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