summaryrefslogtreecommitdiff
path: root/lispref
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>2001-09-06 19:49:21 +0000
committerRichard M. Stallman <rms@gnu.org>2001-09-06 19:49:21 +0000
commitf4f65a420cbc948c05a7cddc500d546124228b64 (patch)
tree8b3b5b7ecfddbdfb9de1d424c69ab75cd2a8619c /lispref
parenta5d0a32e01523b1fd906bc36b62e2e3437e5f8cc (diff)
downloademacs-f4f65a420cbc948c05a7cddc500d546124228b64.tar.gz
Rewrite and move definition of count-screen-lines.
Minor clarifications.
Diffstat (limited to 'lispref')
-rw-r--r--lispref/positions.texi42
1 files changed, 22 insertions, 20 deletions
diff --git a/lispref/positions.texi b/lispref/positions.texi
index 5e9abd359c6..2f2462c84ff 100644
--- a/lispref/positions.texi
+++ b/lispref/positions.texi
@@ -190,7 +190,7 @@ This function moves point forward @var{count} words (or backward if
@var{count} is negative). ``Moving one word'' means moving until point
crosses a word-constituent character and then encounters a
word-separator character. However, this function cannot move point past
-the boundary of the accessible part of the buffer, or across a field
+the boundary of the accessible portion of the buffer, or across a field
boundary (@pxref{Fields}). The most common case of a field boundary is
the end of the prompt in the minibuffer.
@@ -491,7 +491,6 @@ thus take time proportional to the distance scanned. If you intend to
use them heavily, Emacs provides caches which may improve the
performance of your code. @xref{Truncation, cache-long-line-scans}.
-
@defun vertical-motion count &optional window
This function moves point to the start of the screen line @var{count}
screen lines down from the screen line containing point. If @var{count}
@@ -507,6 +506,27 @@ width, the horizontal scrolling, and the display table. But
@var{window} currently displays some other buffer.
@end defun
+@defun count-screen-lines &optional beg end count-final-newline window
+This function returns the number of screen lines in the text from
+@var{beg} to @var{end}. The number of screen lines may be different
+from the number of actual lines, due to line continuation, the display
+table, etc. If @var{beg} and @var{end} are @code{nil} or omitted,
+they default to the beginning and end of the accessible portion of the
+buffer.
+
+If the region ends with a newline, that is ignored unless the optional
+third argument @var{count-final-newline} is non-@code{nil}.
+
+The optional fourth argument @var{window} specifies the window for
+obtaining parameters such as width, horizontal scrolling, and so on.
+The default is to use the selected window's parameters.
+
+Like @code{vertical-motion}, @code{count-screen-lines} always uses the
+current buffer, regardless of which buffer is displayed in
+@var{window}. This makes possible to use @code{count-screen-lines} in
+any buffer, whether or not it is currently displayed in some window.
+@end defun
+
@deffn Command move-to-window-line count
This function moves point with respect to the text currently displayed
in the selected window. It moves point to the beginning of the screen
@@ -528,24 +548,6 @@ The value returned is the window line number point has moved to, with
the top line in the window numbered 0.
@end deffn
-@defun count-screen-lines &optional beg end count-final-newline window
-This function returns the number of the screen lines occupied by the
-text between positions @var{beg} and @var{end}. These arguments default
-to the beginning and end of the accessible portion of the buffer.
-
-If region ends with a newline, it is significant if
-@var{count-final-newline} is non-@code{nil}. Otherwise it is ignored.
-
-The argument @var{window} specifies the window used for obtaining
-parameters such as width, horizontal scrolling, and so on. The default
-is the selected window.
-
-Like @code{vertical-motion}, @code{count-screen-lines} always uses the
-current buffer, regardless of which buffer is displayed in @var{window}.
-This makes possible to use @code{count-screen-lines} in any buffer,
-whether or not it is currently displayed in some window.
-@end defun
-
@defun compute-motion from frompos to topos width offsets window
This function scans the current buffer, calculating screen positions.
It scans the buffer forward from position @var{from}, assuming that is