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