Mercurial > emacs
annotate lispref/positions.texi @ 23636:3246160c5469
(x-get-selection-value): Alias to
x-cut-buffer-or-selection-value.
(w32-standard-fontset-spec): New variable.
(w32-create-initial-fontsets, mouse-set-font): Check whether
new-fontset is available.
(w32-use-w32-font-dialog): Enable use of set-variable.
author | Geoff Voelker <voelker@cs.washington.edu> |
---|---|
date | Wed, 04 Nov 1998 23:23:57 +0000 |
parents | f0cd03a7dac9 |
children | 95815bc1f83b |
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 | |
313 @deffn Command end-of-line &optional count | |
314 This function moves point to the end of the current line. With an | |
315 argument @var{count} not @code{nil} or 1, it moves forward | |
316 @var{count}@minus{}1 lines and then to the end of the line. | |
317 | |
318 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
|
319 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
|
320 is signaled. |
6552 | 321 @end deffn |
322 | |
323 @deffn Command forward-line &optional count | |
324 @cindex beginning of line | |
325 This function moves point forward @var{count} lines, to the beginning of | |
326 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
|
327 @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
|
328 @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
|
329 line. |
6552 | 330 |
331 If @code{forward-line} encounters the beginning or end of the buffer (or | |
332 of the accessible portion) before finding that many lines, it sets point | |
333 there. No error is signaled. | |
334 | |
335 @code{forward-line} returns the difference between @var{count} and the | |
336 number of lines actually moved. If you attempt to move down five lines | |
337 from the beginning of a buffer that has only three lines, point stops at | |
338 the end of the last line, and the value will be 2. | |
339 | |
340 In an interactive call, @var{count} is the numeric prefix argument. | |
341 @end deffn | |
342 | |
343 @defun count-lines start end | |
344 @cindex lines in region | |
345 This function returns the number of lines between the positions | |
346 @var{start} and @var{end} in the current buffer. If @var{start} and | |
347 @var{end} are equal, then it returns 0. Otherwise it returns at least | |
348 1, even if @var{start} and @var{end} are on the same line. This is | |
349 because the text between them, considered in isolation, must contain at | |
350 least one line unless it is empty. | |
351 | |
352 Here is an example of using @code{count-lines}: | |
353 | |
354 @example | |
355 @group | |
356 (defun current-line () | |
357 "Return the vertical position of point@dots{}" | |
358 (+ (count-lines (window-start) (point)) | |
359 (if (= (current-column) 0) 1 0) | |
360 -1)) | |
361 @end group | |
362 @end example | |
363 @end defun | |
364 | |
365 @ignore | |
366 @c ================ | |
367 The @code{previous-line} and @code{next-line} commands are functions | |
368 that should not be used in programs. They are for users and are | |
369 mentioned here only for completeness. | |
370 | |
371 @deffn Command previous-line count | |
372 @cindex goal column | |
373 This function moves point up @var{count} lines (down if @var{count} | |
374 is negative). In moving, it attempts to keep point in the ``goal column'' | |
375 (normally the same column that it was at the beginning of the move). | |
376 | |
377 If there is no character in the target line exactly under the current | |
378 column, point is positioned after the character in that line which | |
379 spans this column, or at the end of the line if it is not long enough. | |
380 | |
381 If it attempts to move beyond the top or bottom of the buffer (or clipped | |
382 region), then point is positioned in the goal column in the top or | |
383 bottom line. No error is signaled. | |
384 | |
385 In an interactive call, @var{count} will be the numeric | |
386 prefix argument. | |
387 | |
388 The command @code{set-goal-column} can be used to create a semipermanent | |
389 goal column to which this command always moves. Then it does not try to | |
390 move vertically. | |
391 | |
392 If you are thinking of using this in a Lisp program, consider using | |
393 @code{forward-line} with a negative argument instead. It is usually easier | |
394 to use and more reliable (no dependence on goal column, etc.). | |
395 @end deffn | |
396 | |
397 @deffn Command next-line count | |
398 This function moves point down @var{count} lines (up if @var{count} | |
399 is negative). In moving, it attempts to keep point in the ``goal column'' | |
400 (normally the same column that it was at the beginning of the move). | |
401 | |
402 If there is no character in the target line exactly under the current | |
403 column, point is positioned after the character in that line which | |
404 spans this column, or at the end of the line if it is not long enough. | |
405 | |
406 If it attempts to move beyond the top or bottom of the buffer (or clipped | |
407 region), then point is positioned in the goal column in the top or | |
408 bottom line. No error is signaled. | |
409 | |
410 In the case where the @var{count} is 1, and point is on the last | |
411 line of the buffer (or clipped region), a new empty line is inserted at the | |
412 end of the buffer (or clipped region) and point moved there. | |
413 | |
414 In an interactive call, @var{count} will be the numeric | |
415 prefix argument. | |
416 | |
417 The command @code{set-goal-column} can be used to create a semipermanent | |
418 goal column to which this command always moves. Then it does not try to | |
419 move vertically. | |
420 | |
421 If you are thinking of using this in a Lisp program, consider using | |
422 @code{forward-line} instead. It is usually easier | |
423 to use and more reliable (no dependence on goal column, etc.). | |
424 @end deffn | |
425 | |
426 @c ================ | |
427 @end ignore | |
428 | |
429 Also see the functions @code{bolp} and @code{eolp} in @ref{Near Point}. | |
430 These functions do not move point, but test whether it is already at the | |
431 beginning or end of a line. | |
432 | |
433 @node Screen Lines | |
434 @subsection Motion by Screen Lines | |
435 | |
436 The line functions in the previous section count text lines, delimited | |
437 only by newline characters. By contrast, these functions count screen | |
438 lines, which are defined by the way the text appears on the screen. A | |
439 text line is a single screen line if it is short enough to fit the width | |
440 of the selected window, but otherwise it may occupy several screen | |
441 lines. | |
442 | |
443 In some cases, text lines are truncated on the screen rather than | |
444 continued onto additional screen lines. In these cases, | |
445 @code{vertical-motion} moves point much like @code{forward-line}. | |
446 @xref{Truncation}. | |
447 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
448 Because the width of a given string depends on the flags that control |
6552 | 449 the appearance of certain characters, @code{vertical-motion} behaves |
450 differently, for a given piece of text, depending on the buffer it is | |
451 in, and even on the selected window (because the width, the truncation | |
452 flag, and display table may vary between windows). @xref{Usual | |
453 Display}. | |
454 | |
9401
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
455 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
|
456 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
|
457 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
|
458 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
|
459 |
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
460 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
461 @defun vertical-motion count &optional window |
6552 | 462 This function moves point to the start of the screen line @var{count} |
463 screen lines down from the screen line containing point. If @var{count} | |
464 is negative, it moves up instead. | |
465 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
466 @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
|
467 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
|
468 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
|
469 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
470 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
|
471 width, the horizontal scrolling, and the display table. But |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
472 @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
|
473 @var{window} currently displays some other buffer. |
6552 | 474 @end defun |
475 | |
476 @deffn Command move-to-window-line count | |
477 This function moves point with respect to the text currently displayed | |
478 in the selected window. It moves point to the beginning of the screen | |
479 line @var{count} screen lines from the top of the window. If | |
480 @var{count} is negative, that specifies a position | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
481 @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
|
482 buffer, if the buffer ends above the specified screen position). |
6552 | 483 |
484 If @var{count} is @code{nil}, then point moves to the beginning of the | |
485 line in the middle of the window. If the absolute value of @var{count} | |
486 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
|
487 that would appear on that screen line if the window were tall enough. |
6552 | 488 This will probably cause the next redisplay to scroll to bring that |
489 location onto the screen. | |
490 | |
491 In an interactive call, @var{count} is the numeric prefix argument. | |
492 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
493 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
|
494 the top line in the window numbered 0. |
6552 | 495 @end deffn |
496 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
497 @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
|
498 This function scans the current buffer, calculating screen positions. |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
499 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
|
500 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
|
501 @var{topos}, whichever comes first. It returns the ending buffer |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
502 position and screen coordinates. |
6552 | 503 |
504 The coordinate arguments @var{frompos} and @var{topos} are cons cells of | |
505 the form @code{(@var{hpos} . @var{vpos})}. | |
506 | |
507 The argument @var{width} is the number of columns available to display | |
508 text; this affects handling of continuation lines. Use the value | |
12098 | 509 returned by @code{window-width} for the window of your choice; |
510 normally, use @code{(window-width @var{window})}. | |
6552 | 511 |
512 The argument @var{offsets} is either @code{nil} or a cons cell of the | |
513 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
|
514 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
|
515 callers get this by calling @code{window-hscroll}. Meanwhile, |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
516 @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
|
517 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
|
518 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
|
519 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
|
520 |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
521 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
|
522 use. @code{compute-motion} always operates on the current buffer, |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
523 regardless of what buffer is displayed in @var{window}. |
6552 | 524 |
525 The return value is a list of five elements: | |
526 | |
527 @example | |
528 (@var{pos} @var{vpos} @var{hpos} @var{prevhpos} @var{contin}) | |
529 @end example | |
530 | |
531 @noindent | |
532 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
|
533 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
|
534 position. |
6552 | 535 |
536 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
|
537 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
|
538 was continued after (or within) the previous character. |
6552 | 539 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
540 For example, to find the buffer position of column @var{col} of screen line |
6552 | 541 @var{line} of a certain window, pass the window's display start location |
542 as @var{from} and the window's upper-left coordinates as @var{frompos}. | |
543 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
|
544 the end of the accessible portion of the buffer, and pass @var{line} and |
6552 | 545 @var{col} as @var{topos}. Here's a function that does this: |
546 | |
547 @example | |
548 (defun coordinates-of-position (col line) | |
549 (car (compute-motion (window-start) | |
550 '(0 . 0) | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
551 (point-max) |
6552 | 552 (cons col line) |
553 (window-width) | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
554 (cons (window-hscroll) 0) |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
555 (selected-window)))) |
6552 | 556 @end example |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
557 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
558 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
|
559 @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
|
560 beginning of the first screen line. @xref{Minibuffer Misc}. |
6552 | 561 @end defun |
562 | |
563 @node List Motion | |
564 @comment node-name, next, previous, up | |
565 @subsection Moving over Balanced Expressions | |
566 @cindex sexp motion | |
567 @cindex Lisp expression motion | |
568 @cindex list motion | |
569 | |
570 Here are several functions concerned with balanced-parenthesis | |
571 expressions (also called @dfn{sexps} in connection with moving across | |
572 them in Emacs). The syntax table controls how these functions interpret | |
573 various characters; see @ref{Syntax Tables}. @xref{Parsing | |
574 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
|
575 sexps. For user-level commands, see @ref{Lists Commands,,, emacs, GNU |
6552 | 576 Emacs Manual}. |
577 | |
578 @deffn Command forward-list arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
579 This function moves forward across @var{arg} balanced groups of |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
580 parentheses. (Other syntactic entities such as words or paired string |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
581 quotes are ignored.) |
6552 | 582 @end deffn |
583 | |
584 @deffn Command backward-list arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
585 This function moves backward across @var{arg} balanced groups of |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
586 parentheses. (Other syntactic entities such as words or paired string |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
587 quotes are ignored.) |
6552 | 588 @end deffn |
589 | |
590 @deffn Command up-list arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
591 This function moves forward out of @var{arg} levels of parentheses. |
6552 | 592 A negative argument means move backward but still to a less deep spot. |
593 @end deffn | |
594 | |
595 @deffn Command down-list arg | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
596 This function moves forward into @var{arg} levels of parentheses. A |
7734 | 597 negative argument means move backward but still go |
598 deeper in parentheses (@minus{}@var{arg} levels). | |
6552 | 599 @end deffn |
600 | |
601 @deffn Command forward-sexp arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
602 This function moves forward across @var{arg} balanced expressions. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
603 Balanced expressions include both those delimited by parentheses and |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
604 other kinds, such as words and string constants. For example, |
6552 | 605 |
606 @example | |
607 @group | |
608 ---------- Buffer: foo ---------- | |
609 (concat@point{} "foo " (car x) y z) | |
610 ---------- Buffer: foo ---------- | |
611 @end group | |
612 | |
613 @group | |
614 (forward-sexp 3) | |
615 @result{} nil | |
616 | |
617 ---------- Buffer: foo ---------- | |
618 (concat "foo " (car x) y@point{} z) | |
619 ---------- Buffer: foo ---------- | |
620 @end group | |
621 @end example | |
622 @end deffn | |
623 | |
624 @deffn Command backward-sexp arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
625 This function moves backward across @var{arg} balanced expressions. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
626 @end deffn |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
627 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
628 @deffn Command beginning-of-defun arg |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
629 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
|
630 @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
|
631 to the beginning of a defun, not to the end of one. |
6552 | 632 @end deffn |
633 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
634 @deffn Command end-of-defun arg |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
635 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
|
636 @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
|
637 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
|
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 @defopt defun-prompt-regexp |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
641 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
|
642 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
|
643 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
|
644 match for this regular expression, followed by a character with |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
645 open-parenthesis syntax. |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
646 @end defopt |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
647 |
6552 | 648 @node Skipping Characters |
649 @comment node-name, next, previous, up | |
650 @subsection Skipping Characters | |
651 @cindex skipping characters | |
652 | |
653 The following two functions move point over a specified set of | |
654 characters. For example, they are often used to skip whitespace. For | |
655 related functions, see @ref{Motion and Syntax}. | |
656 | |
657 @defun skip-chars-forward character-set &optional limit | |
658 This function moves point in the current buffer forward, skipping over a | |
659 given set of characters. It examines the character following point, | |
660 then advances point if the character matches @var{character-set}. This | |
661 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
|
662 function returns the number of characters moved over. |
6552 | 663 |
664 The argument @var{character-set} is like the inside of a | |
665 @samp{[@dots{}]} in a regular expression except that @samp{]} is never | |
666 special and @samp{\} quotes @samp{^}, @samp{-} or @samp{\}. Thus, | |
667 @code{"a-zA-Z"} skips over all letters, stopping before the first | |
13074 | 668 nonletter, and @code{"^a-zA-Z"} skips nonletters stopping before the |
6552 | 669 first letter. @xref{Regular Expressions}. |
670 | |
671 If @var{limit} is supplied (it must be a number or a marker), it | |
672 specifies the maximum position in the buffer that point can be skipped | |
673 to. Point will stop at or before @var{limit}. | |
674 | |
675 In the following example, point is initially located directly before the | |
676 @samp{T}. After the form is evaluated, point is located at the end of | |
677 that line (between the @samp{t} of @samp{hat} and the newline). The | |
678 function skips all letters and spaces, but not newlines. | |
679 | |
680 @example | |
681 @group | |
682 ---------- Buffer: foo ---------- | |
683 I read "@point{}The cat in the hat | |
684 comes back" twice. | |
685 ---------- Buffer: foo ---------- | |
686 @end group | |
687 | |
688 @group | |
689 (skip-chars-forward "a-zA-Z ") | |
690 @result{} nil | |
691 | |
692 ---------- Buffer: foo ---------- | |
693 I read "The cat in the hat@point{} | |
694 comes back" twice. | |
695 ---------- Buffer: foo ---------- | |
696 @end group | |
697 @end example | |
698 @end defun | |
699 | |
700 @defun skip-chars-backward character-set &optional limit | |
701 This function moves point backward, skipping characters that match | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
14504
diff
changeset
|
702 @var{character-set}, until @var{limit}. It is just like |
6552 | 703 @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
|
704 |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
705 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
|
706 is zero or less. |
6552 | 707 @end defun |
708 | |
709 @node Excursions | |
710 @section Excursions | |
711 @cindex excursion | |
712 | |
713 It is often useful to move point ``temporarily'' within a localized | |
714 portion of the program, or to switch buffers temporarily. This is | |
715 called an @dfn{excursion}, and it is done with the @code{save-excursion} | |
716 special form. This construct saves the current buffer and its values of | |
717 point and the mark so they can be restored after the completion of the | |
718 excursion. | |
719 | |
720 The forms for saving and restoring the configuration of windows are | |
721 described elsewhere (see @ref{Window Configurations}, and @pxref{Frame | |
722 Configurations}). | |
723 | |
724 @defspec save-excursion forms@dots{} | |
725 @cindex mark excursion | |
726 @cindex point excursion | |
727 @cindex current buffer excursion | |
728 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
|
729 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
|
730 @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
|
731 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
|
732 an abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). |
6552 | 733 |
734 The @code{save-excursion} special form is the standard way to switch | |
735 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
|
736 the rest of the program. It is used more than 4000 times in the Lisp |
6552 | 737 sources of Emacs. |
738 | |
739 @code{save-excursion} does not save the values of point and the mark for | |
740 other buffers, so changes in other buffers remain in effect after | |
741 @code{save-excursion} exits. | |
742 | |
743 @cindex window excursions | |
744 Likewise, @code{save-excursion} does not restore window-buffer | |
745 correspondences altered by functions such as @code{switch-to-buffer}. | |
746 One way to restore these correspondences, and the selected window, is to | |
747 use @code{save-window-excursion} inside @code{save-excursion} | |
748 (@pxref{Window Configurations}). | |
749 | |
750 The value returned by @code{save-excursion} is the result of the last of | |
751 @var{forms}, or @code{nil} if no @var{forms} are given. | |
752 | |
753 @example | |
754 @group | |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
755 (save-excursion @var{forms}) |
6552 | 756 @equiv{} |
757 (let ((old-buf (current-buffer)) | |
758 (old-pnt (point-marker)) | |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
759 @end group |
6552 | 760 (old-mark (copy-marker (mark-marker)))) |
761 (unwind-protect | |
762 (progn @var{forms}) | |
763 (set-buffer old-buf) | |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
764 @group |
6552 | 765 (goto-char old-pnt) |
766 (set-marker (mark-marker) old-mark))) | |
767 @end group | |
768 @end example | |
769 @end defspec | |
770 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
771 @strong{Warning:} Ordinary insertion of text adjacent to the saved |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
772 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
|
773 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
|
774 before the inserted text. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
775 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
776 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
|
777 not prevent functions which modify the buffer from setting |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
778 @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
|
779 after the command finishes. @xref{The Mark}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
780 |
6552 | 781 @node Narrowing |
782 @section Narrowing | |
783 @cindex narrowing | |
784 @cindex restriction (in a buffer) | |
785 @cindex accessible portion (of a buffer) | |
786 | |
787 @dfn{Narrowing} means limiting the text addressable by Emacs editing | |
788 commands to a limited range of characters in a buffer. The text that | |
789 remains addressable is called the @dfn{accessible portion} of the | |
790 buffer. | |
791 | |
792 Narrowing is specified with two buffer positions which become the | |
793 beginning and end of the accessible portion. For most editing commands | |
794 and most Emacs primitives, these positions replace the values of the | |
795 beginning and end of the buffer. While narrowing is in effect, no text | |
796 outside the accessible portion is displayed, and point cannot move | |
797 outside the accessible portion. | |
798 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
799 Values such as positions or line numbers, which usually count from the |
6552 | 800 beginning of the buffer, do so despite narrowing, but the functions |
801 which use them refuse to operate on text that is inaccessible. | |
802 | |
803 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
|
804 the entire buffer regardless of any narrowing. |
6552 | 805 |
806 @deffn Command narrow-to-region start end | |
807 This function sets the accessible portion of the current buffer to start | |
808 at @var{start} and end at @var{end}. Both arguments should be character | |
809 positions. | |
810 | |
811 In an interactive call, @var{start} and @var{end} are set to the bounds | |
812 of the current region (point and the mark, with the smallest first). | |
813 @end deffn | |
814 | |
815 @deffn Command narrow-to-page move-count | |
816 This function sets the accessible portion of the current buffer to | |
817 include just the current page. An optional first argument | |
818 @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
|
819 @var{move-count} pages and then narrow to one page. The variable |
6552 | 820 @code{page-delimiter} specifies where pages start and end |
821 (@pxref{Standard Regexps}). | |
822 | |
823 In an interactive call, @var{move-count} is set to the numeric prefix | |
824 argument. | |
825 @end deffn | |
826 | |
827 @deffn Command widen | |
828 @cindex widening | |
829 This function cancels any narrowing in the current buffer, so that the | |
830 entire contents are accessible. This is called @dfn{widening}. | |
831 It is equivalent to the following expression: | |
832 | |
833 @example | |
834 (narrow-to-region 1 (1+ (buffer-size))) | |
835 @end example | |
836 @end deffn | |
837 | |
838 @defspec save-restriction body@dots{} | |
839 This special form saves the current bounds of the accessible portion, | |
840 evaluates the @var{body} forms, and finally restores the saved bounds, | |
841 thus restoring the same state of narrowing (or absence thereof) formerly | |
842 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
|
843 abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
844 Therefore, this construct is a clean way to narrow a buffer temporarily. |
6552 | 845 |
846 The value returned by @code{save-restriction} is that returned by the | |
847 last form in @var{body}, or @code{nil} if no body forms were given. | |
848 | |
849 @c Wordy to avoid overfull hbox. --rjc 16mar92 | |
850 @strong{Caution:} it is easy to make a mistake when using the | |
851 @code{save-restriction} construct. Read the entire description here | |
852 before you try it. | |
853 | |
854 If @var{body} changes the current buffer, @code{save-restriction} still | |
855 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
|
856 restrictions it saved from), but it does not restore the identity of the |
6552 | 857 current buffer. |
858 | |
859 @code{save-restriction} does @emph{not} restore point and the mark; use | |
860 @code{save-excursion} for that. If you use both @code{save-restriction} | |
861 and @code{save-excursion} together, @code{save-excursion} should come | |
862 first (on the outside). Otherwise, the old point value would be | |
863 restored with temporary narrowing still in effect. If the old point | |
864 value were outside the limits of the temporary narrowing, this would | |
865 fail to restore it accurately. | |
866 | |
867 The @code{save-restriction} special form records the values of the | |
868 beginning and end of the accessible portion as distances from the | |
869 beginning and end of the buffer. In other words, it records the amount | |
870 of inaccessible text before and after the accessible portion. | |
871 | |
872 This method yields correct results if @var{body} does further narrowing. | |
873 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
|
874 and then makes changes outside the range of the saved narrowing. When |
6552 | 875 this is what you want to do, @code{save-restriction} is not the right |
876 tool for the job. Here is what you must use instead: | |
877 | |
878 @example | |
879 @group | |
880 (let ((beg (point-min-marker)) | |
881 (end (point-max-marker))) | |
882 (unwind-protect | |
883 (progn @var{body}) | |
884 (save-excursion | |
885 (set-buffer (marker-buffer beg)) | |
886 (narrow-to-region beg end)))) | |
887 @end group | |
888 @end example | |
889 | |
890 Here is a simple example of correct use of @code{save-restriction}: | |
891 | |
892 @example | |
893 @group | |
894 ---------- Buffer: foo ---------- | |
895 This is the contents of foo | |
896 This is the contents of foo | |
897 This is the contents of foo@point{} | |
898 ---------- Buffer: foo ---------- | |
899 @end group | |
900 | |
901 @group | |
902 (save-excursion | |
903 (save-restriction | |
904 (goto-char 1) | |
905 (forward-line 2) | |
906 (narrow-to-region 1 (point)) | |
907 (goto-char (point-min)) | |
908 (replace-string "foo" "bar"))) | |
909 | |
910 ---------- Buffer: foo ---------- | |
911 This is the contents of bar | |
912 This is the contents of bar | |
913 This is the contents of foo@point{} | |
914 ---------- Buffer: foo ---------- | |
915 @end group | |
916 @end example | |
917 @end defspec |