Function: pos-bol

pos-bol is a byte-compiled function defined in compat-29.el.

Signature

(pos-bol &optional N)

Documentation

[Compatibility function for pos-bol, defined in Emacs 29.1. See (compat) Emacs
29.1' for more details.]

Return the position of the first character on the current line. With optional argument N, scan forward N - 1 lines first. If the scan reaches the end of the buffer, return that position.

This function ignores text display directionality; it returns the position of the first character in logical order, i.e. the smallest character position on the logical line. See vertical-motion for movement by screen lines.

This function does not move point. Also see line-beginning-position.

Source Code

;; Defined in ~/.emacs.d/elpa/compat-30.1.0.1/compat-29.el
;;;; Defined in editfns.c

(compat-defun pos-bol (&optional n) ;; <compat-tests:pos-bol>
  "Return the position of the first character on the current line.
With optional argument N, scan forward N - 1 lines first.
If the scan reaches the end of the buffer, return that position.

This function ignores text display directionality; it returns the
position of the first character in logical order, i.e. the smallest
character position on the logical line.  See `vertical-motion' for
movement by screen lines.

This function does not move point.  Also see `line-beginning-position'."
  (declare (side-effect-free t))
  (let ((inhibit-field-text-motion t))
    (line-beginning-position n)))