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