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