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