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