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