Variable: hs-find-next-block-function

hs-find-next-block-function is a buffer-local variable defined in hideshow.el.gz.

Documentation

Function to find the start of the next block.

It should reposition point at next block start.

It is called with three arguments REGEXP, BOUND, and COMMENTS.

REGEXP is a regexp representing block start. When block start is found, should set the match data according to the beginning position of the matched REGEXP or block start position.

BOUND is a buffer position that limits the search.

When COMMENTS is non-nil, REGEXP matches not only beginning of a block but also beginning of a comment. In this case, the function should find the nearest block or comment and return non-nil.

Aliases

hs-find-next-block-func (obsolete since 31.1)

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/hideshow.el.gz
(defvar-local hs-find-next-block-function
  #'hs-find-next-block-fn--default
  "Function to find the start of the next block.
It should reposition point at next block start.

It is called with three arguments REGEXP, BOUND, and COMMENTS.

REGEXP is a regexp representing block start.  When block start is found,
should set the match data according to the beginning position of the
matched REGEXP or block start position.

BOUND is a buffer position that limits the search.

When COMMENTS is non-nil, REGEXP matches not only beginning of a block
but also beginning of a comment.  In this case, the function should find
the nearest block or comment and return non-nil.")