Variable: find-function-regexp-alist

find-function-regexp-alist is a variable defined in find-func.el.gz.

Value

((ert--test . find-ert-test-regexp) (defil . find-defil-regexp)
 (defib . find-defib-regexp) (defal . find-defal-regexp)
 (defact . find-defact-regexp)
 (define-mode-local-override . xref-mode-local-find-override)
 (define-overloadable-function
   . xref-mode-local-find-overloadable-regexp)
 (define-type . cl--typedef-regexp)
 (pcase-macro . pcase--find-macro-def-regexp)
 (cl-defgeneric . cl--generic-find-defgeneric-regexp)
 (cl-defmethod cl--generic-search-method .
   cl--generic-search-method-make-form-matcher)
 (nil . find-function-regexp) (defvar . find-variable-regexp)
 (defface . find-function--defface) (feature . find-feature-regexp)
 (defalias . find-alias-regexp))

Documentation

Alist mapping definition types into regexp variables.

Each regexp variable's value should actually be a format string to be used to substitute the desired symbol name into the regexp. Instead of regexp variable, types can be mapped to functions as well, in which case the function is called with one argument (the object we're looking for) and it should search for it.

A value can also be a cons (REGEX . EXPANDED-FORM-MATCHER-FACTORY). REGEX is as above; EXPANDED-FORM-MATCHER-FACTORY is a function of one argument, the same object we'd pass to a REGEX function; it should return another function of one argument that returns non-nil if we're looking at a macroexpanded form that defines the object we're looking for. If you want to use EXPANDED-FORM-MATCHER-FACTORY exclusively, you can set REGEX to a never-match regexp, and force the fallback to EXPANDED-FORM-MATCHER-FACTORY. EXPANDED-FORM-MATCHER-FACTORY is called with the buffer to search the current one.

Symbols can have their own version of this alist on the property find-function-type-alist. See the function find-function-update-type-alist.

View in manual

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/find-func.el.gz
(defvar find-function-regexp-alist
  '((nil . find-function-regexp)
    (defvar . find-variable-regexp)
    (defface . find-function--defface)
    (feature . find-feature-regexp)
    (defalias . find-alias-regexp))
  "Alist mapping definition types into regexp variables.
Each regexp variable's value should actually be a format string
to be used to substitute the desired symbol name into the regexp.
Instead of regexp variable, types can be mapped to functions as well,
in which case the function is called with one argument (the object
we're looking for) and it should search for it.

A value can also be a cons (REGEX . EXPANDED-FORM-MATCHER-FACTORY).
REGEX is as above; EXPANDED-FORM-MATCHER-FACTORY is a function of one
argument, the same object we'd pass to a REGEX function; it should return
another function of one argument that returns non-nil if we're looking at
a macroexpanded form that defines the object we're looking for.
If you want to use EXPANDED-FORM-MATCHER-FACTORY exclusively, you can
set REGEX to a never-match regexp, and force the fallback to
EXPANDED-FORM-MATCHER-FACTORY.  EXPANDED-FORM-MATCHER-FACTORY is
called with the buffer to search the current one.

Symbols can have their own version of this alist on
the property `find-function-type-alist'.
See the function `find-function-update-type-alist'.")