Commit | Line | Data |
---|---|---|
b8d4c8d0 GM |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
73b0cd50 | 3 | @c Copyright (C) 1990-1995, 1998-1999, 2001-2011 |
e9bffc61 | 4 | @c Free Software Foundation, Inc. |
b8d4c8d0 | 5 | @c See the file elisp.texi for copying conditions. |
6336d8c3 | 6 | @setfilename ../../info/buffers |
b8d4c8d0 GM |
7 | @node Buffers, Windows, Backups and Auto-Saving, Top |
8 | @chapter Buffers | |
9 | @cindex buffer | |
10 | ||
11 | A @dfn{buffer} is a Lisp object containing text to be edited. Buffers | |
12 | are used to hold the contents of files that are being visited; there may | |
13 | also be buffers that are not visiting files. While several buffers may | |
14 | exist at one time, only one buffer is designated the @dfn{current | |
15 | buffer} at any time. Most editing commands act on the contents of the | |
16 | current buffer. Each buffer, including the current buffer, may or may | |
17 | not be displayed in any windows. | |
18 | ||
19 | @menu | |
20 | * Buffer Basics:: What is a buffer? | |
21 | * Current Buffer:: Designating a buffer as current | |
22 | so that primitives will access its contents. | |
23 | * Buffer Names:: Accessing and changing buffer names. | |
24 | * Buffer File Name:: The buffer file name indicates which file is visited. | |
25 | * Buffer Modification:: A buffer is @dfn{modified} if it needs to be saved. | |
26 | * Modification Time:: Determining whether the visited file was changed | |
27 | ``behind Emacs's back''. | |
28 | * Read Only Buffers:: Modifying text is not allowed in a read-only buffer. | |
29 | * The Buffer List:: How to look at all the existing buffers. | |
30 | * Creating Buffers:: Functions that create buffers. | |
31 | * Killing Buffers:: Buffers exist until explicitly killed. | |
32 | * Indirect Buffers:: An indirect buffer shares text with some other buffer. | |
2aaaf0dd | 33 | * Swapping Text:: Swapping text between two buffers. |
b8d4c8d0 GM |
34 | * Buffer Gap:: The gap in the buffer. |
35 | @end menu | |
36 | ||
37 | @node Buffer Basics | |
38 | @comment node-name, next, previous, up | |
39 | @section Buffer Basics | |
40 | ||
41 | @ifnottex | |
42 | A @dfn{buffer} is a Lisp object containing text to be edited. Buffers | |
43 | are used to hold the contents of files that are being visited; there may | |
44 | also be buffers that are not visiting files. Although several buffers | |
45 | normally exist, only one buffer is designated the @dfn{current | |
46 | buffer} at any time. Most editing commands act on the contents of the | |
47 | current buffer. Each buffer, including the current buffer, may or may | |
48 | not be displayed in any windows. | |
49 | @end ifnottex | |
50 | ||
51 | Buffers in Emacs editing are objects that have distinct names and hold | |
52 | text that can be edited. Buffers appear to Lisp programs as a special | |
53 | data type. You can think of the contents of a buffer as a string that | |
54 | you can extend; insertions and deletions may occur in any part of the | |
55 | buffer. @xref{Text}. | |
56 | ||
57 | A Lisp buffer object contains numerous pieces of information. Some of | |
58 | this information is directly accessible to the programmer through | |
59 | variables, while other information is accessible only through | |
60 | special-purpose functions. For example, the visited file name is | |
61 | directly accessible through a variable, while the value of point is | |
62 | accessible only through a primitive function. | |
63 | ||
64 | Buffer-specific information that is directly accessible is stored in | |
65 | @dfn{buffer-local} variable bindings, which are variable values that are | |
66 | effective only in a particular buffer. This feature allows each buffer | |
67 | to override the values of certain variables. Most major modes override | |
68 | variables such as @code{fill-column} or @code{comment-column} in this | |
69 | way. For more information about buffer-local variables and functions | |
70 | related to them, see @ref{Buffer-Local Variables}. | |
71 | ||
72 | For functions and variables related to visiting files in buffers, see | |
73 | @ref{Visiting Files} and @ref{Saving Buffers}. For functions and | |
74 | variables related to the display of buffers in windows, see | |
75 | @ref{Buffers and Windows}. | |
76 | ||
77 | @defun bufferp object | |
78 | This function returns @code{t} if @var{object} is a buffer, | |
79 | @code{nil} otherwise. | |
80 | @end defun | |
81 | ||
82 | @node Current Buffer | |
83 | @section The Current Buffer | |
84 | @cindex selecting a buffer | |
85 | @cindex changing to another buffer | |
86 | @cindex current buffer | |
87 | ||
c1bcd0d5 CY |
88 | There are, in general, many buffers in an Emacs session. At any |
89 | time, one of them is designated the @dfn{current buffer}---the buffer | |
90 | in which most editing takes place. Most of the primitives for | |
91 | examining or changing text operate implicitly on the current buffer | |
92 | (@pxref{Text}). | |
93 | ||
94 | Normally, the buffer displayed in the selected window is the current | |
95 | buffer, but this is not always so: a Lisp program can temporarily | |
96 | designate any buffer as current in order to operate on its contents, | |
97 | without changing what is displayed on the screen. The most basic | |
98 | function for designating a current buffer is @code{set-buffer}. | |
99 | ||
100 | @defun current-buffer | |
101 | This function returns the current buffer. | |
102 | ||
103 | @example | |
104 | @group | |
105 | (current-buffer) | |
106 | @result{} #<buffer buffers.texi> | |
107 | @end group | |
108 | @end example | |
109 | @end defun | |
110 | ||
111 | @defun set-buffer buffer-or-name | |
112 | This function makes @var{buffer-or-name} the current buffer. | |
113 | @var{buffer-or-name} must be an existing buffer or the name of an | |
114 | existing buffer. The return value is the buffer made current. | |
115 | ||
116 | This function does not display the buffer in any window, so the user | |
117 | cannot necessarily see the buffer. But Lisp programs will now operate | |
118 | on it. | |
119 | @end defun | |
120 | ||
121 | When an editing command returns to the editor command loop, Emacs | |
122 | automatically calls @code{set-buffer} on the buffer shown in the | |
123 | selected window. This is to prevent confusion: it ensures that the | |
124 | buffer that the cursor is in, when Emacs reads a command, is the | |
125 | buffer to which that command applies (@pxref{Command Loop}). Thus, | |
126 | you should not use @code{set-buffer} to switch visibly to a different | |
0e406a72 | 127 | buffer; for that, use the functions described in @ref{Switching |
c1bcd0d5 CY |
128 | Buffers}. |
129 | ||
130 | When writing a Lisp function, do @emph{not} rely on this behavior of | |
131 | the command loop to restore the current buffer after an operation. | |
132 | Editing commands can also be called as Lisp functions by other | |
133 | programs, not just from the command loop; it is convenient for the | |
134 | caller if the subroutine does not change which buffer is current | |
135 | (unless, of course, that is the subroutine's purpose). | |
136 | ||
137 | To operate temporarily on another buffer, put the @code{set-buffer} | |
138 | within a @code{save-current-buffer} form. Here, as an example, is a | |
9257072f | 139 | simplified version of the command @code{append-to-buffer}: |
b8d4c8d0 GM |
140 | |
141 | @example | |
142 | @group | |
143 | (defun append-to-buffer (buffer start end) | |
c1bcd0d5 | 144 | "Append the text of the region to BUFFER." |
b8d4c8d0 GM |
145 | (interactive "BAppend to buffer: \nr") |
146 | (let ((oldbuf (current-buffer))) | |
147 | (save-current-buffer | |
148 | (set-buffer (get-buffer-create buffer)) | |
149 | (insert-buffer-substring oldbuf start end)))) | |
150 | @end group | |
151 | @end example | |
152 | ||
153 | @noindent | |
c1bcd0d5 CY |
154 | Here, we bind a local variable to record the current buffer, and then |
155 | @code{save-current-buffer} arranges to make it current again later. | |
156 | Next, @code{set-buffer} makes the specified buffer current, and | |
b8d4c8d0 | 157 | @code{insert-buffer-substring} copies the string from the original |
c1bcd0d5 CY |
158 | buffer to the specified (and now current) buffer. |
159 | ||
160 | Alternatively, we can use the @code{with-current-buffer} macro: | |
161 | ||
162 | @example | |
163 | @group | |
164 | (defun append-to-buffer (buffer start end) | |
165 | "Append the text of the region to BUFFER." | |
166 | (interactive "BAppend to buffer: \nr") | |
167 | (let ((oldbuf (current-buffer))) | |
168 | (with-current-buffer (get-buffer-create buffer) | |
169 | (insert-buffer-substring oldbuf start end)))) | |
170 | @end group | |
171 | @end example | |
172 | ||
173 | In either case, if the buffer appended to happens to be displayed in | |
174 | some window, the next redisplay will show how its text has changed. | |
175 | If it is not displayed in any window, you will not see the change | |
176 | immediately on the screen. The command causes the buffer to become | |
177 | current temporarily, but does not cause it to be displayed. | |
178 | ||
179 | If you make local bindings (with @code{let} or function arguments) | |
180 | for a variable that may also have buffer-local bindings, make sure | |
181 | that the same buffer is current at the beginning and at the end of the | |
182 | local binding's scope. Otherwise you might bind it in one buffer and | |
183 | unbind it in another! | |
b8d4c8d0 GM |
184 | |
185 | Do not rely on using @code{set-buffer} to change the current buffer | |
186 | back, because that won't do the job if a quit happens while the wrong | |
9257072f CY |
187 | buffer is current. For instance, in the previous example, it would |
188 | have been wrong to do this: | |
b8d4c8d0 GM |
189 | |
190 | @example | |
191 | @group | |
9257072f CY |
192 | (let ((oldbuf (current-buffer))) |
193 | (set-buffer (get-buffer-create buffer)) | |
194 | (insert-buffer-substring oldbuf start end) | |
195 | (set-buffer oldbuf)) | |
b8d4c8d0 GM |
196 | @end group |
197 | @end example | |
198 | ||
199 | @noindent | |
c1bcd0d5 CY |
200 | Using @code{save-current-buffer} or @code{with-current-buffer}, as we |
201 | did, correctly handles quitting, errors, and @code{throw}, as well as | |
202 | ordinary evaluation. | |
b8d4c8d0 GM |
203 | |
204 | @defspec save-current-buffer body@dots{} | |
205 | The @code{save-current-buffer} special form saves the identity of the | |
206 | current buffer, evaluates the @var{body} forms, and finally restores | |
207 | that buffer as current. The return value is the value of the last | |
208 | form in @var{body}. The current buffer is restored even in case of an | |
209 | abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). | |
210 | ||
211 | If the buffer that used to be current has been killed by the time of | |
212 | exit from @code{save-current-buffer}, then it is not made current again, | |
213 | of course. Instead, whichever buffer was current just before exit | |
214 | remains current. | |
215 | @end defspec | |
216 | ||
217 | @defmac with-current-buffer buffer-or-name body@dots{} | |
218 | The @code{with-current-buffer} macro saves the identity of the current | |
219 | buffer, makes @var{buffer-or-name} current, evaluates the @var{body} | |
09460d9a MR |
220 | forms, and finally restores the current buffer. @var{buffer-or-name} |
221 | must specify an existing buffer or the name of an existing buffer. | |
b8d4c8d0 | 222 | |
09460d9a MR |
223 | The return value is the value of the last form in @var{body}. The |
224 | current buffer is restored even in case of an abnormal exit via | |
225 | @code{throw} or error (@pxref{Nonlocal Exits}). | |
b8d4c8d0 GM |
226 | @end defmac |
227 | ||
228 | @defmac with-temp-buffer body@dots{} | |
229 | @anchor{Definition of with-temp-buffer} | |
230 | The @code{with-temp-buffer} macro evaluates the @var{body} forms | |
231 | with a temporary buffer as the current buffer. It saves the identity of | |
232 | the current buffer, creates a temporary buffer and makes it current, | |
233 | evaluates the @var{body} forms, and finally restores the previous | |
234 | current buffer while killing the temporary buffer. By default, undo | |
235 | information (@pxref{Undo}) is not recorded in the buffer created by | |
236 | this macro (but @var{body} can enable that, if needed). | |
237 | ||
238 | The return value is the value of the last form in @var{body}. You can | |
239 | return the contents of the temporary buffer by using | |
240 | @code{(buffer-string)} as the last form. | |
241 | ||
242 | The current buffer is restored even in case of an abnormal exit via | |
243 | @code{throw} or error (@pxref{Nonlocal Exits}). | |
244 | ||
245 | See also @code{with-temp-file} in @ref{Definition of with-temp-file,, | |
246 | Writing to Files}. | |
247 | @end defmac | |
248 | ||
249 | @node Buffer Names | |
250 | @section Buffer Names | |
251 | @cindex buffer names | |
252 | ||
253 | Each buffer has a unique name, which is a string. Many of the | |
254 | functions that work on buffers accept either a buffer or a buffer name | |
255 | as an argument. Any argument called @var{buffer-or-name} is of this | |
256 | sort, and an error is signaled if it is neither a string nor a buffer. | |
257 | Any argument called @var{buffer} must be an actual buffer | |
258 | object, not a name. | |
259 | ||
260 | @cindex hidden buffers | |
261 | @cindex buffers without undo information | |
262 | Buffers that are ephemeral and generally uninteresting to the user | |
263 | have names starting with a space, so that the @code{list-buffers} and | |
264 | @code{buffer-menu} commands don't mention them (but if such a buffer | |
265 | visits a file, it @strong{is} mentioned). A name starting with | |
266 | space also initially disables recording undo information; see | |
267 | @ref{Undo}. | |
268 | ||
269 | @defun buffer-name &optional buffer | |
4d48fcdc MR |
270 | This function returns the name of @var{buffer} as a string. |
271 | @var{buffer} defaults to the current buffer. | |
b8d4c8d0 GM |
272 | |
273 | If @code{buffer-name} returns @code{nil}, it means that @var{buffer} | |
274 | has been killed. @xref{Killing Buffers}. | |
275 | ||
276 | @example | |
277 | @group | |
278 | (buffer-name) | |
279 | @result{} "buffers.texi" | |
280 | @end group | |
281 | ||
282 | @group | |
283 | (setq foo (get-buffer "temp")) | |
284 | @result{} #<buffer temp> | |
285 | @end group | |
286 | @group | |
287 | (kill-buffer foo) | |
288 | @result{} nil | |
289 | @end group | |
290 | @group | |
291 | (buffer-name foo) | |
292 | @result{} nil | |
293 | @end group | |
294 | @group | |
295 | foo | |
296 | @result{} #<killed buffer> | |
297 | @end group | |
298 | @end example | |
299 | @end defun | |
300 | ||
301 | @deffn Command rename-buffer newname &optional unique | |
302 | This function renames the current buffer to @var{newname}. An error | |
303 | is signaled if @var{newname} is not a string. | |
304 | ||
305 | @c Emacs 19 feature | |
306 | Ordinarily, @code{rename-buffer} signals an error if @var{newname} is | |
307 | already in use. However, if @var{unique} is non-@code{nil}, it modifies | |
308 | @var{newname} to make a name that is not in use. Interactively, you can | |
309 | make @var{unique} non-@code{nil} with a numeric prefix argument. | |
310 | (This is how the command @code{rename-uniquely} is implemented.) | |
311 | ||
312 | This function returns the name actually given to the buffer. | |
313 | @end deffn | |
314 | ||
315 | @defun get-buffer buffer-or-name | |
316 | This function returns the buffer specified by @var{buffer-or-name}. | |
317 | If @var{buffer-or-name} is a string and there is no buffer with that | |
318 | name, the value is @code{nil}. If @var{buffer-or-name} is a buffer, it | |
319 | is returned as given; that is not very useful, so the argument is usually | |
320 | a name. For example: | |
321 | ||
322 | @example | |
323 | @group | |
324 | (setq b (get-buffer "lewis")) | |
325 | @result{} #<buffer lewis> | |
326 | @end group | |
327 | @group | |
328 | (get-buffer b) | |
329 | @result{} #<buffer lewis> | |
330 | @end group | |
331 | @group | |
332 | (get-buffer "Frazzle-nots") | |
333 | @result{} nil | |
334 | @end group | |
335 | @end example | |
336 | ||
337 | See also the function @code{get-buffer-create} in @ref{Creating Buffers}. | |
338 | @end defun | |
339 | ||
340 | @c Emacs 19 feature | |
341 | @defun generate-new-buffer-name starting-name &optional ignore | |
342 | This function returns a name that would be unique for a new buffer---but | |
343 | does not create the buffer. It starts with @var{starting-name}, and | |
344 | produces a name not currently in use for any buffer by appending a | |
345 | number inside of @samp{<@dots{}>}. It starts at 2 and keeps | |
346 | incrementing the number until it is not the name of an existing buffer. | |
347 | ||
348 | If the optional second argument @var{ignore} is non-@code{nil}, it | |
349 | should be a string, a potential buffer name. It means to consider | |
350 | that potential buffer acceptable, if it is tried, even it is the name | |
351 | of an existing buffer (which would normally be rejected). Thus, if | |
352 | buffers named @samp{foo}, @samp{foo<2>}, @samp{foo<3>} and | |
353 | @samp{foo<4>} exist, | |
354 | ||
355 | @example | |
356 | (generate-new-buffer-name "foo") | |
357 | @result{} "foo<5>" | |
358 | (generate-new-buffer-name "foo" "foo<3>") | |
359 | @result{} "foo<3>" | |
360 | (generate-new-buffer-name "foo" "foo<6>") | |
361 | @result{} "foo<5>" | |
362 | @end example | |
363 | ||
364 | See the related function @code{generate-new-buffer} in @ref{Creating | |
365 | Buffers}. | |
366 | @end defun | |
367 | ||
368 | @node Buffer File Name | |
369 | @section Buffer File Name | |
370 | @cindex visited file | |
371 | @cindex buffer file name | |
372 | @cindex file name of buffer | |
373 | ||
374 | The @dfn{buffer file name} is the name of the file that is visited in | |
375 | that buffer. When a buffer is not visiting a file, its buffer file name | |
376 | is @code{nil}. Most of the time, the buffer name is the same as the | |
377 | nondirectory part of the buffer file name, but the buffer file name and | |
378 | the buffer name are distinct and can be set independently. | |
379 | @xref{Visiting Files}. | |
380 | ||
381 | @defun buffer-file-name &optional buffer | |
382 | This function returns the absolute file name of the file that | |
383 | @var{buffer} is visiting. If @var{buffer} is not visiting any file, | |
384 | @code{buffer-file-name} returns @code{nil}. If @var{buffer} is not | |
385 | supplied, it defaults to the current buffer. | |
386 | ||
387 | @example | |
388 | @group | |
389 | (buffer-file-name (other-buffer)) | |
390 | @result{} "/usr/user/lewis/manual/files.texi" | |
391 | @end group | |
392 | @end example | |
393 | @end defun | |
394 | ||
395 | @defvar buffer-file-name | |
396 | This buffer-local variable contains the name of the file being visited | |
397 | in the current buffer, or @code{nil} if it is not visiting a file. It | |
398 | is a permanent local variable, unaffected by | |
399 | @code{kill-all-local-variables}. | |
400 | ||
401 | @example | |
402 | @group | |
403 | buffer-file-name | |
404 | @result{} "/usr/user/lewis/manual/buffers.texi" | |
405 | @end group | |
406 | @end example | |
407 | ||
408 | It is risky to change this variable's value without doing various other | |
409 | things. Normally it is better to use @code{set-visited-file-name} (see | |
410 | below); some of the things done there, such as changing the buffer name, | |
411 | are not strictly necessary, but others are essential to avoid confusing | |
412 | Emacs. | |
413 | @end defvar | |
414 | ||
415 | @defvar buffer-file-truename | |
416 | This buffer-local variable holds the abbreviated truename of the file | |
417 | visited in the current buffer, or @code{nil} if no file is visited. | |
418 | It is a permanent local, unaffected by | |
419 | @code{kill-all-local-variables}. @xref{Truenames}, and | |
420 | @ref{Definition of abbreviate-file-name}. | |
421 | @end defvar | |
422 | ||
423 | @defvar buffer-file-number | |
424 | This buffer-local variable holds the file number and directory device | |
425 | number of the file visited in the current buffer, or @code{nil} if no | |
426 | file or a nonexistent file is visited. It is a permanent local, | |
427 | unaffected by @code{kill-all-local-variables}. | |
428 | ||
429 | The value is normally a list of the form @code{(@var{filenum} | |
430 | @var{devnum})}. This pair of numbers uniquely identifies the file among | |
431 | all files accessible on the system. See the function | |
432 | @code{file-attributes}, in @ref{File Attributes}, for more information | |
433 | about them. | |
434 | ||
435 | If @code{buffer-file-name} is the name of a symbolic link, then both | |
436 | numbers refer to the recursive target. | |
437 | @end defvar | |
438 | ||
439 | @defun get-file-buffer filename | |
440 | This function returns the buffer visiting file @var{filename}. If | |
441 | there is no such buffer, it returns @code{nil}. The argument | |
442 | @var{filename}, which must be a string, is expanded (@pxref{File Name | |
443 | Expansion}), then compared against the visited file names of all live | |
444 | buffers. Note that the buffer's @code{buffer-file-name} must match | |
445 | the expansion of @var{filename} exactly. This function will not | |
446 | recognize other names for the same file. | |
447 | ||
448 | @example | |
449 | @group | |
450 | (get-file-buffer "buffers.texi") | |
451 | @result{} #<buffer buffers.texi> | |
452 | @end group | |
453 | @end example | |
454 | ||
455 | In unusual circumstances, there can be more than one buffer visiting | |
456 | the same file name. In such cases, this function returns the first | |
457 | such buffer in the buffer list. | |
458 | @end defun | |
459 | ||
460 | @defun find-buffer-visiting filename &optional predicate | |
461 | This is like @code{get-file-buffer}, except that it can return any | |
462 | buffer visiting the file @emph{possibly under a different name}. That | |
463 | is, the buffer's @code{buffer-file-name} does not need to match the | |
464 | expansion of @var{filename} exactly, it only needs to refer to the | |
465 | same file. If @var{predicate} is non-@code{nil}, it should be a | |
466 | function of one argument, a buffer visiting @var{filename}. The | |
467 | buffer is only considered a suitable return value if @var{predicate} | |
468 | returns non-@code{nil}. If it can not find a suitable buffer to | |
469 | return, @code{find-buffer-visiting} returns @code{nil}. | |
470 | @end defun | |
471 | ||
472 | @deffn Command set-visited-file-name filename &optional no-query along-with-file | |
473 | If @var{filename} is a non-empty string, this function changes the | |
474 | name of the file visited in the current buffer to @var{filename}. (If the | |
475 | buffer had no visited file, this gives it one.) The @emph{next time} | |
476 | the buffer is saved it will go in the newly-specified file. | |
477 | ||
478 | This command marks the buffer as modified, since it does not (as far | |
479 | as Emacs knows) match the contents of @var{filename}, even if it | |
480 | matched the former visited file. It also renames the buffer to | |
481 | correspond to the new file name, unless the new name is already in | |
482 | use. | |
483 | ||
484 | If @var{filename} is @code{nil} or the empty string, that stands for | |
485 | ``no visited file.'' In this case, @code{set-visited-file-name} marks | |
486 | the buffer as having no visited file, without changing the buffer's | |
487 | modified flag. | |
488 | ||
489 | Normally, this function asks the user for confirmation if there | |
490 | already is a buffer visiting @var{filename}. If @var{no-query} is | |
491 | non-@code{nil}, that prevents asking this question. If there already | |
492 | is a buffer visiting @var{filename}, and the user confirms or | |
493 | @var{query} is non-@code{nil}, this function makes the new buffer name | |
494 | unique by appending a number inside of @samp{<@dots{}>} to @var{filename}. | |
495 | ||
496 | If @var{along-with-file} is non-@code{nil}, that means to assume that | |
497 | the former visited file has been renamed to @var{filename}. In this | |
498 | case, the command does not change the buffer's modified flag, nor the | |
499 | buffer's recorded last file modification time as reported by | |
500 | @code{visited-file-modtime} (@pxref{Modification Time}). If | |
501 | @var{along-with-file} is @code{nil}, this function clears the recorded | |
502 | last file modification time, after which @code{visited-file-modtime} | |
503 | returns zero. | |
504 | ||
505 | @c Wordy to avoid overfull hbox. --rjc 16mar92 | |
506 | When the function @code{set-visited-file-name} is called interactively, it | |
507 | prompts for @var{filename} in the minibuffer. | |
508 | @end deffn | |
509 | ||
510 | @defvar list-buffers-directory | |
511 | This buffer-local variable specifies a string to display in a buffer | |
512 | listing where the visited file name would go, for buffers that don't | |
513 | have a visited file name. Dired buffers use this variable. | |
514 | @end defvar | |
515 | ||
516 | @node Buffer Modification | |
517 | @section Buffer Modification | |
518 | @cindex buffer modification | |
519 | @cindex modification flag (of buffer) | |
520 | ||
521 | Emacs keeps a flag called the @dfn{modified flag} for each buffer, to | |
522 | record whether you have changed the text of the buffer. This flag is | |
523 | set to @code{t} whenever you alter the contents of the buffer, and | |
524 | cleared to @code{nil} when you save it. Thus, the flag shows whether | |
525 | there are unsaved changes. The flag value is normally shown in the mode | |
526 | line (@pxref{Mode Line Variables}), and controls saving (@pxref{Saving | |
527 | Buffers}) and auto-saving (@pxref{Auto-Saving}). | |
528 | ||
529 | Some Lisp programs set the flag explicitly. For example, the function | |
530 | @code{set-visited-file-name} sets the flag to @code{t}, because the text | |
531 | does not match the newly-visited file, even if it is unchanged from the | |
532 | file formerly visited. | |
533 | ||
534 | The functions that modify the contents of buffers are described in | |
535 | @ref{Text}. | |
536 | ||
537 | @defun buffer-modified-p &optional buffer | |
538 | This function returns @code{t} if the buffer @var{buffer} has been modified | |
539 | since it was last read in from a file or saved, or @code{nil} | |
540 | otherwise. If @var{buffer} is not supplied, the current buffer | |
541 | is tested. | |
542 | @end defun | |
543 | ||
544 | @defun set-buffer-modified-p flag | |
545 | This function marks the current buffer as modified if @var{flag} is | |
546 | non-@code{nil}, or as unmodified if the flag is @code{nil}. | |
547 | ||
548 | Another effect of calling this function is to cause unconditional | |
549 | redisplay of the mode line for the current buffer. In fact, the | |
550 | function @code{force-mode-line-update} works by doing this: | |
551 | ||
552 | @example | |
553 | @group | |
554 | (set-buffer-modified-p (buffer-modified-p)) | |
555 | @end group | |
556 | @end example | |
557 | @end defun | |
558 | ||
559 | @defun restore-buffer-modified-p flag | |
560 | Like @code{set-buffer-modified-p}, but does not force redisplay | |
561 | of mode lines. | |
562 | @end defun | |
563 | ||
564 | @deffn Command not-modified &optional arg | |
565 | This command marks the current buffer as unmodified, and not needing | |
566 | to be saved. If @var{arg} is non-@code{nil}, it marks the buffer as | |
567 | modified, so that it will be saved at the next suitable occasion. | |
568 | Interactively, @var{arg} is the prefix argument. | |
569 | ||
570 | Don't use this function in programs, since it prints a message in the | |
571 | echo area; use @code{set-buffer-modified-p} (above) instead. | |
572 | @end deffn | |
573 | ||
574 | @defun buffer-modified-tick &optional buffer | |
575 | This function returns @var{buffer}'s modification-count. This is a | |
576 | counter that increments every time the buffer is modified. If | |
577 | @var{buffer} is @code{nil} (or omitted), the current buffer is used. | |
578 | The counter can wrap around occasionally. | |
579 | @end defun | |
580 | ||
581 | @defun buffer-chars-modified-tick &optional buffer | |
582 | This function returns @var{buffer}'s character-change modification-count. | |
583 | Changes to text properties leave this counter unchanged; however, each | |
584 | time text is inserted or removed from the buffer, the counter is reset | |
569382c2 | 585 | to the value that would be returned by @code{buffer-modified-tick}. |
b8d4c8d0 GM |
586 | By comparing the values returned by two @code{buffer-chars-modified-tick} |
587 | calls, you can tell whether a character change occurred in that buffer | |
588 | in between the calls. If @var{buffer} is @code{nil} (or omitted), the | |
589 | current buffer is used. | |
590 | @end defun | |
591 | ||
592 | @node Modification Time | |
593 | @comment node-name, next, previous, up | |
594 | @section Buffer Modification Time | |
595 | @cindex comparing file modification time | |
596 | @cindex modification time of buffer | |
597 | ||
598 | Suppose that you visit a file and make changes in its buffer, and | |
599 | meanwhile the file itself is changed on disk. At this point, saving the | |
600 | buffer would overwrite the changes in the file. Occasionally this may | |
601 | be what you want, but usually it would lose valuable information. Emacs | |
602 | therefore checks the file's modification time using the functions | |
603 | described below before saving the file. (@xref{File Attributes}, | |
604 | for how to examine a file's modification time.) | |
605 | ||
ec1b9b17 GM |
606 | @defun verify-visited-file-modtime &optional buffer |
607 | This function compares what @var{buffer} (by default, the | |
608 | current-buffer) has recorded for the modification time of its visited | |
609 | file against the actual modification time of the file as recorded by the | |
610 | operating system. The two should be the same unless some other process | |
611 | has written the file since Emacs visited or saved it. | |
b8d4c8d0 GM |
612 | |
613 | The function returns @code{t} if the last actual modification time and | |
614 | Emacs's recorded modification time are the same, @code{nil} otherwise. | |
615 | It also returns @code{t} if the buffer has no recorded last | |
616 | modification time, that is if @code{visited-file-modtime} would return | |
617 | zero. | |
618 | ||
619 | It always returns @code{t} for buffers that are not visiting a file, | |
620 | even if @code{visited-file-modtime} returns a non-zero value. For | |
621 | instance, it always returns @code{t} for dired buffers. It returns | |
622 | @code{t} for buffers that are visiting a file that does not exist and | |
623 | never existed, but @code{nil} for file-visiting buffers whose file has | |
624 | been deleted. | |
625 | @end defun | |
626 | ||
627 | @defun clear-visited-file-modtime | |
628 | This function clears out the record of the last modification time of | |
629 | the file being visited by the current buffer. As a result, the next | |
630 | attempt to save this buffer will not complain of a discrepancy in | |
631 | file modification times. | |
632 | ||
633 | This function is called in @code{set-visited-file-name} and other | |
634 | exceptional places where the usual test to avoid overwriting a changed | |
635 | file should not be done. | |
636 | @end defun | |
637 | ||
638 | @c Emacs 19 feature | |
639 | @defun visited-file-modtime | |
640 | This function returns the current buffer's recorded last file | |
641 | modification time, as a list of the form @code{(@var{high} @var{low})}. | |
642 | (This is the same format that @code{file-attributes} uses to return | |
643 | time values; see @ref{File Attributes}.) | |
644 | ||
645 | If the buffer has no recorded last modification time, this function | |
646 | returns zero. This case occurs, for instance, if the buffer is not | |
647 | visiting a file or if the time has been explicitly cleared by | |
648 | @code{clear-visited-file-modtime}. Note, however, that | |
649 | @code{visited-file-modtime} returns a list for some non-file buffers | |
650 | too. For instance, in a Dired buffer listing a directory, it returns | |
651 | the last modification time of that directory, as recorded by Dired. | |
652 | ||
653 | For a new buffer visiting a not yet existing file, @var{high} is | |
654 | @minus{}1 and @var{low} is 65535, that is, | |
655 | @ifnottex | |
656 | @w{2**16 - 1.} | |
657 | @end ifnottex | |
658 | @tex | |
659 | @math{2^{16}-1}. | |
660 | @end tex | |
661 | @end defun | |
662 | ||
663 | @c Emacs 19 feature | |
664 | @defun set-visited-file-modtime &optional time | |
665 | This function updates the buffer's record of the last modification time | |
666 | of the visited file, to the value specified by @var{time} if @var{time} | |
667 | is not @code{nil}, and otherwise to the last modification time of the | |
668 | visited file. | |
669 | ||
670 | If @var{time} is neither @code{nil} nor zero, it should have the form | |
671 | @code{(@var{high} . @var{low})} or @code{(@var{high} @var{low})}, in | |
672 | either case containing two integers, each of which holds 16 bits of the | |
673 | time. | |
674 | ||
675 | This function is useful if the buffer was not read from the file | |
676 | normally, or if the file itself has been changed for some known benign | |
677 | reason. | |
678 | @end defun | |
679 | ||
680 | @defun ask-user-about-supersession-threat filename | |
681 | This function is used to ask a user how to proceed after an attempt to | |
682 | modify an buffer visiting file @var{filename} when the file is newer | |
683 | than the buffer text. Emacs detects this because the modification | |
684 | time of the file on disk is newer than the last save-time of the | |
685 | buffer. This means some other program has probably altered the file. | |
686 | ||
687 | @kindex file-supersession | |
688 | Depending on the user's answer, the function may return normally, in | |
689 | which case the modification of the buffer proceeds, or it may signal a | |
690 | @code{file-supersession} error with data @code{(@var{filename})}, in which | |
691 | case the proposed buffer modification is not allowed. | |
692 | ||
693 | This function is called automatically by Emacs on the proper | |
694 | occasions. It exists so you can customize Emacs by redefining it. | |
695 | See the file @file{userlock.el} for the standard definition. | |
696 | ||
697 | See also the file locking mechanism in @ref{File Locks}. | |
698 | @end defun | |
699 | ||
700 | @node Read Only Buffers | |
701 | @section Read-Only Buffers | |
702 | @cindex read-only buffer | |
703 | @cindex buffer, read-only | |
704 | ||
705 | If a buffer is @dfn{read-only}, then you cannot change its contents, | |
706 | although you may change your view of the contents by scrolling and | |
707 | narrowing. | |
708 | ||
709 | Read-only buffers are used in two kinds of situations: | |
710 | ||
711 | @itemize @bullet | |
712 | @item | |
713 | A buffer visiting a write-protected file is normally read-only. | |
714 | ||
715 | Here, the purpose is to inform the user that editing the buffer with the | |
716 | aim of saving it in the file may be futile or undesirable. The user who | |
717 | wants to change the buffer text despite this can do so after clearing | |
718 | the read-only flag with @kbd{C-x C-q}. | |
719 | ||
720 | @item | |
721 | Modes such as Dired and Rmail make buffers read-only when altering the | |
722 | contents with the usual editing commands would probably be a mistake. | |
723 | ||
724 | The special commands of these modes bind @code{buffer-read-only} to | |
725 | @code{nil} (with @code{let}) or bind @code{inhibit-read-only} to | |
726 | @code{t} around the places where they themselves change the text. | |
727 | @end itemize | |
728 | ||
729 | @defvar buffer-read-only | |
730 | This buffer-local variable specifies whether the buffer is read-only. | |
731 | The buffer is read-only if this variable is non-@code{nil}. | |
732 | @end defvar | |
733 | ||
734 | @defvar inhibit-read-only | |
735 | If this variable is non-@code{nil}, then read-only buffers and, | |
736 | depending on the actual value, some or all read-only characters may be | |
737 | modified. Read-only characters in a buffer are those that have | |
738 | non-@code{nil} @code{read-only} properties (either text properties or | |
739 | overlay properties). @xref{Special Properties}, for more information | |
740 | about text properties. @xref{Overlays}, for more information about | |
741 | overlays and their properties. | |
742 | ||
743 | If @code{inhibit-read-only} is @code{t}, all @code{read-only} character | |
744 | properties have no effect. If @code{inhibit-read-only} is a list, then | |
745 | @code{read-only} character properties have no effect if they are members | |
746 | of the list (comparison is done with @code{eq}). | |
747 | @end defvar | |
748 | ||
749 | @deffn Command toggle-read-only &optional arg | |
750 | This command toggles whether the current buffer is read-only. It is | |
751 | intended for interactive use; do not use it in programs. At any given | |
752 | point in a program, you should know whether you want the read-only flag | |
753 | on or off; so you can set @code{buffer-read-only} explicitly to the | |
754 | proper value, @code{t} or @code{nil}. | |
755 | ||
756 | If @var{arg} is non-@code{nil}, it should be a raw prefix argument. | |
757 | @code{toggle-read-only} sets @code{buffer-read-only} to @code{t} if | |
758 | the numeric value of that prefix argument is positive and to | |
759 | @code{nil} otherwise. @xref{Prefix Command Arguments}. | |
760 | @end deffn | |
761 | ||
762 | @defun barf-if-buffer-read-only | |
763 | This function signals a @code{buffer-read-only} error if the current | |
764 | buffer is read-only. @xref{Using Interactive}, for another way to | |
765 | signal an error if the current buffer is read-only. | |
766 | @end defun | |
767 | ||
768 | @node The Buffer List | |
769 | @section The Buffer List | |
770 | @cindex buffer list | |
771 | ||
174dc00c MR |
772 | The @dfn{buffer list} is a list of all live buffers. The order of the |
773 | buffers in this list is based primarily on how recently each buffer has | |
774 | been displayed in a window. Several functions, notably | |
775 | @code{other-buffer}, use this ordering. A buffer list displayed for the | |
776 | user also follows this order. | |
777 | ||
0e406a72 CY |
778 | Creating a buffer adds it to the end of the buffer list, and killing |
779 | a buffer removes it from that list. A buffer moves to the front of | |
780 | this list whenever it is chosen for display in a window | |
781 | (@pxref{Switching Buffers}) or a window displaying it is selected | |
782 | (@pxref{Selecting Windows}). A buffer moves to the end of the list | |
783 | when it is buried (see @code{bury-buffer}, below). There are no | |
784 | functions available to the Lisp programmer which directly manipulate | |
785 | the buffer list. | |
174dc00c MR |
786 | |
787 | In addition to the fundamental buffer list just described, Emacs | |
788 | maintains a local buffer list for each frame, in which the buffers that | |
789 | have been displayed (or had their windows selected) in that frame come | |
790 | first. (This order is recorded in the frame's @code{buffer-list} frame | |
791 | parameter; see @ref{Buffer Parameters}.) Buffers never displayed in | |
792 | that frame come afterward, ordered according to the fundamental buffer | |
793 | list. | |
b8d4c8d0 GM |
794 | |
795 | @defun buffer-list &optional frame | |
796 | This function returns the buffer list, including all buffers, even those | |
797 | whose names begin with a space. The elements are actual buffers, not | |
798 | their names. | |
799 | ||
174dc00c MR |
800 | If @var{frame} is a frame, this returns @var{frame}'s local buffer list. |
801 | If @var{frame} is @code{nil} or omitted, the fundamental buffer list is | |
802 | used: the buffers appear in order of most recent display or selection, | |
803 | regardless of which frames they were displayed on. | |
b8d4c8d0 GM |
804 | |
805 | @example | |
806 | @group | |
807 | (buffer-list) | |
808 | @result{} (#<buffer buffers.texi> | |
809 | #<buffer *Minibuf-1*> #<buffer buffer.c> | |
810 | #<buffer *Help*> #<buffer TAGS>) | |
811 | @end group | |
812 | ||
813 | @group | |
814 | ;; @r{Note that the name of the minibuffer} | |
815 | ;; @r{begins with a space!} | |
816 | (mapcar (function buffer-name) (buffer-list)) | |
817 | @result{} ("buffers.texi" " *Minibuf-1*" | |
818 | "buffer.c" "*Help*" "TAGS") | |
819 | @end group | |
820 | @end example | |
821 | @end defun | |
822 | ||
174dc00c MR |
823 | The list returned by @code{buffer-list} is constructed specifically; |
824 | it is not an internal Emacs data structure, and modifying it has no | |
825 | effect on the order of buffers. If you want to change the order of | |
826 | buffers in the fundamental buffer list, here is an easy way: | |
b8d4c8d0 GM |
827 | |
828 | @example | |
829 | (defun reorder-buffer-list (new-list) | |
830 | (while new-list | |
831 | (bury-buffer (car new-list)) | |
832 | (setq new-list (cdr new-list)))) | |
833 | @end example | |
834 | ||
835 | With this method, you can specify any order for the list, but there is | |
836 | no danger of losing a buffer or adding something that is not a valid | |
837 | live buffer. | |
838 | ||
174dc00c MR |
839 | To change the order or value of a specific frame's buffer list, set |
840 | that frame's @code{buffer-list} parameter with | |
841 | @code{modify-frame-parameters} (@pxref{Parameter Access}). | |
b8d4c8d0 GM |
842 | |
843 | @defun other-buffer &optional buffer visible-ok frame | |
844 | This function returns the first buffer in the buffer list other than | |
174dc00c MR |
845 | @var{buffer}. Usually, this is the buffer appearing in the most |
846 | recently selected window (in frame @var{frame} or else the selected | |
847 | frame, @pxref{Input Focus}), aside from @var{buffer}. Buffers whose | |
848 | names start with a space are not considered at all. | |
b8d4c8d0 | 849 | |
174dc00c | 850 | If @var{buffer} is not supplied (or if it is not a live buffer), then |
b8d4c8d0 | 851 | @code{other-buffer} returns the first buffer in the selected frame's |
174dc00c MR |
852 | local buffer list. (If @var{frame} is non-@code{nil}, it returns the |
853 | first buffer in @var{frame}'s local buffer list instead.) | |
b8d4c8d0 GM |
854 | |
855 | If @var{frame} has a non-@code{nil} @code{buffer-predicate} parameter, | |
856 | then @code{other-buffer} uses that predicate to decide which buffers to | |
857 | consider. It calls the predicate once for each buffer, and if the value | |
858 | is @code{nil}, that buffer is ignored. @xref{Buffer Parameters}. | |
859 | ||
860 | @c Emacs 19 feature | |
861 | If @var{visible-ok} is @code{nil}, @code{other-buffer} avoids returning | |
862 | a buffer visible in any window on any visible frame, except as a last | |
174dc00c | 863 | resort. If @var{visible-ok} is non-@code{nil}, then it does not matter |
b8d4c8d0 GM |
864 | whether a buffer is displayed somewhere or not. |
865 | ||
866 | If no suitable buffer exists, the buffer @samp{*scratch*} is returned | |
867 | (and created, if necessary). | |
868 | @end defun | |
869 | ||
174dc00c MR |
870 | @defun last-buffer &optional buffer visible-ok frame |
871 | This function returns the last buffer in @var{frame}'s buffer list other | |
872 | than @var{BUFFER}. If @var{frame} is omitted or @code{nil}, it uses the | |
873 | selected frame's buffer list. | |
874 | ||
875 | The argument @var{visible-ok} is handled as with @code{other-buffer}, | |
876 | see above. If no suitable buffer can be found, the buffer | |
877 | @samp{*scratch*} is returned. | |
878 | @end defun | |
879 | ||
b8d4c8d0 | 880 | @deffn Command bury-buffer &optional buffer-or-name |
174dc00c | 881 | This command puts @var{buffer-or-name} at the end of the buffer list, |
b8d4c8d0 GM |
882 | without changing the order of any of the other buffers on the list. |
883 | This buffer therefore becomes the least desirable candidate for | |
884 | @code{other-buffer} to return. The argument can be either a buffer | |
885 | itself or the name of one. | |
886 | ||
d83dc65b MR |
887 | This functions operates on each frame's @code{buffer-list} parameter as |
888 | well as the fundamental buffer list; therefore, the buffer that you bury | |
889 | will come last in the value of @code{(buffer-list @var{frame})} and in | |
890 | the value of @code{(buffer-list)}. In addition, it also puts the buffer | |
891 | at the end of the list of buffer of the selected window (@pxref{Window | |
892 | History}) provided it is shown in that window. | |
893 | ||
894 | If @var{buffer-or-name} is @code{nil} or omitted, this means to bury the | |
895 | current buffer. In addition, if the current buffer is displayed in the | |
896 | selected window, this makes sure that the window is either deleted or | |
897 | another buffer is shown in it. More precisely, if the window is | |
898 | dedicated (@pxref{Dedicated Windows}) and there are other windows on its | |
899 | frame, the window is deleted. If the window is both dedicated and the | |
900 | only window on its frame's terminal, the function specified by | |
901 | @code{frame-auto-hide-function} (@pxref{Quitting Windows}) will deal | |
902 | with the window. If the window is not dedicated to its buffer, it calls | |
903 | @code{switch-to-prev-buffer} (@pxref{Window History}) to show another | |
904 | buffer in that window. If @var{buffer-or-name} is displayed in some | |
0e406a72 | 905 | other window, it remains displayed there. |
b8d4c8d0 GM |
906 | |
907 | To replace a buffer in all the windows that display it, use | |
d83dc65b | 908 | @code{replace-buffer-in-windows}, @xref{Buffers and Windows}. |
b8d4c8d0 GM |
909 | @end deffn |
910 | ||
174dc00c | 911 | @deffn Command unbury-buffer |
0e406a72 CY |
912 | This command switches to the last buffer in the local buffer list of |
913 | the selected frame. More precisely, it calls the function | |
914 | @code{switch-to-buffer} (@pxref{Switching Buffers}), to display the | |
174dc00c MR |
915 | buffer returned by @code{last-buffer}, see above, in the selected |
916 | window. | |
917 | @end deffn | |
918 | ||
919 | ||
b8d4c8d0 GM |
920 | @node Creating Buffers |
921 | @section Creating Buffers | |
922 | @cindex creating buffers | |
923 | @cindex buffers, creating | |
924 | ||
925 | This section describes the two primitives for creating buffers. | |
926 | @code{get-buffer-create} creates a buffer if it finds no existing buffer | |
927 | with the specified name; @code{generate-new-buffer} always creates a new | |
928 | buffer and gives it a unique name. | |
929 | ||
930 | Other functions you can use to create buffers include | |
931 | @code{with-output-to-temp-buffer} (@pxref{Temporary Displays}) and | |
932 | @code{create-file-buffer} (@pxref{Visiting Files}). Starting a | |
933 | subprocess can also create a buffer (@pxref{Processes}). | |
934 | ||
4d48fcdc | 935 | @defun get-buffer-create buffer-or-name |
09460d9a MR |
936 | This function returns a buffer named @var{buffer-or-name}. The buffer |
937 | returned does not become the current buffer---this function does not | |
938 | change which buffer is current. | |
939 | ||
940 | @var{buffer-or-name} must be either a string or an existing buffer. If | |
941 | it is a string and a live buffer with that name already exists, | |
942 | @code{get-buffer-create} returns that buffer. If no such buffer exists, | |
943 | it creates a new buffer. If @var{buffer-or-name} is a buffer instead of | |
944 | a string, it is returned as given, even if it is dead. | |
b8d4c8d0 GM |
945 | |
946 | @example | |
947 | @group | |
948 | (get-buffer-create "foo") | |
949 | @result{} #<buffer foo> | |
950 | @end group | |
951 | @end example | |
952 | ||
953 | The major mode for a newly created buffer is set to Fundamental mode. | |
4e3b4528 SM |
954 | (The default value of the variable @code{major-mode} is handled at a higher |
955 | level; see @ref{Auto Major Mode}.) If the name begins with a space, the | |
b8d4c8d0 GM |
956 | buffer initially disables undo information recording (@pxref{Undo}). |
957 | @end defun | |
958 | ||
959 | @defun generate-new-buffer name | |
960 | This function returns a newly created, empty buffer, but does not make | |
961 | it current. If there is no buffer named @var{name}, then that is the | |
962 | name of the new buffer. If that name is in use, this function adds | |
963 | suffixes of the form @samp{<@var{n}>} to @var{name}, where @var{n} is an | |
964 | integer. It tries successive integers starting with 2 until it finds an | |
965 | available name. | |
966 | ||
967 | An error is signaled if @var{name} is not a string. | |
968 | ||
969 | @example | |
970 | @group | |
971 | (generate-new-buffer "bar") | |
972 | @result{} #<buffer bar> | |
973 | @end group | |
974 | @group | |
975 | (generate-new-buffer "bar") | |
976 | @result{} #<buffer bar<2>> | |
977 | @end group | |
978 | @group | |
979 | (generate-new-buffer "bar") | |
980 | @result{} #<buffer bar<3>> | |
981 | @end group | |
982 | @end example | |
983 | ||
4e3b4528 SM |
984 | The major mode for the new buffer is set to Fundamental mode. The default |
985 | value of the variable @code{major-mode} is handled at a higher level. | |
b8d4c8d0 GM |
986 | @xref{Auto Major Mode}. |
987 | ||
988 | See the related function @code{generate-new-buffer-name} in @ref{Buffer | |
989 | Names}. | |
990 | @end defun | |
991 | ||
992 | @node Killing Buffers | |
993 | @section Killing Buffers | |
994 | @cindex killing buffers | |
995 | @cindex buffers, killing | |
996 | ||
997 | @dfn{Killing a buffer} makes its name unknown to Emacs and makes the | |
998 | memory space it occupied available for other use. | |
999 | ||
1000 | The buffer object for the buffer that has been killed remains in | |
1001 | existence as long as anything refers to it, but it is specially marked | |
1002 | so that you cannot make it current or display it. Killed buffers retain | |
1003 | their identity, however; if you kill two distinct buffers, they remain | |
1004 | distinct according to @code{eq} although both are dead. | |
1005 | ||
1006 | If you kill a buffer that is current or displayed in a window, Emacs | |
1007 | automatically selects or displays some other buffer instead. This means | |
1008 | that killing a buffer can in general change the current buffer. | |
1009 | Therefore, when you kill a buffer, you should also take the precautions | |
1010 | associated with changing the current buffer (unless you happen to know | |
1011 | that the buffer being killed isn't current). @xref{Current Buffer}. | |
1012 | ||
1013 | If you kill a buffer that is the base buffer of one or more indirect | |
1014 | buffers, the indirect buffers are automatically killed as well. | |
1015 | ||
1016 | The @code{buffer-name} of a killed buffer is @code{nil}. You can use | |
1017 | this feature to test whether a buffer has been killed: | |
1018 | ||
1019 | @example | |
1020 | @group | |
1021 | (defun buffer-killed-p (buffer) | |
1022 | "Return t if BUFFER is killed." | |
1023 | (not (buffer-name buffer))) | |
1024 | @end group | |
1025 | @end example | |
1026 | ||
f76f8246 | 1027 | @deffn Command kill-buffer &optional buffer-or-name |
b8d4c8d0 GM |
1028 | This function kills the buffer @var{buffer-or-name}, freeing all its |
1029 | memory for other uses or to be returned to the operating system. If | |
f76f8246 MR |
1030 | @var{buffer-or-name} is @code{nil} or omitted, it kills the current |
1031 | buffer. | |
b8d4c8d0 GM |
1032 | |
1033 | Any processes that have this buffer as the @code{process-buffer} are | |
1034 | sent the @code{SIGHUP} signal, which normally causes them to terminate. | |
1035 | (The basic meaning of @code{SIGHUP} is that a dialup line has been | |
1036 | disconnected.) @xref{Signals to Processes}. | |
1037 | ||
1038 | If the buffer is visiting a file and contains unsaved changes, | |
1039 | @code{kill-buffer} asks the user to confirm before the buffer is killed. | |
1040 | It does this even if not called interactively. To prevent the request | |
1041 | for confirmation, clear the modified flag before calling | |
1042 | @code{kill-buffer}. @xref{Buffer Modification}. | |
1043 | ||
02043db0 EZ |
1044 | This function calls @code{replace-buffer-in-windows} for cleaning up |
1045 | all windows currently displaying the buffer to be killed. | |
f76f8246 | 1046 | |
b8d4c8d0 GM |
1047 | Killing a buffer that is already dead has no effect. |
1048 | ||
1049 | This function returns @code{t} if it actually killed the buffer. It | |
1050 | returns @code{nil} if the user refuses to confirm or if | |
1051 | @var{buffer-or-name} was already dead. | |
1052 | ||
1053 | @smallexample | |
1054 | (kill-buffer "foo.unchanged") | |
1055 | @result{} t | |
1056 | (kill-buffer "foo.changed") | |
1057 | ||
1058 | ---------- Buffer: Minibuffer ---------- | |
1059 | Buffer foo.changed modified; kill anyway? (yes or no) @kbd{yes} | |
1060 | ---------- Buffer: Minibuffer ---------- | |
1061 | ||
1062 | @result{} t | |
1063 | @end smallexample | |
1064 | @end deffn | |
1065 | ||
1066 | @defvar kill-buffer-query-functions | |
1067 | After confirming unsaved changes, @code{kill-buffer} calls the functions | |
1068 | in the list @code{kill-buffer-query-functions}, in order of appearance, | |
1069 | with no arguments. The buffer being killed is the current buffer when | |
1070 | they are called. The idea of this feature is that these functions will | |
1071 | ask for confirmation from the user. If any of them returns @code{nil}, | |
1072 | @code{kill-buffer} spares the buffer's life. | |
1073 | @end defvar | |
1074 | ||
1075 | @defvar kill-buffer-hook | |
1076 | This is a normal hook run by @code{kill-buffer} after asking all the | |
1077 | questions it is going to ask, just before actually killing the buffer. | |
1078 | The buffer to be killed is current when the hook functions run. | |
1079 | @xref{Hooks}. This variable is a permanent local, so its local binding | |
1080 | is not cleared by changing major modes. | |
1081 | @end defvar | |
1082 | ||
01f17ae2 | 1083 | @defopt buffer-offer-save |
b8d4c8d0 GM |
1084 | This variable, if non-@code{nil} in a particular buffer, tells |
1085 | @code{save-buffers-kill-emacs} and @code{save-some-buffers} (if the | |
1086 | second optional argument to that function is @code{t}) to offer to | |
1087 | save that buffer, just as they offer to save file-visiting buffers. | |
1088 | @xref{Definition of save-some-buffers}. The variable | |
1089 | @code{buffer-offer-save} automatically becomes buffer-local when set | |
1090 | for any reason. @xref{Buffer-Local Variables}. | |
01f17ae2 | 1091 | @end defopt |
b8d4c8d0 GM |
1092 | |
1093 | @defvar buffer-save-without-query | |
1094 | This variable, if non-@code{nil} in a particular buffer, tells | |
1095 | @code{save-buffers-kill-emacs} and @code{save-some-buffers} to save | |
1096 | this buffer (if it's modified) without asking the user. The variable | |
1097 | automatically becomes buffer-local when set for any reason. | |
1098 | @end defvar | |
1099 | ||
1100 | @defun buffer-live-p object | |
1101 | This function returns @code{t} if @var{object} is a buffer which has | |
1102 | not been killed, @code{nil} otherwise. | |
1103 | @end defun | |
1104 | ||
1105 | @node Indirect Buffers | |
1106 | @section Indirect Buffers | |
1107 | @cindex indirect buffers | |
1108 | @cindex base buffer | |
1109 | ||
1110 | An @dfn{indirect buffer} shares the text of some other buffer, which | |
1111 | is called the @dfn{base buffer} of the indirect buffer. In some ways it | |
1112 | is the analogue, for buffers, of a symbolic link among files. The base | |
1113 | buffer may not itself be an indirect buffer. | |
1114 | ||
1115 | The text of the indirect buffer is always identical to the text of its | |
1116 | base buffer; changes made by editing either one are visible immediately | |
1117 | in the other. This includes the text properties as well as the characters | |
1118 | themselves. | |
1119 | ||
1120 | In all other respects, the indirect buffer and its base buffer are | |
1121 | completely separate. They have different names, independent values of | |
1122 | point, independent narrowing, independent markers and overlays (though | |
1123 | inserting or deleting text in either buffer relocates the markers and | |
1124 | overlays for both), independent major modes, and independent | |
1125 | buffer-local variable bindings. | |
1126 | ||
1127 | An indirect buffer cannot visit a file, but its base buffer can. If | |
1128 | you try to save the indirect buffer, that actually saves the base | |
1129 | buffer. | |
1130 | ||
1131 | Killing an indirect buffer has no effect on its base buffer. Killing | |
1132 | the base buffer effectively kills the indirect buffer in that it cannot | |
1133 | ever again be the current buffer. | |
1134 | ||
1135 | @deffn Command make-indirect-buffer base-buffer name &optional clone | |
1136 | This creates and returns an indirect buffer named @var{name} whose | |
1137 | base buffer is @var{base-buffer}. The argument @var{base-buffer} may | |
1138 | be a live buffer or the name (a string) of an existing buffer. If | |
1139 | @var{name} is the name of an existing buffer, an error is signaled. | |
1140 | ||
1141 | If @var{clone} is non-@code{nil}, then the indirect buffer originally | |
1142 | shares the ``state'' of @var{base-buffer} such as major mode, minor | |
1143 | modes, buffer local variables and so on. If @var{clone} is omitted | |
1144 | or @code{nil} the indirect buffer's state is set to the default state | |
1145 | for new buffers. | |
1146 | ||
1147 | If @var{base-buffer} is an indirect buffer, its base buffer is used as | |
1148 | the base for the new buffer. If, in addition, @var{clone} is | |
1149 | non-@code{nil}, the initial state is copied from the actual base | |
1150 | buffer, not from @var{base-buffer}. | |
1151 | @end deffn | |
1152 | ||
5854c267 | 1153 | @deffn Command clone-indirect-buffer newname display-flag &optional norecord |
b8d4c8d0 GM |
1154 | This function creates and returns a new indirect buffer that shares |
1155 | the current buffer's base buffer and copies the rest of the current | |
1156 | buffer's attributes. (If the current buffer is not indirect, it is | |
1157 | used as the base buffer.) | |
1158 | ||
1159 | If @var{display-flag} is non-@code{nil}, that means to display the new | |
1160 | buffer by calling @code{pop-to-buffer}. If @var{norecord} is | |
1161 | non-@code{nil}, that means not to put the new buffer to the front of | |
1162 | the buffer list. | |
106e6894 | 1163 | @end deffn |
b8d4c8d0 GM |
1164 | |
1165 | @defun buffer-base-buffer &optional buffer | |
1166 | This function returns the base buffer of @var{buffer}, which defaults | |
1167 | to the current buffer. If @var{buffer} is not indirect, the value is | |
1168 | @code{nil}. Otherwise, the value is another buffer, which is never an | |
1169 | indirect buffer. | |
1170 | @end defun | |
1171 | ||
2aaaf0dd EZ |
1172 | @node Swapping Text |
1173 | @section Swapping Text Between Two Buffers | |
1174 | @cindex swap text between buffers | |
1175 | @cindex virtual buffers | |
1176 | ||
1177 | Specialized modes sometimes need to let the user access from the | |
1178 | same buffer several vastly different types of text. For example, you | |
1179 | may need to display a summary of the buffer text, in addition to | |
1180 | letting the user access the text itself. | |
1181 | ||
1182 | This could be implemented with multiple buffers (kept in sync when | |
1183 | the user edits the text), or with narrowing (@pxref{Narrowing}). But | |
1184 | these alternatives might sometimes become tedious or prohibitively | |
1185 | expensive, especially if each type of text requires expensive | |
1186 | buffer-global operations in order to provide correct display and | |
1187 | editing commands. | |
1188 | ||
1189 | Emacs provides another facility for such modes: you can quickly swap | |
1190 | buffer text between two buffers with @code{buffer-swap-text}. This | |
1191 | function is very fast because it doesn't move any text, it only | |
1192 | changes the internal data structures of the buffer object to point to | |
1193 | a different chunk of text. Using it, you can pretend that a group of | |
1194 | two or more buffers are actually a single virtual buffer that holds | |
1195 | the contents of all the individual buffers together. | |
1196 | ||
1197 | @defun buffer-swap-text buffer | |
85d14563 SM |
1198 | This function swaps the text of the current buffer and that of its |
1199 | argument @var{buffer}. It signals an error if one of the two buffers | |
1200 | is an indirect buffer (@pxref{Indirect Buffers}) or is a base buffer | |
1201 | of an indirect buffer. | |
2aaaf0dd EZ |
1202 | |
1203 | All the buffer properties that are related to the buffer text are | |
1204 | swapped as well: the positions of point and mark, all the markers, the | |
1205 | overlays, the text properties, the undo list, the value of the | |
1206 | @code{enable-multibyte-characters} flag (@pxref{Text Representations, | |
1207 | enable-multibyte-characters}), etc. | |
1208 | @end defun | |
1209 | ||
137987ab RS |
1210 | If you use @code{buffer-swap-text} on a file-visiting buffer, you |
1211 | should set up a hook to save the buffer's original text rather than | |
1212 | what it was swapped with. @code{write-region-annotate-functions} | |
1213 | works for this purpose. You should probably set | |
1214 | @code{buffer-saved-size} to @minus{}2 in the buffer, so that changes | |
1215 | in the text it is swapped with will not interfere with auto-saving. | |
1216 | ||
b8d4c8d0 GM |
1217 | @node Buffer Gap |
1218 | @section The Buffer Gap | |
1219 | ||
1220 | Emacs buffers are implemented using an invisible @dfn{gap} to make | |
1221 | insertion and deletion faster. Insertion works by filling in part of | |
1222 | the gap, and deletion adds to the gap. Of course, this means that the | |
1223 | gap must first be moved to the locus of the insertion or deletion. | |
1224 | Emacs moves the gap only when you try to insert or delete. This is why | |
1225 | your first editing command in one part of a large buffer, after | |
1226 | previously editing in another far-away part, sometimes involves a | |
1227 | noticeable delay. | |
1228 | ||
1229 | This mechanism works invisibly, and Lisp code should never be affected | |
1230 | by the gap's current location, but these functions are available for | |
1231 | getting information about the gap status. | |
1232 | ||
1233 | @defun gap-position | |
1234 | This function returns the current gap position in the current buffer. | |
1235 | @end defun | |
1236 | ||
1237 | @defun gap-size | |
1238 | This function returns the current gap size of the current buffer. | |
1239 | @end defun | |
1240 |