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