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