annotate doc/lispref/positions.texi @ 97949:e763543ca817

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