Mercurial > emacs
annotate lispref/positions.texi @ 13054:b2df0396fae2
(rmail-file-p): Function moved to mail-utils.el
and renamed to mail-file-babyl-p.
(rmail-output, rmail-output-to-rmail-file): Use new name.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Thu, 21 Sep 1995 20:20:11 +0000 |
parents | a6eb5f12b0f3 |
children | c361ef50ec0f |
rev | line source |
---|---|
6552 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc. | |
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 | |
183 @var{count} is negative). Normally it returns @code{t}. If this motion | |
184 encounters the beginning or end of the buffer, or the limits of the | |
185 accessible portion when narrowing is in effect, point stops there | |
186 and the value is @code{nil}. | |
187 | |
188 In an interactive call, @var{count} is set to the numeric prefix | |
189 argument. | |
190 @end deffn | |
191 | |
192 @deffn Command backward-word count | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
193 This function is just like @code{forward-word}, except that it moves |
6552 | 194 backward until encountering the front of a word, rather than forward. |
195 | |
196 In an interactive call, @var{count} is set to the numeric prefix | |
197 argument. | |
198 | |
199 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
|
200 call @code{forward-word} with a negative argument. |
6552 | 201 @end deffn |
202 | |
203 @defvar words-include-escapes | |
204 @c Emacs 19 feature | |
205 This variable affects the behavior of @code{forward-word} and everything | |
206 that uses it. If it is non-@code{nil}, then characters in the | |
207 ``escape'' and ``character quote'' syntax classes count as part of | |
208 words. Otherwise, they do not. | |
209 @end defvar | |
210 | |
211 @node Buffer End Motion | |
212 @subsection Motion to an End of the Buffer | |
213 | |
214 To move point to the beginning of the buffer, write: | |
215 | |
216 @example | |
217 @group | |
218 (goto-char (point-min)) | |
219 @end group | |
220 @end example | |
221 | |
222 @noindent | |
223 Likewise, to move to the end of the buffer, use: | |
224 | |
225 @example | |
226 @group | |
227 (goto-char (point-max)) | |
228 @end group | |
229 @end example | |
230 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
231 Here are two commands that users use to do these things. They are |
6552 | 232 documented here to warn you not to use them in Lisp programs, because |
233 they set the mark and display messages in the echo area. | |
234 | |
235 @deffn Command beginning-of-buffer &optional n | |
236 This function moves point to the beginning of the buffer (or the limits | |
237 of the accessible portion, when narrowing is in effect), setting the | |
238 mark at the previous position. If @var{n} is non-@code{nil}, then it | |
239 puts point @var{n} tenths of the way from the beginning of the buffer. | |
240 | |
241 In an interactive call, @var{n} is the numeric prefix argument, | |
242 if provided; otherwise @var{n} defaults to @code{nil}. | |
243 | |
244 Don't use this function in Lisp programs! | |
245 @end deffn | |
246 | |
247 @deffn Command end-of-buffer &optional n | |
248 This function moves point to the end of the buffer (or the limits of | |
249 the accessible portion, when narrowing is in effect), setting the mark | |
250 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
|
251 point @var{n} tenths of the way from the end of the buffer. |
6552 | 252 |
253 In an interactive call, @var{n} is the numeric prefix argument, | |
254 if provided; otherwise @var{n} defaults to @code{nil}. | |
255 | |
256 Don't use this function in Lisp programs! | |
257 @end deffn | |
258 | |
259 @node Text Lines | |
260 @subsection Motion by Text Lines | |
261 @cindex lines | |
262 | |
263 Text lines are portions of the buffer delimited by newline characters, | |
264 which are regarded as part of the previous line. The first text line | |
265 begins at the beginning of the buffer, and the last text line ends at | |
266 the end of the buffer whether or not the last character is a newline. | |
267 The division of the buffer into text lines is not affected by the width | |
268 of the window, by line continuation in display, or by how tabs and | |
269 control characters are displayed. | |
270 | |
271 @deffn Command goto-line line | |
272 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
|
273 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
|
274 than 1, it moves point to the beginning of the buffer. If @var{line} is |
6552 | 275 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
|
276 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
|
277 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
|
278 necessarily move to the beginning of a line. |
6552 | 279 |
280 If narrowing is in effect, then @var{line} still counts from the | |
281 beginning of the buffer, but point cannot go outside the accessible | |
282 portion. So @code{goto-line} moves point to the beginning or end of the | |
283 accessible portion, if the line number specifies an inaccessible | |
284 position. | |
285 | |
286 The return value of @code{goto-line} is the difference between | |
287 @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
|
288 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
|
289 Thus, the value is positive if the scan encounters the real end of the |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
290 buffer. The value is zero if scan encounters the end of the accessible |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
291 portion but not the real end of the buffer. |
6552 | 292 |
293 In an interactive call, @var{line} is the numeric prefix argument if | |
294 one has been provided. Otherwise @var{line} is read in the minibuffer. | |
295 @end deffn | |
296 | |
297 @deffn Command beginning-of-line &optional count | |
298 This function moves point to the beginning of the current line. With an | |
299 argument @var{count} not @code{nil} or 1, it moves forward | |
300 @var{count}@minus{}1 lines and then to the beginning of the line. | |
301 | |
302 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
|
303 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
|
304 is signaled. |
6552 | 305 @end deffn |
306 | |
307 @deffn Command end-of-line &optional count | |
308 This function moves point to the end of the current line. With an | |
309 argument @var{count} not @code{nil} or 1, it moves forward | |
310 @var{count}@minus{}1 lines and then to the end of the line. | |
311 | |
312 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
|
313 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
|
314 is signaled. |
6552 | 315 @end deffn |
316 | |
317 @deffn Command forward-line &optional count | |
318 @cindex beginning of line | |
319 This function moves point forward @var{count} lines, to the beginning of | |
320 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
|
321 @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
|
322 @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
|
323 line. |
6552 | 324 |
325 If @code{forward-line} encounters the beginning or end of the buffer (or | |
326 of the accessible portion) before finding that many lines, it sets point | |
327 there. No error is signaled. | |
328 | |
329 @code{forward-line} returns the difference between @var{count} and the | |
330 number of lines actually moved. If you attempt to move down five lines | |
331 from the beginning of a buffer that has only three lines, point stops at | |
332 the end of the last line, and the value will be 2. | |
333 | |
334 In an interactive call, @var{count} is the numeric prefix argument. | |
335 @end deffn | |
336 | |
337 @defun count-lines start end | |
338 @cindex lines in region | |
339 This function returns the number of lines between the positions | |
340 @var{start} and @var{end} in the current buffer. If @var{start} and | |
341 @var{end} are equal, then it returns 0. Otherwise it returns at least | |
342 1, even if @var{start} and @var{end} are on the same line. This is | |
343 because the text between them, considered in isolation, must contain at | |
344 least one line unless it is empty. | |
345 | |
346 Here is an example of using @code{count-lines}: | |
347 | |
348 @example | |
349 @group | |
350 (defun current-line () | |
351 "Return the vertical position of point@dots{}" | |
352 (+ (count-lines (window-start) (point)) | |
353 (if (= (current-column) 0) 1 0) | |
354 -1)) | |
355 @end group | |
356 @end example | |
357 @end defun | |
358 | |
359 @ignore | |
360 @c ================ | |
361 The @code{previous-line} and @code{next-line} commands are functions | |
362 that should not be used in programs. They are for users and are | |
363 mentioned here only for completeness. | |
364 | |
365 @deffn Command previous-line count | |
366 @cindex goal column | |
367 This function moves point up @var{count} lines (down if @var{count} | |
368 is negative). In moving, it attempts to keep point in the ``goal column'' | |
369 (normally the same column that it was at the beginning of the move). | |
370 | |
371 If there is no character in the target line exactly under the current | |
372 column, point is positioned after the character in that line which | |
373 spans this column, or at the end of the line if it is not long enough. | |
374 | |
375 If it attempts to move beyond the top or bottom of the buffer (or clipped | |
376 region), then point is positioned in the goal column in the top or | |
377 bottom line. No error is signaled. | |
378 | |
379 In an interactive call, @var{count} will be the numeric | |
380 prefix argument. | |
381 | |
382 The command @code{set-goal-column} can be used to create a semipermanent | |
383 goal column to which this command always moves. Then it does not try to | |
384 move vertically. | |
385 | |
386 If you are thinking of using this in a Lisp program, consider using | |
387 @code{forward-line} with a negative argument instead. It is usually easier | |
388 to use and more reliable (no dependence on goal column, etc.). | |
389 @end deffn | |
390 | |
391 @deffn Command next-line count | |
392 This function moves point down @var{count} lines (up if @var{count} | |
393 is negative). In moving, it attempts to keep point in the ``goal column'' | |
394 (normally the same column that it was at the beginning of the move). | |
395 | |
396 If there is no character in the target line exactly under the current | |
397 column, point is positioned after the character in that line which | |
398 spans this column, or at the end of the line if it is not long enough. | |
399 | |
400 If it attempts to move beyond the top or bottom of the buffer (or clipped | |
401 region), then point is positioned in the goal column in the top or | |
402 bottom line. No error is signaled. | |
403 | |
404 In the case where the @var{count} is 1, and point is on the last | |
405 line of the buffer (or clipped region), a new empty line is inserted at the | |
406 end of the buffer (or clipped region) and point moved there. | |
407 | |
408 In an interactive call, @var{count} will be the numeric | |
409 prefix argument. | |
410 | |
411 The command @code{set-goal-column} can be used to create a semipermanent | |
412 goal column to which this command always moves. Then it does not try to | |
413 move vertically. | |
414 | |
415 If you are thinking of using this in a Lisp program, consider using | |
416 @code{forward-line} instead. It is usually easier | |
417 to use and more reliable (no dependence on goal column, etc.). | |
418 @end deffn | |
419 | |
420 @c ================ | |
421 @end ignore | |
422 | |
423 Also see the functions @code{bolp} and @code{eolp} in @ref{Near Point}. | |
424 These functions do not move point, but test whether it is already at the | |
425 beginning or end of a line. | |
426 | |
427 @node Screen Lines | |
428 @subsection Motion by Screen Lines | |
429 | |
430 The line functions in the previous section count text lines, delimited | |
431 only by newline characters. By contrast, these functions count screen | |
432 lines, which are defined by the way the text appears on the screen. A | |
433 text line is a single screen line if it is short enough to fit the width | |
434 of the selected window, but otherwise it may occupy several screen | |
435 lines. | |
436 | |
437 In some cases, text lines are truncated on the screen rather than | |
438 continued onto additional screen lines. In these cases, | |
439 @code{vertical-motion} moves point much like @code{forward-line}. | |
440 @xref{Truncation}. | |
441 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
442 Because the width of a given string depends on the flags that control |
6552 | 443 the appearance of certain characters, @code{vertical-motion} behaves |
444 differently, for a given piece of text, depending on the buffer it is | |
445 in, and even on the selected window (because the width, the truncation | |
446 flag, and display table may vary between windows). @xref{Usual | |
447 Display}. | |
448 | |
9401
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
449 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
|
450 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
|
451 use them heavily, Emacs provides caches which may improve the |
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
452 performance of your code. @xref{Text Lines, cache-long-line-scans}. |
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
453 |
32ae92d81323
Document cache-long-line-scans in @node Text Lines.
Jim Blandy <jimb@redhat.com>
parents:
7734
diff
changeset
|
454 |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
455 @defun vertical-motion count &optional window |
6552 | 456 This function moves point to the start of the screen line @var{count} |
457 screen lines down from the screen line containing point. If @var{count} | |
458 is negative, it moves up instead. | |
459 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
460 @code{vertical-motion} returns the number of lines moved. The value may |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
461 be less in absolute value than @var{count} if the beginning or end of |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
462 the buffer was reached. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
463 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
464 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
|
465 width, the horizontal scrolling, and the display table. But |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
466 @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
|
467 @var{window} currently displays some other buffer. |
6552 | 468 @end defun |
469 | |
470 @deffn Command move-to-window-line count | |
471 This function moves point with respect to the text currently displayed | |
472 in the selected window. It moves point to the beginning of the screen | |
473 line @var{count} screen lines from the top of the window. If | |
474 @var{count} is negative, that specifies a position | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
475 @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
|
476 buffer, if the buffer ends above the specified screen position). |
6552 | 477 |
478 If @var{count} is @code{nil}, then point moves to the beginning of the | |
479 line in the middle of the window. If the absolute value of @var{count} | |
480 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
|
481 that would appear on that screen line if the window were tall enough. |
6552 | 482 This will probably cause the next redisplay to scroll to bring that |
483 location onto the screen. | |
484 | |
485 In an interactive call, @var{count} is the numeric prefix argument. | |
486 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
487 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
|
488 the top line in the window numbered 0. |
6552 | 489 @end deffn |
490 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
491 @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
|
492 This function scans the current buffer, calculating screen positions. |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
493 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
|
494 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
|
495 @var{topos}, whichever comes first. It returns the ending buffer |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
496 position and screen coordinates. |
6552 | 497 |
498 The coordinate arguments @var{frompos} and @var{topos} are cons cells of | |
499 the form @code{(@var{hpos} . @var{vpos})}. | |
500 | |
501 The argument @var{width} is the number of columns available to display | |
502 text; this affects handling of continuation lines. Use the value | |
12098 | 503 returned by @code{window-width} for the window of your choice; |
504 normally, use @code{(window-width @var{window})}. | |
6552 | 505 |
506 The argument @var{offsets} is either @code{nil} or a cons cell of the | |
507 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
|
508 the number of columns not being displayed at the left margin; most |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
509 callers get this from @code{window-hscroll}. Meanwhile, |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
510 @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
|
511 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
|
512 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
|
513 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
|
514 |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
515 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
|
516 use. @code{compute-motion} always operates on the current buffer, |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
517 regardless of what buffer is displayed in @var{window}. |
6552 | 518 |
519 The return value is a list of five elements: | |
520 | |
521 @example | |
522 (@var{pos} @var{vpos} @var{hpos} @var{prevhpos} @var{contin}) | |
523 @end example | |
524 | |
525 @noindent | |
526 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
|
527 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
|
528 position. |
6552 | 529 |
530 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
|
531 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
|
532 was continued after (or within) the previous character. |
6552 | 533 |
534 For example, to find the buffer position of column @var{col} of line | |
535 @var{line} of a certain window, pass the window's display start location | |
536 as @var{from} and the window's upper-left coordinates as @var{frompos}. | |
537 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
|
538 the end of the accessible portion of the buffer, and pass @var{line} and |
6552 | 539 @var{col} as @var{topos}. Here's a function that does this: |
540 | |
541 @example | |
542 (defun coordinates-of-position (col line) | |
543 (car (compute-motion (window-start) | |
544 '(0 . 0) | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
545 (point-max) |
6552 | 546 (cons col line) |
547 (window-width) | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
548 (cons (window-hscroll) 0) |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
549 (selected-window)))) |
6552 | 550 @end example |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
551 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
552 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
|
553 @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
|
554 beginning of the first screen line. @xref{Minibuffer Misc}. |
6552 | 555 @end defun |
556 | |
557 @node List Motion | |
558 @comment node-name, next, previous, up | |
559 @subsection Moving over Balanced Expressions | |
560 @cindex sexp motion | |
561 @cindex Lisp expression motion | |
562 @cindex list motion | |
563 | |
564 Here are several functions concerned with balanced-parenthesis | |
565 expressions (also called @dfn{sexps} in connection with moving across | |
566 them in Emacs). The syntax table controls how these functions interpret | |
567 various characters; see @ref{Syntax Tables}. @xref{Parsing | |
568 Expressions}, for lower-level primitives for scanning sexps or parts of | |
569 sexps. For user-level commands, see @ref{Lists and Sexps,,, emacs, GNU | |
570 Emacs Manual}. | |
571 | |
572 @deffn Command forward-list arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
573 This function moves forward across @var{arg} balanced groups of |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
574 parentheses. (Other syntactic entities such as words or paired string |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
575 quotes are ignored.) |
6552 | 576 @end deffn |
577 | |
578 @deffn Command backward-list arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
579 This function moves backward 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 up-list arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
585 This function moves forward out of @var{arg} levels of parentheses. |
6552 | 586 A negative argument means move backward but still to a less deep spot. |
587 @end deffn | |
588 | |
589 @deffn Command down-list arg | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
590 This function moves forward into @var{arg} levels of parentheses. A |
7734 | 591 negative argument means move backward but still go |
592 deeper in parentheses (@minus{}@var{arg} levels). | |
6552 | 593 @end deffn |
594 | |
595 @deffn Command forward-sexp arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
596 This function moves forward across @var{arg} balanced expressions. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
597 Balanced expressions include both those delimited by parentheses and |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
598 other kinds, such as words and string constants. For example, |
6552 | 599 |
600 @example | |
601 @group | |
602 ---------- Buffer: foo ---------- | |
603 (concat@point{} "foo " (car x) y z) | |
604 ---------- Buffer: foo ---------- | |
605 @end group | |
606 | |
607 @group | |
608 (forward-sexp 3) | |
609 @result{} nil | |
610 | |
611 ---------- Buffer: foo ---------- | |
612 (concat "foo " (car x) y@point{} z) | |
613 ---------- Buffer: foo ---------- | |
614 @end group | |
615 @end example | |
616 @end deffn | |
617 | |
618 @deffn Command backward-sexp arg | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
619 This function moves backward across @var{arg} balanced expressions. |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
620 @end deffn |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
621 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
622 @deffn Command beginning-of-defun arg |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
623 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
|
624 @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
|
625 to the beginning of a defun, not to the end of one. |
6552 | 626 @end deffn |
627 | |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
628 @deffn Command end-of-defun arg |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
629 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
|
630 @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
|
631 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
|
632 @end deffn |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
633 |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
634 @defopt defun-prompt-regexp |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
635 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
|
636 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
|
637 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
|
638 match for this regular expression, followed by a character with |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
639 open-parenthesis syntax. |
7086
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
640 @end defopt |
075343a6b32b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
641 |
6552 | 642 @node Skipping Characters |
643 @comment node-name, next, previous, up | |
644 @subsection Skipping Characters | |
645 @cindex skipping characters | |
646 | |
647 The following two functions move point over a specified set of | |
648 characters. For example, they are often used to skip whitespace. For | |
649 related functions, see @ref{Motion and Syntax}. | |
650 | |
651 @defun skip-chars-forward character-set &optional limit | |
652 This function moves point in the current buffer forward, skipping over a | |
653 given set of characters. It examines the character following point, | |
654 then advances point if the character matches @var{character-set}. This | |
655 continues until it reaches a character that does not match. The | |
656 function returns @code{nil}. | |
657 | |
658 The argument @var{character-set} is like the inside of a | |
659 @samp{[@dots{}]} in a regular expression except that @samp{]} is never | |
660 special and @samp{\} quotes @samp{^}, @samp{-} or @samp{\}. Thus, | |
661 @code{"a-zA-Z"} skips over all letters, stopping before the first | |
662 nonletter, and @code{"^a-zA-Z}" skips nonletters stopping before the | |
663 first letter. @xref{Regular Expressions}. | |
664 | |
665 If @var{limit} is supplied (it must be a number or a marker), it | |
666 specifies the maximum position in the buffer that point can be skipped | |
667 to. Point will stop at or before @var{limit}. | |
668 | |
669 In the following example, point is initially located directly before the | |
670 @samp{T}. After the form is evaluated, point is located at the end of | |
671 that line (between the @samp{t} of @samp{hat} and the newline). The | |
672 function skips all letters and spaces, but not newlines. | |
673 | |
674 @example | |
675 @group | |
676 ---------- Buffer: foo ---------- | |
677 I read "@point{}The cat in the hat | |
678 comes back" twice. | |
679 ---------- Buffer: foo ---------- | |
680 @end group | |
681 | |
682 @group | |
683 (skip-chars-forward "a-zA-Z ") | |
684 @result{} nil | |
685 | |
686 ---------- Buffer: foo ---------- | |
687 I read "The cat in the hat@point{} | |
688 comes back" twice. | |
689 ---------- Buffer: foo ---------- | |
690 @end group | |
691 @end example | |
692 @end defun | |
693 | |
694 @defun skip-chars-backward character-set &optional limit | |
695 This function moves point backward, skipping characters that match | |
696 @var{character-set}, until @var{limit}. It just like | |
697 @code{skip-chars-forward} except for the direction of motion. | |
698 @end defun | |
699 | |
700 @node Excursions | |
701 @section Excursions | |
702 @cindex excursion | |
703 | |
704 It is often useful to move point ``temporarily'' within a localized | |
705 portion of the program, or to switch buffers temporarily. This is | |
706 called an @dfn{excursion}, and it is done with the @code{save-excursion} | |
707 special form. This construct saves the current buffer and its values of | |
708 point and the mark so they can be restored after the completion of the | |
709 excursion. | |
710 | |
711 The forms for saving and restoring the configuration of windows are | |
712 described elsewhere (see @ref{Window Configurations}, and @pxref{Frame | |
713 Configurations}). | |
714 | |
715 @defspec save-excursion forms@dots{} | |
716 @cindex mark excursion | |
717 @cindex point excursion | |
718 @cindex current buffer excursion | |
719 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
|
720 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
|
721 @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
|
722 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
|
723 an abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). |
6552 | 724 |
725 The @code{save-excursion} special form is the standard way to switch | |
726 buffers or move point within one part of a program and avoid affecting | |
727 the rest of the program. It is used more than 500 times in the Lisp | |
728 sources of Emacs. | |
729 | |
730 @code{save-excursion} does not save the values of point and the mark for | |
731 other buffers, so changes in other buffers remain in effect after | |
732 @code{save-excursion} exits. | |
733 | |
734 @cindex window excursions | |
735 Likewise, @code{save-excursion} does not restore window-buffer | |
736 correspondences altered by functions such as @code{switch-to-buffer}. | |
737 One way to restore these correspondences, and the selected window, is to | |
738 use @code{save-window-excursion} inside @code{save-excursion} | |
739 (@pxref{Window Configurations}). | |
740 | |
741 The value returned by @code{save-excursion} is the result of the last of | |
742 @var{forms}, or @code{nil} if no @var{forms} are given. | |
743 | |
744 @example | |
745 @group | |
746 (save-excursion | |
747 @var{forms}) | |
748 @equiv{} | |
749 (let ((old-buf (current-buffer)) | |
750 (old-pnt (point-marker)) | |
751 (old-mark (copy-marker (mark-marker)))) | |
752 (unwind-protect | |
753 (progn @var{forms}) | |
754 (set-buffer old-buf) | |
755 (goto-char old-pnt) | |
756 (set-marker (mark-marker) old-mark))) | |
757 @end group | |
758 @end example | |
759 @end defspec | |
760 | |
761 @node Narrowing | |
762 @section Narrowing | |
763 @cindex narrowing | |
764 @cindex restriction (in a buffer) | |
765 @cindex accessible portion (of a buffer) | |
766 | |
767 @dfn{Narrowing} means limiting the text addressable by Emacs editing | |
768 commands to a limited range of characters in a buffer. The text that | |
769 remains addressable is called the @dfn{accessible portion} of the | |
770 buffer. | |
771 | |
772 Narrowing is specified with two buffer positions which become the | |
773 beginning and end of the accessible portion. For most editing commands | |
774 and most Emacs primitives, these positions replace the values of the | |
775 beginning and end of the buffer. While narrowing is in effect, no text | |
776 outside the accessible portion is displayed, and point cannot move | |
777 outside the accessible portion. | |
778 | |
7729
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
779 Values such as positions or line numbers, which usually count from the |
6552 | 780 beginning of the buffer, do so despite narrowing, but the functions |
781 which use them refuse to operate on text that is inaccessible. | |
782 | |
783 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
|
784 the entire buffer regardless of any narrowing. |
6552 | 785 |
786 @deffn Command narrow-to-region start end | |
787 This function sets the accessible portion of the current buffer to start | |
788 at @var{start} and end at @var{end}. Both arguments should be character | |
789 positions. | |
790 | |
791 In an interactive call, @var{start} and @var{end} are set to the bounds | |
792 of the current region (point and the mark, with the smallest first). | |
793 @end deffn | |
794 | |
795 @deffn Command narrow-to-page move-count | |
796 This function sets the accessible portion of the current buffer to | |
797 include just the current page. An optional first argument | |
798 @var{move-count} non-@code{nil} means to move forward or backward by | |
799 @var{move-count} pages and then narrow. The variable | |
800 @code{page-delimiter} specifies where pages start and end | |
801 (@pxref{Standard Regexps}). | |
802 | |
803 In an interactive call, @var{move-count} is set to the numeric prefix | |
804 argument. | |
805 @end deffn | |
806 | |
807 @deffn Command widen | |
808 @cindex widening | |
809 This function cancels any narrowing in the current buffer, so that the | |
810 entire contents are accessible. This is called @dfn{widening}. | |
811 It is equivalent to the following expression: | |
812 | |
813 @example | |
814 (narrow-to-region 1 (1+ (buffer-size))) | |
815 @end example | |
816 @end deffn | |
817 | |
818 @defspec save-restriction body@dots{} | |
819 This special form saves the current bounds of the accessible portion, | |
820 evaluates the @var{body} forms, and finally restores the saved bounds, | |
821 thus restoring the same state of narrowing (or absence thereof) formerly | |
822 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
|
823 abnormal exit via @code{throw} or error (@pxref{Nonlocal Exits}). |
a1c07008521d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
824 Therefore, this construct is a clean way to narrow a buffer temporarily. |
6552 | 825 |
826 The value returned by @code{save-restriction} is that returned by the | |
827 last form in @var{body}, or @code{nil} if no body forms were given. | |
828 | |
829 @c Wordy to avoid overfull hbox. --rjc 16mar92 | |
830 @strong{Caution:} it is easy to make a mistake when using the | |
831 @code{save-restriction} construct. Read the entire description here | |
832 before you try it. | |
833 | |
834 If @var{body} changes the current buffer, @code{save-restriction} still | |
835 restores the restrictions on the original buffer (the buffer whose | |
836 restructions it saved from), but it does not restore the identity of the | |
837 current buffer. | |
838 | |
839 @code{save-restriction} does @emph{not} restore point and the mark; use | |
840 @code{save-excursion} for that. If you use both @code{save-restriction} | |
841 and @code{save-excursion} together, @code{save-excursion} should come | |
842 first (on the outside). Otherwise, the old point value would be | |
843 restored with temporary narrowing still in effect. If the old point | |
844 value were outside the limits of the temporary narrowing, this would | |
845 fail to restore it accurately. | |
846 | |
847 The @code{save-restriction} special form records the values of the | |
848 beginning and end of the accessible portion as distances from the | |
849 beginning and end of the buffer. In other words, it records the amount | |
850 of inaccessible text before and after the accessible portion. | |
851 | |
852 This method yields correct results if @var{body} does further narrowing. | |
853 However, @code{save-restriction} can become confused if the body widens | |
854 and then make changes outside the range of the saved narrowing. When | |
855 this is what you want to do, @code{save-restriction} is not the right | |
856 tool for the job. Here is what you must use instead: | |
857 | |
858 @example | |
859 @group | |
860 (let ((beg (point-min-marker)) | |
861 (end (point-max-marker))) | |
862 (unwind-protect | |
863 (progn @var{body}) | |
864 (save-excursion | |
865 (set-buffer (marker-buffer beg)) | |
866 (narrow-to-region beg end)))) | |
867 @end group | |
868 @end example | |
869 | |
870 Here is a simple example of correct use of @code{save-restriction}: | |
871 | |
872 @example | |
873 @group | |
874 ---------- Buffer: foo ---------- | |
875 This is the contents of foo | |
876 This is the contents of foo | |
877 This is the contents of foo@point{} | |
878 ---------- Buffer: foo ---------- | |
879 @end group | |
880 | |
881 @group | |
882 (save-excursion | |
883 (save-restriction | |
884 (goto-char 1) | |
885 (forward-line 2) | |
886 (narrow-to-region 1 (point)) | |
887 (goto-char (point-min)) | |
888 (replace-string "foo" "bar"))) | |
889 | |
890 ---------- Buffer: foo ---------- | |
891 This is the contents of bar | |
892 This is the contents of bar | |
893 This is the contents of foo@point{} | |
894 ---------- Buffer: foo ---------- | |
895 @end group | |
896 @end example | |
897 @end defspec |