xemacs-beta: man/lispref/positions.texi comparison

comparison man/lispref/positions.texi @ 444:576fb035e263 r21-2-37

Import from CVS: tag r21-2-37

author	cvs
date	Mon, 13 Aug 2007 11:36:19 +0200
parents	3ecd8885ac67
children	1ccc32a20af4

comparison

equal deleted inserted replaced

-:a8296e22da4e
+:576fb035e263
 @c -*-texinfo-*-
 @c This is part of the XEmacs Lisp Reference Manual.
 @c Copyright (C) 1990, 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
 @c See the file lispref.texi for copying conditions.
 @setfilename ../../info/positions.info
 @node Positions, Markers, Consoles and Devices, Top
 @chapter Positions
 @cindex position (in buffer)
 Here are two commands that users use to do these things.  They are
 documented here to warn you not to use them in Lisp programs, because
 they set the mark and display messages in the echo area.
-@deffn Command beginning-of-buffer &optional n
+@deffn Command beginning-of-buffer &optional count
 This function moves point to the beginning of the buffer (or the limits
 of the accessible portion, when narrowing is in effect), setting the
-mark at the previous position.  If @var{n} is non-@code{nil}, then it
+mark at the previous position.  If @var{count} is non-@code{nil}, then it
-puts point @var{n} tenths of the way from the beginning of the buffer.
+puts point @var{count} tenths of the way from the beginning of the buffer.
-In an interactive call, @var{n} is the numeric prefix argument,
+In an interactive call, @var{count} is the numeric prefix argument,
-if provided; otherwise @var{n} defaults to @code{nil}.
+if provided; otherwise @var{count} defaults to @code{nil}.
 Don't use this function in Lisp programs!
 @end deffn
-@deffn Command end-of-buffer &optional n
+@deffn Command end-of-buffer &optional count
 This function moves point to the end of the buffer (or the limits of
 the accessible portion, when narrowing is in effect), setting the mark
-at the previous position.  If @var{n} is non-@code{nil}, then it puts
+at the previous position.  If @var{count} is non-@code{nil}, then it puts
-point @var{n} tenths of the way from the end of the buffer.
+point @var{count} tenths of the way from the end of the buffer.
-In an interactive call, @var{n} is the numeric prefix argument,
+In an interactive call, @var{count} is the numeric prefix argument,
-if provided; otherwise @var{n} defaults to @code{nil}.
+if provided; otherwise @var{count} defaults to @code{nil}.
 Don't use this function in Lisp programs!
 @end deffn
 @node Text Lines
 the end of the last line, and the value will be 2.
 In an interactive call, @var{count} is the numeric prefix argument.
 @end deffn
-@defun count-lines start end
+@defun count-lines start end &optional ignore-invisible-lines-flag
 @cindex lines in region
 This function returns the number of lines between the positions
 @var{start} and @var{end} in the current buffer.  If @var{start} and
 @var{end} are equal, then it returns 0.  Otherwise it returns at least
 1, even if @var{start} and @var{end} are on the same line.  This is
 because the text between them, considered in isolation, must contain at
 least one line unless it is empty.
+With optional @var{ignore-invisible-lines-flag} non-@code{nil}, lines
+collapsed with selective-display are excluded from the line count.
+@strong{Note:} The expression to return the current line number is not
+obvious:
+@example
+(1+ (count-lines 1 (point-at-bol)))
+@end example
 Here is an example of using @code{count-lines}:
 @example
 @group
 (defun current-line ()
 @defun vertical-motion count &optional window pixels
 This function moves point to the start of the frame line @var{count}
 frame lines down from the frame line containing point.  If @var{count}
 is negative, it moves up instead.  The optional second argument
 @var{window} may be used to specify a window other than the
 selected window in which to perform the motion.
 Normally, @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.  If the optional third argument,
 beginning of the first screen line.  @xref{Minibuffer Misc}.
 @end defun
 @end ignore
 @node List Motion
 @subsection Moving over Balanced Expressions
 @cindex sexp motion
 @cindex Lisp expression motion
 @cindex list motion
 Here are several functions concerned with balanced-parenthesis
 parentheses. (Other syntactic entities such as words or paired string
 quotes are ignored.) @var{arg} defaults to 1 if omitted.  If @var{arg}
 is negative, move backward across that many groups of parentheses.
 @end deffn
-@deffn Command backward-list &optional arg
+@deffn Command backward-list &optional count
-This function moves backward across @var{arg} balanced groups of
+This function moves backward across @var{count} balanced groups of
 parentheses. (Other syntactic entities such as words or paired string
-quotes are ignored.) @var{arg} defaults to 1 if omitted.  If @var{arg}
+quotes are ignored.) @var{count} defaults to 1 if omitted.  If
-is negative, move forward across that many groups of parentheses.
+@var{count} is negative, move forward across that many groups of
-@end deffn
+parentheses.
+@end deffn
-@deffn Command up-list arg
-This function moves forward out of @var{arg} levels of parentheses.
+@deffn Command up-list &optional count
+This function moves forward out of @var{count} levels of parentheses.
 A negative argument means move backward but still to a less deep spot.
 @end deffn
-@deffn Command down-list arg
+@deffn Command down-list &optional count
-This function moves forward into @var{arg} levels of parentheses.  A
+This function moves forward into @var{count} levels of parentheses.
-negative argument means move backward but still go
+A negative argument means move backward but still go deeper in
-deeper in parentheses (@minus{}@var{arg} levels).
+parentheses (@minus{}@var{count} levels).
 @end deffn
-@deffn Command forward-sexp &optional arg
+@deffn Command forward-sexp &optional count
-This function moves forward across @var{arg} balanced expressions.
+This function moves forward across @var{count} balanced expressions.
 Balanced expressions include both those delimited by parentheses and
-other kinds, such as words and string constants.  @var{arg} defaults to
+other kinds, such as words and string constants.  @var{count} defaults to
-1 if omitted.  If @var{arg} is negative, move backward across that many
+1 if omitted.  If @var{count} is negative, move backward across that many
 balanced expressions.  For example,
 @example
 @group
 ---------- Buffer: foo ----------
 ---------- Buffer: foo ----------
 @end group
 @end example
 @end deffn
-@deffn Command backward-sexp &optional arg
+@deffn Command backward-sexp &optional count
-This function moves backward across @var{arg} balanced expressions.
+This function moves backward across @var{count} balanced expressions.
-@var{arg} defaults to 1 if omitted.  If @var{arg} is negative, move
+@var{count} defaults to 1 if omitted.  If @var{count} is negative, move
 forward across that many balanced expressions.
 @end deffn
-@deffn Command beginning-of-defun &optional arg
+@deffn Command beginning-of-defun &optional count
-This function moves back to the @var{arg}th beginning of a defun.  If
+This function moves back to the @var{count}th beginning of a defun.
-@var{arg} is negative, this actually moves forward, but it still moves
+If @var{count} is negative, this actually moves forward, but it still
-to the beginning of a defun, not to the end of one.  @var{arg} defaults
+moves to the beginning of a defun, not to the end of one.  @var{count}
-to 1 if omitted.
+defaults to 1 if omitted.
 @end deffn
-@deffn Command end-of-defun &optional arg
+@deffn Command end-of-defun &optional count
-This function moves forward to the @var{arg}th end of a defun.  If
+This function moves forward to the @var{count}th end of a defun.
-@var{arg} is negative, this actually moves backward, but it still moves
+If @var{count} is negative, this actually moves backward, but it still
-to the end of a defun, not to the beginning of one.  @var{arg} defaults
+moves to the end of a defun, not to the beginning of one.  @var{count}
-to 1 if omitted.
+defaults to 1 if omitted.
 @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
 @defspec with-current-buffer buffer forms@dots{}
 This special form evaluates @var{forms} with @var{buffer} as the current
 buffer.  It returns the value of the last form.
 @end defspec
-@defspec with-temp-file file forms@dots{}
+@defspec with-temp-file filename forms@dots{}
 This special form creates a new buffer, evaluates @var{forms} there, and
-writes the buffer to @var{file}.  It returns the value of the last form
+writes the buffer to @var{filename}.  It returns the value of the last form
 evaluated.
 @end defspec
 @defspec save-selected-window forms@dots{}
 This special form is similar to @code{save-excursion} but it saves and
 this is what you want to do, @code{save-restriction} is not the right
 tool for the job.  Here is what you must use instead:
 @example
 @group
-(let ((beg (point-min-marker))
+(let ((start (point-min-marker))
 (end (point-max-marker)))
 (unwind-protect
 (progn @var{body})
 (save-excursion
-(set-buffer (marker-buffer beg))
+(set-buffer (marker-buffer start))
-(narrow-to-region beg end))))
+(narrow-to-region start end))))
 @end group
 @end example
 Here is a simple example of correct use of @code{save-restriction}:

Mercurial > hg > xemacs-beta

comparison man/lispref/positions.texi @ 444:576fb035e263 r21-2-37