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