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