annotate lispref/positions.texi @ 56116:6725db0f57d5

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