Mercurial > emacs
annotate lispref/text.texi @ 11555:4cc0a5e1bdac
Explan when boundaries are made automatically.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 25 Apr 1995 05:29:11 +0000 |
parents | 981b97215c46 |
children | 73dc8205d259 |
rev | line source |
---|---|
6558 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/text | |
6 @node Text, Searching and Matching, Markers, Top | |
7 @chapter Text | |
8 @cindex text | |
9 | |
10 This chapter describes the functions that deal with the text in a | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
11 buffer. Most examine, insert, or delete text in the current buffer, |
6558 | 12 often in the vicinity of point. Many are interactive. All the |
13 functions that change the text provide for undoing the changes | |
14 (@pxref{Undo}). | |
15 | |
16 Many text-related functions operate on a region of text defined by two | |
17 buffer positions passed in arguments named @var{start} and @var{end}. | |
18 These arguments should be either markers (@pxref{Markers}) or numeric | |
19 character positions (@pxref{Positions}). The order of these arguments | |
20 does not matter; it is all right for @var{start} to be the end of the | |
21 region and @var{end} the beginning. For example, @code{(delete-region 1 | |
22 10)} and @code{(delete-region 10 1)} are equivalent. An | |
23 @code{args-out-of-range} error is signaled if either @var{start} or | |
24 @var{end} is outside the accessible portion of the buffer. In an | |
25 interactive call, point and the mark are used for these arguments. | |
26 | |
27 @cindex buffer contents | |
28 Throughout this chapter, ``text'' refers to the characters in the | |
29 buffer. | |
30 | |
31 @menu | |
32 * Near Point:: Examining text in the vicinity of point. | |
33 * Buffer Contents:: Examining text in a general fashion. | |
34 * Comparing Text:: Comparing substrings of buffers. | |
35 * Insertion:: Adding new text to a buffer. | |
36 * Commands for Insertion:: User-level commands to insert text. | |
37 * Deletion:: Removing text from a buffer. | |
38 * User-Level Deletion:: User-level commands to delete text. | |
39 * The Kill Ring:: Where removed text sometimes is saved for later use. | |
40 * Undo:: Undoing changes to the text of a buffer. | |
41 * Maintaining Undo:: How to enable and disable undo information. | |
42 How to control how much information is kept. | |
43 * Filling:: Functions for explicit filling. | |
44 * Auto Filling:: How auto-fill mode is implemented to break lines. | |
45 * Sorting:: Functions for sorting parts of the buffer. | |
46 * Columns:: Computing horizontal positions, and using them. | |
47 * Indentation:: Functions to insert or adjust indentation. | |
48 * Case Changes:: Case conversion of parts of the buffer. | |
49 * Text Properties:: Assigning Lisp property lists to text characters. | |
50 * Substitution:: Replacing a given character wherever it appears. | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
51 * Transposition:: Swapping two portions of a buffer. |
6558 | 52 * Registers:: How registers are implemented. Accessing the text or |
53 position stored in a register. | |
54 * Change Hooks:: Supplying functions to be run when text is changed. | |
55 @end menu | |
56 | |
57 @node Near Point | |
58 @section Examining Text Near Point | |
59 | |
60 Many functions are provided to look at the characters around point. | |
61 Several simple functions are described here. See also @code{looking-at} | |
62 in @ref{Regexp Search}. | |
63 | |
64 @defun char-after position | |
65 This function returns the character in the current buffer at (i.e., | |
66 immediately after) position @var{position}. If @var{position} is out of | |
67 range for this purpose, either before the beginning of the buffer, or at | |
68 or beyond the end, then the value is @code{nil}. | |
69 | |
70 In the following example, assume that the first character in the | |
71 buffer is @samp{@@}: | |
72 | |
73 @example | |
74 @group | |
75 (char-to-string (char-after 1)) | |
76 @result{} "@@" | |
77 @end group | |
78 @end example | |
79 @end defun | |
80 | |
81 @defun following-char | |
82 This function returns the character following point in the current | |
83 buffer. This is similar to @code{(char-after (point))}. However, if | |
84 point is at the end of the buffer, then @code{following-char} returns 0. | |
85 | |
86 Remember that point is always between characters, and the terminal | |
87 cursor normally appears over the character following point. Therefore, | |
88 the character returned by @code{following-char} is the character the | |
89 cursor is over. | |
90 | |
91 In this example, point is between the @samp{a} and the @samp{c}. | |
92 | |
93 @example | |
94 @group | |
95 ---------- Buffer: foo ---------- | |
96 Gentlemen may cry ``Pea@point{}ce! Peace!,'' | |
97 but there is no peace. | |
98 ---------- Buffer: foo ---------- | |
99 @end group | |
100 | |
101 @group | |
102 (char-to-string (preceding-char)) | |
103 @result{} "a" | |
104 (char-to-string (following-char)) | |
105 @result{} "c" | |
106 @end group | |
107 @end example | |
108 @end defun | |
109 | |
110 @defun preceding-char | |
111 This function returns the character preceding point in the current | |
112 buffer. See above, under @code{following-char}, for an example. If | |
113 point is at the beginning of the buffer, @code{preceding-char} returns | |
114 0. | |
115 @end defun | |
116 | |
117 @defun bobp | |
118 This function returns @code{t} if point is at the beginning of the | |
119 buffer. If narrowing is in effect, this means the beginning of the | |
120 accessible portion of the text. See also @code{point-min} in | |
121 @ref{Point}. | |
122 @end defun | |
123 | |
124 @defun eobp | |
125 This function returns @code{t} if point is at the end of the buffer. | |
126 If narrowing is in effect, this means the end of accessible portion of | |
127 the text. See also @code{point-max} in @xref{Point}. | |
128 @end defun | |
129 | |
130 @defun bolp | |
131 This function returns @code{t} if point is at the beginning of a line. | |
132 @xref{Text Lines}. The beginning of the buffer (or its accessible | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
133 portion) always counts as the beginning of a line. |
6558 | 134 @end defun |
135 | |
136 @defun eolp | |
137 This function returns @code{t} if point is at the end of a line. The | |
138 end of the buffer (or of its accessible portion) is always considered | |
139 the end of a line. | |
140 @end defun | |
141 | |
142 @node Buffer Contents | |
143 @section Examining Buffer Contents | |
144 | |
145 This section describes two functions that allow a Lisp program to | |
146 convert any portion of the text in the buffer into a string. | |
147 | |
148 @defun buffer-substring start end | |
149 This function returns a string containing a copy of the text of the | |
150 region defined by positions @var{start} and @var{end} in the current | |
151 buffer. If the arguments are not positions in the accessible portion of | |
152 the buffer, @code{buffer-substring} signals an @code{args-out-of-range} | |
153 error. | |
154 | |
155 It is not necessary for @var{start} to be less than @var{end}; the | |
156 arguments can be given in either order. But most often the smaller | |
157 argument is written first. | |
158 | |
159 @example | |
160 @group | |
161 ---------- Buffer: foo ---------- | |
162 This is the contents of buffer foo | |
163 | |
164 ---------- Buffer: foo ---------- | |
165 @end group | |
166 | |
167 @group | |
168 (buffer-substring 1 10) | |
169 @result{} "This is t" | |
170 @end group | |
171 @group | |
172 (buffer-substring (point-max) 10) | |
173 @result{} "he contents of buffer foo | |
174 " | |
175 @end group | |
176 @end example | |
177 @end defun | |
178 | |
179 @defun buffer-string | |
180 This function returns the contents of the accessible portion of the | |
181 current buffer as a string. This is the portion between | |
182 @code{(point-min)} and @code{(point-max)} (@pxref{Narrowing}). | |
183 | |
184 @example | |
185 @group | |
186 ---------- Buffer: foo ---------- | |
187 This is the contents of buffer foo | |
188 | |
189 ---------- Buffer: foo ---------- | |
190 | |
191 (buffer-string) | |
192 @result{} "This is the contents of buffer foo | |
193 " | |
194 @end group | |
195 @end example | |
196 @end defun | |
197 | |
198 @node Comparing Text | |
199 @section Comparing Text | |
200 @cindex comparing buffer text | |
201 | |
202 This function lets you compare portions of the text in a buffer, without | |
203 copying them into strings first. | |
204 | |
205 @defun compare-buffer-substrings buffer1 start1 end1 buffer2 start2 end2 | |
206 This function lets you compare two substrings of the same buffer or two | |
207 different buffers. The first three arguments specify one substring, | |
208 giving a buffer and two positions within the buffer. The last three | |
209 arguments specify the other substring in the same way. You can use | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
210 @code{nil} for @var{buffer1}, @var{buffer2}, or both to stand for the |
6558 | 211 current buffer. |
212 | |
213 The value is negative if the first substring is less, positive if the | |
214 first is greater, and zero if they are equal. The absolute value of | |
215 the result is one plus the index of the first differing characters | |
216 within the substrings. | |
217 | |
218 This function ignores case when comparing characters | |
219 if @code{case-fold-search} is non-@code{nil}. | |
220 | |
221 Suppose the current buffer contains the text @samp{foobarbar | |
222 haha!rara!}; then in this example the two substrings are @samp{rbar } | |
223 and @samp{rara!}. The value is 2 because the first substring is greater | |
224 at the second character. | |
225 | |
226 @example | |
227 (compare-buffer-substring nil 6 11 nil 16 21) | |
228 @result{} 2 | |
229 @end example | |
230 | |
231 This function does not exist in Emacs version 18 and earlier. | |
232 @end defun | |
233 | |
234 @node Insertion | |
235 @section Insertion | |
236 @cindex insertion of text | |
237 @cindex text insertion | |
238 | |
239 @dfn{Insertion} means adding new text to a buffer. The inserted text | |
240 goes at point---between the character before point and the character | |
241 after point. | |
242 | |
243 Insertion relocates markers that point at positions after the | |
244 insertion point, so that they stay with the surrounding text | |
245 (@pxref{Markers}). When a marker points at the place of insertion, | |
246 insertion normally doesn't relocate the marker, so that it points to the | |
247 beginning of the inserted text; however, certain special functions such | |
248 as @code{insert-before-markers} relocate such markers to point after the | |
249 inserted text. | |
250 | |
251 @cindex insertion before point | |
252 @cindex before point, insertion | |
253 Some insertion functions leave point before the inserted text, while | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
254 other functions leave it after. We call the former insertion @dfn{after |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
255 point} and the latter insertion @dfn{before point}. |
6558 | 256 |
257 Insertion functions signal an error if the current buffer is | |
258 read-only. | |
259 | |
260 @defun insert &rest args | |
261 This function inserts the strings and/or characters @var{args} into the | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
262 current buffer, at point, moving point forward. In other words, it |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
263 inserts the text before point. An error is signaled unless all |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
264 @var{args} are either strings or characters. The value is @code{nil}. |
6558 | 265 @end defun |
266 | |
267 @defun insert-before-markers &rest args | |
268 This function inserts the strings and/or characters @var{args} into the | |
269 current buffer, at point, moving point forward. An error is signaled | |
270 unless all @var{args} are either strings or characters. The value is | |
271 @code{nil}. | |
272 | |
273 This function is unlike the other insertion functions in that it | |
274 relocates markers initially pointing at the insertion point, to point | |
275 after the inserted text. | |
276 @end defun | |
277 | |
8644 | 278 @defun insert-char character count &optional inherit |
6558 | 279 This function inserts @var{count} instances of @var{character} into the |
280 current buffer before point. The argument @var{count} must be a number, | |
281 and @var{character} must be a character. The value is @code{nil}. | |
282 @c It's unfortunate that count comes second. Not like make-string, etc. | |
8644 | 283 |
284 If @var{inherit} is non-@code{nil}, then the inserted characters inherit | |
285 sticky text properties from the two characters before and after the | |
286 insertion point. @xref{Sticky Properties}. | |
6558 | 287 @end defun |
288 | |
289 @defun insert-buffer-substring from-buffer-or-name &optional start end | |
290 This function inserts a portion of buffer @var{from-buffer-or-name} | |
291 (which must already exist) into the current buffer before point. The | |
292 text inserted is the region from @var{start} and @var{end}. (These | |
293 arguments default to the beginning and end of the accessible portion of | |
294 that buffer.) This function returns @code{nil}. | |
295 | |
296 In this example, the form is executed with buffer @samp{bar} as the | |
297 current buffer. We assume that buffer @samp{bar} is initially empty. | |
298 | |
299 @example | |
300 @group | |
301 ---------- Buffer: foo ---------- | |
302 We hold these truths to be self-evident, that all | |
303 ---------- Buffer: foo ---------- | |
304 @end group | |
305 | |
306 @group | |
307 (insert-buffer-substring "foo" 1 20) | |
308 @result{} nil | |
309 | |
310 ---------- Buffer: bar ---------- | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
311 We hold these truth@point{} |
6558 | 312 ---------- Buffer: bar ---------- |
313 @end group | |
314 @end example | |
315 @end defun | |
316 | |
317 @xref{Sticky Properties}, for other insertion functions that inherit | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
318 text properties from the nearby text in addition to inserting it. |
8644 | 319 Whitespace inserted by indentation functions also inherits text |
320 properties. | |
6558 | 321 |
322 @node Commands for Insertion | |
323 @section User-Level Insertion Commands | |
324 | |
325 This section describes higher-level commands for inserting text, | |
326 commands intended primarily for the user but useful also in Lisp | |
327 programs. | |
328 | |
329 @deffn Command insert-buffer from-buffer-or-name | |
330 This command inserts the entire contents of @var{from-buffer-or-name} | |
331 (which must exist) into the current buffer after point. It leaves | |
332 the mark after the inserted text. The value is @code{nil}. | |
333 @end deffn | |
334 | |
335 @deffn Command self-insert-command count | |
336 @cindex character insertion | |
337 @cindex self-insertion | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
338 This command inserts the last character typed; it does so @var{count} |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
339 times, before point, and returns @code{nil}. Most printing characters |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
340 are bound to this command. In routine use, @code{self-insert-command} |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
341 is the most frequently called function in Emacs, but programs rarely use |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
342 it except to install it on a keymap. |
6558 | 343 |
344 In an interactive call, @var{count} is the numeric prefix argument. | |
345 | |
346 This function calls @code{auto-fill-function} if the current column number | |
347 is greater than the value of @code{fill-column} and the character | |
348 inserted is a space (@pxref{Auto Filling}). | |
349 | |
350 @c Cross refs reworded to prevent overfull hbox. --rjc 15mar92 | |
351 This function performs abbrev expansion if Abbrev mode is enabled and | |
352 the inserted character does not have word-constituent | |
353 syntax. (@xref{Abbrevs}, and @ref{Syntax Class Table}.) | |
354 | |
355 This function is also responsible for calling | |
356 @code{blink-paren-function} when the inserted character has close | |
357 parenthesis syntax (@pxref{Blinking}). | |
358 @end deffn | |
359 | |
360 @deffn Command newline &optional number-of-newlines | |
361 This command inserts newlines into the current buffer before point. | |
362 If @var{number-of-newlines} is supplied, that many newline characters | |
363 are inserted. | |
364 | |
365 @cindex newline and Auto Fill mode | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
366 This function calls @code{auto-fill-function} if the current column |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
367 number is greater than the value of @code{fill-column} and |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
368 @var{number-of-newlines} is @code{nil}. Typically what |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
369 @code{auto-fill-function} does is insert a newline; thus, the overall |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
370 result in this case is to insert two newlines at different places: one |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
371 at point, and another earlier in the line. @code{newline} does not |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
372 auto-fill if @var{number-of-newlines} is non-@code{nil}. |
6558 | 373 |
374 The value returned is @code{nil}. In an interactive call, @var{count} | |
375 is the numeric prefix argument. | |
376 @end deffn | |
377 | |
378 @deffn Command split-line | |
379 This command splits the current line, moving the portion of the line | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
380 after point down vertically so that it is on the next line directly |
6558 | 381 below where it was before. Whitespace is inserted as needed at the |
382 beginning of the lower line, using the @code{indent-to} function. | |
383 @code{split-line} returns the position of point. | |
384 | |
385 Programs hardly ever use this function. | |
386 @end deffn | |
387 | |
388 @defvar overwrite-mode | |
389 This variable controls whether overwrite mode is in effect: a | |
390 non-@code{nil} value enables the mode. It is automatically made | |
391 buffer-local when set in any fashion. | |
392 @end defvar | |
393 | |
394 @node Deletion | |
395 @section Deletion of Text | |
396 | |
397 @cindex deletion vs killing | |
398 Deletion means removing part of the text in a buffer, without saving | |
399 it in the kill ring (@pxref{The Kill Ring}). Deleted text can't be | |
400 yanked, but can be reinserted using the undo mechanism (@pxref{Undo}). | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
401 Some deletion functions do save text in the kill ring in some special |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
402 cases. |
6558 | 403 |
404 All of the deletion functions operate on the current buffer, and all | |
405 return a value of @code{nil}. | |
406 | |
407 @defun erase-buffer | |
408 This function deletes the entire text of the current buffer, leaving it | |
409 empty. If the buffer is read-only, it signals a @code{buffer-read-only} | |
410 error. Otherwise, it deletes the text without asking for any | |
411 confirmation. It returns @code{nil}. | |
412 | |
413 Normally, deleting a large amount of text from a buffer inhibits further | |
414 auto-saving of that buffer ``because it has shrunk''. However, | |
415 @code{erase-buffer} does not do this, the idea being that the future | |
416 text is not really related to the former text, and its size should not | |
417 be compared with that of the former text. | |
418 @end defun | |
419 | |
420 @deffn Command delete-region start end | |
421 This command deletes the text in the current buffer in the region | |
422 defined by @var{start} and @var{end}. The value is @code{nil}. | |
423 @end deffn | |
424 | |
425 @deffn Command delete-char count &optional killp | |
426 This command deletes @var{count} characters directly after point, or | |
427 before point if @var{count} is negative. If @var{killp} is | |
428 non-@code{nil}, then it saves the deleted characters in the kill ring. | |
429 | |
430 In an interactive call, @var{count} is the numeric prefix argument, and | |
431 @var{killp} is the unprocessed prefix argument. Therefore, if a prefix | |
432 argument is supplied, the text is saved in the kill ring. If no prefix | |
433 argument is supplied, then one character is deleted, but not saved in | |
434 the kill ring. | |
435 | |
436 The value returned is always @code{nil}. | |
437 @end deffn | |
438 | |
439 @deffn Command delete-backward-char count &optional killp | |
440 @cindex delete previous char | |
441 This command deletes @var{count} characters directly before point, or | |
442 after point if @var{count} is negative. If @var{killp} is | |
443 non-@code{nil}, then it saves the deleted characters in the kill ring. | |
444 | |
445 In an interactive call, @var{count} is the numeric prefix argument, and | |
446 @var{killp} is the unprocessed prefix argument. Therefore, if a prefix | |
447 argument is supplied, the text is saved in the kill ring. If no prefix | |
448 argument is supplied, then one character is deleted, but not saved in | |
449 the kill ring. | |
450 | |
451 The value returned is always @code{nil}. | |
452 @end deffn | |
453 | |
454 @deffn Command backward-delete-char-untabify count &optional killp | |
455 @cindex tab deletion | |
456 This command deletes @var{count} characters backward, changing tabs | |
457 into spaces. When the next character to be deleted is a tab, it is | |
458 first replaced with the proper number of spaces to preserve alignment | |
459 and then one of those spaces is deleted instead of the tab. If | |
460 @var{killp} is non-@code{nil}, then the command saves the deleted | |
461 characters in the kill ring. | |
462 | |
463 Conversion of tabs to spaces happens only if @var{count} is positive. | |
464 If it is negative, exactly @minus{}@var{count} characters after point | |
465 are deleted. | |
466 | |
467 In an interactive call, @var{count} is the numeric prefix argument, and | |
468 @var{killp} is the unprocessed prefix argument. Therefore, if a prefix | |
469 argument is supplied, the text is saved in the kill ring. If no prefix | |
470 argument is supplied, then one character is deleted, but not saved in | |
471 the kill ring. | |
472 | |
473 The value returned is always @code{nil}. | |
474 @end deffn | |
475 | |
476 @node User-Level Deletion | |
477 @section User-Level Deletion Commands | |
478 | |
479 This section describes higher-level commands for deleting text, | |
480 commands intended primarily for the user but useful also in Lisp | |
481 programs. | |
482 | |
483 @deffn Command delete-horizontal-space | |
484 @cindex deleting whitespace | |
485 This function deletes all spaces and tabs around point. It returns | |
486 @code{nil}. | |
487 | |
488 In the following examples, we call @code{delete-horizontal-space} four | |
489 times, once on each line, with point between the second and third | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
490 characters on the line each time. |
6558 | 491 |
492 @example | |
493 @group | |
494 ---------- Buffer: foo ---------- | |
495 I @point{}thought | |
496 I @point{} thought | |
497 We@point{} thought | |
498 Yo@point{}u thought | |
499 ---------- Buffer: foo ---------- | |
500 @end group | |
501 | |
502 @group | |
503 (delete-horizontal-space) ; @r{Four times.} | |
504 @result{} nil | |
505 | |
506 ---------- Buffer: foo ---------- | |
507 Ithought | |
508 Ithought | |
509 Wethought | |
510 You thought | |
511 ---------- Buffer: foo ---------- | |
512 @end group | |
513 @end example | |
514 @end deffn | |
515 | |
516 @deffn Command delete-indentation &optional join-following-p | |
517 This function joins the line point is on to the previous line, deleting | |
518 any whitespace at the join and in some cases replacing it with one | |
519 space. If @var{join-following-p} is non-@code{nil}, | |
520 @code{delete-indentation} joins this line to the following line | |
521 instead. The value is @code{nil}. | |
522 | |
523 If there is a fill prefix, and the second of the lines being joined | |
524 starts with the prefix, then @code{delete-indentation} deletes the | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
525 fill prefix before joining the lines. @xref{Filling}. |
6558 | 526 |
527 In the example below, point is located on the line starting | |
528 @samp{events}, and it makes no difference if there are trailing spaces | |
529 in the preceding line. | |
530 | |
531 @smallexample | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
532 @group |
6558 | 533 ---------- Buffer: foo ---------- |
534 When in the course of human | |
535 @point{} events, it becomes necessary | |
536 ---------- Buffer: foo ---------- | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
537 @end group |
6558 | 538 |
539 (delete-indentation) | |
540 @result{} nil | |
541 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
542 @group |
6558 | 543 ---------- Buffer: foo ---------- |
544 When in the course of human@point{} events, it becomes necessary | |
545 ---------- Buffer: foo ---------- | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
546 @end group |
6558 | 547 @end smallexample |
548 | |
549 After the lines are joined, the function @code{fixup-whitespace} is | |
550 responsible for deciding whether to leave a space at the junction. | |
551 @end deffn | |
552 | |
553 @defun fixup-whitespace | |
554 This function replaces all the white space surrounding point with either | |
555 one space or no space, according to the context. It returns @code{nil}. | |
556 | |
557 At the beginning or end of a line, the appropriate amount of space is | |
558 none. Before a character with close parenthesis syntax, or after a | |
559 character with open parenthesis or expression-prefix syntax, no space is | |
560 also appropriate. Otherwise, one space is appropriate. @xref{Syntax | |
561 Class Table}. | |
562 | |
563 In the example below, @code{fixup-whitespace} is called the first time | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
564 with point before the word @samp{spaces} in the first line. For the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
565 second invocation, point is directly after the @samp{(}. |
6558 | 566 |
567 @smallexample | |
568 @group | |
569 ---------- Buffer: foo ---------- | |
570 This has too many @point{}spaces | |
571 This has too many spaces at the start of (@point{} this list) | |
572 ---------- Buffer: foo ---------- | |
573 @end group | |
574 | |
575 @group | |
576 (fixup-whitespace) | |
577 @result{} nil | |
578 (fixup-whitespace) | |
579 @result{} nil | |
580 @end group | |
581 | |
582 @group | |
583 ---------- Buffer: foo ---------- | |
584 This has too many spaces | |
585 This has too many spaces at the start of (this list) | |
586 ---------- Buffer: foo ---------- | |
587 @end group | |
588 @end smallexample | |
589 @end defun | |
590 | |
591 @deffn Command just-one-space | |
592 @comment !!SourceFile simple.el | |
593 This command replaces any spaces and tabs around point with a single | |
594 space. It returns @code{nil}. | |
595 @end deffn | |
596 | |
597 @deffn Command delete-blank-lines | |
598 This function deletes blank lines surrounding point. If point is on a | |
599 blank line with one or more blank lines before or after it, then all but | |
600 one of them are deleted. If point is on an isolated blank line, then it | |
601 is deleted. If point is on a nonblank line, the command deletes all | |
602 blank lines following it. | |
603 | |
604 A blank line is defined as a line containing only tabs and spaces. | |
605 | |
606 @code{delete-blank-lines} returns @code{nil}. | |
607 @end deffn | |
608 | |
609 @node The Kill Ring | |
610 @section The Kill Ring | |
611 @cindex kill ring | |
612 | |
613 @dfn{Kill} functions delete text like the deletion functions, but save | |
614 it so that the user can reinsert it by @dfn{yanking}. Most of these | |
615 functions have @samp{kill-} in their name. By contrast, the functions | |
616 whose names start with @samp{delete-} normally do not save text for | |
617 yanking (though they can still be undone); these are ``deletion'' | |
618 functions. | |
619 | |
620 Most of the kill commands are primarily for interactive use, and are | |
621 not described here. What we do describe are the functions provided for | |
622 use in writing such commands. You can use these functions to write | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
623 commands for killing text. When you need to delete text for internal |
6558 | 624 purposes within a Lisp function, you should normally use deletion |
625 functions, so as not to disturb the kill ring contents. | |
626 @xref{Deletion}. | |
627 | |
628 Killed text is saved for later yanking in the @dfn{kill ring}. This | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
629 is a list that holds a number of recent kills, not just the last text |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
630 kill. We call this a ``ring'' because yanking treats it as having |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
631 elements in a cyclic order. The list is kept in the variable |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
632 @code{kill-ring}, and can be operated on with the usual functions for |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
633 lists; there are also specialized functions, described in this section, |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
634 that treat it as a ring. |
6558 | 635 |
636 Some people think this use of the word ``kill'' is unfortunate, since | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
637 it refers to operations that specifically @emph{do not} destroy the |
6558 | 638 entities ``killed''. This is in sharp contrast to ordinary life, in |
639 which death is permanent and ``killed'' entities do not come back to | |
640 life. Therefore, other metaphors have been proposed. For example, the | |
641 term ``cut ring'' makes sense to people who, in pre-computer days, used | |
642 scissors and paste to cut up and rearrange manuscripts. However, it | |
643 would be difficult to change the terminology now. | |
644 | |
645 @menu | |
646 * Kill Ring Concepts:: What text looks like in the kill ring. | |
647 * Kill Functions:: Functions that kill text. | |
648 * Yank Commands:: Commands that access the kill ring. | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
649 * Low-Level Kill Ring:: Functions and variables for kill ring access. |
6558 | 650 * Internals of Kill Ring:: Variables that hold kill-ring data. |
651 @end menu | |
652 | |
653 @node Kill Ring Concepts | |
654 @comment node-name, next, previous, up | |
655 @subsection Kill Ring Concepts | |
656 | |
657 The kill ring records killed text as strings in a list, most recent | |
658 first. A short kill ring, for example, might look like this: | |
659 | |
660 @example | |
661 ("some text" "a different piece of text" "even older text") | |
662 @end example | |
663 | |
664 @noindent | |
665 When the list reaches @code{kill-ring-max} entries in length, adding a | |
666 new entry automatically deletes the last entry. | |
667 | |
668 When kill commands are interwoven with other commands, each kill | |
669 command makes a new entry in the kill ring. Multiple kill commands in | |
670 succession build up a single entry in the kill ring, which would be | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
671 yanked as a unit; the second and subsequent consecutive kill commands |
6558 | 672 add text to the entry made by the first one. |
673 | |
674 For yanking, one entry in the kill ring is designated the ``front'' of | |
675 the ring. Some yank commands ``rotate'' the ring by designating a | |
676 different element as the ``front.'' But this virtual rotation doesn't | |
677 change the list itself---the most recent entry always comes first in the | |
678 list. | |
679 | |
680 @node Kill Functions | |
681 @comment node-name, next, previous, up | |
682 @subsection Functions for Killing | |
683 | |
684 @code{kill-region} is the usual subroutine for killing text. Any | |
685 command that calls this function is a ``kill command'' (and should | |
686 probably have @samp{kill} in its name). @code{kill-region} puts the | |
687 newly killed text in a new element at the beginning of the kill ring or | |
688 adds it to the most recent element. It uses the @code{last-command} | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
689 variable to determine whether the previous command was a kill command, |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
690 and if so appends the killed text to the most recent entry. |
6558 | 691 |
692 @deffn Command kill-region start end | |
693 This function kills the text in the region defined by @var{start} and | |
694 @var{end}. The text is deleted but saved in the kill ring. The value | |
695 is always @code{nil}. | |
696 | |
697 In an interactive call, @var{start} and @var{end} are point and | |
698 the mark. | |
699 | |
700 @c Emacs 19 feature | |
701 If the buffer is read-only, @code{kill-region} modifies the kill ring | |
702 just the same, then signals an error without modifying the buffer. This | |
703 is convenient because it lets the user use all the kill commands to copy | |
704 text into the kill ring from a read-only buffer. | |
705 @end deffn | |
706 | |
707 @deffn Command copy-region-as-kill start end | |
708 This command saves the region defined by @var{start} and @var{end} on | |
709 the kill ring, but does not delete the text from the buffer. It returns | |
710 @code{nil}. It also indicates the extent of the text copied by moving | |
711 the cursor momentarily, or by displaying a message in the echo area. | |
712 | |
713 Don't call @code{copy-region-as-kill} in Lisp programs unless you aim to | |
714 support Emacs 18. For Emacs 19, it is better to use @code{kill-new} or | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
715 @code{kill-append} instead. @xref{Low-Level Kill Ring}. |
6558 | 716 @end deffn |
717 | |
718 @node Yank Commands | |
719 @comment node-name, next, previous, up | |
720 @subsection Functions for Yanking | |
721 | |
722 @dfn{Yanking} means reinserting an entry of previously killed text | |
723 from the kill ring. | |
724 | |
725 @deffn Command yank &optional arg | |
726 @cindex inserting killed text | |
727 This command inserts before point the text in the first entry in the | |
728 kill ring. It positions the mark at the beginning of that text, and | |
729 point at the end. | |
730 | |
731 If @var{arg} is a list (which occurs interactively when the user | |
732 types @kbd{C-u} with no digits), then @code{yank} inserts the text as | |
733 described above, but puts point before the yanked text and puts the mark | |
734 after it. | |
735 | |
736 If @var{arg} is a number, then @code{yank} inserts the @var{arg}th most | |
737 recently killed text---the @var{arg}th element of the kill ring list. | |
738 | |
739 @code{yank} does not alter the contents of the kill ring or rotate it. | |
740 It returns @code{nil}. | |
741 @end deffn | |
742 | |
743 @deffn Command yank-pop arg | |
744 This command replaces the just-yanked entry from the kill ring with a | |
745 different entry from the kill ring. | |
746 | |
747 This is allowed only immediately after a @code{yank} or another | |
748 @code{yank-pop}. At such a time, the region contains text that was just | |
749 inserted by yanking. @code{yank-pop} deletes that text and inserts in | |
750 its place a different piece of killed text. It does not add the deleted | |
751 text to the kill ring, since it is already in the kill ring somewhere. | |
752 | |
753 If @var{arg} is @code{nil}, then the replacement text is the previous | |
754 element of the kill ring. If @var{arg} is numeric, the replacement is | |
755 the @var{arg}th previous kill. If @var{arg} is negative, a more recent | |
756 kill is the replacement. | |
757 | |
758 The sequence of kills in the kill ring wraps around, so that after the | |
759 oldest one comes the newest one, and before the newest one goes the | |
760 oldest. | |
761 | |
762 The value is always @code{nil}. | |
763 @end deffn | |
764 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
765 @node Low-Level Kill Ring |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
766 @subsection Low-Level Kill Ring |
6558 | 767 |
768 These functions and variables provide access to the kill ring at a lower | |
769 level, but still convenient for use in Lisp programs. They take care of | |
770 interaction with X Window selections. They do not exist in Emacs | |
771 version 18. | |
772 | |
773 @defun current-kill n &optional do-not-move | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
774 The function @code{current-kill} rotates the yanking pointer which |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
775 designates the ``front'' of the kill ring by @var{n} places (from newer |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
776 kills to older ones), and returns the text at that place in the ring. |
6558 | 777 |
778 If the optional second argument @var{do-not-move} is non-@code{nil}, | |
779 then @code{current-kill} doesn't alter the yanking pointer; it just | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
780 returns the @var{n}th kill, counting from the current yanking pointer. |
6558 | 781 |
782 If @var{n} is zero, indicating a request for the latest kill, | |
783 @code{current-kill} calls the value of | |
784 @code{interprogram-paste-function} (documented below) before consulting | |
785 the kill ring. | |
786 @end defun | |
787 | |
788 @defun kill-new string | |
789 This function puts the text @var{string} into the kill ring as a new | |
790 entry at the front of the ring. It discards the oldest entry if | |
791 appropriate. It also invokes the value of | |
792 @code{interprogram-cut-function} (see below). | |
793 @end defun | |
794 | |
795 @defun kill-append string before-p | |
796 This function appends the text @var{string} to the first entry in the | |
797 kill ring. Normally @var{string} goes at the end of the entry, but if | |
798 @var{before-p} is non-@code{nil}, it goes at the beginning. This | |
799 function also invokes the value of @code{interprogram-cut-function} (see | |
800 below). | |
801 @end defun | |
802 | |
803 @defvar interprogram-paste-function | |
804 This variable provides a way of transferring killed text from other | |
805 programs, when you are using a window system. Its value should be | |
806 @code{nil} or a function of no arguments. | |
807 | |
808 If the value is a function, @code{current-kill} calls it to get the | |
809 ``most recent kill''. If the function returns a non-@code{nil} value, | |
810 then that value is used as the ``most recent kill''. If it returns | |
811 @code{nil}, then the first element of @code{kill-ring} is used. | |
812 | |
813 The normal use of this hook is to get the X server's primary selection | |
814 as the most recent kill, even if the selection belongs to another X | |
815 client. @xref{X Selections}. | |
816 @end defvar | |
817 | |
818 @defvar interprogram-cut-function | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
819 This variable provides a way of communicating killed text to other |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
820 programs, when you are using a window system. Its value should be |
6558 | 821 @code{nil} or a function of one argument. |
822 | |
823 If the value is a function, @code{kill-new} and @code{kill-append} call | |
824 it with the new first element of the kill ring as an argument. | |
825 | |
826 The normal use of this hook is to set the X server's primary selection | |
827 to the newly killed text. | |
828 @end defvar | |
829 | |
830 @node Internals of Kill Ring | |
831 @comment node-name, next, previous, up | |
832 @subsection Internals of the Kill Ring | |
833 | |
834 The variable @code{kill-ring} holds the kill ring contents, in the | |
835 form of a list of strings. The most recent kill is always at the front | |
836 of the list. | |
837 | |
838 The @code{kill-ring-yank-pointer} variable points to a link in the | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
839 kill ring list, whose @sc{car} is the text to yank next. We say it |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
840 identifies the ``front'' of the ring. Moving |
6558 | 841 @code{kill-ring-yank-pointer} to a different link is called |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
842 @dfn{rotating the kill ring}. We call the kill ring a ``ring'' because |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
843 the functions that move the yank pointer wrap around from the end of the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
844 list to the beginning, or vice-versa. Rotation of the kill ring is |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
845 virtual; it does not change the value of @code{kill-ring}. |
6558 | 846 |
847 Both @code{kill-ring} and @code{kill-ring-yank-pointer} are Lisp | |
848 variables whose values are normally lists. The word ``pointer'' in the | |
849 name of the @code{kill-ring-yank-pointer} indicates that the variable's | |
850 purpose is to identify one element of the list for use by the next yank | |
851 command. | |
852 | |
853 The value of @code{kill-ring-yank-pointer} is always @code{eq} to one | |
854 of the links in the kill ring list. The element it identifies is the | |
855 @sc{car} of that link. Kill commands, which change the kill ring, also | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
856 set this variable to the value of @code{kill-ring}. The effect is to |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
857 rotate the ring so that the newly killed text is at the front. |
6558 | 858 |
859 Here is a diagram that shows the variable @code{kill-ring-yank-pointer} | |
860 pointing to the second entry in the kill ring @code{("some text" "a | |
861 different piece of text" "yet older text")}. | |
862 | |
863 @example | |
864 @group | |
865 kill-ring kill-ring-yank-pointer | |
866 | | | |
867 | ___ ___ ---> ___ ___ ___ ___ | |
868 --> |___|___|------> |___|___|--> |___|___|--> nil | |
869 | | | | |
870 | | | | |
871 | | -->"yet older text" | |
872 | | | |
873 | --> "a different piece of text" | |
874 | | |
875 --> "some text" | |
876 @end group | |
877 @end example | |
878 | |
879 @noindent | |
880 This state of affairs might occur after @kbd{C-y} (@code{yank}) | |
881 immediately followed by @kbd{M-y} (@code{yank-pop}). | |
882 | |
883 @defvar kill-ring | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
884 This variable holds the list of killed text sequences, most recently |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
885 killed first. |
6558 | 886 @end defvar |
887 | |
888 @defvar kill-ring-yank-pointer | |
889 This variable's value indicates which element of the kill ring is at the | |
890 ``front'' of the ring for yanking. More precisely, the value is a tail | |
891 of the value of @code{kill-ring}, and its @sc{car} is the kill string | |
892 that @kbd{C-y} should yank. | |
893 @end defvar | |
894 | |
895 @defopt kill-ring-max | |
896 The value of this variable is the maximum length to which the kill | |
897 ring can grow, before elements are thrown away at the end. The default | |
898 value for @code{kill-ring-max} is 30. | |
899 @end defopt | |
900 | |
901 @node Undo | |
902 @comment node-name, next, previous, up | |
903 @section Undo | |
904 @cindex redo | |
905 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
906 Most buffers have an @dfn{undo list}, which records all changes made |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
907 to the buffer's text so that they can be undone. (The buffers that |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
908 don't have one are usually special-purpose buffers for which Emacs |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
909 assumes that undoing is not useful.) All the primitives that modify the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
910 text in the buffer automatically add elements to the front of the undo |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
911 list, which is in the variable @code{buffer-undo-list}. |
6558 | 912 |
913 @defvar buffer-undo-list | |
914 This variable's value is the undo list of the current buffer. | |
915 A value of @code{t} disables the recording of undo information. | |
916 @end defvar | |
917 | |
918 Here are the kinds of elements an undo list can have: | |
919 | |
920 @table @code | |
921 @item @var{integer} | |
922 This kind of element records a previous value of point. Ordinary cursor | |
923 motion does not get any sort of undo record, but deletion commands use | |
924 these entries to record where point was before the command. | |
925 | |
926 @item (@var{beg} . @var{end}) | |
927 This kind of element indicates how to delete text that was inserted. | |
928 Upon insertion, the text occupied the range @var{beg}--@var{end} in the | |
929 buffer. | |
930 | |
10364 | 931 @item (@var{text} . @var{position}) |
6558 | 932 This kind of element indicates how to reinsert text that was deleted. |
10364 | 933 The deleted text itself is the string @var{text}. The place to |
934 reinsert it is @code{(abs @var{position})}. | |
6558 | 935 |
936 @item (t @var{high} . @var{low}) | |
937 This kind of element indicates that an unmodified buffer became | |
938 modified. The elements @var{high} and @var{low} are two integers, each | |
939 recording 16 bits of the visited file's modification time as of when it | |
940 was previously visited or saved. @code{primitive-undo} uses those | |
941 values to determine whether to mark the buffer as unmodified once again; | |
942 it does so only if the file's modification time matches those numbers. | |
943 | |
944 @item (nil @var{property} @var{value} @var{beg} . @var{end}) | |
945 This kind of element records a change in a text property. | |
946 Here's how you might undo the change: | |
947 | |
948 @example | |
949 (put-text-property @var{beg} @var{end} @var{property} @var{value}) | |
950 @end example | |
951 | |
10364 | 952 @item @var{position} |
953 This element indicates where point was at an earlier time. | |
954 Undoing this element sets point to @var{position}. | |
955 | |
6558 | 956 @item nil |
957 This element is a boundary. The elements between two boundaries are | |
958 called a @dfn{change group}; normally, each change group corresponds to | |
959 one keyboard command, and undo commands normally undo an entire group as | |
960 a unit. | |
961 @end table | |
962 | |
963 @defun undo-boundary | |
964 This function places a boundary element in the undo list. The undo | |
965 command stops at such a boundary, and successive undo commands undo | |
966 to earlier and earlier boundaries. This function returns @code{nil}. | |
967 | |
11555
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
968 The editor command loop automatically creates an undo boundary before |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
969 each key sequence is executed. Thus, each undo normally undoes the |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
970 effects of one command. Self-inserting input characters are an |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
971 exception. The command loop makes a boundary for the first such |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
972 character; the next 19 consecutive self-inserting input characters do |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
973 not make boundaries, and then the 20th does, and so on as long as |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
974 self-inserting characters continue. |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
975 |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
976 All buffer modifications add a boundary whenever the previous undoable |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
977 change was made in some other buffer. This way, a command that modifies |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
978 several buffers makes a boundary in each buffer it changes. |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
979 |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
980 Calling this function explicitly is useful for splitting the effects of |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
981 a command into more than one unit. For example, @code{query-replace} |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
982 calls @code{undo-boundary} after each replacement, so that the user can |
4cc0a5e1bdac
Explan when boundaries are made automatically.
Richard M. Stallman <rms@gnu.org>
parents:
10364
diff
changeset
|
983 undo individual replacements one by one. |
6558 | 984 @end defun |
985 | |
986 @defun primitive-undo count list | |
987 This is the basic function for undoing elements of an undo list. | |
988 It undoes the first @var{count} elements of @var{list}, returning | |
989 the rest of @var{list}. You could write this function in Lisp, | |
990 but it is convenient to have it in C. | |
991 | |
992 @code{primitive-undo} adds elements to the buffer's undo list when it | |
993 changes the buffer. Undo commands avoid confusion by saving the undo | |
994 list value at the beginning of a sequence of undo operations. Then the | |
995 undo operations use and update the saved value. The new elements added | |
996 by undoing are not part of the saved value, so they don't interfere with | |
997 continuing to undo. | |
998 @end defun | |
999 | |
1000 @node Maintaining Undo | |
1001 @section Maintaining Undo Lists | |
1002 | |
1003 This section describes how to enable and disable undo information for | |
1004 a given buffer. It also explains how the undo list is truncated | |
1005 automatically so it doesn't get too big. | |
1006 | |
1007 Recording of undo information in a newly created buffer is normally | |
1008 enabled to start with; but if the buffer name starts with a space, the | |
1009 undo recording is initially disabled. You can explicitly enable or | |
1010 disable undo recording with the following two functions, or by setting | |
1011 @code{buffer-undo-list} yourself. | |
1012 | |
1013 @deffn Command buffer-enable-undo &optional buffer-or-name | |
1014 This command enables recording undo information for buffer | |
1015 @var{buffer-or-name}, so that subsequent changes can be undone. If no | |
1016 argument is supplied, then the current buffer is used. This function | |
1017 does nothing if undo recording is already enabled in the buffer. It | |
1018 returns @code{nil}. | |
1019 | |
1020 In an interactive call, @var{buffer-or-name} is the current buffer. | |
1021 You cannot specify any other buffer. | |
1022 @end deffn | |
1023 | |
1024 @defun buffer-disable-undo &optional buffer | |
1025 @defunx buffer-flush-undo &optional buffer | |
1026 @cindex disable undo | |
1027 This function discards the undo list of @var{buffer}, and disables | |
1028 further recording of undo information. As a result, it is no longer | |
1029 possible to undo either previous changes or any subsequent changes. If | |
1030 the undo list of @var{buffer} is already disabled, this function | |
1031 has no effect. | |
1032 | |
1033 This function returns @code{nil}. It cannot be called interactively. | |
1034 | |
1035 The name @code{buffer-flush-undo} is not considered obsolete, but the | |
1036 preferred name @code{buffer-disable-undo} is new as of Emacs versions | |
1037 19. | |
1038 @end defun | |
1039 | |
1040 As editing continues, undo lists get longer and longer. To prevent | |
1041 them from using up all available memory space, garbage collection trims | |
1042 them back to size limits you can set. (For this purpose, the ``size'' | |
1043 of an undo list measures the cons cells that make up the list, plus the | |
1044 strings of deleted text.) Two variables control the range of acceptable | |
1045 sizes: @code{undo-limit} and @code{undo-strong-limit}. | |
1046 | |
1047 @defvar undo-limit | |
1048 This is the soft limit for the acceptable size of an undo list. The | |
1049 change group at which this size is exceeded is the last one kept. | |
1050 @end defvar | |
1051 | |
1052 @defvar undo-strong-limit | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1053 This is the upper limit for the acceptable size of an undo list. The |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1054 change group at which this size is exceeded is discarded itself (along |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1055 with all older change groups). There is one exception: the very latest |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1056 change group is never discarded separate no matter how big it is. |
6558 | 1057 @end defvar |
1058 | |
1059 @node Filling | |
1060 @comment node-name, next, previous, up | |
1061 @section Filling | |
1062 @cindex filling, explicit | |
1063 | |
1064 @dfn{Filling} means adjusting the lengths of lines (by moving the line | |
1065 breaks) so that they are nearly (but no greater than) a specified | |
1066 maximum width. Additionally, lines can be @dfn{justified}, which means | |
1067 that spaces are inserted between words to make the line exactly the | |
1068 specified width. The width is controlled by the variable | |
1069 @code{fill-column}. For ease of reading, lines should be no longer than | |
1070 70 or so columns. | |
1071 | |
1072 You can use Auto Fill mode (@pxref{Auto Filling}) to fill text | |
1073 automatically as you insert it, but changes to existing text may leave | |
1074 it improperly filled. Then you must fill the text explicitly. | |
1075 | |
1076 Most of the functions in this section return values that are not | |
1077 meaningful. | |
1078 | |
1079 @deffn Command fill-paragraph justify-flag | |
1080 @cindex filling a paragraph | |
1081 This command fills the paragraph at or after point. If | |
1082 @var{justify-flag} is non-@code{nil}, each line is justified as well. | |
1083 It uses the ordinary paragraph motion commands to find paragraph | |
1084 boundaries. @xref{Paragraphs,,, emacs, The Emacs Manual}. | |
1085 @end deffn | |
1086 | |
1087 @deffn Command fill-region start end &optional justify-flag | |
1088 This command fills each of the paragraphs in the region from @var{start} | |
1089 to @var{end}. It justifies as well if @var{justify-flag} is | |
1090 non-@code{nil}. | |
1091 | |
1092 The variable @code{paragraph-separate} controls how to distinguish | |
1093 paragraphs. @xref{Standard Regexps}. | |
1094 @end deffn | |
1095 | |
1096 @deffn Command fill-individual-paragraphs start end &optional justify-flag mail-flag | |
1097 This command fills each paragraph in the region according to its | |
1098 individual fill prefix. Thus, if the lines of a paragraph were indented | |
1099 with spaces, the filled paragraph will remain indented in the same | |
1100 fashion. | |
1101 | |
1102 The first two arguments, @var{start} and @var{end}, are the beginning | |
1103 and end of the region to be filled. The third and fourth arguments, | |
1104 @var{justify-flag} and @var{mail-flag}, are optional. If | |
1105 @var{justify-flag} is non-@code{nil}, the paragraphs are justified as | |
1106 well as filled. If @var{mail-flag} is non-@code{nil}, it means the | |
1107 function is operating on a mail message and therefore should not fill | |
1108 the header lines. | |
1109 | |
1110 Ordinarily, @code{fill-individual-paragraphs} regards each change in | |
1111 indentation as starting a new paragraph. If | |
1112 @code{fill-individual-varying-indent} is non-@code{nil}, then only | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1113 separator lines separate paragraphs. That mode can handle indented |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1114 paragraphs with additional indentation on the first line. |
6558 | 1115 @end deffn |
1116 | |
1117 @defopt fill-individual-varying-indent | |
1118 This variable alters the action of @code{fill-individual-paragraphs} as | |
1119 described above. | |
1120 @end defopt | |
1121 | |
1122 @deffn Command fill-region-as-paragraph start end &optional justify-flag | |
1123 This command considers a region of text as a paragraph and fills it. If | |
1124 the region was made up of many paragraphs, the blank lines between | |
1125 paragraphs are removed. This function justifies as well as filling when | |
1126 @var{justify-flag} is non-@code{nil}. In an interactive call, any | |
1127 prefix argument requests justification. | |
1128 | |
1129 In Adaptive Fill mode, which is enabled by default, | |
1130 @code{fill-region-as-paragraph} on an indented paragraph when there is | |
1131 no fill prefix uses the indentation of the second line of the paragraph | |
1132 as the fill prefix. | |
1133 @end deffn | |
1134 | |
1135 @deffn Command justify-current-line | |
1136 This command inserts spaces between the words of the current line so | |
1137 that the line ends exactly at @code{fill-column}. It returns | |
1138 @code{nil}. | |
1139 @end deffn | |
1140 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1141 @defopt fill-prefix |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1142 This variable specifies a string of text that appears at the beginning |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1143 of normal text lines and should be disregarded when filling them. Any |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1144 line that fails to start with the fill prefix is considered the start of |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1145 a paragraph; so is any line that starts with the fill prefix followed by |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1146 additional whitespace. Lines that start with the fill prefix but no |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1147 additional whitespace are ordinary text lines that can be filled |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1148 together. The resulting filled lines also start with the fill prefix. |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1149 @end defopt |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1150 |
6558 | 1151 @defopt fill-column |
1152 This buffer-local variable specifies the maximum width of filled | |
1153 lines. Its value should be an integer, which is a number of columns. | |
1154 All the filling, justification and centering commands are affected by | |
1155 this variable, including Auto Fill mode (@pxref{Auto Filling}). | |
1156 | |
1157 As a practical matter, if you are writing text for other people to | |
1158 read, you should set @code{fill-column} to no more than 70. Otherwise | |
1159 the line will be too long for people to read comfortably, and this can | |
1160 make the text seem clumsy. | |
1161 @end defopt | |
1162 | |
1163 @defvar default-fill-column | |
1164 The value of this variable is the default value for @code{fill-column} in | |
1165 buffers that do not override it. This is the same as | |
1166 @code{(default-value 'fill-column)}. | |
1167 | |
1168 The default value for @code{default-fill-column} is 70. | |
1169 @end defvar | |
1170 | |
1171 @node Auto Filling | |
1172 @comment node-name, next, previous, up | |
1173 @section Auto Filling | |
1174 @cindex filling, automatic | |
1175 @cindex Auto Fill mode | |
1176 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1177 Auto Fill mode is a minor mode that fills lines automatically as text |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1178 as inserted. This section describes the hook used by Auto Fill mode. |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1179 For a description of functions that you can call explicitly to fill and |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1180 justify existing text, see @ref{Filling}. |
6558 | 1181 |
1182 @defvar auto-fill-function | |
1183 The value of this variable should be a function (of no arguments) to | |
1184 be called after self-inserting a space at a column beyond | |
1185 @code{fill-column}. It may be @code{nil}, in which case nothing | |
1186 special is done. | |
1187 | |
1188 The value of @code{auto-fill-function} is @code{do-auto-fill} when | |
1189 Auto-Fill mode is enabled. That is a function whose sole purpose is to | |
1190 implement the usual strategy for breaking a line. | |
1191 | |
1192 @quotation | |
1193 In older Emacs versions, this variable was named @code{auto-fill-hook}, | |
1194 but since it is not called with the standard convention for hooks, it | |
1195 was renamed to @code{auto-fill-function} in version 19. | |
1196 @end quotation | |
1197 @end defvar | |
1198 | |
1199 @node Sorting | |
1200 @section Sorting Text | |
1201 @cindex sorting text | |
1202 | |
1203 The sorting functions described in this section all rearrange text in | |
1204 a buffer. This is in contrast to the function @code{sort}, which | |
1205 rearranges the order of the elements of a list (@pxref{Rearrangement}). | |
1206 The values returned by these functions are not meaningful. | |
1207 | |
1208 @defun sort-subr reverse nextrecfun endrecfun &optional startkeyfun endkeyfun | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1209 This function is the general text-sorting routine that divides a buffer |
6558 | 1210 into records and sorts them. Most of the commands in this section use |
1211 this function. | |
1212 | |
1213 To understand how @code{sort-subr} works, consider the whole accessible | |
1214 portion of the buffer as being divided into disjoint pieces called | |
1215 @dfn{sort records}. The records may or may not be contiguous; they may | |
1216 not overlap. A portion of each sort record (perhaps all of it) is | |
1217 designated as the sort key. Sorting rearranges the records in order by | |
1218 their sort keys. | |
1219 | |
1220 Usually, the records are rearranged in order of ascending sort key. | |
1221 If the first argument to the @code{sort-subr} function, @var{reverse}, | |
1222 is non-@code{nil}, the sort records are rearranged in order of | |
1223 descending sort key. | |
1224 | |
1225 The next four arguments to @code{sort-subr} are functions that are | |
1226 called to move point across a sort record. They are called many times | |
1227 from within @code{sort-subr}. | |
1228 | |
1229 @enumerate | |
1230 @item | |
1231 @var{nextrecfun} is called with point at the end of a record. This | |
1232 function moves point to the start of the next record. The first record | |
1233 is assumed to start at the position of point when @code{sort-subr} is | |
1234 called. Therefore, you should usually move point to the beginning of | |
1235 the buffer before calling @code{sort-subr}. | |
1236 | |
1237 This function can indicate there are no more sort records by leaving | |
1238 point at the end of the buffer. | |
1239 | |
1240 @item | |
1241 @var{endrecfun} is called with point within a record. It moves point to | |
1242 the end of the record. | |
1243 | |
1244 @item | |
1245 @var{startkeyfun} is called to move point from the start of a record to | |
1246 the start of the sort key. This argument is optional; if it is omitted, | |
1247 the whole record is the sort key. If supplied, the function should | |
1248 either return a non-@code{nil} value to be used as the sort key, or | |
1249 return @code{nil} to indicate that the sort key is in the buffer | |
1250 starting at point. In the latter case, @var{endkeyfun} is called to | |
1251 find the end of the sort key. | |
1252 | |
1253 @item | |
1254 @var{endkeyfun} is called to move point from the start of the sort key | |
1255 to the end of the sort key. This argument is optional. If | |
1256 @var{startkeyfun} returns @code{nil} and this argument is omitted (or | |
1257 @code{nil}), then the sort key extends to the end of the record. There | |
1258 is no need for @var{endkeyfun} if @var{startkeyfun} returns a | |
1259 non-@code{nil} value. | |
1260 @end enumerate | |
1261 | |
1262 As an example of @code{sort-subr}, here is the complete function | |
1263 definition for @code{sort-lines}: | |
1264 | |
1265 @example | |
1266 @group | |
1267 ;; @r{Note that the first two lines of doc string} | |
1268 ;; @r{are effectively one line when viewed by a user.} | |
1269 (defun sort-lines (reverse beg end) | |
1270 "Sort lines in region alphabetically. | |
1271 Called from a program, there are three arguments: | |
1272 @end group | |
1273 @group | |
1274 REVERSE (non-nil means reverse order), | |
1275 and BEG and END (the region to sort)." | |
1276 (interactive "P\nr") | |
1277 (save-restriction | |
1278 (narrow-to-region beg end) | |
1279 (goto-char (point-min)) | |
1280 (sort-subr reverse | |
1281 'forward-line | |
1282 'end-of-line))) | |
1283 @end group | |
1284 @end example | |
1285 | |
1286 Here @code{forward-line} moves point to the start of the next record, | |
1287 and @code{end-of-line} moves point to the end of record. We do not pass | |
1288 the arguments @var{startkeyfun} and @var{endkeyfun}, because the entire | |
1289 record is used as the sort key. | |
1290 | |
1291 The @code{sort-paragraphs} function is very much the same, except that | |
1292 its @code{sort-subr} call looks like this: | |
1293 | |
1294 @example | |
1295 @group | |
1296 (sort-subr reverse | |
1297 (function | |
1298 (lambda () | |
1299 (skip-chars-forward "\n \t\f"))) | |
1300 'forward-paragraph) | |
1301 @end group | |
1302 @end example | |
1303 @end defun | |
1304 | |
1305 @deffn Command sort-regexp-fields reverse record-regexp key-regexp start end | |
1306 This command sorts the region between @var{start} and @var{end} | |
1307 alphabetically as specified by @var{record-regexp} and @var{key-regexp}. | |
1308 If @var{reverse} is a negative integer, then sorting is in reverse | |
1309 order. | |
1310 | |
1311 Alphabetical sorting means that two sort keys are compared by | |
1312 comparing the first characters of each, the second characters of each, | |
1313 and so on. If a mismatch is found, it means that the sort keys are | |
1314 unequal; the sort key whose character is less at the point of first | |
1315 mismatch is the lesser sort key. The individual characters are compared | |
1316 according to their numerical values. Since Emacs uses the @sc{ASCII} | |
1317 character set, the ordering in that set determines alphabetical order. | |
1318 @c version 19 change | |
1319 | |
1320 The value of the @var{record-regexp} argument specifies how to divide | |
1321 the buffer into sort records. At the end of each record, a search is | |
1322 done for this regular expression, and the text that matches it is the | |
1323 next record. For example, the regular expression @samp{^.+$}, which | |
1324 matches lines with at least one character besides a newline, would make | |
1325 each such line into a sort record. @xref{Regular Expressions}, for a | |
1326 description of the syntax and meaning of regular expressions. | |
1327 | |
1328 The value of the @var{key-regexp} argument specifies what part of each | |
1329 record is the sort key. The @var{key-regexp} could match the whole | |
1330 record, or only a part. In the latter case, the rest of the record has | |
1331 no effect on the sorted order of records, but it is carried along when | |
1332 the record moves to its new position. | |
1333 | |
1334 The @var{key-regexp} argument can refer to the text matched by a | |
1335 subexpression of @var{record-regexp}, or it can be a regular expression | |
1336 on its own. | |
1337 | |
1338 If @var{key-regexp} is: | |
1339 | |
1340 @table @asis | |
1341 @item @samp{\@var{digit}} | |
1342 then the text matched by the @var{digit}th @samp{\(...\)} parenthesis | |
1343 grouping in @var{record-regexp} is the sort key. | |
1344 | |
1345 @item @samp{\&} | |
1346 then the whole record is the sort key. | |
1347 | |
1348 @item a regular expression | |
1349 then @code{sort-regexp-fields} searches for a match for the regular | |
1350 expression within the record. If such a match is found, it is the sort | |
1351 key. If there is no match for @var{key-regexp} within a record then | |
1352 that record is ignored, which means its position in the buffer is not | |
1353 changed. (The other records may move around it.) | |
1354 @end table | |
1355 | |
1356 For example, if you plan to sort all the lines in the region by the | |
1357 first word on each line starting with the letter @samp{f}, you should | |
1358 set @var{record-regexp} to @samp{^.*$} and set @var{key-regexp} to | |
1359 @samp{\<f\w*\>}. The resulting expression looks like this: | |
1360 | |
1361 @example | |
1362 @group | |
1363 (sort-regexp-fields nil "^.*$" "\\<f\\w*\\>" | |
1364 (region-beginning) | |
1365 (region-end)) | |
1366 @end group | |
1367 @end example | |
1368 | |
1369 If you call @code{sort-regexp-fields} interactively, it prompts for | |
1370 @var{record-regexp} and @var{key-regexp} in the minibuffer. | |
1371 @end deffn | |
1372 | |
1373 @deffn Command sort-lines reverse start end | |
1374 This command alphabetically sorts lines in the region between | |
1375 @var{start} and @var{end}. If @var{reverse} is non-@code{nil}, the sort | |
1376 is in reverse order. | |
1377 @end deffn | |
1378 | |
1379 @deffn Command sort-paragraphs reverse start end | |
1380 This command alphabetically sorts paragraphs in the region between | |
1381 @var{start} and @var{end}. If @var{reverse} is non-@code{nil}, the sort | |
1382 is in reverse order. | |
1383 @end deffn | |
1384 | |
1385 @deffn Command sort-pages reverse start end | |
1386 This command alphabetically sorts pages in the region between | |
1387 @var{start} and @var{end}. If @var{reverse} is non-@code{nil}, the sort | |
1388 is in reverse order. | |
1389 @end deffn | |
1390 | |
1391 @deffn Command sort-fields field start end | |
1392 This command sorts lines in the region between @var{start} and | |
1393 @var{end}, comparing them alphabetically by the @var{field}th field | |
1394 of each line. Fields are separated by whitespace and numbered starting | |
1395 from 1. If @var{field} is negative, sorting is by the | |
1396 @w{@minus{}@var{field}th} field from the end of the line. This command | |
1397 is useful for sorting tables. | |
1398 @end deffn | |
1399 | |
1400 @deffn Command sort-numeric-fields field start end | |
1401 This command sorts lines in the region between @var{start} and | |
1402 @var{end}, comparing them numerically by the @var{field}th field of each | |
1403 line. The specified field must contain a number in each line of the | |
1404 region. Fields are separated by whitespace and numbered starting from | |
1405 1. If @var{field} is negative, sorting is by the | |
1406 @w{@minus{}@var{field}th} field from the end of the line. This command | |
1407 is useful for sorting tables. | |
1408 @end deffn | |
1409 | |
1410 @deffn Command sort-columns reverse &optional beg end | |
1411 This command sorts the lines in the region between @var{beg} and | |
1412 @var{end}, comparing them alphabetically by a certain range of columns. | |
1413 The column positions of @var{beg} and @var{end} bound the range of | |
1414 columns to sort on. | |
1415 | |
1416 If @var{reverse} is non-@code{nil}, the sort is in reverse order. | |
1417 | |
1418 One unusual thing about this command is that the entire line | |
1419 containing position @var{beg}, and the entire line containing position | |
1420 @var{end}, are included in the region sorted. | |
1421 | |
1422 Note that @code{sort-columns} uses the @code{sort} utility program, | |
1423 and so cannot work properly on text containing tab characters. Use | |
1424 @kbd{M-x @code{untabify}} to convert tabs to spaces before sorting. | |
1425 | |
1426 The @code{sort-columns} function did not work on VMS prior to Emacs 19. | |
1427 @end deffn | |
1428 | |
1429 @node Columns | |
1430 @comment node-name, next, previous, up | |
1431 @section Counting Columns | |
1432 @cindex columns | |
1433 @cindex counting columns | |
1434 @cindex horizontal position | |
1435 | |
1436 The column functions convert between a character position (counting | |
1437 characters from the beginning of the buffer) and a column position | |
1438 (counting screen characters from the beginning of a line). | |
1439 | |
1440 A character counts according to the number of columns it occupies on | |
1441 the screen. This means control characters count as occupying 2 or 4 | |
1442 columns, depending upon the value of @code{ctl-arrow}, and tabs count as | |
1443 occupying a number of columns that depends on the value of | |
1444 @code{tab-width} and on the column where the tab begins. @xref{Usual Display}. | |
1445 | |
1446 Column number computations ignore the width of the window and the | |
1447 amount of horizontal scrolling. Consequently, a column value can be | |
1448 arbitrarily high. The first (or leftmost) column is numbered 0. | |
1449 | |
1450 @defun current-column | |
1451 This function returns the horizontal position of point, measured in | |
1452 columns, counting from 0 at the left margin. The column position is the | |
1453 sum of the widths of all the displayed representations of the characters | |
1454 between the start of the current line and point. | |
1455 | |
1456 For an example of using @code{current-column}, see the description of | |
1457 @code{count-lines} in @ref{Text Lines}. | |
1458 @end defun | |
1459 | |
1460 @defun move-to-column column &optional force | |
1461 This function moves point to @var{column} in the current line. The | |
1462 calculation of @var{column} takes into account the widths of the | |
1463 displayed representations of the characters between the start of the | |
1464 line and point. | |
1465 | |
1466 If column @var{column} is beyond the end of the line, point moves to the | |
1467 end of the line. If @var{column} is negative, point moves to the | |
1468 beginning of the line. | |
1469 | |
1470 If it is impossible to move to column @var{column} because that is in | |
1471 the middle of a multicolumn character such as a tab, point moves to the | |
1472 end of that character. However, if @var{force} is non-@code{nil}, and | |
1473 @var{column} is in the middle of a tab, then @code{move-to-column} | |
1474 converts the tab into spaces so that it can move precisely to column | |
1475 @var{column}. Other multicolumn characters can cause anomalies despite | |
1476 @var{force}, since there is no way to split them. | |
1477 | |
1478 The argument @var{force} also has an effect if the line isn't long | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1479 enough to reach column @var{column}; in that case, it says to add |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1480 whitespace at the end of the line to reach that column. |
6558 | 1481 |
1482 If @var{column} is not an integer, an error is signaled. | |
1483 | |
1484 The return value is the column number actually moved to. | |
1485 @end defun | |
1486 | |
1487 @node Indentation | |
1488 @section Indentation | |
1489 @cindex indentation | |
1490 | |
1491 The indentation functions are used to examine, move to, and change | |
1492 whitespace that is at the beginning of a line. Some of the functions | |
1493 can also change whitespace elsewhere on a line. Columns and indentation | |
1494 count from zero at the left margin. | |
1495 | |
1496 @menu | |
1497 * Primitive Indent:: Functions used to count and insert indentation. | |
1498 * Mode-Specific Indent:: Customize indentation for different modes. | |
1499 * Region Indent:: Indent all the lines in a region. | |
1500 * Relative Indent:: Indent the current line based on previous lines. | |
1501 * Indent Tabs:: Adjustable, typewriter-like tab stops. | |
1502 * Motion by Indent:: Move to first non-blank character. | |
1503 @end menu | |
1504 | |
1505 @node Primitive Indent | |
1506 @subsection Indentation Primitives | |
1507 | |
1508 This section describes the primitive functions used to count and | |
1509 insert indentation. The functions in the following sections use these | |
1510 primitives. | |
1511 | |
1512 @defun current-indentation | |
1513 @comment !!Type Primitive Function | |
1514 @comment !!SourceFile indent.c | |
1515 This function returns the indentation of the current line, which is | |
1516 the horizontal position of the first nonblank character. If the | |
1517 contents are entirely blank, then this is the horizontal position of the | |
1518 end of the line. | |
1519 @end defun | |
1520 | |
1521 @deffn Command indent-to column &optional minimum | |
1522 @comment !!Type Primitive Function | |
1523 @comment !!SourceFile indent.c | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1524 This function indents from point with tabs and spaces until @var{column} |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1525 is reached. If @var{minimum} is specified and non-@code{nil}, then at |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1526 least that many spaces are inserted even if this requires going beyond |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1527 @var{column}. Otherwise the function does nothing if point is already |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1528 beyond @var{column}. The value is the column at which the inserted |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1529 indentation ends. |
8644 | 1530 |
1531 The inserted whitespace characters inherit text properties from the | |
1532 surrounding text (usually, from the preceding text only). @xref{Sticky | |
1533 Properties}. | |
6558 | 1534 @end deffn |
1535 | |
1536 @defopt indent-tabs-mode | |
1537 @comment !!SourceFile indent.c | |
1538 If this variable is non-@code{nil}, indentation functions can insert | |
1539 tabs as well as spaces. Otherwise, they insert only spaces. Setting | |
1540 this variable automatically makes it local to the current buffer. | |
1541 @end defopt | |
1542 | |
1543 @node Mode-Specific Indent | |
1544 @subsection Indentation Controlled by Major Mode | |
1545 | |
1546 An important function of each major mode is to customize the @key{TAB} | |
1547 key to indent properly for the language being edited. This section | |
1548 describes the mechanism of the @key{TAB} key and how to control it. | |
1549 The functions in this section return unpredictable values. | |
1550 | |
1551 @defvar indent-line-function | |
1552 This variable's value is the function to be used by @key{TAB} (and | |
1553 various commands) to indent the current line. The command | |
1554 @code{indent-according-to-mode} does no more than call this function. | |
1555 | |
1556 In Lisp mode, the value is the symbol @code{lisp-indent-line}; in C | |
1557 mode, @code{c-indent-line}; in Fortran mode, @code{fortran-indent-line}. | |
1558 In Fundamental mode, Text mode, and many other modes with no standard | |
1559 for indentation, the value is @code{indent-to-left-margin} (which is the | |
1560 default value). | |
1561 @end defvar | |
1562 | |
1563 @deffn Command indent-according-to-mode | |
1564 This command calls the function in @code{indent-line-function} to | |
1565 indent the current line in a way appropriate for the current major mode. | |
1566 @end deffn | |
1567 | |
1568 @deffn Command indent-for-tab-command | |
1569 This command calls the function in @code{indent-line-function} to indent | |
1570 the current line; except that if that function is | |
1571 @code{indent-to-left-margin}, it calls @code{insert-tab} instead. (That | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1572 is a trivial command that inserts a tab character.) |
6558 | 1573 @end deffn |
1574 | |
1575 @defun indent-to-left-margin | |
1576 This is the default @code{indent-line-function}, used in Fundamental | |
1577 mode, Text mode, etc. Its effect is to adjust the indentation at the | |
1578 beginning of the current line to the value specified by the variable | |
1579 @code{left-margin}. This may involve either inserting or deleting | |
1580 whitespace. | |
1581 @end defun | |
1582 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1583 @defvar left-margin |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1584 This variable specifies the column for @code{indent-to-left-margin} to |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1585 indent to. In Fundamental mode, @key{LFD} indents to this column. This |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1586 variable automatically becomes buffer-local when set in any fashion. |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1587 @end defvar |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1588 |
6558 | 1589 @deffn Command newline-and-indent |
1590 @comment !!SourceFile simple.el | |
1591 This function inserts a newline, then indents the new line (the one | |
1592 following the newline just inserted) according to the major mode. | |
1593 | |
1594 It does indentation by calling the current @code{indent-line-function}. | |
1595 In programming language modes, this is the same thing @key{TAB} does, | |
1596 but in some text modes, where @key{TAB} inserts a tab, | |
1597 @code{newline-and-indent} indents to the column specified by | |
1598 @code{left-margin}. | |
1599 @end deffn | |
1600 | |
1601 @deffn Command reindent-then-newline-and-indent | |
1602 @comment !!SourceFile simple.el | |
1603 This command reindents the current line, inserts a newline at point, | |
1604 and then reindents the new line (the one following the newline just | |
1605 inserted). | |
1606 | |
1607 This command does indentation on both lines according to the current | |
1608 major mode, by calling the current value of @code{indent-line-function}. | |
1609 In programming language modes, this is the same thing @key{TAB} does, | |
1610 but in some text modes, where @key{TAB} inserts a tab, | |
1611 @code{reindent-then-newline-and-indent} indents to the column specified | |
1612 by @code{left-margin}. | |
1613 @end deffn | |
1614 | |
1615 @node Region Indent | |
1616 @subsection Indenting an Entire Region | |
1617 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1618 This section describes commands that indent all the lines in the |
6558 | 1619 region. They return unpredictable values. |
1620 | |
1621 @deffn Command indent-region start end to-column | |
1622 This command indents each nonblank line starting between @var{start} | |
1623 (inclusive) and @var{end} (exclusive). If @var{to-column} is | |
1624 @code{nil}, @code{indent-region} indents each nonblank line by calling | |
1625 the current mode's indentation function, the value of | |
1626 @code{indent-line-function}. | |
1627 | |
1628 If @var{to-column} is non-@code{nil}, it should be an integer | |
1629 specifying the number of columns of indentation; then this function | |
1630 gives each line exactly that much indentation, by either adding or | |
1631 deleting whitespace. | |
1632 | |
1633 If there is a fill prefix, @code{indent-region} indents each line | |
1634 by making it start with the fill prefix. | |
1635 @end deffn | |
1636 | |
1637 @defvar indent-region-function | |
1638 The value of this variable is a function that can be used by | |
1639 @code{indent-region} as a short cut. You should design the function so | |
1640 that it will produce the same results as indenting the lines of the | |
1641 region one by one, but presumably faster. | |
1642 | |
1643 If the value is @code{nil}, there is no short cut, and | |
1644 @code{indent-region} actually works line by line. | |
1645 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1646 A short-cut function is useful in modes such as C mode and Lisp mode, |
6558 | 1647 where the @code{indent-line-function} must scan from the beginning of |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1648 the function definition: applying it to each line would be quadratic in |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1649 time. The short cut can update the scan information as it moves through |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1650 the lines indenting them; this takes linear time. In a mode where |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1651 indenting a line individually is fast, there is no need for a short cut. |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1652 |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1653 @code{indent-region} with a non-@code{nil} argument @var{to-column} has |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1654 a different meaning and does not use this variable. |
6558 | 1655 @end defvar |
1656 | |
1657 @deffn Command indent-rigidly start end count | |
1658 @comment !!SourceFile indent.el | |
1659 This command indents all lines starting between @var{start} | |
1660 (inclusive) and @var{end} (exclusive) sideways by @var{count} columns. | |
1661 This ``preserves the shape'' of the affected region, moving it as a | |
1662 rigid unit. Consequently, this command is useful not only for indenting | |
1663 regions of unindented text, but also for indenting regions of formatted | |
1664 code. | |
1665 | |
1666 For example, if @var{count} is 3, this command adds 3 columns of | |
1667 indentation to each of the lines beginning in the region specified. | |
1668 | |
1669 In Mail mode, @kbd{C-c C-y} (@code{mail-yank-original}) uses | |
1670 @code{indent-rigidly} to indent the text copied from the message being | |
1671 replied to. | |
1672 @end deffn | |
1673 | |
1674 @defun indent-code-rigidly start end columns &optional nochange-regexp | |
1675 This is like @code{indent-rigidly}, except that it doesn't alter lines | |
1676 that start within strings or comments. | |
1677 | |
1678 In addition, it doesn't alter a line if @var{nochange-regexp} matches at | |
1679 the beginning of the line (if @var{nochange-regexp} is non-@code{nil}). | |
1680 @end defun | |
1681 | |
1682 @node Relative Indent | |
1683 @subsection Indentation Relative to Previous Lines | |
1684 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1685 This section describes two commands that indent the current line |
6558 | 1686 based on the contents of previous lines. |
1687 | |
1688 @deffn Command indent-relative &optional unindented-ok | |
1689 This command inserts whitespace at point, extending to the same | |
1690 column as the next @dfn{indent point} of the previous nonblank line. An | |
1691 indent point is a non-whitespace character following whitespace. The | |
1692 next indent point is the first one at a column greater than the current | |
1693 column of point. For example, if point is underneath and to the left of | |
1694 the first non-blank character of a line of text, it moves to that column | |
1695 by inserting whitespace. | |
1696 | |
1697 If the previous nonblank line has no next indent point (i.e., none at a | |
1698 great enough column position), @code{indent-relative} either does | |
1699 nothing (if @var{unindented-ok} is non-@code{nil}) or calls | |
1700 @code{tab-to-tab-stop}. Thus, if point is underneath and to the right | |
1701 of the last column of a short line of text, this command ordinarily | |
1702 moves point to the next tab stop by inserting whitespace. | |
1703 | |
1704 The return value of @code{indent-relative} is unpredictable. | |
1705 | |
1706 In the following example, point is at the beginning of the second | |
1707 line: | |
1708 | |
1709 @example | |
1710 @group | |
1711 This line is indented twelve spaces. | |
1712 @point{}The quick brown fox jumped. | |
1713 @end group | |
1714 @end example | |
1715 | |
1716 @noindent | |
1717 Evaluation of the expression @code{(indent-relative nil)} produces the | |
1718 following: | |
1719 | |
1720 @example | |
1721 @group | |
1722 This line is indented twelve spaces. | |
1723 @point{}The quick brown fox jumped. | |
1724 @end group | |
1725 @end example | |
1726 | |
1727 In this example, point is between the @samp{m} and @samp{p} of | |
1728 @samp{jumped}: | |
1729 | |
1730 @example | |
1731 @group | |
1732 This line is indented twelve spaces. | |
1733 The quick brown fox jum@point{}ped. | |
1734 @end group | |
1735 @end example | |
1736 | |
1737 @noindent | |
1738 Evaluation of the expression @code{(indent-relative nil)} produces the | |
1739 following: | |
1740 | |
1741 @example | |
1742 @group | |
1743 This line is indented twelve spaces. | |
1744 The quick brown fox jum @point{}ped. | |
1745 @end group | |
1746 @end example | |
1747 @end deffn | |
1748 | |
1749 @deffn Command indent-relative-maybe | |
1750 @comment !!SourceFile indent.el | |
1751 This command indents the current line like the previous nonblank line. | |
1752 It calls @code{indent-relative} with @code{t} as the @var{unindented-ok} | |
1753 argument. The return value is unpredictable. | |
1754 | |
1755 If the previous nonblank line has no indent points beyond the current | |
1756 column, this command does nothing. | |
1757 @end deffn | |
1758 | |
1759 @node Indent Tabs | |
1760 @comment node-name, next, previous, up | |
1761 @subsection Adjustable ``Tab Stops'' | |
1762 @cindex tabs stops for indentation | |
1763 | |
1764 This section explains the mechanism for user-specified ``tab stops'' | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1765 and the mechanisms that use and set them. The name ``tab stops'' is |
6558 | 1766 used because the feature is similar to that of the tab stops on a |
1767 typewriter. The feature works by inserting an appropriate number of | |
1768 spaces and tab characters to reach the next tab stop column; it does not | |
1769 affect the display of tab characters in the buffer (@pxref{Usual | |
1770 Display}). Note that the @key{TAB} character as input uses this tab | |
1771 stop feature only in a few major modes, such as Text mode. | |
1772 | |
1773 @deffn Command tab-to-tab-stop | |
1774 This command inserts spaces or tabs up to the next tab stop column | |
1775 defined by @code{tab-stop-list}. It searches the list for an element | |
1776 greater than the current column number, and uses that element as the | |
1777 column to indent to. It does nothing if no such element is found. | |
1778 @end deffn | |
1779 | |
1780 @defopt tab-stop-list | |
1781 This variable is the list of tab stop columns used by | |
1782 @code{tab-to-tab-stops}. The elements should be integers in increasing | |
1783 order. The tab stop columns need not be evenly spaced. | |
1784 | |
1785 Use @kbd{M-x edit-tab-stops} to edit the location of tab stops | |
1786 interactively. | |
1787 @end defopt | |
1788 | |
1789 @node Motion by Indent | |
1790 @subsection Indentation-Based Motion Commands | |
1791 | |
1792 These commands, primarily for interactive use, act based on the | |
1793 indentation in the text. | |
1794 | |
1795 @deffn Command back-to-indentation | |
1796 @comment !!SourceFile simple.el | |
1797 This command moves point to the first non-whitespace character in the | |
1798 current line (which is the line in which point is located). It returns | |
1799 @code{nil}. | |
1800 @end deffn | |
1801 | |
1802 @deffn Command backward-to-indentation arg | |
1803 @comment !!SourceFile simple.el | |
1804 This command moves point backward @var{arg} lines and then to the | |
1805 first nonblank character on that line. It returns @code{nil}. | |
1806 @end deffn | |
1807 | |
1808 @deffn Command forward-to-indentation arg | |
1809 @comment !!SourceFile simple.el | |
1810 This command moves point forward @var{arg} lines and then to the first | |
1811 nonblank character on that line. It returns @code{nil}. | |
1812 @end deffn | |
1813 | |
1814 @node Case Changes | |
1815 @comment node-name, next, previous, up | |
1816 @section Case Changes | |
1817 @cindex case changes | |
1818 | |
1819 The case change commands described here work on text in the current | |
1820 buffer. @xref{Character Case}, for case conversion commands that work | |
1821 on strings and characters. @xref{Case Table}, for how to customize | |
1822 which characters are upper or lower case and how to convert them. | |
1823 | |
1824 @deffn Command capitalize-region start end | |
1825 This function capitalizes all words in the region defined by | |
1826 @var{start} and @var{end}. To capitalize means to convert each word's | |
1827 first character to upper case and convert the rest of each word to lower | |
1828 case. The function returns @code{nil}. | |
1829 | |
1830 If one end of the region is in the middle of a word, the part of the | |
1831 word within the region is treated as an entire word. | |
1832 | |
1833 When @code{capitalize-region} is called interactively, @var{start} and | |
1834 @var{end} are point and the mark, with the smallest first. | |
1835 | |
1836 @example | |
1837 @group | |
1838 ---------- Buffer: foo ---------- | |
1839 This is the contents of the 5th foo. | |
1840 ---------- Buffer: foo ---------- | |
1841 @end group | |
1842 | |
1843 @group | |
1844 (capitalize-region 1 44) | |
1845 @result{} nil | |
1846 | |
1847 ---------- Buffer: foo ---------- | |
1848 This Is The Contents Of The 5th Foo. | |
1849 ---------- Buffer: foo ---------- | |
1850 @end group | |
1851 @end example | |
1852 @end deffn | |
1853 | |
1854 @deffn Command downcase-region start end | |
1855 This function converts all of the letters in the region defined by | |
1856 @var{start} and @var{end} to lower case. The function returns | |
1857 @code{nil}. | |
1858 | |
1859 When @code{downcase-region} is called interactively, @var{start} and | |
1860 @var{end} are point and the mark, with the smallest first. | |
1861 @end deffn | |
1862 | |
1863 @deffn Command upcase-region start end | |
1864 This function converts all of the letters in the region defined by | |
1865 @var{start} and @var{end} to upper case. The function returns | |
1866 @code{nil}. | |
1867 | |
1868 When @code{upcase-region} is called interactively, @var{start} and | |
1869 @var{end} are point and the mark, with the smallest first. | |
1870 @end deffn | |
1871 | |
1872 @deffn Command capitalize-word count | |
1873 This function capitalizes @var{count} words after point, moving point | |
1874 over as it does. To capitalize means to convert each word's first | |
1875 character to upper case and convert the rest of each word to lower case. | |
1876 If @var{count} is negative, the function capitalizes the | |
1877 @minus{}@var{count} previous words but does not move point. The value | |
1878 is @code{nil}. | |
1879 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1880 If point is in the middle of a word, the part of the word before point |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1881 is ignored when moving forward. The rest is treated as an entire word. |
6558 | 1882 |
1883 When @code{capitalize-word} is called interactively, @var{count} is | |
1884 set to the numeric prefix argument. | |
1885 @end deffn | |
1886 | |
1887 @deffn Command downcase-word count | |
1888 This function converts the @var{count} words after point to all lower | |
1889 case, moving point over as it does. If @var{count} is negative, it | |
1890 converts the @minus{}@var{count} previous words but does not move point. | |
1891 The value is @code{nil}. | |
1892 | |
1893 When @code{downcase-word} is called interactively, @var{count} is set | |
1894 to the numeric prefix argument. | |
1895 @end deffn | |
1896 | |
1897 @deffn Command upcase-word count | |
1898 This function converts the @var{count} words after point to all upper | |
1899 case, moving point over as it does. If @var{count} is negative, it | |
1900 converts the @minus{}@var{count} previous words but does not move point. | |
1901 The value is @code{nil}. | |
1902 | |
1903 When @code{upcase-word} is called interactively, @var{count} is set to | |
1904 the numeric prefix argument. | |
1905 @end deffn | |
1906 | |
1907 @node Text Properties | |
1908 @section Text Properties | |
1909 @cindex text properties | |
1910 @cindex attributes of text | |
1911 @cindex properties of text | |
1912 | |
1913 Each character position in a buffer or a string can have a @dfn{text | |
1914 property list}, much like the property list of a symbol (@pxref{Property | |
1915 Lists}). The properties belong to a particular character at a | |
1916 particular place, such as, the letter @samp{T} at the beginning of this | |
1917 sentence or the first @samp{o} in @samp{foo}---if the same character | |
1918 occurs in two different places, the two occurrences generally have | |
1919 different properties. | |
1920 | |
1921 Each property has a name and a value. Both of these can be any Lisp | |
1922 object, but the name is normally a symbol. The usual way to access the | |
1923 property list is to specify a name and ask what value corresponds to it. | |
1924 | |
1925 If a character has a @code{category} property, we call it the | |
1926 @dfn{category} of the character. It should be a symbol. The properties | |
1927 of the symbol serve as defaults for the properties of the character. | |
1928 | |
1929 Copying text between strings and buffers preserves the properties | |
1930 along with the characters; this includes such diverse functions as | |
1931 @code{substring}, @code{insert}, and @code{buffer-substring}. | |
1932 | |
1933 @menu | |
1934 * Examining Properties:: Looking at the properties of one character. | |
1935 * Changing Properties:: Setting the properties of a range of text. | |
1936 * Property Search:: Searching for where a property changes value. | |
1937 * Special Properties:: Particular properties with special meanings. | |
1938 * Sticky Properties:: How inserted text gets properties from | |
1939 neighboring text. | |
1940 * Saving Properties:: Saving text properties in files, and reading | |
1941 them back. | |
1942 * Not Intervals:: Why text properties do not use | |
1943 Lisp-visible text intervals. | |
1944 @end menu | |
1945 | |
1946 @node Examining Properties | |
1947 @subsection Examining Text Properties | |
1948 | |
1949 The simplest way to examine text properties is to ask for the value of | |
1950 a particular property of a particular character. For that, use | |
1951 @code{get-text-property}. Use @code{text-properties-at} to get the | |
1952 entire property list of a character. @xref{Property Search}, for | |
1953 functions to examine the properties of a number of characters at once. | |
1954 | |
1955 These functions handle both strings and buffers. Keep in mind that | |
1956 positions in a string start from 0, whereas positions in a buffer start | |
1957 from 1. | |
1958 | |
1959 @defun get-text-property pos prop &optional object | |
1960 This function returns the value of the @var{prop} property of the | |
1961 character after position @var{pos} in @var{object} (a buffer or | |
1962 string). The argument @var{object} is optional and defaults to the | |
1963 current buffer. | |
1964 | |
1965 If there is no @var{prop} property strictly speaking, but the character | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
1966 has a category that is a symbol, then @code{get-text-property} returns |
6558 | 1967 the @var{prop} property of that symbol. |
1968 @end defun | |
1969 | |
1970 @defun get-char-property pos prop &optional object | |
1971 This function is like @code{get-text-property}, except that it checks | |
1972 overlays first and then text properties. @xref{Overlays}. | |
1973 | |
1974 The argument @var{object} may be a string, a buffer, or a window. If it | |
1975 is a window, then the buffer displayed in that window is used for text | |
1976 properties and overlays, but only the overlays active for that window | |
1977 are considered. If @var{object} is a buffer, then all overlays in that | |
1978 buffer are considered, as well as text properties. If @var{object} is a | |
1979 string, only text properties are considered, since strings never have | |
1980 overlays. | |
1981 @end defun | |
1982 | |
1983 @defun text-properties-at position &optional object | |
1984 This function returns the entire property list of the character at | |
1985 @var{position} in the string or buffer @var{object}. If @var{object} is | |
1986 @code{nil}, it defaults to the current buffer. | |
1987 @end defun | |
1988 | |
1989 @node Changing Properties | |
1990 @subsection Changing Text Properties | |
1991 | |
1992 The primitives for changing properties apply to a specified range of | |
1993 text. The function @code{set-text-properties} (see end of section) sets | |
1994 the entire property list of the text in that range; more often, it is | |
1995 useful to add, change, or delete just certain properties specified by | |
1996 name. | |
1997 | |
1998 Since text properties are considered part of the buffer's contents, and | |
1999 can affect how the buffer looks on the screen, any change in the text | |
2000 properties is considered a buffer modification. Buffer text property | |
2001 changes are undoable (@pxref{Undo}). | |
2002 | |
2003 @defun add-text-properties start end props &optional object | |
2004 This function modifies the text properties for the text between | |
2005 @var{start} and @var{end} in the string or buffer @var{object}. If | |
2006 @var{object} is @code{nil}, it defaults to the current buffer. | |
2007 | |
2008 The argument @var{props} specifies which properties to change. It | |
2009 should have the form of a property list (@pxref{Property Lists}): a list | |
2010 whose elements include the property names followed alternately by the | |
2011 corresponding values. | |
2012 | |
2013 The return value is @code{t} if the function actually changed some | |
2014 property's value; @code{nil} otherwise (if @var{props} is @code{nil} or | |
2015 its values agree with those in the text). | |
2016 | |
2017 For example, here is how to set the @code{comment} and @code{face} | |
2018 properties of a range of text: | |
2019 | |
2020 @example | |
2021 (add-text-properties @var{start} @var{end} | |
2022 '(comment t face highlight)) | |
2023 @end example | |
2024 @end defun | |
2025 | |
2026 @defun put-text-property start end prop value &optional object | |
2027 This function sets the @var{prop} property to @var{value} for the text | |
2028 between @var{start} and @var{end} in the string or buffer @var{object}. | |
2029 If @var{object} is @code{nil}, it defaults to the current buffer. | |
2030 @end defun | |
2031 | |
2032 @defun remove-text-properties start end props &optional object | |
2033 This function deletes specified text properties from the text between | |
2034 @var{start} and @var{end} in the string or buffer @var{object}. If | |
2035 @var{object} is @code{nil}, it defaults to the current buffer. | |
2036 | |
2037 The argument @var{props} specifies which properties to delete. It | |
2038 should have the form of a property list (@pxref{Property Lists}): a list | |
2039 whose elements are property names alternating with corresponding values. | |
2040 But only the names matter---the values that accompany them are ignored. | |
2041 For example, here's how to remove the @code{face} property. | |
2042 | |
2043 @example | |
2044 (remove-text-properties @var{start} @var{end} '(face nil)) | |
2045 @end example | |
2046 | |
2047 The return value is @code{t} if the function actually changed some | |
2048 property's value; @code{nil} otherwise (if @var{props} is @code{nil} or | |
2049 if no character in the specified text had any of those properties). | |
2050 @end defun | |
2051 | |
2052 @defun set-text-properties start end props &optional object | |
2053 This function completely replaces the text property list for the text | |
2054 between @var{start} and @var{end} in the string or buffer @var{object}. | |
2055 If @var{object} is @code{nil}, it defaults to the current buffer. | |
2056 | |
2057 The argument @var{props} is the new property list. It should be a list | |
2058 whose elements are property names alternating with corresponding values. | |
2059 | |
2060 After @code{set-text-properties} returns, all the characters in the | |
2061 specified range have identical properties. | |
2062 | |
2063 If @var{props} is @code{nil}, the effect is to get rid of all properties | |
2064 from the specified range of text. Here's an example: | |
2065 | |
2066 @example | |
2067 (set-text-properties @var{start} @var{end} nil) | |
2068 @end example | |
2069 @end defun | |
2070 | |
2071 @node Property Search | |
2072 @subsection Property Search Functions | |
2073 | |
2074 In typical use of text properties, most of the time several or many | |
2075 consecutive characters have the same value for a property. Rather than | |
2076 writing your programs to examine characters one by one, it is much | |
2077 faster to process chunks of text that have the same property value. | |
2078 | |
2079 Here are functions you can use to do this. In all cases, @var{object} | |
2080 defaults to the current buffer. | |
2081 | |
2082 For high performance, it's very important to use the @var{limit} | |
2083 argument to these functions, especially the ones that search for a | |
2084 single property---otherwise, they may spend a long time considering | |
2085 changes in other properties while scanning to the end of the buffer. | |
2086 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2087 Remember that a position is always between two characters; the position |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2088 returned by these functions is between two characters with different |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2089 properties. |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2090 |
6558 | 2091 @defun next-property-change pos &optional object limit |
2092 The function scans the text forward from position @var{pos} in the | |
2093 string or buffer @var{object} till it finds a change in some text | |
2094 property, then returns the position of the change. In other words, it | |
2095 returns the position of the first character beyond @var{pos} whose | |
2096 properties are not identical to those of the character just after | |
2097 @var{pos}. | |
2098 | |
2099 If @var{limit} is non-@code{nil}, then the scan ends at position | |
2100 @var{limit}. If there is no property change before that point, | |
2101 @code{next-property-change} returns @var{limit}. | |
2102 | |
2103 The value is @code{nil} if the properties remain unchanged all the way | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2104 to the end of @var{object} and @var{limit} is @code{nil}. If the value |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2105 is non-@code{nil}, it is a position greater than or equal to @var{pos}. |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2106 The value equals @var{pos} only when @var{limit} equals @var{pos}. |
6558 | 2107 |
2108 Here is an example of how to scan the buffer by chunks of text within | |
2109 which all properties are constant: | |
2110 | |
2111 @smallexample | |
2112 (while (not (eobp)) | |
2113 (let ((plist (text-properties-at (point))) | |
2114 (next-change | |
2115 (or (next-property-change (point) (current-buffer)) | |
2116 (point-max)))) | |
2117 @r{Process text from point to @var{next-change}@dots{}} | |
2118 (goto-char next-change))) | |
2119 @end smallexample | |
2120 @end defun | |
2121 | |
2122 @defun next-single-property-change pos prop &optional object limit | |
2123 The function scans the text forward from position @var{pos} in the | |
2124 string or buffer @var{object} till it finds a change in the @var{prop} | |
2125 property, then returns the position of the change. In other words, it | |
2126 returns the position of the first character beyond @var{pos} whose | |
2127 @var{prop} property differs from that of the character just after | |
2128 @var{pos}. | |
2129 | |
2130 If @var{limit} is non-@code{nil}, then the scan ends at position | |
2131 @var{limit}. If there is no property change before that point, | |
2132 @code{next-single-property-change} returns @var{limit}. | |
2133 | |
2134 The value is @code{nil} if the property remains unchanged all the way to | |
2135 the end of @var{object} and @var{limit} is @code{nil}. If the value is | |
2136 non-@code{nil}, it is a position greater than or equal to @var{pos}; it | |
2137 equals @var{pos} only if @var{limit} equals @var{pos}. | |
2138 @end defun | |
2139 | |
2140 @defun previous-property-change pos &optional object limit | |
2141 This is like @code{next-property-change}, but scans back from @var{pos} | |
2142 instead of forward. If the value is non-@code{nil}, it is a position | |
2143 less than or equal to @var{pos}; it equals @var{pos} only if @var{limit} | |
2144 equals @var{pos}. | |
2145 @end defun | |
2146 | |
2147 @defun previous-single-property-change pos prop &optional object limit | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2148 This is like @code{next-single-property-change}, but scans back from |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2149 @var{pos} instead of forward. If the value is non-@code{nil}, it is a |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2150 position less than or equal to @var{pos}; it equals @var{pos} only if |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2151 @var{limit} equals @var{pos}. |
6558 | 2152 @end defun |
2153 | |
2154 @defun text-property-any start end prop value &optional object | |
2155 This function returns non-@code{nil} if at least one character between | |
2156 @var{start} and @var{end} has a property @var{prop} whose value is | |
2157 @var{value}. More precisely, it returns the position of the first such | |
2158 character. Otherwise, it returns @code{nil}. | |
2159 | |
2160 The optional fifth argument, @var{object}, specifies the string or | |
2161 buffer to scan. Positions are relative to @var{object}. The default | |
2162 for @var{object} is the current buffer. | |
2163 @end defun | |
2164 | |
2165 @defun text-property-not-all start end prop value &optional object | |
2166 This function returns non-@code{nil} if at least one character between | |
2167 @var{start} and @var{end} has a property @var{prop} whose value differs | |
2168 from @var{value}. More precisely, it returns the position of the | |
2169 first such character. Otherwise, it returns @code{nil}. | |
2170 | |
2171 The optional fifth argument, @var{object}, specifies the string or | |
2172 buffer to scan. Positions are relative to @var{object}. The default | |
2173 for @var{object} is the current buffer. | |
2174 @end defun | |
2175 | |
2176 @node Special Properties | |
2177 @subsection Properties with Special Meanings | |
2178 | |
2179 @table @code | |
2180 @cindex category of text character | |
2181 @kindex category @r{(text property)} | |
2182 @item category | |
2183 If a character has a @code{category} property, we call it the | |
2184 @dfn{category} of the character. It should be a symbol. The properties | |
2185 of the symbol serve as defaults for the properties of the character. | |
2186 | |
2187 @item face | |
2188 @cindex face codes of text | |
2189 @kindex face @r{(text property)} | |
2190 You can use the property @code{face} to control the font and color of | |
2191 text. @xref{Faces}, for more information. This feature is temporary; | |
2192 in the future, we may replace it with other ways of specifying how to | |
2193 display text. | |
2194 | |
2195 @item mouse-face | |
2196 @kindex mouse-face @r{(text property)} | |
2197 The property @code{mouse-face} is used instead of @code{face} when the | |
2198 mouse is on or near the character. For this purpose, ``near'' means | |
2199 that all text between the character and where the mouse is have the same | |
2200 @code{mouse-face} property value. | |
2201 | |
2202 @item local-map | |
2203 @cindex keymap of character | |
2204 @kindex local-map @r{(text property)} | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2205 You can specify a different keymap for a portion of the text by means of |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2206 a @code{local-map} property. The property's value for the character |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2207 after point, if non-@code{nil}, replaces the buffer's local map. |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2208 @xref{Active Keymaps}. |
6558 | 2209 |
2210 @item read-only | |
2211 @cindex read-only character | |
2212 @kindex read-only @r{(text property)} | |
2213 If a character has the property @code{read-only}, then modifying that | |
2214 character is not allowed. Any command that would do so gets an error. | |
2215 | |
2216 Insertion next to a read-only character is an error if inserting | |
2217 ordinary text there would inherit the @code{read-only} property due to | |
2218 stickiness. Thus, you can control permission to insert next to | |
2219 read-only text by controlling the stickiness. @xref{Sticky Properties}. | |
2220 | |
2221 Since changing properties counts as modifying the buffer, it is not | |
2222 possible to remove a @code{read-only} property unless you know the | |
2223 special trick: bind @code{inhibit-read-only} to a non-@code{nil} value | |
2224 and then remove the property. @xref{Read Only Buffers}. | |
2225 | |
2226 @item invisible | |
2227 @kindex invisible @r{(text property)} | |
2228 A non-@code{nil} @code{invisible} property means a character does not | |
2229 appear on the screen. This works much like selective display. Details | |
2230 of this feature are likely to change in future versions, so check the | |
2231 @file{etc/NEWS} file in the version you are using. | |
2232 | |
6782
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2233 @item intangible |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2234 @kindex intangible @r{(text property)} |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2235 A non-@code{nil} @code{intangible} property on a character prevents |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2236 putting point before that character. If you try, point actually goes |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2237 after the character (and after all succeeding intangible characters). |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2238 |
6558 | 2239 @item modification-hooks |
2240 @cindex change hooks for a character | |
2241 @cindex hooks for changing a character | |
2242 @kindex modification-hooks @r{(text property)} | |
2243 If a character has the property @code{modification-hooks}, then its | |
2244 value should be a list of functions; modifying that character calls all | |
2245 of those functions. Each function receives two arguments: the beginning | |
2246 and end of the part of the buffer being modified. Note that if a | |
2247 particular modification hook function appears on several characters | |
2248 being modified by a single primitive, you can't predict how many times | |
2249 the function will be called. | |
2250 | |
2251 @item insert-in-front-hooks | |
2252 @itemx insert-behind-hooks | |
2253 @kindex insert-in-front-hooks @r{(text property)} | |
2254 @kindex insert-behind-hooks @r{(text property)} | |
9980
ff5d8881a3eb
Fix in insert-behind-hooks and insert-in-front-hooks.
Richard M. Stallman <rms@gnu.org>
parents:
8644
diff
changeset
|
2255 The operation of inserting text in a buffer, before actually modifying |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2256 the buffer, calls the functions listed in the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2257 @code{insert-in-front-hooks} property of the following character and in |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2258 the @code{insert-behind-hooks} property of the preceding character. |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2259 These functions receive two arguments, the beginning and end of the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2260 inserted text. |
6558 | 2261 |
2262 See also @ref{Change Hooks}, for other hooks that are called | |
2263 when you change text in a buffer. | |
2264 | |
2265 @item point-entered | |
2266 @itemx point-left | |
2267 @cindex hooks for motion of point | |
2268 @kindex point-entered @r{(text property)} | |
2269 @kindex point-left @r{(text property)} | |
2270 The special properties @code{point-entered} and @code{point-left} | |
2271 record hook functions that report motion of point. Each time point | |
2272 moves, Emacs compares these two property values: | |
2273 | |
2274 @itemize @bullet | |
2275 @item | |
2276 the @code{point-left} property of the character after the old location, | |
2277 and | |
2278 @item | |
2279 the @code{point-entered} property of the character after the new | |
2280 location. | |
2281 @end itemize | |
2282 | |
2283 @noindent | |
2284 If these two values differ, each of them is called (if not @code{nil}) | |
2285 with two arguments: the old value of point, and the new one. | |
2286 | |
2287 The same comparison is made for the characters before the old and new | |
2288 locations. The result may be to execute two @code{point-left} functions | |
2289 (which may be the same function) and/or two @code{point-entered} | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2290 functions (which may be the same function). In any case, all the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2291 @code{point-left} functions are called first, followed by all the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2292 @code{point-entered} functions. |
6558 | 2293 |
2294 A primitive function may examine characters at various positions | |
2295 without moving point to those positions. Only an actual change in the | |
2296 value of point runs these hook functions. | |
2297 @end table | |
2298 | |
2299 @defvar inhibit-point-motion-hooks | |
2300 When this variable is non-@code{nil}, @code{point-left} and | |
2301 @code{point-entered} hooks are not run. | |
2302 @end defvar | |
2303 | |
2304 @node Sticky Properties | |
2305 @subsection Stickiness of Text Properties | |
2306 @cindex sticky text properties | |
2307 @cindex inheritance of text properties | |
2308 | |
2309 Self-inserting characters normally take on the same properties as the | |
2310 preceding character. This is called @dfn{inheritance} of properties. | |
2311 | |
2312 In a Lisp program, you can do insertion with inheritance or without, | |
2313 depending on your choice of insertion primitive. The ordinary text | |
2314 insertion functions such as @code{insert} do not inherit any properties. | |
2315 They insert text with precisely the properties of the string being | |
2316 inserted, and no others. This is correct for programs that copy text | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2317 from one context to another---for example, into or out of the kill ring. |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2318 To insert with inheritance, use the special primitives described in this |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2319 section. Self-inserting characters inherit properties because they work |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2320 using these primitives. |
6558 | 2321 |
2322 When you do insertion with inheritance, @emph{which} properties are | |
2323 inherited depends on two specific properties: @code{front-sticky} and | |
2324 @code{rear-nonsticky}. | |
2325 | |
2326 Insertion after a character inherits those of its properties that are | |
2327 @dfn{rear-sticky}. Insertion before a character inherits those of its | |
2328 properties that are @dfn{front-sticky}. By default, a text property is | |
2329 rear-sticky but not front-sticky. Thus, the default is to inherit all | |
2330 the properties of the preceding character, and nothing from the | |
2331 following character. You can request different behavior by specifying | |
2332 the stickiness of certain properties. | |
2333 | |
2334 If a character's @code{front-sticky} property is @code{t}, then all | |
2335 its properties are front-sticky. If the @code{front-sticky} property is | |
2336 a list, then the sticky properties of the character are those whose | |
2337 names are in the list. For example, if a character has a | |
2338 @code{front-sticky} property whose value is @code{(face read-only)}, | |
2339 then insertion before the character can inherit its @code{face} property | |
2340 and its @code{read-only} property, but no others. | |
2341 | |
2342 The @code{rear-nonsticky} works the opposite way. Every property is | |
2343 rear-sticky by default, so the @code{rear-nonsticky} property says which | |
2344 properties are @emph{not} rear-sticky. If a character's | |
2345 @code{rear-nonsticky} property is @code{t}, then none of its properties | |
2346 are rear-sticky. If the @code{rear-nonsticky} property is a list, | |
2347 properties are rear-sticky @emph{unless} their names are in the list. | |
2348 | |
2349 When you insert text with inheritance, it inherits all the rear-sticky | |
2350 properties of the preceding character, and all the front-sticky | |
2351 properties of the following character. The previous character's | |
2352 properties take precedence when both sides offer different sticky values | |
2353 for the same property. | |
2354 | |
2355 Here are the functions that insert text with inheritance of properties: | |
2356 | |
2357 @defun insert-and-inherit &rest strings | |
2358 Insert the strings @var{strings}, just like the function @code{insert}, | |
2359 but inherit any sticky properties from the adjoining text. | |
2360 @end defun | |
2361 | |
2362 @defun insert-before-markers-and-inherit &rest strings | |
2363 Insert the strings @var{strings}, just like the function | |
2364 @code{insert-before-markers}, but inherit any sticky properties from the | |
2365 adjoining text. | |
2366 @end defun | |
2367 | |
2368 @node Saving Properties | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2369 @subsection Saving Text Properties in Files |
6558 | 2370 @cindex text properties in files |
2371 @cindex saving text properties | |
2372 | |
2373 You can save text properties in files, and restore text properties | |
2374 when inserting the files, using these two hooks: | |
2375 | |
2376 @defvar write-region-annotation-functions | |
2377 This variable's value is a list of functions for @code{write-region} to | |
2378 run to encode text properties in some fashion as annotations to the text | |
2379 being written in the file. @xref{Writing to Files}. | |
2380 | |
2381 Each function in the list is called with two arguments: the start and | |
2382 end of the region to be written. These functions should not alter the | |
2383 contents of the buffer. Instead, they should return lists indicating | |
2384 annotations to write in the file in addition to the text in the | |
2385 buffer. | |
2386 | |
2387 Each function should return a list of elements of the form | |
2388 @code{(@var{position} . @var{string})}, where @var{position} is an | |
2389 integer specifying the relative position in the text to be written, and | |
2390 @var{string} is the annotation to add there. | |
2391 | |
2392 Each list returned by one of these functions must be already sorted in | |
2393 increasing order by @var{position}. If there is more than one function, | |
2394 @code{write-region} merges the lists destructively into one sorted list. | |
2395 | |
2396 When @code{write-region} actually writes the text from the buffer to the | |
2397 file, it intermixes the specified annotations at the corresponding | |
2398 positions. All this takes place without modifying the buffer. | |
2399 @end defvar | |
2400 | |
2401 @defvar after-insert-file-functions | |
2402 This variable holds a list of functions for @code{insert-file-contents} | |
2403 to call after inserting a file's contents. These functions should scan | |
2404 the inserted text for annotations, and convert them to the text | |
2405 properties they stand for. | |
2406 | |
2407 Each function receives one argument, the length of the inserted text; | |
2408 point indicates the start of that text. The function should scan that | |
2409 text for annotations, delete them, and create the text properties that | |
2410 the annotations specify. The function should return the updated length | |
2411 of the inserted text, as it stands after those changes. The value | |
2412 returned by one function becomes the argument to the next function. | |
2413 | |
2414 These functions should always return with point at the beginning of | |
2415 the inserted text. | |
2416 | |
2417 The intended use of @code{after-insert-file-functions} is for converting | |
2418 some sort of textual annotations into actual text properties. But other | |
2419 uses may be possible. | |
2420 @end defvar | |
2421 | |
2422 We invite users to write Lisp programs to store and retrieve text | |
2423 properties in files, using these hooks, and thus to experiment with | |
2424 various data formats and find good ones. Eventually we hope users | |
2425 will produce good, general extensions we can install in Emacs. | |
2426 | |
2427 We suggest not trying to handle arbitrary Lisp objects as property | |
2428 names or property values---because a program that general is probably | |
2429 difficult to write, and slow. Instead, choose a set of possible data | |
2430 types that are reasonably flexible, and not too hard to encode. | |
2431 | |
2432 @node Not Intervals | |
2433 @subsection Why Text Properties are not Intervals | |
2434 @cindex intervals | |
2435 | |
2436 Some editors that support adding attributes to text in the buffer do | |
2437 so by letting the user specify ``intervals'' within the text, and adding | |
2438 the properties to the intervals. Those editors permit the user or the | |
2439 programmer to determine where individual intervals start and end. We | |
2440 deliberately provided a different sort of interface in Emacs Lisp to | |
2441 avoid certain paradoxical behavior associated with text modification. | |
2442 | |
2443 If the actual subdivision into intervals is meaningful, that means you | |
2444 can distinguish between a buffer that is just one interval with a | |
2445 certain property, and a buffer containing the same text subdivided into | |
2446 two intervals, both of which have that property. | |
2447 | |
2448 Suppose you take the buffer with just one interval and kill part of | |
2449 the text. The text remaining in the buffer is one interval, and the | |
2450 copy in the kill ring (and the undo list) becomes a separate interval. | |
2451 Then if you yank back the killed text, you get two intervals with the | |
2452 same properties. Thus, editing does not preserve the distinction | |
2453 between one interval and two. | |
2454 | |
2455 Suppose we ``fix'' this problem by coalescing the two intervals when | |
2456 the text is inserted. That works fine if the buffer originally was a | |
2457 single interval. But suppose instead that we have two adjacent | |
2458 intervals with the same properties, and we kill the text of one interval | |
2459 and yank it back. The same interval-coalescence feature that rescues | |
2460 the other case causes trouble in this one: after yanking, we have just | |
2461 one interval. One again, editing does not preserve the distinction | |
2462 between one interval and two. | |
2463 | |
2464 Insertion of text at the border between intervals also raises | |
2465 questions that have no satisfactory answer. | |
2466 | |
2467 However, it is easy to arrange for editing to behave consistently for | |
2468 questions of the form, ``What are the properties of this character?'' | |
2469 So we have decided these are the only questions that make sense; we have | |
2470 not implemented asking questions about where intervals start or end. | |
2471 | |
2472 In practice, you can usually use the property search functions in | |
2473 place of explicit interval boundaries. You can think of them as finding | |
2474 the boundaries of intervals, assuming that intervals are always | |
2475 coalesced whenever possible. @xref{Property Search}. | |
2476 | |
2477 Emacs also provides explicit intervals as a presentation feature; see | |
2478 @ref{Overlays}. | |
2479 | |
2480 @node Substitution | |
2481 @section Substituting for a Character Code | |
2482 | |
2483 The following functions replace characters within a specified region | |
2484 based on their character codes. | |
2485 | |
2486 @defun subst-char-in-region start end old-char new-char &optional noundo | |
2487 @cindex replace characters | |
2488 This function replaces all occurrences of the character @var{old-char} | |
2489 with the character @var{new-char} in the region of the current buffer | |
2490 defined by @var{start} and @var{end}. | |
2491 | |
2492 @cindex Outline mode | |
2493 @cindex undo avoidance | |
2494 If @var{noundo} is non-@code{nil}, then @code{subst-char-in-region} | |
2495 does not record the change for undo and does not mark the buffer as | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2496 modified. This feature is useful for changes that are not considered |
6558 | 2497 significant, such as when Outline mode changes visible lines to |
2498 invisible lines and vice versa. | |
2499 | |
2500 @code{subst-char-in-region} does not move point and returns | |
2501 @code{nil}. | |
2502 | |
2503 @example | |
2504 @group | |
2505 ---------- Buffer: foo ---------- | |
2506 This is the contents of the buffer before. | |
2507 ---------- Buffer: foo ---------- | |
2508 @end group | |
2509 | |
2510 @group | |
2511 (subst-char-in-region 1 20 ?i ?X) | |
2512 @result{} nil | |
2513 | |
2514 ---------- Buffer: foo ---------- | |
2515 ThXs Xs the contents of the buffer before. | |
2516 ---------- Buffer: foo ---------- | |
2517 @end group | |
2518 @end example | |
2519 @end defun | |
2520 | |
2521 @defun translate-region start end table | |
2522 This function applies a translation table to the characters in the | |
2523 buffer between positions @var{start} and @var{end}. | |
2524 | |
2525 The translation table @var{table} is a string; @code{(aref @var{table} | |
2526 @var{ochar})} gives the translated character corresponding to | |
2527 @var{ochar}. If the length of @var{table} is less than 256, any | |
2528 characters with codes larger than the length of @var{table} are not | |
2529 altered by the translation. | |
2530 | |
2531 The return value of @code{translate-region} is the number of | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2532 characters that were actually changed by the translation. This does |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2533 not count characters that were mapped into themselves in the |
6558 | 2534 translation table. |
2535 | |
2536 This function is available in Emacs versions 19 and later. | |
2537 @end defun | |
2538 | |
2539 @node Registers | |
2540 @section Registers | |
2541 @cindex registers | |
2542 | |
2543 A register is a sort of variable used in Emacs editing that can hold a | |
2544 marker, a string, a rectangle, a window configuration (of one frame), or | |
2545 a frame configuration (of all frames). Each register is named by a | |
2546 single character. All characters, including control and meta characters | |
2547 (but with the exception of @kbd{C-g}), can be used to name registers. | |
2548 Thus, there are 255 possible registers. A register is designated in | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
2549 Emacs Lisp by a character that is its name. |
6558 | 2550 |
2551 The functions in this section return unpredictable values unless | |
2552 otherwise stated. | |
2553 @c Will change in version 19 | |
2554 | |
2555 @defvar register-alist | |
2556 This variable is an alist of elements of the form @code{(@var{name} . | |
2557 @var{contents})}. Normally, there is one element for each Emacs | |
2558 register that has been used. | |
2559 | |
2560 The object @var{name} is a character (an integer) identifying the | |
2561 register. The object @var{contents} is a string, marker, or list | |
2562 representing the register contents. A string represents text stored in | |
2563 the register. A marker represents a position. A list represents a | |
2564 rectangle; its elements are strings, one per line of the rectangle. | |
2565 @end defvar | |
2566 | |
2567 @defun get-register reg | |
2568 This function returns the contents of the register | |
2569 @var{reg}, or @code{nil} if it has no contents. | |
2570 @end defun | |
2571 | |
2572 @defun set-register reg value | |
2573 This function sets the contents of register @var{reg} to @var{value}. | |
2574 A register can be set to any value, but the other register functions | |
2575 expect only certain data types. The return value is @var{value}. | |
2576 @end defun | |
2577 | |
2578 @deffn Command view-register reg | |
2579 This command displays what is contained in register @var{reg}. | |
2580 @end deffn | |
2581 | |
2582 @ignore | |
2583 @deffn Command point-to-register reg | |
2584 This command stores both the current location of point and the current | |
2585 buffer in register @var{reg} as a marker. | |
2586 @end deffn | |
2587 | |
2588 @deffn Command jump-to-register reg | |
2589 @deffnx Command register-to-point reg | |
2590 @comment !!SourceFile register.el | |
2591 This command restores the status recorded in register @var{reg}. | |
2592 | |
2593 If @var{reg} contains a marker, it moves point to the position stored in | |
2594 the marker. Since both the buffer and the location within the buffer | |
2595 are stored by the @code{point-to-register} function, this command can | |
2596 switch you to another buffer. | |
2597 | |
2598 If @var{reg} contains a window configuration or a frame configuration. | |
2599 @code{jump-to-register} restores that configuration. | |
2600 @end deffn | |
2601 @end ignore | |
2602 | |
2603 @deffn Command insert-register reg &optional beforep | |
2604 This command inserts contents of register @var{reg} into the current | |
2605 buffer. | |
2606 | |
2607 Normally, this command puts point before the inserted text, and the | |
2608 mark after it. However, if the optional second argument @var{beforep} | |
2609 is non-@code{nil}, it puts the mark before and point after. | |
2610 You can pass a non-@code{nil} second argument @var{beforep} to this | |
2611 function interactively by supplying any prefix argument. | |
2612 | |
2613 If the register contains a rectangle, then the rectangle is inserted | |
2614 with its upper left corner at point. This means that text is inserted | |
2615 in the current line and underneath it on successive lines. | |
2616 | |
2617 If the register contains something other than saved text (a string) or | |
2618 a rectangle (a list), currently useless things happen. This may be | |
2619 changed in the future. | |
2620 @end deffn | |
2621 | |
2622 @ignore | |
2623 @deffn Command copy-to-register reg start end &optional delete-flag | |
2624 This command copies the region from @var{start} to @var{end} into | |
2625 register @var{reg}. If @var{delete-flag} is non-@code{nil}, it deletes | |
2626 the region from the buffer after copying it into the register. | |
2627 @end deffn | |
2628 | |
2629 @deffn Command prepend-to-register reg start end &optional delete-flag | |
2630 This command prepends the region from @var{start} to @var{end} into | |
2631 register @var{reg}. If @var{delete-flag} is non-@code{nil}, it deletes | |
2632 the region from the buffer after copying it to the register. | |
2633 @end deffn | |
2634 | |
2635 @deffn Command append-to-register reg start end &optional delete-flag | |
2636 This command appends the region from @var{start} to @var{end} to the | |
2637 text already in register @var{reg}. If @var{delete-flag} is | |
2638 non-@code{nil}, it deletes the region from the buffer after copying it | |
2639 to the register. | |
2640 @end deffn | |
2641 | |
2642 @deffn Command copy-rectangle-to-register reg start end &optional delete-flag | |
2643 This command copies a rectangular region from @var{start} to @var{end} | |
2644 into register @var{reg}. If @var{delete-flag} is non-@code{nil}, it | |
2645 deletes the region from the buffer after copying it to the register. | |
2646 @end deffn | |
2647 | |
2648 @deffn Command window-configuration-to-register reg | |
2649 This function stores the window configuration of the selected frame in | |
2650 register @var{reg}. | |
2651 @end deffn | |
2652 | |
2653 @deffn Command frame-configuration-to-register reg | |
2654 This function stores the current frame configuration in register | |
2655 @var{reg}. | |
2656 @end deffn | |
2657 @end ignore | |
2658 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2659 @node Transposition |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2660 @section Transposition of Text |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2661 |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2662 This subroutine is used by the transposition commands. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2663 |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2664 @defun transpose-regions start1 end1 start2 end2 &optional leave-markers |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2665 This function exchanges two nonoverlapping portions of the buffer. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2666 Arguments @var{start1} and @var{end1} specify the bounds of one portion |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2667 and arguments @var{start2} and @var{end2} specify the bounds of the |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2668 other portion. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2669 |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2670 Normally, @code{transpose-regions} relocates markers with the transposed |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2671 text; a marker previously positioned within one of the two transposed |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2672 portions moves along with that portion, thus remaining between the same |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2673 two characters in their new position. However, if @var{leave-markers} |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2674 is non-@code{nil}, @code{transpose-regions} does not do this---it leaves |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2675 all markers unrelocated. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2676 @end defun |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2677 |
6558 | 2678 @node Change Hooks |
2679 @section Change Hooks | |
2680 @cindex change hooks | |
2681 @cindex hooks for text changes | |
2682 | |
2683 These hook variables let you arrange to take notice of all changes in | |
2684 all buffers (or in a particular buffer, if you make them buffer-local). | |
2685 See also @ref{Special Properties}, for how to detect changes to specific | |
2686 parts of the text. | |
2687 | |
2688 The functions you use in these hooks should save and restore the match | |
2689 data if they do anything that uses regular expressions; otherwise, they | |
2690 will interfere in bizarre ways with the editing operations that call | |
2691 them. | |
2692 | |
6782
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2693 @defvar before-change-functions |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2694 This variable holds a list of a functions to call before any buffer |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2695 modification. Each function gets two arguments, the beginning and end |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2696 of the region that is about to change, represented as integers. The |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2697 buffer that is about to change is always the current buffer. |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2698 @end defvar |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2699 |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2700 @defvar after-change-functions |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2701 This variable holds a list of a functions to call after any buffer |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2702 modification. Each function receives three arguments: the beginning and |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2703 end of the region just changed, and the length of the text that existed |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2704 before the change. (To get the current length, subtract the region |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2705 beginning from the region end.) All three arguments are integers. The |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2706 buffer that's about to change is always the current buffer. |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2707 @end defvar |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2708 |
6558 | 2709 @defvar before-change-function |
6782
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2710 This variable holds one function to call before any buffer modification |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2711 (or @code{nil} for no function). It is called just like the functions |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2712 in @code{before-change-functions}. |
6558 | 2713 @end defvar |
2714 | |
2715 @defvar after-change-function | |
6782
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2716 This variable holds one function to call after any buffer modification |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2717 (or @code{nil} for no function). It is called just like the functions in |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2718 @code{after-change-functions}. |
6558 | 2719 @end defvar |
2720 | |
6782
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2721 The four variables above are temporarily bound to @code{nil} during the |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2722 time that any of these functions is running. This means that if one of |
6558 | 2723 these functions changes the buffer, that change won't run these |
6782
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2724 functions. If you do want a hook function to make changes that run |
5b07647ec8f7
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6558
diff
changeset
|
2725 these functions, make it bind these variables back to their usual |
6558 | 2726 values. |
2727 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2728 One inconvenient result of this protective feature is that you cannot |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2729 have a function in @code{after-change-functions} or |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2730 @code{before-change-functions} which changes the value of that variable. |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2731 But that's not a real limitation. If you want those functions to change |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2732 the list of functions to run, simply add one fixed function to the hook, |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2733 and code that function to look in another variable for other functions |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2734 to call. Here is an example: |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2735 |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2736 @example |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2737 (setq my-own-after-change-functions nil) |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2738 (defun indirect-after-change-function (beg end len) |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2739 (let ((list my-own-after-change-functions)) |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2740 (while list |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2741 (funcall (car list) beg end len) |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2742 (setq list (cdr list))))) |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2743 (add-hooks 'after-change-functions |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2744 'indirect-after-change-function) |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2745 @end example |
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6782
diff
changeset
|
2746 |
6558 | 2747 @defvar first-change-hook |
2748 This variable is a normal hook that is run whenever a buffer is changed | |
2749 that was previously in the unmodified state. | |
2750 @end defvar | |
2751 | |
2752 The variables described in this section are meaningful only starting | |
2753 with Emacs version 19. |