comparison lispref/positions.texi @ 7086:075343a6b32b

*** empty log message ***

7085:5e56975be72a

(point-max)
     @result{} 36
@end group
@end example
@end defun

@defvar buffer-saved-size
  The value of this buffer-local variable is the former length of the
current buffer, as of the last time it was read in, saved or auto-saved.
@end defvar

@node Motion
@section Motion

  Motion functions change the value of point, either relative to the

differently, for a given piece of text, depending on the buffer it is
in, and even on the selected window (because the width, the truncation
flag, and display table may vary between windows).  @xref{Usual
Display}.

@defun vertical-motion count
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}
is negative, it moves up instead.

This function returns the number of lines moved.  The value may be less
in absolute value than @var{count} if the beginning or end of the buffer
was reached.
@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

The value returned is the window line number, with the top line in the
window numbered 0.
@end deffn

@defun compute-motion from frompos to topos width offsets
This function scan through the current buffer, calculating screen
position.  It scans the current buffer forward from position @var{from},
assuming that is at screen coordinates @var{frompos}, to position
@var{to} or coordinates @var{topos}, whichever comes first.  It returns
the ending buffer position and screen coordinates.

text; this affects handling of continuation lines.  Use the value
returned by @code{window-width} for the window of your choice.

The argument @var{offsets} is either @code{nil} or a cons cell of the
form @code{(@var{hscroll} . @var{tab-offset})}.  Here @var{hscroll} is
the number of columns not being displayed at the left margin; in most
calls, this comes from @code{window-hscroll}.  Meanwhile,
@var{tab-offset} is the number of columns of an initial tab character
(at @var{from}) that aren't included in the display, perhaps because the
line was continued within that character.

The return value is a list of five elements:

@example
(@var{pos} @var{vpos} @var{hpos} @var{prevhpos} @var{contin})

                       (point)
                       (cons col line)
                       (window-width)
                       (cons (window-hscroll) 0))))
@end example
@end defun

@node Vertical Motion
@comment  node-name,  next,  previous,  up
@subsection The User-Level Vertical Motion Commands

Expressions}, for lower-level primitives for scanning sexps or parts of
sexps.  For user-level commands, see @ref{Lists and Sexps,,, emacs, GNU
Emacs Manual}.

@deffn Command forward-list arg
Move forward across @var{arg} balanced groups of parentheses.
(Other syntactic entities such as words or paired string quotes
are ignored.)
@end deffn

@deffn Command backward-list arg
Move backward across @var{arg} balanced groups of parentheses.
(Other syntactic entities such as words or paired string quotes
are ignored.)
@end deffn

@deffn Command up-list arg
Move forward out of @var{arg} levels of parentheses.
A negative argument means move backward but still to a less deep spot.
@end deffn

@deffn Command down-list arg
Move forward down @var{arg} levels of parentheses.  A negative argument
means move backward but still go down @var{arg} levels.
@end deffn

@deffn Command forward-sexp arg
Move forward across @var{arg} balanced expressions.
Balanced expressions include both those delimited by parentheses
and other kinds, such as words and string constants.  For example,

@example
@group
---------- Buffer: foo ----------
(concat@point{} "foo " (car x) y z)

@end group
@end example
@end deffn

@deffn Command backward-sexp arg
Move backward across @var{arg} balanced expressions.
@end deffn

@node Skipping Characters
@comment  node-name,  next,  previous,  up
@subsection Skipping Characters
@cindex skipping characters

7086:075343a6b32b

(point-max)
     @result{} 36
@end group
@end example
@end defun

@node Motion
@section Motion

  Motion functions change the value of point, either relative to the

differently, for a given piece of text, depending on the buffer it is
in, and even on the selected window (because the width, the truncation
flag, and display table may vary between windows).  @xref{Usual
Display}.

@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}
is negative, it moves up instead.

@code{vertical-motion} returns the number of lines moved.  The value may
be less in absolute value than @var{count} if the beginning or end of
the buffer was reached.

The window @var{window} is used for obtaining parameters such as the
width, the horizontal scrolling, and the display table.  But
@code{vertical-motion} always operates on the current buffer, even if
@var{window} currently displays some other buffer.
@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

The value returned is the window line number, with the top line in the
window numbered 0.
@end deffn

@defun compute-motion from frompos to topos width offsets window
This function scan through the current buffer, calculating screen
position.  It scans the current buffer forward from position @var{from},
assuming that is at screen coordinates @var{frompos}, to position
@var{to} or coordinates @var{topos}, whichever comes first.  It returns
the ending buffer position and screen coordinates.

text; this affects handling of continuation lines.  Use the value
returned by @code{window-width} for the window of your choice.

The argument @var{offsets} is either @code{nil} or a cons cell of the
form @code{(@var{hscroll} . @var{tab-offset})}.  Here @var{hscroll} is
the number of columns not being displayed at the left margin; most
callers get this from @code{window-hscroll}.  Meanwhile,
@var{tab-offset} is the offset between column numbers on the screen and
column numbers in the buffer.  This can be nonzero in a continuation
line, when the previous screen lines' widths do not add up to a multiple
of @code{tab-width}.  It is always zero in a non-continuation line.

The window @var{window} serves to specify which display table to use;
that is its only effect.  @code{compute-motion} always operates on the
current buffer, regardless of what buffer is displayed in @var{window}.

The return value is a list of five elements:

@example
(@var{pos} @var{vpos} @var{hpos} @var{prevhpos} @var{contin})

                       (point)
                       (cons col line)
                       (window-width)
                       (cons (window-hscroll) 0))))
@end example

When you use @code{compute-motion} for the minibuffer, you need to use
@code{minibuffer-prompt-width} to get the horizontal position of the
beginning of the first screen line.  @xref{Minibuffer Misc}.
@end defun

@node Vertical Motion
@comment  node-name,  next,  previous,  up
@subsection The User-Level Vertical Motion Commands

Expressions}, for lower-level primitives for scanning sexps or parts of
sexps.  For user-level commands, see @ref{Lists and Sexps,,, emacs, GNU
Emacs Manual}.

@deffn Command forward-list arg
This function moves forward across @var{arg} balanced groups of
parentheses.  (Other syntactic entities such as words or paired string
quotes are ignored.)
@end deffn

@deffn Command backward-list arg
This function moves backward across @var{arg} balanced groups of
parentheses.  (Other syntactic entities such as words or paired string
quotes are ignored.)
@end deffn

@deffn Command up-list arg
This function moves forward out of @var{arg} levels of parentheses.
A negative argument means move backward but still to a less deep spot.
@end deffn

@deffn Command down-list arg
This function moves forward down @var{arg} levels of parentheses.  A
negative argument means move backward but still go down @var{arg}
levels.
@end deffn

@deffn Command forward-sexp arg
This function moves forward across @var{arg} balanced expressions.
Balanced expressions include both those delimited by parentheses and
other kinds, such as words and string constants.  For example,

@example
@group
---------- Buffer: foo ----------
(concat@point{} "foo " (car x) y z)

@end group
@end example
@end deffn

@deffn Command backward-sexp arg
This function moves backward across @var{arg} balanced expressions.
@end deffn

@deffn Command beginning-of-defun arg
This function moves back to the @var{arg}th beginning of a defun.  If
@var{arg} is negative, this actually moves forward, but it still moves
to the beginning of a defun, not to the end of one.
@end deffn

@deffn Command end-of-defun arg
Move forward to the @var{arg}th end of a defun.  If @var{arg} is
negative, this actually moves backward, but it still moves to the end of
a defun, not to the beginning of one.
@end deffn

@defopt defun-prompt-regexp
If non-@code{nil}, this variable holds a regular expression that
specifies what text can appear before the open-parenthesis that starts a
defun.  That is to say, the a defun begins on a line which starts
with a match for this regular expression, followed by a character
with open-parenthesis syntax.
@end defopt

@node Skipping Characters
@comment  node-name,  next,  previous,  up
@subsection Skipping Characters
@cindex skipping characters