Mercurial > emacs
annotate lispref/buffers.texi @ 23641:b13886e06eb2
(delete-whitespace-rectangle): close-rectangle renamed.
(close-rectangle): Define as alias.
author | Karl Heuer <kwzh@gnu.org> |
---|---|
date | Thu, 05 Nov 1998 19:12:21 +0000 |
parents | 40089afa2b1d |
children | 7451b1458af1 |
rev | line source |
---|---|
6564 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6564 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/buffers | |
6 @node Buffers, Windows, Backups and Auto-Saving, Top | |
7 @chapter Buffers | |
8 @cindex buffer | |
9 | |
10 A @dfn{buffer} is a Lisp object containing text to be edited. Buffers | |
11 are used to hold the contents of files that are being visited; there may | |
7677 | 12 also be buffers that are not visiting files. While several buffers may |
6564 | 13 exist at one time, exactly one buffer is designated the @dfn{current |
14 buffer} at any time. Most editing commands act on the contents of the | |
15 current buffer. Each buffer, including the current buffer, may or may | |
16 not be displayed in any windows. | |
17 | |
18 @menu | |
19 * Buffer Basics:: What is a buffer? | |
12067 | 20 * Current Buffer:: Designating a buffer as current |
21 so primitives will access its contents. | |
6564 | 22 * Buffer Names:: Accessing and changing buffer names. |
23 * Buffer File Name:: The buffer file name indicates which file is visited. | |
24 * Buffer Modification:: A buffer is @dfn{modified} if it needs to be saved. | |
25 * Modification Time:: Determining whether the visited file was changed | |
26 ``behind Emacs's back''. | |
27 * Read Only Buffers:: Modifying text is not allowed in a read-only buffer. | |
28 * The Buffer List:: How to look at all the existing buffers. | |
29 * Creating Buffers:: Functions that create buffers. | |
30 * Killing Buffers:: Buffers exist until explicitly killed. | |
12067 | 31 * Indirect Buffers:: An indirect buffer shares text with some other buffer. |
6564 | 32 @end menu |
33 | |
34 @node Buffer Basics | |
35 @comment node-name, next, previous, up | |
36 @section Buffer Basics | |
37 | |
38 @ifinfo | |
39 A @dfn{buffer} is a Lisp object containing text to be edited. Buffers | |
40 are used to hold the contents of files that are being visited; there may | |
7677 | 41 also be buffers that are not visiting files. While several buffers may |
6564 | 42 exist at one time, exactly one buffer is designated the @dfn{current |
43 buffer} at any time. Most editing commands act on the contents of the | |
44 current buffer. Each buffer, including the current buffer, may or may | |
45 not be displayed in any windows. | |
46 @end ifinfo | |
47 | |
12098 | 48 Buffers in Emacs editing are objects that have distinct names and hold |
49 text that can be edited. Buffers appear to Lisp programs as a special | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
50 data type. You can think of the contents of a buffer as a string that |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
51 you can extend; insertions and deletions may occur in any part of the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
52 buffer. @xref{Text}. |
6564 | 53 |
54 A Lisp buffer object contains numerous pieces of information. Some of | |
55 this information is directly accessible to the programmer through | |
7677 | 56 variables, while other information is accessible only through |
6564 | 57 special-purpose functions. For example, the visited file name is |
58 directly accessible through a variable, while the value of point is | |
59 accessible only through a primitive function. | |
60 | |
61 Buffer-specific information that is directly accessible is stored in | |
62 @dfn{buffer-local} variable bindings, which are variable values that are | |
63 effective only in a particular buffer. This feature allows each buffer | |
64 to override the values of certain variables. Most major modes override | |
65 variables such as @code{fill-column} or @code{comment-column} in this | |
66 way. For more information about buffer-local variables and functions | |
67 related to them, see @ref{Buffer-Local Variables}. | |
68 | |
69 For functions and variables related to visiting files in buffers, see | |
70 @ref{Visiting Files} and @ref{Saving Buffers}. For functions and | |
71 variables related to the display of buffers in windows, see | |
72 @ref{Buffers and Windows}. | |
73 | |
74 @defun bufferp object | |
75 This function returns @code{t} if @var{object} is a buffer, | |
76 @code{nil} otherwise. | |
77 @end defun | |
78 | |
12067 | 79 @node Current Buffer |
80 @section The Current Buffer | |
81 @cindex selecting a buffer | |
82 @cindex changing to another buffer | |
83 @cindex current buffer | |
84 | |
85 There are, in general, many buffers in an Emacs session. At any time, | |
86 one of them is designated as the @dfn{current buffer}. This is the | |
87 buffer in which most editing takes place, because most of the primitives | |
88 for examining or changing text in a buffer operate implicitly on the | |
89 current buffer (@pxref{Text}). Normally the buffer that is displayed on | |
90 the screen in the selected window is the current buffer, but this is not | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
91 always so: a Lisp program can temporarily designate any buffer as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
92 current in order to operate on its contents, without changing what is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
93 displayed on the screen. |
12067 | 94 |
95 The way to designate a current buffer in a Lisp program is by calling | |
96 @code{set-buffer}. The specified buffer remains current until a new one | |
97 is designated. | |
98 | |
99 When an editing command returns to the editor command loop, the | |
100 command loop designates the buffer displayed in the selected window as | |
101 current, to prevent confusion: the buffer that the cursor is in when | |
102 Emacs reads a command is the buffer that the command will apply to. | |
103 (@xref{Command Loop}.) Therefore, @code{set-buffer} is not the way to | |
104 switch visibly to a different buffer so that the user can edit it. For | |
105 this, you must use the functions described in @ref{Displaying Buffers}. | |
106 | |
107 However, Lisp functions that change to a different current buffer | |
108 should not depend on the command loop to set it back afterwards. | |
109 Editing commands written in Emacs Lisp can be called from other programs | |
110 as well as from the command loop. It is convenient for the caller if | |
111 the subroutine does not change which buffer is current (unless, of | |
112 course, that is the subroutine's purpose). Therefore, you should | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
113 normally use @code{set-buffer} within a @code{save-current-buffer} or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
114 @code{save-excursion} (@pxref{Excursions}) form that will restore the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
115 current buffer when your function is done. Here is an example, the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
116 code for the command @code{append-to-buffer} (with the documentation |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
117 string abridged): |
12067 | 118 |
119 @example | |
120 @group | |
121 (defun append-to-buffer (buffer start end) | |
122 "Append to specified buffer the text of the region. | |
123 @dots{}" | |
124 (interactive "BAppend to buffer: \nr") | |
125 (let ((oldbuf (current-buffer))) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
126 (save-current-buffer |
12067 | 127 (set-buffer (get-buffer-create buffer)) |
128 (insert-buffer-substring oldbuf start end)))) | |
129 @end group | |
130 @end example | |
131 | |
132 @noindent | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
133 This function binds a local variable to record the current buffer, and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
134 then @code{save-current-buffer} arranges to make it current again. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
135 Next, @code{set-buffer} makes the specified buffer current. Finally, |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
136 @code{insert-buffer-substring} copies the string from the original |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
137 current buffer to the specified (and now current) buffer. |
12067 | 138 |
139 If the buffer appended to happens to be displayed in some window, | |
140 the next redisplay will show how its text has changed. Otherwise, you | |
141 will not see the change immediately on the screen. The buffer becomes | |
142 current temporarily during the execution of the command, but this does | |
143 not cause it to be displayed. | |
144 | |
145 If you make local bindings (with @code{let} or function arguments) for | |
146 a variable that may also have buffer-local bindings, make sure that the | |
147 same buffer is current at the beginning and at the end of the local | |
148 binding's scope. Otherwise you might bind it in one buffer and unbind | |
149 it in another! There are two ways to do this. In simple cases, you may | |
150 see that nothing ever changes the current buffer within the scope of the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
151 binding. Otherwise, use @code{save-current-buffer} or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
152 @code{save-excursion} to make sure that the buffer current at the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
153 beginning is current again whenever the variable is unbound. |
12067 | 154 |
155 It is not reliable to change the current buffer back with | |
156 @code{set-buffer}, because that won't do the job if a quit happens while | |
157 the wrong buffer is current. Here is what @emph{not} to do: | |
158 | |
159 @example | |
160 @group | |
161 (let (buffer-read-only | |
162 (obuf (current-buffer))) | |
163 (set-buffer @dots{}) | |
164 @dots{} | |
165 (set-buffer obuf)) | |
166 @end group | |
167 @end example | |
168 | |
169 @noindent | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
170 Using @code{save-current-buffer}, as shown here, handles quitting, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
171 errors, and @code{throw}, as well as ordinary evaluation. |
12067 | 172 |
173 @example | |
174 @group | |
175 (let (buffer-read-only) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
176 (save-current-buffer |
12067 | 177 (set-buffer @dots{}) |
178 @dots{})) | |
179 @end group | |
180 @end example | |
181 | |
182 @defun current-buffer | |
183 This function returns the current buffer. | |
184 | |
185 @example | |
186 @group | |
187 (current-buffer) | |
188 @result{} #<buffer buffers.texi> | |
189 @end group | |
190 @end example | |
191 @end defun | |
192 | |
193 @defun set-buffer buffer-or-name | |
194 This function makes @var{buffer-or-name} the current buffer. It does | |
195 not display the buffer in the currently selected window or in any other | |
196 window, so the user cannot necessarily see the buffer. But Lisp | |
197 programs can in any case work on it. | |
198 | |
199 This function returns the buffer identified by @var{buffer-or-name}. | |
200 An error is signaled if @var{buffer-or-name} does not identify an | |
201 existing buffer. | |
202 @end defun | |
203 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
204 @defspec save-current-buffer body... |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
205 @tindex save-current-buffer |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
206 The @code{save-current-buffer} macro saves the identity of the current |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
207 buffer, evaluates the @var{body} forms, and finally restores that buffer |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
208 as current. The return value is the value of the last form in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
209 @var{body}. The current buffer is restored even in case of an abnormal |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
210 exit via @code{throw} or error (@pxref{Nonlocal Exits}). |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
211 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
212 If the buffer that used to be current has been killed by the time of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
213 exit from @code{save-current-buffer}, then it is not made current again, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
214 of course. Instead, whichever buffer was current just before exit |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
215 remains current. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
216 @end defspec |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
217 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
218 @defmac with-current-buffer buffer body... |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
219 @tindex with-current-buffer |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
220 The @code{with-current-buffer} macro saves the identity of the current |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
221 buffer, makes @var{buffer} current, evaluates the @var{body} forms, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
222 finally restores the buffer. The return value is the value of the last |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
223 form in @var{body}. The current buffer is restored even in case of an |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
224 abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
225 @end defmac |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
226 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
227 @defmac with-temp-buffer body... |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
228 @tindex with-temp-buffer |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
229 The @code{with-temp-buffer} macro evaluates the @var{body} forms |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
230 with a temporary buffer as the current buffer. It saves the identity of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
231 the current buffer, creates a temporary buffer and makes it current, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
232 evaluates the @var{body} forms, and finally restores the previous |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
233 current buffer while killing the temporary buffer. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
234 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
235 The return value is the value of the last form in @var{body}. You can |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
236 return the contents of the temporary buffer by using |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
237 @code{(buffer-string)} as the last form. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
238 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
239 The current buffer is restored even in case of an abnormal exit via |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
240 @code{throw} or error (@pxref{Nonlocal Exits}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
241 @end defmac |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
242 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
243 See also @code{with-temp-file} in @ref{Writing to Files}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
244 |
6564 | 245 @node Buffer Names |
246 @section Buffer Names | |
247 @cindex buffer names | |
248 | |
249 Each buffer has a unique name, which is a string. Many of the | |
250 functions that work on buffers accept either a buffer or a buffer name | |
251 as an argument. Any argument called @var{buffer-or-name} is of this | |
252 sort, and an error is signaled if it is neither a string nor a buffer. | |
253 Any argument called @var{buffer} must be an actual buffer | |
254 object, not a name. | |
255 | |
256 Buffers that are ephemeral and generally uninteresting to the user | |
12098 | 257 have names starting with a space, so that the @code{list-buffers} and |
6564 | 258 @code{buffer-menu} commands don't mention them. A name starting with |
259 space also initially disables recording undo information; see | |
260 @ref{Undo}. | |
261 | |
262 @defun buffer-name &optional buffer | |
263 This function returns the name of @var{buffer} as a string. If | |
264 @var{buffer} is not supplied, it defaults to the current buffer. | |
265 | |
266 If @code{buffer-name} returns @code{nil}, it means that @var{buffer} | |
267 has been killed. @xref{Killing Buffers}. | |
268 | |
269 @example | |
270 @group | |
271 (buffer-name) | |
272 @result{} "buffers.texi" | |
273 @end group | |
274 | |
275 @group | |
276 (setq foo (get-buffer "temp")) | |
277 @result{} #<buffer temp> | |
278 @end group | |
279 @group | |
280 (kill-buffer foo) | |
281 @result{} nil | |
282 @end group | |
283 @group | |
284 (buffer-name foo) | |
285 @result{} nil | |
286 @end group | |
287 @group | |
288 foo | |
289 @result{} #<killed buffer> | |
290 @end group | |
291 @end example | |
292 @end defun | |
293 | |
294 @deffn Command rename-buffer newname &optional unique | |
295 This function renames the current buffer to @var{newname}. An error | |
296 is signaled if @var{newname} is not a string, or if there is already a | |
13229 | 297 buffer with that name. The function returns @var{newname}. |
6564 | 298 |
299 @c Emacs 19 feature | |
300 Ordinarily, @code{rename-buffer} signals an error if @var{newname} is | |
301 already in use. However, if @var{unique} is non-@code{nil}, it modifies | |
302 @var{newname} to make a name that is not in use. Interactively, you can | |
303 make @var{unique} non-@code{nil} with a numeric prefix argument. | |
304 | |
305 One application of this command is to rename the @samp{*shell*} buffer | |
306 to some other name, thus making it possible to create a second shell | |
307 buffer under the name @samp{*shell*}. | |
308 @end deffn | |
309 | |
310 @defun get-buffer buffer-or-name | |
311 This function returns the buffer specified by @var{buffer-or-name}. | |
312 If @var{buffer-or-name} is a string and there is no buffer with that | |
313 name, the value is @code{nil}. If @var{buffer-or-name} is a buffer, it | |
314 is returned as given. (That is not very useful, so the argument is usually | |
315 a name.) For example: | |
316 | |
317 @example | |
318 @group | |
319 (setq b (get-buffer "lewis")) | |
320 @result{} #<buffer lewis> | |
321 @end group | |
322 @group | |
323 (get-buffer b) | |
324 @result{} #<buffer lewis> | |
325 @end group | |
326 @group | |
327 (get-buffer "Frazzle-nots") | |
328 @result{} nil | |
329 @end group | |
330 @end example | |
331 | |
332 See also the function @code{get-buffer-create} in @ref{Creating Buffers}. | |
333 @end defun | |
334 | |
335 @c Emacs 19 feature | |
336 @defun generate-new-buffer-name starting-name | |
337 This function returns a name that would be unique for a new buffer---but | |
338 does not create the buffer. It starts with @var{starting-name}, and | |
339 produces a name not currently in use for any buffer by appending a | |
340 number inside of @samp{<@dots{}>}. | |
341 | |
342 See the related function @code{generate-new-buffer} in @ref{Creating | |
343 Buffers}. | |
344 @end defun | |
345 | |
346 @node Buffer File Name | |
347 @section Buffer File Name | |
348 @cindex visited file | |
349 @cindex buffer file name | |
350 @cindex file name of buffer | |
351 | |
352 The @dfn{buffer file name} is the name of the file that is visited in | |
353 that buffer. When a buffer is not visiting a file, its buffer file name | |
354 is @code{nil}. Most of the time, the buffer name is the same as the | |
355 nondirectory part of the buffer file name, but the buffer file name and | |
356 the buffer name are distinct and can be set independently. | |
357 @xref{Visiting Files}. | |
358 | |
359 @defun buffer-file-name &optional buffer | |
360 This function returns the absolute file name of the file that | |
361 @var{buffer} is visiting. If @var{buffer} is not visiting any file, | |
362 @code{buffer-file-name} returns @code{nil}. If @var{buffer} is not | |
363 supplied, it defaults to the current buffer. | |
364 | |
365 @example | |
366 @group | |
367 (buffer-file-name (other-buffer)) | |
368 @result{} "/usr/user/lewis/manual/files.texi" | |
369 @end group | |
370 @end example | |
371 @end defun | |
372 | |
373 @defvar buffer-file-name | |
374 This buffer-local variable contains the name of the file being visited | |
375 in the current buffer, or @code{nil} if it is not visiting a file. It | |
376 is a permanent local, unaffected by @code{kill-local-variables}. | |
377 | |
378 @example | |
379 @group | |
380 buffer-file-name | |
381 @result{} "/usr/user/lewis/manual/buffers.texi" | |
382 @end group | |
383 @end example | |
384 | |
385 It is risky to change this variable's value without doing various other | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
386 things. Normally it is better to use @code{set-visited-file-name} (see |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
387 below); some of the things done there, such as changing the buffer name, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
388 are not strictly necessary, but others are essential to avoid confusing |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
389 Emacs. |
6564 | 390 @end defvar |
391 | |
392 @defvar buffer-file-truename | |
393 This buffer-local variable holds the truename of the file visited in the | |
394 current buffer, or @code{nil} if no file is visited. It is a permanent | |
395 local, unaffected by @code{kill-local-variables}. @xref{Truenames}. | |
396 @end defvar | |
397 | |
398 @defvar buffer-file-number | |
399 This buffer-local variable holds the file number and directory device | |
400 number of the file visited in the current buffer, or @code{nil} if no | |
401 file or a nonexistent file is visited. It is a permanent local, | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
402 unaffected by @code{kill-local-variables}. |
6564 | 403 |
404 The value is normally a list of the form @code{(@var{filenum} | |
405 @var{devnum})}. This pair of numbers uniquely identifies the file among | |
406 all files accessible on the system. See the function | |
407 @code{file-attributes}, in @ref{File Attributes}, for more information | |
408 about them. | |
409 @end defvar | |
410 | |
411 @defun get-file-buffer filename | |
412 This function returns the buffer visiting file @var{filename}. If | |
413 there is no such buffer, it returns @code{nil}. The argument | |
414 @var{filename}, which must be a string, is expanded (@pxref{File Name | |
415 Expansion}), then compared against the visited file names of all live | |
416 buffers. | |
417 | |
418 @example | |
419 @group | |
420 (get-file-buffer "buffers.texi") | |
421 @result{} #<buffer buffers.texi> | |
422 @end group | |
423 @end example | |
424 | |
425 In unusual circumstances, there can be more than one buffer visiting | |
426 the same file name. In such cases, this function returns the first | |
427 such buffer in the buffer list. | |
428 @end defun | |
429 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
430 @deffn Command set-visited-file-name filename &optional no-query along-with-file |
6564 | 431 If @var{filename} is a non-empty string, this function changes the |
432 name of the file visited in current buffer to @var{filename}. (If the | |
433 buffer had no visited file, this gives it one.) The @emph{next time} | |
434 the buffer is saved it will go in the newly-specified file. This | |
435 command marks the buffer as modified, since it does not (as far as Emacs | |
436 knows) match the contents of @var{filename}, even if it matched the | |
437 former visited file. | |
438 | |
439 If @var{filename} is @code{nil} or the empty string, that stands for | |
440 ``no visited file''. In this case, @code{set-visited-file-name} marks | |
441 the buffer as having no visited file. | |
442 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
443 Normally, this function asks the user for confirmation if the specified |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
444 file already exists. If @var{no-query} is non-@code{nil}, that prevents |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
445 asking this question. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
446 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
447 If @var{along-with-file} is non-@code{nil}, that means to assume that the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
448 former visited file has been renamed to @var{filename}. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
449 |
6564 | 450 @c Wordy to avoid overfull hbox. --rjc 16mar92 |
451 When the function @code{set-visited-file-name} is called interactively, it | |
452 prompts for @var{filename} in the minibuffer. | |
453 @end deffn | |
454 | |
455 @defvar list-buffers-directory | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
456 This buffer-local variable specifies a string to display in a buffer |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
457 listing where the visited file name would go, for buffers that don't |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
458 have a visited file name. Dired buffers use this variable. |
6564 | 459 @end defvar |
460 | |
461 @node Buffer Modification | |
462 @section Buffer Modification | |
463 @cindex buffer modification | |
464 @cindex modification flag (of buffer) | |
465 | |
466 Emacs keeps a flag called the @dfn{modified flag} for each buffer, to | |
467 record whether you have changed the text of the buffer. This flag is | |
468 set to @code{t} whenever you alter the contents of the buffer, and | |
469 cleared to @code{nil} when you save it. Thus, the flag shows whether | |
470 there are unsaved changes. The flag value is normally shown in the mode | |
471 line (@pxref{Mode Line Variables}), and controls saving (@pxref{Saving | |
472 Buffers}) and auto-saving (@pxref{Auto-Saving}). | |
473 | |
474 Some Lisp programs set the flag explicitly. For example, the function | |
475 @code{set-visited-file-name} sets the flag to @code{t}, because the text | |
476 does not match the newly-visited file, even if it is unchanged from the | |
477 file formerly visited. | |
478 | |
479 The functions that modify the contents of buffers are described in | |
480 @ref{Text}. | |
481 | |
482 @defun buffer-modified-p &optional buffer | |
483 This function returns @code{t} if the buffer @var{buffer} has been modified | |
484 since it was last read in from a file or saved, or @code{nil} | |
485 otherwise. If @var{buffer} is not supplied, the current buffer | |
486 is tested. | |
487 @end defun | |
488 | |
489 @defun set-buffer-modified-p flag | |
490 This function marks the current buffer as modified if @var{flag} is | |
491 non-@code{nil}, or as unmodified if the flag is @code{nil}. | |
492 | |
493 Another effect of calling this function is to cause unconditional | |
494 redisplay of the mode line for the current buffer. In fact, the | |
495 function @code{force-mode-line-update} works by doing this: | |
496 | |
497 @example | |
498 @group | |
499 (set-buffer-modified-p (buffer-modified-p)) | |
500 @end group | |
501 @end example | |
502 @end defun | |
503 | |
504 @deffn Command not-modified | |
13229 | 505 This command marks the current buffer as unmodified, and not needing to |
506 be saved. With prefix arg, it marks the buffer as modified, so that it | |
507 will be saved at the next suitable occasion. | |
508 | |
509 Don't use this function in programs, since it prints a message in the | |
510 echo area; use @code{set-buffer-modified-p} (above) instead. | |
6564 | 511 @end deffn |
512 | |
513 @c Emacs 19 feature | |
514 @defun buffer-modified-tick &optional buffer | |
13229 | 515 This function returns @var{buffer}'s modification-count. This is a |
6564 | 516 counter that increments every time the buffer is modified. If |
517 @var{buffer} is @code{nil} (or omitted), the current buffer is used. | |
518 @end defun | |
519 | |
520 @node Modification Time | |
521 @comment node-name, next, previous, up | |
522 @section Comparison of Modification Time | |
523 @cindex comparison of modification time | |
524 @cindex modification time, comparison of | |
525 | |
526 Suppose that you visit a file and make changes in its buffer, and | |
527 meanwhile the file itself is changed on disk. At this point, saving the | |
528 buffer would overwrite the changes in the file. Occasionally this may | |
529 be what you want, but usually it would lose valuable information. Emacs | |
530 therefore checks the file's modification time using the functions | |
531 described below before saving the file. | |
532 | |
533 @defun verify-visited-file-modtime buffer | |
534 This function compares what @var{buffer} has recorded for the | |
535 modification time of its visited file against the actual modification | |
536 time of the file as recorded by the operating system. The two should be | |
537 the same unless some other process has written the file since Emacs | |
538 visited or saved it. | |
539 | |
540 The function returns @code{t} if the last actual modification time and | |
541 Emacs's recorded modification time are the same, @code{nil} otherwise. | |
542 @end defun | |
543 | |
544 @defun clear-visited-file-modtime | |
545 This function clears out the record of the last modification time of | |
546 the file being visited by the current buffer. As a result, the next | |
547 attempt to save this buffer will not complain of a discrepancy in | |
548 file modification times. | |
549 | |
550 This function is called in @code{set-visited-file-name} and other | |
551 exceptional places where the usual test to avoid overwriting a changed | |
552 file should not be done. | |
553 @end defun | |
554 | |
555 @c Emacs 19 feature | |
556 @defun visited-file-modtime | |
557 This function returns the buffer's recorded last file modification time, | |
558 as a list of the form @code{(@var{high} . @var{low})}. (This is the | |
559 same format that @code{file-attributes} uses to return time values; see | |
560 @ref{File Attributes}.) | |
561 @end defun | |
562 | |
563 @c Emacs 19 feature | |
564 @defun set-visited-file-modtime &optional time | |
565 This function updates the buffer's record of the last modification time | |
566 of the visited file, to the value specified by @var{time} if @var{time} | |
567 is not @code{nil}, and otherwise to the last modification time of the | |
568 visited file. | |
569 | |
570 If @var{time} is not @code{nil}, it should have the form | |
571 @code{(@var{high} . @var{low})} or @code{(@var{high} @var{low})}, in | |
572 either case containing two integers, each of which holds 16 bits of the | |
573 time. | |
574 | |
575 This function is useful if the buffer was not read from the file | |
576 normally, or if the file itself has been changed for some known benign | |
577 reason. | |
578 @end defun | |
579 | |
7677 | 580 @defun ask-user-about-supersession-threat filename |
6564 | 581 @cindex obsolete buffer |
582 This function is used to ask a user how to proceed after an attempt to | |
7677 | 583 modify an obsolete buffer visiting file @var{filename}. An |
584 @dfn{obsolete buffer} is an unmodified buffer for which the associated | |
585 file on disk is newer than the last save-time of the buffer. This means | |
586 some other program has probably altered the file. | |
587 | |
588 @kindex file-supersession | |
589 Depending on the user's answer, the function may return normally, in | |
590 which case the modification of the buffer proceeds, or it may signal a | |
591 @code{file-supersession} error with data @code{(@var{filename})}, in which | |
592 case the proposed buffer modification is not allowed. | |
6564 | 593 |
594 This function is called automatically by Emacs on the proper | |
595 occasions. It exists so you can customize Emacs by redefining it. | |
596 See the file @file{userlock.el} for the standard definition. | |
597 | |
598 See also the file locking mechanism in @ref{File Locks}. | |
599 @end defun | |
600 | |
601 @node Read Only Buffers | |
602 @section Read-Only Buffers | |
603 @cindex read-only buffer | |
604 @cindex buffer, read-only | |
605 | |
606 If a buffer is @dfn{read-only}, then you cannot change its contents, | |
607 although you may change your view of the contents by scrolling and | |
608 narrowing. | |
609 | |
610 Read-only buffers are used in two kinds of situations: | |
611 | |
612 @itemize @bullet | |
613 @item | |
614 A buffer visiting a write-protected file is normally read-only. | |
615 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
616 Here, the purpose is to inform the user that editing the buffer with the |
6564 | 617 aim of saving it in the file may be futile or undesirable. The user who |
618 wants to change the buffer text despite this can do so after clearing | |
12098 | 619 the read-only flag with @kbd{C-x C-q}. |
6564 | 620 |
621 @item | |
622 Modes such as Dired and Rmail make buffers read-only when altering the | |
623 contents with the usual editing commands is probably a mistake. | |
624 | |
625 The special commands of these modes bind @code{buffer-read-only} to | |
626 @code{nil} (with @code{let}) or bind @code{inhibit-read-only} to | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
627 @code{t} around the places where they themselves change the text. |
6564 | 628 @end itemize |
629 | |
630 @defvar buffer-read-only | |
631 This buffer-local variable specifies whether the buffer is read-only. | |
632 The buffer is read-only if this variable is non-@code{nil}. | |
633 @end defvar | |
634 | |
635 @defvar inhibit-read-only | |
636 If this variable is non-@code{nil}, then read-only buffers and read-only | |
7677 | 637 characters may be modified. Read-only characters in a buffer are those |
638 that have non-@code{nil} @code{read-only} properties (either text | |
639 properties or overlay properties). @xref{Special Properties}, for more | |
640 information about text properties. @xref{Overlays}, for more | |
641 information about overlays and their properties. | |
6564 | 642 |
7677 | 643 If @code{inhibit-read-only} is @code{t}, all @code{read-only} character |
644 properties have no effect. If @code{inhibit-read-only} is a list, then | |
645 @code{read-only} character properties have no effect if they are members | |
646 of the list (comparison is done with @code{eq}). | |
6564 | 647 @end defvar |
648 | |
649 @deffn Command toggle-read-only | |
650 This command changes whether the current buffer is read-only. It is | |
651 intended for interactive use; don't use it in programs. At any given | |
652 point in a program, you should know whether you want the read-only flag | |
653 on or off; so you can set @code{buffer-read-only} explicitly to the | |
654 proper value, @code{t} or @code{nil}. | |
655 @end deffn | |
656 | |
657 @defun barf-if-buffer-read-only | |
658 This function signals a @code{buffer-read-only} error if the current | |
659 buffer is read-only. @xref{Interactive Call}, for another way to | |
660 signal an error if the current buffer is read-only. | |
661 @end defun | |
662 | |
663 @node The Buffer List | |
664 @section The Buffer List | |
665 @cindex buffer list | |
666 | |
667 The @dfn{buffer list} is a list of all live buffers. Creating a | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
668 buffer adds it to this list, and killing a buffer excises it. The order |
6564 | 669 of the buffers in the list is based primarily on how recently each |
670 buffer has been displayed in the selected window. Buffers move to the | |
671 front of the list when they are selected and to the end when they are | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
672 buried (see @code{bury-buffer}, below). Several functions, notably |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
673 @code{other-buffer}, use this ordering. A buffer list displayed for the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
674 user also follows this order. |
6564 | 675 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
676 In addition to the fundamental Emacs buffer list, each frame has its |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
677 own version of the buffer list, in which the buffers that have been |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
678 selected in that frame come first, starting with the buffers most |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
679 recently selected @emph{in that frame}. (This order is recorded in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
680 @var{frame}'s @code{buffer-list} frame parameter; see @ref{Window Frame |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
681 Parameters}.) The buffers that were never selected in @var{frame} come |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
682 afterward, ordered according to the fundamental Emacs buffer list. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
683 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
684 @defun buffer-list &optional frame |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
685 This function returns the buffer list, including all buffers, even those |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
686 whose names begin with a space. The elements are actual buffers, not |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
687 their names. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
688 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
689 If @var{frame} is a frame, this returns @var{frame}'s buffer list. If |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
690 @var{frame} is @code{nil}, the fundamental Emacs buffer list is used: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
691 all the buffers appear in order of most recent selection, regardless of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
692 which frames they were selected in. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
693 |
6564 | 694 @example |
695 @group | |
696 (buffer-list) | |
697 @result{} (#<buffer buffers.texi> | |
698 #<buffer *Minibuf-1*> #<buffer buffer.c> | |
699 #<buffer *Help*> #<buffer TAGS>) | |
700 @end group | |
701 | |
702 @group | |
703 ;; @r{Note that the name of the minibuffer} | |
704 ;; @r{begins with a space!} | |
705 (mapcar (function buffer-name) (buffer-list)) | |
706 @result{} ("buffers.texi" " *Minibuf-1*" | |
707 "buffer.c" "*Help*" "TAGS") | |
708 @end group | |
709 @end example | |
15862
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
710 @end defun |
6564 | 711 |
15862
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
712 The list that @code{buffer-list} returns is constructed specifically |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
713 by @code{buffer-list}; it is not an internal Emacs data structure, and |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
714 modifying it has no effect on the order of buffers. If you want to |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
715 change the order of buffers in the frame-independent buffer list, here |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
716 is an easy way: |
15862
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
717 |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
718 @example |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
719 (defun reorder-buffer-list (new-list) |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
720 (while new-list |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
721 (bury-buffer (car new-list)) |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
722 (setq new-list (cdr new-list)))) |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
723 @end example |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
724 |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
725 With this method, you can specify any order for the list, but there is |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
726 no danger of losing a buffer or adding something that is not a valid |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
727 live buffer. |
6564 | 728 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
729 To change the order or value of a frame's buffer list, set the frame's |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
730 @code{buffer-list} frame parameter with @code{modify-frame-parameters} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
731 (@pxref{Parameter Access}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
732 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
733 @defun other-buffer &optional buffer visible-ok frame |
6564 | 734 This function returns the first buffer in the buffer list other than |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
735 @var{buffer}. Usually this is the buffer selected most recently (in |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
736 frame @var{frame} or else the currently selected frame), aside from |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
737 @var{buffer}. Buffers whose names start with a space are not considered |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
738 at all. |
6564 | 739 |
13247
750f4d22537f
Arg of other-buffer can't be a buffer name.
Richard M. Stallman <rms@gnu.org>
parents:
13229
diff
changeset
|
740 If @var{buffer} is not supplied (or if it is not a buffer), then |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
741 @code{other-buffer} returns the first buffer in the selected frame's |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
742 buffer list that is not now visible in any window in a visible frame. |
6564 | 743 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
744 If @var{frame} has a non-@code{nil} @code{buffer-predicate} parameter, |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
745 then @code{other-buffer} uses that predicate to decide which buffers to |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
746 consider. It calls the predicate once for each buffer, and if the value |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
747 is @code{nil}, that buffer is ignored. @xref{Window Frame Parameters}. |
12067 | 748 |
6564 | 749 @c Emacs 19 feature |
750 If @var{visible-ok} is @code{nil}, @code{other-buffer} avoids returning | |
751 a buffer visible in any window on any visible frame, except as a last | |
752 resort. If @var{visible-ok} is non-@code{nil}, then it does not matter | |
753 whether a buffer is displayed somewhere or not. | |
754 | |
755 If no suitable buffer exists, the buffer @samp{*scratch*} is returned | |
756 (and created, if necessary). | |
757 @end defun | |
758 | |
759 @deffn Command bury-buffer &optional buffer-or-name | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
760 This function puts @var{buffer-or-name} at the end of the buffer list, |
6564 | 761 without changing the order of any of the other buffers on the list. |
762 This buffer therefore becomes the least desirable candidate for | |
763 @code{other-buffer} to return. | |
764 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
765 @code{bury-buffer} operates on each frame's @code{buffer-list} parameter |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
766 as well as the frame-independent Emacs buffer list; therefore, the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
767 buffer that you bury will come last in the value of @code{(buffer-list |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
768 @var{frame})} and in the value of @code{(buffer-list nil)}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
769 |
7677 | 770 If @var{buffer-or-name} is @code{nil} or omitted, this means to bury the |
771 current buffer. In addition, if the buffer is displayed in the selected | |
772 window, this switches to some other buffer (obtained using | |
773 @code{other-buffer}) in the selected window. But if the buffer is | |
774 displayed in some other window, it remains displayed there. | |
6564 | 775 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
776 To replace a buffer in all the windows that display it, use |
6564 | 777 @code{replace-buffer-in-windows}. @xref{Buffers and Windows}. |
778 @end deffn | |
779 | |
780 @node Creating Buffers | |
781 @section Creating Buffers | |
782 @cindex creating buffers | |
783 @cindex buffers, creating | |
784 | |
785 This section describes the two primitives for creating buffers. | |
7677 | 786 @code{get-buffer-create} creates a buffer if it finds no existing buffer |
787 with the specified name; @code{generate-new-buffer} always creates a new | |
788 buffer and gives it a unique name. | |
6564 | 789 |
790 Other functions you can use to create buffers include | |
791 @code{with-output-to-temp-buffer} (@pxref{Temporary Displays}) and | |
792 @code{create-file-buffer} (@pxref{Visiting Files}). Starting a | |
793 subprocess can also create a buffer (@pxref{Processes}). | |
794 | |
795 @defun get-buffer-create name | |
796 This function returns a buffer named @var{name}. It returns an existing | |
797 buffer with that name, if one exists; otherwise, it creates a new | |
798 buffer. The buffer does not become the current buffer---this function | |
799 does not change which buffer is current. | |
800 | |
801 An error is signaled if @var{name} is not a string. | |
802 | |
803 @example | |
804 @group | |
805 (get-buffer-create "foo") | |
806 @result{} #<buffer foo> | |
807 @end group | |
808 @end example | |
809 | |
12067 | 810 The major mode for the new buffer is set to Fundamental mode. The |
811 variable @code{default-major-mode} is handled at a higher level. | |
812 @xref{Auto Major Mode}. | |
6564 | 813 @end defun |
814 | |
815 @defun generate-new-buffer name | |
816 This function returns a newly created, empty buffer, but does not make | |
817 it current. If there is no buffer named @var{name}, then that is the | |
818 name of the new buffer. If that name is in use, this function adds | |
7677 | 819 suffixes of the form @samp{<@var{n}>} to @var{name}, where @var{n} is an |
820 integer. It tries successive integers starting with 2 until it finds an | |
821 available name. | |
6564 | 822 |
823 An error is signaled if @var{name} is not a string. | |
824 | |
825 @example | |
826 @group | |
827 (generate-new-buffer "bar") | |
828 @result{} #<buffer bar> | |
829 @end group | |
830 @group | |
831 (generate-new-buffer "bar") | |
832 @result{} #<buffer bar<2>> | |
833 @end group | |
834 @group | |
835 (generate-new-buffer "bar") | |
836 @result{} #<buffer bar<3>> | |
837 @end group | |
838 @end example | |
839 | |
12067 | 840 The major mode for the new buffer is set to Fundamental mode. The |
841 variable @code{default-major-mode} is handled at a higher level. | |
842 @xref{Auto Major Mode}. | |
6564 | 843 |
844 See the related function @code{generate-new-buffer-name} in @ref{Buffer | |
845 Names}. | |
846 @end defun | |
847 | |
848 @node Killing Buffers | |
849 @section Killing Buffers | |
850 @cindex killing buffers | |
851 @cindex buffers, killing | |
852 | |
853 @dfn{Killing a buffer} makes its name unknown to Emacs and makes its | |
7677 | 854 text space available for other use. |
6564 | 855 |
7677 | 856 The buffer object for the buffer that has been killed remains in |
6564 | 857 existence as long as anything refers to it, but it is specially marked |
858 so that you cannot make it current or display it. Killed buffers retain | |
859 their identity, however; two distinct buffers, when killed, remain | |
860 distinct according to @code{eq}. | |
861 | |
862 If you kill a buffer that is current or displayed in a window, Emacs | |
863 automatically selects or displays some other buffer instead. This means | |
864 that killing a buffer can in general change the current buffer. | |
865 Therefore, when you kill a buffer, you should also take the precautions | |
866 associated with changing the current buffer (unless you happen to know | |
867 that the buffer being killed isn't current). @xref{Current Buffer}. | |
868 | |
12098 | 869 If you kill a buffer that is the base buffer of one or more indirect |
870 buffers, the indirect buffers are automatically killed as well. | |
871 | |
6564 | 872 The @code{buffer-name} of a killed buffer is @code{nil}. You can use |
873 this feature to test whether a buffer has been killed: | |
874 | |
875 @example | |
876 @group | |
877 (defun buffer-killed-p (buffer) | |
878 "Return t if BUFFER is killed." | |
879 (not (buffer-name buffer))) | |
880 @end group | |
881 @end example | |
882 | |
883 @deffn Command kill-buffer buffer-or-name | |
884 This function kills the buffer @var{buffer-or-name}, freeing all its | |
13229 | 885 memory for other uses or to be returned to the operating system. It |
886 returns @code{nil}. | |
6564 | 887 |
888 Any processes that have this buffer as the @code{process-buffer} are | |
889 sent the @code{SIGHUP} signal, which normally causes them to terminate. | |
890 (The basic meaning of @code{SIGHUP} is that a dialup line has been | |
891 disconnected.) @xref{Deleting Processes}. | |
892 | |
893 If the buffer is visiting a file and contains unsaved changes, | |
894 @code{kill-buffer} asks the user to confirm before the buffer is killed. | |
895 It does this even if not called interactively. To prevent the request | |
896 for confirmation, clear the modified flag before calling | |
897 @code{kill-buffer}. @xref{Buffer Modification}. | |
898 | |
899 Killing a buffer that is already dead has no effect. | |
900 | |
901 @smallexample | |
902 (kill-buffer "foo.unchanged") | |
903 @result{} nil | |
904 (kill-buffer "foo.changed") | |
905 | |
906 ---------- Buffer: Minibuffer ---------- | |
907 Buffer foo.changed modified; kill anyway? (yes or no) @kbd{yes} | |
908 ---------- Buffer: Minibuffer ---------- | |
909 | |
910 @result{} nil | |
911 @end smallexample | |
912 @end deffn | |
913 | |
7542
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
914 @defvar kill-buffer-query-functions |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
915 After confirming unsaved changes, @code{kill-buffer} calls the functions |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
916 in the list @code{kill-buffer-query-functions}, in order of appearance, |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
917 with no arguments. The buffer being killed is the current buffer when |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
918 they are called. The idea is that these functions ask for confirmation |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
919 from the user for various nonstandard reasons. If any of them returns |
11545
a91fcb58e8d2
Fix backwards test in kill-buffer-query-functions.
Richard M. Stallman <rms@gnu.org>
parents:
7677
diff
changeset
|
920 @code{nil}, @code{kill-buffer} spares the buffer's life. |
7542
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
921 @end defvar |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
922 |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
923 @defvar kill-buffer-hook |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
924 This is a normal hook run by @code{kill-buffer} after asking all the |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
925 questions it is going to ask, just before actually killing the buffer. |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
926 The buffer to be killed is current when the hook functions run. |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
927 @xref{Hooks}. |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
928 @end defvar |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
929 |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
930 @defvar buffer-offer-save |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
931 This variable, if non-@code{nil} in a particular buffer, tells |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
932 @code{save-buffers-kill-emacs} and @code{save-some-buffers} to offer to |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
933 save that buffer, just as they offer to save file-visiting buffers. The |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
934 variable @code{buffer-offer-save} automatically becomes buffer-local |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
935 when set for any reason. @xref{Buffer-Local Variables}. |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
936 @end defvar |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
937 |
12067 | 938 @node Indirect Buffers |
939 @section Indirect Buffers | |
940 @cindex indirect buffers | |
941 @cindex base buffer | |
6564 | 942 |
12067 | 943 An @dfn{indirect buffer} shares the text of some other buffer, which |
944 is called the @dfn{base buffer} of the indirect buffer. In some ways it | |
12098 | 945 is the analogue, for buffers, of a symbolic link among files. The base |
12067 | 946 buffer may not itself be an indirect buffer. |
6564 | 947 |
12067 | 948 The text of the indirect buffer is always identical to the text of its |
949 base buffer; changes made by editing either one are visible immediately | |
950 in the other. This includes the text properties as well as the characters | |
951 themselves. | |
6564 | 952 |
12067 | 953 But in all other respects, the indirect buffer and its base buffer are |
954 completely separate. They have different names, different values of | |
955 point, different narrowing, different markers and overlays (though | |
956 inserting or deleting text in either buffer relocates the markers and | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
957 overlays for both), different major modes, and different buffer-local |
12067 | 958 variables. |
6564 | 959 |
12067 | 960 An indirect buffer cannot visit a file, but its base buffer can. If |
961 you try to save the indirect buffer, that actually works by saving the | |
962 base buffer. | |
6564 | 963 |
12067 | 964 Killing an indirect buffer has no effect on its base buffer. Killing |
965 the base buffer effectively kills the indirect buffer in that it cannot | |
966 ever again be the current buffer. | |
6564 | 967 |
12067 | 968 @deffn Command make-indirect-buffer base-buffer name |
969 This creates an indirect buffer named @var{name} whose base buffer | |
970 is @var{base-buffer}. The argument @var{base-buffer} may be a buffer | |
971 or a string. | |
972 | |
973 If @var{base-buffer} is an indirect buffer, its base buffer is used as | |
974 the base for the new buffer. | |
975 @end deffn | |
6564 | 976 |
12067 | 977 @defun buffer-base-buffer buffer |
978 This function returns the base buffer of @var{buffer}. If @var{buffer} | |
979 is not indirect, the value is @code{nil}. Otherwise, the value is | |
980 another buffer, which is never an indirect buffer. | |
6564 | 981 @end defun |
982 |