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