Function: lazy-highlight-cleanup

lazy-highlight-cleanup is an interactive and byte-compiled function defined in isearch.el.gz.

Signature

(lazy-highlight-cleanup &optional FORCE PROCRASTINATE)

Documentation

Stop lazy highlighting and remove extra highlighting from current buffer.

FORCE non-nil means do it whether or not lazy-highlight-cleanup(var)/lazy-highlight-cleanup(fun) is nil. PROCRASTINATE non-nil means postpone cleanup to a later time. This function is called when exiting an incremental search if lazy-highlight-cleanup(var)/lazy-highlight-cleanup(fun) is non-nil.

Probably introduced at or before Emacs version 27.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/isearch.el.gz
(defun lazy-highlight-cleanup (&optional force procrastinate)
  "Stop lazy highlighting and remove extra highlighting from current buffer.
FORCE non-nil means do it whether or not `lazy-highlight-cleanup' is nil.
PROCRASTINATE non-nil means postpone cleanup to a later time.
This function is called when exiting an incremental search if
`lazy-highlight-cleanup' is non-nil."
  (interactive '(t))
  (when (and (or force lazy-highlight-cleanup) (not procrastinate))
    (while isearch-lazy-highlight-overlays
      (delete-overlay (car isearch-lazy-highlight-overlays))
      (setq isearch-lazy-highlight-overlays
            (cdr isearch-lazy-highlight-overlays))))
  (when isearch-lazy-highlight-timer
    (cancel-timer isearch-lazy-highlight-timer)
    (setq isearch-lazy-highlight-timer nil)))