Homepage: https://www.emacswiki.org/emacs/download/isearch%2b.el
Author: Drew Adams
Updated:
Extensions to `isearch.el' (incremental search)
Extensions to `isearch.el' (incremental search).
The Isearch+ libraries are these:
`isearch+.el' (this file) - Various extensions to `isearch.el'.
Can be used with Emacs 20 or later.
`isearch-prop.el' (optional) - Commands to search within contexts,
which are character-property zones:
spans of text that have certain
text or overlay properties. Can be
Used with Emacs 23 or later.
You can use either of the Isearch+ files without the other, but I
recommend that you use them together.
This file should be loaded *AFTER* loading the standard GNU file
`isearch.el'. So in your `~/.emacs' file, do this:
(eval-after-load "isearch" '(require 'isearch+))
Library `isearch-prop.el' is optional. If you do not want to use
it then do not put it in your `load-path'. If it is in your
`load-path' then it will automatically be loaded when you load
library `isearch+.el'.
More description below - see Overview of Features.
Index
-----
If you have library `linkd.el' and Emacs 22 or later, load
`linkd.el' and turn on `linkd-mode' now. It lets you easily
navigate around the sections of this doc. Linkd mode will
highlight this Index, as well as the cross-references and section
headings throughout this file. You can get `linkd.el' here:
https://www.emacswiki.org/emacs/download/linkd.el.
(@> "Overview of Features")
(@> "Change log")
(@> "Faces and Variables")
(@> "Keys and Hooks")
(@> "Macros")
(@> "Commands")
(@> "Non-Interactive Functions")
Commands defined here:
`isearchp-act-on-demand' (Emacs 22+),
`isearchp-add-filter-predicate' (Emacs 24.4+),
`isearchp-add-inline-regexp-filter-predicate' (Emacs 24.4+),
`isearchp-add-regexp-filter-predicate' (Emacs 24.4+),
`isearchp-append-register',
`isearchp-bookmark-current-filter-predicate' (Emacs 24.4+),
`isearch-char-by-name' (Emacs 23-24.3), `isearchp-columns'
(Emacs 24.4+), `isearchp-complement-filter' (Emacs 24.4+),
`isearchp-complete', `isearchp-cycle-mismatch-removal',
`isearchp-defun-filter-predicate' (Emacs 24.4+),
`isearchp-describe-prefix-bindings',
`isearchp-eval-sexp-and-insert' (Emacs 22+),
`isearchp-fontify-buffer-now', `isearchp-forward-regexp-region',
`isearchp-forward-region', `isearchp-init-edit',
`isearchp-keep-filter-predicate' (Emacs 24.4+), `isearchp-near'
(Emacs 24.4+), `isearchp-near-after' (Emacs 24.4+),
`isearchp-near-before' (Emacs 24.4+),
`isearchp-negate-last-filter' (Emacs 24.4+),
`isearchp-open-recursive-edit' (Emacs 22+),
`isearchp-or-filter-predicate' (Emacs 24.4+),
`isearchp-or-last-filter' (Emacs 24.4+),
`isearchp-remove-failed-part' (Emacs 22+),
`isearchp-remove-failed-part-or-last-char' (Emacs 22+),
`isearchp-remove-filter-predicate' (Emacs 24.4+),
`isearchp-reset-filter-predicate' (Emacs 24.4+),
`isearchp-reset-filter-preds-alist' (Emacs 24.4+),
`isearchp-retrieve-last-quit-search',
`isearchp-set-filter-predicate' (Emacs 24.4+),
`isearchp-set-region-around-search-target',
`isearchp-show-filters' (Emacs 24.4+),
`isearchp-toggle-auto-keep-filter-predicate' (Emacs 24.4+),
`isearchp-toggle-dimming-filter-failures' (Emacs 24.4+),
`isearchp-toggle-highlighting-regexp-groups',
`isearchp-toggle-lazy-highlight-cleanup' (Emacs 22+),
`isearchp-toggle-lazy-highlight-count' (Emacs 22+),
`isearchp-toggle-lazy-highlight-full-buffer' (Emacs 24.3+),
`isearchp-toggle-lazy-highlighting' (Emacs 22+),
`isearchp-toggle-limit-match-numbers-to-region' (Emacs 24.3+),
`isearchp-toggle-literal-replacement' (Emacs 22+),
`isearchp-toggle-option-toggle',
`isearchp-toggle-regexp-quote-yank',
`isearchp-toggle-region-deactivation' (Emacs 24.3+),
`isearchp-toggle-region-restriction' (Emacs 24.3+),
`isearchp-toggle-repeat-search-if-fail' (Emacs 22+),
`isearchp-toggle-search-invisible',
`isearchp-toggle-set-region',
`isearchp-toggle-showing-filter-prompt-prefixes' (Emacs 24.4+),
`isearchp-toggle-showing-match-number' (Emacs 24.3+),
`isearchp-toggle-symmetric-char-fold' (Emacs 25+),
`isearchp-yank-char' (Emacs 22+), `isearchp-yank-line' (Emacs
22+), `isearchp-yank-line-backward',
`isearchp-yank-line-forward', `isearchp-yank-through-key-move',
`isearchp-yank-through-new-match',
`isearchp-yank-through-rec-edit-move',
`isearchp-yank-sexp-symbol-or-char' (Emacs 22+),
`isearchp-yank-sexp-symbol-or-char-1',
`isearchp-yank-symbol-or-char' (Emacs 22+),
`isearchp-yank-word-or-char' (Emacs 22+),
`isearchp-yank-word-or-char-backward',
`isearchp-yank-word-or-char-forward'.
User options defined here:
`isearchp-auto-keep-filter-predicate-flag' (Emacs 22+),
`isearchp-case-fold', `isearchp-deactivate-region-flag' (Emacs
24.3+), `isearchp-directional-yank', `isearchp-drop-mismatch',
`isearchp-drop-mismatch-regexp-flag',
`isearchp-filter-predicates-alist' (Emacs 24.4+),
`isearchp-highlight-regexp-group-levels-flag' (Emacs 24.4+),
`isearchp-initiate-edit-commands' (Emacs 22+),
`isearch-lazy-count' (Emacs 22-26),
`isearchp-lazy-dim-filter-failures-flag' (Emacs 24.4+),
`isearchp-limit-match-numbers-to-region-flag' (Emacs 24.3+),
`isearchp-mouse-2-flag', `isearchp-movement-unit-alist' (Emacs
24.4+), `isearchp-on-demand-action-function' (Emacs 22+),
`isearchp-prompt-for-filter-name' (Emacs 24.4+),
`isearchp-regexp-quote-yank-flag',
`isearchp-repeat-search-if-fail-flag' (Emacs 22+),
`isearchp-restrict-to-region-flag' (Emacs 24.3+),
`isearchp-resume-with-last-when-empty-flag' (Emacs 22+),
`isearchp-ring-bell-function', `isearchp-set-region-flag',
`isearchp-toggle-option-flag',
`isearchp-update-filter-predicates-alist-flag' (Emacs 24.4+).
Faces defined here:
`isearch-fail', `isearchp-lazy-odd-regexp-groups' (Emacs 24.4+),
`isearchp-multi', `isearchp-overwrapped', `isearchp-regexp',
`isearchp-regexp-level-1' (Emacs 24.4+),
`isearchp-regexp-level-2' (Emacs 24.4+),
`isearchp-regexp-level-3' (Emacs 24.4+),
`isearchp-regexp-level-4' (Emacs 24.4+),
`isearchp-regexp-level-5' (Emacs 24.4+),
`isearchp-regexp-level-6' (Emacs 24.4+),
`isearchp-regexp-level-7' (Emacs 24.4+),
`isearchp-regexp-level-8' (Emacs 24.4+), `isearchp-word',
`isearchp-wrapped'.
Macros defined here:
`isearchp-define-in/out-filter',
`isearchp-define-yank-movement-command', `isearchp-user-error'.
Non-interactive functions defined here:
`isearchp-add-filter-predicate-1' (Emacs 24.4+),
`isearchp-assoc-delete-all', `isearchp-barf-if-use-minibuffer',
`isearchp-columns-p' (Emacs 24.4+),
`isearchp-complete-past-string',
`isearchp-constrain-to-rectangular-region' (Emacs 25+),
`isearchp-current-filter-predicates' (Emacs 24.4+),
`isearchp-fail-pos', `isearchp-ffap-guesser' (Emacs 24.4+),
`isearchp-filter-bookmark-alist-only' (Emacs 24.4+),
`isearchp-filter-bookmark-p' (Emacs 24.4+),
`isearchp-filters-description' (Emacs 24.4+),
`isearchp-first-isearch-advice' (Emacs 24.4+),
`isearchp-highlight-lighter', `isearchp-in-color-p' (Emacs
24.4+), `isearchp-in-comment-p' (Emacs 24.4+),
`isearchp-in-comment-or-delim-p' (Emacs 24.4+),
`isearchp-in-decimal-number-p' (Emacs 24.4+),
`isearchp-in-defun-p' (Emacs 24.4+),
`isearchp-in-email-address-p' (Emacs 24.4+),
`isearchp-in-file-name-p' (Emacs 24.4+),
`isearchp-in-file-or-url-p' (Emacs 24.4+),
`isearchp-in-hex-number-p' (Emacs 24.4+), `isearchp-in-line-p'
(Emacs 24.4+), `isearchp-in-lisp-variable-p' (Emacs 24.4+),
`isearchp-in-list-p' (Emacs 24.4+), `isearchp-in-number-p'
(Emacs 24.4+), `isearchp-in-page-p' (Emacs 24.4+),
`isearchp-in-paragraph-p' (Emacs 24.4+),
`isearchp-in-sentence-p' (Emacs 24.4+), `isearchp-in-sexp-p'
(Emacs 24.4+), `isearchp-in-string-or-comment-p' (Emacs 24.4+),
`isearchp-in-string-p' (Emacs 24.4+), `isearchp-in-symbol-p'
(Emacs 24.4+), `isearchp-in-thing-p' (Emacs 24.4+),
`isearchp-in-url-p' (Emacs 24.4+), `isearchp-in-word-p' (Emacs
24.4+), `isearchp-last-isearch-advice' (Emacs 24.4+),
`isearchp-match-regexp-filter-predicate' (Emacs 24.4+),
`isearchp-message-prefix', `isearchp-message-suffix',
`isearchp-near-after-predicate' (Emacs 24.4+),
`isearchp-near-before-predicate' (Emacs 24.4+),
`isearchp-near-predicate' (Emacs 24.4+), `isearchp-not-pred'
(Emacs 24.4+), `isearchp-not-in-color-p' (Emacs 24.4+),
`isearchp-not-in-comment-p' (Emacs 24.4+),
`isearchp-not-in-comment-or-delim-p' (Emacs 24.4+),
`isearchp-not-in-decimal-number-p' (Emacs 24.4+),
`isearchp-not-in-defun-p' (Emacs 24.4+),
`isearchp-not-in-email-address-p' (Emacs 24.4+),
`isearchp-not-in-file-name-p' (Emacs 24.4+),
`isearchp-not-in-file-or-url-p' (Emacs 24.4+),
`isearchp-not-in-hex-number-p' (Emacs 24.4+),
`isearchp-not-in-line-p' (Emacs 24.4+),
`isearchp-not-in-lisp-variable-p' (Emacs 24.4+),
`isearchp-not-in-list-p' (Emacs 24.4+),
`isearchp-not-in-number-p' (Emacs 24.4+),
`isearchp-not-in-page-p' (Emacs 24.4+),
`isearchp-not-in-paragraph-p' (Emacs 24.4+),
`isearchp-not-in-sentence-p' (Emacs 24.4+),
`isearchp-not-in-sexp-p' (Emacs 24.4+),
`isearchp-not-in-string-or-comment-p' (Emacs 24.4+),
`isearchp-not-in-string-p' (Emacs 24.4+),
`isearchp-not-in-symbol-p' (Emacs 24.4+),
`isearchp-not-in-url-p' (Emacs 24.4+), `isearchp-not-in-word-p'
(Emacs 24.4+), `isearchp-not-predicate' (Emacs 24.4+),
`isearchp-oddp', `isearchp-or-predicates' (Emacs 24.4+),
`isearchp-or-preds' (Emacs 24.4+), `isearchp-read-face-names',
`isearchp-read-face-names--read', `isearchp-read-filter-name'
(Emacs 24.4+), `isearchp-read-measure' (Emacs 24.4+),
`isearchp-read-near-args' (Emacs 24.4+),
`isearchp-read-predicate' (Emacs 24.4+),
`isearchp-read-prompt-prefix' (Emacs 24.4+),
`isearchp-read-regexp-during-search' (Emacs 24.4+),
`isearchp-read-sexps', `isearchp-redo-lazy-highlighting' (Emacs
24.4+), `isearchp-remove-duplicates',
`isearchp-remove-mismatch', `isearchp-repeat-command',
`isearchp-repeat-search-if-fail' (Emacs 22+),
`isearchp-replace-fixed-case-p' (Emacs 22+),
`isearchp-replace-match' (Emacs 22+),
`isearchp-replace-multiple' (Emacs 22+),
`isearchp-replace-on-demand' (Emacs 22+),
`isearchp-reset-noprompt-action-fn', `isearchp-set-region',
`isearchp-set-sel-and-yank', `isearchp-show-hit-w-crosshairs'
(Emacs 24.4+), `isearchp-update-edit-init-commands' (Emacs 22+).
Internal variables defined here:
`isearchp-current-filter-preds-alist' (Emacs 24.4+),
`isearchp-ffap-max-region-size' (Emacs 24.4+),
`isearchp-filter-map' (Emacs 24.4+),
`isearchp-in-lazy-highlight-update-p' (Emacs 24.3+),
`isearchp-kept-filter-predicate' (Emacs 24.4+),
`isearchp-last-non-nil-invisible',
`isearchp-last-quit-regexp-search', `isearchp-last-quit-search',
`isearchp-lazy-highlight-face' (Emacs 22+),
`isearchp-lazy-regexp-level-overlays' (Emacs 24.4+),
`isearchp-nomodify-action-hook' (Emacs 22+),
`isearchp-noprompt-action-function',
`isearchp-orig-ring-bell-fn', `isearchp-pref-arg',
`isearchp-reached-limit-p', `isearchp-reg-beg',
`isearchp-reg-end', `isearchp-regexp-level-overlays' (Emacs
24.4+), `isearchp-replace-literally' (Emacs 22+),
`isearchp-replacement' (Emacs 22+),
`isearchp--replacing-on-demand' (Emacs 22+),
`isearch-update-post-hook' (Emacs 20-21),
`isearchp-user-entered-new-filter-p' (Emacs 24.4+),
`isearchp-win-pt-line'.
***** NOTE: The following macros and functions defined in
`isearch.el' have been REDEFINED OR ADVISED HERE:
`isearch-abort' - Save search string when `C-g'.
`isearch-backward', `isearch-backward-regexp' -
Prefix arg can `multi-isearch-buffers'.
`isearch-cancel' - Restore cursor position relative to window.
`isearch-dehighlight' - Delete regexp-group level overlays too.
Added unused arg, for Emacs 20.
`isearch--describe-word-mode' - Face `isearchp-word' on string.
`isearch-done' - Restore/update `isearch-filter-predicate'.
Reset `ring-bell-function'.
`isearch-edit-string' - Put point at mismatch position.
`isearch-forward', `isearch-forward-regexp' -
Prefix arg can `multi-isearch-buffers'.
`isearch-highlight' - Highlight also regexp-group levels.
`lazy-highlight-cleanup' - Delete lazy regexp overlays. (24.4+)
`isearch-lazy-highlight-search' - Can limit to region (24.3+)
`isearch-lazy-highlight-update' - Can limit to region (24.3+)
`isearch-mode' - Save cursor position relative to window.
`isearch-mode-help' - End isearch. List bindings.
`isearch-message' - Highlight failed part of search string in
echo area, in face `isearch-fail'.
`isearch-message-prefix' - Highlight prompt keywords: wrapped,
regexp, word, multi. Highlight filter
prefixes, and reverse their order.
`isearch-mouse-2' - Respect `isearchp-mouse-2-flag'(Emacs 21+)
`isearch-process-search-string' - Added arg RESPECT-DIRECTION.
`isearch-search' - Can limit to active region (Emacs 24.3+)
`isearch-repeat' - Can limit to active region (Emacs 24.3+)
`isearch-printing-char' - Respect option `isearchp-drop-mismatch'
`isearch-toggle-case-fold' - Respect `isearchp-toggle-option-flag'
Show case sensitivity in mode-line.
Message.
`isearch-toggle-invisible' - Respect `isearchp-toggle-option-flag'
Message.
`isearch-toggle-word' - Message, and turn off regexp search.
`isearch-update' - Run `isearch-update-post-hook' (Emacs 20-21).
- Run `isearchp-noprompt-action-function' and
`isearchp-nomodify-action-hook' (Emacs 22+).
`isearch-yank-char' - Respect `isearchp-directional-yank'.
`isearch--yank-char-or-syntax' - Added arg RESPECT-DIRECTION.
`isearch-yank-string' - 1. Respect `isearchp-regexp-quote-yank-flag'.
2. Added arg RESPECT-DIRECTION.
`isearch-yank-internal' - Added arg RESPECT-DIRECTION.
`isearch-yank-line' - 1. Respect `isearchp-directional-yank'.
2. Use `isearchp-yank-line-forward' and
`isearchp-yank-line-backward'.
`isearch-yank-symbol-or-char'- Respect `isearchp-directional-yank'
`isearch-yank-until-char' - Respect `isearchp-directional-yank'.
`isearch-yank-word' - Respect `isearchp-directional-yank'.
`isearch-yank-word-or-char' - Respect `isearchp-directional-yank'.
`with-isearch-suspended' - Add `catch': update `isearch-success'.
***** NOTE: The following internal variables defined in
`isearch.el' have been REDEFINED HERE:
`isearch-invisible' - defined for Emacs<24.4 & added doc string.
***** NOTE: The following function defined in `misearch.el' has
been ADVISED HERE:
`multi-isearch-end' - Fix for bug #20234: reset buffer list.
Keys bound in `isearch-mode-map' here, by default. Some are from
`isearch-prop.el' or `highlight.el'. Keys bound to
`isearchp-init-edit' by default are controlled by option
`isearchp-initiate-edit-commands'.
`C-`' `isearchp-toggle-regexp-quote-yank'
`C-+' `isearchp-toggle-search-invisible'
`C-_' `isearchp-yank-symbol-or-char' (Emacs 22+)
`C-(' `isearchp-yank-sexp-symbol-or-char' (Emacs 22+)
`C-backspace' `isearchp-remove-failed-part-or-last-char'
(Emacs 22+)
`C-end' `goto-longest-line' (requires `misc-cmds.el')
`C-left' `isearchp-init-edit' (Emacs 22+)
`C-SPC C-SPC' `isearchp-toggle-region-deactivation'
(Emacs 24.3+)
`C-b' `isearchp-init-edit' (Emacs 22+)
`C-h' `isearch-mode-help'
`C-t' `isearchp-property-forward' (Emacs 23+)
(`isearch-prop.el')
`C-x n' `isearchp-toggle-region-restriction' (Emacs 24.3+)
`C-x o' `isearchp-open-recursive-edit' (Emacs 22+)
`C-x r g' `isearchp-append-register'
`C-x 8 RET' `isearch-char-by-name' (Emacs 23-24.3)
`C-y C-_' `isearchp-yank-symbol-or-char' (Emacs 22+)
`C-y C-(' `isearchp-yank-sexp-symbol-or-char' (Emacs 22+)
`C-y C-2' `isearch-yank-secondary' (requires `second-sel.el')
`C-y C-c' `isearchp-yank-char' (Emacs 22+)
`C-y C-e' `isearchp-yank-line' (Emacs 22+)
`C-y C-w' `isearchp-yank-word-or-char' (Emacs 22+)
`C-y C-y' `isearch-yank-kill'
`C-y M-g' `isearchp-retrieve-last-quit-search'
`C-y M-y' `isearch-yank-pop' (Emacs 24+)
`C-y C-M-c' `isearchp-yank-through-rec-edit-move'
`C-y C-M-k' `isearchp-yank-through-key-move'
`C-y C-M-m' `isearchp-yank-through-new-match' (aka `M-RET`)
`C-y C-M-z' `isearch-yank-until-char'
`C-z !' `isearchp-set-filter-predicate' (Emacs 24.4+)
`C-z %' `isearchp-add-regexp-filter-predicate'
(Emacs 24.4+)
`C-z .' `isearchp-add-inline-regexp-filter-predicate'
(Emacs 24.4+)
`C-z &' `isearchp-add-filter-predicate' (Emacs 24.4+)
`C-z -' `isearchp-remove-filter-predicate' (Emacs 24.4+)
`C-z 0' `isearchp-reset-filter-predicate' (Emacs 24.4+)
`C-z <' `isearchp-near-before' (Emacs 24.4+)
`C-z >' `isearchp-near-after' (Emacs 24.4+)
`C-z ?' `isearchp-show-filters' (Emacs 24.4+)
`C-z @' `isearchp-near' (Emacs 24.4+)
`C-z b' `isearchp-bookmark-current-filter-predicate' (Emacs
24.4+ and requires library Bookmark+)
`C-z c' `isearchp-columns' (Emacs 24.4+)
`C-z n' `isearchp-defun-filter-predicate' (Emacs 24.4+)
`C-z p' `isearchp-toggle-showing-filter-prompt-prefixes'
(Emacs 24.4+)
`C-z S' `isearchp-toggle-auto-keep-filter-predicate'
(Emacs 24.4+)
`C-z s' `isearchp-keep-filter-predicate' (Emacs 24.4+)
`C-z ||' `isearchp-or-filter-predicate' (Emacs 24.4+)
`C-z |1' `isearchp-or-last-filter' (Emacs 24.4+)
`C-z ~~' `isearchp-complement-filter' (Emacs 24.4+)
`C-z ~1' `isearchp-negate-last-filter' (Emacs 24.4+)
`C-M-;' `isearchp-toggle-ignoring-comments' (Emacs 23+)
(`isearch-prop.el')
`C-M-`' `isearchp-toggle-literal-replacement' (Emacs 22+)
`C-M-~' `isearchp-toggle-complementing-domain' (Emacs 23+)
(`isearch-prop.el')
`C-M-RET' `isearchp-act-on-demand' (Emacs 22+)
`C-M-tab' `isearchp-complete' (on MS Windows)
`C-M-b' `isearchp-init-edit' (Emacs 22+)
`C-M-D' `isearchp-toggle-dimming-outside-search-area'
(Emacs 23+) (`isearch-prop.el')
`C-M-left' `isearchp-init-edit' (Emacs 22+)
`C-M-i' `isearchp-complete'
`C-M-l' `isearchp-remove-failed-part' (Emacs 22+)
`C-M-t' `isearchp-property-forward-regexp' (Emacs 23+)
`C-M-y' `isearch-yank-secondary' (requires `second-sel.el')
`C-S-SPC' `isearchp-narrow-to-lazy-highlights' (Emacs 23+)
(`isearch-prop.el')
`M-:' `isearchp-eval-sexp-and-insert' (Emacs 22+)
`M-;' `isearchp-toggle-hiding-comments' (Emacs 23+)
(`isearch-prop.el')
`M-left' `isearchp-init-edit' (Emacs 22+)
`M-b' `isearchp-init-edit' (Emacs 22+)
`M-c' `isearch-toggle-case-fold'
`M-e' `isearch-edit-string'
`M-g' `isearchp-retrieve-last-quit-search'
`M-k' `isearchp-cycle-mismatch-removal'
`M-r' `isearch-toggle-regexp'
`M-w' `isearchp-kill-ring-save'
`M-s h ' `isearchp-toggle-lazy-highlighting'
`M-s C-e' `isearchp-yank-line' (Emacs 22+)
`M-s =' `isearchp-toggle-symmetric-char-fold' (Emacs 25+)
`M-s #' `isearchp-toggle-showing-match-number' (Emacs 24.3+)
`M-s %' `isearchp-toggle-limit-match-numbers-to-region'
(Emacs 24.3+)
`M-s h d' `isearchp-toggle-dimming-filter-failures'
(Emacs 24.4+)
`M-s h b' `isearchp-toggle-lazy-highlight-full-buffer'
(Emacs 24.3+)
`M-s h f' `isearchp-highlight-matches-other-face' (Emacs 22+)
`M-s h h' `hlt-highlight-isearch-matches'
`M-s h l' `isearchp-toggle-lazy-highlight-cleanup'
(Emacs 22+)
`M-s h L' `isearchp-toggle-lazy-highlighting' (Emacs 22+)
`M-s h R' `isearchp-toggle-highlighting-regexp-groups'
`M-s h u' `hlt-unhighlight-isearch-matches'
`M-s i' `isearch-toggle-invisible'
`M-s v' `isearchp-toggle-option-toggle'
`M-TAB' `isearchp-complete'
`M-s M-SPC' `isearchp-toggle-set-region'
`M-s M-k' `isearchp-toggle-repeat-search-if-fail' (Emacs 22+)
`M-s u f' `isearchp-unhighlight-last-face' (Emacs 22+)
`M-s z a' `isearchp-add-zones-from-lazy-highlighting'
`M-s z r' `isearchp-noncontiguous-region-from-lazy-highlighting'
`M-s z s' `isearchp-set-zones-from-lazy-highlighting'
`M-S-delete' `isearchp-cleanup' (Emacs 23+) (`isearch-prop.el')
`left' `isearchp-init-edit' (Emacs 22+)
`mouse-2' `isearch-mouse-2'
`next' `isearch-repeat-forward'
`prior' `isearch-repeat-backward'
User option `isearchp-initiate-edit-commands' causes certain keys
not to exit Isearch but rather to edit the search string.
Customize it to `nil' if you do not want this behavior at all.
The following bindings are made here for incremental search edit
mode:
`C-x 8 RET' `insert-char' (Emacs 23+)
`C-M-tab' `isearch-complete-edit' (MS Windows only)
(@* "Overview of Features")
Overview of Features ---------------------------------------------
* Dynamic search filtering (starting with Emacs 24.4).
You can add and remove any number of search filters while
searching incrementally. See
https://www.emacswiki.org/emacs/DynamicIsearchFiltering.
The predicate that is the value of `isearch-filter-predicate' is
advised by additional predicates that you add, creating a
complex suite of predicates that act together.
Reminder: An Isearch filter predicate is a function that accepts
two buffer positions, BEG and END, as its first two arguments.
These values are the beginning and ending positions of a search
hit. If the return value of the function is `nil' then the
search hit is excluded from searching; otherwise it is included.
The value of standard variable (but not a user option)
`isearch-filter-predicate' is the filter predicate used by
Isearch. By default, the value is predicate
`isearch-filter-visible', which returns non-`nil' for any search
hit that is visible (not rendered invisible by a text property,
overlay property, etc.)
If you search the Emacs Lisp source code, you will find only two
uses, so far, of variable `isearch-filter-predicate', even
though such filtering has been around since Emacs 23. It's
hardly ever used. Why?
Because it's not so easy to use, out of the box. And it's not
thought of as a way to *refine* searches, but rather as a way to
*wall off* certain areas from searching.
Yes, those are in fact the same thing, but I don't think people
think this way ... because Isearch does not make it particularly
easy to use filters. Isearch+ tries to do that, to let you
refine searches by adding filters incrementally.
The idea is simple: Isearch+ defines some keys that prompt you
for a filter. You can enter any filter predicates at the
prompts. There are also some predefined predicates that you can
choose from, using completion. You can combine predicates using
AND, OR, and NOT.
A filter predicate does essentially the same thing as the search
pattern that you type at the Isearch prompt. Each restricts the
search space (the buffer text) to certain zones: those that
satisfy the predicate and those that match the search pattern.
But a predicate can be much more general than is the predefined
pattern-matching provided by Emacs Isearch. Suppose that you
want to find lines of text that contain `cat', `dog', and
`turtle'. There is no simple search pattern that lets you do
this. A regexp would need to explicitly express each possible
order, and there are 6 of them - not so simple.
But a predicate can just check each line for `cat' AND check for
`dog' AND check for `turtle'. It is usually much easier to
combine simple patterns than it is to come up with a complex
pattern that does the same thing. And the way to combine
patterns in Emacs Isearch is to use one or more filter
predicates.
A filter predicate can even perform side effects, if you like.
Only the return value is used by Isearch. For example, if you
wanted to more easily see the cursor position each time search
stops at a search hit, you could use something like this as a
filter predicate. (This requires library `crosshairs.el', which
highlights the current column and line using crosshairs.)
(lambda (beg end)
(save-excursion (goto-char end)) ; Go to end of search hit.
;; Avoid calling `crosshairs' when inside
;; `isearch-lazy-highlight-search'.
(unless isearchp-in-lazy-highlight-update-p (crosshairs))
t) ; Return non-nil always - no real filtering.
The side-effect-producing call to function `crosshairs' is
guarded by variable `isearchp-in-lazy-highlight-update-p' here,
so that it is invoked only when the cursor is moved to a search
hit, not also when lazy highlighting is performed. (Filtering
applies also to lazy highlighting: it filters out search hits
that are not being used. But in this case no real filtering is
done, and there is no need to show crosshairs moving across the
buffer during lazy highlighting.)
(You can choose that crosshairs-showing filter predicate by the
name `crosshairs' when prompted for a predicate. It corresponds
to predicate `isearchp-show-hit-w-crosshairs'.)
The following filtering commands are available during Isearch.
They are all on prefix key `C-z', by default. They are on
prefix keymap `isearchp-filter-map', which you can bind to any
key in `isearch-mode-map'. If you forget a `C-z' key, you can
use `C-z C-h' while searching to show them all.
- `C-z &' (`isearchp-add-filter-predicate') adds a filter
predicate, AND-ing it as an additional `:after-while' filter.
- `C-z %' (`isearchp-add-regexp-filter-predicate') adds a filter
predicate that requires search hits to match a given regexp.
- `C-z .' (`isearchp-add-inline-regexp-filter-predicate') is
really just `C-z %', but `.*' is added to each side of the
regexp you enter. You can use this multiple times when regexp
searching for full lines with `.+', to find the lines that
contain multiple regexp matches in any order.
- `C-z ||' (`isearchp-or-filter-predicate') adds a filter
predicate, OR-ing it as an additional `:before-until' filter.
- `C-z |1' (`isearchp-or-last-filter') replaces the last-added
filter by its disjunction with another predicate, which you
specify.
- `C-z ~~' (`isearchp-complement-filter') complements the current
filter. It either adds an `:around' filter that complements
or it removes an existing top-level complementing filter.
- `C-z ~1' (`isearchp-negate-last-filter') replaces the
last-added filter by its complement.
- `C-z -' (`isearchp-remove-filter-predicate') removes a filter
predicate that you specify, using completion. The last-added
is the default - retrieve it using `M-n'.
- `C-z !' (`isearchp-set-filter-predicate') sets the overall
filter predicate (advised `isearch-filter-predicate') to a
single predicate.
- `C-z 0' (`isearchp-reset-filter-predicate') resets
`isearch-filter-predicate' to its original (default) value.
- `C-z b' (`isearchp-bookmark-current-filter-predicate')
bookmarks the current value of `isearch-filter-predicate',
persisting it for reuse in future Emacs sessions. You need
library Bookmark+ to be able to use this.
- `C-z c' (`isearchp-columns') adds a filter predicate that
limits search between two columns (or before/after a column).
- `C-z n' (`isearchp-defun-filter-predicate') names the current
suite of filter predicates, creating a named predicate that
does the same thing. With a prefix arg it can also set or
keep it (for this Emacs session) - that is, do what `C-z !' or
`C-z s' does.
You can use that name with `C-z -' to remove that predicate.
You can also use it to create a custom Isearch command that
uses it for filtering. For example:
(defun foo ()
"Isearch with filter predicate `my-filter-pred'."
(interactive)
(let ((isearch-filter-predicate 'my-filter-pred))
(isearch-forward)))
- `C-z p' (`isearchp-toggle-showing-filter-prompt-prefixes')
toggles option `isearchp-show-filter-prompt-prefixes-flag',
which controls whether to show filter prefixes in the Isearch
prompt.
- `C-z s' (`isearchp-keep-filter-predicate') keeps the current
filter-predicate suite for subsequent searches (in this Emacs
session only). Unless you do this (and unless auto-keeping is
turned on), the next Isearch starts out from scratch, using
the default value of `isearch-filter-predicate'. (To remove
the kept predicate suite, use `C-z 0'.)
- `C-z S' (uppercase `s')
(`isearchp-toggle-auto-keep-filter-predicate') toggles option
`isearchp-auto-keep-filter-predicate-flag', which
automatically keeps the current filter-predicate suite, so
that it is used for subsequent searches (so no need to use
`C-z s'). (To remove a kept predicate suite, use `C-z 0'.)
- `C-z ?' (`isearchp-show-filters') echoes the current suite of
filter predicates (advice and original, unadvised predicate).
- `C-z @', `C-z <', and `C-z >' (`isearchp-near',
`isearchp-near-before', and `isearchp-near-after') constrain
searching to be within a given distance of (near) another
search pattern. For example, you can limit search hits to
those whose end (or beginning, if searching backward) is
within, say, 4 words of another search pattern. You are
prompted for the search pattern for the nearby text, the
"near" distance, and the unit of distance measurement
(default: characters). You can define the list of acceptable
units by customizing option `isearchp-movement-unit-alist'.
The default option value includes units character, word, sexp,
list, and sentence.
You can also use functions `isearch-near-predicate',
`isearchp-near-before-predicate', and
`isearchp-near-after-predicate' to define your own nearness
predicates, which incorporate particular patterns and
distances. You can then simply add such a predicate using `C-z
&' (no prompting for pattern or distance).
Typically you add (`C-z &', `C-z %', etc.) a filter predicate to
those already active, or you remove one (`C-z -'). Adding is
implicitly an AND operation: the list of current predicates must
all be satisfied. You can also OR a predicate against either
the entire ANDed list of predicates (`C-z ||') or against only
the last-added one (`C-z |1'). And you can complement either
the entire ANDed list (`C-z ~~') or just the last-added
predicate (`C-z ~1').
This ORing and NOTing, together with adding and removing
predicates in a given order (implicitly ANDing them), gives you
complete Boolean combination flexibility.
The list of filter predicates is always a conjunction. But you
can use, as any of the conjuncts, a predicate that implements a
disjunction or a negation. Or you can replace the entire list
by a single predicate that implements a disjunction or a
negation.
When you use one of the commands that adds a filter predicate as
advice to `isearch-filter-predicate' you can be prompted for two
things: (1) a short name for the predicate and (2) text to add
to the Isearch prompt as a reminder of filtering. The optional
short name is a convenience for referring to the predicate - for
adding it again or removing it, for example.
Two user options control this prompting:
- `isearchp-prompt-for-filter-name' says whether to prompt you
always, never, or only when the predicate that you provide is
not a symbol (it is a lambda form). The last of these is the
default behavior. If you are prompted and provide a name, you
can use that name with `C-z -' to remove that predicate.
- `isearchp-prompt-for-prompt-prefix-flag' says whether to
prompt you for a prefix to add to the Isearch prompt. You are
prompted by default, but if you don't care to see such a
prompt prefix and you don't want to be bothered by it, you can
customize this to skip prompting.
In addition, whatever the value of these options, when you add a
filter predicate you can override the option values by using a
prefix argument. A non-positive prefix arg overrides the option
for name prompting, and a non-negative prefix arg overrides the
option for prompt-prefix prompting. (So zero, e.g., `M-0',
overrides both.)
Option `isearchp-show-filter-prompt-prefixes-flag' controls
whether prefixes for filters are added to the Isearch prompt.
You can toggle this option during search using `C-z p'.
User option `isearchp-filter-predicates-alist' contains filter
predicates that are available as completion candidates whenever
you are prompted for one. This is an important option. The
alist entries can be of several forms, which affect the behavior
differently.
In particular, instead of choosing a filter predicate as a
completion candidate, you can choose a function that creates and
returns a filter predicate, after prompting you for some more
information.
This is the case, for example, for function
`isearchp-near-before-predicate'. It is used in the predefined
alist entry `("near<..." isearchp-near-before-predicate)',
which associates the short name `near<...', as a completion
candidate, with the function.
When you choose this candidate, function
`isearchp-near-before-predicate' prompts you for another pattern
for Isearch to match, a max number of units of nearness, and
which units to measure with. It constructs and returns a
predicate that checks those match parameters. As usual, you can
be prompted for a short name and an Isearch prompt prefix to
associate with the newly defined predicate, so that you can
easily choose it again (no prompting).
Similarly, candidate `not...' prompts you for a predicate to
negate, and candidate `or...' prompts you for two predicates to
combine using `or'.
For the completion candidates that are predefined, this
naming convention is used:
* Bracketed names (`[...]') stand for predicates that check that
the search hit is (entirely) within something. For example,
name `[;]' means that each filtered search hit must be inside
a comment (`;' is the Emacs-Lisp comment-start character), and
name `[defun]' means each search hit must be inside a defun.
* A `~' in front of a name means "not". For example, `~[;]'
means the filtered search hits must not be in comments.
* Names that end in `...' indicate candidates that prompt you
for more information. These names represent, not filter
predicates, but functions that return filter predicates. For
example, `near<...' stands for function
`isearchp-near-before-predicate' (see above).
Filter predicates that you add dynamically are added as
completion candidates for the current Emacs session. If option
`isearchp-update-filter-predicates-alist-flag' is non-`nil' then
they are also added to `isearchp-filter-predicates-alist'. That
updated option value is NOT SAVED, however. If you want to save
your additions to it for future Emacs sessions then use
`M-x customize-option isearchp-filter-predicates-alist'.
You can use command `isearchp-reset-filter-preds-alist' (not
bound) to reset the filter predicates available for completion
to those in option `isearchp-filter-predicates-alist'. A prefix
arg with `C-z 0' also resets this, along with resetting to the
unadvised value of `isearch-filter-predicate'.
If option `isearchp-lazy-dim-filter-failures-flag' is non-`nil'
then search hits that are skipped because they are removed by
filtering are nevertheless lazy-highlighted, but using a face
that dims the background. You can toggle this highlighting of
filter-failure search hits using `M-s h d' (command
`isearchp-toggle-dimming-filter-failures').
The dimming face for this is hard-coded as having background
color #9abfca, unless you also use library `isearch-prop.el'
(recommended). If you use `isearch-prop.el' then you can
control the dimming color using option `isearchp-dimming-color'.
It specifies a given background color to use always, or it
specifies that the current background color is to be dimmed a
given amount.
* Case-sensitivity is indicated in the mode line minor-mode
lighter: `ISEARCH' for case-insensitive; `Isearch' for
case-sensitive.
* Optional highlighting of the first eight regexp-group levels in
the current search hit, controlled by option
`isearchp-highlight-regexp-group-levels-flag'. For
lazy-highlighting of other search hits, the odd groups are
highlighted differently from the even groups. You can toggle
the value using `M-s h R' (command
`isearchp-toggle-highlighting-regexp-groups.') during Isearch.
* Whether search is literal or regexp is indicated in the mode
line minor-mode lighter: `R*SEARCH' or `R*search', for regexp.
* Highlighting of the mode-line minor-mode lighter when search has
wrapped around or overwrapped.
* Highlighting of parts of the prompt, to indicate the type of
search: regexp, word, multiple-buffer, and whether searching has
wrapped around the buffer (Emacs 22+ only).
* Optional restriction of search to the active region, controlled
by option `isearchp-restrict-to-region-flag'. Deactivation of
the active region is controlled by option
`isearchp-deactivate-region-flag'. Both of these are available
for Emacs 24.3 and later.
Restriction of Isearch to the region works also for a
rectangular region (which you create using `M-x
rectangle-mark-mode').
NOTE: For search to be limited to the region in Info, you must
also use library `info+.el'.
You can use `C-x n' (command
`isearchp-toggle-region-restriction') and `C-SPC C-SPC' (command
`isearchp-toggle-region-deactivation') during search to toggle
`isearchp-restrict-to-region-flag' and
`isearchp-deactivate-region-flag', respectively, but in each
case the new value takes effect only when the current search is
exited.
* Option and commands to let you select the last target occurrence
(set the region around it):
- Option `isearchp-set-region-flag' - Non-`nil' means
automatically set the region around the last search target.
- Command `isearchp-toggle-set-region', bound to `M-s M-SPC'
during isearch - toggle `isearchp-set-region-flag'.
- Command `isearchp-set-region-around-search-target' - manually
set the region around the last search target.
* When you visit a search hit, you can perform an action on it.
Use `C-M-RET' (command `isearchp-act-on-demand' - Emacs 22+
only) to invoke the action function that is the value of option
`isearchp-on-demand-action-function'. That function is passed
the current search-hit string and its start and end positions in
the buffer. Search moves to the next hit in the same search
direction, so just repeating `C-M-RET' carries out the action on
subsequent hits.
* The default value of `isearchp-on-demand-action-function' is
function `isearchp-replace-on-demand', which replaces the search
hit. This means that you can replace (or delete) chosen search
hits on demand.
By default, the replacement string is empty, so with no prefix
argument the action is to delete the search hit (replace it with
nothing).
With a prefix arg, `isearchp-replace-on-demand' prompts for the
replacement, which is used thereafter until you again use a
prefix arg. Since you can use a prefix arg at any time, you can
provide different replacements for different search hits. When
prompted, if you clear the minibuffer and hit `RET', hit
replacement just becomes search-hit deletion.
. With a plain prefix arg (`C-u') or a numeric prefix arg of
value 1 (e.g. `C-1'), `isearchp-replace-on-demand' replaces
only the current search hit.
. With a negative prefix arg (e.g. `M--' or `C--'),
`isearchp-replace-on-demand' toggles automatic replacement by
just searching. Automatic replacement means that each time
you use a search key (e.g. `C-s') to visit a search hit, the
hit is automatically replaced, without your needing to hit
`C-M-RET'. Using a prefix arg again with `C-M-RET' cancels
this (as does quitting and restarting Isearch).
. With a positive prefix arg N (e.g. `C-8' or `C-u 200'),
`isearchp-replace-on-demand' replaces N search hits (but it
stops at the search limit, if reached).
. With a zero prefix arg (e.g. `C-0),
`isearchp-replace-on-demand' replaces *all* remaining search
hits (up to the search limit).
(NOTE: To use a prefix arg within Isearch, you must set
`isearch-allow-prefix' (if available) or `isearch-allow-scroll'
to non-`nil'.)
* When you use on-demand replacement (with `C-M-RET') the
replacement text can be either inserted literally, as is, or
interpreted as in `query-replace-regexp'. In the latter case,
you can use `\&', `\=\N', `\#', `\,' and `\?'.
For example, suppose you use a regexp-search pattern of
`\(e\)\|a' and a replacement pattern of `\,(if \1 "a" "e")'.
Each `C-M-RET' will then swap `e' for `a' and vice versa.
See the doc for `query-replace-regexp' and node `Regexp Replace'
of the Emacs manual for more information.
(Note that `\?' is supported, but it is not very useful in this
context, because it prompts you to edit the result each time you
hit `C-M-RET'. Instead, use `C-u C-M-RET' whenever you want to
change (edit) the replacement pattern.)
* You can use `C-M-`' (`isearchp-toggle-literal-replacement')
anytime during Isearch to toggle whether replacement text is
used literally or interpreted per the special regexp-replacement
constructs.
Note that the use of the special regexp replacement patterns is
unrelated to the kind of incremental search: literal string
search or regexp search. Just remember that the way to switch
on/off the special behavior of `\&' and so on is to use `C-M-`'.
* The value of variable `isearchp-noprompt-action-function' is a
function that is invoked automatically, after you visit each
search hit. The function is called with no arguments. It
cannot use the minibuffer, but it can modify buffer contents.
The variable is reset to `nil' when you quit Isearch. As an
example of use, command `isearchp-replace-on-demand' with a
negative prefix arg sets this to `isearchp-replace-match', which
causes automatic replacement each time you visit a search hit.
* Hook `isearchp-nomodify-action-hook' (Emacs 22+ only) is also
run after each search visit. Its functions also must accept the
same arguments as `isearchp-act-on-demand'. The functions can
use the minibuffer, but they must not update the buffer text (in
a way noticeable by Isearch), or else that will likely lead to a
call-stack overflow. This is because they are called with
Isearch suspended during `isearch-update' (which can itself be
invoked by the action...).
* Option (`isearchp-regexp-quote-yank-flag') and command
(`isearchp-toggle-regexp-quote-yank', bound to `C-`') to toggle
quoting (escaping) of regexp special characters. With escaping
turned off, you can yank text such as `^\*.*' without it being
transformed to `\^\\\*\.\*'.
* `M-:' (`isearchp-eval-sexp-and-insert') prompts you for a Lisp
sexp, evaluates it, and appends the value to the search string.
This is useful, for example, to use `rx' or another
regexp-creation helper to create a regexp search pattern.
For example: `C-M-s M-: (rx (and line-start (1+ (in "("))))'
searches using the result of that `rx' sexp, which is "^(+".
(The double-quote chars are removed.)
Remember too that you can use `C-u M-:' after `M-e'. That
inserts the sexp value into the minibuffer, where you are
editing the search string. Use this when you do not want to
simply append the sexp value to the search string, but instead
you want to do some editing of it or the rest of the search
string.
* `M-g' (`isearchp-retrieve-last-quit-search') yanks the last
successful search string (regexp or plain) from when you last
hit `C-g' in Isearch. Sometimes you search for something but
abandon the search - you just want to check the locations of
something, without staying at any of them. Afterward, if you
want to find them again, use `M-g'. This yanks that search
string, so you can append it to whatever you are already
searching for.
* `C-x r g' (`isearchp-append-register') appends the contents of a
register to the search string. You are prompted for the
register to use. This is the same key that is bound globally to
`insert-register'. If you want this key to instead exit Isearch
and insert the register in the buffer, then define this key in
`isearch-mode-map' as `nil' (i.e., unbind it), and optionally
bind `isearchp-append-register' to a different key in
`isearch-mode-map'.
* `C-M-y' (`isearch-yank-secondary') yanks the secondary selection
into the search string, if you also use library `second-sel.el'.
* `C-y C-c' (`isearchp-yank-char') yanks successive characters
onto the search string.
* `C-_' (`isearchp-yank-symbol-or-char') yanks successive symbols
(or words or subwords or chars) into the search string.
* `C-(' (`isearchp-yank-sexp-symbol-or-char') yanks successive
sexps (or symbols or words or subwords or chars) into the search
string.
* `M-w' (`isearchp-kill-ring-save') copies the current search
string to the kill ring.
(I use this all the time, but you might not use multiple Emacs
sessions.) Note that if you did not have this feature then you
would need to select the search-string text (in the text buffer
or in the `M-e' Isearch edit buffer) and copy it to the kill
ring. (Note: `M-w' used to toggle word search, but
`isearch-toggle-word' is now `M-s w'.)
* Commands that yank buffer text onto the search string are bound
to keys with prefix `C-y'. (Some also have additional Isearch
bindings).
`C-y C-_' isearchp-yank-symbol-or-char
`C-y C-(' isearchp-yank-sexp-symbol-or-char
`C-y C-2' isearch-yank-secondary
`C-y C-c' isearchp-yank-char
`C-y C-e' isearchp-yank-line
`C-y C-w' isearchp-yank-word-or-char
`C-y C-y' isearch-yank-kill
`C-y M-y' isearch-yank-pop
`C-y C-M-c' isearchp-yank-through-rec-edit-move
`C-y C-M-k' isearchp-yank-through-key-move
`C-y C-M-m' isearchp-yank-through-new-match (aka `M-RET`)
`C-y C-M-z' isearch-yank-until-char
You can repeat any of these for which it makes sense (i.e., all
except `isearch-yank-secondary', `isearch-yank-kill', and
`isearch-yank-pop') by just repeating the last key. For
example: `C-y C-e C-e C-e' adds the text up to the end of three
lines.
* `C-x 8 RET' (`isearch-char-by-name') reads the name of a Unicode
character with completion and appends it to the search string.
Same thing when editing the search string (i.e., after `M-e').
This is part of GNU Emacs starting with Emacs 24.4.
* `C-x o' (`isearchp-open-recursive-edit') opens a recursive
editing session, where you can do anything you like (including
search for something different). Using `C-M-c' closes the
recursive editing session and resumes the search (from the
current position where you hit `C-M-c').
* Option `isearchp-resume-with-last-when-empty-flag' non-`nil'
(the default) means that if Isearch is resumed with an empty
search string, after being suspended, the previous search string
is used. If `nil', it is resumed with an empty search string,
as if starting over from the resumed location.
* `C-g' after successfully finding matches restores not only the
original position but also its relative position in the window.
IOW, you get back to what you saw before searching. Fixes Emacs
bug #12253 for Isearch.
* Highlighting of the mismatched portion of your search string in
the minibuffer. This is the portion that is removed if you do
`C-g', or removed/replaced manually if you use `C-M-l' (see
next) or automatically if you use `M-k' (see below). I added
this feature to GNU Emacs 23.1.
* `C-M-l' (`isearchp-remove-failed-part') removes the failed part
of the search string, if any. `C-g' does this as well, but
`C-g' also has an effect when search is successful.
* `C-' (`isearchp-remove-failed-part-or-last-char')
also removes the failed part, if any. If there is none then it
removes the last character. You might prefer to bind this to
`DEL' (Backspace), in place of `isearch-delete-char'.
* `M-k' (`isearchp-cycle-mismatch-removal') cycles automatic
removal or replacement of the input portion that does not match.
The behavior is controlled by the value of option
`isearchp-drop-mismatch':
`replace-last' - Your current input replaces the last mismatched
text. You can always see your last input, even
if it is a mismatch. And it is available for
editing using `M-e'.
`nil' - Your current input is appended, even if the
previous input has a mismatched portion.
anything else - Your current input is ignored (removed) if it
causes a mismatch. The search string always
has successful matches.
* Option `isearchp-drop-mismatch-regexp-flag' controls whether
regexp search respects option `isearchp-drop-mismatch'. If
`nil' (the default value) then regexp search acts as if
`isearchp-drop-mismatch' were `nil'. This is because typing a
regexp such as `[a-w]' can be problematic when mismatches are
automatically replaced. There is no problem for many regexp
patterns however, so you might prefer customizing this to
non-`nil' and using `M-k' to turn `isearchp-drop-mismatch' off
only temporarily, when needed.
* Non-nil option `isearchp-repeat-search-if-fail-flag' means that
Isearch fails only when there are no search hits within the
search limits. If there are search hits, and if there are no
more hits in the current search direction, then search restarts
automatically at the limit. You can toggle this behavior using
`M-s M-k' anytime during Isearch.
* You can use option `isearchp-ring-bell-function' to suppress or
replace bell ringing (`ding') during Isearch (but not for
quitting with `C-g'). Set it to `ignore', for example, to
suppress any indication of an error. Set it to a function such
as `echo-bell' (from library `echo-bell.el'), to indicate errors
only visually.
* Non-`nil' option `isearchp-toggle-option-flag', which you can
toggle using `M-s v' (`isearchp-toggle-option-toggle'),
determines whether commands that toggle behavior also toggle an
associated user option. For such commands, a prefix argument
flips the behavior, as if `isearchp-toggle-option-flag' were
toggled temporarily. Currently this feature applies to toggles
`M-c' (case-sensitivity) and `M-s i' (matching hidden text).
* `M-c' (`isearch-toggle-case-fold') toggles case sensitivity. If
option `isearchp-toggle-option-flag' is non-`nil' then it
toggles option `isearchp-case-fold' to change the sensitivity
from now on. Otherwise, the option value is not changed, so the
effect is for the current search only.
* `M-s i' (`isearch-toggle-invisible') toggles invisible-text
sensitivity. If option `isearchp-toggle-option-flag' is
non-`nil' then it toggles option `search-invisible' to change
the sensitivity from now on. Otherwise, the option value is not
changed, so the effect is for the current search only.
* `C-+' (`isearchp-toggle-search-invisible') toggles the value of
option `search-invisible'. The effect is like that of `M-s i'
with no prefix argument and with non-`nil'
`isearchp-toggle-option-flag'.
* `M-s h L' (`isearchp-toggle-lazy-highlighting') toggles the
value of option `isearch-lazy-highlight'. Turning this
highlighting off can sometimes speed up searching considerably,
in particular for symmetric character folding.
* `M-s h l' (`isearchp-toggle-lazy-highlight-cleanup') toggles the
value of option `lazy-highlight-cleanup'. When the value is
`nil' you can continue to see the search hits highlighted from
the last search. Toggle the option off, or use command
`lazy-highlight-cleanup', to remove the highlighting.
When `M-s h l' turns cleanup on it also sets option
`lazy-highlight-buffer' to nil, turning off full-buffer
highlighting.
* `M-s h b' (`isearchp-toggle-lazy-highlight-full-buffer') toggles
the value of option `lazy-highlight-buffer'. When the value is
`t' Isearch lazy-highlights the entire buffer. The default
value of `nil' means it lazy-highlights only the buffer parts
currently shown (but previously highlighted parts remain
highlighted). (Emacs 24.3+)
`M-s h b' also toggles option `lazy-highlight-cleanup', in the
other direction. This is because in most cases where you want
to lazy-highlight the whole buffer you also want to keep that
highlighting. You need Emacs 24.3+ to take advantage of
`lazy-highlight-buffer'.
* `M-s #' (`isearchp-toggle-showing-match-number') toggles showing
the current match number and total matches in the Isearch prompt
(option `isearch-lazy-count'). (Emacs 24.3+)
* `M-s %' (`isearchp-toggle-limit-match-numbers-to-region')
toggles whether match number are limited to the active region
when option `isearchp-restrict-to-region-flag' is non-nil.
(Emacs 24.3+)
* There are almost 30 Isearch toggle commands, depending on
whether you use optional libraries such as `isearch-prop.el',
`zones.el', and `highlight.el'. Each toggle is bound to a short
key. In addition, they are all on prefix key `M-=', by default.
They are on prefix keymap `isearchp-toggles-map' which you can
bind to any key in `isearch-mode-map'. If you forget a `M-='
toggle key, you can use `M-= C-h' while searching to show them
all.
* Other bindings during Isearch:
- `next', `prior' repeat the last Isearch forward and backward
(easier than using the chords `C-s', `C-r').
- `C-end' - go to the longest line. Repeat to go to the longest
line following that one in the buffer. As usual, `C-g' puts
you back where you started. This binding is made only if you
also use `misc-cmds.el'.
- `C-h' provides help on Isearch while searching. This library
also redefines `isearch-mode-help' so that it lists all
Isearch bindings and ends Isearch properly.
* `M-e' (`isearch-edit-string') automatically puts the cursor at
the first mismatch position in the search string, for easy
editing. Whereas `C-g' (see also `M-k') removes all of the
mismatch, this feature lets you change or insert a character or
two, without losing the rest of the search string.
* A user option, `isearchp-initiate-edit-commands', that specifies
commands whose keys will not exit Isearch but will instead
initiate editing of the search string. For example, if
`backward-char' is included in the list then `C-b' and `left'
will just move the cursor backward over the search string so you
can change, delete, or insert chars in the middle somewhere.
This makes the search string more minibuffer-like.
* If you also use library `highlight.el' then you can highlight
and unhighlight Isearch matches in different faces, including
for multiple-buffer searches. The simplest way to do this is to
use `M-s h f' (to highlight) and `M-s u f' (to unhighlight)
while searching.
* If you also use library `zones.el' then you can replace (`M-s z
s') or update (`M-s z a') the current list of zones from the
boundaries of lazy-highlighted text, or you can create a
noncontiguous region from that text (`M-s z r').
* You can, by default, select text with the mouse, then hit `C-s'
etc. to search for it. This is controlled by user option
`isearchp-mouse-2-flag'.
* If you also use library `character-fold+.el' then you can use
`M-s =' (command `isearchp-toggle-symmetric-char-fold') to
toggle whether character folding is symmetric. Note that lazy
highlighting can slow down symmetric char folding considerably,
so you might also want to use `M-s h L' to turn off such
highlighting.
This feature is not available now, since vanilla Emacs changed
the way vanilla file `character-fold.el' works.
If you have Emacs 23 or later then I recommend that you also use
the companion library, `isearch-prop.el'. If it is in your
`load-path' then it will be loaded by `isearch+.el'. It lets you
limit incremental searching to contexts that you define.
Example: search within zones having a `face' text property with a
value of `font-lock-comment-face' or `font-lock-string-face'.
Search overlays or text properties.
Besides relying on existing text properties such as `face' for
contexts to search, you can use command
`isearchp-put-prop-on-region' to add any text property to the
region. This gives you an easy way to set up contexts for
text-property search. For property `face', empty input to
`isearchp-put-prop-on-region' removes all faces from the region.