Mercurial > emacs
annotate lispref/markers.texi @ 53441:cb72a8379550
*** empty log message ***
author | Eli Zaretskii <eliz@is.elta.co.il> |
---|---|
date | Tue, 30 Dec 2003 08:26:00 +0000 |
parents | b0b3d8b864b8 |
children | 3e2d6f6c8e51 |
rev | line source |
---|---|
6444 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46339
diff
changeset
|
4 @c Free Software Foundation, Inc. |
6444 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/markers | |
7 @node Markers, Text, Positions, Top | |
8 @chapter Markers | |
9 @cindex markers | |
10 | |
11 A @dfn{marker} is a Lisp object used to specify a position in a buffer | |
12 relative to the surrounding text. A marker changes its offset from the | |
13 beginning of the buffer automatically whenever text is inserted or | |
14 deleted, so that it stays with the two characters on either side of it. | |
15 | |
16 @menu | |
17 * Overview of Markers:: The components of a marker, and how it relocates. | |
18 * Predicates on Markers:: Testing whether an object is a marker. | |
19 * Creating Markers:: Making empty markers or markers at certain places. | |
20 * Information from Markers:: Finding the marker's buffer or character position. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
21 * Marker Insertion Types:: Two ways a marker can relocate when you |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
22 insert where it points. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
23 * Moving Markers:: Moving the marker to a new buffer or position. |
6444 | 24 * The Mark:: How ``the mark'' is implemented with a marker. |
25 * The Region:: How to access ``the region''. | |
26 @end menu | |
27 | |
28 @node Overview of Markers | |
29 @section Overview of Markers | |
30 | |
53104
b0b3d8b864b8
(Overview of Markers): Mention that, if a marker is used a a position,
Luc Teirlinck <teirllm@auburn.edu>
parents:
53036
diff
changeset
|
31 A marker specifies a buffer and a position in that buffer. The |
b0b3d8b864b8
(Overview of Markers): Mention that, if a marker is used a a position,
Luc Teirlinck <teirllm@auburn.edu>
parents:
53036
diff
changeset
|
32 marker can be used to represent a position in the functions that |
b0b3d8b864b8
(Overview of Markers): Mention that, if a marker is used a a position,
Luc Teirlinck <teirllm@auburn.edu>
parents:
53036
diff
changeset
|
33 require one, just as an integer could be used. In that case, the |
b0b3d8b864b8
(Overview of Markers): Mention that, if a marker is used a a position,
Luc Teirlinck <teirllm@auburn.edu>
parents:
53036
diff
changeset
|
34 marker's buffer is normally ignored. Of course, a marker used in this |
b0b3d8b864b8
(Overview of Markers): Mention that, if a marker is used a a position,
Luc Teirlinck <teirllm@auburn.edu>
parents:
53036
diff
changeset
|
35 way usually points to a position in the buffer that the function |
b0b3d8b864b8
(Overview of Markers): Mention that, if a marker is used a a position,
Luc Teirlinck <teirllm@auburn.edu>
parents:
53036
diff
changeset
|
36 operates on, but that is entirely the programmer's responsibility. |
b0b3d8b864b8
(Overview of Markers): Mention that, if a marker is used a a position,
Luc Teirlinck <teirllm@auburn.edu>
parents:
53036
diff
changeset
|
37 @xref{Positions}, for a complete description of positions. |
6444 | 38 |
39 A marker has two attributes: the marker position, and the marker | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
40 buffer. The marker position is an integer that is equivalent (at a |
6444 | 41 given time) to the marker as a position in that buffer. But the |
42 marker's position value can change often during the life of the marker. | |
43 Insertion and deletion of text in the buffer relocate the marker. The | |
44 idea is that a marker positioned between two characters remains between | |
45 those two characters despite insertion and deletion elsewhere in the | |
46 buffer. Relocation changes the integer equivalent of the marker. | |
47 | |
48 @cindex marker relocation | |
49 Deleting text around a marker's position leaves the marker between the | |
50 characters immediately before and after the deleted text. Inserting | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
51 text at the position of a marker normally leaves the marker either in |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
52 front of or after the new text, depending on the marker's @dfn{insertion |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
53 type} (@pxref{Marker Insertion Types})---unless the insertion is done |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
54 with @code{insert-before-markers} (@pxref{Insertion}). |
6444 | 55 |
56 @cindex marker garbage collection | |
57 Insertion and deletion in a buffer must check all the markers and | |
58 relocate them if necessary. This slows processing in a buffer with a | |
59 large number of markers. For this reason, it is a good idea to make a | |
60 marker point nowhere if you are sure you don't need it any more. | |
61 Unreferenced markers are garbage collected eventually, but until then | |
62 will continue to use time if they do point somewhere. | |
63 | |
64 @cindex markers as numbers | |
65 Because it is common to perform arithmetic operations on a marker | |
66 position, most of the arithmetic operations (including @code{+} and | |
67 @code{-}) accept markers as arguments. In such cases, the marker | |
68 stands for its current position. | |
69 | |
70 Here are examples of creating markers, setting markers, and moving point | |
71 to markers: | |
72 | |
73 @example | |
74 @group | |
75 ;; @r{Make a new marker that initially does not point anywhere:} | |
76 (setq m1 (make-marker)) | |
77 @result{} #<marker in no buffer> | |
78 @end group | |
79 | |
80 @group | |
81 ;; @r{Set @code{m1} to point between the 99th and 100th characters} | |
82 ;; @r{in the current buffer:} | |
83 (set-marker m1 100) | |
84 @result{} #<marker at 100 in markers.texi> | |
85 @end group | |
86 | |
87 @group | |
88 ;; @r{Now insert one character at the beginning of the buffer:} | |
89 (goto-char (point-min)) | |
90 @result{} 1 | |
91 (insert "Q") | |
92 @result{} nil | |
93 @end group | |
94 | |
95 @group | |
96 ;; @r{@code{m1} is updated appropriately.} | |
97 m1 | |
98 @result{} #<marker at 101 in markers.texi> | |
99 @end group | |
100 | |
101 @group | |
102 ;; @r{Two markers that point to the same position} | |
103 ;; @r{are not @code{eq}, but they are @code{equal}.} | |
104 (setq m2 (copy-marker m1)) | |
105 @result{} #<marker at 101 in markers.texi> | |
106 (eq m1 m2) | |
107 @result{} nil | |
108 (equal m1 m2) | |
109 @result{} t | |
110 @end group | |
111 | |
112 @group | |
113 ;; @r{When you are finished using a marker, make it point nowhere.} | |
114 (set-marker m1 nil) | |
115 @result{} #<marker in no buffer> | |
116 @end group | |
117 @end example | |
118 | |
119 @node Predicates on Markers | |
120 @section Predicates on Markers | |
121 | |
122 You can test an object to see whether it is a marker, or whether it is | |
123 either an integer or a marker. The latter test is useful in connection | |
124 with the arithmetic functions that work with both markers and integers. | |
125 | |
126 @defun markerp object | |
127 This function returns @code{t} if @var{object} is a marker, @code{nil} | |
128 otherwise. Note that integers are not markers, even though many | |
129 functions will accept either a marker or an integer. | |
130 @end defun | |
131 | |
132 @defun integer-or-marker-p object | |
133 This function returns @code{t} if @var{object} is an integer or a marker, | |
134 @code{nil} otherwise. | |
135 @end defun | |
136 | |
137 @defun number-or-marker-p object | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
138 This function returns @code{t} if @var{object} is a number (either |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
139 integer or floating point) or a marker, @code{nil} otherwise. |
6444 | 140 @end defun |
141 | |
142 @node Creating Markers | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
143 @section Functions that Create Markers |
6444 | 144 |
145 When you create a new marker, you can make it point nowhere, or point | |
146 to the present position of point, or to the beginning or end of the | |
147 accessible portion of the buffer, or to the same place as another given | |
148 marker. | |
149 | |
53036
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
150 The next four functions all return markers with insertion type |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
151 @code{nil}. @xref{Marker Insertion Types}. |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
152 |
6444 | 153 @defun make-marker |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
154 This function returns a newly created marker that does not point |
6444 | 155 anywhere. |
156 | |
157 @example | |
158 @group | |
159 (make-marker) | |
160 @result{} #<marker in no buffer> | |
161 @end group | |
162 @end example | |
163 @end defun | |
164 | |
165 @defun point-marker | |
166 This function returns a new marker that points to the present position | |
167 of point in the current buffer. @xref{Point}. For an example, see | |
168 @code{copy-marker}, below. | |
169 @end defun | |
170 | |
171 @defun point-min-marker | |
172 This function returns a new marker that points to the beginning of the | |
173 accessible portion of the buffer. This will be the beginning of the | |
174 buffer unless narrowing is in effect. @xref{Narrowing}. | |
175 @end defun | |
176 | |
177 @defun point-max-marker | |
178 @cindex end of buffer marker | |
179 This function returns a new marker that points to the end of the | |
180 accessible portion of the buffer. This will be the end of the buffer | |
181 unless narrowing is in effect. @xref{Narrowing}. | |
182 | |
183 Here are examples of this function and @code{point-min-marker}, shown in | |
184 a buffer containing a version of the source file for the text of this | |
185 chapter. | |
186 | |
187 @example | |
188 @group | |
189 (point-min-marker) | |
190 @result{} #<marker at 1 in markers.texi> | |
191 (point-max-marker) | |
192 @result{} #<marker at 15573 in markers.texi> | |
193 @end group | |
194 | |
195 @group | |
196 (narrow-to-region 100 200) | |
197 @result{} nil | |
198 @end group | |
199 @group | |
200 (point-min-marker) | |
201 @result{} #<marker at 100 in markers.texi> | |
202 @end group | |
203 @group | |
204 (point-max-marker) | |
205 @result{} #<marker at 200 in markers.texi> | |
206 @end group | |
207 @end example | |
208 @end defun | |
209 | |
53036
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
210 @defun copy-marker marker-or-integer &optional insertion-type |
6444 | 211 If passed a marker as its argument, @code{copy-marker} returns a |
212 new marker that points to the same place and the same buffer as does | |
213 @var{marker-or-integer}. If passed an integer as its argument, | |
214 @code{copy-marker} returns a new marker that points to position | |
215 @var{marker-or-integer} in the current buffer. | |
216 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
217 The new marker's insertion type is specified by the argument |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
218 @var{insertion-type}. @xref{Marker Insertion Types}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
219 |
6444 | 220 If passed an integer argument less than 1, @code{copy-marker} returns a |
221 new marker that points to the beginning of the current buffer. If | |
222 passed an integer argument greater than the length of the buffer, | |
223 @code{copy-marker} returns a new marker that points to the end of the | |
224 buffer. | |
225 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
226 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
227 @group |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
228 (copy-marker 0) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
229 @result{} #<marker at 1 in markers.texi> |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
230 @end group |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
231 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
232 @group |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
233 (copy-marker 20000) |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
234 @result{} #<marker at 7572 in markers.texi> |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
235 @end group |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
236 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
237 |
6444 | 238 An error is signaled if @var{marker} is neither a marker nor an |
239 integer. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
240 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
241 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
242 Two distinct markers are considered @code{equal} (even though not |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
243 @code{eq}) to each other if they have the same position and buffer, or |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
244 if they both point nowhere. |
6444 | 245 |
246 @example | |
247 @group | |
248 (setq p (point-marker)) | |
249 @result{} #<marker at 2139 in markers.texi> | |
250 @end group | |
251 | |
252 @group | |
253 (setq q (copy-marker p)) | |
254 @result{} #<marker at 2139 in markers.texi> | |
255 @end group | |
256 | |
257 @group | |
258 (eq p q) | |
259 @result{} nil | |
260 @end group | |
261 | |
262 @group | |
263 (equal p q) | |
264 @result{} t | |
265 @end group | |
266 @end example | |
267 | |
268 @node Information from Markers | |
269 @section Information from Markers | |
270 | |
271 This section describes the functions for accessing the components of a | |
272 marker object. | |
273 | |
274 @defun marker-position marker | |
275 This function returns the position that @var{marker} points to, or | |
276 @code{nil} if it points nowhere. | |
277 @end defun | |
278 | |
279 @defun marker-buffer marker | |
280 This function returns the buffer that @var{marker} points into, or | |
281 @code{nil} if it points nowhere. | |
282 | |
283 @example | |
284 @group | |
285 (setq m (make-marker)) | |
286 @result{} #<marker in no buffer> | |
287 @end group | |
288 @group | |
289 (marker-position m) | |
290 @result{} nil | |
291 @end group | |
292 @group | |
293 (marker-buffer m) | |
294 @result{} nil | |
295 @end group | |
296 | |
297 @group | |
298 (set-marker m 3770 (current-buffer)) | |
299 @result{} #<marker at 3770 in markers.texi> | |
300 @end group | |
301 @group | |
302 (marker-buffer m) | |
303 @result{} #<buffer markers.texi> | |
304 @end group | |
305 @group | |
306 (marker-position m) | |
307 @result{} 3770 | |
308 @end group | |
309 @end example | |
310 @end defun | |
311 | |
26181 | 312 @defun buffer-has-markers-at position |
313 @tindex buffer-has-markers-at | |
314 This function returns @code{t} if one or more markers | |
315 point at position @var{position} in the current buffer. | |
316 @end defun | |
317 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
318 @node Marker Insertion Types |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
319 @section Marker Insertion Types |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
320 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
321 @cindex insertion type of a marker |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
322 When you insert text directly at the place where a marker points, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
323 there are two possible ways to relocate that marker: it can point before |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
324 the inserted text, or point after it. You can specify which one a given |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
325 marker should do by setting its @dfn{insertion type}. Note that use of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
326 @code{insert-before-markers} ignores markers' insertion types, always |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
327 relocating a marker to point after the inserted text. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
328 |
53036
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
329 Most functions that create markers, without explicitly specifying an |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
330 insertion type, create them with insertion type @code{nil}. Also, the |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
331 mark has, by default, insertion type @code{nil}. |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
332 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
333 @defun set-marker-insertion-type marker type |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
334 This function sets the insertion type of marker @var{marker} to |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
335 @var{type}. If @var{type} is @code{t}, @var{marker} will advance when |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
336 text is inserted at its position. If @var{type} is @code{nil}, |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
337 @var{marker} does not advance when text is inserted there. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
338 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
339 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
340 @defun marker-insertion-type marker |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
341 This function reports the current insertion type of @var{marker}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
342 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
343 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
344 @node Moving Markers |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
345 @section Moving Marker Positions |
6444 | 346 |
347 This section describes how to change the position of an existing | |
348 marker. When you do this, be sure you know whether the marker is used | |
349 outside of your program, and, if so, what effects will result from | |
350 moving it---otherwise, confusing things may happen in other parts of | |
351 Emacs. | |
352 | |
353 @defun set-marker marker position &optional buffer | |
354 This function moves @var{marker} to @var{position} | |
355 in @var{buffer}. If @var{buffer} is not provided, it defaults to | |
356 the current buffer. | |
357 | |
358 If @var{position} is less than 1, @code{set-marker} moves @var{marker} | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
359 to the beginning of the buffer. If @var{position} is greater than the |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
360 size of the buffer, @code{set-marker} moves marker to the end of the |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
361 buffer. If @var{position} is @code{nil} or a marker that points |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
362 nowhere, then @var{marker} is set to point nowhere. |
6444 | 363 |
364 The value returned is @var{marker}. | |
365 | |
366 @example | |
367 @group | |
368 (setq m (point-marker)) | |
369 @result{} #<marker at 4714 in markers.texi> | |
370 @end group | |
371 @group | |
372 (set-marker m 55) | |
373 @result{} #<marker at 55 in markers.texi> | |
374 @end group | |
375 @group | |
376 (setq b (get-buffer "foo")) | |
377 @result{} #<buffer foo> | |
378 @end group | |
379 @group | |
380 (set-marker m 0 b) | |
381 @result{} #<marker at 1 in foo> | |
382 @end group | |
383 @end example | |
384 @end defun | |
385 | |
386 @defun move-marker marker position &optional buffer | |
387 This is another name for @code{set-marker}. | |
388 @end defun | |
389 | |
390 @node The Mark | |
391 @section The Mark | |
392 @cindex mark, the | |
393 @cindex mark ring | |
394 | |
395 One special marker in each buffer is designated @dfn{the mark}. It | |
396 records a position for the user for the sake of commands such as | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
397 @code{kill-region} and @code{indent-rigidly}. Lisp programs should set |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
398 the mark only to values that have a potential use to the user, and never |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
399 for their own internal purposes. For example, the @code{replace-regexp} |
6444 | 400 command sets the mark to the value of point before doing any |
401 replacements, because this enables the user to move back there | |
402 conveniently after the replace is finished. | |
403 | |
404 Many commands are designed so that when called interactively they | |
405 operate on the text between point and the mark. If you are writing such | |
406 a command, don't examine the mark directly; instead, use | |
407 @code{interactive} with the @samp{r} specification. This provides the | |
408 values of point and the mark as arguments to the command in an | |
409 interactive call, but permits other Lisp programs to specify arguments | |
410 explicitly. @xref{Interactive Codes}. | |
411 | |
412 Each buffer has its own value of the mark that is independent of the | |
413 value of the mark in other buffers. When a buffer is created, the mark | |
414 exists but does not point anywhere. We consider this state as ``the | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
415 absence of a mark in that buffer.'' |
6444 | 416 |
417 Once the mark ``exists'' in a buffer, it normally never ceases to | |
418 exist. However, it may become @dfn{inactive}, if Transient Mark mode is | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
419 enabled. The variable @code{mark-active}, which is always buffer-local |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
420 in all buffers, indicates whether the mark is active: non-@code{nil} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
421 means yes. A command can request deactivation of the mark upon return |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
422 to the editor command loop by setting @code{deactivate-mark} to a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
423 non-@code{nil} value (but this causes deactivation only if Transient |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
424 Mark mode is enabled). |
6444 | 425 |
426 The main motivation for using Transient Mark mode is that this mode | |
427 also enables highlighting of the region when the mark is active. | |
428 @xref{Display}. | |
429 | |
430 In addition to the mark, each buffer has a @dfn{mark ring} which is a | |
431 list of markers containing previous values of the mark. When editing | |
432 commands change the mark, they should normally save the old value of the | |
433 mark on the mark ring. The variable @code{mark-ring-max} specifies the | |
434 maximum number of entries in the mark ring; once the list becomes this | |
435 long, adding a new element deletes the last element. | |
436 | |
26181 | 437 There is also a separate global mark ring, but that is used only in a |
438 few particular user-level commands, and is not relevant to Lisp | |
439 programming. So we do not describe it here. | |
440 | |
6444 | 441 @defun mark &optional force |
442 @cindex current buffer mark | |
443 This function returns the current buffer's mark position as an integer. | |
444 | |
53036
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
445 If Transient Mark mode is enabled, @code{mark-even-if-inactive} is |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
446 @code{nil} and and the mark is inactive, @code{mark} normally signals |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
447 an error. However, if @var{force} is non-@code{nil}, then @code{mark} |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
448 returns the mark position anyway---or @code{nil}, if the mark is not |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
449 yet set for this buffer. |
6444 | 450 @end defun |
451 | |
452 @defun mark-marker | |
453 This function returns the current buffer's mark. This is the very marker | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
454 that records the mark location inside Emacs, not a copy. Therefore, |
6444 | 455 changing this marker's position will directly affect the position of the mark. |
456 Don't do it unless that is the effect you want. | |
457 | |
458 @example | |
459 @group | |
460 (setq m (mark-marker)) | |
461 @result{} #<marker at 3420 in markers.texi> | |
462 @end group | |
463 @group | |
464 (set-marker m 100) | |
465 @result{} #<marker at 100 in markers.texi> | |
466 @end group | |
467 @group | |
468 (mark-marker) | |
469 @result{} #<marker at 100 in markers.texi> | |
470 @end group | |
471 @end example | |
472 | |
473 Like any marker, this marker can be set to point at any buffer you like. | |
474 We don't recommend that you make it point at any buffer other than the | |
475 one of which it is the mark. If you do, it will yield perfectly | |
476 consistent, but rather odd, results. | |
477 @end defun | |
478 | |
479 @ignore | |
480 @deffn Command set-mark-command jump | |
481 If @var{jump} is @code{nil}, this command sets the mark to the value | |
482 of point and pushes the previous value of the mark on the mark ring. The | |
483 message @samp{Mark set} is also displayed in the echo area. | |
484 | |
485 If @var{jump} is not @code{nil}, this command sets point to the value | |
486 of the mark, and sets the mark to the previous saved mark value, which | |
487 is popped off the mark ring. | |
488 | |
489 This function is @emph{only} intended for interactive use. | |
490 @end deffn | |
491 @end ignore | |
492 | |
493 @defun set-mark position | |
494 This function sets the mark to @var{position}, and activates the mark. | |
495 The old value of the mark is @emph{not} pushed onto the mark ring. | |
496 | |
7734 | 497 @strong{Please note:} Use this function only if you want the user to |
6444 | 498 see that the mark has moved, and you want the previous mark position to |
499 be lost. Normally, when a new mark is set, the old one should go on the | |
500 @code{mark-ring}. For this reason, most applications should use | |
501 @code{push-mark} and @code{pop-mark}, not @code{set-mark}. | |
502 | |
503 Novice Emacs Lisp programmers often try to use the mark for the wrong | |
504 purposes. The mark saves a location for the user's convenience. An | |
505 editing command should not alter the mark unless altering the mark is | |
506 part of the user-level functionality of the command. (And, in that | |
507 case, this effect should be documented.) To remember a location for | |
508 internal use in the Lisp program, store it in a Lisp variable. For | |
509 example: | |
510 | |
511 @example | |
512 @group | |
513 (let ((beg (point))) | |
514 (forward-line 1) | |
515 (delete-region beg (point))). | |
516 @end group | |
517 @end example | |
518 @end defun | |
519 | |
520 @c for interactive use only | |
521 @ignore | |
522 @deffn Command exchange-point-and-mark | |
523 This function exchanges the positions of point and the mark. | |
524 It is intended for interactive use. | |
525 @end deffn | |
526 @end ignore | |
527 | |
528 @defun push-mark &optional position nomsg activate | |
529 This function sets the current buffer's mark to @var{position}, and | |
530 pushes a copy of the previous mark onto @code{mark-ring}. If | |
531 @var{position} is @code{nil}, then the value of point is used. | |
532 @code{push-mark} returns @code{nil}. | |
533 | |
534 The function @code{push-mark} normally @emph{does not} activate the | |
535 mark. To do that, specify @code{t} for the argument @var{activate}. | |
536 | |
537 A @samp{Mark set} message is displayed unless @var{nomsg} is | |
538 non-@code{nil}. | |
539 @end defun | |
540 | |
541 @defun pop-mark | |
542 This function pops off the top element of @code{mark-ring} and makes | |
543 that mark become the buffer's actual mark. This does not move point in | |
544 the buffer, and it does nothing if @code{mark-ring} is empty. It | |
545 deactivates the mark. | |
546 | |
547 The return value is not meaningful. | |
548 @end defun | |
549 | |
550 @defopt transient-mark-mode | |
551 @cindex Transient Mark mode | |
12098 | 552 This variable if non-@code{nil} enables Transient Mark mode, in which |
553 every buffer-modifying primitive sets @code{deactivate-mark}. The | |
554 consequence of this is that commands that modify the buffer normally | |
555 make the mark inactive. | |
6444 | 556 @end defopt |
557 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
558 @defopt mark-even-if-inactive |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
559 If this is non-@code{nil}, Lisp programs and the Emacs user can use the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
560 mark even when it is inactive. This option affects the behavior of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
561 Transient Mark mode. When the option is non-@code{nil}, deactivation of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
562 the mark turns off region highlighting, but commands that use the mark |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
563 behave as if the mark were still active. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
564 @end defopt |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
565 |
6444 | 566 @defvar deactivate-mark |
567 If an editor command sets this variable non-@code{nil}, then the editor | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
568 command loop deactivates the mark after the command returns (if |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
569 Transient Mark mode is enabled). All the primitives that change the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
570 buffer set @code{deactivate-mark}, to deactivate the mark when the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
571 command is finished. |
46339
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
572 |
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
573 To write Lisp code that modifies the buffer without causing |
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
574 deactivation of the mark at the end of the command, bind |
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
575 @code{deactivate-mark} to @code{nil} around the code that does the |
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
576 modification. For example: |
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
577 |
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
578 @example |
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
579 (let (deactivate-mark) |
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
580 (insert " ")) |
469cf4d8b62b
Document binding `deactivate-mark' around something that modifies the
Richard M. Stallman <rms@gnu.org>
parents:
27189
diff
changeset
|
581 @end example |
6444 | 582 @end defvar |
583 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
584 @defun deactivate-mark |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
585 This function deactivates the mark, if Transient Mark mode is enabled. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
586 Otherwise it does nothing. |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
587 @end defun |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6444
diff
changeset
|
588 |
6444 | 589 @defvar mark-active |
590 The mark is active when this variable is non-@code{nil}. This variable | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
591 is always buffer-local in each buffer. |
6444 | 592 @end defvar |
593 | |
594 @defvar activate-mark-hook | |
595 @defvarx deactivate-mark-hook | |
596 These normal hooks are run, respectively, when the mark becomes active | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
597 and when it becomes inactive. The hook @code{activate-mark-hook} is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
598 also run at the end of a command if the mark is active and it is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
599 possible that the region may have changed. |
6444 | 600 @end defvar |
601 | |
602 @defvar mark-ring | |
603 The value of this buffer-local variable is the list of saved former | |
604 marks of the current buffer, most recent first. | |
605 | |
606 @example | |
607 @group | |
608 mark-ring | |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
46339
diff
changeset
|
609 @result{} (#<marker at 11050 in markers.texi> |
6444 | 610 #<marker at 10832 in markers.texi> |
611 @dots{}) | |
612 @end group | |
613 @end example | |
614 @end defvar | |
615 | |
616 @defopt mark-ring-max | |
617 The value of this variable is the maximum size of @code{mark-ring}. If | |
618 more marks than this are pushed onto the @code{mark-ring}, | |
619 @code{push-mark} discards an old mark when it adds a new one. | |
620 @end defopt | |
621 | |
622 @node The Region | |
623 @section The Region | |
624 @cindex region, the | |
625 | |
626 The text between point and the mark is known as @dfn{the region}. | |
627 Various functions operate on text delimited by point and the mark, but | |
628 only those functions specifically related to the region itself are | |
629 described here. | |
630 | |
53036
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
631 The next two functions signal an error if the mark does not point |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
632 anywhere. If Transient Mark mode is enabled and |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
633 @code{mark-even-if-inactive} is @code{nil}, they also signal an error |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
634 if the mark is inactive. |
8383c6d510e2
(Creating Markers): Specify insertion type of created markers. Add
Luc Teirlinck <teirllm@auburn.edu>
parents:
52401
diff
changeset
|
635 |
6444 | 636 @defun region-beginning |
637 This function returns the position of the beginning of the region (as | |
638 an integer). This is the position of either point or the mark, | |
639 whichever is smaller. | |
640 @end defun | |
641 | |
642 @defun region-end | |
643 This function returns the position of the end of the region (as an | |
644 integer). This is the position of either point or the mark, whichever is | |
645 larger. | |
646 @end defun | |
647 | |
648 Few programs need to use the @code{region-beginning} and | |
649 @code{region-end} functions. A command designed to operate on a region | |
650 should normally use @code{interactive} with the @samp{r} specification | |
651 to find the beginning and end of the region. This lets other Lisp | |
652 programs specify the bounds explicitly as arguments. (@xref{Interactive | |
653 Codes}.) | |
52401 | 654 |
655 @ignore | |
656 arch-tag: b1ba2e7a-a0f3-4c5e-875c-7d8e22d73299 | |
657 @end ignore |