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