Mercurial > emacs
annotate lispref/positions.texi @ 24702:95815bc1f83b
*** empty log message ***
author | Karl Heuer <kwzh@gnu.org> |
---|---|
date | Sun, 09 May 1999 06:59:45 +0000 |
parents | f0cd03a7dac9 |
children | 80ac191b6d2b |
rev | line source |
---|---|
6552 | 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:
14504
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc. |
6552 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/positions | |
6 @node Positions, Markers, Frames, Top | |
7 @chapter Positions | |
8 @cindex position (in buffer) | |
9 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
10 A @dfn{position} is the index of a character in the text of a buffer. |
6552 | 11 More precisely, a position identifies the place between two characters |
12 (or before the first character, or after the last character), so we can | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
13 speak of the character before or after a given position. However, we |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
14 often speak of the character ``at'' a position, meaning the character |
6552 | 15 after that position. |
16 | |
17 Positions are usually represented as integers starting from 1, but can | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
18 also be represented as @dfn{markers}---special objects that relocate |
6552 | 19 automatically when text is inserted or deleted so they stay with the |
20 surrounding characters. @xref{Markers}. | |
21 | |
22 @menu | |
23 * Point:: The special position where editing takes place. | |
24 * Motion:: Changing point. | |
25 * Excursions:: Temporary motion and buffer changes. | |
26 * Narrowing:: Restricting editing to a portion of the buffer. | |
27 @end menu | |
28 | |
29 @node Point | |
30 @section Point | |
31 @cindex point | |
32 | |
33 @dfn{Point} is a special buffer position used by many editing | |
34 commands, including the self-inserting typed characters and text | |
35 insertion functions. Other commands move point through the text | |
36 to allow editing and insertion at different places. | |
37 | |
38 Like other positions, point designates a place between two characters | |
39 (or before the first character, or after the last character), rather | |
12098 | 40 than a particular character. Usually terminals display the cursor over |
41 the character that immediately follows point; point is actually before | |
42 the character on which the cursor sits. | |
6552 | 43 |
44 @cindex point with narrowing | |
45 The value of point is a number between 1 and the buffer size plus 1. | |
46 If narrowing is in effect (@pxref{Narrowing}), then point is constrained | |
47 to fall within the accessible portion of the buffer (possibly at one end | |
48 of it). | |
49 | |
50 Each buffer has its own value of point, which is independent of the | |
51 value of point in other buffers. Each window also has a value of point, | |
52 which is independent of the value of point in other windows on the same | |
53 buffer. This is why point can have different values in various windows | |
54 that display the same buffer. When a buffer appears in only one window, | |
55 the buffer's point and the window's point normally have the same value, | |
56 so the distinction is rarely important. @xref{Window Point}, for more | |
57 details. | |
58 | |
59 @defun point | |
60 @cindex current buffer position | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
61 This function returns the value of point in the current buffer, |
6552 | 62 as an integer. |
63 | |
64 @need 700 | |
65 @example | |
66 @group | |
67 (point) | |
68 @result{} 175 | |
69 @end group | |
70 @end example | |
71 @end defun | |
72 | |
73 @defun point-min | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
74 This function returns the minimum accessible value of point in the |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
75 current buffer. This is normally 1, but if narrowing is in effect, it |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
76 is the position of the start of the region that you narrowed to. |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
77 (@xref{Narrowing}.) |
6552 | 78 @end defun |
79 | |
80 @defun point-max | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
81 This function returns the maximum accessible value of point in the |
6552 | 82 current buffer. This is @code{(1+ (buffer-size))}, unless narrowing is |
83 in effect, in which case it is the position of the end of the region | |
84 that you narrowed to. (@xref{Narrowing}). | |
85 @end defun | |
86 | |
87 @defun buffer-end flag | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
88 This function returns @code{(point-min)} if @var{flag} is less than 1, |
6552 | 89 @code{(point-max)} otherwise. The argument @var{flag} must be a number. |
90 @end defun | |
91 | |
92 @defun buffer-size | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
93 This function returns the total number of characters in the current |
6552 | 94 buffer. In the absence of any narrowing (@pxref{Narrowing}), |
95 @code{point-max} returns a value one larger than this. | |
96 | |
97 @example | |
98 @group | |
99 (buffer-size) | |
100 @result{} 35 | |
101 @end group | |
102 @group | |
103 (point-max) | |
104 @result{} 36 | |
105 @end group | |
106 @end example | |
107 @end defun | |
108 | |
109 @node Motion | |
110 @section Motion | |
111 | |
112 Motion functions change the value of point, either relative to the | |
113 current value of point, relative to the beginning or end of the buffer, | |
114 or relative to the edges of the selected window. @xref{Point}. | |
115 | |
116 @menu | |
117 * Character Motion:: Moving in terms of characters. | |
118 * Word Motion:: Moving in terms of words. | |
119 * Buffer End Motion:: Moving to the beginning or end of the buffer. | |
120 * Text Lines:: Moving in terms of lines of text. | |
121 * Screen Lines:: Moving in terms of lines as displayed. | |
122 * List Motion:: Moving by parsing lists and sexps. | |
123 * Skipping Characters:: Skipping characters belonging to a certain set. | |
124 @end menu | |
125 | |
126 @node Character Motion | |
127 @subsection Motion by Characters | |
128 | |
129 These functions move point based on a count of characters. | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
130 @code{goto-char} is the fundamental primitive; the other functions use |
6552 | 131 that. |
132 | |
133 @deffn Command goto-char position | |
134 This function sets point in the current buffer to the value | |
135 @var{position}. If @var{position} is less than 1, it moves point to the | |
136 beginning of the buffer. If @var{position} is greater than the length | |
137 of the buffer, it moves point to the end. | |
138 | |
139 If narrowing is in effect, @var{position} still counts from the | |
140 beginning of the buffer, but point cannot go outside the accessible | |
141 portion. If @var{position} is out of range, @code{goto-char} moves | |
142 point to the beginning or the end of the accessible portion. | |
143 | |
144 When this function is called interactively, @var{position} is the | |
145 numeric prefix argument, if provided; otherwise it is read from the | |
146 minibuffer. | |
147 | |
148 @code{goto-char} returns @var{position}. | |
149 @end deffn | |
150 | |
151 @deffn Command forward-char &optional count | |
152 @c @kindex beginning-of-buffer | |
153 @c @kindex end-of-buffer | |
154 This function moves point @var{count} characters forward, towards the | |
155 end of the buffer (or backward, towards the beginning of the buffer, if | |
156 @var{count} is negative). If the function attempts to move point past | |
157 the beginning or end of the buffer (or the limits of the accessible | |
158 portion, when narrowing is in effect), an error is signaled with error | |
159 code @code{beginning-of-buffer} or @code{end-of-buffer}. | |
160 | |
161 In an interactive call, @var{count} is the numeric prefix argument. | |
162 @end deffn | |
163 | |
164 @deffn Command backward-char &optional count | |
165 This function moves point @var{count} characters backward, towards the | |
166 beginning of the buffer (or forward, towards the end of the buffer, if | |
167 @var{count} is negative). If the function attempts to move point past | |
168 the beginning or end of the buffer (or the limits of the accessible | |
169 portion, when narrowing is in effect), an error is signaled with error | |
170 code @code{beginning-of-buffer} or @code{end-of-buffer}. | |
171 | |
172 In an interactive call, @var{count} is the numeric prefix argument. | |
173 @end deffn | |
174 | |
175 @node Word Motion | |
176 @subsection Motion by Words | |
177 | |
178 These functions for parsing words use the syntax table to decide | |
179 whether a given character is part of a word. @xref{Syntax Tables}. | |
180 | |
181 @deffn Command forward-word count | |
182 This function moves point forward @var{count} words (or backward if | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
183 @var{count} is negative). ``Moving one word'' means moving until point |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
184 crosses a word-constituent character and then encounters a |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
185 word-separator character (or the boundary of the accessible part of the |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
186 buffer). |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
187 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
188 If it is possible to move @var{count} words, without being stopped by |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
189 the buffer boundary (except perhaps after the last word), the value is |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
190 @code{t}. Otherwise, the return value is @code{nil} and point stops |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
191 at the buffer boundary. |
6552 | 192 |
193 In an interactive call, @var{count} is set to the numeric prefix | |
194 argument. | |
195 @end deffn | |
196 | |
197 @deffn Command backward-word count | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
198 This function is just like @code{forward-word}, except that it moves |
6552 | 199 backward until encountering the front of a word, rather than forward. |
200 | |
201 In an interactive call, @var{count} is set to the numeric prefix | |
202 argument. | |
203 | |
204 This function is rarely used in programs, as it is more efficient to | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
205 call @code{forward-word} with a negative argument. |
6552 | 206 @end deffn |
207 | |
208 @defvar words-include-escapes | |
209 @c Emacs 19 feature | |
210 This variable affects the behavior of @code{forward-word} and everything | |
211 that uses it. If it is non-@code{nil}, then characters in the | |
212 ``escape'' and ``character quote'' syntax classes count as part of | |
213 words. Otherwise, they do not. | |
214 @end defvar | |
215 | |
216 @node Buffer End Motion | |
217 @subsection Motion to an End of the Buffer | |
218 | |
219 To move point to the beginning of the buffer, write: | |
220 | |
221 @example | |
222 @group | |
223 (goto-char (point-min)) | |
224 @end group | |
225 @end example | |
226 | |
227 @noindent | |
228 Likewise, to move to the end of the buffer, use: | |
229 | |
230 @example | |
231 @group | |
232 (goto-char (point-max)) | |
233 @end group | |
234 @end example | |
235 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
236 Here are two commands that users use to do these things. They are |
6552 | 237 documented here to warn you not to use them in Lisp programs, because |
238 they set the mark and display messages in the echo area. | |
239 | |
240 @deffn Command beginning-of-buffer &optional n | |
241 This function moves point to the beginning of the buffer (or the limits | |
242 of the accessible portion, when narrowing is in effect), setting the | |
243 mark at the previous position. If @var{n} is non-@code{nil}, then it | |
244 puts point @var{n} tenths of the way from the beginning of the buffer. | |
245 | |
246 In an interactive call, @var{n} is the numeric prefix argument, | |
247 if provided; otherwise @var{n} defaults to @code{nil}. | |
248 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
249 @strong{Warning:} Don't use this function in Lisp programs! |
6552 | 250 @end deffn |
251 | |
252 @deffn Command end-of-buffer &optional n | |
253 This function moves point to the end of the buffer (or the limits of | |
254 the accessible portion, when narrowing is in effect), setting the mark | |
255 at the previous position. If @var{n} is non-@code{nil}, then it puts | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
256 point @var{n} tenths of the way from the end of the buffer. |
6552 | 257 |
258 In an interactive call, @var{n} is the numeric prefix argument, | |
259 if provided; otherwise @var{n} defaults to @code{nil}. | |
260 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
261 @strong{Warning:} Don't use this function in Lisp programs! |
6552 | 262 @end deffn |
263 | |
264 @node Text Lines | |
265 @subsection Motion by Text Lines | |
266 @cindex lines | |
267 | |
268 Text lines are portions of the buffer delimited by newline characters, | |
269 which are regarded as part of the previous line. The first text line | |
270 begins at the beginning of the buffer, and the last text line ends at | |
271 the end of the buffer whether or not the last character is a newline. | |
272 The division of the buffer into text lines is not affected by the width | |
273 of the window, by line continuation in display, or by how tabs and | |
274 control characters are displayed. | |
275 | |
276 @deffn Command goto-line line | |
277 This function moves point to the front of the @var{line}th line, | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
278 counting from line 1 at beginning of the buffer. If @var{line} is less |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
279 than 1, it moves point to the beginning of the buffer. If @var{line} is |
6552 | 280 greater than the number of lines in the buffer, it moves point to the |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
281 end of the buffer---that is, the @emph{end of the last line} of the |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
282 buffer. This is the only case in which @code{goto-line} does not |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
283 necessarily move to the beginning of a line. |
6552 | 284 |
285 If narrowing is in effect, then @var{line} still counts from the | |
286 beginning of the buffer, but point cannot go outside the accessible | |
287 portion. So @code{goto-line} moves point to the beginning or end of the | |
288 accessible portion, if the line number specifies an inaccessible | |
289 position. | |
290 | |
291 The return value of @code{goto-line} is the difference between | |
292 @var{line} and the line number of the line to which point actually was | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
293 able to move (in the full buffer, before taking account of narrowing). |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
294 Thus, the value is positive if the scan encounters the real end of the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
295 buffer before finding the specified line. The value is zero if scan |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
296 encounters the end of the accessible portion but not the real end of the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
297 buffer. |
6552 | 298 |
299 In an interactive call, @var{line} is the numeric prefix argument if | |
300 one has been provided. Otherwise @var{line} is read in the minibuffer. | |
301 @end deffn | |
302 | |
303 @deffn Command beginning-of-line &optional count | |
304 This function moves point to the beginning of the current line. With an | |
305 argument @var{count} not @code{nil} or 1, it moves forward | |
306 @var{count}@minus{}1 lines and then to the beginning of the line. | |
307 | |
308 If this function reaches the end of the buffer (or of the accessible | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
309 portion, if narrowing is in effect), it positions point there. No error |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
310 is signaled. |
6552 | 311 @end deffn |
312 | |
24702 | 313 @defun line-beginning-position &optional count |
314 @tindex line-beginning-position | |
315 Return the position that @code{(beginning-of-line @var{count})} | |
316 would move to. | |
317 @end defun | |
318 | |
6552 | 319 @deffn Command end-of-line &optional count |
320 This function moves point to the end of the current line. With an | |
321 argument @var{count} not @code{nil} or 1, it moves forward | |
322 @var{count}@minus{}1 lines and then to the end of the line. | |
323 | |
324 If this function reaches the end of the buffer (or of the accessible | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
325 portion, if narrowing is in effect), it positions point there. No error |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
326 is signaled. |
6552 | 327 @end deffn |
328 | |
24702 | 329 @defun line-end-position &optional count |
330 @tindex line-end-position | |
331 Return the position that @code{(end-of-line @var{count})} | |
332 would move to. | |
333 @end defun | |
334 | |
6552 | 335 @deffn Command forward-line &optional count |
336 @cindex beginning of line | |
337 This function moves point forward @var{count} lines, to the beginning of | |
338 the line. If @var{count} is negative, it moves point | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
339 @minus{}@var{count} lines backward, to the beginning of a line. If |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
340 @var{count} is zero, it moves point to the beginning of the current |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
341 line. |
6552 | 342 |
343 If @code{forward-line} encounters the beginning or end of the buffer (or | |
344 of the accessible portion) before finding that many lines, it sets point | |
345 there. No error is signaled. | |
346 | |
347 @code{forward-line} returns the difference between @var{count} and the | |
348 number of lines actually moved. If you attempt to move down five lines | |
349 from the beginning of a buffer that has only three lines, point stops at | |
350 the end of the last line, and the value will be 2. | |
351 | |
352 In an interactive call, @var{count} is the numeric prefix argument. | |
353 @end deffn | |
354 | |
355 @defun count-lines start end | |
356 @cindex lines in region | |
357 This function returns the number of lines between the positions | |
358 @var{start} and @var{end} in the current buffer. If @var{start} and | |
359 @var{end} are equal, then it returns 0. Otherwise it returns at least | |
360 1, even if @var{start} and @var{end} are on the same line. This is | |
361 because the text between them, considered in isolation, must contain at | |
362 least one line unless it is empty. | |
363 | |
364 Here is an example of using @code{count-lines}: | |
365 | |
366 @example | |
367 @group | |
368 (defun current-line () | |
369 "Return the vertical position of point@dots{}" | |
370 (+ (count-lines (window-start) (point)) | |
371 (if (= (current-column) 0) 1 0) | |
372 -1)) | |
373 @end group | |
374 @end example | |
375 @end defun | |
376 | |
377 @ignore | |
378 @c ================ | |
379 The @code{previous-line} and @code{next-line} commands are functions | |
380 that should not be used in programs. They are for users and are | |
381 mentioned here only for completeness. | |
382 | |
383 @deffn Command previous-line count | |
384 @cindex goal column | |
385 This function moves point up @var{count} lines (down if @var{count} | |
386 is negative). In moving, it attempts to keep point in the ``goal column'' | |
387 (normally the same column that it was at the beginning of the move). | |
388 | |
389 If there is no character in the target line exactly under the current | |
390 column, point is positioned after the character in that line which | |
391 spans this column, or at the end of the line if it is not long enough. | |
392 | |
393 If it attempts to move beyond the top or bottom of the buffer (or clipped | |
394 region), then point is positioned in the goal column in the top or | |
395 bottom line. No error is signaled. | |
396 | |
397 In an interactive call, @var{count} will be the numeric | |
398 prefix argument. | |
399 | |
400 The command @code{set-goal-column} can be used to create a semipermanent | |
401 goal column to which this command always moves. Then it does not try to | |
402 move vertically. | |
403 | |
404 If you are thinking of using this in a Lisp program, consider using | |
405 @code{forward-line} with a negative argument instead. It is usually easier | |
406 to use and more reliable (no dependence on goal column, etc.). | |
407 @end deffn | |
408 | |
409 @deffn Command next-line count | |
410 This function moves point down @var{count} lines (up if @var{count} | |
411 is negative). In moving, it attempts to keep point in the ``goal column'' | |
412 (normally the same column that it was at the beginning of the move). | |
413 | |
414 If there is no character in the target line exactly under the current | |
415 column, point is positioned after the character in that line which | |
416 spans this column, or at the end of the line if it is not long enough. | |
417 | |
418 If it attempts to move beyond the top or bottom of the buffer (or clipped | |
419 region), then point is positioned in the goal column in the top or | |
420 bottom line. No error is signaled. | |
421 | |
422 In the case where the @var{count} is 1, and point is on the last | |
423 line of the buffer (or clipped region), a new empty line is inserted at the | |
424 end of the buffer (or clipped region) and point moved there. | |
425 | |
426 In an interactive call, @var{count} will be the numeric | |
427 prefix argument. | |
428 | |
429 The command @code{set-goal-column} can be used to create a semipermanent | |
430 goal column to which this command always moves. Then it does not try to | |
431 move vertically. | |
432 | |
433 If you are thinking of using this in a Lisp program, consider using | |
434 @code{forward-line} instead. It is usually easier | |
435 to use and more reliable (no dependence on goal column, etc.). | |
436 @end deffn | |
437 | |
438 @c ================ | |
439 @end ignore | |
440 | |
441 Also see the functions @code{bolp} and @code{eolp} in @ref{Near Point}. | |
442 These functions do not move point, but test whether it is already at the | |
443 beginning or end of a line. | |
444 | |
445 @node Screen Lines | |
446 @subsection Motion by Screen Lines | |
447 | |
448 The line functions in the previous section count text lines, delimited | |
449 only by newline characters. By contrast, these functions count screen | |
450 lines, which are defined by the way the text appears on the screen. A | |
451 text line is a single screen line if it is short enough to fit the width | |
452 of the selected window, but otherwise it may occupy several screen | |
453 lines. | |
454 | |
455 In some cases, text lines are truncated on the screen rather than | |
456 continued onto additional screen lines. In these cases, | |
457 @code{vertical-motion} moves point much like @code{forward-line}. | |
458 @xref{Truncation}. | |
459 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
460 Because the width of a given string depends on the flags that control |
6552 | 461 the appearance of certain characters, @code{vertical-motion} behaves |
462 differently, for a given piece of text, depending on the buffer it is | |
463 in, and even on the selected window (because the width, the truncation | |
464 flag, and display table may vary between windows). @xref{Usual | |
465 Display}. | |
466 | |
9401
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
467 These functions scan text to determine where screen lines break, and |
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
468 thus take time proportional to the distance scanned. If you intend to |
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
469 use them heavily, Emacs provides caches which may improve the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
470 performance of your code. @xref{Truncation, cache-long-line-scans}. |
9401
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
471 |
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
472 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
473 @defun vertical-motion count &optional window |
6552 | 474 This function moves point to the start of the screen line @var{count} |
475 screen lines down from the screen line containing point. If @var{count} | |
476 is negative, it moves up instead. | |
477 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
478 @code{vertical-motion} returns the number of screen lines over which it |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
479 moved point. The value may be less in absolute value than @var{count} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
480 if the beginning or end of the buffer was reached. |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
481 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
482 The window @var{window} is used for obtaining parameters such as the |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
483 width, the horizontal scrolling, and the display table. But |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
484 @code{vertical-motion} always operates on the current buffer, even if |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
485 @var{window} currently displays some other buffer. |
6552 | 486 @end defun |
487 | |
488 @deffn Command move-to-window-line count | |
489 This function moves point with respect to the text currently displayed | |
490 in the selected window. It moves point to the beginning of the screen | |
491 line @var{count} screen lines from the top of the window. If | |
492 @var{count} is negative, that specifies a position | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
493 @w{@minus{}@var{count}} lines from the bottom (or the last line of the |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
494 buffer, if the buffer ends above the specified screen position). |
6552 | 495 |
496 If @var{count} is @code{nil}, then point moves to the beginning of the | |
497 line in the middle of the window. If the absolute value of @var{count} | |
498 is greater than the size of the window, then point moves to the place | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
499 that would appear on that screen line if the window were tall enough. |
6552 | 500 This will probably cause the next redisplay to scroll to bring that |
501 location onto the screen. | |
502 | |
503 In an interactive call, @var{count} is the numeric prefix argument. | |
504 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
505 The value returned is the window line number point has moved to, with |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
506 the top line in the window numbered 0. |
6552 | 507 @end deffn |
508 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
509 @defun compute-motion from frompos to topos width offsets window |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
510 This function scans the current buffer, calculating screen positions. |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
511 It scans the buffer forward from position @var{from}, assuming that is |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
512 at screen coordinates @var{frompos}, to position @var{to} or coordinates |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
513 @var{topos}, whichever comes first. It returns the ending buffer |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
514 position and screen coordinates. |
6552 | 515 |
516 The coordinate arguments @var{frompos} and @var{topos} are cons cells of | |
517 the form @code{(@var{hpos} . @var{vpos})}. | |
518 | |
519 The argument @var{width} is the number of columns available to display | |
520 text; this affects handling of continuation lines. Use the value | |
12098 | 521 returned by @code{window-width} for the window of your choice; |
522 normally, use @code{(window-width @var{window})}. | |
6552 | 523 |
524 The argument @var{offsets} is either @code{nil} or a cons cell of the | |
525 form @code{(@var{hscroll} . @var{tab-offset})}. Here @var{hscroll} is | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
526 the number of columns not being displayed at the left margin; most |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
527 callers get this by calling @code{window-hscroll}. Meanwhile, |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
528 @var{tab-offset} is the offset between column numbers on the screen and |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
529 column numbers in the buffer. This can be nonzero in a continuation |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
530 line, when the previous screen lines' widths do not add up to a multiple |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
531 of @code{tab-width}. It is always zero in a non-continuation line. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
532 |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
533 The window @var{window} serves only to specify which display table to |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
534 use. @code{compute-motion} always operates on the current buffer, |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
535 regardless of what buffer is displayed in @var{window}. |
6552 | 536 |
537 The return value is a list of five elements: | |
538 | |
539 @example | |
540 (@var{pos} @var{vpos} @var{hpos} @var{prevhpos} @var{contin}) | |
541 @end example | |
542 | |
543 @noindent | |
544 Here @var{pos} is the buffer position where the scan stopped, @var{vpos} | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
545 is the vertical screen position, and @var{hpos} is the horizontal screen |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
546 position. |
6552 | 547 |
548 The result @var{prevhpos} is the horizontal position one character back | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
549 from @var{pos}. The result @var{contin} is @code{t} if the last line |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
550 was continued after (or within) the previous character. |
6552 | 551 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
552 For example, to find the buffer position of column @var{col} of screen line |
6552 | 553 @var{line} of a certain window, pass the window's display start location |
554 as @var{from} and the window's upper-left coordinates as @var{frompos}. | |
555 Pass the buffer's @code{(point-max)} as @var{to}, to limit the scan to | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
556 the end of the accessible portion of the buffer, and pass @var{line} and |
6552 | 557 @var{col} as @var{topos}. Here's a function that does this: |
558 | |
559 @example | |
560 (defun coordinates-of-position (col line) | |
561 (car (compute-motion (window-start) | |
562 '(0 . 0) | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
563 (point-max) |
6552 | 564 (cons col line) |
565 (window-width) | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
566 (cons (window-hscroll) 0) |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
567 (selected-window)))) |
6552 | 568 @end example |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
569 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
570 When you use @code{compute-motion} for the minibuffer, you need to use |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
571 @code{minibuffer-prompt-width} to get the horizontal position of the |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
572 beginning of the first screen line. @xref{Minibuffer Misc}. |
6552 | 573 @end defun |
574 | |
575 @node List Motion | |
576 @comment node-name, next, previous, up | |
577 @subsection Moving over Balanced Expressions | |
578 @cindex sexp motion | |
579 @cindex Lisp expression motion | |
580 @cindex list motion | |
581 | |
582 Here are several functions concerned with balanced-parenthesis | |
583 expressions (also called @dfn{sexps} in connection with moving across | |
584 them in Emacs). The syntax table controls how these functions interpret | |
585 various characters; see @ref{Syntax Tables}. @xref{Parsing | |
586 Expressions}, for lower-level primitives for scanning sexps or parts of | |
14504
680aa532d697
(List Motion): Fix xref to Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
13074
diff
changeset
|
587 sexps. For user-level commands, see @ref{Lists Commands,,, emacs, GNU |
6552 | 588 Emacs Manual}. |
589 | |
590 @deffn Command forward-list arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
591 This function moves forward across @var{arg} balanced groups of |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
592 parentheses. (Other syntactic entities such as words or paired string |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
593 quotes are ignored.) |
6552 | 594 @end deffn |
595 | |
596 @deffn Command backward-list arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
597 This function moves backward across @var{arg} balanced groups of |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
598 parentheses. (Other syntactic entities such as words or paired string |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
599 quotes are ignored.) |
6552 | 600 @end deffn |
601 | |
602 @deffn Command up-list arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
603 This function moves forward out of @var{arg} levels of parentheses. |
6552 | 604 A negative argument means move backward but still to a less deep spot. |
605 @end deffn | |
606 | |
607 @deffn Command down-list arg | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
608 This function moves forward into @var{arg} levels of parentheses. A |
7734 | 609 negative argument means move backward but still go |
610 deeper in parentheses (@minus{}@var{arg} levels). | |
6552 | 611 @end deffn |
612 | |
613 @deffn Command forward-sexp arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
614 This function moves forward across @var{arg} balanced expressions. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
615 Balanced expressions include both those delimited by parentheses and |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
616 other kinds, such as words and string constants. For example, |
6552 | 617 |
618 @example | |
619 @group | |
620 ---------- Buffer: foo ---------- | |
621 (concat@point{} "foo " (car x) y z) | |
622 ---------- Buffer: foo ---------- | |
623 @end group | |
624 | |
625 @group | |
626 (forward-sexp 3) | |
627 @result{} nil | |
628 | |
629 ---------- Buffer: foo ---------- | |
630 (concat "foo " (car x) y@point{} z) | |
631 ---------- Buffer: foo ---------- | |
632 @end group | |
633 @end example | |
634 @end deffn | |
635 | |
636 @deffn Command backward-sexp arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
637 This function moves backward across @var{arg} balanced expressions. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
638 @end deffn |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
639 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
640 @deffn Command beginning-of-defun arg |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
641 This function moves back to the @var{arg}th beginning of a defun. If |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
642 @var{arg} is negative, this actually moves forward, but it still moves |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
643 to the beginning of a defun, not to the end of one. |
6552 | 644 @end deffn |
645 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
646 @deffn Command end-of-defun arg |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
647 This function moves forward to the @var{arg}th end of a defun. If |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
648 @var{arg} is negative, this actually moves backward, but it still moves |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
649 to the end of a defun, not to the beginning of one. |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
650 @end deffn |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
651 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
652 @defopt defun-prompt-regexp |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
653 If non-@code{nil}, this variable holds a regular expression that |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
654 specifies what text can appear before the open-parenthesis that starts a |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
655 defun. That is to say, a defun begins on a line that starts with a |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
656 match for this regular expression, followed by a character with |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
657 open-parenthesis syntax. |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
658 @end defopt |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
659 |
6552 | 660 @node Skipping Characters |
661 @comment node-name, next, previous, up | |
662 @subsection Skipping Characters | |
663 @cindex skipping characters | |
664 | |
665 The following two functions move point over a specified set of | |
666 characters. For example, they are often used to skip whitespace. For | |
667 related functions, see @ref{Motion and Syntax}. | |
668 | |
669 @defun skip-chars-forward character-set &optional limit | |
670 This function moves point in the current buffer forward, skipping over a | |
671 given set of characters. It examines the character following point, | |
672 then advances point if the character matches @var{character-set}. This | |
673 continues until it reaches a character that does not match. The | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
674 function returns the number of characters moved over. |
6552 | 675 |
676 The argument @var{character-set} is like the inside of a | |
677 @samp{[@dots{}]} in a regular expression except that @samp{]} is never | |
678 special and @samp{\} quotes @samp{^}, @samp{-} or @samp{\}. Thus, | |
679 @code{"a-zA-Z"} skips over all letters, stopping before the first | |
13074 | 680 nonletter, and @code{"^a-zA-Z"} skips nonletters stopping before the |
6552 | 681 first letter. @xref{Regular Expressions}. |
682 | |
683 If @var{limit} is supplied (it must be a number or a marker), it | |
684 specifies the maximum position in the buffer that point can be skipped | |
685 to. Point will stop at or before @var{limit}. | |
686 | |
687 In the following example, point is initially located directly before the | |
688 @samp{T}. After the form is evaluated, point is located at the end of | |
689 that line (between the @samp{t} of @samp{hat} and the newline). The | |
690 function skips all letters and spaces, but not newlines. | |
691 | |
692 @example | |
693 @group | |
694 ---------- Buffer: foo ---------- | |
695 I read "@point{}The cat in the hat | |
696 comes back" twice. | |
697 ---------- Buffer: foo ---------- | |
698 @end group | |
699 | |
700 @group | |
701 (skip-chars-forward "a-zA-Z ") | |
702 @result{} nil | |
703 | |
704 ---------- Buffer: foo ---------- | |
705 I read "The cat in the hat@point{} | |
706 comes back" twice. | |
707 ---------- Buffer: foo ---------- | |
708 @end group | |
709 @end example | |
710 @end defun | |
711 | |
712 @defun skip-chars-backward character-set &optional limit | |
713 This function moves point backward, skipping characters that match | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
714 @var{character-set}, until @var{limit}. It is just like |
6552 | 715 @code{skip-chars-forward} except for the direction of motion. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
716 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
717 The return value indicates the distance traveled. It is an integer that |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
718 is zero or less. |
6552 | 719 @end defun |
720 | |
721 @node Excursions | |
722 @section Excursions | |
723 @cindex excursion | |
724 | |
725 It is often useful to move point ``temporarily'' within a localized | |
726 portion of the program, or to switch buffers temporarily. This is | |
727 called an @dfn{excursion}, and it is done with the @code{save-excursion} | |
728 special form. This construct saves the current buffer and its values of | |
729 point and the mark so they can be restored after the completion of the | |
730 excursion. | |
731 | |
732 The forms for saving and restoring the configuration of windows are | |
733 described elsewhere (see @ref{Window Configurations}, and @pxref{Frame | |
734 Configurations}). | |
735 | |
736 @defspec save-excursion forms@dots{} | |
737 @cindex mark excursion | |
738 @cindex point excursion | |
739 @cindex current buffer excursion | |
740 The @code{save-excursion} special form saves the identity of the current | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
741 buffer and the values of point and the mark in it, evaluates |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
742 @var{forms}, and finally restores the buffer and its saved values of |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
743 point and the mark. All three saved values are restored even in case of |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
744 an abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). |
6552 | 745 |
746 The @code{save-excursion} special form is the standard way to switch | |
747 buffers or move point within one part of a program and avoid affecting | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
748 the rest of the program. It is used more than 4000 times in the Lisp |
6552 | 749 sources of Emacs. |
750 | |
751 @code{save-excursion} does not save the values of point and the mark for | |
752 other buffers, so changes in other buffers remain in effect after | |
753 @code{save-excursion} exits. | |
754 | |
755 @cindex window excursions | |
756 Likewise, @code{save-excursion} does not restore window-buffer | |
757 correspondences altered by functions such as @code{switch-to-buffer}. | |
758 One way to restore these correspondences, and the selected window, is to | |
759 use @code{save-window-excursion} inside @code{save-excursion} | |
760 (@pxref{Window Configurations}). | |
761 | |
762 The value returned by @code{save-excursion} is the result of the last of | |
763 @var{forms}, or @code{nil} if no @var{forms} are given. | |
764 | |
765 @example | |
766 @group | |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
767 (save-excursion @var{forms}) |
6552 | 768 @equiv{} |
769 (let ((old-buf (current-buffer)) | |
770 (old-pnt (point-marker)) | |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
771 @end group |
6552 | 772 (old-mark (copy-marker (mark-marker)))) |
773 (unwind-protect | |
774 (progn @var{forms}) | |
775 (set-buffer old-buf) | |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
776 @group |
6552 | 777 (goto-char old-pnt) |
778 (set-marker (mark-marker) old-mark))) | |
779 @end group | |
780 @end example | |
781 @end defspec | |
782 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
783 @strong{Warning:} Ordinary insertion of text adjacent to the saved |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
784 point value relocates the saved value, just as it relocates all markers. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
785 Therefore, when the saved point value is restored, it normally comes |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
786 before the inserted text. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
787 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
788 Although @code{save-excursion} saves the location of the mark, it does |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
789 not prevent functions which modify the buffer from setting |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
790 @code{deactivate-mark}, and thus causing the deactivation of the mark |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
791 after the command finishes. @xref{The Mark}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
792 |
6552 | 793 @node Narrowing |
794 @section Narrowing | |
795 @cindex narrowing | |
796 @cindex restriction (in a buffer) | |
797 @cindex accessible portion (of a buffer) | |
798 | |
799 @dfn{Narrowing} means limiting the text addressable by Emacs editing | |
800 commands to a limited range of characters in a buffer. The text that | |
801 remains addressable is called the @dfn{accessible portion} of the | |
802 buffer. | |
803 | |
804 Narrowing is specified with two buffer positions which become the | |
805 beginning and end of the accessible portion. For most editing commands | |
806 and most Emacs primitives, these positions replace the values of the | |
807 beginning and end of the buffer. While narrowing is in effect, no text | |
808 outside the accessible portion is displayed, and point cannot move | |
809 outside the accessible portion. | |
810 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
811 Values such as positions or line numbers, which usually count from the |
6552 | 812 beginning of the buffer, do so despite narrowing, but the functions |
813 which use them refuse to operate on text that is inaccessible. | |
814 | |
815 The commands for saving buffers are unaffected by narrowing; they save | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
816 the entire buffer regardless of any narrowing. |
6552 | 817 |
818 @deffn Command narrow-to-region start end | |
819 This function sets the accessible portion of the current buffer to start | |
820 at @var{start} and end at @var{end}. Both arguments should be character | |
821 positions. | |
822 | |
823 In an interactive call, @var{start} and @var{end} are set to the bounds | |
824 of the current region (point and the mark, with the smallest first). | |
825 @end deffn | |
826 | |
827 @deffn Command narrow-to-page move-count | |
828 This function sets the accessible portion of the current buffer to | |
829 include just the current page. An optional first argument | |
830 @var{move-count} non-@code{nil} means to move forward or backward by | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
831 @var{move-count} pages and then narrow to one page. The variable |
6552 | 832 @code{page-delimiter} specifies where pages start and end |
833 (@pxref{Standard Regexps}). | |
834 | |
835 In an interactive call, @var{move-count} is set to the numeric prefix | |
836 argument. | |
837 @end deffn | |
838 | |
839 @deffn Command widen | |
840 @cindex widening | |
841 This function cancels any narrowing in the current buffer, so that the | |
842 entire contents are accessible. This is called @dfn{widening}. | |
843 It is equivalent to the following expression: | |
844 | |
845 @example | |
846 (narrow-to-region 1 (1+ (buffer-size))) | |
847 @end example | |
848 @end deffn | |
849 | |
850 @defspec save-restriction body@dots{} | |
851 This special form saves the current bounds of the accessible portion, | |
852 evaluates the @var{body} forms, and finally restores the saved bounds, | |
853 thus restoring the same state of narrowing (or absence thereof) formerly | |
854 in effect. The state of narrowing is restored even in the event of an | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
855 abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
856 Therefore, this construct is a clean way to narrow a buffer temporarily. |
6552 | 857 |
858 The value returned by @code{save-restriction} is that returned by the | |
859 last form in @var{body}, or @code{nil} if no body forms were given. | |
860 | |
861 @c Wordy to avoid overfull hbox. --rjc 16mar92 | |
862 @strong{Caution:} it is easy to make a mistake when using the | |
863 @code{save-restriction} construct. Read the entire description here | |
864 before you try it. | |
865 | |
866 If @var{body} changes the current buffer, @code{save-restriction} still | |
867 restores the restrictions on the original buffer (the buffer whose | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
868 restrictions it saved from), but it does not restore the identity of the |
6552 | 869 current buffer. |
870 | |
871 @code{save-restriction} does @emph{not} restore point and the mark; use | |
872 @code{save-excursion} for that. If you use both @code{save-restriction} | |
873 and @code{save-excursion} together, @code{save-excursion} should come | |
874 first (on the outside). Otherwise, the old point value would be | |
875 restored with temporary narrowing still in effect. If the old point | |
876 value were outside the limits of the temporary narrowing, this would | |
877 fail to restore it accurately. | |
878 | |
879 The @code{save-restriction} special form records the values of the | |
880 beginning and end of the accessible portion as distances from the | |
881 beginning and end of the buffer. In other words, it records the amount | |
882 of inaccessible text before and after the accessible portion. | |
883 | |
884 This method yields correct results if @var{body} does further narrowing. | |
885 However, @code{save-restriction} can become confused if the body widens | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
886 and then makes changes outside the range of the saved narrowing. When |
6552 | 887 this is what you want to do, @code{save-restriction} is not the right |
888 tool for the job. Here is what you must use instead: | |
889 | |
890 @example | |
891 @group | |
892 (let ((beg (point-min-marker)) | |
893 (end (point-max-marker))) | |
894 (unwind-protect | |
895 (progn @var{body}) | |
896 (save-excursion | |
897 (set-buffer (marker-buffer beg)) | |
898 (narrow-to-region beg end)))) | |
899 @end group | |
900 @end example | |
901 | |
902 Here is a simple example of correct use of @code{save-restriction}: | |
903 | |
904 @example | |
905 @group | |
906 ---------- Buffer: foo ---------- | |
907 This is the contents of foo | |
908 This is the contents of foo | |
909 This is the contents of foo@point{} | |
910 ---------- Buffer: foo ---------- | |
911 @end group | |
912 | |
913 @group | |
914 (save-excursion | |
915 (save-restriction | |
916 (goto-char 1) | |
917 (forward-line 2) | |
918 (narrow-to-region 1 (point)) | |
919 (goto-char (point-min)) | |
920 (replace-string "foo" "bar"))) | |
921 | |
922 ---------- Buffer: foo ---------- | |
923 This is the contents of bar | |
924 This is the contents of bar | |
925 This is the contents of foo@point{} | |
926 ---------- Buffer: foo ---------- | |
927 @end group | |
928 @end example | |
929 @end defspec |