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