Commit | Line | Data |
---|---|---|
73804d4b RS |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
651f374c | 3 | @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2000, 2001, |
ceb4c4d3 | 4 | @c 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
73804d4b RS |
5 | @c See the file elisp.texi for copying conditions. |
6 | @setfilename ../info/text | |
f9f59935 | 7 | @node Text, Non-ASCII Characters, Markers, Top |
73804d4b RS |
8 | @chapter Text |
9 | @cindex text | |
10 | ||
11 | This chapter describes the functions that deal with the text in a | |
61cfa852 | 12 | buffer. Most examine, insert, or delete text in the current buffer, |
b6954afd RS |
13 | often operating at point or on text adjacent to point. Many are |
14 | interactive. All the functions that change the text provide for undoing | |
15 | the changes (@pxref{Undo}). | |
73804d4b RS |
16 | |
17 | Many text-related functions operate on a region of text defined by two | |
18 | buffer positions passed in arguments named @var{start} and @var{end}. | |
19 | These arguments should be either markers (@pxref{Markers}) or numeric | |
20 | character positions (@pxref{Positions}). The order of these arguments | |
21 | does not matter; it is all right for @var{start} to be the end of the | |
22 | region and @var{end} the beginning. For example, @code{(delete-region 1 | |
23 | 10)} and @code{(delete-region 10 1)} are equivalent. An | |
24 | @code{args-out-of-range} error is signaled if either @var{start} or | |
25 | @var{end} is outside the accessible portion of the buffer. In an | |
26 | interactive call, point and the mark are used for these arguments. | |
27 | ||
28 | @cindex buffer contents | |
29 | Throughout this chapter, ``text'' refers to the characters in the | |
b6954afd RS |
30 | buffer, together with their properties (when relevant). Keep in mind |
31 | that point is always between two characters, and the cursor appears on | |
32 | the character after point. | |
73804d4b RS |
33 | |
34 | @menu | |
35 | * Near Point:: Examining text in the vicinity of point. | |
36 | * Buffer Contents:: Examining text in a general fashion. | |
37 | * Comparing Text:: Comparing substrings of buffers. | |
38 | * Insertion:: Adding new text to a buffer. | |
39 | * Commands for Insertion:: User-level commands to insert text. | |
40 | * Deletion:: Removing text from a buffer. | |
41 | * User-Level Deletion:: User-level commands to delete text. | |
42 | * The Kill Ring:: Where removed text sometimes is saved for later use. | |
43 | * Undo:: Undoing changes to the text of a buffer. | |
44 | * Maintaining Undo:: How to enable and disable undo information. | |
45 | How to control how much information is kept. | |
46 | * Filling:: Functions for explicit filling. | |
bfe721d1 | 47 | * Margins:: How to specify margins for filling commands. |
e75ecfec | 48 | * Adaptive Fill:: Adaptive Fill mode chooses a fill prefix from context. |
73804d4b RS |
49 | * Auto Filling:: How auto-fill mode is implemented to break lines. |
50 | * Sorting:: Functions for sorting parts of the buffer. | |
51 | * Columns:: Computing horizontal positions, and using them. | |
52 | * Indentation:: Functions to insert or adjust indentation. | |
53 | * Case Changes:: Case conversion of parts of the buffer. | |
54 | * Text Properties:: Assigning Lisp property lists to text characters. | |
55 | * Substitution:: Replacing a given character wherever it appears. | |
b22f3a19 | 56 | * Transposition:: Swapping two portions of a buffer. |
73804d4b RS |
57 | * Registers:: How registers are implemented. Accessing the text or |
58 | position stored in a register. | |
b6954afd | 59 | * Base 64:: Conversion to or from base 64 encoding. |
13cad738 RS |
60 | * MD5 Checksum:: Compute the MD5 "message digest"/"checksum". |
61 | * Atomic Changes:: Installing several buffer changes "atomically". | |
73804d4b RS |
62 | * Change Hooks:: Supplying functions to be run when text is changed. |
63 | @end menu | |
64 | ||
65 | @node Near Point | |
66 | @section Examining Text Near Point | |
67 | ||
68 | Many functions are provided to look at the characters around point. | |
69 | Several simple functions are described here. See also @code{looking-at} | |
70 | in @ref{Regexp Search}. | |
71 | ||
af1996b5 LT |
72 | In the following four functions, ``beginning'' or ``end'' of buffer |
73 | refers to the beginning or end of the accessible portion. | |
74 | ||
1911e6e5 | 75 | @defun char-after &optional position |
73804d4b RS |
76 | This function returns the character in the current buffer at (i.e., |
77 | immediately after) position @var{position}. If @var{position} is out of | |
78 | range for this purpose, either before the beginning of the buffer, or at | |
1911e6e5 RS |
79 | or beyond the end, then the value is @code{nil}. The default for |
80 | @var{position} is point. | |
73804d4b RS |
81 | |
82 | In the following example, assume that the first character in the | |
83 | buffer is @samp{@@}: | |
84 | ||
85 | @example | |
86 | @group | |
87 | (char-to-string (char-after 1)) | |
88 | @result{} "@@" | |
89 | @end group | |
90 | @end example | |
91 | @end defun | |
92 | ||
1911e6e5 | 93 | @defun char-before &optional position |
969fe9b5 RS |
94 | This function returns the character in the current buffer immediately |
95 | before position @var{position}. If @var{position} is out of range for | |
a3a349c4 | 96 | this purpose, either at or before the beginning of the buffer, or beyond |
1911e6e5 RS |
97 | the end, then the value is @code{nil}. The default for |
98 | @var{position} is point. | |
969fe9b5 RS |
99 | @end defun |
100 | ||
73804d4b RS |
101 | @defun following-char |
102 | This function returns the character following point in the current | |
103 | buffer. This is similar to @code{(char-after (point))}. However, if | |
104 | point is at the end of the buffer, then @code{following-char} returns 0. | |
105 | ||
106 | Remember that point is always between characters, and the terminal | |
107 | cursor normally appears over the character following point. Therefore, | |
108 | the character returned by @code{following-char} is the character the | |
109 | cursor is over. | |
110 | ||
111 | In this example, point is between the @samp{a} and the @samp{c}. | |
112 | ||
113 | @example | |
114 | @group | |
115 | ---------- Buffer: foo ---------- | |
116 | Gentlemen may cry ``Pea@point{}ce! Peace!,'' | |
117 | but there is no peace. | |
118 | ---------- Buffer: foo ---------- | |
119 | @end group | |
120 | ||
121 | @group | |
122 | (char-to-string (preceding-char)) | |
123 | @result{} "a" | |
124 | (char-to-string (following-char)) | |
125 | @result{} "c" | |
126 | @end group | |
127 | @end example | |
128 | @end defun | |
129 | ||
130 | @defun preceding-char | |
131 | This function returns the character preceding point in the current | |
132 | buffer. See above, under @code{following-char}, for an example. If | |
133 | point is at the beginning of the buffer, @code{preceding-char} returns | |
134 | 0. | |
135 | @end defun | |
136 | ||
137 | @defun bobp | |
138 | This function returns @code{t} if point is at the beginning of the | |
139 | buffer. If narrowing is in effect, this means the beginning of the | |
140 | accessible portion of the text. See also @code{point-min} in | |
141 | @ref{Point}. | |
142 | @end defun | |
143 | ||
144 | @defun eobp | |
145 | This function returns @code{t} if point is at the end of the buffer. | |
146 | If narrowing is in effect, this means the end of accessible portion of | |
147 | the text. See also @code{point-max} in @xref{Point}. | |
148 | @end defun | |
149 | ||
150 | @defun bolp | |
151 | This function returns @code{t} if point is at the beginning of a line. | |
f9f59935 | 152 | @xref{Text Lines}. The beginning of the buffer (or of its accessible |
61cfa852 | 153 | portion) always counts as the beginning of a line. |
73804d4b RS |
154 | @end defun |
155 | ||
156 | @defun eolp | |
157 | This function returns @code{t} if point is at the end of a line. The | |
158 | end of the buffer (or of its accessible portion) is always considered | |
159 | the end of a line. | |
160 | @end defun | |
161 | ||
162 | @node Buffer Contents | |
163 | @section Examining Buffer Contents | |
164 | ||
2a233172 | 165 | This section describes functions that allow a Lisp program to |
73804d4b RS |
166 | convert any portion of the text in the buffer into a string. |
167 | ||
168 | @defun buffer-substring start end | |
169 | This function returns a string containing a copy of the text of the | |
170 | region defined by positions @var{start} and @var{end} in the current | |
171 | buffer. If the arguments are not positions in the accessible portion of | |
172 | the buffer, @code{buffer-substring} signals an @code{args-out-of-range} | |
173 | error. | |
174 | ||
175 | It is not necessary for @var{start} to be less than @var{end}; the | |
176 | arguments can be given in either order. But most often the smaller | |
177 | argument is written first. | |
178 | ||
d735cf50 | 179 | Here's an example which assumes Font-Lock mode is not enabled: |
22697dac | 180 | |
73804d4b RS |
181 | @example |
182 | @group | |
183 | ---------- Buffer: foo ---------- | |
184 | This is the contents of buffer foo | |
185 | ||
186 | ---------- Buffer: foo ---------- | |
187 | @end group | |
188 | ||
189 | @group | |
190 | (buffer-substring 1 10) | |
1c1a1471 | 191 | @result{} "This is t" |
73804d4b RS |
192 | @end group |
193 | @group | |
194 | (buffer-substring (point-max) 10) | |
1c1a1471 | 195 | @result{} "he contents of buffer foo\n" |
73804d4b RS |
196 | @end group |
197 | @end example | |
d735cf50 RS |
198 | |
199 | If the text being copied has any text properties, these are copied into | |
200 | the string along with the characters they belong to. @xref{Text | |
201 | Properties}. However, overlays (@pxref{Overlays}) in the buffer and | |
202 | their properties are ignored, not copied. | |
203 | ||
204 | For example, if Font-Lock mode is enabled, you might get results like | |
205 | these: | |
206 | ||
207 | @example | |
208 | @group | |
209 | (buffer-substring 1 10) | |
210 | @result{} #("This is t" 0 1 (fontified t) 1 9 (fontified t)) | |
211 | @end group | |
212 | @end example | |
73804d4b RS |
213 | @end defun |
214 | ||
371f8cd0 | 215 | @defun buffer-substring-no-properties start end |
22697dac KH |
216 | This is like @code{buffer-substring}, except that it does not copy text |
217 | properties, just the characters themselves. @xref{Text Properties}. | |
22697dac KH |
218 | @end defun |
219 | ||
1f8a33db | 220 | @defun filter-buffer-substring start end &optional delete noprops |
8e669bbd RS |
221 | This function passes the buffer text between @var{start} and @var{end} |
222 | through the filter functions specified by the variable | |
223 | @code{buffer-substring-filters}, and returns the value from the last | |
224 | filter function. If @code{buffer-substring-filters} is @code{nil}, | |
225 | the value is the unaltered text from the buffer, what | |
226 | @code{buffer-substring} would return. | |
227 | ||
228 | If @var{delete} is non-@code{nil}, this function deletes the text | |
229 | between @var{start} and @var{end} after copying it, like | |
230 | @code{delete-and-extract-region}. | |
231 | ||
1f8a33db KS |
232 | If @var{noprops} is non-@code{nil}, the final string returned does not |
233 | include text properties, while the string passed through the filters | |
234 | still includes text properties from the buffer text. | |
235 | ||
236 | Lisp code should use this function instead of @code{buffer-substring}, | |
237 | @code{buffer-substring-no-properties}, | |
8e669bbd RS |
238 | or @code{delete-and-extract-region} when copying into user-accessible |
239 | data structures such as the kill-ring, X clipboard, and registers. | |
240 | Major and minor modes can add functions to | |
241 | @code{buffer-substring-filters} to alter such text as it is copied out | |
242 | of the buffer. | |
243 | @end defun | |
244 | ||
245 | @defvar buffer-substring-filters | |
246 | This variable should be a list of functions that accept a single | |
247 | argument, a string, and return a string. | |
248 | @code{filter-buffer-substring} passes the buffer substring to the | |
249 | first function in this list, and the return value of each function is | |
250 | passed to the next function. The return value of the last function is | |
251 | used as the return value of @code{filter-buffer-substring}. | |
252 | ||
253 | As a special convention, point is set to the start of the buffer text | |
254 | being operated on (i.e., the @var{start} argument for | |
255 | @code{filter-buffer-substring}) before these functions are called. | |
256 | ||
257 | If this variable is @code{nil}, no filtering is performed. | |
258 | @end defvar | |
259 | ||
73804d4b | 260 | @defun buffer-string |
f9f59935 | 261 | This function returns the contents of the entire accessible portion of |
a9f0a989 RS |
262 | the current buffer as a string. It is equivalent to |
263 | ||
264 | @example | |
265 | (buffer-substring (point-min) (point-max)) | |
266 | @end example | |
73804d4b RS |
267 | |
268 | @example | |
269 | @group | |
270 | ---------- Buffer: foo ---------- | |
271 | This is the contents of buffer foo | |
272 | ||
273 | ---------- Buffer: foo ---------- | |
274 | ||
275 | (buffer-string) | |
1c1a1471 | 276 | @result{} "This is the contents of buffer foo\n" |
73804d4b RS |
277 | @end group |
278 | @end example | |
279 | @end defun | |
280 | ||
74eee906 RS |
281 | @defun current-word &optional strict really-word |
282 | This function returns the symbol (or word) at or near point, as a string. | |
283 | The return value includes no text properties. | |
284 | ||
af1996b5 LT |
285 | If the optional argument @var{really-word} is non-@code{nil}, it finds a |
286 | word; otherwise, it finds a symbol (which includes both word | |
287 | characters and symbol constituent characters). | |
74eee906 RS |
288 | |
289 | If the optional argument @var{strict} is non-@code{nil}, then point | |
290 | must be in or next to the symbol or word---if no symbol or word is | |
291 | there, the function returns @code{nil}. Otherwise, a nearby symbol or | |
292 | word on the same line is acceptable. | |
293 | @end defun | |
294 | ||
f9f59935 RS |
295 | @defun thing-at-point thing |
296 | Return the @var{thing} around or next to point, as a string. | |
297 | ||
298 | The argument @var{thing} is a symbol which specifies a kind of syntactic | |
299 | entity. Possibilities include @code{symbol}, @code{list}, @code{sexp}, | |
300 | @code{defun}, @code{filename}, @code{url}, @code{word}, @code{sentence}, | |
301 | @code{whitespace}, @code{line}, @code{page}, and others. | |
302 | ||
303 | @example | |
304 | ---------- Buffer: foo ---------- | |
305 | Gentlemen may cry ``Pea@point{}ce! Peace!,'' | |
306 | but there is no peace. | |
307 | ---------- Buffer: foo ---------- | |
308 | ||
309 | (thing-at-point 'word) | |
310 | @result{} "Peace" | |
311 | (thing-at-point 'line) | |
312 | @result{} "Gentlemen may cry ``Peace! Peace!,''\n" | |
313 | (thing-at-point 'whitespace) | |
314 | @result{} nil | |
315 | @end example | |
316 | @end defun | |
317 | ||
73804d4b RS |
318 | @node Comparing Text |
319 | @section Comparing Text | |
320 | @cindex comparing buffer text | |
321 | ||
322 | This function lets you compare portions of the text in a buffer, without | |
323 | copying them into strings first. | |
324 | ||
325 | @defun compare-buffer-substrings buffer1 start1 end1 buffer2 start2 end2 | |
326 | This function lets you compare two substrings of the same buffer or two | |
327 | different buffers. The first three arguments specify one substring, | |
af1996b5 LT |
328 | giving a buffer (or a buffer name) and two positions within the |
329 | buffer. The last three arguments specify the other substring in the | |
330 | same way. You can use @code{nil} for @var{buffer1}, @var{buffer2}, or | |
331 | both to stand for the current buffer. | |
73804d4b RS |
332 | |
333 | The value is negative if the first substring is less, positive if the | |
334 | first is greater, and zero if they are equal. The absolute value of | |
335 | the result is one plus the index of the first differing characters | |
336 | within the substrings. | |
337 | ||
338 | This function ignores case when comparing characters | |
bfe721d1 KH |
339 | if @code{case-fold-search} is non-@code{nil}. It always ignores |
340 | text properties. | |
73804d4b RS |
341 | |
342 | Suppose the current buffer contains the text @samp{foobarbar | |
343 | haha!rara!}; then in this example the two substrings are @samp{rbar } | |
344 | and @samp{rara!}. The value is 2 because the first substring is greater | |
345 | at the second character. | |
346 | ||
347 | @example | |
8241495d | 348 | (compare-buffer-substrings nil 6 11 nil 16 21) |
73804d4b RS |
349 | @result{} 2 |
350 | @end example | |
73804d4b RS |
351 | @end defun |
352 | ||
353 | @node Insertion | |
bfe721d1 | 354 | @section Inserting Text |
73804d4b RS |
355 | @cindex insertion of text |
356 | @cindex text insertion | |
357 | ||
969fe9b5 RS |
358 | @cindex insertion before point |
359 | @cindex before point, insertion | |
73804d4b RS |
360 | @dfn{Insertion} means adding new text to a buffer. The inserted text |
361 | goes at point---between the character before point and the character | |
969fe9b5 RS |
362 | after point. Some insertion functions leave point before the inserted |
363 | text, while other functions leave it after. We call the former | |
364 | insertion @dfn{after point} and the latter insertion @dfn{before point}. | |
73804d4b RS |
365 | |
366 | Insertion relocates markers that point at positions after the | |
367 | insertion point, so that they stay with the surrounding text | |
368 | (@pxref{Markers}). When a marker points at the place of insertion, | |
969fe9b5 RS |
369 | insertion may or may not relocate the marker, depending on the marker's |
370 | insertion type (@pxref{Marker Insertion Types}). Certain special | |
371 | functions such as @code{insert-before-markers} relocate all such markers | |
372 | to point after the inserted text, regardless of the markers' insertion | |
373 | type. | |
73804d4b RS |
374 | |
375 | Insertion functions signal an error if the current buffer is | |
2468d0c0 | 376 | read-only or if they insert within read-only text. |
73804d4b | 377 | |
bfe721d1 KH |
378 | These functions copy text characters from strings and buffers along |
379 | with their properties. The inserted characters have exactly the same | |
380 | properties as the characters they were copied from. By contrast, | |
381 | characters specified as separate arguments, not part of a string or | |
382 | buffer, inherit their text properties from the neighboring text. | |
383 | ||
a9f0a989 RS |
384 | The insertion functions convert text from unibyte to multibyte in |
385 | order to insert in a multibyte buffer, and vice versa---if the text | |
386 | comes from a string or from a buffer. However, they do not convert | |
387 | unibyte character codes 128 through 255 to multibyte characters, not | |
388 | even if the current buffer is a multibyte buffer. @xref{Converting | |
389 | Representations}. | |
390 | ||
73804d4b RS |
391 | @defun insert &rest args |
392 | This function inserts the strings and/or characters @var{args} into the | |
61cfa852 RS |
393 | current buffer, at point, moving point forward. In other words, it |
394 | inserts the text before point. An error is signaled unless all | |
395 | @var{args} are either strings or characters. The value is @code{nil}. | |
73804d4b RS |
396 | @end defun |
397 | ||
398 | @defun insert-before-markers &rest args | |
399 | This function inserts the strings and/or characters @var{args} into the | |
400 | current buffer, at point, moving point forward. An error is signaled | |
401 | unless all @var{args} are either strings or characters. The value is | |
402 | @code{nil}. | |
403 | ||
404 | This function is unlike the other insertion functions in that it | |
405 | relocates markers initially pointing at the insertion point, to point | |
2a233172 RS |
406 | after the inserted text. If an overlay begins at the insertion point, |
407 | the inserted text falls outside the overlay; if a nonempty overlay | |
408 | ends at the insertion point, the inserted text falls inside that | |
409 | overlay. | |
73804d4b RS |
410 | @end defun |
411 | ||
9e3561d2 | 412 | @defun insert-char character count &optional inherit |
73804d4b | 413 | This function inserts @var{count} instances of @var{character} into the |
6646ea10 TTN |
414 | current buffer before point. The argument @var{count} should be an |
415 | integer, and @var{character} must be a character. The value is @code{nil}. | |
33acbad2 | 416 | |
a9f0a989 RS |
417 | This function does not convert unibyte character codes 128 through 255 |
418 | to multibyte characters, not even if the current buffer is a multibyte | |
419 | buffer. @xref{Converting Representations}. | |
420 | ||
33acbad2 RS |
421 | If @var{inherit} is non-@code{nil}, then the inserted characters inherit |
422 | sticky text properties from the two characters before and after the | |
423 | insertion point. @xref{Sticky Properties}. | |
73804d4b RS |
424 | @end defun |
425 | ||
426 | @defun insert-buffer-substring from-buffer-or-name &optional start end | |
427 | This function inserts a portion of buffer @var{from-buffer-or-name} | |
428 | (which must already exist) into the current buffer before point. The | |
af1996b5 | 429 | text inserted is the region between @var{start} and @var{end}. (These |
73804d4b RS |
430 | arguments default to the beginning and end of the accessible portion of |
431 | that buffer.) This function returns @code{nil}. | |
432 | ||
433 | In this example, the form is executed with buffer @samp{bar} as the | |
434 | current buffer. We assume that buffer @samp{bar} is initially empty. | |
435 | ||
436 | @example | |
437 | @group | |
438 | ---------- Buffer: foo ---------- | |
439 | We hold these truths to be self-evident, that all | |
440 | ---------- Buffer: foo ---------- | |
441 | @end group | |
442 | ||
443 | @group | |
444 | (insert-buffer-substring "foo" 1 20) | |
445 | @result{} nil | |
446 | ||
447 | ---------- Buffer: bar ---------- | |
61cfa852 | 448 | We hold these truth@point{} |
73804d4b RS |
449 | ---------- Buffer: bar ---------- |
450 | @end group | |
451 | @end example | |
d73eac4d RS |
452 | @end defun |
453 | ||
454 | @defun insert-buffer-substring-no-properties from-buffer-or-name &optional start end | |
455 | This is like @code{insert-buffer-substring} except that it does not | |
456 | copy any text properties. | |
73804d4b RS |
457 | @end defun |
458 | ||
459 | @xref{Sticky Properties}, for other insertion functions that inherit | |
61cfa852 | 460 | text properties from the nearby text in addition to inserting it. |
33acbad2 RS |
461 | Whitespace inserted by indentation functions also inherits text |
462 | properties. | |
73804d4b RS |
463 | |
464 | @node Commands for Insertion | |
465 | @section User-Level Insertion Commands | |
466 | ||
467 | This section describes higher-level commands for inserting text, | |
468 | commands intended primarily for the user but useful also in Lisp | |
469 | programs. | |
470 | ||
471 | @deffn Command insert-buffer from-buffer-or-name | |
af1996b5 LT |
472 | This command inserts the entire accessible contents of |
473 | @var{from-buffer-or-name} (which must exist) into the current buffer | |
474 | after point. It leaves the mark after the inserted text. The value | |
475 | is @code{nil}. | |
73804d4b RS |
476 | @end deffn |
477 | ||
478 | @deffn Command self-insert-command count | |
479 | @cindex character insertion | |
480 | @cindex self-insertion | |
61cfa852 RS |
481 | This command inserts the last character typed; it does so @var{count} |
482 | times, before point, and returns @code{nil}. Most printing characters | |
483 | are bound to this command. In routine use, @code{self-insert-command} | |
484 | is the most frequently called function in Emacs, but programs rarely use | |
485 | it except to install it on a keymap. | |
73804d4b RS |
486 | |
487 | In an interactive call, @var{count} is the numeric prefix argument. | |
488 | ||
1412ac47 RS |
489 | Self-insertion translates the input character through |
490 | @code{translation-table-for-input}. @xref{Translation of Characters}. | |
491 | ||
22697dac | 492 | This command calls @code{auto-fill-function} whenever that is |
ca3be36e DL |
493 | non-@code{nil} and the character inserted is in the table |
494 | @code{auto-fill-chars} (@pxref{Auto Filling}). | |
73804d4b RS |
495 | |
496 | @c Cross refs reworded to prevent overfull hbox. --rjc 15mar92 | |
22697dac | 497 | This command performs abbrev expansion if Abbrev mode is enabled and |
73804d4b | 498 | the inserted character does not have word-constituent |
1412ac47 RS |
499 | syntax. (@xref{Abbrevs}, and @ref{Syntax Class Table}.) It is also |
500 | responsible for calling @code{blink-paren-function} when the inserted | |
501 | character has close parenthesis syntax (@pxref{Blinking}). | |
a40d4712 PR |
502 | |
503 | Do not try substituting your own definition of | |
504 | @code{self-insert-command} for the standard one. The editor command | |
505 | loop handles this function specially. | |
73804d4b RS |
506 | @end deffn |
507 | ||
177c0ea7 | 508 | @deffn Command newline &optional number-of-newlines |
73804d4b RS |
509 | This command inserts newlines into the current buffer before point. |
510 | If @var{number-of-newlines} is supplied, that many newline characters | |
511 | are inserted. | |
512 | ||
513 | @cindex newline and Auto Fill mode | |
61cfa852 RS |
514 | This function calls @code{auto-fill-function} if the current column |
515 | number is greater than the value of @code{fill-column} and | |
516 | @var{number-of-newlines} is @code{nil}. Typically what | |
517 | @code{auto-fill-function} does is insert a newline; thus, the overall | |
518 | result in this case is to insert two newlines at different places: one | |
519 | at point, and another earlier in the line. @code{newline} does not | |
520 | auto-fill if @var{number-of-newlines} is non-@code{nil}. | |
73804d4b | 521 | |
bfe721d1 KH |
522 | This command indents to the left margin if that is not zero. |
523 | @xref{Margins}. | |
524 | ||
73804d4b RS |
525 | The value returned is @code{nil}. In an interactive call, @var{count} |
526 | is the numeric prefix argument. | |
527 | @end deffn | |
528 | ||
529 | @deffn Command split-line | |
530 | This command splits the current line, moving the portion of the line | |
61cfa852 | 531 | after point down vertically so that it is on the next line directly |
73804d4b RS |
532 | below where it was before. Whitespace is inserted as needed at the |
533 | beginning of the lower line, using the @code{indent-to} function. | |
534 | @code{split-line} returns the position of point. | |
535 | ||
536 | Programs hardly ever use this function. | |
537 | @end deffn | |
538 | ||
539 | @defvar overwrite-mode | |
1911e6e5 RS |
540 | This variable controls whether overwrite mode is in effect. The value |
541 | should be @code{overwrite-mode-textual}, @code{overwrite-mode-binary}, | |
542 | or @code{nil}. @code{overwrite-mode-textual} specifies textual | |
543 | overwrite mode (treats newlines and tabs specially), and | |
544 | @code{overwrite-mode-binary} specifies binary overwrite mode (treats | |
545 | newlines and tabs like any other characters). | |
73804d4b RS |
546 | @end defvar |
547 | ||
548 | @node Deletion | |
bfe721d1 | 549 | @section Deleting Text |
73804d4b RS |
550 | |
551 | @cindex deletion vs killing | |
552 | Deletion means removing part of the text in a buffer, without saving | |
553 | it in the kill ring (@pxref{The Kill Ring}). Deleted text can't be | |
554 | yanked, but can be reinserted using the undo mechanism (@pxref{Undo}). | |
61cfa852 RS |
555 | Some deletion functions do save text in the kill ring in some special |
556 | cases. | |
73804d4b | 557 | |
af1996b5 | 558 | All of the deletion functions operate on the current buffer. |
73804d4b | 559 | |
1911e6e5 | 560 | @deffn Command erase-buffer |
af1996b5 LT |
561 | This function deletes the entire text of the current buffer |
562 | (@emph{not} just the accessible portion), leaving it | |
73804d4b | 563 | empty. If the buffer is read-only, it signals a @code{buffer-read-only} |
2468d0c0 DL |
564 | error; if some of the text in it is read-only, it signals a |
565 | @code{text-read-only} error. Otherwise, it deletes the text without | |
566 | asking for any confirmation. It returns @code{nil}. | |
8241495d | 567 | |
73804d4b | 568 | Normally, deleting a large amount of text from a buffer inhibits further |
13cad738 | 569 | auto-saving of that buffer ``because it has shrunk.'' However, |
73804d4b RS |
570 | @code{erase-buffer} does not do this, the idea being that the future |
571 | text is not really related to the former text, and its size should not | |
572 | be compared with that of the former text. | |
1911e6e5 | 573 | @end deffn |
73804d4b RS |
574 | |
575 | @deffn Command delete-region start end | |
1dffc5db RS |
576 | This command deletes the text between positions @var{start} and |
577 | @var{end} in the current buffer, and returns @code{nil}. If point was | |
578 | inside the deleted region, its value afterward is @var{start}. | |
68002b5f | 579 | Otherwise, point relocates with the surrounding text, as markers do. |
73804d4b RS |
580 | @end deffn |
581 | ||
1dffc5db | 582 | @defun delete-and-extract-region start end |
1dffc5db RS |
583 | This function deletes the text between positions @var{start} and |
584 | @var{end} in the current buffer, and returns a string containing the | |
585 | text just deleted. | |
586 | ||
587 | If point was inside the deleted region, its value afterward is | |
588 | @var{start}. Otherwise, point relocates with the surrounding text, as | |
589 | markers do. | |
590 | @end defun | |
591 | ||
73804d4b RS |
592 | @deffn Command delete-char count &optional killp |
593 | This command deletes @var{count} characters directly after point, or | |
594 | before point if @var{count} is negative. If @var{killp} is | |
595 | non-@code{nil}, then it saves the deleted characters in the kill ring. | |
596 | ||
597 | In an interactive call, @var{count} is the numeric prefix argument, and | |
598 | @var{killp} is the unprocessed prefix argument. Therefore, if a prefix | |
599 | argument is supplied, the text is saved in the kill ring. If no prefix | |
600 | argument is supplied, then one character is deleted, but not saved in | |
601 | the kill ring. | |
602 | ||
603 | The value returned is always @code{nil}. | |
604 | @end deffn | |
605 | ||
606 | @deffn Command delete-backward-char count &optional killp | |
607 | @cindex delete previous char | |
608 | This command deletes @var{count} characters directly before point, or | |
609 | after point if @var{count} is negative. If @var{killp} is | |
610 | non-@code{nil}, then it saves the deleted characters in the kill ring. | |
611 | ||
612 | In an interactive call, @var{count} is the numeric prefix argument, and | |
613 | @var{killp} is the unprocessed prefix argument. Therefore, if a prefix | |
614 | argument is supplied, the text is saved in the kill ring. If no prefix | |
615 | argument is supplied, then one character is deleted, but not saved in | |
616 | the kill ring. | |
617 | ||
618 | The value returned is always @code{nil}. | |
619 | @end deffn | |
620 | ||
621 | @deffn Command backward-delete-char-untabify count &optional killp | |
622 | @cindex tab deletion | |
623 | This command deletes @var{count} characters backward, changing tabs | |
624 | into spaces. When the next character to be deleted is a tab, it is | |
625 | first replaced with the proper number of spaces to preserve alignment | |
626 | and then one of those spaces is deleted instead of the tab. If | |
627 | @var{killp} is non-@code{nil}, then the command saves the deleted | |
628 | characters in the kill ring. | |
629 | ||
630 | Conversion of tabs to spaces happens only if @var{count} is positive. | |
631 | If it is negative, exactly @minus{}@var{count} characters after point | |
632 | are deleted. | |
633 | ||
634 | In an interactive call, @var{count} is the numeric prefix argument, and | |
635 | @var{killp} is the unprocessed prefix argument. Therefore, if a prefix | |
636 | argument is supplied, the text is saved in the kill ring. If no prefix | |
637 | argument is supplied, then one character is deleted, but not saved in | |
638 | the kill ring. | |
639 | ||
640 | The value returned is always @code{nil}. | |
641 | @end deffn | |
642 | ||
969fe9b5 RS |
643 | @defopt backward-delete-char-untabify-method |
644 | This option specifies how @code{backward-delete-char-untabify} should | |
645 | deal with whitespace. Possible values include @code{untabify}, the | |
646 | default, meaning convert a tab to many spaces and delete one; | |
af1996b5 LT |
647 | @code{hungry}, meaning delete all tabs and spaces before point with |
648 | one command; @code{all} meaning delete all tabs, spaces and newlines | |
649 | before point, and @code{nil}, meaning do nothing special for | |
969fe9b5 RS |
650 | whitespace characters. |
651 | @end defopt | |
652 | ||
73804d4b RS |
653 | @node User-Level Deletion |
654 | @section User-Level Deletion Commands | |
655 | ||
656 | This section describes higher-level commands for deleting text, | |
657 | commands intended primarily for the user but useful also in Lisp | |
658 | programs. | |
659 | ||
af1996b5 | 660 | @deffn Command delete-horizontal-space &optional backward-only |
73804d4b RS |
661 | @cindex deleting whitespace |
662 | This function deletes all spaces and tabs around point. It returns | |
663 | @code{nil}. | |
664 | ||
af1996b5 LT |
665 | If @var{backward-only} is non-@code{nil}, the function deletes |
666 | spaces and tabs before point, but not after point. | |
667 | ||
73804d4b RS |
668 | In the following examples, we call @code{delete-horizontal-space} four |
669 | times, once on each line, with point between the second and third | |
61cfa852 | 670 | characters on the line each time. |
73804d4b RS |
671 | |
672 | @example | |
673 | @group | |
674 | ---------- Buffer: foo ---------- | |
675 | I @point{}thought | |
676 | I @point{} thought | |
677 | We@point{} thought | |
678 | Yo@point{}u thought | |
679 | ---------- Buffer: foo ---------- | |
680 | @end group | |
681 | ||
682 | @group | |
683 | (delete-horizontal-space) ; @r{Four times.} | |
684 | @result{} nil | |
685 | ||
686 | ---------- Buffer: foo ---------- | |
687 | Ithought | |
688 | Ithought | |
689 | Wethought | |
690 | You thought | |
691 | ---------- Buffer: foo ---------- | |
692 | @end group | |
693 | @end example | |
694 | @end deffn | |
695 | ||
177c0ea7 | 696 | @deffn Command delete-indentation &optional join-following-p |
73804d4b RS |
697 | This function joins the line point is on to the previous line, deleting |
698 | any whitespace at the join and in some cases replacing it with one | |
699 | space. If @var{join-following-p} is non-@code{nil}, | |
700 | @code{delete-indentation} joins this line to the following line | |
a9f0a989 | 701 | instead. The function returns @code{nil}. |
73804d4b RS |
702 | |
703 | If there is a fill prefix, and the second of the lines being joined | |
704 | starts with the prefix, then @code{delete-indentation} deletes the | |
bfe721d1 | 705 | fill prefix before joining the lines. @xref{Margins}. |
73804d4b RS |
706 | |
707 | In the example below, point is located on the line starting | |
708 | @samp{events}, and it makes no difference if there are trailing spaces | |
709 | in the preceding line. | |
710 | ||
711 | @smallexample | |
b22f3a19 | 712 | @group |
73804d4b RS |
713 | ---------- Buffer: foo ---------- |
714 | When in the course of human | |
715 | @point{} events, it becomes necessary | |
716 | ---------- Buffer: foo ---------- | |
b22f3a19 | 717 | @end group |
73804d4b RS |
718 | |
719 | (delete-indentation) | |
720 | @result{} nil | |
721 | ||
b22f3a19 | 722 | @group |
73804d4b RS |
723 | ---------- Buffer: foo ---------- |
724 | When in the course of human@point{} events, it becomes necessary | |
725 | ---------- Buffer: foo ---------- | |
b22f3a19 | 726 | @end group |
73804d4b RS |
727 | @end smallexample |
728 | ||
729 | After the lines are joined, the function @code{fixup-whitespace} is | |
730 | responsible for deciding whether to leave a space at the junction. | |
731 | @end deffn | |
732 | ||
af1996b5 LT |
733 | @deffn Command fixup-whitespace |
734 | This function replaces all the horizontal whitespace surrounding point | |
735 | with either one space or no space, according to the context. It | |
736 | returns @code{nil}. | |
73804d4b RS |
737 | |
738 | At the beginning or end of a line, the appropriate amount of space is | |
739 | none. Before a character with close parenthesis syntax, or after a | |
740 | character with open parenthesis or expression-prefix syntax, no space is | |
741 | also appropriate. Otherwise, one space is appropriate. @xref{Syntax | |
742 | Class Table}. | |
743 | ||
744 | In the example below, @code{fixup-whitespace} is called the first time | |
61cfa852 RS |
745 | with point before the word @samp{spaces} in the first line. For the |
746 | second invocation, point is directly after the @samp{(}. | |
73804d4b RS |
747 | |
748 | @smallexample | |
749 | @group | |
750 | ---------- Buffer: foo ---------- | |
751 | This has too many @point{}spaces | |
752 | This has too many spaces at the start of (@point{} this list) | |
753 | ---------- Buffer: foo ---------- | |
754 | @end group | |
755 | ||
756 | @group | |
757 | (fixup-whitespace) | |
758 | @result{} nil | |
759 | (fixup-whitespace) | |
760 | @result{} nil | |
761 | @end group | |
762 | ||
763 | @group | |
764 | ---------- Buffer: foo ---------- | |
765 | This has too many spaces | |
766 | This has too many spaces at the start of (this list) | |
767 | ---------- Buffer: foo ---------- | |
768 | @end group | |
769 | @end smallexample | |
af1996b5 | 770 | @end deffn |
73804d4b | 771 | |
b471b8e9 | 772 | @deffn Command just-one-space &optional n |
73804d4b RS |
773 | @comment !!SourceFile simple.el |
774 | This command replaces any spaces and tabs around point with a single | |
b471b8e9 RS |
775 | space, or @var{n} spaces if @var{n} is specified. It returns |
776 | @code{nil}. | |
73804d4b RS |
777 | @end deffn |
778 | ||
779 | @deffn Command delete-blank-lines | |
780 | This function deletes blank lines surrounding point. If point is on a | |
781 | blank line with one or more blank lines before or after it, then all but | |
782 | one of them are deleted. If point is on an isolated blank line, then it | |
783 | is deleted. If point is on a nonblank line, the command deletes all | |
af1996b5 | 784 | blank lines immediately following it. |
73804d4b RS |
785 | |
786 | A blank line is defined as a line containing only tabs and spaces. | |
787 | ||
788 | @code{delete-blank-lines} returns @code{nil}. | |
789 | @end deffn | |
790 | ||
791 | @node The Kill Ring | |
792 | @section The Kill Ring | |
793 | @cindex kill ring | |
794 | ||
969fe9b5 | 795 | @dfn{Kill functions} delete text like the deletion functions, but save |
73804d4b RS |
796 | it so that the user can reinsert it by @dfn{yanking}. Most of these |
797 | functions have @samp{kill-} in their name. By contrast, the functions | |
798 | whose names start with @samp{delete-} normally do not save text for | |
799 | yanking (though they can still be undone); these are ``deletion'' | |
800 | functions. | |
801 | ||
802 | Most of the kill commands are primarily for interactive use, and are | |
803 | not described here. What we do describe are the functions provided for | |
804 | use in writing such commands. You can use these functions to write | |
61cfa852 | 805 | commands for killing text. When you need to delete text for internal |
73804d4b RS |
806 | purposes within a Lisp function, you should normally use deletion |
807 | functions, so as not to disturb the kill ring contents. | |
808 | @xref{Deletion}. | |
809 | ||
810 | Killed text is saved for later yanking in the @dfn{kill ring}. This | |
61cfa852 RS |
811 | is a list that holds a number of recent kills, not just the last text |
812 | kill. We call this a ``ring'' because yanking treats it as having | |
813 | elements in a cyclic order. The list is kept in the variable | |
814 | @code{kill-ring}, and can be operated on with the usual functions for | |
815 | lists; there are also specialized functions, described in this section, | |
816 | that treat it as a ring. | |
73804d4b RS |
817 | |
818 | Some people think this use of the word ``kill'' is unfortunate, since | |
61cfa852 | 819 | it refers to operations that specifically @emph{do not} destroy the |
13cad738 | 820 | entities ``killed.'' This is in sharp contrast to ordinary life, in |
73804d4b RS |
821 | which death is permanent and ``killed'' entities do not come back to |
822 | life. Therefore, other metaphors have been proposed. For example, the | |
823 | term ``cut ring'' makes sense to people who, in pre-computer days, used | |
824 | scissors and paste to cut up and rearrange manuscripts. However, it | |
825 | would be difficult to change the terminology now. | |
826 | ||
827 | @menu | |
828 | * Kill Ring Concepts:: What text looks like in the kill ring. | |
829 | * Kill Functions:: Functions that kill text. | |
d73eac4d | 830 | * Yanking:: How yanking is done. |
73804d4b | 831 | * Yank Commands:: Commands that access the kill ring. |
61cfa852 | 832 | * Low-Level Kill Ring:: Functions and variables for kill ring access. |
af1996b5 | 833 | * Internals of Kill Ring:: Variables that hold kill ring data. |
73804d4b RS |
834 | @end menu |
835 | ||
836 | @node Kill Ring Concepts | |
837 | @comment node-name, next, previous, up | |
838 | @subsection Kill Ring Concepts | |
839 | ||
840 | The kill ring records killed text as strings in a list, most recent | |
841 | first. A short kill ring, for example, might look like this: | |
842 | ||
843 | @example | |
844 | ("some text" "a different piece of text" "even older text") | |
845 | @end example | |
846 | ||
847 | @noindent | |
848 | When the list reaches @code{kill-ring-max} entries in length, adding a | |
849 | new entry automatically deletes the last entry. | |
850 | ||
851 | When kill commands are interwoven with other commands, each kill | |
852 | command makes a new entry in the kill ring. Multiple kill commands in | |
af1996b5 | 853 | succession build up a single kill ring entry, which would be yanked as a |
a9f0a989 RS |
854 | unit; the second and subsequent consecutive kill commands add text to |
855 | the entry made by the first one. | |
73804d4b RS |
856 | |
857 | For yanking, one entry in the kill ring is designated the ``front'' of | |
858 | the ring. Some yank commands ``rotate'' the ring by designating a | |
859 | different element as the ``front.'' But this virtual rotation doesn't | |
860 | change the list itself---the most recent entry always comes first in the | |
861 | list. | |
862 | ||
863 | @node Kill Functions | |
864 | @comment node-name, next, previous, up | |
865 | @subsection Functions for Killing | |
866 | ||
867 | @code{kill-region} is the usual subroutine for killing text. Any | |
868 | command that calls this function is a ``kill command'' (and should | |
869 | probably have @samp{kill} in its name). @code{kill-region} puts the | |
870 | newly killed text in a new element at the beginning of the kill ring or | |
f9f59935 RS |
871 | adds it to the most recent element. It determines automatically (using |
872 | @code{last-command}) whether the previous command was a kill command, | |
61cfa852 | 873 | and if so appends the killed text to the most recent entry. |
73804d4b | 874 | |
d73eac4d | 875 | @deffn Command kill-region start end &optional yank-handler |
73804d4b | 876 | This function kills the text in the region defined by @var{start} and |
bfe721d1 KH |
877 | @var{end}. The text is deleted but saved in the kill ring, along with |
878 | its text properties. The value is always @code{nil}. | |
73804d4b RS |
879 | |
880 | In an interactive call, @var{start} and @var{end} are point and | |
881 | the mark. | |
882 | ||
883 | @c Emacs 19 feature | |
2468d0c0 DL |
884 | If the buffer or text is read-only, @code{kill-region} modifies the kill |
885 | ring just the same, then signals an error without modifying the buffer. | |
886 | This is convenient because it lets the user use a series of kill | |
887 | commands to copy text from a read-only buffer into the kill ring. | |
d73eac4d RS |
888 | |
889 | If @var{yank-handler} is non-@code{nil}, this puts that value onto | |
af1996b5 LT |
890 | the string of killed text, as a @code{yank-handler} text property. |
891 | @xref{Yanking}. Note that if @var{yank-handler} is @code{nil}, any | |
892 | @code{yank-handler} properties present on the killed text are copied | |
893 | onto the kill ring, like other text properties. | |
73804d4b RS |
894 | @end deffn |
895 | ||
1911e6e5 | 896 | @defopt kill-read-only-ok |
2468d0c0 DL |
897 | If this option is non-@code{nil}, @code{kill-region} does not signal an |
898 | error if the buffer or text is read-only. Instead, it simply returns, | |
899 | updating the kill ring but not changing the buffer. | |
1911e6e5 RS |
900 | @end defopt |
901 | ||
73804d4b RS |
902 | @deffn Command copy-region-as-kill start end |
903 | This command saves the region defined by @var{start} and @var{end} on | |
bfe721d1 | 904 | the kill ring (including text properties), but does not delete the text |
af1996b5 | 905 | from the buffer. It returns @code{nil}. |
73804d4b | 906 | |
22697dac KH |
907 | The command does not set @code{this-command} to @code{kill-region}, so a |
908 | subsequent kill command does not append to the same kill ring entry. | |
909 | ||
73804d4b | 910 | Don't call @code{copy-region-as-kill} in Lisp programs unless you aim to |
f9f59935 RS |
911 | support Emacs 18. For newer Emacs versions, it is better to use |
912 | @code{kill-new} or @code{kill-append} instead. @xref{Low-Level Kill | |
913 | Ring}. | |
73804d4b RS |
914 | @end deffn |
915 | ||
d73eac4d RS |
916 | @node Yanking |
917 | @subsection Yanking | |
918 | ||
919 | Yanking means inserting text from the kill ring, but it does | |
920 | not insert the text blindly. Yank commands and some other commands | |
921 | use @code{insert-for-yank} to perform special processing on the | |
922 | text that they copy into the buffer. | |
923 | ||
924 | @defun insert-for-yank string | |
925 | This function normally works like @code{insert} except that it doesn't | |
926 | insert the text properties in the @code{yank-excluded-properties} | |
af1996b5 LT |
927 | list. However, if any part of @var{string} has a non-@code{nil} |
928 | @code{yank-handler} text property, that property can do various | |
929 | special processing on that part of the text being inserted. | |
d73eac4d RS |
930 | @end defun |
931 | ||
932 | @defun insert-buffer-substring-as-yank buf &optional start end | |
933 | This function resembles @code{insert-buffer-substring} except that it | |
934 | doesn't insert the text properties in the | |
935 | @code{yank-excluded-properties} list. | |
936 | @end defun | |
937 | ||
af1996b5 LT |
938 | You can put a @code{yank-handler} text property on all or part of |
939 | the text to control how it will be inserted if it is yanked. The | |
940 | @code{insert-for-yank} function looks for that property. The property | |
941 | value must be a list of one to four elements, with the following | |
942 | format (where elements after the first may be omitted): | |
d73eac4d RS |
943 | |
944 | @example | |
945 | (@var{function} @var{param} @var{noexclude} @var{undo}) | |
946 | @end example | |
947 | ||
948 | Here is what the elements do: | |
949 | ||
950 | @table @var | |
951 | @item function | |
af1996b5 | 952 | When @var{function} is present and non-@code{nil}, it is called instead of |
d73eac4d RS |
953 | @code{insert} to insert the string. @var{function} takes one |
954 | argument---the string to insert. | |
955 | ||
956 | @item param | |
957 | If @var{param} is present and non-@code{nil}, it replaces @var{string} | |
af1996b5 LT |
958 | (or the part of @var{string} being processed) as the object passed to |
959 | @var{function} (or @code{insert}); for example, if @var{function} is | |
960 | @code{yank-rectangle}, @var{param} should be a list of strings to | |
961 | insert as a rectangle. | |
d73eac4d RS |
962 | |
963 | @item noexclude | |
964 | If @var{noexclude} is present and non-@code{nil}, the normal removal of the | |
965 | yank-excluded-properties is not performed; instead @var{function} is | |
966 | responsible for removing those properties. This may be necessary | |
967 | if @var{function} adjusts point before or after inserting the object. | |
968 | ||
969 | @item undo | |
af1996b5 | 970 | If @var{undo} is present and non-@code{nil}, it is a function that will be |
d73eac4d RS |
971 | called by @code{yank-pop} to undo the insertion of the current object. |
972 | It is called with two arguments, the start and end of the current | |
973 | region. @var{function} can set @code{yank-undo-function} to override | |
974 | the @var{undo} value. | |
975 | @end table | |
976 | ||
73804d4b RS |
977 | @node Yank Commands |
978 | @comment node-name, next, previous, up | |
979 | @subsection Functions for Yanking | |
980 | ||
981 | @dfn{Yanking} means reinserting an entry of previously killed text | |
bfe721d1 | 982 | from the kill ring. The text properties are copied too. |
73804d4b RS |
983 | |
984 | @deffn Command yank &optional arg | |
985 | @cindex inserting killed text | |
af1996b5 | 986 | This command inserts before point the text at the front of the |
73804d4b RS |
987 | kill ring. It positions the mark at the beginning of that text, and |
988 | point at the end. | |
989 | ||
af1996b5 LT |
990 | If @var{arg} is a non-@code{nil} list (which occurs interactively when |
991 | the user types @kbd{C-u} with no digits), then @code{yank} inserts the | |
992 | text as described above, but puts point before the yanked text and | |
993 | puts the mark after it. | |
73804d4b | 994 | |
af1996b5 LT |
995 | If @var{arg} is a number, then @code{yank} inserts the @var{arg}th |
996 | most recently killed text---the @var{arg}th element of the kill ring | |
997 | list, counted cyclically from the front, which is considered the | |
998 | first element for this purpose. | |
73804d4b | 999 | |
af1996b5 LT |
1000 | @code{yank} does not alter the contents of the kill ring, unless it |
1001 | used text provided by another program, in which case it pushes that text | |
1002 | onto the kill ring. However if @var{arg} is an integer different from | |
1003 | one, it rotates the kill ring to place the yanked string at the front. | |
1004 | ||
1005 | @code{yank} returns @code{nil}. | |
73804d4b RS |
1006 | @end deffn |
1007 | ||
af1996b5 | 1008 | @deffn Command yank-pop &optional arg |
73804d4b RS |
1009 | This command replaces the just-yanked entry from the kill ring with a |
1010 | different entry from the kill ring. | |
1011 | ||
1012 | This is allowed only immediately after a @code{yank} or another | |
1013 | @code{yank-pop}. At such a time, the region contains text that was just | |
1014 | inserted by yanking. @code{yank-pop} deletes that text and inserts in | |
1015 | its place a different piece of killed text. It does not add the deleted | |
1016 | text to the kill ring, since it is already in the kill ring somewhere. | |
af1996b5 LT |
1017 | It does however rotate the kill ring to place the newly yanked string at |
1018 | the front. | |
73804d4b RS |
1019 | |
1020 | If @var{arg} is @code{nil}, then the replacement text is the previous | |
1021 | element of the kill ring. If @var{arg} is numeric, the replacement is | |
1022 | the @var{arg}th previous kill. If @var{arg} is negative, a more recent | |
1023 | kill is the replacement. | |
1024 | ||
1025 | The sequence of kills in the kill ring wraps around, so that after the | |
1026 | oldest one comes the newest one, and before the newest one goes the | |
1027 | oldest. | |
1028 | ||
a9f0a989 | 1029 | The return value is always @code{nil}. |
73804d4b RS |
1030 | @end deffn |
1031 | ||
d73eac4d RS |
1032 | @defvar yank-undo-function |
1033 | If this variable is non-@code{nil}, the function @code{yank-pop} uses | |
1034 | its value instead of @code{delete-region} to delete the text | |
1035 | inserted by the previous @code{yank} or | |
af1996b5 LT |
1036 | @code{yank-pop} command. The value must be a function of two |
1037 | arguments, the start and end of the current region. | |
d73eac4d RS |
1038 | |
1039 | The function @code{insert-for-yank} automatically sets this variable | |
1040 | according to the @var{undo} element of the @code{yank-handler} | |
1041 | text property, if there is one. | |
1042 | @end defvar | |
1043 | ||
61cfa852 RS |
1044 | @node Low-Level Kill Ring |
1045 | @subsection Low-Level Kill Ring | |
73804d4b | 1046 | |
969fe9b5 RS |
1047 | These functions and variables provide access to the kill ring at a |
1048 | lower level, but still convenient for use in Lisp programs, because they | |
1049 | take care of interaction with window system selections | |
1050 | (@pxref{Window System Selections}). | |
73804d4b RS |
1051 | |
1052 | @defun current-kill n &optional do-not-move | |
a9f0a989 RS |
1053 | The function @code{current-kill} rotates the yanking pointer, which |
1054 | designates the ``front'' of the kill ring, by @var{n} places (from newer | |
61cfa852 | 1055 | kills to older ones), and returns the text at that place in the ring. |
73804d4b RS |
1056 | |
1057 | If the optional second argument @var{do-not-move} is non-@code{nil}, | |
1058 | then @code{current-kill} doesn't alter the yanking pointer; it just | |
61cfa852 | 1059 | returns the @var{n}th kill, counting from the current yanking pointer. |
73804d4b RS |
1060 | |
1061 | If @var{n} is zero, indicating a request for the latest kill, | |
1062 | @code{current-kill} calls the value of | |
af1996b5 LT |
1063 | @code{interprogram-paste-function} (documented below) before |
1064 | consulting the kill ring. If that value is a function and calling it | |
1065 | returns a string, @code{current-kill} pushes that string onto the kill | |
1066 | ring and returns it. It also sets the yanking pointer to point to | |
1067 | that new entry, regardless of the value of @var{do-not-move}. | |
1068 | Otherwise, @code{current-kill} does not treat a zero value for @var{n} | |
1069 | specially: it returns the entry pointed at by the yanking pointer and | |
1070 | does not move the yanking pointer. | |
1071 | @end defun | |
1072 | ||
1073 | @defun kill-new string &optional replace yank-handler | |
1074 | This function pushes the text @var{string} onto the kill ring and | |
1075 | makes the yanking pointer point to it. It discards the oldest entry | |
1076 | if appropriate. It also invokes the value of | |
73804d4b | 1077 | @code{interprogram-cut-function} (see below). |
d73eac4d | 1078 | |
af1996b5 LT |
1079 | If @var{replace} is non-@code{nil}, then @code{kill-new} replaces the |
1080 | first element of the kill ring with @var{string}, rather than pushing | |
1081 | @var{string} onto the kill ring. | |
1082 | ||
d73eac4d RS |
1083 | If @var{yank-handler} is non-@code{nil}, this puts that value onto |
1084 | the string of killed text, as a @code{yank-handler} property. | |
af1996b5 LT |
1085 | @xref{Yanking}. Note that if @var{yank-handler} is @code{nil}, then |
1086 | @code{kill-new} copies any @code{yank-handler} properties present on | |
1087 | @var{string} onto the kill ring, as it does with other text properties. | |
73804d4b RS |
1088 | @end defun |
1089 | ||
d73eac4d | 1090 | @defun kill-append string before-p &optional yank-handler |
73804d4b | 1091 | This function appends the text @var{string} to the first entry in the |
af1996b5 LT |
1092 | kill ring and makes the yanking pointer point to the combined entry. |
1093 | Normally @var{string} goes at the end of the entry, but if | |
73804d4b | 1094 | @var{before-p} is non-@code{nil}, it goes at the beginning. This |
af1996b5 LT |
1095 | function also invokes the value of @code{interprogram-cut-function} |
1096 | (see below). This handles @var{yank-handler} just like | |
1097 | @code{kill-new}, except that if @var{yank-handler} is different from | |
1098 | the @code{yank-handler} property of the first entry of the kill ring, | |
1099 | @code{kill-append} pushes the concatenated string onto the kill ring, | |
1100 | instead of replacing the original first entry with it. | |
73804d4b RS |
1101 | @end defun |
1102 | ||
1103 | @defvar interprogram-paste-function | |
1104 | This variable provides a way of transferring killed text from other | |
1105 | programs, when you are using a window system. Its value should be | |
1106 | @code{nil} or a function of no arguments. | |
1107 | ||
1108 | If the value is a function, @code{current-kill} calls it to get the | |
13cad738 RS |
1109 | ``most recent kill.'' If the function returns a non-@code{nil} value, |
1110 | then that value is used as the ``most recent kill.'' If it returns | |
af1996b5 | 1111 | @code{nil}, then the front of the kill ring is used. |
73804d4b | 1112 | |
969fe9b5 RS |
1113 | The normal use of this hook is to get the window system's primary |
1114 | selection as the most recent kill, even if the selection belongs to | |
1115 | another application. @xref{Window System Selections}. | |
73804d4b RS |
1116 | @end defvar |
1117 | ||
1118 | @defvar interprogram-cut-function | |
61cfa852 RS |
1119 | This variable provides a way of communicating killed text to other |
1120 | programs, when you are using a window system. Its value should be | |
af1996b5 | 1121 | @code{nil} or a function of one required and one optional argument. |
73804d4b RS |
1122 | |
1123 | If the value is a function, @code{kill-new} and @code{kill-append} call | |
af1996b5 LT |
1124 | it with the new first element of the kill ring as the first argument. |
1125 | The second, optional, argument has the same meaning as the @var{push} | |
1126 | argument to @code{x-set-cut-buffer} (@pxref{Definition of | |
1127 | x-set-cut-buffer}) and only affects the second and later cut buffers. | |
73804d4b | 1128 | |
969fe9b5 | 1129 | The normal use of this hook is to set the window system's primary |
af1996b5 LT |
1130 | selection (and first cut buffer) from the newly killed text. |
1131 | @xref{Window System Selections}. | |
73804d4b RS |
1132 | @end defvar |
1133 | ||
1134 | @node Internals of Kill Ring | |
1135 | @comment node-name, next, previous, up | |
1136 | @subsection Internals of the Kill Ring | |
1137 | ||
1138 | The variable @code{kill-ring} holds the kill ring contents, in the | |
1139 | form of a list of strings. The most recent kill is always at the front | |
177c0ea7 | 1140 | of the list. |
73804d4b RS |
1141 | |
1142 | The @code{kill-ring-yank-pointer} variable points to a link in the | |
61cfa852 RS |
1143 | kill ring list, whose @sc{car} is the text to yank next. We say it |
1144 | identifies the ``front'' of the ring. Moving | |
73804d4b | 1145 | @code{kill-ring-yank-pointer} to a different link is called |
61cfa852 RS |
1146 | @dfn{rotating the kill ring}. We call the kill ring a ``ring'' because |
1147 | the functions that move the yank pointer wrap around from the end of the | |
1148 | list to the beginning, or vice-versa. Rotation of the kill ring is | |
1149 | virtual; it does not change the value of @code{kill-ring}. | |
73804d4b RS |
1150 | |
1151 | Both @code{kill-ring} and @code{kill-ring-yank-pointer} are Lisp | |
1152 | variables whose values are normally lists. The word ``pointer'' in the | |
1153 | name of the @code{kill-ring-yank-pointer} indicates that the variable's | |
1154 | purpose is to identify one element of the list for use by the next yank | |
1155 | command. | |
1156 | ||
1157 | The value of @code{kill-ring-yank-pointer} is always @code{eq} to one | |
1158 | of the links in the kill ring list. The element it identifies is the | |
1159 | @sc{car} of that link. Kill commands, which change the kill ring, also | |
61cfa852 RS |
1160 | set this variable to the value of @code{kill-ring}. The effect is to |
1161 | rotate the ring so that the newly killed text is at the front. | |
73804d4b RS |
1162 | |
1163 | Here is a diagram that shows the variable @code{kill-ring-yank-pointer} | |
1164 | pointing to the second entry in the kill ring @code{("some text" "a | |
177c0ea7 | 1165 | different piece of text" "yet older text")}. |
73804d4b RS |
1166 | |
1167 | @example | |
1168 | @group | |
969fe9b5 RS |
1169 | kill-ring ---- kill-ring-yank-pointer |
1170 | | | | |
1171 | | v | |
1172 | | --- --- --- --- --- --- | |
1173 | --> | | |------> | | |--> | | |--> nil | |
1174 | --- --- --- --- --- --- | |
177c0ea7 JB |
1175 | | | | |
1176 | | | | | |
1177 | | | -->"yet older text" | |
73804d4b | 1178 | | | |
177c0ea7 | 1179 | | --> "a different piece of text" |
73804d4b RS |
1180 | | |
1181 | --> "some text" | |
1182 | @end group | |
1183 | @end example | |
1184 | ||
1185 | @noindent | |
1186 | This state of affairs might occur after @kbd{C-y} (@code{yank}) | |
1187 | immediately followed by @kbd{M-y} (@code{yank-pop}). | |
1188 | ||
1189 | @defvar kill-ring | |
61cfa852 RS |
1190 | This variable holds the list of killed text sequences, most recently |
1191 | killed first. | |
73804d4b RS |
1192 | @end defvar |
1193 | ||
1194 | @defvar kill-ring-yank-pointer | |
1195 | This variable's value indicates which element of the kill ring is at the | |
1196 | ``front'' of the ring for yanking. More precisely, the value is a tail | |
1197 | of the value of @code{kill-ring}, and its @sc{car} is the kill string | |
1198 | that @kbd{C-y} should yank. | |
1199 | @end defvar | |
1200 | ||
1201 | @defopt kill-ring-max | |
1202 | The value of this variable is the maximum length to which the kill | |
1203 | ring can grow, before elements are thrown away at the end. The default | |
af1996b5 | 1204 | value for @code{kill-ring-max} is 60. |
73804d4b RS |
1205 | @end defopt |
1206 | ||
1207 | @node Undo | |
1208 | @comment node-name, next, previous, up | |
1209 | @section Undo | |
1210 | @cindex redo | |
1211 | ||
61cfa852 RS |
1212 | Most buffers have an @dfn{undo list}, which records all changes made |
1213 | to the buffer's text so that they can be undone. (The buffers that | |
1214 | don't have one are usually special-purpose buffers for which Emacs | |
1e094ef9 EZ |
1215 | assumes that undoing is not useful. In particular, any buffer whose |
1216 | name begins with a space has its undo recording off by default, | |
1217 | see @ref{Buffer Names}.) All the primitives that modify the | |
61cfa852 RS |
1218 | text in the buffer automatically add elements to the front of the undo |
1219 | list, which is in the variable @code{buffer-undo-list}. | |
73804d4b RS |
1220 | |
1221 | @defvar buffer-undo-list | |
475aab0d CY |
1222 | This buffer-local variable's value is the undo list of the current |
1223 | buffer. A value of @code{t} disables the recording of undo information. | |
73804d4b RS |
1224 | @end defvar |
1225 | ||
1226 | Here are the kinds of elements an undo list can have: | |
1227 | ||
1228 | @table @code | |
1911e6e5 RS |
1229 | @item @var{position} |
1230 | This kind of element records a previous value of point; undoing this | |
1231 | element moves point to @var{position}. Ordinary cursor motion does not | |
1232 | make any sort of undo record, but deletion operations use these entries | |
1233 | to record where point was before the command. | |
73804d4b RS |
1234 | |
1235 | @item (@var{beg} . @var{end}) | |
1236 | This kind of element indicates how to delete text that was inserted. | |
177c0ea7 | 1237 | Upon insertion, the text occupied the range @var{beg}--@var{end} in the |
73804d4b RS |
1238 | buffer. |
1239 | ||
d1756ab9 | 1240 | @item (@var{text} . @var{position}) |
73804d4b | 1241 | This kind of element indicates how to reinsert text that was deleted. |
d1756ab9 | 1242 | The deleted text itself is the string @var{text}. The place to |
af1996b5 LT |
1243 | reinsert it is @code{(abs @var{position})}. If @var{position} is |
1244 | positive, point was at the beginning of the deleted text, otherwise it | |
1245 | was at the end. | |
73804d4b RS |
1246 | |
1247 | @item (t @var{high} . @var{low}) | |
1248 | This kind of element indicates that an unmodified buffer became | |
1249 | modified. The elements @var{high} and @var{low} are two integers, each | |
1250 | recording 16 bits of the visited file's modification time as of when it | |
1251 | was previously visited or saved. @code{primitive-undo} uses those | |
1252 | values to determine whether to mark the buffer as unmodified once again; | |
1253 | it does so only if the file's modification time matches those numbers. | |
1254 | ||
1255 | @item (nil @var{property} @var{value} @var{beg} . @var{end}) | |
1256 | This kind of element records a change in a text property. | |
1257 | Here's how you might undo the change: | |
1258 | ||
1259 | @example | |
1260 | (put-text-property @var{beg} @var{end} @var{property} @var{value}) | |
1261 | @end example | |
d1756ab9 | 1262 | |
61ee3601 RS |
1263 | @item (@var{marker} . @var{adjustment}) |
1264 | This kind of element records the fact that the marker @var{marker} was | |
1265 | relocated due to deletion of surrounding text, and that it moved | |
1266 | @var{adjustment} character positions. Undoing this element moves | |
1267 | @var{marker} @minus{} @var{adjustment} characters. | |
1268 | ||
2abded2e RS |
1269 | @item (apply @var{funname} . @var{args}) |
1270 | This is an extensible undo item, which is undone by calling | |
1271 | @var{funname} with arguments @var{args}. | |
1272 | ||
1273 | @item (apply @var{delta} @var{beg} @var{end} @var{funname} . @var{args}) | |
1274 | This is an extensible undo item, which records a change limited to the | |
1275 | range @var{beg} to @var{end}, which increased the size of the buffer | |
1276 | by @var{delta}. It is undone by calling @var{funname} with arguments | |
1277 | @var{args}. | |
1278 | ||
1412ac47 RS |
1279 | This kind of element enables undo limited to a region to determine |
1280 | whether the element pertains to that region. | |
1281 | ||
73804d4b RS |
1282 | @item nil |
1283 | This element is a boundary. The elements between two boundaries are | |
1284 | called a @dfn{change group}; normally, each change group corresponds to | |
1285 | one keyboard command, and undo commands normally undo an entire group as | |
1286 | a unit. | |
1287 | @end table | |
1288 | ||
1289 | @defun undo-boundary | |
1290 | This function places a boundary element in the undo list. The undo | |
1291 | command stops at such a boundary, and successive undo commands undo | |
1292 | to earlier and earlier boundaries. This function returns @code{nil}. | |
1293 | ||
b6a786ce RS |
1294 | The editor command loop automatically creates an undo boundary before |
1295 | each key sequence is executed. Thus, each undo normally undoes the | |
1296 | effects of one command. Self-inserting input characters are an | |
1297 | exception. The command loop makes a boundary for the first such | |
1298 | character; the next 19 consecutive self-inserting input characters do | |
1299 | not make boundaries, and then the 20th does, and so on as long as | |
1300 | self-inserting characters continue. | |
1301 | ||
1302 | All buffer modifications add a boundary whenever the previous undoable | |
a9f0a989 RS |
1303 | change was made in some other buffer. This is to ensure that |
1304 | each command makes a boundary in each buffer where it makes changes. | |
b6a786ce RS |
1305 | |
1306 | Calling this function explicitly is useful for splitting the effects of | |
1307 | a command into more than one unit. For example, @code{query-replace} | |
1308 | calls @code{undo-boundary} after each replacement, so that the user can | |
1309 | undo individual replacements one by one. | |
73804d4b RS |
1310 | @end defun |
1311 | ||
0e29c77f RS |
1312 | @defvar undo-in-progress |
1313 | This variable is normally @code{nil}, but the undo commands bind it to | |
1314 | @code{t}. This is so that various kinds of change hooks can tell when | |
1315 | they're being called for the sake of undoing. | |
1316 | @end defvar | |
1317 | ||
73804d4b RS |
1318 | @defun primitive-undo count list |
1319 | This is the basic function for undoing elements of an undo list. | |
1320 | It undoes the first @var{count} elements of @var{list}, returning | |
1321 | the rest of @var{list}. You could write this function in Lisp, | |
1322 | but it is convenient to have it in C. | |
1323 | ||
1324 | @code{primitive-undo} adds elements to the buffer's undo list when it | |
1325 | changes the buffer. Undo commands avoid confusion by saving the undo | |
1326 | list value at the beginning of a sequence of undo operations. Then the | |
1327 | undo operations use and update the saved value. The new elements added | |
bfe721d1 | 1328 | by undoing are not part of this saved value, so they don't interfere with |
73804d4b | 1329 | continuing to undo. |
0e29c77f RS |
1330 | |
1331 | This function does not bind @code{undo-in-progress}. | |
73804d4b RS |
1332 | @end defun |
1333 | ||
1334 | @node Maintaining Undo | |
1335 | @section Maintaining Undo Lists | |
1336 | ||
1337 | This section describes how to enable and disable undo information for | |
1338 | a given buffer. It also explains how the undo list is truncated | |
1339 | automatically so it doesn't get too big. | |
1340 | ||
1341 | Recording of undo information in a newly created buffer is normally | |
1342 | enabled to start with; but if the buffer name starts with a space, the | |
1343 | undo recording is initially disabled. You can explicitly enable or | |
1344 | disable undo recording with the following two functions, or by setting | |
1345 | @code{buffer-undo-list} yourself. | |
1346 | ||
1347 | @deffn Command buffer-enable-undo &optional buffer-or-name | |
1348 | This command enables recording undo information for buffer | |
1349 | @var{buffer-or-name}, so that subsequent changes can be undone. If no | |
1350 | argument is supplied, then the current buffer is used. This function | |
1351 | does nothing if undo recording is already enabled in the buffer. It | |
1352 | returns @code{nil}. | |
1353 | ||
1354 | In an interactive call, @var{buffer-or-name} is the current buffer. | |
1355 | You cannot specify any other buffer. | |
1356 | @end deffn | |
1357 | ||
af1996b5 | 1358 | @deffn Command buffer-disable-undo &optional buffer-or-name |
73804d4b | 1359 | @cindex disable undo |
af1996b5 | 1360 | This function discards the undo list of @var{buffer-or-name}, and disables |
73804d4b RS |
1361 | further recording of undo information. As a result, it is no longer |
1362 | possible to undo either previous changes or any subsequent changes. If | |
af1996b5 | 1363 | the undo list of @var{buffer-or-name} is already disabled, this function |
73804d4b RS |
1364 | has no effect. |
1365 | ||
a9f0a989 | 1366 | This function returns @code{nil}. |
a9f0a989 | 1367 | @end deffn |
73804d4b RS |
1368 | |
1369 | As editing continues, undo lists get longer and longer. To prevent | |
1370 | them from using up all available memory space, garbage collection trims | |
1371 | them back to size limits you can set. (For this purpose, the ``size'' | |
1372 | of an undo list measures the cons cells that make up the list, plus the | |
578e484b LT |
1373 | strings of deleted text.) Three variables control the range of acceptable |
1374 | sizes: @code{undo-limit}, @code{undo-strong-limit} and | |
1375 | @code{undo-outer-limit}. | |
73804d4b | 1376 | |
578e484b | 1377 | @defopt undo-limit |
73804d4b RS |
1378 | This is the soft limit for the acceptable size of an undo list. The |
1379 | change group at which this size is exceeded is the last one kept. | |
578e484b | 1380 | @end defopt |
73804d4b | 1381 | |
578e484b | 1382 | @defopt undo-strong-limit |
61cfa852 RS |
1383 | This is the upper limit for the acceptable size of an undo list. The |
1384 | change group at which this size is exceeded is discarded itself (along | |
1385 | with all older change groups). There is one exception: the very latest | |
578e484b LT |
1386 | change group is only discarded if it exceeds @code{undo-outer-limit}. |
1387 | @end defopt | |
1388 | ||
1389 | @defopt undo-outer-limit | |
1390 | If at garbage collection time the undo info for the current command | |
b471b8e9 RS |
1391 | exceeds this limit, Emacs discards the info and displays a warning. |
1392 | This is a last ditch limit to prevent memory overflow. | |
578e484b | 1393 | @end defopt |
73804d4b RS |
1394 | |
1395 | @node Filling | |
1396 | @comment node-name, next, previous, up | |
1397 | @section Filling | |
1398 | @cindex filling, explicit | |
1399 | ||
1400 | @dfn{Filling} means adjusting the lengths of lines (by moving the line | |
1401 | breaks) so that they are nearly (but no greater than) a specified | |
1402 | maximum width. Additionally, lines can be @dfn{justified}, which means | |
bfe721d1 KH |
1403 | inserting spaces to make the left and/or right margins line up |
1404 | precisely. The width is controlled by the variable @code{fill-column}. | |
1405 | For ease of reading, lines should be no longer than 70 or so columns. | |
73804d4b RS |
1406 | |
1407 | You can use Auto Fill mode (@pxref{Auto Filling}) to fill text | |
1408 | automatically as you insert it, but changes to existing text may leave | |
1409 | it improperly filled. Then you must fill the text explicitly. | |
1410 | ||
22697dac KH |
1411 | Most of the commands in this section return values that are not |
1412 | meaningful. All the functions that do filling take note of the current | |
bfe721d1 KH |
1413 | left margin, current right margin, and current justification style |
1414 | (@pxref{Margins}). If the current justification style is | |
1415 | @code{none}, the filling functions don't actually do anything. | |
1416 | ||
1417 | Several of the filling functions have an argument @var{justify}. | |
1418 | If it is non-@code{nil}, that requests some kind of justification. It | |
1419 | can be @code{left}, @code{right}, @code{full}, or @code{center}, to | |
1420 | request a specific style of justification. If it is @code{t}, that | |
1421 | means to use the current justification style for this part of the text | |
969fe9b5 RS |
1422 | (see @code{current-justification}, below). Any other value is treated |
1423 | as @code{full}. | |
bfe721d1 KH |
1424 | |
1425 | When you call the filling functions interactively, using a prefix | |
1426 | argument implies the value @code{full} for @var{justify}. | |
73804d4b | 1427 | |
bfe721d1 | 1428 | @deffn Command fill-paragraph justify |
73804d4b RS |
1429 | @cindex filling a paragraph |
1430 | This command fills the paragraph at or after point. If | |
bfe721d1 | 1431 | @var{justify} is non-@code{nil}, each line is justified as well. |
73804d4b | 1432 | It uses the ordinary paragraph motion commands to find paragraph |
0b2fb045 | 1433 | boundaries. @xref{Paragraphs,,, emacs, The GNU Emacs Manual}. |
73804d4b RS |
1434 | @end deffn |
1435 | ||
15da7853 | 1436 | @deffn Command fill-region start end &optional justify nosqueeze to-eop |
73804d4b | 1437 | This command fills each of the paragraphs in the region from @var{start} |
bfe721d1 | 1438 | to @var{end}. It justifies as well if @var{justify} is |
73804d4b RS |
1439 | non-@code{nil}. |
1440 | ||
1911e6e5 RS |
1441 | If @var{nosqueeze} is non-@code{nil}, that means to leave whitespace |
1442 | other than line breaks untouched. If @var{to-eop} is non-@code{nil}, | |
ebc6903b | 1443 | that means to keep filling to the end of the paragraph---or the next hard |
1911e6e5 RS |
1444 | newline, if @code{use-hard-newlines} is enabled (see below). |
1445 | ||
73804d4b RS |
1446 | The variable @code{paragraph-separate} controls how to distinguish |
1447 | paragraphs. @xref{Standard Regexps}. | |
1448 | @end deffn | |
1449 | ||
2468d0c0 | 1450 | @deffn Command fill-individual-paragraphs start end &optional justify citation-regexp |
73804d4b RS |
1451 | This command fills each paragraph in the region according to its |
1452 | individual fill prefix. Thus, if the lines of a paragraph were indented | |
1453 | with spaces, the filled paragraph will remain indented in the same | |
1454 | fashion. | |
1455 | ||
1456 | The first two arguments, @var{start} and @var{end}, are the beginning | |
1457 | and end of the region to be filled. The third and fourth arguments, | |
2468d0c0 | 1458 | @var{justify} and @var{citation-regexp}, are optional. If |
bfe721d1 | 1459 | @var{justify} is non-@code{nil}, the paragraphs are justified as |
2468d0c0 | 1460 | well as filled. If @var{citation-regexp} is non-@code{nil}, it means the |
73804d4b | 1461 | function is operating on a mail message and therefore should not fill |
2468d0c0 DL |
1462 | the header lines. If @var{citation-regexp} is a string, it is used as |
1463 | a regular expression; if it matches the beginning of a line, that line | |
1464 | is treated as a citation marker. | |
73804d4b RS |
1465 | |
1466 | Ordinarily, @code{fill-individual-paragraphs} regards each change in | |
1467 | indentation as starting a new paragraph. If | |
1468 | @code{fill-individual-varying-indent} is non-@code{nil}, then only | |
61cfa852 RS |
1469 | separator lines separate paragraphs. That mode can handle indented |
1470 | paragraphs with additional indentation on the first line. | |
73804d4b RS |
1471 | @end deffn |
1472 | ||
1473 | @defopt fill-individual-varying-indent | |
1474 | This variable alters the action of @code{fill-individual-paragraphs} as | |
1475 | described above. | |
1476 | @end defopt | |
1477 | ||
1911e6e5 | 1478 | @deffn Command fill-region-as-paragraph start end &optional justify nosqueeze squeeze-after |
f9f59935 RS |
1479 | This command considers a region of text as a single paragraph and fills |
1480 | it. If the region was made up of many paragraphs, the blank lines | |
1481 | between paragraphs are removed. This function justifies as well as | |
1482 | filling when @var{justify} is non-@code{nil}. | |
22697dac KH |
1483 | |
1484 | In an interactive call, any prefix argument requests justification. | |
73804d4b | 1485 | |
1911e6e5 RS |
1486 | If @var{nosqueeze} is non-@code{nil}, that means to leave whitespace |
1487 | other than line breaks untouched. If @var{squeeze-after} is | |
ebc6903b | 1488 | non-@code{nil}, it specifies a position in the region, and means don't |
1911e6e5 RS |
1489 | canonicalize spaces before that position. |
1490 | ||
1491 | In Adaptive Fill mode, this command calls @code{fill-context-prefix} to | |
1492 | choose a fill prefix by default. @xref{Adaptive Fill}. | |
73804d4b RS |
1493 | @end deffn |
1494 | ||
2468d0c0 | 1495 | @deffn Command justify-current-line &optional how eop nosqueeze |
73804d4b RS |
1496 | This command inserts spaces between the words of the current line so |
1497 | that the line ends exactly at @code{fill-column}. It returns | |
1498 | @code{nil}. | |
22697dac KH |
1499 | |
1500 | The argument @var{how}, if non-@code{nil} specifies explicitly the style | |
1501 | of justification. It can be @code{left}, @code{right}, @code{full}, | |
1502 | @code{center}, or @code{none}. If it is @code{t}, that means to do | |
1503 | follow specified justification style (see @code{current-justification}, | |
1504 | below). @code{nil} means to do full justification. | |
1505 | ||
342fd6cd RS |
1506 | If @var{eop} is non-@code{nil}, that means do only left-justification |
1507 | if @code{current-justification} specifies full justification. This is | |
1508 | used for the last line of a paragraph; even if the paragraph as a | |
1509 | whole is fully justified, the last line should not be. | |
22697dac KH |
1510 | |
1511 | If @var{nosqueeze} is non-@code{nil}, that means do not change interior | |
1512 | whitespace. | |
73804d4b RS |
1513 | @end deffn |
1514 | ||
22697dac KH |
1515 | @defopt default-justification |
1516 | This variable's value specifies the style of justification to use for | |
1517 | text that doesn't specify a style with a text property. The possible | |
1518 | values are @code{left}, @code{right}, @code{full}, @code{center}, or | |
bfe721d1 | 1519 | @code{none}. The default value is @code{left}. |
22697dac KH |
1520 | @end defopt |
1521 | ||
1522 | @defun current-justification | |
1523 | This function returns the proper justification style to use for filling | |
1524 | the text around point. | |
1525 | @end defun | |
1526 | ||
1911e6e5 | 1527 | @defopt sentence-end-double-space |
6cae76c2 | 1528 | @anchor{Definition of sentence-end-double-space} |
1911e6e5 RS |
1529 | If this variable is non-@code{nil}, a period followed by just one space |
1530 | does not count as the end of a sentence, and the filling functions | |
1531 | avoid breaking the line at such a place. | |
1532 | @end defopt | |
1533 | ||
d69ea7ab RS |
1534 | @defopt sentence-end-without-period |
1535 | If this variable is non-@code{nil}, a sentence can end without a | |
1536 | period. This is used for languages like Thai, where sentences end | |
1537 | with a double space but without a period. | |
1538 | @end defopt | |
1539 | ||
1540 | @defopt sentence-end-without-space | |
1541 | If this variable is non-@code{nil}, it should be a string of | |
1542 | characters that can end a sentence without following spaces. | |
1543 | @end defopt | |
1544 | ||
bfe721d1 KH |
1545 | @defvar fill-paragraph-function |
1546 | This variable provides a way for major modes to override the filling of | |
1547 | paragraphs. If the value is non-@code{nil}, @code{fill-paragraph} calls | |
1548 | this function to do the work. If the function returns a non-@code{nil} | |
1549 | value, @code{fill-paragraph} assumes the job is done, and immediately | |
1550 | returns that value. | |
1551 | ||
1552 | The usual use of this feature is to fill comments in programming | |
1553 | language modes. If the function needs to fill a paragraph in the usual | |
1554 | way, it can do so as follows: | |
1555 | ||
1556 | @example | |
1557 | (let ((fill-paragraph-function nil)) | |
1558 | (fill-paragraph arg)) | |
1559 | @end example | |
1560 | @end defvar | |
1561 | ||
1562 | @defvar use-hard-newlines | |
1563 | If this variable is non-@code{nil}, the filling functions do not delete | |
1564 | newlines that have the @code{hard} text property. These ``hard | |
1565 | newlines'' act as paragraph separators. | |
1566 | @end defvar | |
1567 | ||
1568 | @node Margins | |
1569 | @section Margins for Filling | |
1570 | ||
61cfa852 | 1571 | @defopt fill-prefix |
a9f0a989 RS |
1572 | This buffer-local variable specifies a string of text that appears at |
1573 | the beginning | |
61cfa852 RS |
1574 | of normal text lines and should be disregarded when filling them. Any |
1575 | line that fails to start with the fill prefix is considered the start of | |
1576 | a paragraph; so is any line that starts with the fill prefix followed by | |
1577 | additional whitespace. Lines that start with the fill prefix but no | |
1578 | additional whitespace are ordinary text lines that can be filled | |
1579 | together. The resulting filled lines also start with the fill prefix. | |
bfe721d1 KH |
1580 | |
1581 | The fill prefix follows the left margin whitespace, if any. | |
61cfa852 RS |
1582 | @end defopt |
1583 | ||
1911e6e5 | 1584 | @defopt fill-column |
f9f59935 RS |
1585 | This buffer-local variable specifies the maximum width of filled lines. |
1586 | Its value should be an integer, which is a number of columns. All the | |
1587 | filling, justification, and centering commands are affected by this | |
1588 | variable, including Auto Fill mode (@pxref{Auto Filling}). | |
73804d4b RS |
1589 | |
1590 | As a practical matter, if you are writing text for other people to | |
1591 | read, you should set @code{fill-column} to no more than 70. Otherwise | |
1592 | the line will be too long for people to read comfortably, and this can | |
1593 | make the text seem clumsy. | |
1911e6e5 | 1594 | @end defopt |
73804d4b RS |
1595 | |
1596 | @defvar default-fill-column | |
1597 | The value of this variable is the default value for @code{fill-column} in | |
1598 | buffers that do not override it. This is the same as | |
1599 | @code{(default-value 'fill-column)}. | |
1600 | ||
1601 | The default value for @code{default-fill-column} is 70. | |
1602 | @end defvar | |
1603 | ||
22697dac KH |
1604 | @deffn Command set-left-margin from to margin |
1605 | This sets the @code{left-margin} property on the text from @var{from} to | |
1606 | @var{to} to the value @var{margin}. If Auto Fill mode is enabled, this | |
1607 | command also refills the region to fit the new margin. | |
1608 | @end deffn | |
1609 | ||
1610 | @deffn Command set-right-margin from to margin | |
bfe721d1 KH |
1611 | This sets the @code{right-margin} property on the text from @var{from} |
1612 | to @var{to} to the value @var{margin}. If Auto Fill mode is enabled, | |
1613 | this command also refills the region to fit the new margin. | |
22697dac KH |
1614 | @end deffn |
1615 | ||
1616 | @defun current-left-margin | |
1617 | This function returns the proper left margin value to use for filling | |
1618 | the text around point. The value is the sum of the @code{left-margin} | |
1619 | property of the character at the start of the current line (or zero if | |
bfe721d1 | 1620 | none), and the value of the variable @code{left-margin}. |
22697dac KH |
1621 | @end defun |
1622 | ||
1623 | @defun current-fill-column | |
1624 | This function returns the proper fill column value to use for filling | |
1625 | the text around point. The value is the value of the @code{fill-column} | |
1626 | variable, minus the value of the @code{right-margin} property of the | |
1627 | character after point. | |
1628 | @end defun | |
1629 | ||
1630 | @deffn Command move-to-left-margin &optional n force | |
1631 | This function moves point to the left margin of the current line. The | |
1632 | column moved to is determined by calling the function | |
bfe721d1 | 1633 | @code{current-left-margin}. If the argument @var{n} is non-@code{nil}, |
22697dac KH |
1634 | @code{move-to-left-margin} moves forward @var{n}@minus{}1 lines first. |
1635 | ||
1636 | If @var{force} is non-@code{nil}, that says to fix the line's | |
1637 | indentation if that doesn't match the left margin value. | |
1638 | @end deffn | |
1639 | ||
2468d0c0 DL |
1640 | @defun delete-to-left-margin &optional from to |
1641 | This function removes left margin indentation from the text between | |
1642 | @var{from} and @var{to}. The amount of indentation to delete is | |
1643 | determined by calling @code{current-left-margin}. In no case does this | |
1644 | function delete non-whitespace. If @var{from} and @var{to} are omitted, | |
1645 | they default to the whole buffer. | |
22697dac KH |
1646 | @end defun |
1647 | ||
bfe721d1 KH |
1648 | @defun indent-to-left-margin |
1649 | This is the default @code{indent-line-function}, used in Fundamental | |
1650 | mode, Text mode, etc. Its effect is to adjust the indentation at the | |
1651 | beginning of the current line to the value specified by the variable | |
1652 | @code{left-margin}. This may involve either inserting or deleting | |
1653 | whitespace. | |
1654 | @end defun | |
1655 | ||
1656 | @defvar left-margin | |
1657 | This variable specifies the base left margin column. In Fundamental | |
969fe9b5 | 1658 | mode, @kbd{C-j} indents to this column. This variable automatically |
bfe721d1 KH |
1659 | becomes buffer-local when set in any fashion. |
1660 | @end defvar | |
1661 | ||
969fe9b5 | 1662 | @defvar fill-nobreak-predicate |
edd523a9 RS |
1663 | This variable gives major modes a way to specify not to break a line |
1664 | at certain places. Its value should be a list of functions, but a | |
1665 | single function is also supported for compatibility. Whenever filling | |
1666 | considers breaking the line at a certain place in the buffer, it calls | |
1667 | each of these functions with no arguments and with point located at | |
1668 | that place. If any of the functions returns non-@code{nil}, then the | |
1669 | line won't be broken there. | |
969fe9b5 RS |
1670 | @end defvar |
1671 | ||
1911e6e5 RS |
1672 | @node Adaptive Fill |
1673 | @section Adaptive Fill Mode | |
1674 | @cindex Adaptive Fill mode | |
1675 | ||
0c2cfb96 EZ |
1676 | When @dfn{Adaptive Fill Mode} is enabled, Emacs determines the fill |
1677 | prefix automatically from the text in each paragraph being filled | |
1678 | rather than using a predetermined value. During filling, this fill | |
1679 | prefix gets inserted at the start of the second and subsequent lines | |
1680 | of the paragraph as described in @ref{Filling}, and in @ref{Auto | |
1681 | Filling}. | |
1911e6e5 RS |
1682 | |
1683 | @defopt adaptive-fill-mode | |
1684 | Adaptive Fill mode is enabled when this variable is non-@code{nil}. | |
1685 | It is @code{t} by default. | |
1686 | @end defopt | |
1687 | ||
1688 | @defun fill-context-prefix from to | |
1689 | This function implements the heart of Adaptive Fill mode; it chooses a | |
0c2cfb96 EZ |
1690 | fill prefix based on the text between @var{from} and @var{to}, |
1691 | typically the start and end of a paragraph. It does this by looking | |
1692 | at the first two lines of the paragraph, based on the variables | |
1693 | described below. | |
2468d0c0 DL |
1694 | @c The optional argument first-line-regexp is not documented |
1695 | @c because it exists for internal purposes and might be eliminated | |
1696 | @c in the future. | |
0c2cfb96 EZ |
1697 | |
1698 | Usually, this function returns the fill prefix, a string. However, | |
1699 | before doing this, the function makes a final check (not specially | |
1700 | mentioned in the following) that a line starting with this prefix | |
1701 | wouldn't look like the start of a paragraph. Should this happen, the | |
1702 | function signals the anomaly by returning @code{nil} instead. | |
1703 | ||
1704 | In detail, @code{fill-context-prefix} does this: | |
1705 | ||
1706 | @enumerate | |
1707 | @item | |
1708 | It takes a candidate for the fill prefix from the first line---it | |
1709 | tries first the function in @code{adaptive-fill-function} (if any), | |
1710 | then the regular expression @code{adaptive-fill-regexp} (see below). | |
1711 | The first non-@code{nil} result of these, or the empty string if | |
1712 | they're both @code{nil}, becomes the first line's candidate. | |
1713 | @item | |
1714 | If the paragraph has as yet only one line, the function tests the | |
1715 | validity of the prefix candidate just found. The function then | |
1716 | returns the candidate if it's valid, or a string of spaces otherwise. | |
1717 | (see the description of @code{adaptive-fill-first-line-regexp} below). | |
1718 | @item | |
1719 | When the paragraph already has two lines, the function next looks for | |
1720 | a prefix candidate on the second line, in just the same way it did for | |
1721 | the first line. If it doesn't find one, it returns @code{nil}. | |
1722 | @item | |
1723 | The function now compares the two candidate prefixes heuristically: if | |
1724 | the non-whitespace characters in the line 2 candidate occur in the | |
1725 | same order in the line 1 candidate, the function returns the line 2 | |
1726 | candidate. Otherwise, it returns the largest initial substring which | |
1727 | is common to both candidates (which might be the empty string). | |
1728 | @end enumerate | |
1911e6e5 RS |
1729 | @end defun |
1730 | ||
1731 | @defopt adaptive-fill-regexp | |
ebc6903b RS |
1732 | Adaptive Fill mode matches this regular expression against the text |
1733 | starting after the left margin whitespace (if any) on a line; the | |
1734 | characters it matches are that line's candidate for the fill prefix. | |
0c2cfb96 | 1735 | |
3b42af63 | 1736 | @w{@code{"[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"}} is the |
342fd6cd RS |
1737 | default value. This matches a number enclosed in parentheses or |
1738 | followed by a period, or certain punctuation characters, or any | |
1739 | sequence of these intermingled with whitespace. In particular, it | |
1740 | matches a sequence of whitespace, possibly empty. | |
1911e6e5 RS |
1741 | @end defopt |
1742 | ||
1743 | @defopt adaptive-fill-first-line-regexp | |
0c2cfb96 EZ |
1744 | Used only in one-line paragraphs, this regular expression acts as an |
1745 | additional check of the validity of the one available candidate fill | |
1746 | prefix: the candidate must match this regular expression, or match | |
1747 | @code{comment-start-skip}. If it doesn't, @code{fill-context-prefix} | |
1748 | replaces the candidate with a string of spaces ``of the same width'' | |
1749 | as it. | |
1750 | ||
3b42af63 | 1751 | The default value of this variable is @w{@code{"\\`[ \t]*\\'"}}, which |
0c2cfb96 EZ |
1752 | matches only a string of whitespace. The effect of this default is to |
1753 | force the fill prefixes found in one-line paragraphs always to be pure | |
1754 | whitespace. | |
1911e6e5 RS |
1755 | @end defopt |
1756 | ||
1757 | @defopt adaptive-fill-function | |
1758 | You can specify more complex ways of choosing a fill prefix | |
1759 | automatically by setting this variable to a function. The function is | |
0c2cfb96 EZ |
1760 | called with point after the left margin (if any) of a line, and it |
1761 | must preserve point. It should return either ``that line's'' fill | |
1762 | prefix or @code{nil}, meaning it has failed to determine a prefix. | |
1911e6e5 RS |
1763 | @end defopt |
1764 | ||
73804d4b RS |
1765 | @node Auto Filling |
1766 | @comment node-name, next, previous, up | |
1767 | @section Auto Filling | |
1768 | @cindex filling, automatic | |
1769 | @cindex Auto Fill mode | |
1770 | ||
61cfa852 | 1771 | Auto Fill mode is a minor mode that fills lines automatically as text |
bda144f4 | 1772 | is inserted. This section describes the hook used by Auto Fill mode. |
61cfa852 RS |
1773 | For a description of functions that you can call explicitly to fill and |
1774 | justify existing text, see @ref{Filling}. | |
73804d4b | 1775 | |
bfe721d1 KH |
1776 | Auto Fill mode also enables the functions that change the margins and |
1777 | justification style to refill portions of the text. @xref{Margins}. | |
1778 | ||
73804d4b | 1779 | @defvar auto-fill-function |
475aab0d CY |
1780 | The value of this buffer-local variable should be a function (of no |
1781 | arguments) to be called after self-inserting a character from the table | |
ca3be36e DL |
1782 | @code{auto-fill-chars}. It may be @code{nil}, in which case nothing |
1783 | special is done in that case. | |
73804d4b RS |
1784 | |
1785 | The value of @code{auto-fill-function} is @code{do-auto-fill} when | |
1786 | Auto-Fill mode is enabled. That is a function whose sole purpose is to | |
1787 | implement the usual strategy for breaking a line. | |
1788 | ||
1789 | @quotation | |
1790 | In older Emacs versions, this variable was named @code{auto-fill-hook}, | |
1791 | but since it is not called with the standard convention for hooks, it | |
1792 | was renamed to @code{auto-fill-function} in version 19. | |
1793 | @end quotation | |
1794 | @end defvar | |
1795 | ||
910bc071 RS |
1796 | @defvar normal-auto-fill-function |
1797 | This variable specifies the function to use for | |
1798 | @code{auto-fill-function}, if and when Auto Fill is turned on. Major | |
969fe9b5 RS |
1799 | modes can set buffer-local values for this variable to alter how Auto |
1800 | Fill works. | |
910bc071 RS |
1801 | @end defvar |
1802 | ||
ca3be36e DL |
1803 | @defvar auto-fill-chars |
1804 | A char table of characters which invoke @code{auto-fill-function} when | |
1805 | self-inserted---space and newline in most language environments. They | |
1806 | have an entry @code{t} in the table. | |
1807 | @end defvar | |
1808 | ||
73804d4b RS |
1809 | @node Sorting |
1810 | @section Sorting Text | |
1811 | @cindex sorting text | |
1812 | ||
1813 | The sorting functions described in this section all rearrange text in | |
1814 | a buffer. This is in contrast to the function @code{sort}, which | |
1815 | rearranges the order of the elements of a list (@pxref{Rearrangement}). | |
1816 | The values returned by these functions are not meaningful. | |
1817 | ||
1412ac47 | 1818 | @defun sort-subr reverse nextrecfun endrecfun &optional startkeyfun endkeyfun predicate |
f9f59935 RS |
1819 | This function is the general text-sorting routine that subdivides a |
1820 | buffer into records and then sorts them. Most of the commands in this | |
1821 | section use this function. | |
73804d4b RS |
1822 | |
1823 | To understand how @code{sort-subr} works, consider the whole accessible | |
1824 | portion of the buffer as being divided into disjoint pieces called | |
f9f59935 RS |
1825 | @dfn{sort records}. The records may or may not be contiguous, but they |
1826 | must not overlap. A portion of each sort record (perhaps all of it) is | |
73804d4b RS |
1827 | designated as the sort key. Sorting rearranges the records in order by |
1828 | their sort keys. | |
1829 | ||
1830 | Usually, the records are rearranged in order of ascending sort key. | |
1831 | If the first argument to the @code{sort-subr} function, @var{reverse}, | |
1832 | is non-@code{nil}, the sort records are rearranged in order of | |
1833 | descending sort key. | |
1834 | ||
1835 | The next four arguments to @code{sort-subr} are functions that are | |
1836 | called to move point across a sort record. They are called many times | |
1837 | from within @code{sort-subr}. | |
1838 | ||
1839 | @enumerate | |
1840 | @item | |
1841 | @var{nextrecfun} is called with point at the end of a record. This | |
1842 | function moves point to the start of the next record. The first record | |
1843 | is assumed to start at the position of point when @code{sort-subr} is | |
1844 | called. Therefore, you should usually move point to the beginning of | |
1845 | the buffer before calling @code{sort-subr}. | |
1846 | ||
1847 | This function can indicate there are no more sort records by leaving | |
1848 | point at the end of the buffer. | |
1849 | ||
1850 | @item | |
1851 | @var{endrecfun} is called with point within a record. It moves point to | |
1852 | the end of the record. | |
1853 | ||
1854 | @item | |
1855 | @var{startkeyfun} is called to move point from the start of a record to | |
1856 | the start of the sort key. This argument is optional; if it is omitted, | |
1857 | the whole record is the sort key. If supplied, the function should | |
1858 | either return a non-@code{nil} value to be used as the sort key, or | |
1859 | return @code{nil} to indicate that the sort key is in the buffer | |
1860 | starting at point. In the latter case, @var{endkeyfun} is called to | |
1861 | find the end of the sort key. | |
1862 | ||
1863 | @item | |
1864 | @var{endkeyfun} is called to move point from the start of the sort key | |
1865 | to the end of the sort key. This argument is optional. If | |
1866 | @var{startkeyfun} returns @code{nil} and this argument is omitted (or | |
1867 | @code{nil}), then the sort key extends to the end of the record. There | |
1868 | is no need for @var{endkeyfun} if @var{startkeyfun} returns a | |
1869 | non-@code{nil} value. | |
1870 | @end enumerate | |
1871 | ||
1412ac47 RS |
1872 | The argument @var{predicate} is the function to use to compare keys. |
1873 | If keys are numbers, it defaults to @code{<}; otherwise it defaults to | |
1874 | @code{string<}. | |
1875 | ||
73804d4b RS |
1876 | As an example of @code{sort-subr}, here is the complete function |
1877 | definition for @code{sort-lines}: | |
1878 | ||
1879 | @example | |
1880 | @group | |
1881 | ;; @r{Note that the first two lines of doc string} | |
1882 | ;; @r{are effectively one line when viewed by a user.} | |
1883 | (defun sort-lines (reverse beg end) | |
f9f59935 RS |
1884 | "Sort lines in region alphabetically;\ |
1885 | argument means descending order. | |
73804d4b RS |
1886 | Called from a program, there are three arguments: |
1887 | @end group | |
1888 | @group | |
f9f59935 RS |
1889 | REVERSE (non-nil means reverse order),\ |
1890 | BEG and END (region to sort). | |
1891 | The variable `sort-fold-case' determines\ | |
1892 | whether alphabetic case affects | |
690146de | 1893 | the sort order." |
f9f59935 RS |
1894 | @end group |
1895 | @group | |
73804d4b | 1896 | (interactive "P\nr") |
1911e6e5 RS |
1897 | (save-excursion |
1898 | (save-restriction | |
1899 | (narrow-to-region beg end) | |
1900 | (goto-char (point-min)) | |
1901 | (sort-subr reverse 'forward-line 'end-of-line)))) | |
73804d4b RS |
1902 | @end group |
1903 | @end example | |
1904 | ||
1905 | Here @code{forward-line} moves point to the start of the next record, | |
1906 | and @code{end-of-line} moves point to the end of record. We do not pass | |
1907 | the arguments @var{startkeyfun} and @var{endkeyfun}, because the entire | |
1908 | record is used as the sort key. | |
1909 | ||
1910 | The @code{sort-paragraphs} function is very much the same, except that | |
1911 | its @code{sort-subr} call looks like this: | |
1912 | ||
1913 | @example | |
1914 | @group | |
1915 | (sort-subr reverse | |
1911e6e5 RS |
1916 | (function |
1917 | (lambda () | |
1918 | (while (and (not (eobp)) | |
1919 | (looking-at paragraph-separate)) | |
1920 | (forward-line 1)))) | |
73804d4b RS |
1921 | 'forward-paragraph) |
1922 | @end group | |
1923 | @end example | |
f9f59935 RS |
1924 | |
1925 | Markers pointing into any sort records are left with no useful | |
1926 | position after @code{sort-subr} returns. | |
73804d4b RS |
1927 | @end defun |
1928 | ||
1911e6e5 RS |
1929 | @defopt sort-fold-case |
1930 | If this variable is non-@code{nil}, @code{sort-subr} and the other | |
1931 | buffer sorting functions ignore case when comparing strings. | |
1932 | @end defopt | |
1933 | ||
73804d4b RS |
1934 | @deffn Command sort-regexp-fields reverse record-regexp key-regexp start end |
1935 | This command sorts the region between @var{start} and @var{end} | |
1936 | alphabetically as specified by @var{record-regexp} and @var{key-regexp}. | |
1937 | If @var{reverse} is a negative integer, then sorting is in reverse | |
1938 | order. | |
1939 | ||
1940 | Alphabetical sorting means that two sort keys are compared by | |
1941 | comparing the first characters of each, the second characters of each, | |
1942 | and so on. If a mismatch is found, it means that the sort keys are | |
1943 | unequal; the sort key whose character is less at the point of first | |
1944 | mismatch is the lesser sort key. The individual characters are compared | |
f9f59935 | 1945 | according to their numerical character codes in the Emacs character set. |
73804d4b RS |
1946 | |
1947 | The value of the @var{record-regexp} argument specifies how to divide | |
1948 | the buffer into sort records. At the end of each record, a search is | |
f9f59935 RS |
1949 | done for this regular expression, and the text that matches it is taken |
1950 | as the next record. For example, the regular expression @samp{^.+$}, | |
1951 | which matches lines with at least one character besides a newline, would | |
1952 | make each such line into a sort record. @xref{Regular Expressions}, for | |
1953 | a description of the syntax and meaning of regular expressions. | |
73804d4b RS |
1954 | |
1955 | The value of the @var{key-regexp} argument specifies what part of each | |
1956 | record is the sort key. The @var{key-regexp} could match the whole | |
1957 | record, or only a part. In the latter case, the rest of the record has | |
1958 | no effect on the sorted order of records, but it is carried along when | |
1959 | the record moves to its new position. | |
1960 | ||
1961 | The @var{key-regexp} argument can refer to the text matched by a | |
1962 | subexpression of @var{record-regexp}, or it can be a regular expression | |
1963 | on its own. | |
1964 | ||
1965 | If @var{key-regexp} is: | |
1966 | ||
1967 | @table @asis | |
1968 | @item @samp{\@var{digit}} | |
1969 | then the text matched by the @var{digit}th @samp{\(...\)} parenthesis | |
1970 | grouping in @var{record-regexp} is the sort key. | |
1971 | ||
1972 | @item @samp{\&} | |
1973 | then the whole record is the sort key. | |
1974 | ||
1975 | @item a regular expression | |
1976 | then @code{sort-regexp-fields} searches for a match for the regular | |
1977 | expression within the record. If such a match is found, it is the sort | |
1978 | key. If there is no match for @var{key-regexp} within a record then | |
1979 | that record is ignored, which means its position in the buffer is not | |
1980 | changed. (The other records may move around it.) | |
1981 | @end table | |
1982 | ||
1983 | For example, if you plan to sort all the lines in the region by the | |
1984 | first word on each line starting with the letter @samp{f}, you should | |
1985 | set @var{record-regexp} to @samp{^.*$} and set @var{key-regexp} to | |
1986 | @samp{\<f\w*\>}. The resulting expression looks like this: | |
1987 | ||
1988 | @example | |
1989 | @group | |
1990 | (sort-regexp-fields nil "^.*$" "\\<f\\w*\\>" | |
1991 | (region-beginning) | |
1992 | (region-end)) | |
1993 | @end group | |
1994 | @end example | |
1995 | ||
1996 | If you call @code{sort-regexp-fields} interactively, it prompts for | |
1997 | @var{record-regexp} and @var{key-regexp} in the minibuffer. | |
1998 | @end deffn | |
1999 | ||
2000 | @deffn Command sort-lines reverse start end | |
2001 | This command alphabetically sorts lines in the region between | |
2002 | @var{start} and @var{end}. If @var{reverse} is non-@code{nil}, the sort | |
2003 | is in reverse order. | |
2004 | @end deffn | |
2005 | ||
2006 | @deffn Command sort-paragraphs reverse start end | |
2007 | This command alphabetically sorts paragraphs in the region between | |
2008 | @var{start} and @var{end}. If @var{reverse} is non-@code{nil}, the sort | |
2009 | is in reverse order. | |
2010 | @end deffn | |
2011 | ||
2012 | @deffn Command sort-pages reverse start end | |
2013 | This command alphabetically sorts pages in the region between | |
2014 | @var{start} and @var{end}. If @var{reverse} is non-@code{nil}, the sort | |
2015 | is in reverse order. | |
2016 | @end deffn | |
2017 | ||
2018 | @deffn Command sort-fields field start end | |
2019 | This command sorts lines in the region between @var{start} and | |
2020 | @var{end}, comparing them alphabetically by the @var{field}th field | |
2021 | of each line. Fields are separated by whitespace and numbered starting | |
2022 | from 1. If @var{field} is negative, sorting is by the | |
2023 | @w{@minus{}@var{field}th} field from the end of the line. This command | |
2024 | is useful for sorting tables. | |
2025 | @end deffn | |
2026 | ||
2027 | @deffn Command sort-numeric-fields field start end | |
2028 | This command sorts lines in the region between @var{start} and | |
b471b8e9 RS |
2029 | @var{end}, comparing them numerically by the @var{field}th field of |
2030 | each line. Fields are separated by whitespace and numbered starting | |
2031 | from 1. The specified field must contain a number in each line of the | |
2032 | region. Numbers starting with 0 are treated as octal, and numbers | |
2033 | starting with @samp{0x} are treated as hexadecimal. | |
2034 | ||
2035 | If @var{field} is negative, sorting is by the | |
2036 | @w{@minus{}@var{field}th} field from the end of the line. This | |
2037 | command is useful for sorting tables. | |
73804d4b RS |
2038 | @end deffn |
2039 | ||
b471b8e9 RS |
2040 | @defopt sort-numeric-base |
2041 | This variable specifies the default radix for | |
2042 | @code{sort-numeric-fields} to parse numbers. | |
2043 | @end defopt | |
2044 | ||
73804d4b RS |
2045 | @deffn Command sort-columns reverse &optional beg end |
2046 | This command sorts the lines in the region between @var{beg} and | |
b471b8e9 RS |
2047 | @var{end}, comparing them alphabetically by a certain range of |
2048 | columns. The column positions of @var{beg} and @var{end} bound the | |
2049 | range of columns to sort on. | |
73804d4b RS |
2050 | |
2051 | If @var{reverse} is non-@code{nil}, the sort is in reverse order. | |
2052 | ||
2053 | One unusual thing about this command is that the entire line | |
2054 | containing position @var{beg}, and the entire line containing position | |
2055 | @var{end}, are included in the region sorted. | |
2056 | ||
2057 | Note that @code{sort-columns} uses the @code{sort} utility program, | |
2058 | and so cannot work properly on text containing tab characters. Use | |
969fe9b5 | 2059 | @kbd{M-x untabify} to convert tabs to spaces before sorting. |
73804d4b RS |
2060 | @end deffn |
2061 | ||
2062 | @node Columns | |
2063 | @comment node-name, next, previous, up | |
2064 | @section Counting Columns | |
2065 | @cindex columns | |
2066 | @cindex counting columns | |
2067 | @cindex horizontal position | |
2068 | ||
2069 | The column functions convert between a character position (counting | |
2070 | characters from the beginning of the buffer) and a column position | |
2071 | (counting screen characters from the beginning of a line). | |
2072 | ||
f9f59935 RS |
2073 | These functions count each character according to the number of |
2074 | columns it occupies on the screen. This means control characters count | |
2075 | as occupying 2 or 4 columns, depending upon the value of | |
2076 | @code{ctl-arrow}, and tabs count as occupying a number of columns that | |
2077 | depends on the value of @code{tab-width} and on the column where the tab | |
2078 | begins. @xref{Usual Display}. | |
73804d4b RS |
2079 | |
2080 | Column number computations ignore the width of the window and the | |
2081 | amount of horizontal scrolling. Consequently, a column value can be | |
6fac48b3 RS |
2082 | arbitrarily high. The first (or leftmost) column is numbered 0. They |
2083 | also ignore overlays and text properties, aside from invisibility. | |
73804d4b RS |
2084 | |
2085 | @defun current-column | |
2086 | This function returns the horizontal position of point, measured in | |
2087 | columns, counting from 0 at the left margin. The column position is the | |
2088 | sum of the widths of all the displayed representations of the characters | |
2089 | between the start of the current line and point. | |
2090 | ||
2091 | For an example of using @code{current-column}, see the description of | |
2092 | @code{count-lines} in @ref{Text Lines}. | |
2093 | @end defun | |
2094 | ||
2095 | @defun move-to-column column &optional force | |
2096 | This function moves point to @var{column} in the current line. The | |
2097 | calculation of @var{column} takes into account the widths of the | |
2098 | displayed representations of the characters between the start of the | |
2099 | line and point. | |
2100 | ||
2101 | If column @var{column} is beyond the end of the line, point moves to the | |
2102 | end of the line. If @var{column} is negative, point moves to the | |
2103 | beginning of the line. | |
2104 | ||
2105 | If it is impossible to move to column @var{column} because that is in | |
2106 | the middle of a multicolumn character such as a tab, point moves to the | |
2107 | end of that character. However, if @var{force} is non-@code{nil}, and | |
2108 | @var{column} is in the middle of a tab, then @code{move-to-column} | |
2109 | converts the tab into spaces so that it can move precisely to column | |
2110 | @var{column}. Other multicolumn characters can cause anomalies despite | |
2111 | @var{force}, since there is no way to split them. | |
2112 | ||
2113 | The argument @var{force} also has an effect if the line isn't long | |
8241495d RS |
2114 | enough to reach column @var{column}; if it is @code{t}, that means to |
2115 | add whitespace at the end of the line to reach that column. | |
73804d4b RS |
2116 | |
2117 | If @var{column} is not an integer, an error is signaled. | |
2118 | ||
2119 | The return value is the column number actually moved to. | |
2120 | @end defun | |
2121 | ||
2122 | @node Indentation | |
2123 | @section Indentation | |
2124 | @cindex indentation | |
2125 | ||
2126 | The indentation functions are used to examine, move to, and change | |
2127 | whitespace that is at the beginning of a line. Some of the functions | |
2128 | can also change whitespace elsewhere on a line. Columns and indentation | |
2129 | count from zero at the left margin. | |
2130 | ||
2131 | @menu | |
2132 | * Primitive Indent:: Functions used to count and insert indentation. | |
2133 | * Mode-Specific Indent:: Customize indentation for different modes. | |
2134 | * Region Indent:: Indent all the lines in a region. | |
2135 | * Relative Indent:: Indent the current line based on previous lines. | |
2136 | * Indent Tabs:: Adjustable, typewriter-like tab stops. | |
2137 | * Motion by Indent:: Move to first non-blank character. | |
2138 | @end menu | |
2139 | ||
2140 | @node Primitive Indent | |
2141 | @subsection Indentation Primitives | |
2142 | ||
2143 | This section describes the primitive functions used to count and | |
2144 | insert indentation. The functions in the following sections use these | |
969fe9b5 | 2145 | primitives. @xref{Width}, for related functions. |
73804d4b RS |
2146 | |
2147 | @defun current-indentation | |
2148 | @comment !!Type Primitive Function | |
2149 | @comment !!SourceFile indent.c | |
2150 | This function returns the indentation of the current line, which is | |
2151 | the horizontal position of the first nonblank character. If the | |
2152 | contents are entirely blank, then this is the horizontal position of the | |
2153 | end of the line. | |
2154 | @end defun | |
2155 | ||
2156 | @deffn Command indent-to column &optional minimum | |
2157 | @comment !!Type Primitive Function | |
2158 | @comment !!SourceFile indent.c | |
61cfa852 RS |
2159 | This function indents from point with tabs and spaces until @var{column} |
2160 | is reached. If @var{minimum} is specified and non-@code{nil}, then at | |
2161 | least that many spaces are inserted even if this requires going beyond | |
2162 | @var{column}. Otherwise the function does nothing if point is already | |
2163 | beyond @var{column}. The value is the column at which the inserted | |
2164 | indentation ends. | |
33acbad2 RS |
2165 | |
2166 | The inserted whitespace characters inherit text properties from the | |
2167 | surrounding text (usually, from the preceding text only). @xref{Sticky | |
2168 | Properties}. | |
73804d4b RS |
2169 | @end deffn |
2170 | ||
2171 | @defopt indent-tabs-mode | |
2172 | @comment !!SourceFile indent.c | |
2173 | If this variable is non-@code{nil}, indentation functions can insert | |
2174 | tabs as well as spaces. Otherwise, they insert only spaces. Setting | |
969fe9b5 | 2175 | this variable automatically makes it buffer-local in the current buffer. |
73804d4b RS |
2176 | @end defopt |
2177 | ||
2178 | @node Mode-Specific Indent | |
2179 | @subsection Indentation Controlled by Major Mode | |
2180 | ||
2181 | An important function of each major mode is to customize the @key{TAB} | |
2182 | key to indent properly for the language being edited. This section | |
2183 | describes the mechanism of the @key{TAB} key and how to control it. | |
2184 | The functions in this section return unpredictable values. | |
2185 | ||
2186 | @defvar indent-line-function | |
2187 | This variable's value is the function to be used by @key{TAB} (and | |
2188 | various commands) to indent the current line. The command | |
2189 | @code{indent-according-to-mode} does no more than call this function. | |
2190 | ||
2191 | In Lisp mode, the value is the symbol @code{lisp-indent-line}; in C | |
2192 | mode, @code{c-indent-line}; in Fortran mode, @code{fortran-indent-line}. | |
2193 | In Fundamental mode, Text mode, and many other modes with no standard | |
2194 | for indentation, the value is @code{indent-to-left-margin} (which is the | |
2195 | default value). | |
2196 | @end defvar | |
2197 | ||
2198 | @deffn Command indent-according-to-mode | |
2199 | This command calls the function in @code{indent-line-function} to | |
2200 | indent the current line in a way appropriate for the current major mode. | |
2201 | @end deffn | |
2202 | ||
2203 | @deffn Command indent-for-tab-command | |
2204 | This command calls the function in @code{indent-line-function} to indent | |
a9f0a989 RS |
2205 | the current line; however, if that function is |
2206 | @code{indent-to-left-margin}, @code{insert-tab} is called instead. (That | |
61cfa852 | 2207 | is a trivial command that inserts a tab character.) |
73804d4b RS |
2208 | @end deffn |
2209 | ||
73804d4b RS |
2210 | @deffn Command newline-and-indent |
2211 | @comment !!SourceFile simple.el | |
2212 | This function inserts a newline, then indents the new line (the one | |
2213 | following the newline just inserted) according to the major mode. | |
2214 | ||
2215 | It does indentation by calling the current @code{indent-line-function}. | |
2216 | In programming language modes, this is the same thing @key{TAB} does, | |
2217 | but in some text modes, where @key{TAB} inserts a tab, | |
2218 | @code{newline-and-indent} indents to the column specified by | |
2219 | @code{left-margin}. | |
2220 | @end deffn | |
2221 | ||
2222 | @deffn Command reindent-then-newline-and-indent | |
2223 | @comment !!SourceFile simple.el | |
2224 | This command reindents the current line, inserts a newline at point, | |
1911e6e5 | 2225 | and then indents the new line (the one following the newline just |
73804d4b RS |
2226 | inserted). |
2227 | ||
2228 | This command does indentation on both lines according to the current | |
2229 | major mode, by calling the current value of @code{indent-line-function}. | |
2230 | In programming language modes, this is the same thing @key{TAB} does, | |
2231 | but in some text modes, where @key{TAB} inserts a tab, | |
2232 | @code{reindent-then-newline-and-indent} indents to the column specified | |
2233 | by @code{left-margin}. | |
2234 | @end deffn | |
2235 | ||
2236 | @node Region Indent | |
2237 | @subsection Indenting an Entire Region | |
2238 | ||
61cfa852 | 2239 | This section describes commands that indent all the lines in the |
73804d4b RS |
2240 | region. They return unpredictable values. |
2241 | ||
2242 | @deffn Command indent-region start end to-column | |
2243 | This command indents each nonblank line starting between @var{start} | |
2244 | (inclusive) and @var{end} (exclusive). If @var{to-column} is | |
2245 | @code{nil}, @code{indent-region} indents each nonblank line by calling | |
2246 | the current mode's indentation function, the value of | |
2247 | @code{indent-line-function}. | |
2248 | ||
2249 | If @var{to-column} is non-@code{nil}, it should be an integer | |
2250 | specifying the number of columns of indentation; then this function | |
2251 | gives each line exactly that much indentation, by either adding or | |
2252 | deleting whitespace. | |
2253 | ||
2254 | If there is a fill prefix, @code{indent-region} indents each line | |
2255 | by making it start with the fill prefix. | |
2256 | @end deffn | |
2257 | ||
2258 | @defvar indent-region-function | |
2259 | The value of this variable is a function that can be used by | |
a9f0a989 RS |
2260 | @code{indent-region} as a short cut. It should take two arguments, the |
2261 | start and end of the region. You should design the function so | |
73804d4b RS |
2262 | that it will produce the same results as indenting the lines of the |
2263 | region one by one, but presumably faster. | |
2264 | ||
2265 | If the value is @code{nil}, there is no short cut, and | |
2266 | @code{indent-region} actually works line by line. | |
2267 | ||
61cfa852 | 2268 | A short-cut function is useful in modes such as C mode and Lisp mode, |
73804d4b | 2269 | where the @code{indent-line-function} must scan from the beginning of |
61cfa852 RS |
2270 | the function definition: applying it to each line would be quadratic in |
2271 | time. The short cut can update the scan information as it moves through | |
2272 | the lines indenting them; this takes linear time. In a mode where | |
2273 | indenting a line individually is fast, there is no need for a short cut. | |
73804d4b | 2274 | |
61cfa852 RS |
2275 | @code{indent-region} with a non-@code{nil} argument @var{to-column} has |
2276 | a different meaning and does not use this variable. | |
73804d4b RS |
2277 | @end defvar |
2278 | ||
2279 | @deffn Command indent-rigidly start end count | |
2280 | @comment !!SourceFile indent.el | |
2281 | This command indents all lines starting between @var{start} | |
2282 | (inclusive) and @var{end} (exclusive) sideways by @var{count} columns. | |
2283 | This ``preserves the shape'' of the affected region, moving it as a | |
2284 | rigid unit. Consequently, this command is useful not only for indenting | |
2285 | regions of unindented text, but also for indenting regions of formatted | |
2286 | code. | |
2287 | ||
2288 | For example, if @var{count} is 3, this command adds 3 columns of | |
2289 | indentation to each of the lines beginning in the region specified. | |
2290 | ||
2291 | In Mail mode, @kbd{C-c C-y} (@code{mail-yank-original}) uses | |
2292 | @code{indent-rigidly} to indent the text copied from the message being | |
2293 | replied to. | |
2294 | @end deffn | |
2295 | ||
2296 | @defun indent-code-rigidly start end columns &optional nochange-regexp | |
2297 | This is like @code{indent-rigidly}, except that it doesn't alter lines | |
2298 | that start within strings or comments. | |
2299 | ||
2300 | In addition, it doesn't alter a line if @var{nochange-regexp} matches at | |
2301 | the beginning of the line (if @var{nochange-regexp} is non-@code{nil}). | |
2302 | @end defun | |
2303 | ||
2304 | @node Relative Indent | |
2305 | @subsection Indentation Relative to Previous Lines | |
2306 | ||
61cfa852 | 2307 | This section describes two commands that indent the current line |
73804d4b RS |
2308 | based on the contents of previous lines. |
2309 | ||
2310 | @deffn Command indent-relative &optional unindented-ok | |
2311 | This command inserts whitespace at point, extending to the same | |
2312 | column as the next @dfn{indent point} of the previous nonblank line. An | |
2313 | indent point is a non-whitespace character following whitespace. The | |
2314 | next indent point is the first one at a column greater than the current | |
2315 | column of point. For example, if point is underneath and to the left of | |
2316 | the first non-blank character of a line of text, it moves to that column | |
2317 | by inserting whitespace. | |
2318 | ||
2319 | If the previous nonblank line has no next indent point (i.e., none at a | |
2320 | great enough column position), @code{indent-relative} either does | |
2321 | nothing (if @var{unindented-ok} is non-@code{nil}) or calls | |
2322 | @code{tab-to-tab-stop}. Thus, if point is underneath and to the right | |
2323 | of the last column of a short line of text, this command ordinarily | |
2324 | moves point to the next tab stop by inserting whitespace. | |
2325 | ||
2326 | The return value of @code{indent-relative} is unpredictable. | |
2327 | ||
2328 | In the following example, point is at the beginning of the second | |
2329 | line: | |
2330 | ||
2331 | @example | |
2332 | @group | |
2333 | This line is indented twelve spaces. | |
2334 | @point{}The quick brown fox jumped. | |
2335 | @end group | |
2336 | @end example | |
2337 | ||
2338 | @noindent | |
2339 | Evaluation of the expression @code{(indent-relative nil)} produces the | |
2340 | following: | |
2341 | ||
2342 | @example | |
2343 | @group | |
2344 | This line is indented twelve spaces. | |
2345 | @point{}The quick brown fox jumped. | |
2346 | @end group | |
2347 | @end example | |
2348 | ||
f9f59935 | 2349 | In this next example, point is between the @samp{m} and @samp{p} of |
73804d4b RS |
2350 | @samp{jumped}: |
2351 | ||
2352 | @example | |
2353 | @group | |
2354 | This line is indented twelve spaces. | |
2355 | The quick brown fox jum@point{}ped. | |
2356 | @end group | |
2357 | @end example | |
2358 | ||
2359 | @noindent | |
2360 | Evaluation of the expression @code{(indent-relative nil)} produces the | |
2361 | following: | |
2362 | ||
2363 | @example | |
2364 | @group | |
2365 | This line is indented twelve spaces. | |
2366 | The quick brown fox jum @point{}ped. | |
2367 | @end group | |
2368 | @end example | |
2369 | @end deffn | |
2370 | ||
2371 | @deffn Command indent-relative-maybe | |
2372 | @comment !!SourceFile indent.el | |
f9f59935 RS |
2373 | This command indents the current line like the previous nonblank line, |
2374 | by calling @code{indent-relative} with @code{t} as the | |
2375 | @var{unindented-ok} argument. The return value is unpredictable. | |
73804d4b RS |
2376 | |
2377 | If the previous nonblank line has no indent points beyond the current | |
2378 | column, this command does nothing. | |
2379 | @end deffn | |
2380 | ||
2381 | @node Indent Tabs | |
2382 | @comment node-name, next, previous, up | |
2383 | @subsection Adjustable ``Tab Stops'' | |
2384 | @cindex tabs stops for indentation | |
2385 | ||
2386 | This section explains the mechanism for user-specified ``tab stops'' | |
61cfa852 | 2387 | and the mechanisms that use and set them. The name ``tab stops'' is |
73804d4b RS |
2388 | used because the feature is similar to that of the tab stops on a |
2389 | typewriter. The feature works by inserting an appropriate number of | |
2390 | spaces and tab characters to reach the next tab stop column; it does not | |
2391 | affect the display of tab characters in the buffer (@pxref{Usual | |
2392 | Display}). Note that the @key{TAB} character as input uses this tab | |
2393 | stop feature only in a few major modes, such as Text mode. | |
2394 | ||
2395 | @deffn Command tab-to-tab-stop | |
f9f59935 RS |
2396 | This command inserts spaces or tabs before point, up to the next tab |
2397 | stop column defined by @code{tab-stop-list}. It searches the list for | |
2398 | an element greater than the current column number, and uses that element | |
2399 | as the column to indent to. It does nothing if no such element is | |
2400 | found. | |
73804d4b RS |
2401 | @end deffn |
2402 | ||
2403 | @defopt tab-stop-list | |
2404 | This variable is the list of tab stop columns used by | |
2405 | @code{tab-to-tab-stops}. The elements should be integers in increasing | |
2406 | order. The tab stop columns need not be evenly spaced. | |
2407 | ||
2408 | Use @kbd{M-x edit-tab-stops} to edit the location of tab stops | |
2409 | interactively. | |
2410 | @end defopt | |
2411 | ||
2412 | @node Motion by Indent | |
2413 | @subsection Indentation-Based Motion Commands | |
2414 | ||
2415 | These commands, primarily for interactive use, act based on the | |
2416 | indentation in the text. | |
2417 | ||
177c0ea7 | 2418 | @deffn Command back-to-indentation |
73804d4b RS |
2419 | @comment !!SourceFile simple.el |
2420 | This command moves point to the first non-whitespace character in the | |
2421 | current line (which is the line in which point is located). It returns | |
2422 | @code{nil}. | |
2423 | @end deffn | |
2424 | ||
2b42d12a | 2425 | @deffn Command backward-to-indentation &optional arg |
73804d4b RS |
2426 | @comment !!SourceFile simple.el |
2427 | This command moves point backward @var{arg} lines and then to the | |
2428 | first nonblank character on that line. It returns @code{nil}. | |
2b42d12a | 2429 | If @var{arg} is omitted or @code{nil}, it defaults to 1. |
73804d4b RS |
2430 | @end deffn |
2431 | ||
2b42d12a | 2432 | @deffn Command forward-to-indentation &optional arg |
73804d4b RS |
2433 | @comment !!SourceFile simple.el |
2434 | This command moves point forward @var{arg} lines and then to the first | |
2435 | nonblank character on that line. It returns @code{nil}. | |
2b42d12a | 2436 | If @var{arg} is omitted or @code{nil}, it defaults to 1. |
73804d4b RS |
2437 | @end deffn |
2438 | ||
2439 | @node Case Changes | |
2440 | @comment node-name, next, previous, up | |
2441 | @section Case Changes | |
969fe9b5 | 2442 | @cindex case conversion in buffers |
73804d4b RS |
2443 | |
2444 | The case change commands described here work on text in the current | |
969fe9b5 RS |
2445 | buffer. @xref{Case Conversion}, for case conversion functions that work |
2446 | on strings and characters. @xref{Case Tables}, for how to customize | |
73804d4b RS |
2447 | which characters are upper or lower case and how to convert them. |
2448 | ||
2449 | @deffn Command capitalize-region start end | |
2450 | This function capitalizes all words in the region defined by | |
2451 | @var{start} and @var{end}. To capitalize means to convert each word's | |
2452 | first character to upper case and convert the rest of each word to lower | |
2453 | case. The function returns @code{nil}. | |
2454 | ||
2455 | If one end of the region is in the middle of a word, the part of the | |
2456 | word within the region is treated as an entire word. | |
2457 | ||
2458 | When @code{capitalize-region} is called interactively, @var{start} and | |
2459 | @var{end} are point and the mark, with the smallest first. | |
2460 | ||
2461 | @example | |
2462 | @group | |
2463 | ---------- Buffer: foo ---------- | |
2464 | This is the contents of the 5th foo. | |
2465 | ---------- Buffer: foo ---------- | |
2466 | @end group | |
2467 | ||
2468 | @group | |
2469 | (capitalize-region 1 44) | |
2470 | @result{} nil | |
2471 | ||
2472 | ---------- Buffer: foo ---------- | |
2473 | This Is The Contents Of The 5th Foo. | |
2474 | ---------- Buffer: foo ---------- | |
2475 | @end group | |
2476 | @end example | |
2477 | @end deffn | |
2478 | ||
2479 | @deffn Command downcase-region start end | |
2480 | This function converts all of the letters in the region defined by | |
2481 | @var{start} and @var{end} to lower case. The function returns | |
2482 | @code{nil}. | |
2483 | ||
2484 | When @code{downcase-region} is called interactively, @var{start} and | |
2485 | @var{end} are point and the mark, with the smallest first. | |
2486 | @end deffn | |
2487 | ||
2488 | @deffn Command upcase-region start end | |
2489 | This function converts all of the letters in the region defined by | |
2490 | @var{start} and @var{end} to upper case. The function returns | |
2491 | @code{nil}. | |
2492 | ||
2493 | When @code{upcase-region} is called interactively, @var{start} and | |
2494 | @var{end} are point and the mark, with the smallest first. | |
2495 | @end deffn | |
2496 | ||
2497 | @deffn Command capitalize-word count | |
2498 | This function capitalizes @var{count} words after point, moving point | |
2499 | over as it does. To capitalize means to convert each word's first | |
2500 | character to upper case and convert the rest of each word to lower case. | |
2501 | If @var{count} is negative, the function capitalizes the | |
2502 | @minus{}@var{count} previous words but does not move point. The value | |
2503 | is @code{nil}. | |
2504 | ||
61cfa852 RS |
2505 | If point is in the middle of a word, the part of the word before point |
2506 | is ignored when moving forward. The rest is treated as an entire word. | |
73804d4b RS |
2507 | |
2508 | When @code{capitalize-word} is called interactively, @var{count} is | |
2509 | set to the numeric prefix argument. | |
2510 | @end deffn | |
2511 | ||
2512 | @deffn Command downcase-word count | |
2513 | This function converts the @var{count} words after point to all lower | |
2514 | case, moving point over as it does. If @var{count} is negative, it | |
2515 | converts the @minus{}@var{count} previous words but does not move point. | |
2516 | The value is @code{nil}. | |
2517 | ||
2518 | When @code{downcase-word} is called interactively, @var{count} is set | |
2519 | to the numeric prefix argument. | |
2520 | @end deffn | |
2521 | ||
2522 | @deffn Command upcase-word count | |
2523 | This function converts the @var{count} words after point to all upper | |
2524 | case, moving point over as it does. If @var{count} is negative, it | |
2525 | converts the @minus{}@var{count} previous words but does not move point. | |
2526 | The value is @code{nil}. | |
2527 | ||
2528 | When @code{upcase-word} is called interactively, @var{count} is set to | |
2529 | the numeric prefix argument. | |
2530 | @end deffn | |
2531 | ||
2532 | @node Text Properties | |
2533 | @section Text Properties | |
2534 | @cindex text properties | |
2535 | @cindex attributes of text | |
2536 | @cindex properties of text | |
2537 | ||
2538 | Each character position in a buffer or a string can have a @dfn{text | |
2539 | property list}, much like the property list of a symbol (@pxref{Property | |
2540 | Lists}). The properties belong to a particular character at a | |
2541 | particular place, such as, the letter @samp{T} at the beginning of this | |
2542 | sentence or the first @samp{o} in @samp{foo}---if the same character | |
d735cf50 | 2543 | occurs in two different places, the two occurrences in general have |
73804d4b RS |
2544 | different properties. |
2545 | ||
2546 | Each property has a name and a value. Both of these can be any Lisp | |
d735cf50 RS |
2547 | object, but the name is normally a symbol. Typically each property |
2548 | name symbol is used for a particular purpose; for instance, the text | |
2549 | property @code{face} specifies the faces for displaying the character | |
2550 | (@pxref{Special Properties}). The usual way to access the property | |
2551 | list is to specify a name and ask what value corresponds to it. | |
73804d4b RS |
2552 | |
2553 | If a character has a @code{category} property, we call it the | |
2554 | @dfn{category} of the character. It should be a symbol. The properties | |
2555 | of the symbol serve as defaults for the properties of the character. | |
2556 | ||
2557 | Copying text between strings and buffers preserves the properties | |
2558 | along with the characters; this includes such diverse functions as | |
2559 | @code{substring}, @code{insert}, and @code{buffer-substring}. | |
2560 | ||
2561 | @menu | |
a6b73788 RS |
2562 | * Examining Properties:: Looking at the properties of one character. |
2563 | * Changing Properties:: Setting the properties of a range of text. | |
2564 | * Property Search:: Searching for where a property changes value. | |
2565 | * Special Properties:: Particular properties with special meanings. | |
2566 | * Format Properties:: Properties for representing formatting of text. | |
2567 | * Sticky Properties:: How inserted text gets properties from | |
2568 | neighboring text. | |
2569 | * Saving Properties:: Saving text properties in files, and reading | |
2570 | them back. | |
2571 | * Lazy Properties:: Computing text properties in a lazy fashion | |
2572 | only when text is examined. | |
2573 | * Clickable Text:: Using text properties to make regions of text | |
2574 | do something when you click on them. | |
5364b27c | 2575 | * Links and Mouse-1:: How to make @key{Mouse-1} follow a link. |
a6b73788 RS |
2576 | * Fields:: The @code{field} property defines |
2577 | fields within the buffer. | |
2578 | * Not Intervals:: Why text properties do not use | |
2579 | Lisp-visible text intervals. | |
73804d4b RS |
2580 | @end menu |
2581 | ||
2582 | @node Examining Properties | |
2583 | @subsection Examining Text Properties | |
2584 | ||
2585 | The simplest way to examine text properties is to ask for the value of | |
2586 | a particular property of a particular character. For that, use | |
2587 | @code{get-text-property}. Use @code{text-properties-at} to get the | |
2588 | entire property list of a character. @xref{Property Search}, for | |
2589 | functions to examine the properties of a number of characters at once. | |
2590 | ||
2591 | These functions handle both strings and buffers. Keep in mind that | |
2592 | positions in a string start from 0, whereas positions in a buffer start | |
2593 | from 1. | |
2594 | ||
2595 | @defun get-text-property pos prop &optional object | |
2596 | This function returns the value of the @var{prop} property of the | |
2597 | character after position @var{pos} in @var{object} (a buffer or | |
2598 | string). The argument @var{object} is optional and defaults to the | |
2599 | current buffer. | |
2600 | ||
2601 | If there is no @var{prop} property strictly speaking, but the character | |
61cfa852 | 2602 | has a category that is a symbol, then @code{get-text-property} returns |
73804d4b RS |
2603 | the @var{prop} property of that symbol. |
2604 | @end defun | |
2605 | ||
6fac48b3 | 2606 | @defun get-char-property position prop &optional object |
73804d4b RS |
2607 | This function is like @code{get-text-property}, except that it checks |
2608 | overlays first and then text properties. @xref{Overlays}. | |
2609 | ||
2610 | The argument @var{object} may be a string, a buffer, or a window. If it | |
2611 | is a window, then the buffer displayed in that window is used for text | |
2612 | properties and overlays, but only the overlays active for that window | |
2613 | are considered. If @var{object} is a buffer, then all overlays in that | |
2614 | buffer are considered, as well as text properties. If @var{object} is a | |
2615 | string, only text properties are considered, since strings never have | |
2616 | overlays. | |
2617 | @end defun | |
2618 | ||
6fac48b3 RS |
2619 | @defun get-char-property-and-overlay position prop &optional object |
2620 | This is like @code{get-char-property}, but gives extra information | |
2621 | about the overlay that the property value comes from. | |
2622 | ||
2623 | Its value is a cons cell whose @sc{car} is the property value, the | |
2624 | same value @code{get-char-property} would return with the same | |
2625 | arguments. Its @sc{cdr} is the overlay in which the property was | |
2626 | found, or @code{nil}, if it was found as a text property or not found | |
2627 | at all. | |
2628 | ||
2629 | If @var{position} is at the end of @var{object}, both the @sc{car} and | |
2630 | the @sc{cdr} of the value are @code{nil}. | |
2631 | @end defun | |
2632 | ||
1f63f814 CW |
2633 | @defvar char-property-alias-alist |
2634 | This variable holds an alist which maps property names to a list of | |
2635 | alternative property names. If a character does not specify a direct | |
2636 | value for a property, the alternative property names are consulted in | |
74eee906 | 2637 | order; the first non-@code{nil} value is used. This variable takes |
1f63f814 CW |
2638 | precedence over @code{default-text-properties}, and @code{category} |
2639 | properties take precedence over this variable. | |
2640 | @end defvar | |
2641 | ||
73804d4b RS |
2642 | @defun text-properties-at position &optional object |
2643 | This function returns the entire property list of the character at | |
2644 | @var{position} in the string or buffer @var{object}. If @var{object} is | |
2645 | @code{nil}, it defaults to the current buffer. | |
2646 | @end defun | |
2647 | ||
22697dac KH |
2648 | @defvar default-text-properties |
2649 | This variable holds a property list giving default values for text | |
2650 | properties. Whenever a character does not specify a value for a | |
1f63f814 CW |
2651 | property, neither directly, through a category symbol, or through |
2652 | @code{char-property-alias-alist}, the value stored in this list is | |
2653 | used instead. Here is an example: | |
22697dac KH |
2654 | |
2655 | @example | |
1f63f814 CW |
2656 | (setq default-text-properties '(foo 69) |
2657 | char-property-alias-alist nil) | |
22697dac KH |
2658 | ;; @r{Make sure character 1 has no properties of its own.} |
2659 | (set-text-properties 1 2 nil) | |
2660 | ;; @r{What we get, when we ask, is the default value.} | |
2661 | (get-text-property 1 'foo) | |
2662 | @result{} 69 | |
2663 | @end example | |
2664 | @end defvar | |
2665 | ||
73804d4b RS |
2666 | @node Changing Properties |
2667 | @subsection Changing Text Properties | |
2668 | ||
2669 | The primitives for changing properties apply to a specified range of | |
e78ea3db RS |
2670 | text in a buffer or string. The function @code{set-text-properties} |
2671 | (see end of section) sets the entire property list of the text in that | |
2672 | range; more often, it is useful to add, change, or delete just certain | |
2673 | properties specified by name. | |
73804d4b | 2674 | |
e78ea3db | 2675 | Since text properties are considered part of the contents of the |
9a36dd51 RS |
2676 | buffer (or string), and can affect how a buffer looks on the screen, |
2677 | any change in buffer text properties marks the buffer as modified. | |
2678 | Buffer text property changes are undoable also (@pxref{Undo}). | |
2679 | Positions in a string start from 0, whereas positions in a buffer | |
2680 | start from 1. | |
73804d4b | 2681 | |
bfe721d1 KH |
2682 | @defun put-text-property start end prop value &optional object |
2683 | This function sets the @var{prop} property to @var{value} for the text | |
2684 | between @var{start} and @var{end} in the string or buffer @var{object}. | |
2685 | If @var{object} is @code{nil}, it defaults to the current buffer. | |
2686 | @end defun | |
2687 | ||
73804d4b | 2688 | @defun add-text-properties start end props &optional object |
f9f59935 | 2689 | This function adds or overrides text properties for the text between |
73804d4b RS |
2690 | @var{start} and @var{end} in the string or buffer @var{object}. If |
2691 | @var{object} is @code{nil}, it defaults to the current buffer. | |
2692 | ||
f9f59935 RS |
2693 | The argument @var{props} specifies which properties to add. It should |
2694 | have the form of a property list (@pxref{Property Lists}): a list whose | |
2695 | elements include the property names followed alternately by the | |
73804d4b RS |
2696 | corresponding values. |
2697 | ||
2698 | The return value is @code{t} if the function actually changed some | |
2699 | property's value; @code{nil} otherwise (if @var{props} is @code{nil} or | |
2700 | its values agree with those in the text). | |
2701 | ||
2702 | For example, here is how to set the @code{comment} and @code{face} | |
2703 | properties of a range of text: | |
2704 | ||
2705 | @example | |
2706 | (add-text-properties @var{start} @var{end} | |
2707 | '(comment t face highlight)) | |
2708 | @end example | |
2709 | @end defun | |
2710 | ||
73804d4b RS |
2711 | @defun remove-text-properties start end props &optional object |
2712 | This function deletes specified text properties from the text between | |
2713 | @var{start} and @var{end} in the string or buffer @var{object}. If | |
2714 | @var{object} is @code{nil}, it defaults to the current buffer. | |
2715 | ||
2716 | The argument @var{props} specifies which properties to delete. It | |
2717 | should have the form of a property list (@pxref{Property Lists}): a list | |
2718 | whose elements are property names alternating with corresponding values. | |
2719 | But only the names matter---the values that accompany them are ignored. | |
2720 | For example, here's how to remove the @code{face} property. | |
2721 | ||
2722 | @example | |
2723 | (remove-text-properties @var{start} @var{end} '(face nil)) | |
2724 | @end example | |
2725 | ||
2726 | The return value is @code{t} if the function actually changed some | |
2727 | property's value; @code{nil} otherwise (if @var{props} is @code{nil} or | |
2728 | if no character in the specified text had any of those properties). | |
e78ea3db RS |
2729 | |
2730 | To remove all text properties from certain text, use | |
2731 | @code{set-text-properties} and specify @code{nil} for the new property | |
2732 | list. | |
73804d4b RS |
2733 | @end defun |
2734 | ||
d73eac4d | 2735 | @defun remove-list-of-text-properties start end list-of-properties &optional object |
d69ea7ab | 2736 | Like @code{remove-text-properties} except that |
7fdc81ab | 2737 | @var{list-of-properties} is a list of property names only, not an |
d69ea7ab | 2738 | alternating list of property names and values. |
d73eac4d RS |
2739 | @end defun |
2740 | ||
73804d4b RS |
2741 | @defun set-text-properties start end props &optional object |
2742 | This function completely replaces the text property list for the text | |
2743 | between @var{start} and @var{end} in the string or buffer @var{object}. | |
2744 | If @var{object} is @code{nil}, it defaults to the current buffer. | |
2745 | ||
2746 | The argument @var{props} is the new property list. It should be a list | |
2747 | whose elements are property names alternating with corresponding values. | |
2748 | ||
2749 | After @code{set-text-properties} returns, all the characters in the | |
2750 | specified range have identical properties. | |
2751 | ||
2752 | If @var{props} is @code{nil}, the effect is to get rid of all properties | |
2753 | from the specified range of text. Here's an example: | |
2754 | ||
2755 | @example | |
2756 | (set-text-properties @var{start} @var{end} nil) | |
2757 | @end example | |
19bb7940 RS |
2758 | |
2759 | Do not rely on the return value of this function. | |
a40d4712 PR |
2760 | @end defun |
2761 | ||
2762 | The easiest way to make a string with text properties | |
2763 | is with @code{propertize}: | |
2764 | ||
2765 | @defun propertize string &rest properties | |
a40d4712 PR |
2766 | This function returns a copy of @var{string} which has the text |
2767 | properties @var{properties}. These properties apply to all the | |
2768 | characters in the string that is returned. Here is an example that | |
2769 | constructs a string with a @code{face} property and a @code{mouse-face} | |
2770 | property: | |
2771 | ||
2772 | @smallexample | |
2773 | (propertize "foo" 'face 'italic | |
2774 | 'mouse-face 'bold-italic) | |
2775 | @result{} #("foo" 0 3 (mouse-face bold-italic face italic)) | |
2776 | @end smallexample | |
2777 | ||
2778 | To put different properties on various parts of a string, you can | |
2779 | construct each part with @code{propertize} and then combine them with | |
2780 | @code{concat}: | |
2781 | ||
2782 | @smallexample | |
2783 | (concat | |
2784 | (propertize "foo" 'face 'italic | |
2785 | 'mouse-face 'bold-italic) | |
2786 | " and " | |
2787 | (propertize "bar" 'face 'italic | |
2788 | 'mouse-face 'bold-italic)) | |
2789 | @result{} #("foo and bar" | |
2790 | 0 3 (face italic mouse-face bold-italic) | |
2791 | 3 8 nil | |
2792 | 8 11 (face italic mouse-face bold-italic)) | |
2793 | @end smallexample | |
73804d4b RS |
2794 | @end defun |
2795 | ||
f9f59935 | 2796 | See also the function @code{buffer-substring-no-properties} |
22697dac KH |
2797 | (@pxref{Buffer Contents}) which copies text from the buffer |
2798 | but does not copy its properties. | |
2799 | ||
73804d4b | 2800 | @node Property Search |
f9f59935 | 2801 | @subsection Text Property Search Functions |
73804d4b | 2802 | |
f9f59935 | 2803 | In typical use of text properties, most of the time several or many |
73804d4b RS |
2804 | consecutive characters have the same value for a property. Rather than |
2805 | writing your programs to examine characters one by one, it is much | |
2806 | faster to process chunks of text that have the same property value. | |
2807 | ||
f9f59935 | 2808 | Here are functions you can use to do this. They use @code{eq} for |
bfe721d1 KH |
2809 | comparing property values. In all cases, @var{object} defaults to the |
2810 | current buffer. | |
73804d4b | 2811 | |
f9f59935 | 2812 | For high performance, it's very important to use the @var{limit} |
73804d4b | 2813 | argument to these functions, especially the ones that search for a |
bfe721d1 KH |
2814 | single property---otherwise, they may spend a long time scanning to the |
2815 | end of the buffer, if the property you are interested in does not change. | |
73804d4b | 2816 | |
f9f59935 RS |
2817 | These functions do not move point; instead, they return a position (or |
2818 | @code{nil}). Remember that a position is always between two characters; | |
2819 | the position returned by these functions is between two characters with | |
2820 | different properties. | |
61cfa852 | 2821 | |
73804d4b RS |
2822 | @defun next-property-change pos &optional object limit |
2823 | The function scans the text forward from position @var{pos} in the | |
2824 | string or buffer @var{object} till it finds a change in some text | |
2825 | property, then returns the position of the change. In other words, it | |
2826 | returns the position of the first character beyond @var{pos} whose | |
2827 | properties are not identical to those of the character just after | |
2828 | @var{pos}. | |
2829 | ||
2830 | If @var{limit} is non-@code{nil}, then the scan ends at position | |
177c0ea7 | 2831 | @var{limit}. If there is no property change before that point, |
73804d4b RS |
2832 | @code{next-property-change} returns @var{limit}. |
2833 | ||
2834 | The value is @code{nil} if the properties remain unchanged all the way | |
61cfa852 RS |
2835 | to the end of @var{object} and @var{limit} is @code{nil}. If the value |
2836 | is non-@code{nil}, it is a position greater than or equal to @var{pos}. | |
2837 | The value equals @var{pos} only when @var{limit} equals @var{pos}. | |
73804d4b RS |
2838 | |
2839 | Here is an example of how to scan the buffer by chunks of text within | |
2840 | which all properties are constant: | |
2841 | ||
2842 | @smallexample | |
2843 | (while (not (eobp)) | |
2844 | (let ((plist (text-properties-at (point))) | |
2845 | (next-change | |
2846 | (or (next-property-change (point) (current-buffer)) | |
2847 | (point-max)))) | |
2848 | @r{Process text from point to @var{next-change}@dots{}} | |
2849 | (goto-char next-change))) | |
2850 | @end smallexample | |
2851 | @end defun | |
2852 | ||
d735cf50 RS |
2853 | @defun previous-property-change pos &optional object limit |
2854 | This is like @code{next-property-change}, but scans back from @var{pos} | |
2855 | instead of forward. If the value is non-@code{nil}, it is a position | |
2856 | less than or equal to @var{pos}; it equals @var{pos} only if @var{limit} | |
2857 | equals @var{pos}. | |
2858 | @end defun | |
2859 | ||
73804d4b | 2860 | @defun next-single-property-change pos prop &optional object limit |
d735cf50 RS |
2861 | The function scans text for a change in the @var{prop} property, then |
2862 | returns the position of the change. The scan goes forward from | |
2863 | position @var{pos} in the string or buffer @var{object}. In other | |
2864 | words, this function returns the position of the first character | |
2865 | beyond @var{pos} whose @var{prop} property differs from that of the | |
2866 | character just after @var{pos}. | |
73804d4b RS |
2867 | |
2868 | If @var{limit} is non-@code{nil}, then the scan ends at position | |
177c0ea7 | 2869 | @var{limit}. If there is no property change before that point, |
73804d4b RS |
2870 | @code{next-single-property-change} returns @var{limit}. |
2871 | ||
2872 | The value is @code{nil} if the property remains unchanged all the way to | |
2873 | the end of @var{object} and @var{limit} is @code{nil}. If the value is | |
2874 | non-@code{nil}, it is a position greater than or equal to @var{pos}; it | |
2875 | equals @var{pos} only if @var{limit} equals @var{pos}. | |
2876 | @end defun | |
2877 | ||
73804d4b | 2878 | @defun previous-single-property-change pos prop &optional object limit |
61cfa852 RS |
2879 | This is like @code{next-single-property-change}, but scans back from |
2880 | @var{pos} instead of forward. If the value is non-@code{nil}, it is a | |
2881 | position less than or equal to @var{pos}; it equals @var{pos} only if | |
2882 | @var{limit} equals @var{pos}. | |
73804d4b RS |
2883 | @end defun |
2884 | ||
9db3a582 | 2885 | @defun next-char-property-change pos &optional limit |
f9f59935 | 2886 | This is like @code{next-property-change} except that it considers |
9db3a582 MB |
2887 | overlay properties as well as text properties, and if no change is |
2888 | found before the end of the buffer, it returns the maximum buffer | |
2889 | position rather than @code{nil} (in this sense, it resembles the | |
2890 | corresponding overlay function @code{next-overlay-change}, rather than | |
2891 | @code{next-property-change}). There is no @var{object} operand | |
2892 | because this function operates only on the current buffer. It returns | |
2893 | the next address at which either kind of property changes. | |
f9f59935 RS |
2894 | @end defun |
2895 | ||
9db3a582 | 2896 | @defun previous-char-property-change pos &optional limit |
f9f59935 | 2897 | This is like @code{next-char-property-change}, but scans back from |
9db3a582 MB |
2898 | @var{pos} instead of forward, and returns the minimum buffer |
2899 | position if no change is found. | |
2900 | @end defun | |
2901 | ||
2902 | @defun next-single-char-property-change pos prop &optional object limit | |
2903 | This is like @code{next-single-property-change} except that it | |
2904 | considers overlay properties as well as text properties, and if no | |
2905 | change is found before the end of the @var{object}, it returns the | |
2906 | maximum valid position in @var{object} rather than @code{nil}. Unlike | |
2907 | @code{next-char-property-change}, this function @emph{does} have an | |
2908 | @var{object} operand; if @var{object} is not a buffer, only | |
2909 | text-properties are considered. | |
2910 | @end defun | |
2911 | ||
2912 | @defun previous-single-char-property-change pos prop &optional object limit | |
2913 | This is like @code{next-single-char-property-change}, but scans back | |
2914 | from @var{pos} instead of forward, and returns the minimum valid | |
2915 | position in @var{object} if no change is found. | |
f9f59935 RS |
2916 | @end defun |
2917 | ||
73804d4b RS |
2918 | @defun text-property-any start end prop value &optional object |
2919 | This function returns non-@code{nil} if at least one character between | |
2920 | @var{start} and @var{end} has a property @var{prop} whose value is | |
2921 | @var{value}. More precisely, it returns the position of the first such | |
2922 | character. Otherwise, it returns @code{nil}. | |
2923 | ||
2924 | The optional fifth argument, @var{object}, specifies the string or | |
2925 | buffer to scan. Positions are relative to @var{object}. The default | |
2926 | for @var{object} is the current buffer. | |
2927 | @end defun | |
2928 | ||
2929 | @defun text-property-not-all start end prop value &optional object | |
2930 | This function returns non-@code{nil} if at least one character between | |
f9f59935 RS |
2931 | @var{start} and @var{end} does not have a property @var{prop} with value |
2932 | @var{value}. More precisely, it returns the position of the first such | |
2933 | character. Otherwise, it returns @code{nil}. | |
73804d4b RS |
2934 | |
2935 | The optional fifth argument, @var{object}, specifies the string or | |
2936 | buffer to scan. Positions are relative to @var{object}. The default | |
2937 | for @var{object} is the current buffer. | |
2938 | @end defun | |
2939 | ||
2940 | @node Special Properties | |
2941 | @subsection Properties with Special Meanings | |
2942 | ||
bfe721d1 | 2943 | Here is a table of text property names that have special built-in |
969fe9b5 RS |
2944 | meanings. The following sections list a few additional special property |
2945 | names that control filling and property inheritance. All other names | |
2946 | have no standard meaning, and you can use them as you like. | |
bfe721d1 | 2947 | |
73804d4b RS |
2948 | @table @code |
2949 | @cindex category of text character | |
2950 | @kindex category @r{(text property)} | |
2951 | @item category | |
2952 | If a character has a @code{category} property, we call it the | |
2953 | @dfn{category} of the character. It should be a symbol. The properties | |
2954 | of the symbol serve as defaults for the properties of the character. | |
2955 | ||
2956 | @item face | |
2957 | @cindex face codes of text | |
2958 | @kindex face @r{(text property)} | |
2959 | You can use the property @code{face} to control the font and color of | |
8241495d RS |
2960 | text. @xref{Faces}, for more information. |
2961 | ||
2962 | In the simplest case, the value is a face name. It can also be a list; | |
2963 | then each element can be any of these possibilities; | |
2964 | ||
2965 | @itemize @bullet | |
2966 | @item | |
2967 | A face name (a symbol or string). | |
f9f59935 | 2968 | |
8241495d | 2969 | @item |
de968ddb | 2970 | A property list of face attributes. This has the |
8241495d RS |
2971 | form (@var{keyword} @var{value} @dots{}), where each @var{keyword} is a |
2972 | face attribute name and @var{value} is a meaningful value for that | |
2973 | attribute. With this feature, you do not need to create a face each | |
2974 | time you want to specify a particular attribute for certain text. | |
2975 | @xref{Face Attributes}. | |
2976 | ||
2977 | @item | |
2978 | A cons cell of the form @code{(foreground-color . @var{color-name})} or | |
2979 | @code{(background-color . @var{color-name})}. These elements specify | |
69164016 EZ |
2980 | just the foreground color or just the background color. @xref{Color |
2981 | Names}, for the supported forms of @var{color-name}. | |
8241495d RS |
2982 | |
2983 | @code{(foreground-color . @var{color-name})} is equivalent to | |
342fd6cd RS |
2984 | specifying @code{(:foreground @var{color-name})}, and likewise for the |
2985 | background. | |
8241495d | 2986 | @end itemize |
f9f59935 | 2987 | |
1f63f814 CW |
2988 | You can use Font Lock Mode (@pxref{Font Lock Mode}), to dynamically |
2989 | update @code{face} properties based on the contents of the text. | |
2990 | ||
2991 | @item font-lock-face | |
2992 | @kindex font-lock-face @r{(text property)} | |
2993 | The @code{font-lock-face} property is the same in all respects as the | |
2994 | @code{face} property, but its state of activation is controlled by | |
2995 | @code{font-lock-mode}. This can be advantageous for special buffers | |
2996 | which are not intended to be user-editable, or for static areas of | |
2997 | text which are always fontified in the same way. | |
2998 | @xref{Precalculated Fontification}. | |
2999 | ||
3000 | Strictly speaking, @code{font-lock-face} is not a built-in text | |
3001 | property; rather, it is implemented in Font Lock mode using | |
3002 | @code{char-property-alias-alist}. @xref{Examining Properties}. | |
3003 | ||
bf247b6e | 3004 | This property is new in Emacs 22.1. |
73804d4b RS |
3005 | |
3006 | @item mouse-face | |
3007 | @kindex mouse-face @r{(text property)} | |
3008 | The property @code{mouse-face} is used instead of @code{face} when the | |
3009 | mouse is on or near the character. For this purpose, ``near'' means | |
3010 | that all text between the character and where the mouse is have the same | |
3011 | @code{mouse-face} property value. | |
3012 | ||
8241495d RS |
3013 | @item fontified |
3014 | @kindex fontified @r{(text property)} | |
f0b99db0 NR |
3015 | This property says whether the character has a face assigned to it by font |
3016 | locking. The display engine tests it to decide whether a buffer | |
e91d4202 | 3017 | portion needs refontifying before display. @xref{Auto Faces}. It |
f0b99db0 | 3018 | takes one of three values: |
e91d4202 AM |
3019 | |
3020 | @table @asis | |
3021 | @item @code{nil} | |
f0b99db0 NR |
3022 | Font locking is disabled, or the character's @code{face} property, if |
3023 | any, is invalid. | |
e91d4202 | 3024 | |
f0b99db0 | 3025 | @item @code{defer} |
c9abd530 NR |
3026 | This value is only used when ``just in time'' font locking is enabled |
3027 | and it means that the character's @code{face} property is invalid and | |
3028 | needs deferred fontification. | |
e91d4202 AM |
3029 | |
3030 | @item @code{t} | |
f0b99db0 | 3031 | The character's @code{face} property, or absence of one, is valid. |
e91d4202 | 3032 | @end table |
8241495d RS |
3033 | |
3034 | @item display | |
3035 | @kindex display @r{(text property)} | |
3036 | This property activates various features that change the | |
3037 | way text is displayed. For example, it can make text appear taller | |
75708135 | 3038 | or shorter, higher or lower, wider or narrow, or replaced with an image. |
8241495d RS |
3039 | @xref{Display Property}. |
3040 | ||
3041 | @item help-echo | |
3042 | @kindex help-echo @r{(text property)} | |
85378c3f | 3043 | @cindex tooltip |
b6dd5963 | 3044 | @anchor{Text help-echo} |
8241495d RS |
3045 | If text has a string as its @code{help-echo} property, then when you |
3046 | move the mouse onto that text, Emacs displays that string in the echo | |
85378c3f RS |
3047 | area, or in the tooltip window (@pxref{Tooltips,,, emacs, The GNU Emacs |
3048 | Manual}). | |
b6dd5963 | 3049 | |
05cae5d0 | 3050 | If the value of the @code{help-echo} property is a function, that |
b6dd5963 | 3051 | function is called with three arguments, @var{window}, @var{object} and |
ef6938c5 | 3052 | @var{pos} and should return a help string or @code{nil} for |
b6dd5963 DL |
3053 | none. The first argument, @var{window} is the window in which |
3054 | the help was found. The second, @var{object}, is the buffer, overlay or | |
ef6938c5 | 3055 | string which had the @code{help-echo} property. The @var{pos} |
b6dd5963 DL |
3056 | argument is as follows: |
3057 | ||
3058 | @itemize @bullet{} | |
3059 | @item | |
f0b99db0 | 3060 | If @var{object} is a buffer, @var{pos} is the position in the buffer. |
b6dd5963 DL |
3061 | @item |
3062 | If @var{object} is an overlay, that overlay has a @code{help-echo} | |
f0b99db0 | 3063 | property, and @var{pos} is the position in the overlay's buffer. |
b6dd5963 DL |
3064 | @item |
3065 | If @var{object} is a string (an overlay string or a string displayed | |
05cae5d0 | 3066 | with the @code{display} property), @var{pos} is the position in that |
f0b99db0 | 3067 | string. |
b6dd5963 DL |
3068 | @end itemize |
3069 | ||
3070 | If the value of the @code{help-echo} property is neither a function nor | |
3071 | a string, it is evaluated to obtain a help string. | |
3072 | ||
05cae5d0 DL |
3073 | You can alter the way help text is displayed by setting the variable |
3074 | @code{show-help-function} (@pxref{Help display}). | |
b6dd5963 | 3075 | |
2e46cd09 | 3076 | This feature is used in the mode line and for other active text. |
8241495d | 3077 | |
0b3da4ec | 3078 | @item keymap |
1bd2023a | 3079 | @cindex keymap of character |
0b3da4ec | 3080 | @kindex keymap @r{(text property)} |
1bd2023a | 3081 | The @code{keymap} property specifies an additional keymap for |
41332983 RS |
3082 | commands. The property's value for the character before point applies |
3083 | if it is non-@code{nil} and rear-sticky, and the property's value for | |
3084 | the character after point applies if it is non-@code{nil} and | |
6fac48b3 RS |
3085 | front-sticky. (For mouse clicks, the position of the click is used |
3086 | instead of the position of point.) If the property value is a symbol, | |
3087 | the symbol's function definition is used as the keymap. | |
3088 | ||
3089 | When this keymap applies, it is used for key lookup before the minor | |
3090 | mode keymaps and before the buffer's local map. @xref{Active | |
3091 | Keymaps}. | |
1bd2023a RS |
3092 | |
3093 | @item local-map | |
3094 | @kindex local-map @r{(text property)} | |
41332983 RS |
3095 | This property works like @code{keymap} except that it specifies a |
3096 | keymap to use @emph{instead of} the buffer's local map. For most | |
3097 | purposes (perhaps all purposes), the @code{keymap} is superior. | |
0b3da4ec | 3098 | |
f9f59935 RS |
3099 | @item syntax-table |
3100 | The @code{syntax-table} property overrides what the syntax table says | |
3101 | about this particular character. @xref{Syntax Properties}. | |
73804d4b RS |
3102 | |
3103 | @item read-only | |
3104 | @cindex read-only character | |
3105 | @kindex read-only @r{(text property)} | |
3106 | If a character has the property @code{read-only}, then modifying that | |
2468d0c0 | 3107 | character is not allowed. Any command that would do so gets an error, |
55111a56 RS |
3108 | @code{text-read-only}. If the property value is a string, that string |
3109 | is used as the error message. | |
73804d4b RS |
3110 | |
3111 | Insertion next to a read-only character is an error if inserting | |
3112 | ordinary text there would inherit the @code{read-only} property due to | |
3113 | stickiness. Thus, you can control permission to insert next to | |
3114 | read-only text by controlling the stickiness. @xref{Sticky Properties}. | |
3115 | ||
3116 | Since changing properties counts as modifying the buffer, it is not | |
3117 | possible to remove a @code{read-only} property unless you know the | |
3118 | special trick: bind @code{inhibit-read-only} to a non-@code{nil} value | |
3119 | and then remove the property. @xref{Read Only Buffers}. | |
3120 | ||
3121 | @item invisible | |
3122 | @kindex invisible @r{(text property)} | |
22697dac KH |
3123 | A non-@code{nil} @code{invisible} property can make a character invisible |
3124 | on the screen. @xref{Invisible Text}, for details. | |
73804d4b | 3125 | |
72654a3c RS |
3126 | @item intangible |
3127 | @kindex intangible @r{(text property)} | |
22697dac KH |
3128 | If a group of consecutive characters have equal and non-@code{nil} |
3129 | @code{intangible} properties, then you cannot place point between them. | |
bfe721d1 KH |
3130 | If you try to move point forward into the group, point actually moves to |
3131 | the end of the group. If you try to move point backward into the group, | |
22697dac KH |
3132 | point actually moves to the start of the group. |
3133 | ||
3134 | When the variable @code{inhibit-point-motion-hooks} is non-@code{nil}, | |
3135 | the @code{intangible} property is ignored. | |
72654a3c | 3136 | |
2468d0c0 DL |
3137 | @item field |
3138 | @kindex field @r{(text property)} | |
3139 | Consecutive characters with the same @code{field} property constitute a | |
3140 | @dfn{field}. Some motion functions including @code{forward-word} and | |
3141 | @code{beginning-of-line} stop moving at a field boundary. | |
3142 | @xref{Fields}. | |
3143 | ||
a10db310 KS |
3144 | @item cursor |
3145 | @kindex cursor @r{(text property)} | |
3146 | Normally, the cursor is displayed at the end of any overlay and text | |
7d252e6b RS |
3147 | property strings present at the current window position. You can |
3148 | place the cursor on any desired character of these strings by giving | |
a10db310 KS |
3149 | that character a non-@code{nil} @var{cursor} text property. |
3150 | ||
3151 | @item pointer | |
3152 | @kindex pointer @r{(text property)} | |
3153 | This specifies a specific pointer shape when the mouse pointer is over | |
9d42ffaa LK |
3154 | this text or image. @xref{Pointer Shape}, for possible pointer |
3155 | shapes. | |
a10db310 | 3156 | |
7d252e6b RS |
3157 | @item line-spacing |
3158 | @kindex line-spacing @r{(text property)} | |
4676d6f3 RS |
3159 | A newline can have a @code{line-spacing} text or overlay property that |
3160 | controls the height of the display line ending with that newline. The | |
3161 | property value overrides the default frame line spacing and the buffer | |
a71fe68f | 3162 | local @code{line-spacing} variable. @xref{Line Height}. |
7d252e6b | 3163 | |
a10db310 KS |
3164 | @item line-height |
3165 | @kindex line-height @r{(text property)} | |
7d252e6b | 3166 | A newline can have a @code{line-height} text or overlay property that |
4676d6f3 | 3167 | controls the total height of the display line ending in that newline. |
a71fe68f | 3168 | @xref{Line Height}. |
a10db310 | 3169 | |
73804d4b RS |
3170 | @item modification-hooks |
3171 | @cindex change hooks for a character | |
3172 | @cindex hooks for changing a character | |
3173 | @kindex modification-hooks @r{(text property)} | |
3174 | If a character has the property @code{modification-hooks}, then its | |
3175 | value should be a list of functions; modifying that character calls all | |
3176 | of those functions. Each function receives two arguments: the beginning | |
3177 | and end of the part of the buffer being modified. Note that if a | |
3178 | particular modification hook function appears on several characters | |
3179 | being modified by a single primitive, you can't predict how many times | |
3180 | the function will be called. | |
3181 | ||
fbbad95f RS |
3182 | If these functions modify the buffer, they should bind |
3183 | @code{inhibit-modification-hooks} to @code{t} around doing so, to | |
3184 | avoid confusing the internal mechanism that calls these hooks. | |
3185 | ||
73804d4b RS |
3186 | @item insert-in-front-hooks |
3187 | @itemx insert-behind-hooks | |
3188 | @kindex insert-in-front-hooks @r{(text property)} | |
3189 | @kindex insert-behind-hooks @r{(text property)} | |
9ea65df9 RS |
3190 | The operation of inserting text in a buffer also calls the functions |
3191 | listed in the @code{insert-in-front-hooks} property of the following | |
3192 | character and in the @code{insert-behind-hooks} property of the | |
3193 | preceding character. These functions receive two arguments, the | |
3194 | beginning and end of the inserted text. The functions are called | |
3195 | @emph{after} the actual insertion takes place. | |
73804d4b RS |
3196 | |
3197 | See also @ref{Change Hooks}, for other hooks that are called | |
3198 | when you change text in a buffer. | |
3199 | ||
3200 | @item point-entered | |
3201 | @itemx point-left | |
3202 | @cindex hooks for motion of point | |
3203 | @kindex point-entered @r{(text property)} | |
3204 | @kindex point-left @r{(text property)} | |
3205 | The special properties @code{point-entered} and @code{point-left} | |
3206 | record hook functions that report motion of point. Each time point | |
3207 | moves, Emacs compares these two property values: | |
3208 | ||
3209 | @itemize @bullet | |
3210 | @item | |
3211 | the @code{point-left} property of the character after the old location, | |
3212 | and | |
3213 | @item | |
3214 | the @code{point-entered} property of the character after the new | |
3215 | location. | |
3216 | @end itemize | |
3217 | ||
3218 | @noindent | |
3219 | If these two values differ, each of them is called (if not @code{nil}) | |
3220 | with two arguments: the old value of point, and the new one. | |
3221 | ||
3222 | The same comparison is made for the characters before the old and new | |
3223 | locations. The result may be to execute two @code{point-left} functions | |
3224 | (which may be the same function) and/or two @code{point-entered} | |
61cfa852 RS |
3225 | functions (which may be the same function). In any case, all the |
3226 | @code{point-left} functions are called first, followed by all the | |
3227 | @code{point-entered} functions. | |
73804d4b | 3228 | |
2a233172 RS |
3229 | It is possible with @code{char-after} to examine characters at various |
3230 | buffer positions without moving point to those positions. Only an | |
3231 | actual change in the value of point runs these hook functions. | |
73804d4b RS |
3232 | @end table |
3233 | ||
3234 | @defvar inhibit-point-motion-hooks | |
3235 | When this variable is non-@code{nil}, @code{point-left} and | |
22697dac | 3236 | @code{point-entered} hooks are not run, and the @code{intangible} |
f9f59935 RS |
3237 | property has no effect. Do not set this variable globally; bind it with |
3238 | @code{let}. | |
73804d4b RS |
3239 | @end defvar |
3240 | ||
b6dd5963 | 3241 | @defvar show-help-function |
05cae5d0 DL |
3242 | @anchor{Help display} If this variable is non-@code{nil}, it specifies a |
3243 | function called to display help strings. These may be @code{help-echo} | |
3244 | properties, menu help strings (@pxref{Simple Menu Items}, | |
3245 | @pxref{Extended Menu Items}), or tool bar help strings (@pxref{Tool | |
3246 | Bar}). The specified function is called with one argument, the help | |
0b2fb045 WL |
3247 | string to display. Tooltip mode (@pxref{Tooltips,,, emacs, The GNU Emacs |
3248 | Manual}) provides an example. | |
b6dd5963 DL |
3249 | @end defvar |
3250 | ||
22697dac | 3251 | @node Format Properties |
bfe721d1 | 3252 | @subsection Formatted Text Properties |
22697dac KH |
3253 | |
3254 | These text properties affect the behavior of the fill commands. They | |
bfe721d1 KH |
3255 | are used for representing formatted text. @xref{Filling}, and |
3256 | @ref{Margins}. | |
22697dac | 3257 | |
bfe721d1 | 3258 | @table @code |
22697dac KH |
3259 | @item hard |
3260 | If a newline character has this property, it is a ``hard'' newline. | |
3261 | The fill commands do not alter hard newlines and do not move words | |
b471b8e9 RS |
3262 | across them. However, this property takes effect only if the |
3263 | @code{use-hard-newlines} minor mode is enabled. @xref{Hard and Soft | |
3264 | Newlines,, Hard and Soft Newlines, emacs, The GNU Emacs Manual}. | |
22697dac KH |
3265 | |
3266 | @item right-margin | |
bfe721d1 | 3267 | This property specifies an extra right margin for filling this part of the |
22697dac KH |
3268 | text. |
3269 | ||
3270 | @item left-margin | |
bfe721d1 | 3271 | This property specifies an extra left margin for filling this part of the |
22697dac KH |
3272 | text. |
3273 | ||
3274 | @item justification | |
3275 | This property specifies the style of justification for filling this part | |
3276 | of the text. | |
3277 | @end table | |
3278 | ||
73804d4b RS |
3279 | @node Sticky Properties |
3280 | @subsection Stickiness of Text Properties | |
3281 | @cindex sticky text properties | |
3282 | @cindex inheritance of text properties | |
3283 | ||
3284 | Self-inserting characters normally take on the same properties as the | |
3285 | preceding character. This is called @dfn{inheritance} of properties. | |
3286 | ||
3287 | In a Lisp program, you can do insertion with inheritance or without, | |
3288 | depending on your choice of insertion primitive. The ordinary text | |
3289 | insertion functions such as @code{insert} do not inherit any properties. | |
3290 | They insert text with precisely the properties of the string being | |
3291 | inserted, and no others. This is correct for programs that copy text | |
61cfa852 RS |
3292 | from one context to another---for example, into or out of the kill ring. |
3293 | To insert with inheritance, use the special primitives described in this | |
3294 | section. Self-inserting characters inherit properties because they work | |
3295 | using these primitives. | |
73804d4b RS |
3296 | |
3297 | When you do insertion with inheritance, @emph{which} properties are | |
2468d0c0 DL |
3298 | inherited, and from where, depends on which properties are @dfn{sticky}. |
3299 | Insertion after a character inherits those of its properties that are | |
73804d4b | 3300 | @dfn{rear-sticky}. Insertion before a character inherits those of its |
2468d0c0 DL |
3301 | properties that are @dfn{front-sticky}. When both sides offer different |
3302 | sticky values for the same property, the previous character's value | |
3303 | takes precedence. | |
3304 | ||
3305 | By default, a text property is rear-sticky but not front-sticky; thus, | |
3306 | the default is to inherit all the properties of the preceding character, | |
3307 | and nothing from the following character. | |
3308 | ||
3309 | You can control the stickiness of various text properties with two | |
3310 | specific text properties, @code{front-sticky} and @code{rear-nonsticky}, | |
3311 | and with the variable @code{text-property-default-nonsticky}. You can | |
3312 | use the variable to specify a different default for a given property. | |
3313 | You can use those two text properties to make any specific properties | |
3314 | sticky or nonsticky in any particular part of the text. | |
73804d4b RS |
3315 | |
3316 | If a character's @code{front-sticky} property is @code{t}, then all | |
3317 | its properties are front-sticky. If the @code{front-sticky} property is | |
3318 | a list, then the sticky properties of the character are those whose | |
3319 | names are in the list. For example, if a character has a | |
3320 | @code{front-sticky} property whose value is @code{(face read-only)}, | |
3321 | then insertion before the character can inherit its @code{face} property | |
3322 | and its @code{read-only} property, but no others. | |
3323 | ||
75708135 RS |
3324 | The @code{rear-nonsticky} property works the opposite way. Most |
3325 | properties are rear-sticky by default, so the @code{rear-nonsticky} | |
3326 | property says which properties are @emph{not} rear-sticky. If a | |
3327 | character's @code{rear-nonsticky} property is @code{t}, then none of its | |
3328 | properties are rear-sticky. If the @code{rear-nonsticky} property is a | |
3329 | list, properties are rear-sticky @emph{unless} their names are in the | |
3330 | list. | |
73804d4b | 3331 | |
2468d0c0 | 3332 | @defvar text-property-default-nonsticky |
2468d0c0 DL |
3333 | This variable holds an alist which defines the default rear-stickiness |
3334 | of various text properties. Each element has the form | |
3335 | @code{(@var{property} . @var{nonstickiness})}, and it defines the | |
3336 | stickiness of a particular text property, @var{property}. | |
3337 | ||
3338 | If @var{nonstickiness} is non-@code{nil}, this means that the property | |
3339 | @var{property} is rear-nonsticky by default. Since all properties are | |
3340 | front-nonsticky by default, this makes @var{property} nonsticky in both | |
3341 | directions by default. | |
3342 | ||
3343 | The text properties @code{front-sticky} and @code{rear-nonsticky}, when | |
8b6c1445 | 3344 | used, take precedence over the default @var{nonstickiness} specified in |
2468d0c0 DL |
3345 | @code{text-property-default-nonsticky}. |
3346 | @end defvar | |
73804d4b RS |
3347 | |
3348 | Here are the functions that insert text with inheritance of properties: | |
3349 | ||
3350 | @defun insert-and-inherit &rest strings | |
3351 | Insert the strings @var{strings}, just like the function @code{insert}, | |
3352 | but inherit any sticky properties from the adjoining text. | |
3353 | @end defun | |
3354 | ||
3355 | @defun insert-before-markers-and-inherit &rest strings | |
3356 | Insert the strings @var{strings}, just like the function | |
3357 | @code{insert-before-markers}, but inherit any sticky properties from the | |
3358 | adjoining text. | |
3359 | @end defun | |
3360 | ||
f9f59935 RS |
3361 | @xref{Insertion}, for the ordinary insertion functions which do not |
3362 | inherit. | |
3363 | ||
73804d4b | 3364 | @node Saving Properties |
61cfa852 | 3365 | @subsection Saving Text Properties in Files |
73804d4b RS |
3366 | @cindex text properties in files |
3367 | @cindex saving text properties | |
3368 | ||
f9f59935 RS |
3369 | You can save text properties in files (along with the text itself), |
3370 | and restore the same text properties when visiting or inserting the | |
3371 | files, using these two hooks: | |
73804d4b | 3372 | |
bfe721d1 | 3373 | @defvar write-region-annotate-functions |
73804d4b RS |
3374 | This variable's value is a list of functions for @code{write-region} to |
3375 | run to encode text properties in some fashion as annotations to the text | |
3376 | being written in the file. @xref{Writing to Files}. | |
3377 | ||
3378 | Each function in the list is called with two arguments: the start and | |
3379 | end of the region to be written. These functions should not alter the | |
3380 | contents of the buffer. Instead, they should return lists indicating | |
3381 | annotations to write in the file in addition to the text in the | |
3382 | buffer. | |
3383 | ||
3384 | Each function should return a list of elements of the form | |
3385 | @code{(@var{position} . @var{string})}, where @var{position} is an | |
f9f59935 RS |
3386 | integer specifying the relative position within the text to be written, |
3387 | and @var{string} is the annotation to add there. | |
73804d4b RS |
3388 | |
3389 | Each list returned by one of these functions must be already sorted in | |
3390 | increasing order by @var{position}. If there is more than one function, | |
3391 | @code{write-region} merges the lists destructively into one sorted list. | |
3392 | ||
3393 | When @code{write-region} actually writes the text from the buffer to the | |
3394 | file, it intermixes the specified annotations at the corresponding | |
3395 | positions. All this takes place without modifying the buffer. | |
3396 | @end defvar | |
3397 | ||
3398 | @defvar after-insert-file-functions | |
3399 | This variable holds a list of functions for @code{insert-file-contents} | |
3400 | to call after inserting a file's contents. These functions should scan | |
3401 | the inserted text for annotations, and convert them to the text | |
3402 | properties they stand for. | |
3403 | ||
3404 | Each function receives one argument, the length of the inserted text; | |
3405 | point indicates the start of that text. The function should scan that | |
3406 | text for annotations, delete them, and create the text properties that | |
3407 | the annotations specify. The function should return the updated length | |
3408 | of the inserted text, as it stands after those changes. The value | |
3409 | returned by one function becomes the argument to the next function. | |
3410 | ||
3411 | These functions should always return with point at the beginning of | |
3412 | the inserted text. | |
3413 | ||
3414 | The intended use of @code{after-insert-file-functions} is for converting | |
3415 | some sort of textual annotations into actual text properties. But other | |
3416 | uses may be possible. | |
3417 | @end defvar | |
3418 | ||
3419 | We invite users to write Lisp programs to store and retrieve text | |
3420 | properties in files, using these hooks, and thus to experiment with | |
177c0ea7 | 3421 | various data formats and find good ones. Eventually we hope users |
73804d4b RS |
3422 | will produce good, general extensions we can install in Emacs. |
3423 | ||
f9f59935 RS |
3424 | We suggest not trying to handle arbitrary Lisp objects as text property |
3425 | names or values---because a program that general is probably difficult | |
3426 | to write, and slow. Instead, choose a set of possible data types that | |
3427 | are reasonably flexible, and not too hard to encode. | |
73804d4b | 3428 | |
bfe721d1 KH |
3429 | @xref{Format Conversion}, for a related feature. |
3430 | ||
3431 | @c ??? In next edition, merge this info Format Conversion. | |
3432 | ||
61ee3601 RS |
3433 | @node Lazy Properties |
3434 | @subsection Lazy Computation of Text Properties | |
3435 | ||
3436 | Instead of computing text properties for all the text in the buffer, | |
3437 | you can arrange to compute the text properties for parts of the text | |
3438 | when and if something depends on them. | |
3439 | ||
3440 | The primitive that extracts text from the buffer along with its | |
3441 | properties is @code{buffer-substring}. Before examining the properties, | |
3442 | this function runs the abnormal hook @code{buffer-access-fontify-functions}. | |
3443 | ||
3444 | @defvar buffer-access-fontify-functions | |
3445 | This variable holds a list of functions for computing text properties. | |
3446 | Before @code{buffer-substring} copies the text and text properties for a | |
3447 | portion of the buffer, it calls all the functions in this list. Each of | |
3448 | the functions receives two arguments that specify the range of the | |
3449 | buffer being accessed. (The buffer itself is always the current | |
3450 | buffer.) | |
3451 | @end defvar | |
3452 | ||
3453 | The function @code{buffer-substring-no-properties} does not call these | |
3454 | functions, since it ignores text properties anyway. | |
3455 | ||
3456 | In order to prevent the hook functions from being called more than | |
3457 | once for the same part of the buffer, you can use the variable | |
3458 | @code{buffer-access-fontified-property}. | |
3459 | ||
3460 | @defvar buffer-access-fontified-property | |
3461 | If this value's variable is non-@code{nil}, it is a symbol which is used | |
3462 | as a text property name. A non-@code{nil} value for that text property | |
3463 | means, ``the other text properties for this character have already been | |
3464 | computed.'' | |
3465 | ||
3466 | If all the characters in the range specified for @code{buffer-substring} | |
3467 | have a non-@code{nil} value for this property, @code{buffer-substring} | |
3468 | does not call the @code{buffer-access-fontify-functions} functions. It | |
3469 | assumes these characters already have the right text properties, and | |
3470 | just copies the properties they already have. | |
3471 | ||
3472 | The normal way to use this feature is that the | |
3473 | @code{buffer-access-fontify-functions} functions add this property, as | |
3474 | well as others, to the characters they operate on. That way, they avoid | |
3475 | being called over and over for the same text. | |
3476 | @end defvar | |
3477 | ||
f9f59935 RS |
3478 | @node Clickable Text |
3479 | @subsection Defining Clickable Text | |
3480 | @cindex clickable text | |
3481 | ||
5ac64732 | 3482 | There are two parts of setting up @dfn{clickable text} in a buffer: |
fc0ba1d0 | 3483 | (1) to indicate clickability when the mouse moves over the text, and (2) |
5ac64732 | 3484 | to make a mouse button do something when you click on that text. |
f9f59935 | 3485 | |
fc0ba1d0 TTN |
3486 | Indicating clickability usually involves highlighting the text, and |
3487 | often involves displaying helpful information about the action, such | |
3488 | as which mouse button to press, or a short summary of the action. | |
3489 | This can be done with the @code{mouse-face} and @code{help-echo} | |
3490 | text properties. @xref{Special Properties}. | |
3491 | Here is an example of how Dired does it: | |
f9f59935 RS |
3492 | |
3493 | @smallexample | |
3494 | (condition-case nil | |
3495 | (if (dired-move-to-filename) | |
fc0ba1d0 TTN |
3496 | (add-text-properties |
3497 | (point) | |
3498 | (save-excursion | |
3499 | (dired-move-to-end-of-filename) | |
3500 | (point)) | |
3501 | '(mouse-face highlight | |
3502 | help-echo "mouse-2: visit this file in other window"))) | |
f9f59935 RS |
3503 | (error nil)) |
3504 | @end smallexample | |
3505 | ||
3506 | @noindent | |
fc0ba1d0 | 3507 | The first two arguments to @code{add-text-properties} specify the |
f9f59935 RS |
3508 | beginning and end of the text. |
3509 | ||
3510 | The usual way to make the mouse do something when you click it | |
3511 | on this text is to define @code{mouse-2} in the major mode's | |
3512 | keymap. The job of checking whether the click was on clickable text | |
3513 | is done by the command definition. Here is how Dired does it: | |
3514 | ||
3515 | @smallexample | |
3516 | (defun dired-mouse-find-file-other-window (event) | |
fc0ba1d0 | 3517 | "In Dired, visit the file or directory name you click on." |
f9f59935 | 3518 | (interactive "e") |
fc0ba1d0 | 3519 | (let (window pos file) |
f9f59935 | 3520 | (save-excursion |
fc0ba1d0 TTN |
3521 | (setq window (posn-window (event-end event)) |
3522 | pos (posn-point (event-end event))) | |
3523 | (if (not (windowp window)) | |
3524 | (error "No file chosen")) | |
3525 | (set-buffer (window-buffer window)) | |
3526 | (goto-char pos) | |
3527 | (setq file (dired-get-file-for-visit))) | |
3528 | (if (file-directory-p file) | |
3529 | (or (and (cdr dired-subdir-alist) | |
3530 | (dired-goto-subdir file)) | |
3531 | (progn | |
3532 | (select-window window) | |
3533 | (dired-other-window file))) | |
3534 | (select-window window) | |
3535 | (find-file-other-window (file-name-sans-versions file t))))) | |
f9f59935 RS |
3536 | @end smallexample |
3537 | ||
3538 | @noindent | |
fc0ba1d0 TTN |
3539 | The reason for the @code{save-excursion} construct is to avoid |
3540 | changing the current buffer. In this case, | |
3541 | Dired uses the functions @code{posn-window} and @code{posn-point} | |
3542 | to determine which buffer the click happened in and where, and | |
3543 | in that buffer, @code{dired-get-file-for-visit} to determine which | |
3544 | file to visit. | |
f9f59935 RS |
3545 | |
3546 | Instead of defining a mouse command for the major mode, you can define | |
c26a99e8 | 3547 | a key binding for the clickable text itself, using the @code{keymap} |
ce75fd23 | 3548 | text property: |
f9f59935 RS |
3549 | |
3550 | @example | |
3551 | (let ((map (make-sparse-keymap))) | |
c26a99e8 | 3552 | (define-key map [mouse-2] 'operate-this-button) |
f9f59935 RS |
3553 | (put-text-property (point) |
3554 | (save-excursion | |
3555 | (dired-move-to-end-of-filename) | |
3556 | (point)) | |
c26a99e8 | 3557 | 'keymap map)) |
f9f59935 RS |
3558 | @end example |
3559 | ||
3560 | @noindent | |
3561 | This method makes it possible to define different commands for various | |
3562 | clickable pieces of text. Also, the major mode definition (or the | |
3563 | global definition) remains available for the rest of the text in the | |
3564 | buffer. | |
3565 | ||
5364b27c KS |
3566 | @node Links and Mouse-1 |
3567 | @subsection Links and Mouse-1 | |
9bcb9ab0 | 3568 | @cindex follow links |
5364b27c | 3569 | @cindex mouse-1 |
9bcb9ab0 | 3570 | |
b503de76 RS |
3571 | The normal Emacs command for activating text in read-only buffers is |
3572 | @key{Mouse-2}, which includes following textual links. However, most | |
3573 | graphical applications use @key{Mouse-1} for following links. For | |
3574 | compatibility, @key{Mouse-1} follows links in Emacs too, when you | |
3575 | click on a link quickly without moving the mouse. The user can | |
f3b11af5 | 3576 | customize this behavior through the variable |
b503de76 RS |
3577 | @code{mouse-1-click-follows-link}. |
3578 | ||
5364b27c | 3579 | To define text as a link at the Lisp level, you should bind the |
cf819102 RS |
3580 | @code{mouse-2} event to a command to follow the link. Then, to indicate that |
3581 | @key{Mouse-1} should also follow the link, you should specify a | |
3582 | @code{follow-link} condition either as a text property or as a key | |
3583 | binding: | |
9bcb9ab0 KS |
3584 | |
3585 | @table @asis | |
b503de76 RS |
3586 | @item @code{follow-link} property |
3587 | If the clickable text has a non-@code{nil} @code{follow-link} text or overlay | |
cf819102 | 3588 | property, that specifies the condition. |
9bcb9ab0 | 3589 | |
b503de76 | 3590 | @item @code{follow-link} event |
cf819102 RS |
3591 | If there is a binding for the @code{follow-link} event, either on the |
3592 | clickable text or in the local keymap, the binding is the condition. | |
b503de76 | 3593 | @end table |
9bcb9ab0 | 3594 | |
cf819102 RS |
3595 | Regardless of how you set the @code{follow-link} condition, its |
3596 | value is used as follows to determine whether the given position is | |
3597 | inside a link, and (if so) to compute an @dfn{action code} saying how | |
3598 | @key{Mouse-1} should handle the link. | |
9bcb9ab0 | 3599 | |
b503de76 RS |
3600 | @table @asis |
3601 | @item @code{mouse-face} | |
cf819102 | 3602 | If the condition is @code{mouse-face}, a position is inside a link if |
b503de76 RS |
3603 | there is a non-@code{nil} @code{mouse-face} property at that position. |
3604 | The action code is always @code{t}. | |
9bcb9ab0 | 3605 | |
b503de76 | 3606 | For example, here is how Info mode handles @key{Mouse-1}: |
9bcb9ab0 | 3607 | |
342fd6cd | 3608 | @smallexample |
9bcb9ab0 | 3609 | (define-key Info-mode-map [follow-link] 'mouse-face) |
342fd6cd | 3610 | @end smallexample |
9bcb9ab0 KS |
3611 | |
3612 | @item a function | |
cf819102 RS |
3613 | If the condition is a valid function, @var{func}, then a position |
3614 | @var{pos} is inside a link if @code{(@var{func} @var{pos})} evaluates | |
3615 | to non-@code{nil}. The value returned by @var{func} serves as the | |
3616 | action code. | |
9bcb9ab0 | 3617 | |
b503de76 RS |
3618 | For example, here is how pcvs enables @key{Mouse-1} to follow links on |
3619 | file names only: | |
9bcb9ab0 | 3620 | |
342fd6cd | 3621 | @smallexample |
9bcb9ab0 KS |
3622 | (define-key map [follow-link] |
3623 | (lambda (pos) | |
342fd6cd RS |
3624 | (eq (get-char-property pos 'face) 'cvs-filename-face))) |
3625 | @end smallexample | |
9bcb9ab0 | 3626 | |
b503de76 | 3627 | @item anything else |
cf819102 RS |
3628 | If the condition value is anything else, then the position is inside a |
3629 | link and the condition itself is the action code. Clearly you should | |
3630 | only specify this kind of condition on the text that constitutes a | |
3631 | link. | |
9bcb9ab0 KS |
3632 | @end table |
3633 | ||
3634 | @noindent | |
cf819102 | 3635 | The action code tells @key{Mouse-1} how to follow the link: |
9bcb9ab0 KS |
3636 | |
3637 | @table @asis | |
1b1c49e1 | 3638 | @item a string or vector |
cf819102 RS |
3639 | If the action code is a string or vector, the @key{Mouse-1} event is |
3640 | translated into the first element of the string or vector; i.e., the | |
3641 | action of the @key{Mouse-1} click is the local or global binding of | |
1b1c49e1 | 3642 | that character or symbol. Thus, if the action code is @code{"foo"}, |
cf819102 RS |
3643 | @key{Mouse-1} translates into @kbd{f}. If it is @code{[foo]}, |
3644 | @key{Mouse-1} translates into @key{foo}. | |
b503de76 RS |
3645 | |
3646 | @item anything else | |
3647 | For any other non-@code{nil} action code, the @code{mouse-1} event is | |
3648 | translated into a @code{mouse-2} event at the same position. | |
9bcb9ab0 KS |
3649 | @end table |
3650 | ||
b503de76 RS |
3651 | To define @key{Mouse-1} to activate a button defined with |
3652 | @code{define-button-type}, give the button a @code{follow-link} | |
3653 | property with a value as specified above to determine how to follow | |
5364b27c KS |
3654 | the link. For example, here is how Help mode handles @key{Mouse-1}: |
3655 | ||
3656 | @smallexample | |
3657 | (define-button-type 'help-xref | |
3658 | 'follow-link t | |
3659 | 'action #'help-button-action) | |
3660 | @end smallexample | |
9bcb9ab0 | 3661 | |
b503de76 RS |
3662 | To define @key{Mouse-1} on a widget defined with |
3663 | @code{define-widget}, give the widget a @code{:follow-link} property | |
3664 | with a value as specified above to determine how to follow the link. | |
5364b27c KS |
3665 | |
3666 | For example, here is how the @code{link} widget specifies that | |
3667 | a @key{Mouse-1} click shall be translated to @key{RET}: | |
3668 | ||
3669 | @smallexample | |
3670 | (define-widget 'link 'item | |
3671 | "An embedded link." | |
3672 | :button-prefix 'widget-link-prefix | |
3673 | :button-suffix 'widget-link-suffix | |
3674 | :follow-link "\C-m" | |
3675 | :help-echo "Follow the link." | |
3676 | :format "%[%t%]") | |
3677 | @end smallexample | |
9bcb9ab0 KS |
3678 | |
3679 | @defun mouse-on-link-p pos | |
b503de76 | 3680 | This function returns non-@code{nil} if position @var{pos} in the |
faad80bf TTN |
3681 | current buffer is on a link. @var{pos} can also be a mouse event |
3682 | location, as returned by @code{event-start} (@pxref{Accessing Events}). | |
9bcb9ab0 KS |
3683 | @end defun |
3684 | ||
2468d0c0 DL |
3685 | @node Fields |
3686 | @subsection Defining and Using Fields | |
3687 | @cindex fields | |
3688 | ||
3689 | A field is a range of consecutive characters in the buffer that are | |
3690 | identified by having the same value (comparing with @code{eq}) of the | |
35627f72 MB |
3691 | @code{field} property (either a text-property or an overlay property). |
3692 | This section describes special functions that are available for | |
3693 | operating on fields. | |
2468d0c0 DL |
3694 | |
3695 | You specify a field with a buffer position, @var{pos}. We think of | |
3696 | each field as containing a range of buffer positions, so the position | |
3697 | you specify stands for the field containing that position. | |
3698 | ||
3699 | When the characters before and after @var{pos} are part of the same | |
3700 | field, there is no doubt which field contains @var{pos}: the one those | |
3701 | characters both belong to. When @var{pos} is at a boundary between | |
3702 | fields, which field it belongs to depends on the stickiness of the | |
3703 | @code{field} properties of the two surrounding characters (@pxref{Sticky | |
3704 | Properties}). The field whose property would be inherited by text | |
3705 | inserted at @var{pos} is the field that contains @var{pos}. | |
3706 | ||
3707 | There is an anomalous case where newly inserted text at @var{pos} | |
3708 | would not inherit the @code{field} property from either side. This | |
3709 | happens if the previous character's @code{field} property is not | |
3710 | rear-sticky, and the following character's @code{field} property is not | |
3711 | front-sticky. In this case, @var{pos} belongs to neither the preceding | |
3712 | field nor the following field; the field functions treat it as belonging | |
3713 | to an empty field whose beginning and end are both at @var{pos}. | |
3714 | ||
3715 | In all of these functions, if @var{pos} is omitted or @code{nil}, the | |
04668363 TTN |
3716 | value of point is used by default. If narrowing is in effect, then |
3717 | @var{pos} should fall within the accessible portion. @xref{Narrowing}. | |
2468d0c0 | 3718 | |
9c7fce05 | 3719 | @defun field-beginning &optional pos escape-from-edge limit |
2468d0c0 DL |
3720 | This function returns the beginning of the field specified by @var{pos}. |
3721 | ||
35627f72 MB |
3722 | If @var{pos} is at the beginning of its field, and |
3723 | @var{escape-from-edge} is non-@code{nil}, then the return value is | |
3724 | always the beginning of the preceding field that @emph{ends} at @var{pos}, | |
3725 | regardless of the stickiness of the @code{field} properties around | |
3726 | @var{pos}. | |
9c7fce05 MB |
3727 | |
3728 | If @var{limit} is non-@code{nil}, it is a buffer position; if the | |
3729 | beginning of the field is before @var{limit}, then @var{limit} will be | |
3730 | returned instead. | |
2468d0c0 DL |
3731 | @end defun |
3732 | ||
9c7fce05 | 3733 | @defun field-end &optional pos escape-from-edge limit |
2468d0c0 DL |
3734 | This function returns the end of the field specified by @var{pos}. |
3735 | ||
35627f72 MB |
3736 | If @var{pos} is at the end of its field, and @var{escape-from-edge} is |
3737 | non-@code{nil}, then the return value is always the end of the following | |
3738 | field that @emph{begins} at @var{pos}, regardless of the stickiness of | |
3739 | the @code{field} properties around @var{pos}. | |
9c7fce05 MB |
3740 | |
3741 | If @var{limit} is non-@code{nil}, it is a buffer position; if the end | |
3742 | of the field is after @var{limit}, then @var{limit} will be returned | |
3743 | instead. | |
2468d0c0 DL |
3744 | @end defun |
3745 | ||
3746 | @defun field-string &optional pos | |
2468d0c0 DL |
3747 | This function returns the contents of the field specified by @var{pos}, |
3748 | as a string. | |
3749 | @end defun | |
3750 | ||
3751 | @defun field-string-no-properties &optional pos | |
2468d0c0 DL |
3752 | This function returns the contents of the field specified by @var{pos}, |
3753 | as a string, discarding text properties. | |
3754 | @end defun | |
3755 | ||
3756 | @defun delete-field &optional pos | |
2468d0c0 DL |
3757 | This function deletes the text of the field specified by @var{pos}. |
3758 | @end defun | |
3759 | ||
35627f72 | 3760 | @defun constrain-to-field new-pos old-pos &optional escape-from-edge only-in-line inhibit-capture-property |
2468d0c0 DL |
3761 | This function ``constrains'' @var{new-pos} to the field that |
3762 | @var{old-pos} belongs to---in other words, it returns the position | |
3763 | closest to @var{new-pos} that is in the same field as @var{old-pos}. | |
3764 | ||
3765 | If @var{new-pos} is @code{nil}, then @code{constrain-to-field} uses | |
3766 | the value of point instead, and moves point to the resulting position. | |
3767 | ||
75708135 RS |
3768 | If @var{old-pos} is at the boundary of two fields, then the acceptable |
3769 | positions for @var{new-pos} depend on the value of the optional argument | |
3770 | @var{escape-from-edge}. If @var{escape-from-edge} is @code{nil}, then | |
3771 | @var{new-pos} is constrained to the field that has the same @code{field} | |
35627f72 MB |
3772 | property (either a text-property or an overlay property) that new |
3773 | characters inserted at @var{old-pos} would get. (This depends on the | |
3774 | stickiness of the @code{field} property for the characters before and | |
3775 | after @var{old-pos}.) If @var{escape-from-edge} is non-@code{nil}, | |
3776 | @var{new-pos} is constrained to the union of the two adjacent fields. | |
3777 | Additionally, if two fields are separated by another field with the | |
3778 | special value @code{boundary}, then any point within this special field | |
3779 | is also considered to be ``on the boundary.'' | |
2468d0c0 DL |
3780 | |
3781 | If the optional argument @var{only-in-line} is non-@code{nil}, and | |
3782 | constraining @var{new-pos} in the usual way would move it to a different | |
3783 | line, @var{new-pos} is returned unconstrained. This used in commands | |
3784 | that move by line, such as @code{next-line} and | |
3785 | @code{beginning-of-line}, so that they respect field boundaries only in | |
3786 | the case where they can still move to the right line. | |
35627f72 MB |
3787 | |
3788 | If the optional argument @var{inhibit-capture-property} is | |
3789 | non-@code{nil}, and @var{old-pos} has a non-@code{nil} property of that | |
3790 | name, then any field boundaries are ignored. | |
3791 | ||
3792 | You can cause @code{constrain-to-field} to ignore all field boundaries | |
3793 | (and so never constrain anything) by binding the variable | |
74eee906 | 3794 | @code{inhibit-field-text-motion} to a non-@code{nil} value. |
2468d0c0 DL |
3795 | @end defun |
3796 | ||
73804d4b RS |
3797 | @node Not Intervals |
3798 | @subsection Why Text Properties are not Intervals | |
3799 | @cindex intervals | |
3800 | ||
3801 | Some editors that support adding attributes to text in the buffer do | |
3802 | so by letting the user specify ``intervals'' within the text, and adding | |
3803 | the properties to the intervals. Those editors permit the user or the | |
3804 | programmer to determine where individual intervals start and end. We | |
3805 | deliberately provided a different sort of interface in Emacs Lisp to | |
3806 | avoid certain paradoxical behavior associated with text modification. | |
3807 | ||
3808 | If the actual subdivision into intervals is meaningful, that means you | |
3809 | can distinguish between a buffer that is just one interval with a | |
3810 | certain property, and a buffer containing the same text subdivided into | |
3811 | two intervals, both of which have that property. | |
3812 | ||
3813 | Suppose you take the buffer with just one interval and kill part of | |
3814 | the text. The text remaining in the buffer is one interval, and the | |
3815 | copy in the kill ring (and the undo list) becomes a separate interval. | |
3816 | Then if you yank back the killed text, you get two intervals with the | |
3817 | same properties. Thus, editing does not preserve the distinction | |
3818 | between one interval and two. | |
3819 | ||
3820 | Suppose we ``fix'' this problem by coalescing the two intervals when | |
3821 | the text is inserted. That works fine if the buffer originally was a | |
3822 | single interval. But suppose instead that we have two adjacent | |
3823 | intervals with the same properties, and we kill the text of one interval | |
3824 | and yank it back. The same interval-coalescence feature that rescues | |
3825 | the other case causes trouble in this one: after yanking, we have just | |
3826 | one interval. One again, editing does not preserve the distinction | |
3827 | between one interval and two. | |
3828 | ||
3829 | Insertion of text at the border between intervals also raises | |
3830 | questions that have no satisfactory answer. | |
3831 | ||
3832 | However, it is easy to arrange for editing to behave consistently for | |
3833 | questions of the form, ``What are the properties of this character?'' | |
3834 | So we have decided these are the only questions that make sense; we have | |
3835 | not implemented asking questions about where intervals start or end. | |
3836 | ||
f9f59935 | 3837 | In practice, you can usually use the text property search functions in |
73804d4b RS |
3838 | place of explicit interval boundaries. You can think of them as finding |
3839 | the boundaries of intervals, assuming that intervals are always | |
3840 | coalesced whenever possible. @xref{Property Search}. | |
3841 | ||
3842 | Emacs also provides explicit intervals as a presentation feature; see | |
3843 | @ref{Overlays}. | |
3844 | ||
3845 | @node Substitution | |
3846 | @section Substituting for a Character Code | |
3847 | ||
3848 | The following functions replace characters within a specified region | |
3849 | based on their character codes. | |
3850 | ||
3851 | @defun subst-char-in-region start end old-char new-char &optional noundo | |
3852 | @cindex replace characters | |
3853 | This function replaces all occurrences of the character @var{old-char} | |
3854 | with the character @var{new-char} in the region of the current buffer | |
3855 | defined by @var{start} and @var{end}. | |
3856 | ||
73804d4b | 3857 | @cindex undo avoidance |
bfe721d1 KH |
3858 | If @var{noundo} is non-@code{nil}, then @code{subst-char-in-region} does |
3859 | not record the change for undo and does not mark the buffer as modified. | |
2468d0c0 DL |
3860 | This was useful for controlling the old selective display feature |
3861 | (@pxref{Selective Display}). | |
73804d4b RS |
3862 | |
3863 | @code{subst-char-in-region} does not move point and returns | |
3864 | @code{nil}. | |
3865 | ||
3866 | @example | |
3867 | @group | |
3868 | ---------- Buffer: foo ---------- | |
3869 | This is the contents of the buffer before. | |
3870 | ---------- Buffer: foo ---------- | |
3871 | @end group | |
3872 | ||
3873 | @group | |
3874 | (subst-char-in-region 1 20 ?i ?X) | |
3875 | @result{} nil | |
3876 | ||
3877 | ---------- Buffer: foo ---------- | |
3878 | ThXs Xs the contents of the buffer before. | |
3879 | ---------- Buffer: foo ---------- | |
3880 | @end group | |
3881 | @end example | |
3882 | @end defun | |
3883 | ||
3884 | @defun translate-region start end table | |
3885 | This function applies a translation table to the characters in the | |
3886 | buffer between positions @var{start} and @var{end}. | |
3887 | ||
902e1cde KH |
3888 | The translation table @var{table} is a string or a char-table; |
3889 | @code{(aref @var{table} @var{ochar})} gives the translated character | |
3890 | corresponding to @var{ochar}. If @var{table} is a string, any | |
73804d4b RS |
3891 | characters with codes larger than the length of @var{table} are not |
3892 | altered by the translation. | |
3893 | ||
3894 | The return value of @code{translate-region} is the number of | |
61cfa852 RS |
3895 | characters that were actually changed by the translation. This does |
3896 | not count characters that were mapped into themselves in the | |
73804d4b | 3897 | translation table. |
73804d4b RS |
3898 | @end defun |
3899 | ||
3900 | @node Registers | |
3901 | @section Registers | |
3902 | @cindex registers | |
3903 | ||
3904 | A register is a sort of variable used in Emacs editing that can hold a | |
969fe9b5 | 3905 | variety of different kinds of values. Each register is named by a |
ad800164 | 3906 | single character. All @acronym{ASCII} characters and their meta variants |
75708135 RS |
3907 | (but with the exception of @kbd{C-g}) can be used to name registers. |
3908 | Thus, there are 255 possible registers. A register is designated in | |
3909 | Emacs Lisp by the character that is its name. | |
73804d4b RS |
3910 | |
3911 | @defvar register-alist | |
3912 | This variable is an alist of elements of the form @code{(@var{name} . | |
3913 | @var{contents})}. Normally, there is one element for each Emacs | |
3914 | register that has been used. | |
3915 | ||
3916 | The object @var{name} is a character (an integer) identifying the | |
969fe9b5 | 3917 | register. |
73804d4b RS |
3918 | @end defvar |
3919 | ||
969fe9b5 RS |
3920 | The @var{contents} of a register can have several possible types: |
3921 | ||
3922 | @table @asis | |
3923 | @item a number | |
3924 | A number stands for itself. If @code{insert-register} finds a number | |
3925 | in the register, it converts the number to decimal. | |
3926 | ||
3927 | @item a marker | |
3928 | A marker represents a buffer position to jump to. | |
3929 | ||
3930 | @item a string | |
3931 | A string is text saved in the register. | |
3932 | ||
3933 | @item a rectangle | |
3934 | A rectangle is represented by a list of strings. | |
3935 | ||
3936 | @item @code{(@var{window-configuration} @var{position})} | |
3937 | This represents a window configuration to restore in one frame, and a | |
3938 | position to jump to in the current buffer. | |
3939 | ||
3940 | @item @code{(@var{frame-configuration} @var{position})} | |
3941 | This represents a frame configuration to restore, and a position | |
3942 | to jump to in the current buffer. | |
3943 | ||
3944 | @item (file @var{filename}) | |
3945 | This represents a file to visit; jumping to this value visits file | |
3946 | @var{filename}. | |
3947 | ||
3948 | @item (file-query @var{filename} @var{position}) | |
3949 | This represents a file to visit and a position in it; jumping to this | |
3950 | value visits file @var{filename} and goes to buffer position | |
3951 | @var{position}. Restoring this type of position asks the user for | |
3952 | confirmation first. | |
3953 | @end table | |
3954 | ||
3955 | The functions in this section return unpredictable values unless | |
3956 | otherwise stated. | |
3957 | ||
73804d4b RS |
3958 | @defun get-register reg |
3959 | This function returns the contents of the register | |
3960 | @var{reg}, or @code{nil} if it has no contents. | |
3961 | @end defun | |
3962 | ||
3963 | @defun set-register reg value | |
3964 | This function sets the contents of register @var{reg} to @var{value}. | |
3965 | A register can be set to any value, but the other register functions | |
3966 | expect only certain data types. The return value is @var{value}. | |
3967 | @end defun | |
3968 | ||
3969 | @deffn Command view-register reg | |
3970 | This command displays what is contained in register @var{reg}. | |
3971 | @end deffn | |
3972 | ||
3973 | @ignore | |
3974 | @deffn Command point-to-register reg | |
3975 | This command stores both the current location of point and the current | |
3976 | buffer in register @var{reg} as a marker. | |
3977 | @end deffn | |
3978 | ||
3979 | @deffn Command jump-to-register reg | |
3980 | @deffnx Command register-to-point reg | |
3981 | @comment !!SourceFile register.el | |
3982 | This command restores the status recorded in register @var{reg}. | |
3983 | ||
3984 | If @var{reg} contains a marker, it moves point to the position stored in | |
3985 | the marker. Since both the buffer and the location within the buffer | |
3986 | are stored by the @code{point-to-register} function, this command can | |
3987 | switch you to another buffer. | |
3988 | ||
3989 | If @var{reg} contains a window configuration or a frame configuration. | |
3990 | @code{jump-to-register} restores that configuration. | |
3991 | @end deffn | |
3992 | @end ignore | |
3993 | ||
3994 | @deffn Command insert-register reg &optional beforep | |
3995 | This command inserts contents of register @var{reg} into the current | |
3996 | buffer. | |
3997 | ||
3998 | Normally, this command puts point before the inserted text, and the | |
3999 | mark after it. However, if the optional second argument @var{beforep} | |
4000 | is non-@code{nil}, it puts the mark before and point after. | |
4001 | You can pass a non-@code{nil} second argument @var{beforep} to this | |
4002 | function interactively by supplying any prefix argument. | |
4003 | ||
4004 | If the register contains a rectangle, then the rectangle is inserted | |
4005 | with its upper left corner at point. This means that text is inserted | |
4006 | in the current line and underneath it on successive lines. | |
4007 | ||
4008 | If the register contains something other than saved text (a string) or | |
4009 | a rectangle (a list), currently useless things happen. This may be | |
4010 | changed in the future. | |
4011 | @end deffn | |
4012 | ||
4013 | @ignore | |
4014 | @deffn Command copy-to-register reg start end &optional delete-flag | |
4015 | This command copies the region from @var{start} to @var{end} into | |
4016 | register @var{reg}. If @var{delete-flag} is non-@code{nil}, it deletes | |
4017 | the region from the buffer after copying it into the register. | |
4018 | @end deffn | |
4019 | ||
4020 | @deffn Command prepend-to-register reg start end &optional delete-flag | |
4021 | This command prepends the region from @var{start} to @var{end} into | |
4022 | register @var{reg}. If @var{delete-flag} is non-@code{nil}, it deletes | |
4023 | the region from the buffer after copying it to the register. | |
4024 | @end deffn | |
4025 | ||
4026 | @deffn Command append-to-register reg start end &optional delete-flag | |
4027 | This command appends the region from @var{start} to @var{end} to the | |
4028 | text already in register @var{reg}. If @var{delete-flag} is | |
4029 | non-@code{nil}, it deletes the region from the buffer after copying it | |
4030 | to the register. | |
4031 | @end deffn | |
4032 | ||
4033 | @deffn Command copy-rectangle-to-register reg start end &optional delete-flag | |
4034 | This command copies a rectangular region from @var{start} to @var{end} | |
4035 | into register @var{reg}. If @var{delete-flag} is non-@code{nil}, it | |
4036 | deletes the region from the buffer after copying it to the register. | |
4037 | @end deffn | |
4038 | ||
4039 | @deffn Command window-configuration-to-register reg | |
4040 | This function stores the window configuration of the selected frame in | |
4041 | register @var{reg}. | |
4042 | @end deffn | |
4043 | ||
4044 | @deffn Command frame-configuration-to-register reg | |
4045 | This function stores the current frame configuration in register | |
4046 | @var{reg}. | |
4047 | @end deffn | |
4048 | @end ignore | |
4049 | ||
b22f3a19 RS |
4050 | @node Transposition |
4051 | @section Transposition of Text | |
4052 | ||
4053 | This subroutine is used by the transposition commands. | |
4054 | ||
4055 | @defun transpose-regions start1 end1 start2 end2 &optional leave-markers | |
4056 | This function exchanges two nonoverlapping portions of the buffer. | |
4057 | Arguments @var{start1} and @var{end1} specify the bounds of one portion | |
4058 | and arguments @var{start2} and @var{end2} specify the bounds of the | |
4059 | other portion. | |
4060 | ||
4061 | Normally, @code{transpose-regions} relocates markers with the transposed | |
4062 | text; a marker previously positioned within one of the two transposed | |
4063 | portions moves along with that portion, thus remaining between the same | |
4064 | two characters in their new position. However, if @var{leave-markers} | |
4065 | is non-@code{nil}, @code{transpose-regions} does not do this---it leaves | |
4066 | all markers unrelocated. | |
4067 | @end defun | |
4068 | ||
b6954afd RS |
4069 | @node Base 64 |
4070 | @section Base 64 Encoding | |
4071 | @cindex base 64 encoding | |
4072 | ||
ae9b6b4a | 4073 | Base 64 code is used in email to encode a sequence of 8-bit bytes as |
ad800164 | 4074 | a longer sequence of @acronym{ASCII} graphic characters. It is defined in |
944351c0 EZ |
4075 | Internet RFC@footnote{ |
4076 | An RFC, an acronym for @dfn{Request for Comments}, is a numbered | |
4077 | Internet informational document describing a standard. RFCs are | |
4078 | usually written by technical experts acting on their own initiative, | |
4079 | and are traditionally written in a pragmatic, experience-driven | |
4080 | manner. | |
4081 | }2045. This section describes the functions for | |
ae9b6b4a | 4082 | converting to and from this code. |
b6954afd RS |
4083 | |
4084 | @defun base64-encode-region beg end &optional no-line-break | |
b25e2fb5 DL |
4085 | This function converts the region from @var{beg} to @var{end} into base |
4086 | 64 code. It returns the length of the encoded text. An error is | |
4087 | signaled if a character in the region is multibyte, i.e.@: in a | |
4088 | multibyte buffer the region must contain only characters from the | |
4089 | charsets @code{ascii}, @code{eight-bit-control} and | |
4090 | @code{eight-bit-graphic}. | |
b6954afd RS |
4091 | |
4092 | Normally, this function inserts newline characters into the encoded | |
4093 | text, to avoid overlong lines. However, if the optional argument | |
4094 | @var{no-line-break} is non-@code{nil}, these newlines are not added, so | |
4095 | the output is just one long line. | |
4096 | @end defun | |
4097 | ||
4098 | @defun base64-encode-string string &optional no-line-break | |
b6954afd | 4099 | This function converts the string @var{string} into base 64 code. It |
b25e2fb5 DL |
4100 | returns a string containing the encoded text. As for |
4101 | @code{base64-encode-region}, an error is signaled if a character in the | |
4102 | string is multibyte. | |
b6954afd RS |
4103 | |
4104 | Normally, this function inserts newline characters into the encoded | |
4105 | text, to avoid overlong lines. However, if the optional argument | |
4106 | @var{no-line-break} is non-@code{nil}, these newlines are not added, so | |
4107 | the result string is just one long line. | |
4108 | @end defun | |
4109 | ||
4110 | @defun base64-decode-region beg end | |
b6954afd RS |
4111 | This function converts the region from @var{beg} to @var{end} from base |
4112 | 64 code into the corresponding decoded text. It returns the length of | |
4113 | the decoded text. | |
4114 | ||
4115 | The decoding functions ignore newline characters in the encoded text. | |
4116 | @end defun | |
4117 | ||
4118 | @defun base64-decode-string string | |
b6954afd | 4119 | This function converts the string @var{string} from base 64 code into |
54f7f2a4 | 4120 | the corresponding decoded text. It returns a unibyte string containing the |
b6954afd RS |
4121 | decoded text. |
4122 | ||
4123 | The decoding functions ignore newline characters in the encoded text. | |
4124 | @end defun | |
4125 | ||
944351c0 EZ |
4126 | @node MD5 Checksum |
4127 | @section MD5 Checksum | |
4128 | @cindex MD5 checksum | |
4129 | @cindex message digest computation | |
4130 | ||
4131 | MD5 cryptographic checksums, or @dfn{message digests}, are 128-bit | |
4132 | ``fingerprints'' of a document or program. They are used to verify | |
4133 | that you have an exact and unaltered copy of the data. The algorithm | |
4134 | to calculate the MD5 message digest is defined in Internet | |
4135 | RFC@footnote{ | |
4136 | For an explanation of what is an RFC, see the footnote in @ref{Base | |
4137 | 64}. | |
4138 | }1321. This section describes the Emacs facilities for computing | |
4139 | message digests. | |
4140 | ||
4141 | @defun md5 object &optional start end coding-system noerror | |
4142 | This function returns the MD5 message digest of @var{object}, which | |
4143 | should be a buffer or a string. | |
4144 | ||
4145 | The two optional arguments @var{start} and @var{end} are character | |
4146 | positions specifying the portion of @var{object} to compute the | |
4147 | message digest for. If they are @code{nil} or omitted, the digest is | |
4148 | computed for the whole of @var{object}. | |
4149 | ||
4150 | The function @code{md5} does not compute the message digest directly | |
4151 | from the internal Emacs representation of the text (@pxref{Text | |
4152 | Representations}). Instead, it encodes the text using a coding | |
4153 | system, and computes the message digest from the encoded text. The | |
4154 | optional fourth argument @var{coding-system} specifies which coding | |
4155 | system to use for encoding the text. It should be the same coding | |
4156 | system that you used to read the text, or that you used or will use | |
4157 | when saving or sending the text. @xref{Coding Systems}, for more | |
4158 | information about coding systems. | |
4159 | ||
4160 | If @var{coding-system} is @code{nil} or omitted, the default depends | |
4161 | on @var{object}. If @var{object} is a buffer, the default for | |
4162 | @var{coding-system} is whatever coding system would be chosen by | |
4163 | default for writing this text into a file. If @var{object} is a | |
4164 | string, the user's most preferred coding system (@pxref{Recognize | |
4165 | Coding, prefer-coding-system, the description of | |
4166 | @code{prefer-coding-system}, emacs, GNU Emacs Manual}) is used. | |
4167 | ||
4168 | Normally, @code{md5} signals an error if the text can't be encoded | |
4169 | using the specified or chosen coding system. However, if | |
4170 | @var{noerror} is non-@code{nil}, it silently uses @code{raw-text} | |
4171 | coding instead. | |
4172 | @end defun | |
4173 | ||
d73eac4d RS |
4174 | @node Atomic Changes |
4175 | @section Atomic Change Groups | |
4176 | @cindex atomic changes | |
4177 | ||
4178 | In data base terminology, an @dfn{atomic} change is an indivisible | |
4179 | change---it can succeed entirely or it can fail entirely, but it | |
4180 | cannot partly succeed. A Lisp program can make a series of changes to | |
4181 | one or several buffers as an @dfn{atomic change group}, meaning that | |
4182 | either the entire series of changes will be installed in their buffers | |
4183 | or, in case of an error, none of them will be. | |
4184 | ||
4185 | To do this for one buffer, the one already current, simply write a | |
4186 | call to @code{atomic-change-group} around the code that makes the | |
4187 | changes, like this: | |
4188 | ||
4189 | @example | |
4190 | (atomic-change-group | |
4191 | (insert foo) | |
4192 | (delete-region x y)) | |
4193 | @end example | |
4194 | ||
4195 | @noindent | |
4196 | If an error (or other nonlocal exit) occurs inside the body of | |
4197 | @code{atomic-change-group}, it unmakes all the changes in that buffer | |
4198 | that were during the execution of the body. This kind of change group | |
4810d170 | 4199 | has no effect on any other buffers---any such changes remain. |
d73eac4d RS |
4200 | |
4201 | If you need something more sophisticated, such as to make changes in | |
4202 | various buffers constitute one atomic group, you must directly call | |
4203 | lower-level functions that @code{atomic-change-group} uses. | |
4204 | ||
4205 | @defun prepare-change-group &optional buffer | |
4206 | This function sets up a change group for buffer @var{buffer}, which | |
4207 | defaults to the current buffer. It returns a ``handle'' that | |
4208 | represents the change group. You must use this handle to activate the | |
4209 | change group and subsequently to finish it. | |
4210 | @end defun | |
4211 | ||
4212 | To use the change group, you must @dfn{activate} it. You must do | |
4213 | this before making any changes in the text of @var{buffer}. | |
4214 | ||
4215 | @defun activate-change-group handle | |
4216 | This function activates the change group that @var{handle} designates. | |
4217 | @end defun | |
4218 | ||
4219 | After you activate the change group, any changes you make in that | |
4220 | buffer become part of it. Once you have made all the desired changes | |
4221 | in the buffer, you must @dfn{finish} the change group. There are two | |
4222 | ways to do this: you can either accept (and finalize) all the changes, | |
4223 | or cancel them all. | |
4224 | ||
4225 | @defun accept-change-group handle | |
4226 | This function accepts all the changes in the change group specified by | |
4227 | @var{handle}, making them final. | |
4228 | @end defun | |
4229 | ||
4230 | @defun cancel-change-group handle | |
4231 | This function cancels and undoes all the changes in the change group | |
4232 | specified by @var{handle}. | |
4233 | @end defun | |
4234 | ||
4235 | Your code should use @code{unwind-protect} to make sure the group is | |
4236 | always finished. The call to @code{activate-change-group} should be | |
4237 | inside the @code{unwind-protect}, in case the user types @kbd{C-g} | |
4238 | just after it runs. (This is one reason why | |
4239 | @code{prepare-change-group} and @code{activate-change-group} are | |
4240 | separate functions, because normally you would call | |
4241 | @code{prepare-change-group} before the start of that | |
4242 | @code{unwind-protect}.) Once you finish the group, don't use the | |
4243 | handle again---in particular, don't try to finish the same group | |
4244 | twice. | |
4245 | ||
4246 | To make a multibuffer change group, call @code{prepare-change-group} | |
4247 | once for each buffer you want to cover, then use @code{nconc} to | |
4248 | combine the returned values, like this: | |
4249 | ||
4250 | @example | |
4251 | (nconc (prepare-change-group buffer-1) | |
4252 | (prepare-change-group buffer-2)) | |
4253 | @end example | |
4254 | ||
4255 | You can then activate the multibuffer change group with a single call | |
4256 | to @code{activate-change-group}, and finish it with a single call to | |
4257 | @code{accept-change-group} or @code{cancel-change-group}. | |
4258 | ||
4259 | Nested use of several change groups for the same buffer works as you | |
4260 | would expect. Non-nested use of change groups for the same buffer | |
4261 | will get Emacs confused, so don't let it happen; the first change | |
4262 | group you start for any given buffer should be the last one finished. | |
4263 | ||
73804d4b RS |
4264 | @node Change Hooks |
4265 | @section Change Hooks | |
4266 | @cindex change hooks | |
4267 | @cindex hooks for text changes | |
4268 | ||
4269 | These hook variables let you arrange to take notice of all changes in | |
4270 | all buffers (or in a particular buffer, if you make them buffer-local). | |
4271 | See also @ref{Special Properties}, for how to detect changes to specific | |
4272 | parts of the text. | |
4273 | ||
4274 | The functions you use in these hooks should save and restore the match | |
4275 | data if they do anything that uses regular expressions; otherwise, they | |
4276 | will interfere in bizarre ways with the editing operations that call | |
4277 | them. | |
4278 | ||
72654a3c | 4279 | @defvar before-change-functions |
f9f59935 | 4280 | This variable holds a list of functions to call before any buffer |
72654a3c RS |
4281 | modification. Each function gets two arguments, the beginning and end |
4282 | of the region that is about to change, represented as integers. The | |
4283 | buffer that is about to change is always the current buffer. | |
4284 | @end defvar | |
4285 | ||
4286 | @defvar after-change-functions | |
f9f59935 | 4287 | This variable holds a list of functions to call after any buffer |
72654a3c RS |
4288 | modification. Each function receives three arguments: the beginning and |
4289 | end of the region just changed, and the length of the text that existed | |
584b8104 RS |
4290 | before the change. All three arguments are integers. The buffer that's |
4291 | about to change is always the current buffer. | |
4292 | ||
1911e6e5 | 4293 | The length of the old text is the difference between the buffer positions |
a9f0a989 RS |
4294 | before and after that text as it was before the change. As for the |
4295 | changed text, its length is simply the difference between the first two | |
4296 | arguments. | |
72654a3c RS |
4297 | @end defvar |
4298 | ||
af1996b5 | 4299 | Output of messages into the @samp{*Messages*} buffer does not |
74eee906 RS |
4300 | call these functions. |
4301 | ||
80be8042 | 4302 | @defmac combine-after-change-calls body@dots{} |
f9f59935 RS |
4303 | The macro executes @var{body} normally, but arranges to call the |
4304 | after-change functions just once for a series of several changes---if | |
4305 | that seems safe. | |
4306 | ||
4307 | If a program makes several text changes in the same area of the buffer, | |
4308 | using the macro @code{combine-after-change-calls} around that part of | |
4309 | the program can make it run considerably faster when after-change hooks | |
969fe9b5 RS |
4310 | are in use. When the after-change hooks are ultimately called, the |
4311 | arguments specify a portion of the buffer including all of the changes | |
4312 | made within the @code{combine-after-change-calls} body. | |
f9f59935 RS |
4313 | |
4314 | @strong{Warning:} You must not alter the values of | |
b6dd5963 | 4315 | @code{after-change-functions} within |
f9f59935 | 4316 | the body of a @code{combine-after-change-calls} form. |
969fe9b5 | 4317 | |
6142d1d0 | 4318 | @strong{Warning:} if the changes you combine occur in widely scattered |
969fe9b5 RS |
4319 | parts of the buffer, this will still work, but it is not advisable, |
4320 | because it may lead to inefficient behavior for some change hook | |
4321 | functions. | |
f9f59935 RS |
4322 | @end defmac |
4323 | ||
b6dd5963 | 4324 | The two variables above are temporarily bound to @code{nil} during the |
72654a3c | 4325 | time that any of these functions is running. This means that if one of |
73804d4b | 4326 | these functions changes the buffer, that change won't run these |
72654a3c RS |
4327 | functions. If you do want a hook function to make changes that run |
4328 | these functions, make it bind these variables back to their usual | |
73804d4b RS |
4329 | values. |
4330 | ||
b22f3a19 RS |
4331 | One inconvenient result of this protective feature is that you cannot |
4332 | have a function in @code{after-change-functions} or | |
4333 | @code{before-change-functions} which changes the value of that variable. | |
4334 | But that's not a real limitation. If you want those functions to change | |
4335 | the list of functions to run, simply add one fixed function to the hook, | |
4336 | and code that function to look in another variable for other functions | |
4337 | to call. Here is an example: | |
4338 | ||
4339 | @example | |
4340 | (setq my-own-after-change-functions nil) | |
4341 | (defun indirect-after-change-function (beg end len) | |
4342 | (let ((list my-own-after-change-functions)) | |
4343 | (while list | |
4344 | (funcall (car list) beg end len) | |
4345 | (setq list (cdr list))))) | |
969fe9b5 RS |
4346 | |
4347 | @group | |
b22f3a19 RS |
4348 | (add-hooks 'after-change-functions |
4349 | 'indirect-after-change-function) | |
969fe9b5 | 4350 | @end group |
b22f3a19 RS |
4351 | @end example |
4352 | ||
73804d4b RS |
4353 | @defvar first-change-hook |
4354 | This variable is a normal hook that is run whenever a buffer is changed | |
4355 | that was previously in the unmodified state. | |
4356 | @end defvar | |
8241495d RS |
4357 | |
4358 | @defvar inhibit-modification-hooks | |
8241495d RS |
4359 | If this variable is non-@code{nil}, all of the change hooks are |
4360 | disabled; none of them run. This affects all the hook variables | |
4361 | described above in this section, as well as the hooks attached to | |
4362 | certain special text properties (@pxref{Special Properties}) and overlay | |
4363 | properties (@pxref{Overlay Properties}). | |
8241495d | 4364 | @end defvar |
ab5796a9 MB |
4365 | |
4366 | @ignore | |
4367 | arch-tag: 3721e738-a1cb-4085-bc1a-6cb8d8e1d32b | |
4368 | @end ignore |