Mercurial > emacs
annotate lispref/buffers.texi @ 89657:899286e38bef
*** empty log message ***
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Mon, 24 Nov 2003 08:28:58 +0000 |
parents | 375f2633d815 |
children | 548375b6b1f8 |
rev | line source |
---|---|
6564 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
44346
diff
changeset
|
4 @c Free Software Foundation, Inc. |
6564 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/buffers | |
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 | |
7677 | 13 also be buffers that are not visiting files. While several buffers may |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
14 exist at one time, only one buffer is designated the @dfn{current |
6564 | 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? | |
12067 | 21 * Current Buffer:: Designating a buffer as current |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
22 so that primitives will access its contents. |
6564 | 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. | |
12067 | 32 * Indirect Buffers:: An indirect buffer shares text with some other buffer. |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
33 * Buffer Gap:: The gap in the buffer. |
6564 | 34 @end menu |
35 | |
36 @node Buffer Basics | |
37 @comment node-name, next, previous, up | |
38 @section Buffer Basics | |
39 | |
27193 | 40 @ifnottex |
6564 | 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 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
43 also be buffers that are not visiting files. Although several buffers |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
44 normally exist, only one buffer is designated the @dfn{current |
6564 | 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. | |
27193 | 48 @end ifnottex |
6564 | 49 |
12098 | 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 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
52 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
|
53 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
|
54 buffer. @xref{Text}. |
6564 | 55 |
56 A Lisp buffer object contains numerous pieces of information. Some of | |
57 this information is directly accessible to the programmer through | |
7677 | 58 variables, while other information is accessible only through |
6564 | 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 | |
12067 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
93 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
|
94 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
|
95 displayed on the screen. |
12067 | 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 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
107 that, you must use the functions described in @ref{Displaying Buffers}. |
12067 | 108 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
109 @strong{Note:} Lisp functions that change to a different current buffer |
12067 | 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 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
112 as well as from the command loop; it is convenient for the caller if |
12067 | 113 the subroutine does not change which buffer is current (unless, of |
114 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
|
115 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
|
116 @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
|
117 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
|
118 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
|
119 string abridged): |
12067 | 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))) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
128 (save-current-buffer |
12067 | 129 (set-buffer (get-buffer-create buffer)) |
130 (insert-buffer-substring oldbuf start end)))) | |
131 @end group | |
132 @end example | |
133 | |
134 @noindent | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
135 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
|
136 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
|
137 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
|
138 @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
|
139 current buffer to the specified (and now current) buffer. |
12067 | 140 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
44346
diff
changeset
|
141 If the buffer appended to happens to be displayed in some window, |
12067 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
153 binding. Otherwise, use @code{save-current-buffer} or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
154 @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
|
155 beginning is current again whenever the variable is unbound. |
12067 | 156 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
157 Do not rely on using @code{set-buffer} to change the current buffer |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
158 back, because that won't do the job if a quit happens while the wrong |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
159 buffer is current. Here is what @emph{not} to do: |
12067 | 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 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
172 Using @code{save-current-buffer}, as shown here, handles quitting, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
173 errors, and @code{throw}, as well as ordinary evaluation. |
12067 | 174 |
175 @example | |
176 @group | |
177 (let (buffer-read-only) | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
178 (save-current-buffer |
12067 | 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 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
196 This function makes @var{buffer-or-name} the current buffer. This does |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
197 not display the buffer in any window, so the user cannot necessarily see |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
198 the buffer. But Lisp programs will now operate on it. |
12067 | 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 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
205 @defspec save-current-buffer body... |
49676
5d28b76b587c
(Current Buffer): Describe `save-current-buffer' as a special form, not a macro.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
206 The @code{save-current-buffer} special form saves the identity of the |
5d28b76b587c
(Current Buffer): Describe `save-current-buffer' as a special form, not a macro.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
207 current buffer, evaluates the @var{body} forms, and finally restores |
5d28b76b587c
(Current Buffer): Describe `save-current-buffer' as a special form, not a macro.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
208 that buffer as current. The return value is the value of the last |
5d28b76b587c
(Current Buffer): Describe `save-current-buffer' as a special form, not a macro.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
209 form in @var{body}. The current buffer is restored even in case of an |
5d28b76b587c
(Current Buffer): Describe `save-current-buffer' as a special form, not a macro.
Juanma Barranquero <lekktu@gmail.com>
parents:
49600
diff
changeset
|
210 abnormal 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 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
|
220 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
|
221 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
|
222 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
|
223 abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
224 @end defmac |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
225 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
226 @defmac with-temp-buffer body... |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
227 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
|
228 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
|
229 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
|
230 evaluates the @var{body} forms, and finally restores the previous |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
231 current buffer while killing the temporary buffer. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
232 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
233 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
|
234 return the contents of the temporary buffer by using |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
235 @code{(buffer-string)} as the last form. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
236 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
237 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
|
238 @code{throw} or error (@pxref{Nonlocal Exits}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
239 @end defmac |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
240 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
241 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
|
242 |
6564 | 243 @node Buffer Names |
244 @section Buffer Names | |
245 @cindex buffer names | |
246 | |
247 Each buffer has a unique name, which is a string. Many of the | |
248 functions that work on buffers accept either a buffer or a buffer name | |
249 as an argument. Any argument called @var{buffer-or-name} is of this | |
250 sort, and an error is signaled if it is neither a string nor a buffer. | |
251 Any argument called @var{buffer} must be an actual buffer | |
252 object, not a name. | |
253 | |
254 Buffers that are ephemeral and generally uninteresting to the user | |
12098 | 255 have names starting with a space, so that the @code{list-buffers} and |
40492
93b1df487abe
(Buffer Names): Buffers whose names start with a space, but which visit
Eli Zaretskii <eliz@gnu.org>
parents:
39403
diff
changeset
|
256 @code{buffer-menu} commands don't mention them (but if such a buffer |
93b1df487abe
(Buffer Names): Buffers whose names start with a space, but which visit
Eli Zaretskii <eliz@gnu.org>
parents:
39403
diff
changeset
|
257 visits a file, it @strong{is} mentioned). A name starting with |
6564 | 258 space also initially disables recording undo information; see |
259 @ref{Undo}. | |
260 | |
261 @defun buffer-name &optional buffer | |
262 This function returns the name of @var{buffer} as a string. If | |
263 @var{buffer} is not supplied, it defaults to the current buffer. | |
264 | |
265 If @code{buffer-name} returns @code{nil}, it means that @var{buffer} | |
266 has been killed. @xref{Killing Buffers}. | |
267 | |
268 @example | |
269 @group | |
270 (buffer-name) | |
271 @result{} "buffers.texi" | |
272 @end group | |
273 | |
274 @group | |
275 (setq foo (get-buffer "temp")) | |
276 @result{} #<buffer temp> | |
277 @end group | |
278 @group | |
279 (kill-buffer foo) | |
280 @result{} nil | |
281 @end group | |
282 @group | |
283 (buffer-name foo) | |
284 @result{} nil | |
285 @end group | |
286 @group | |
287 foo | |
288 @result{} #<killed buffer> | |
289 @end group | |
290 @end example | |
291 @end defun | |
292 | |
293 @deffn Command rename-buffer newname &optional unique | |
294 This function renames the current buffer to @var{newname}. An error | |
295 is signaled if @var{newname} is not a string, or if there is already a | |
13229 | 296 buffer with that name. The function returns @var{newname}. |
6564 | 297 |
298 @c Emacs 19 feature | |
299 Ordinarily, @code{rename-buffer} signals an error if @var{newname} is | |
300 already in use. However, if @var{unique} is non-@code{nil}, it modifies | |
301 @var{newname} to make a name that is not in use. Interactively, you can | |
302 make @var{unique} non-@code{nil} with a numeric prefix argument. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
303 (This is how the command @code{rename-uniquely} is implemented.) |
6564 | 304 @end deffn |
305 | |
306 @defun get-buffer buffer-or-name | |
307 This function returns the buffer specified by @var{buffer-or-name}. | |
308 If @var{buffer-or-name} is a string and there is no buffer with that | |
309 name, the value is @code{nil}. If @var{buffer-or-name} is a buffer, it | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
44346
diff
changeset
|
310 is returned as given; that is not very useful, so the argument is usually |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
311 a name. For example: |
6564 | 312 |
313 @example | |
314 @group | |
315 (setq b (get-buffer "lewis")) | |
316 @result{} #<buffer lewis> | |
317 @end group | |
318 @group | |
319 (get-buffer b) | |
320 @result{} #<buffer lewis> | |
321 @end group | |
322 @group | |
323 (get-buffer "Frazzle-nots") | |
324 @result{} nil | |
325 @end group | |
326 @end example | |
327 | |
328 See also the function @code{get-buffer-create} in @ref{Creating Buffers}. | |
329 @end defun | |
330 | |
331 @c Emacs 19 feature | |
26239 | 332 @defun generate-new-buffer-name starting-name &rest ignore |
6564 | 333 This function returns a name that would be unique for a new buffer---but |
334 does not create the buffer. It starts with @var{starting-name}, and | |
335 produces a name not currently in use for any buffer by appending a | |
336 number inside of @samp{<@dots{}>}. | |
337 | |
26239 | 338 If the optional second argument @var{ignore} is non-@code{nil}, it |
27301
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
339 should be a string; it makes a difference if it is a name in the |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
340 sequence of names to be tried. That name will be considered acceptable, |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
341 if it is tried, even if a buffer with that name exists. Thus, if |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
342 buffers named @samp{foo}, @samp{foo<2>}, @samp{foo<3>} and @samp{foo<4>} |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
343 exist, |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
344 |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
345 @example |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
346 (generate-new-buffer-name "foo") |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
347 @result{} "foo<5>" |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
348 (generate-new-buffer-name "foo" "foo<3>") |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
349 @result{} "foo<3>" |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
350 (generate-new-buffer-name "foo" "foo<6>") |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
351 @result{} "foo<5>" |
8c79b30d8475
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
352 @end example |
26239 | 353 |
6564 | 354 See the related function @code{generate-new-buffer} in @ref{Creating |
355 Buffers}. | |
356 @end defun | |
357 | |
358 @node Buffer File Name | |
359 @section Buffer File Name | |
360 @cindex visited file | |
361 @cindex buffer file name | |
362 @cindex file name of buffer | |
363 | |
364 The @dfn{buffer file name} is the name of the file that is visited in | |
365 that buffer. When a buffer is not visiting a file, its buffer file name | |
366 is @code{nil}. Most of the time, the buffer name is the same as the | |
367 nondirectory part of the buffer file name, but the buffer file name and | |
368 the buffer name are distinct and can be set independently. | |
369 @xref{Visiting Files}. | |
370 | |
371 @defun buffer-file-name &optional buffer | |
372 This function returns the absolute file name of the file that | |
373 @var{buffer} is visiting. If @var{buffer} is not visiting any file, | |
374 @code{buffer-file-name} returns @code{nil}. If @var{buffer} is not | |
375 supplied, it defaults to the current buffer. | |
376 | |
377 @example | |
378 @group | |
379 (buffer-file-name (other-buffer)) | |
380 @result{} "/usr/user/lewis/manual/files.texi" | |
381 @end group | |
382 @end example | |
383 @end defun | |
384 | |
385 @defvar buffer-file-name | |
386 This buffer-local variable contains the name of the file being visited | |
387 in the current buffer, or @code{nil} if it is not visiting a file. It | |
25950
7996385fc601
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
388 is a permanent local variable, unaffected by |
7996385fc601
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
389 @code{kill-all-local-variables}. |
6564 | 390 |
391 @example | |
392 @group | |
393 buffer-file-name | |
394 @result{} "/usr/user/lewis/manual/buffers.texi" | |
395 @end group | |
396 @end example | |
397 | |
398 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
|
399 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
|
400 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
|
401 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
|
402 Emacs. |
6564 | 403 @end defvar |
404 | |
405 @defvar buffer-file-truename | |
406 This buffer-local variable holds the truename of the file visited in the | |
407 current buffer, or @code{nil} if no file is visited. It is a permanent | |
25950
7996385fc601
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
408 local, unaffected by @code{kill-all-local-variables}. @xref{Truenames}. |
6564 | 409 @end defvar |
410 | |
411 @defvar buffer-file-number | |
412 This buffer-local variable holds the file number and directory device | |
413 number of the file visited in the current buffer, or @code{nil} if no | |
414 file or a nonexistent file is visited. It is a permanent local, | |
25950
7996385fc601
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25751
diff
changeset
|
415 unaffected by @code{kill-all-local-variables}. |
6564 | 416 |
417 The value is normally a list of the form @code{(@var{filenum} | |
418 @var{devnum})}. This pair of numbers uniquely identifies the file among | |
419 all files accessible on the system. See the function | |
420 @code{file-attributes}, in @ref{File Attributes}, for more information | |
421 about them. | |
422 @end defvar | |
423 | |
424 @defun get-file-buffer filename | |
425 This function returns the buffer visiting file @var{filename}. If | |
426 there is no such buffer, it returns @code{nil}. The argument | |
427 @var{filename}, which must be a string, is expanded (@pxref{File Name | |
428 Expansion}), then compared against the visited file names of all live | |
429 buffers. | |
430 | |
431 @example | |
432 @group | |
433 (get-file-buffer "buffers.texi") | |
434 @result{} #<buffer buffers.texi> | |
435 @end group | |
436 @end example | |
437 | |
438 In unusual circumstances, there can be more than one buffer visiting | |
439 the same file name. In such cases, this function returns the first | |
440 such buffer in the buffer list. | |
441 @end defun | |
442 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
443 @deffn Command set-visited-file-name filename &optional no-query along-with-file |
6564 | 444 If @var{filename} is a non-empty string, this function changes the |
26239 | 445 name of the file visited in the current buffer to @var{filename}. (If the |
6564 | 446 buffer had no visited file, this gives it one.) The @emph{next time} |
88123 | 447 the buffer is saved it will go in the newly-specified file. This |
448 command marks the buffer as modified, since it does not (as far as Emacs | |
449 knows) match the contents of @var{filename}, even if it matched the | |
450 former visited file. | |
6564 | 451 |
452 If @var{filename} is @code{nil} or the empty string, that stands for | |
453 ``no visited file''. In this case, @code{set-visited-file-name} marks | |
454 the buffer as having no visited file. | |
455 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
456 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
|
457 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
|
458 asking this question. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
459 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
460 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
|
461 former visited file has been renamed to @var{filename}. |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
462 |
6564 | 463 @c Wordy to avoid overfull hbox. --rjc 16mar92 |
464 When the function @code{set-visited-file-name} is called interactively, it | |
465 prompts for @var{filename} in the minibuffer. | |
466 @end deffn | |
467 | |
468 @defvar list-buffers-directory | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
469 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
|
470 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
|
471 have a visited file name. Dired buffers use this variable. |
6564 | 472 @end defvar |
473 | |
474 @node Buffer Modification | |
475 @section Buffer Modification | |
476 @cindex buffer modification | |
477 @cindex modification flag (of buffer) | |
478 | |
479 Emacs keeps a flag called the @dfn{modified flag} for each buffer, to | |
480 record whether you have changed the text of the buffer. This flag is | |
481 set to @code{t} whenever you alter the contents of the buffer, and | |
482 cleared to @code{nil} when you save it. Thus, the flag shows whether | |
483 there are unsaved changes. The flag value is normally shown in the mode | |
484 line (@pxref{Mode Line Variables}), and controls saving (@pxref{Saving | |
485 Buffers}) and auto-saving (@pxref{Auto-Saving}). | |
486 | |
487 Some Lisp programs set the flag explicitly. For example, the function | |
488 @code{set-visited-file-name} sets the flag to @code{t}, because the text | |
489 does not match the newly-visited file, even if it is unchanged from the | |
490 file formerly visited. | |
491 | |
492 The functions that modify the contents of buffers are described in | |
493 @ref{Text}. | |
494 | |
495 @defun buffer-modified-p &optional buffer | |
496 This function returns @code{t} if the buffer @var{buffer} has been modified | |
497 since it was last read in from a file or saved, or @code{nil} | |
498 otherwise. If @var{buffer} is not supplied, the current buffer | |
499 is tested. | |
500 @end defun | |
501 | |
502 @defun set-buffer-modified-p flag | |
503 This function marks the current buffer as modified if @var{flag} is | |
504 non-@code{nil}, or as unmodified if the flag is @code{nil}. | |
505 | |
506 Another effect of calling this function is to cause unconditional | |
507 redisplay of the mode line for the current buffer. In fact, the | |
508 function @code{force-mode-line-update} works by doing this: | |
509 | |
510 @example | |
511 @group | |
512 (set-buffer-modified-p (buffer-modified-p)) | |
513 @end group | |
514 @end example | |
515 @end defun | |
516 | |
517 @deffn Command not-modified | |
13229 | 518 This command marks the current buffer as unmodified, and not needing to |
519 be saved. With prefix arg, it marks the buffer as modified, so that it | |
520 will be saved at the next suitable occasion. | |
521 | |
522 Don't use this function in programs, since it prints a message in the | |
523 echo area; use @code{set-buffer-modified-p} (above) instead. | |
6564 | 524 @end deffn |
525 | |
526 @c Emacs 19 feature | |
527 @defun buffer-modified-tick &optional buffer | |
13229 | 528 This function returns @var{buffer}'s modification-count. This is a |
6564 | 529 counter that increments every time the buffer is modified. If |
530 @var{buffer} is @code{nil} (or omitted), the current buffer is used. | |
531 @end defun | |
532 | |
533 @node Modification Time | |
534 @comment node-name, next, previous, up | |
535 @section Comparison of Modification Time | |
536 @cindex comparison of modification time | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
44346
diff
changeset
|
537 @cindex modification time, comparison of |
6564 | 538 |
539 Suppose that you visit a file and make changes in its buffer, and | |
540 meanwhile the file itself is changed on disk. At this point, saving the | |
541 buffer would overwrite the changes in the file. Occasionally this may | |
542 be what you want, but usually it would lose valuable information. Emacs | |
543 therefore checks the file's modification time using the functions | |
544 described below before saving the file. | |
545 | |
546 @defun verify-visited-file-modtime buffer | |
547 This function compares what @var{buffer} has recorded for the | |
548 modification time of its visited file against the actual modification | |
549 time of the file as recorded by the operating system. The two should be | |
550 the same unless some other process has written the file since Emacs | |
551 visited or saved it. | |
552 | |
553 The function returns @code{t} if the last actual modification time and | |
554 Emacs's recorded modification time are the same, @code{nil} otherwise. | |
555 @end defun | |
556 | |
557 @defun clear-visited-file-modtime | |
558 This function clears out the record of the last modification time of | |
559 the file being visited by the current buffer. As a result, the next | |
560 attempt to save this buffer will not complain of a discrepancy in | |
561 file modification times. | |
562 | |
563 This function is called in @code{set-visited-file-name} and other | |
564 exceptional places where the usual test to avoid overwriting a changed | |
565 file should not be done. | |
566 @end defun | |
567 | |
568 @c Emacs 19 feature | |
569 @defun visited-file-modtime | |
570 This function returns the buffer's recorded last file modification time, | |
571 as a list of the form @code{(@var{high} . @var{low})}. (This is the | |
572 same format that @code{file-attributes} uses to return time values; see | |
573 @ref{File Attributes}.) | |
574 @end defun | |
575 | |
576 @c Emacs 19 feature | |
577 @defun set-visited-file-modtime &optional time | |
578 This function updates the buffer's record of the last modification time | |
579 of the visited file, to the value specified by @var{time} if @var{time} | |
580 is not @code{nil}, and otherwise to the last modification time of the | |
581 visited file. | |
582 | |
583 If @var{time} is not @code{nil}, it should have the form | |
584 @code{(@var{high} . @var{low})} or @code{(@var{high} @var{low})}, in | |
585 either case containing two integers, each of which holds 16 bits of the | |
586 time. | |
587 | |
588 This function is useful if the buffer was not read from the file | |
589 normally, or if the file itself has been changed for some known benign | |
590 reason. | |
591 @end defun | |
592 | |
7677 | 593 @defun ask-user-about-supersession-threat filename |
6564 | 594 @cindex obsolete buffer |
595 This function is used to ask a user how to proceed after an attempt to | |
7677 | 596 modify an obsolete buffer visiting file @var{filename}. An |
597 @dfn{obsolete buffer} is an unmodified buffer for which the associated | |
598 file on disk is newer than the last save-time of the buffer. This means | |
599 some other program has probably altered the file. | |
600 | |
601 @kindex file-supersession | |
602 Depending on the user's answer, the function may return normally, in | |
603 which case the modification of the buffer proceeds, or it may signal a | |
604 @code{file-supersession} error with data @code{(@var{filename})}, in which | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
44346
diff
changeset
|
605 case the proposed buffer modification is not allowed. |
6564 | 606 |
607 This function is called automatically by Emacs on the proper | |
608 occasions. It exists so you can customize Emacs by redefining it. | |
609 See the file @file{userlock.el} for the standard definition. | |
610 | |
611 See also the file locking mechanism in @ref{File Locks}. | |
612 @end defun | |
613 | |
614 @node Read Only Buffers | |
615 @section Read-Only Buffers | |
616 @cindex read-only buffer | |
617 @cindex buffer, read-only | |
618 | |
619 If a buffer is @dfn{read-only}, then you cannot change its contents, | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
44346
diff
changeset
|
620 although you may change your view of the contents by scrolling and |
6564 | 621 narrowing. |
622 | |
623 Read-only buffers are used in two kinds of situations: | |
624 | |
625 @itemize @bullet | |
626 @item | |
627 A buffer visiting a write-protected file is normally read-only. | |
628 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
629 Here, the purpose is to inform the user that editing the buffer with the |
6564 | 630 aim of saving it in the file may be futile or undesirable. The user who |
631 wants to change the buffer text despite this can do so after clearing | |
12098 | 632 the read-only flag with @kbd{C-x C-q}. |
6564 | 633 |
634 @item | |
635 Modes such as Dired and Rmail make buffers read-only when altering the | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
636 contents with the usual editing commands would probably be a mistake. |
6564 | 637 |
638 The special commands of these modes bind @code{buffer-read-only} to | |
639 @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
|
640 @code{t} around the places where they themselves change the text. |
6564 | 641 @end itemize |
642 | |
643 @defvar buffer-read-only | |
644 This buffer-local variable specifies whether the buffer is read-only. | |
645 The buffer is read-only if this variable is non-@code{nil}. | |
646 @end defvar | |
647 | |
648 @defvar inhibit-read-only | |
649 If this variable is non-@code{nil}, then read-only buffers and read-only | |
7677 | 650 characters may be modified. Read-only characters in a buffer are those |
651 that have non-@code{nil} @code{read-only} properties (either text | |
652 properties or overlay properties). @xref{Special Properties}, for more | |
653 information about text properties. @xref{Overlays}, for more | |
654 information about overlays and their properties. | |
6564 | 655 |
7677 | 656 If @code{inhibit-read-only} is @code{t}, all @code{read-only} character |
657 properties have no effect. If @code{inhibit-read-only} is a list, then | |
658 @code{read-only} character properties have no effect if they are members | |
659 of the list (comparison is done with @code{eq}). | |
6564 | 660 @end defvar |
661 | |
662 @deffn Command toggle-read-only | |
663 This command changes whether the current buffer is read-only. It is | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
664 intended for interactive use; do not use it in programs. At any given |
6564 | 665 point in a program, you should know whether you want the read-only flag |
666 on or off; so you can set @code{buffer-read-only} explicitly to the | |
667 proper value, @code{t} or @code{nil}. | |
668 @end deffn | |
669 | |
670 @defun barf-if-buffer-read-only | |
671 This function signals a @code{buffer-read-only} error if the current | |
672 buffer is read-only. @xref{Interactive Call}, for another way to | |
673 signal an error if the current buffer is read-only. | |
674 @end defun | |
675 | |
676 @node The Buffer List | |
677 @section The Buffer List | |
678 @cindex buffer list | |
679 | |
680 The @dfn{buffer list} is a list of all live buffers. Creating a | |
50466
e4180f608731
Clarify when buffer list is reordered.
Richard M. Stallman <rms@gnu.org>
parents:
49676
diff
changeset
|
681 buffer adds it to this list, and killing a buffer removes it. The |
e4180f608731
Clarify when buffer list is reordered.
Richard M. Stallman <rms@gnu.org>
parents:
49676
diff
changeset
|
682 order of the buffers in the list is based primarily on how recently |
e4180f608731
Clarify when buffer list is reordered.
Richard M. Stallman <rms@gnu.org>
parents:
49676
diff
changeset
|
683 each buffer has been displayed in the selected window. Buffers move |
e4180f608731
Clarify when buffer list is reordered.
Richard M. Stallman <rms@gnu.org>
parents:
49676
diff
changeset
|
684 to the front of the list when they are selected (selecting a window |
e4180f608731
Clarify when buffer list is reordered.
Richard M. Stallman <rms@gnu.org>
parents:
49676
diff
changeset
|
685 that already displays the buffer counts as selecting the buffer), and |
e4180f608731
Clarify when buffer list is reordered.
Richard M. Stallman <rms@gnu.org>
parents:
49676
diff
changeset
|
686 to the end when they are buried (see @code{bury-buffer}, below). |
e4180f608731
Clarify when buffer list is reordered.
Richard M. Stallman <rms@gnu.org>
parents:
49676
diff
changeset
|
687 Several functions, notably @code{other-buffer}, use this ordering. A |
e4180f608731
Clarify when buffer list is reordered.
Richard M. Stallman <rms@gnu.org>
parents:
49676
diff
changeset
|
688 buffer list displayed for the user also follows this order. |
6564 | 689 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
690 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
|
691 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
|
692 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
|
693 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
|
694 @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
|
695 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
|
696 afterward, ordered according to the fundamental Emacs buffer list. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
697 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
698 @defun buffer-list &optional frame |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
699 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
|
700 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
|
701 their names. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
702 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
703 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
|
704 @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
|
705 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
|
706 which frames they were selected in. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
707 |
6564 | 708 @example |
709 @group | |
710 (buffer-list) | |
711 @result{} (#<buffer buffers.texi> | |
712 #<buffer *Minibuf-1*> #<buffer buffer.c> | |
713 #<buffer *Help*> #<buffer TAGS>) | |
714 @end group | |
715 | |
716 @group | |
717 ;; @r{Note that the name of the minibuffer} | |
718 ;; @r{begins with a space!} | |
719 (mapcar (function buffer-name) (buffer-list)) | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
44346
diff
changeset
|
720 @result{} ("buffers.texi" " *Minibuf-1*" |
6564 | 721 "buffer.c" "*Help*" "TAGS") |
722 @end group | |
723 @end example | |
15862
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
724 @end defun |
6564 | 725 |
15862
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
726 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
|
727 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
|
728 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
|
729 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
|
730 is an easy way: |
15862
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
731 |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
732 @example |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
733 (defun reorder-buffer-list (new-list) |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
734 (while new-list |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
735 (bury-buffer (car new-list)) |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
736 (setq new-list (cdr new-list)))) |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
737 @end example |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
738 |
d0a061b594a1
Show how to reorder buffers.
Richard M. Stallman <rms@gnu.org>
parents:
13247
diff
changeset
|
739 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
|
740 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
|
741 live buffer. |
6564 | 742 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
743 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
|
744 @code{buffer-list} frame parameter with @code{modify-frame-parameters} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
745 (@pxref{Parameter Access}). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
746 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
747 @defun other-buffer &optional buffer visible-ok frame |
6564 | 748 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
|
749 @var{buffer}. Usually this is the buffer selected most recently (in |
39403
f242022750ee
(The Buffer List): Add cross-references to the definition of selected frame.
Eli Zaretskii <eliz@gnu.org>
parents:
27301
diff
changeset
|
750 frame @var{frame} or else the currently selected frame, @pxref{Input |
f242022750ee
(The Buffer List): Add cross-references to the definition of selected frame.
Eli Zaretskii <eliz@gnu.org>
parents:
27301
diff
changeset
|
751 Focus}), aside from @var{buffer}. Buffers whose names start with a |
f242022750ee
(The Buffer List): Add cross-references to the definition of selected frame.
Eli Zaretskii <eliz@gnu.org>
parents:
27301
diff
changeset
|
752 space are not considered at all. |
6564 | 753 |
13247
750f4d22537f
Arg of other-buffer can't be a buffer name.
Richard M. Stallman <rms@gnu.org>
parents:
13229
diff
changeset
|
754 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
|
755 @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
|
756 buffer list that is not now visible in any window in a visible frame. |
6564 | 757 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
758 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
|
759 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
|
760 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
|
761 is @code{nil}, that buffer is ignored. @xref{Window Frame Parameters}. |
12067 | 762 |
6564 | 763 @c Emacs 19 feature |
764 If @var{visible-ok} is @code{nil}, @code{other-buffer} avoids returning | |
765 a buffer visible in any window on any visible frame, except as a last | |
766 resort. If @var{visible-ok} is non-@code{nil}, then it does not matter | |
767 whether a buffer is displayed somewhere or not. | |
768 | |
769 If no suitable buffer exists, the buffer @samp{*scratch*} is returned | |
770 (and created, if necessary). | |
771 @end defun | |
772 | |
773 @deffn Command bury-buffer &optional buffer-or-name | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
774 This function puts @var{buffer-or-name} at the end of the buffer list, |
6564 | 775 without changing the order of any of the other buffers on the list. |
776 This buffer therefore becomes the least desirable candidate for | |
777 @code{other-buffer} to return. | |
778 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
779 @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
|
780 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
|
781 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
|
782 @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
|
783 |
7677 | 784 If @var{buffer-or-name} is @code{nil} or omitted, this means to bury the |
785 current buffer. In addition, if the buffer is displayed in the selected | |
786 window, this switches to some other buffer (obtained using | |
787 @code{other-buffer}) in the selected window. But if the buffer is | |
788 displayed in some other window, it remains displayed there. | |
6564 | 789 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
15862
diff
changeset
|
790 To replace a buffer in all the windows that display it, use |
6564 | 791 @code{replace-buffer-in-windows}. @xref{Buffers and Windows}. |
792 @end deffn | |
793 | |
794 @node Creating Buffers | |
795 @section Creating Buffers | |
796 @cindex creating buffers | |
797 @cindex buffers, creating | |
798 | |
799 This section describes the two primitives for creating buffers. | |
7677 | 800 @code{get-buffer-create} creates a buffer if it finds no existing buffer |
801 with the specified name; @code{generate-new-buffer} always creates a new | |
802 buffer and gives it a unique name. | |
6564 | 803 |
804 Other functions you can use to create buffers include | |
805 @code{with-output-to-temp-buffer} (@pxref{Temporary Displays}) and | |
806 @code{create-file-buffer} (@pxref{Visiting Files}). Starting a | |
807 subprocess can also create a buffer (@pxref{Processes}). | |
808 | |
809 @defun get-buffer-create name | |
810 This function returns a buffer named @var{name}. It returns an existing | |
811 buffer with that name, if one exists; otherwise, it creates a new | |
812 buffer. The buffer does not become the current buffer---this function | |
813 does not change which buffer is current. | |
814 | |
815 An error is signaled if @var{name} is not a string. | |
816 | |
817 @example | |
818 @group | |
819 (get-buffer-create "foo") | |
820 @result{} #<buffer foo> | |
821 @end group | |
822 @end example | |
823 | |
12067 | 824 The major mode for the new buffer is set to Fundamental mode. The |
825 variable @code{default-major-mode} is handled at a higher level. | |
826 @xref{Auto Major Mode}. | |
6564 | 827 @end defun |
828 | |
829 @defun generate-new-buffer name | |
830 This function returns a newly created, empty buffer, but does not make | |
831 it current. If there is no buffer named @var{name}, then that is the | |
832 name of the new buffer. If that name is in use, this function adds | |
7677 | 833 suffixes of the form @samp{<@var{n}>} to @var{name}, where @var{n} is an |
834 integer. It tries successive integers starting with 2 until it finds an | |
835 available name. | |
6564 | 836 |
837 An error is signaled if @var{name} is not a string. | |
838 | |
839 @example | |
840 @group | |
841 (generate-new-buffer "bar") | |
842 @result{} #<buffer bar> | |
843 @end group | |
844 @group | |
845 (generate-new-buffer "bar") | |
846 @result{} #<buffer bar<2>> | |
847 @end group | |
848 @group | |
849 (generate-new-buffer "bar") | |
850 @result{} #<buffer bar<3>> | |
851 @end group | |
852 @end example | |
853 | |
12067 | 854 The major mode for the new buffer is set to Fundamental mode. The |
855 variable @code{default-major-mode} is handled at a higher level. | |
856 @xref{Auto Major Mode}. | |
6564 | 857 |
858 See the related function @code{generate-new-buffer-name} in @ref{Buffer | |
859 Names}. | |
860 @end defun | |
861 | |
862 @node Killing Buffers | |
863 @section Killing Buffers | |
864 @cindex killing buffers | |
865 @cindex buffers, killing | |
866 | |
867 @dfn{Killing a buffer} makes its name unknown to Emacs and makes its | |
7677 | 868 text space available for other use. |
6564 | 869 |
7677 | 870 The buffer object for the buffer that has been killed remains in |
6564 | 871 existence as long as anything refers to it, but it is specially marked |
872 so that you cannot make it current or display it. Killed buffers retain | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
873 their identity, however; if you kill two distinct buffers, they remain |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
874 distinct according to @code{eq} although both are dead. |
6564 | 875 |
876 If you kill a buffer that is current or displayed in a window, Emacs | |
877 automatically selects or displays some other buffer instead. This means | |
878 that killing a buffer can in general change the current buffer. | |
879 Therefore, when you kill a buffer, you should also take the precautions | |
880 associated with changing the current buffer (unless you happen to know | |
881 that the buffer being killed isn't current). @xref{Current Buffer}. | |
882 | |
12098 | 883 If you kill a buffer that is the base buffer of one or more indirect |
884 buffers, the indirect buffers are automatically killed as well. | |
885 | |
6564 | 886 The @code{buffer-name} of a killed buffer is @code{nil}. You can use |
887 this feature to test whether a buffer has been killed: | |
888 | |
889 @example | |
890 @group | |
891 (defun buffer-killed-p (buffer) | |
892 "Return t if BUFFER is killed." | |
893 (not (buffer-name buffer))) | |
894 @end group | |
895 @end example | |
896 | |
897 @deffn Command kill-buffer buffer-or-name | |
898 This function kills the buffer @var{buffer-or-name}, freeing all its | |
13229 | 899 memory for other uses or to be returned to the operating system. It |
900 returns @code{nil}. | |
6564 | 901 |
902 Any processes that have this buffer as the @code{process-buffer} are | |
903 sent the @code{SIGHUP} signal, which normally causes them to terminate. | |
904 (The basic meaning of @code{SIGHUP} is that a dialup line has been | |
44346
43dc1031ba62
Fix the xref for sending SIGHUP.
Richard M. Stallman <rms@gnu.org>
parents:
40492
diff
changeset
|
905 disconnected.) @xref{Signals to Processes}. |
6564 | 906 |
907 If the buffer is visiting a file and contains unsaved changes, | |
908 @code{kill-buffer} asks the user to confirm before the buffer is killed. | |
909 It does this even if not called interactively. To prevent the request | |
910 for confirmation, clear the modified flag before calling | |
911 @code{kill-buffer}. @xref{Buffer Modification}. | |
912 | |
913 Killing a buffer that is already dead has no effect. | |
914 | |
915 @smallexample | |
916 (kill-buffer "foo.unchanged") | |
917 @result{} nil | |
918 (kill-buffer "foo.changed") | |
919 | |
920 ---------- Buffer: Minibuffer ---------- | |
921 Buffer foo.changed modified; kill anyway? (yes or no) @kbd{yes} | |
922 ---------- Buffer: Minibuffer ---------- | |
923 | |
924 @result{} nil | |
925 @end smallexample | |
926 @end deffn | |
927 | |
7542
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
928 @defvar kill-buffer-query-functions |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
929 After confirming unsaved changes, @code{kill-buffer} calls the functions |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
930 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
|
931 with no arguments. The buffer being killed is the current buffer when |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
932 they are called. The idea of this feature is that these functions will |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
933 ask for confirmation from the user. If any of them returns @code{nil}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
934 @code{kill-buffer} spares the buffer's life. |
7542
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
935 @end defvar |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
936 |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
937 @defvar kill-buffer-hook |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
938 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
|
939 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
|
940 The buffer to be killed is current when the hook functions run. |
51925
803b9aa5604e
(Killing Buffers): kill-buffer-hook is perm local.
Richard M. Stallman <rms@gnu.org>
parents:
50466
diff
changeset
|
941 @xref{Hooks}. This variable is a permanent local, so its local binding |
803b9aa5604e
(Killing Buffers): kill-buffer-hook is perm local.
Richard M. Stallman <rms@gnu.org>
parents:
50466
diff
changeset
|
942 is not cleared by changing major modes. |
7542
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
943 @end defvar |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
944 |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
945 @defvar buffer-offer-save |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
946 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
|
947 @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
|
948 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
|
949 variable @code{buffer-offer-save} automatically becomes buffer-local |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
950 when set for any reason. @xref{Buffer-Local Variables}. |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
951 @end defvar |
b93516a5dcda
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
952 |
12067 | 953 @node Indirect Buffers |
954 @section Indirect Buffers | |
955 @cindex indirect buffers | |
956 @cindex base buffer | |
6564 | 957 |
12067 | 958 An @dfn{indirect buffer} shares the text of some other buffer, which |
959 is called the @dfn{base buffer} of the indirect buffer. In some ways it | |
12098 | 960 is the analogue, for buffers, of a symbolic link among files. The base |
12067 | 961 buffer may not itself be an indirect buffer. |
6564 | 962 |
12067 | 963 The text of the indirect buffer is always identical to the text of its |
964 base buffer; changes made by editing either one are visible immediately | |
965 in the other. This includes the text properties as well as the characters | |
966 themselves. | |
6564 | 967 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
968 In all other respects, the indirect buffer and its base buffer are |
12067 | 969 completely separate. They have different names, different values of |
970 point, different narrowing, different markers and overlays (though | |
971 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
|
972 overlays for both), different major modes, and different buffer-local |
12067 | 973 variables. |
6564 | 974 |
12067 | 975 An indirect buffer cannot visit a file, but its base buffer can. If |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
976 you try to save the indirect buffer, that actually saves the base |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24951
diff
changeset
|
977 buffer. |
6564 | 978 |
12067 | 979 Killing an indirect buffer has no effect on its base buffer. Killing |
980 the base buffer effectively kills the indirect buffer in that it cannot | |
981 ever again be the current buffer. | |
6564 | 982 |
12067 | 983 @deffn Command make-indirect-buffer base-buffer name |
984 This creates an indirect buffer named @var{name} whose base buffer | |
985 is @var{base-buffer}. The argument @var{base-buffer} may be a buffer | |
986 or a string. | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
44346
diff
changeset
|
987 |
12067 | 988 If @var{base-buffer} is an indirect buffer, its base buffer is used as |
989 the base for the new buffer. | |
990 @end deffn | |
6564 | 991 |
12067 | 992 @defun buffer-base-buffer buffer |
993 This function returns the base buffer of @var{buffer}. If @var{buffer} | |
994 is not indirect, the value is @code{nil}. Otherwise, the value is | |
995 another buffer, which is never an indirect buffer. | |
6564 | 996 @end defun |
997 | |
24951
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
998 @node Buffer Gap |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
999 @section The Buffer Gap |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1000 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1001 Emacs buffers are implemented using an invisible @dfn{gap} to make |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1002 insertion and deletion faster. Insertion works by filling in part of |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1003 the gap, and deletion adds to the gap. Of course, this means that the |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1004 gap must first be moved to the locus of the insertion or deletion. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1005 Emacs moves the gap only when you try to insert or delete. This is why |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1006 your first editing command in one part of a large buffer, after |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1007 previously editing in another far-away part, sometimes involves a |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1008 noticeable delay. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1009 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1010 This mechanism works invisibly, and Lisp code should never be affected |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1011 by the gap's current location, but these functions are available for |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1012 getting information about the gap status. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1013 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1014 @defun gap-position |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1015 This function returns the current gap position in the current buffer. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1016 @end defun |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1017 |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1018 @defun gap-size |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1019 This function returns the current gap size of the current buffer. |
7451b1458af1
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
1020 @end defun |