procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of 'isearch-filter-predicate'

Browse source 
* lisp/isearch.el (isearch-filter-predicate)
(isearch-filter-visible): Doc fixes.  (Bug#34150)
This commit is contained in:
Eli Zaretskii 2019-01-21 18:20:33 +02:00
parent 9034dd6c70
commit 928d342c81
1 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
lisp/isearch.el
View file

@ -188,11 +188,14 @@ or to the end of the buffer for a backward search.")
to the search status stack.") to the search status stack.")
(defvar isearch-filter-predicate #'isearch-filter-visible (defvar isearch-filter-predicate #'isearch-filter-visible
"Predicate that filters the search hits that would normally be available. "Predicate to filter hits of Isearch and replace commands.
Search hits that dissatisfy the predicate are skipped. The function Isearch hits that don't satisfy the predicate will be skipped.
has two arguments: the positions of start and end of text matched by The value should be a function of two arguments; it will be
the search. If this function returns nil, continue searching without called with the the positions of the start and the end of the
stopping at this match. text matched by Isearch and replace commands. If this function
returns nil, Isearch and replace commands will continue searching
without stopping at resp. replacing this match.
If you use `add-function' to modify this variable, you can use the If you use `add-function' to modify this variable, you can use the
`isearch-message-prefix' advice property to specify the prefix string `isearch-message-prefix' advice property to specify the prefix string
displayed in the search message.") displayed in the search message.")
@ -3009,10 +3012,13 @@ Optional third argument, if t, means if fail just return nil (no error).
(setq isearch-hidden t))))))) (setq isearch-hidden t)))))))
(defun isearch-filter-visible (beg end) (defun isearch-filter-visible (beg end)
"Test whether the current search hit is visible at least partially. "Return non-nil if text between BEG and END is deemed visible by Isearch.
Return non-nil if the text from BEG to END is visible to Isearch as This function is intended to be used as `isearch-filter-predicate'.
determined by `isearch-range-invisible' unless invisible text can be It returns non-nil if the text between BEG and END is visible to
searched too when `search-invisible' is t." Isearch, at least partially, as determined by `isearch-range-invisible'.
If `search-invisible' is t, which allows Isearch matches inside
invisible text, this function will always return non-nil, regardless
of what `isearch-range-invisible' says."
(or (eq search-invisible t) (or (eq search-invisible t)
(not (isearch-range-invisible beg end)))) (not (isearch-range-invisible beg end))))