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