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