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