Variable: beginning-of-defun-function

beginning-of-defun-function is a variable defined in lisp.el.gz.

Value

nil

Documentation

If non-nil, function for beginning-of-defun-raw to call.

This is used to find the beginning of the defun instead of using the normal recipe (see beginning-of-defun). Major modes can define this if defining defun-prompt-regexp is not sufficient to handle the mode's needs.

The function takes the same argument as beginning-of-defun and should behave similarly, returning non-nil if it found the beginning of a defun. Ideally it should move to a point right before an open-paren which encloses the body of the defun.

View in manual

Probably introduced at or before Emacs version 21.1.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/lisp.el.gz
(defvar beginning-of-defun-function nil
  "If non-nil, function for `beginning-of-defun-raw' to call.
This is used to find the beginning of the defun instead of using the
normal recipe (see `beginning-of-defun').  Major modes can define this
if defining `defun-prompt-regexp' is not sufficient to handle the mode's
needs.

The function takes the same argument as `beginning-of-defun' and should
behave similarly, returning non-nil if it found the beginning of a defun.
Ideally it should move to a point right before an open-paren which encloses
the body of the defun.")