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