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