Function: xref-backend-identifier-completion-predicate

xref-backend-identifier-completion-predicate is a byte-compiled function defined in xref.el.gz.

Signature

(xref-backend-identifier-completion-predicate BACKEND &optional KIND)

Documentation

Return the predicate for filtering candidates in identifier completion.

The returned value should be a function that will be used as the PREDICATE argument for completing-read when an identifier is read with completion.

The argument KIND will be provided to the method when the caller intends to use the completion's result in a search for that KIND of definitions. In such case this predicate can filter the candidate identifiers as appropriate for KIND.

Implementations

(xref-backend-identifier-completion-predicate (BACKEND (eql 'etags)) &optional KIND) in `etags.el'.

Predicate for rejecting completion candidates for the `etags' backend. This is the implementation for the `etags' backend. If KIND is non-nil, meaning that the caller is interested only in canddiates that match KIND, the predicate is a function which will reject any candidate that doesn't match KIND.

(xref-backend-identifier-completion-predicate BACKEND &optional KIND) in `xref.el'.

Undocumented

(xref-backend-identifier-completion-predicate (BACKEND (eql 'elisp)) &optional KIND) in `elisp-mode.el'.

Undocumented

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/xref.el.gz
(cl-defgeneric xref-backend-identifier-completion-predicate (_backend
                                                             &optional _kind)
  "Return the predicate for filtering candidates in identifier completion.

The returned value should be a function that will be used as the PREDICATE
argument for `completing-read' when an identifier is read with completion.

The argument KIND will be provided to the method when the caller intends to
use the completion's result in a search for that KIND of definitions.  In
such case this predicate can filter the candidate identifiers as appropriate
for KIND."
  nil)