1 ;;; isearch.el --- incremental search minor mode -*- lexical-binding: t -*-
3 ;; Copyright (C) 1992-1997, 1999-2017 Free Software Foundation, Inc.
5 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
6 ;; Maintainer: emacs-devel@gnu.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
30 ;; isearch-mode behaves modally and does not return until the search
31 ;; is completed. It uses a recursive-edit to behave this way.
33 ;; The key bindings active within isearch-mode are defined below in
34 ;; `isearch-mode-map'. Also see minibuffer-local-isearch-map
35 ;; for bindings active during `isearch-edit-string'.
37 ;; isearch-mode should work even if you switch windows with the mouse,
38 ;; in which case isearch-mode is terminated automatically before the
41 ;; The search ring and completion commands automatically put you in
42 ;; the minibuffer to edit the string. This gives you a chance to
43 ;; modify the search string before executing the search. There are
44 ;; three commands to terminate the editing: C-s and C-r exit the
45 ;; minibuffer and search forward and reverse respectively, while C-m
46 ;; exits and searches in the last search direction.
48 ;; Exiting immediately from isearch uses isearch-edit-string instead
49 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
50 ;; The name of this option should probably be changed if we decide to
51 ;; keep the behavior. No point in forcing nonincremental search until
52 ;; the last possible moment.
56 (eval-when-compile (require 'cl-lib
))
58 ;; Some additional options and constants.
61 "Incremental search minor mode."
62 :link
'(emacs-commentary-link "isearch")
63 :link
'(custom-manual "(emacs)Incremental Search")
69 (defcustom search-exit-option t
70 "Non-nil means random control characters terminate incremental search."
73 (defcustom search-slow-window-lines
1
74 "Number of lines in slow search display windows.
75 These are the short windows used during incremental search on slow terminals.
76 Negative means put the slow search window at the top (normally it's at bottom)
77 and the value is minus the number of lines."
80 (defcustom search-slow-speed
1200
81 "Highest terminal speed at which to use \"slow\" style incremental search.
82 This is the style where a one-line window is created to show the line
83 that the search has reached."
86 (defcustom search-upper-case
'not-yanks
87 "If non-nil, upper case chars disable case fold searching.
88 That is, upper and lower case chars must match exactly.
89 This applies no matter where the chars come from, but does not
90 apply to chars in regexps that are prefixed with `\\'.
91 If this value is `not-yanks', text yanked into the search string
92 in Isearch mode is always downcased."
93 :type
'(choice (const :tag
"off" nil
)
97 (defcustom search-nonincremental-instead t
98 "If non-nil, do a nonincremental search instead of exiting immediately.
99 This affects the behavior of `isearch-exit' and any key bound to that
100 command: if this variable is nil, `isearch-exit' always exits the search;
101 if the value is non-nil, and the search string is empty, `isearch-exit'
102 starts a nonincremental search instead. (Actually, `isearch-edit-string'
103 is called to let you enter the search string, and RET terminates editing
104 and does a nonincremental search.)"
107 (defcustom search-whitespace-regexp
(purecopy "\\s-+")
108 "If non-nil, regular expression to match a sequence of whitespace chars.
109 When you enter a space or spaces in the incremental search, it
110 will match any sequence matched by this regexp. As an exception,
111 spaces are treated normally in regexp incremental search if they
112 occur in a regexp construct like [...] or *, + or ?.
114 If the value is a string, it applies to both ordinary and
115 regexp incremental search. If the value is nil, or
116 `isearch-lax-whitespace' is nil for ordinary incremental search, or
117 `isearch-regexp-lax-whitespace' is nil for regexp incremental search,
118 then each space you type matches literally, against one space.
120 You might want to use something like \"[ \\t\\r\\n]+\" instead.
121 In the Customization buffer, that is `[' followed by a space,
122 a tab, a carriage return (control-M), a newline, and `]+'."
123 :type
'(choice (const :tag
"Match Spaces Literally" nil
)
127 (defcustom search-invisible
'open
128 "If t incremental search/query-replace can match hidden text.
129 A nil value means don't match invisible text.
130 When the value is `open', if the text matched is made invisible by
131 an overlay having an `invisible' property and that overlay has a property
132 `isearch-open-invisible', then incremental search will show the contents.
133 \(This applies when using `outline.el' and `hideshow.el'.)
135 To temporarily change the value for an active incremental search,
136 use \\<isearch-mode-map>\\[isearch-toggle-invisible].
138 See also the related option `isearch-hide-immediately'.
140 See also `reveal-mode' if you want overlays to automatically be opened
141 whenever point is in one of them."
142 :type
'(choice (const :tag
"Match hidden text" t
)
143 (const :tag
"Open overlays" open
)
144 (const :tag
"Don't match hidden text" nil
)))
146 (defcustom isearch-hide-immediately t
147 "If non-nil, re-hide an invisible match right away.
148 This variable makes a difference when `search-invisible' is set to `open'.
149 If non-nil, invisible matches are re-hidden as soon as the match moves
150 off the invisible text surrounding the match.
151 If nil then do not re-hide opened invisible text when the match moves.
152 Whatever the value, all opened invisible text is hidden again after exiting
153 the search, with the exception of the last successful match, if any."
156 (defcustom isearch-resume-in-command-history nil
157 "If non-nil, `isearch-resume' commands are added to the command history.
158 This allows you to resume earlier Isearch sessions through the
162 (defvar isearch-mode-hook nil
163 "Function(s) to call after starting up an incremental search.")
165 (defvar isearch-update-post-hook nil
166 "Function(s) to call after isearch has found matches in the buffer.")
168 (defvar isearch-mode-end-hook nil
169 "Function(s) to call after terminating an incremental search.
170 When these functions are called, `isearch-mode-end-hook-quit'
171 is non-nil if the user quits the search.")
173 (defvar isearch-mode-end-hook-quit nil
174 "Non-nil while running `isearch-mode-end-hook' if the user quits the search.")
176 (defvar isearch-message-function nil
177 "Function to call to display the search prompt.
178 If nil, use function `isearch-message'.")
180 (defvar isearch-wrap-function nil
181 "Function to call to wrap the search when search is failed.
182 If nil, move point to the beginning of the buffer for a forward search,
183 or to the end of the buffer for a backward search.")
185 (defvar isearch-push-state-function nil
186 "Function to save a function restoring the mode-specific Isearch state
187 to the search status stack.")
189 (defvar isearch-filter-predicate
#'isearch-filter-visible
190 "Predicate that filters the search hits that would normally be available.
191 Search hits that dissatisfy the predicate are skipped. The function
192 has two arguments: the positions of start and end of text matched by
193 the search. If this function returns nil, continue searching without
194 stopping at this match.
195 If you use `add-function' to modify this variable, you can use the
196 `isearch-message-prefix' advice property to specify the prefix string
197 displayed in the search message.")
201 (defvar search-ring nil
202 "List of search string sequences.")
203 (defvar regexp-search-ring nil
204 "List of regular expression search string sequences.")
206 (defcustom search-ring-max
16
207 "Maximum length of search ring before oldest elements are thrown away."
209 (defcustom regexp-search-ring-max
16
210 "Maximum length of regexp search ring before oldest elements are thrown away."
213 (defvar search-ring-yank-pointer nil
214 "Index in `search-ring' of last string reused.
215 It is nil if none yet.")
216 (defvar regexp-search-ring-yank-pointer nil
217 "Index in `regexp-search-ring' of last string reused.
218 It is nil if none yet.")
220 (defcustom search-ring-update nil
221 "Non-nil if advancing or retreating in the search ring should cause search.
222 Default value, nil, means edit the string instead."
225 (autoload 'char-fold-to-regexp
"char-fold")
227 (defcustom search-default-mode nil
228 "Default mode to use when starting isearch.
229 Value is nil, t, or a function.
231 If nil, default to literal searches (note that `case-fold-search'
232 and `isearch-lax-whitespace' may still be applied).\\<isearch-mode-map>
233 If t, default to regexp searches (as if typing `\\[isearch-toggle-regexp]' during
236 If a function, use that function as an `isearch-regexp-function'.
237 Example functions (and the keys to toggle them during isearch)
238 are `word-search-regexp' \(`\\[isearch-toggle-word]'), `isearch-symbol-regexp'
239 \(`\\[isearch-toggle-symbol]'), and `char-fold-to-regexp' \(`\\[isearch-toggle-char-fold]')."
240 ;; :type is set below by `isearch-define-mode-toggle'.
241 :type
'(choice (const :tag
"Literal search" nil
)
242 (const :tag
"Regexp search" t
)
243 (function :tag
"Other"))
246 ;;; isearch highlight customization.
248 (defcustom search-highlight t
249 "Non-nil means incremental search highlights the current match."
253 '((((class color
) (min-colors 88) (background light
))
254 ;; The background must not be too dark, for that means
255 ;; the character is hard to see when the cursor is there.
256 (:background
"magenta3" :foreground
"lightskyblue1"))
257 (((class color
) (min-colors 88) (background dark
))
258 (:background
"palevioletred2" :foreground
"brown4"))
259 (((class color
) (min-colors 16))
260 (:background
"magenta4" :foreground
"cyan1"))
261 (((class color
) (min-colors 8))
262 (:background
"magenta4" :foreground
"cyan1"))
263 (t (:inverse-video t
)))
264 "Face for highlighting Isearch matches."
267 (defvar isearch-face
'isearch
)
269 (defface isearch-fail
270 '((((class color
) (min-colors 88) (background light
))
271 (:background
"RosyBrown1"))
272 (((class color
) (min-colors 88) (background dark
))
273 (:background
"red4"))
274 (((class color
) (min-colors 16))
276 (((class color
) (min-colors 8))
278 (((class color grayscale
))
280 (t (:inverse-video t
)))
281 "Face for highlighting failed part in Isearch echo-area message."
284 (defcustom isearch-lazy-highlight t
285 "Controls the lazy-highlighting during incremental search.
286 When non-nil, all text in the buffer matching the current search
287 string is highlighted lazily (see `lazy-highlight-initial-delay'
288 and `lazy-highlight-interval')."
290 :group
'lazy-highlight
293 ;;; Lazy highlight customization.
295 (defgroup lazy-highlight nil
296 "Lazy highlighting feature for matching strings."
297 :prefix
"lazy-highlight-"
302 (define-obsolete-variable-alias 'isearch-lazy-highlight-cleanup
303 'lazy-highlight-cleanup
306 (defcustom lazy-highlight-cleanup t
307 "Controls whether to remove extra highlighting after a search.
308 If this is nil, extra highlighting can be \"manually\" removed with
309 \\[lazy-highlight-cleanup]."
311 :group
'lazy-highlight
)
313 (define-obsolete-variable-alias 'isearch-lazy-highlight-initial-delay
314 'lazy-highlight-initial-delay
317 (defcustom lazy-highlight-initial-delay
0.25
318 "Seconds to wait before beginning to lazily highlight all matches."
320 :group
'lazy-highlight
)
322 (define-obsolete-variable-alias 'isearch-lazy-highlight-interval
323 'lazy-highlight-interval
326 (defcustom lazy-highlight-interval
0 ; 0.0625
327 "Seconds between lazily highlighting successive matches."
329 :group
'lazy-highlight
)
331 (define-obsolete-variable-alias 'isearch-lazy-highlight-max-at-a-time
332 'lazy-highlight-max-at-a-time
335 (defcustom lazy-highlight-max-at-a-time
20
336 "Maximum matches to highlight at a time (for `lazy-highlight').
337 Larger values may reduce Isearch's responsiveness to user input;
338 smaller values make matches highlight slowly.
339 A value of nil means highlight all matches."
340 :type
'(choice (const :tag
"All" nil
)
341 (integer :tag
"Some"))
342 :group
'lazy-highlight
)
344 (defface lazy-highlight
345 '((((class color
) (min-colors 88) (background light
))
346 (:background
"paleturquoise"))
347 (((class color
) (min-colors 88) (background dark
))
348 (:background
"paleturquoise4"))
349 (((class color
) (min-colors 16))
350 (:background
"turquoise3"))
351 (((class color
) (min-colors 8))
352 (:background
"turquoise3"))
354 "Face for lazy highlighting of matches other than the current one."
355 :group
'lazy-highlight
359 ;; Define isearch help map.
361 (defvar isearch-help-map
362 (let ((map (make-sparse-keymap)))
363 (define-key map
(char-to-string help-char
) 'isearch-help-for-help
)
364 (define-key map
[help] 'isearch-help-for-help)
365 (define-key map [f1] 'isearch-help-for-help)
366 (define-key map "?" 'isearch-help-for-help)
367 (define-key map "b" 'isearch-describe-bindings)
368 (define-key map "k" 'isearch-describe-key)
369 (define-key map "m" 'isearch-describe-mode)
370 (define-key map "q" 'help-quit)
372 "Keymap for characters following the Help key for Isearch mode.")
374 (eval-when-compile (require 'help-macro))
376 (make-help-screen isearch-help-for-help-internal
377 (purecopy "Type a help option: [bkm] or ?")
378 "You have typed %THIS-KEY%, the help character. Type a Help option:
379 \(Type \\<help-map>\\[help-quit] to exit the Help command.)
381 b Display all Isearch key bindings.
382 k KEYS Display full documentation of Isearch key sequence.
383 m Display documentation of Isearch mode.
385 You can't type here other help keys available in the global help map,
386 but outside of this help window when you type them in Isearch mode,
387 they exit Isearch mode before displaying global help."
390 (defvar isearch--display-help-action '(nil (inhibit-same-window . t)))
392 (defun isearch-help-for-help ()
393 "Display Isearch help menu."
395 (let ((display-buffer-overriding-action isearch--display-help-action))
396 (isearch-help-for-help-internal))
399 (defun isearch-describe-bindings ()
400 "Show a list of all keys defined in Isearch mode, and their definitions.
401 This is like `describe-bindings', but displays only Isearch keys."
403 (let ((display-buffer-overriding-action isearch--display-help-action))
404 (with-help-window "*Help*"
405 (with-current-buffer standard-output
406 (princ "Isearch Mode Bindings:\n")
407 (princ (substitute-command-keys "\\{isearch-mode-map}"))))))
409 (defun isearch-describe-key ()
410 "Display documentation of the function invoked by isearch key."
412 (let ((display-buffer-overriding-action isearch--display-help-action))
413 (call-interactively 'describe-key))
416 (defun isearch-describe-mode ()
417 "Display documentation of Isearch mode."
419 (let ((display-buffer-overriding-action isearch--display-help-action))
420 (describe-function 'isearch-forward))
423 (defalias 'isearch-mode-help 'isearch-describe-mode)
426 ;; Define isearch-mode keymap.
428 (defvar isearch-mode-map
431 (or (char-table-p (nth 1 map))
432 (error "The initialization of isearch-mode-map must be updated"))
433 ;; Make all multibyte characters search for themselves.
434 (set-char-table-range (nth 1 map) (cons #x100 (max-char))
435 'isearch-printing-char)
437 ;; Single-byte printing chars extend the search string by default.
440 (define-key map (vector i) 'isearch-printing-char)
443 ;; To handle local bindings with meta char prefix keys, define
444 ;; another full keymap. This must be done for any other prefix
445 ;; keys as well, one full keymap per char of the prefix key. It
446 ;; would be simpler to disable the global keymap, and/or have a
447 ;; default local key binding for any key not otherwise bound.
448 (let ((meta-map (make-sparse-keymap)))
449 (define-key map (char-to-string meta-prefix-char) meta-map))
451 ;; Several non-printing chars change the searching behavior.
452 (define-key map "\C-s" 'isearch-repeat-forward)
453 (define-key map "\C-r" 'isearch-repeat-backward)
454 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
455 ;; combinations can be used to repeat regexp isearches that can
456 ;; be used to start these searches.
457 (define-key map "\M-\C-s" 'isearch-repeat-forward)
458 (define-key map "\M-\C-r" 'isearch-repeat-backward)
459 (define-key map "\177" 'isearch-delete-char)
460 (define-key map [backspace] 'undefined) ;bug#20466.
461 (define-key map "\C-g" 'isearch-abort)
463 ;; This assumes \e is the meta-prefix-char.
464 (or (= ?\e meta-prefix-char)
465 (error "Inconsistency in isearch.el"))
466 (define-key map "\e\e\e" 'isearch-cancel)
468 (define-key map "\C-q" 'isearch-quote-char)
470 (define-key map "\r" 'isearch-exit)
471 (define-key map [return] 'isearch-exit)
472 (define-key map "\C-j" 'isearch-printing-char)
473 (define-key map "\t" 'isearch-printing-char)
474 (define-key map [?\S-\ ] 'isearch-printing-char)
476 (define-key map "\C-w" 'isearch-yank-word-or-char)
477 (define-key map "\M-\C-w" 'isearch-del-char)
478 (define-key map "\M-\C-y" 'isearch-yank-char)
479 (define-key map "\C-y" 'isearch-yank-kill)
480 (define-key map "\M-s\C-e" 'isearch-yank-line)
482 (define-key map (char-to-string help-char) isearch-help-map)
483 (define-key map [help] isearch-help-map
)
484 (define-key map
[f1] isearch-help-map)
486 (define-key map "\M-n" 'isearch-ring-advance)
487 (define-key map "\M-p" 'isearch-ring-retreat)
488 (define-key map "\M-y" 'isearch-yank-pop)
490 (define-key map "\M-\t" 'isearch-complete)
492 ;; Pass frame events transparently so they won't exit the search.
493 ;; In particular, if we have more than one display open, then a
494 ;; switch-frame might be generated by someone typing at another keyboard.
495 (define-key map [switch-frame] nil)
496 (define-key map [delete-frame] nil)
497 (define-key map [iconify-frame] nil)
498 (define-key map [make-frame-visible] nil)
499 (define-key map [mouse-movement] nil)
500 (define-key map [language-change] nil)
502 ;; For searching multilingual text.
503 (define-key map "\C-\\" 'isearch-toggle-input-method)
504 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
506 ;; People expect to be able to paste with the mouse.
507 (define-key map [mouse-2] #'isearch-mouse-2)
508 (define-key map [down-mouse-2] nil)
509 (define-key map [xterm-paste] #'isearch-xterm-paste)
511 ;; Some bindings you may want to put in your isearch-mode-hook.
512 ;; Suggest some alternates...
513 (define-key map "\M-c" 'isearch-toggle-case-fold)
514 (define-key map "\M-r" 'isearch-toggle-regexp)
515 (define-key map "\M-e" 'isearch-edit-string)
517 (put 'isearch-edit-string :advertised-binding "\M-se")
519 (define-key map "\M-se" 'isearch-edit-string)
520 ;; More toggles defined by `isearch-define-mode-toggle'.
522 (define-key map [?\M-%] 'isearch-query-replace)
523 (define-key map [?\C-\M-%] 'isearch-query-replace-regexp)
524 (define-key map "\M-so" 'isearch-occur)
525 (define-key map "\M-shr" 'isearch-highlight-regexp)
527 ;; The key translations defined in the C-x 8 prefix should add
528 ;; characters to the search string. See iso-transl.el.
529 (define-key map "\C-x8\r" 'isearch-char-by-name)
532 "Keymap for `isearch-mode'.")
534 (defvar minibuffer-local-isearch-map
535 (let ((map (make-sparse-keymap)))
536 (set-keymap-parent map minibuffer-local-map)
537 (define-key map "\r" 'exit-minibuffer)
538 (define-key map "\M-\t" 'isearch-complete-edit)
539 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
540 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
541 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
542 (define-key map [right] 'isearch-yank-char-in-minibuffer)
544 "Keymap for editing Isearch strings in the minibuffer.")
546 ;; Internal variables declared globally for byte-compiler.
547 ;; These are all set with setq while isearching
548 ;; and bound locally while editing the search string.
550 (defvar isearch-forward nil) ; Searching in the forward direction.
551 (defvar isearch-regexp nil) ; Searching for a regexp.
552 (defvar isearch-regexp-function nil
553 "Regexp-based search mode for words/symbols.
554 If the value is a function (e.g. `isearch-symbol-regexp'), it is
555 called to convert a plain search string to a regexp used by
556 regexp search functions.
557 The symbol property `isearch-message-prefix' put on this function
558 specifies the prefix string displayed in the search message.
560 This variable is set and changed during isearch. To change the
561 default behavior used for searches, see `search-default-mode'
563 ;; We still support setting this to t for backwards compatibility.
564 (define-obsolete-variable-alias 'isearch-word
565 'isearch-regexp-function "25.1")
567 (defvar isearch-lax-whitespace t
568 "If non-nil, a space will match a sequence of whitespace chars.
569 When you enter a space or spaces in ordinary incremental search, it
570 will match any sequence matched by the regexp defined by the variable
571 `search-whitespace-regexp'. If the value is nil, each space you type
572 matches literally, against one space. You can toggle the value of this
573 variable by the command `isearch-toggle-lax-whitespace'.")
575 (defvar isearch-regexp-lax-whitespace nil
576 "If non-nil, a space will match a sequence of whitespace chars.
577 When you enter a space or spaces in regexp incremental search, it
578 will match any sequence matched by the regexp defined by the variable
579 `search-whitespace-regexp'. If the value is nil, each space you type
580 matches literally, against one space. You can toggle the value of this
581 variable by the command `isearch-toggle-lax-whitespace'.")
583 (defvar isearch-cmds nil
584 "Stack of search status elements.
585 Each element is an `isearch--state' struct where the slots are
586 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
587 ERROR WRAPPED BARRIER CASE-FOLD-SEARCH]")
589 (defvar isearch-string "") ; The current search string.
590 (defvar isearch-message "") ; text-char-description version of isearch-string
592 (defvar isearch-message-prefix-add nil) ; Additional text for the message prefix
593 (defvar isearch-message-suffix-add nil) ; Additional text for the message suffix
595 (defvar isearch-success t) ; Searching is currently successful.
596 (defvar isearch-error nil) ; Error message for failed search.
597 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
598 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
599 (defvar isearch-barrier 0
600 "Recorded minimum/maximal point for the current search.")
601 (defvar isearch-just-started nil)
602 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
604 ;; case-fold-search while searching.
605 ;; either nil, t, or 'yes. 'yes means the same as t except that mixed
606 ;; case in the search string is ignored.
607 (defvar isearch-case-fold-search nil)
609 ;; search-invisible while searching.
610 ;; either nil, t, or 'open. 'open means the same as t except that
611 ;; opens hidden overlays.
612 (defvar isearch-invisible search-invisible)
614 (defvar isearch-last-case-fold-search nil)
616 ;; Used to save default value while isearch is active
617 (defvar isearch-original-minibuffer-message-timeout nil)
619 (defvar isearch-adjusted nil)
620 (defvar isearch-slow-terminal-mode nil)
621 ;; If t, using a small window.
622 (defvar isearch-small-window nil)
623 (defvar isearch-opoint 0)
624 ;; The window configuration active at the beginning of the search.
625 (defvar isearch-window-configuration nil)
627 ;; Flag to indicate a yank occurred, so don't move the cursor.
628 (defvar isearch-yank-flag nil)
630 ;; A function to be called after each input character is processed.
631 ;; (It is not called after characters that exit the search.)
632 ;; It is only set from an optional argument to `isearch-mode'.
633 (defvar isearch-op-fun nil)
635 ;; Is isearch-mode in a recursive edit for modal searching.
636 (defvar isearch-recursive-edit nil)
638 ;; Should isearch be terminated after doing one search?
639 (defvar isearch-nonincremental nil)
641 ;; New value of isearch-forward after isearch-edit-string.
642 (defvar isearch-new-forward nil)
644 ;; Accumulate here the overlays opened during searching.
645 (defvar isearch-opened-overlays nil)
647 ;; Non-nil if the string exists but is invisible.
648 (defvar isearch-hidden nil)
650 ;; The value of input-method-function when isearch is invoked.
651 (defvar isearch-input-method-function nil)
653 ;; A flag to tell if input-method-function is locally bound when
654 ;; isearch is invoked.
655 (defvar isearch-input-method-local-p nil)
657 (defvar isearch--saved-overriding-local-map nil)
659 ;; Minor-mode-alist changes - kind of redundant with the
660 ;; echo area, but if isearching in multiple windows, it can be useful.
662 (or (assq 'isearch-mode minor-mode-alist)
663 (nconc minor-mode-alist
664 (list '(isearch-mode isearch-mode))))
666 (defvar-local isearch-mode nil) ;; Name of the minor mode, if non-nil.
668 (define-key global-map "\C-s" 'isearch-forward)
669 (define-key esc-map "\C-s" 'isearch-forward-regexp)
670 (define-key global-map "\C-r" 'isearch-backward)
671 (define-key esc-map "\C-r" 'isearch-backward-regexp)
672 (define-key search-map "w" 'isearch-forward-word)
673 (define-key search-map "_" 'isearch-forward-symbol)
674 (define-key search-map "." 'isearch-forward-symbol-at-point)
676 ;; Entry points to isearch-mode.
678 (defun isearch-forward (&optional regexp-p no-recursive-edit)
680 Do incremental search forward.
681 With a prefix argument, do an incremental regular expression search instead.
683 As you type characters, they add to the search string and are found.
684 The following non-printing keys are bound in `isearch-mode-map'.
686 Type \\[isearch-delete-char] to cancel last input item from end of search string.
687 Type \\[isearch-exit] to exit, leaving point at location found.
688 Type LFD (C-j) to match end of line.
689 Type \\[isearch-repeat-forward] to search again forward,\
690 \\[isearch-repeat-backward] to search again backward.
691 Type \\[isearch-yank-word-or-char] to yank next word or character in buffer
692 onto the end of the search string, and search for it.
693 Type \\[isearch-del-char] to delete character from end of search string.
694 Type \\[isearch-yank-char] to yank char from buffer onto end of search\
695 string and search for it.
696 Type \\[isearch-yank-line] to yank rest of line onto end of search string\
698 Type \\[isearch-yank-kill] to yank the last string of killed text.
699 Type \\[isearch-yank-pop] to replace string just yanked into search prompt
700 with string killed before it.
701 Type \\[isearch-quote-char] to quote control character to search for it.
702 Type \\[isearch-char-by-name] to add a character to search by Unicode name,\
704 \\[isearch-abort] while searching or when search has failed cancels input\
706 been found successfully.
707 \\[isearch-abort] when search is successful aborts and moves point to\
710 If you try to exit with the search string still empty, it invokes
711 nonincremental search.
713 Type \\[isearch-toggle-case-fold] to toggle search case-sensitivity.
714 Type \\[isearch-toggle-invisible] to toggle search in invisible text.
715 Type \\[isearch-toggle-regexp] to toggle regular-expression mode.
716 Type \\[isearch-toggle-word] to toggle word mode.
717 Type \\[isearch-toggle-symbol] to toggle symbol mode.
718 Type \\[isearch-toggle-char-fold] to toggle character folding.
720 Type \\[isearch-toggle-lax-whitespace] to toggle whitespace matching.
721 In incremental searches, a space or spaces normally matches any whitespace
722 defined by the variable `search-whitespace-regexp'; see also the variables
723 `isearch-lax-whitespace' and `isearch-regexp-lax-whitespace'.
725 Type \\[isearch-edit-string] to edit the search string in the minibuffer.
727 Also supported is a search ring of the previous 16 search strings.
728 Type \\[isearch-ring-advance] to search for the next item in the search ring.
729 Type \\[isearch-ring-retreat] to search for the previous item in the search\
731 Type \\[isearch-complete] to complete the search string using the search ring.
733 Type \\[isearch-query-replace] to run `query-replace' with string to\
734 replace from last search string.
735 Type \\[isearch-query-replace-regexp] to run `query-replace-regexp'\
736 with the last search string.
737 Type \\[isearch-occur] to run `occur' that shows\
738 the last search string.
739 Type \\[isearch-highlight-regexp] to run `highlight-regexp'\
740 that highlights the last search string.
742 Type \\[isearch-describe-bindings] to display all Isearch key bindings.
743 Type \\[isearch-describe-key] to display documentation of Isearch key.
744 Type \\[isearch-describe-mode] to display documentation of Isearch mode.
746 If an input method is turned on in the current buffer, that input
747 method is also active while you are typing characters to search.
748 To toggle the input method, type \\[isearch-toggle-input-method]. \
749 It also toggles the input
750 method in the current buffer.
752 To use a different input method for searching, type \
753 \\[isearch-toggle-specified-input-method],
754 and specify an input method you want to use.
756 The above keys, bound in `isearch-mode-map', are often controlled by
757 options; do \\[apropos] on search-.* to find them.
758 Other control and meta characters terminate the search
759 and are then executed normally (depending on `search-exit-option').
760 Likewise for function keys and mouse button events.
762 If this function is called non-interactively with a nil NO-RECURSIVE-EDIT,
763 it does not return to the calling function until the search is done.
764 See the function `isearch-mode' for more information."
767 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
769 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
770 "Do incremental search forward for regular expression.
771 With a prefix argument, do a regular string search instead.
772 Like ordinary incremental search except that your input is treated
773 as a regexp. See the command `isearch-forward' for more information.
775 In incremental searches, a space or spaces normally matches any
776 whitespace defined by the variable `search-whitespace-regexp'.
777 To search for a literal space and nothing else, enter C-q SPC.
778 To toggle whitespace matching, use `isearch-toggle-lax-whitespace'.
779 This command does not support character folding."
781 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
783 (defun isearch-forward-word (&optional not-word no-recursive-edit)
784 "Do incremental search forward for a sequence of words.
785 With a prefix argument, do a regular string search instead.
786 Like ordinary incremental search except that your input is treated
787 as a sequence of words without regard to how the words are separated.
788 See the command `isearch-forward' for more information.
789 This command does not support character folding, and lax space matching
790 has no effect on it."
792 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
794 (defun isearch-forward-symbol (&optional _not-symbol no-recursive-edit)
795 "Do incremental search forward for a symbol.
796 The prefix argument is currently unused.
797 Like ordinary incremental search except that your input is treated
798 as a symbol surrounded by symbol boundary constructs \\_< and \\_>.
799 See the command `isearch-forward' for more information.
800 This command does not support character folding, and lax space matching
801 has no effect on it."
803 (isearch-mode t nil nil (not no-recursive-edit) 'isearch-symbol-regexp))
805 (defun isearch-backward (&optional regexp-p no-recursive-edit)
806 "Do incremental search backward.
807 With a prefix argument, do a regular expression search instead.
808 See the command `isearch-forward' for more information."
810 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
812 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
813 "Do incremental search backward for regular expression.
814 With a prefix argument, do a regular string search instead.
815 Like ordinary incremental search except that your input is treated
816 as a regexp. See the command `isearch-forward-regexp' for more information."
818 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
820 (defun isearch-forward-symbol-at-point ()
821 "Do incremental search forward for a symbol found near point.
822 Like ordinary incremental search except that the symbol found at point
823 is added to the search string initially as a regexp surrounded
824 by symbol boundary constructs \\_< and \\_>.
825 See the command `isearch-forward-symbol' for more information."
827 (isearch-forward-symbol nil 1)
828 (let ((bounds (find-tag-default-bounds)))
831 (when (< (car bounds) (point))
832 (goto-char (car bounds)))
834 (buffer-substring-no-properties (car bounds) (cdr bounds))))
836 (setq isearch-error "No symbol at point")
841 ;; isearch-mode only sets up incremental search for the minor mode.
842 ;; All the work is done by the isearch-mode commands.
845 ;;(defvar isearch-commands '(isearch-forward isearch-backward
846 ;; isearch-forward-regexp isearch-backward-regexp)
847 ;; "List of commands for which isearch-mode does not recursive-edit.")
849 (defun isearch-mode (forward &optional regexp op-fun recursive-edit regexp-function)
850 "Start Isearch minor mode.
851 It is called by the function `isearch-forward' and other related functions.
853 The non-nil arg FORWARD means searching in the forward direction.
855 The non-nil arg REGEXP does an incremental regular expression search.
857 The arg OP-FUN is a function to be called after each input character
858 is processed. (It is not called after characters that exit the search.)
860 When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and
861 does not return to the calling function until the search is completed.
862 To behave this way it enters a recursive-edit and exits it when done
865 The arg REGEXP-FUNCTION, if non-nil, should be a function. It is
866 used to set the value of `isearch-regexp-function'."
868 ;; Initialize global vars.
869 (setq isearch-forward forward
870 isearch-regexp (or regexp
871 (and (not regexp-function)
872 (eq search-default-mode t)))
873 isearch-regexp-function (or regexp-function
874 (and (functionp search-default-mode)
876 search-default-mode))
877 isearch-op-fun op-fun
878 isearch-last-case-fold-search isearch-case-fold-search
879 isearch-case-fold-search case-fold-search
880 isearch-invisible search-invisible
886 isearch-barrier (point)
888 isearch-yank-flag nil
890 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
893 (abs search-slow-window-lines))))
894 isearch-other-end nil
895 isearch-small-window nil
896 isearch-just-started t
897 isearch-start-hscroll (window-hscroll)
899 isearch-opoint (point)
900 search-ring-yank-pointer nil
901 isearch-opened-overlays nil
902 isearch-input-method-function input-method-function
903 isearch-input-method-local-p (local-variable-p 'input-method-function)
904 regexp-search-ring-yank-pointer nil
906 ;; Save the original value of `minibuffer-message-timeout', and
907 ;; set it to nil so that isearch's messages don't get timed out.
908 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
909 minibuffer-message-timeout nil)
911 ;; We must bypass input method while reading key. When a user type
912 ;; printable character, appropriate input method is turned on in
913 ;; minibuffer to read multibyte characters.
914 (or isearch-input-method-local-p
915 (make-local-variable 'input-method-function))
916 (setq input-method-function nil)
919 (setq isearch-window-configuration
920 (if isearch-slow-terminal-mode (current-window-configuration) nil))
922 ;; Maybe make minibuffer frame visible and/or raise it.
923 (let ((frame (window-frame (minibuffer-window))))
924 (unless (memq (frame-live-p frame) '(nil t))
925 (unless (frame-visible-p frame)
926 (make-frame-visible frame))
927 (if minibuffer-auto-raise
928 (raise-frame frame))))
930 (setq isearch-mode " Isearch") ;; forward? regexp?
931 (force-mode-line-update)
933 (setq overriding-terminal-local-map isearch-mode-map)
934 (run-hooks 'isearch-mode-hook)
935 ;; Remember the initial map possibly modified
936 ;; by external packages in isearch-mode-hook. (Bug#16035)
937 (setq isearch--saved-overriding-local-map overriding-terminal-local-map)
939 ;; Pushing the initial state used to be before running isearch-mode-hook,
940 ;; but a hook might set `isearch-push-state-function' used in
941 ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994)
946 (add-hook 'pre-command-hook 'isearch-pre-command-hook)
947 (add-hook 'post-command-hook 'isearch-post-command-hook)
948 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
949 (add-hook 'kbd-macro-termination-hook 'isearch-done)
951 ;; isearch-mode can be made modal (in the sense of not returning to
952 ;; the calling function until searching is completed) by entering
953 ;; a recursive-edit and exiting it when done isearching.
955 (let ((isearch-recursive-edit t))
960 ;; Some high level utilities. Others below.
961 (defvar isearch--current-buffer nil)
963 (defun isearch-update ()
964 "This is called after every isearch command to update the display.
965 The second last thing it does is to run `isearch-update-post-hook'.
966 The last thing is to trigger a new round of lazy highlighting."
967 (unless (eq (current-buffer) isearch--current-buffer)
968 (when (buffer-live-p isearch--current-buffer)
969 (with-current-buffer isearch--current-buffer
970 (setq cursor-sensor-inhibit (delq 'isearch cursor-sensor-inhibit))))
971 (setq isearch--current-buffer (current-buffer))
972 (make-local-variable 'cursor-sensor-inhibit)
973 ;; Suspend things like cursor-intangible during Isearch so we can search
974 ;; even within intangible text.
975 (push 'isearch cursor-sensor-inhibit))
977 (if (and (null unread-command-events)
978 (null executing-kbd-macro))
980 (if (not (input-pending-p))
981 (funcall (or isearch-message-function #'isearch-message)))
982 (if (and isearch-slow-terminal-mode
983 (not (or isearch-small-window
984 (pos-visible-in-window-group-p))))
985 (let ((found-point (point)))
986 (setq isearch-small-window t)
987 (move-to-window-line 0)
988 (let ((window-min-height 1))
989 (split-window nil (if (< search-slow-window-lines 0)
990 (1+ (- search-slow-window-lines))
992 (1+ search-slow-window-lines)))))
993 (if (< search-slow-window-lines 0)
994 (progn (vertical-motion (- 1 search-slow-window-lines))
995 (set-window-start (next-window) (point))
996 (set-window-hscroll (next-window)
998 (set-window-hscroll (selected-window) 0))
1000 (goto-char found-point))
1001 ;; Keep same hscrolling as at the start of the search when possible
1002 (let ((current-scroll (window-hscroll))
1004 (set-window-hscroll (selected-window) isearch-start-hscroll)
1005 (setq visible-p (pos-visible-in-window-group-p nil nil t))
1006 (if (or (not visible-p)
1007 ;; When point is not visible because of hscroll,
1008 ;; pos-visible-in-window-group-p returns non-nil, but
1009 ;; the X coordinate it returns is 1 pixel beyond
1010 ;; the last visible one.
1012 (* (window-max-chars-per-line) (frame-char-width))))
1013 (set-window-hscroll (selected-window) current-scroll))))
1014 (if isearch-other-end
1015 (if (< isearch-other-end (point)) ; isearch-forward?
1016 (isearch-highlight isearch-other-end (point))
1017 (isearch-highlight (point) isearch-other-end))
1018 (isearch-dehighlight))))
1019 (setq ;; quit-flag nil not for isearch-mode
1020 isearch-adjusted nil
1021 isearch-yank-flag nil)
1022 ;; We must prevent the point moving to the end of composition when a
1023 ;; part of the composition has just been searched.
1024 (setq disable-point-adjustment t)
1025 (run-hooks 'isearch-update-post-hook)
1026 (when isearch-lazy-highlight
1027 (isearch-lazy-highlight-new-loop)))
1029 (defun isearch-done (&optional nopush edit)
1031 For successful search, pass no args.
1032 For a failing search, NOPUSH is t.
1033 For going to the minibuffer to edit the search string,
1034 NOPUSH is t and EDIT is t."
1036 (if isearch-resume-in-command-history
1037 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
1038 ,isearch-regexp-function ,isearch-forward
1040 ',isearch-case-fold-search)))
1041 (unless (equal (car command-history) command)
1042 (setq command-history (cons command command-history)))))
1044 (remove-hook 'pre-command-hook 'isearch-pre-command-hook)
1045 (remove-hook 'post-command-hook 'isearch-post-command-hook)
1046 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
1047 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
1048 (setq isearch-lazy-highlight-start nil)
1049 (when (buffer-live-p isearch--current-buffer)
1050 (with-current-buffer isearch--current-buffer
1051 (setq isearch--current-buffer nil)
1052 (setq cursor-sensor-inhibit (delq 'isearch cursor-sensor-inhibit))))
1054 ;; Called by all commands that terminate isearch-mode.
1055 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
1056 (setq overriding-terminal-local-map nil)
1057 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
1058 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
1059 (isearch-dehighlight)
1060 (lazy-highlight-cleanup lazy-highlight-cleanup)
1061 (let ((found-start (window-group-start))
1062 (found-point (point)))
1063 (when isearch-window-configuration
1064 (set-window-configuration isearch-window-configuration)
1065 (if isearch-small-window
1066 (goto-char found-point)
1067 ;; set-window-configuration clobbers window-start; restore it.
1068 ;; This has an annoying side effect of clearing the last_modiff
1069 ;; field of the window, which can cause unwanted scrolling,
1070 ;; so don't do it unless truly necessary.
1071 (set-window-group-start (selected-window) found-start t))))
1073 (setq isearch-mode nil)
1074 (if isearch-input-method-local-p
1075 (setq input-method-function isearch-input-method-function)
1076 (kill-local-variable 'input-method-function))
1078 (force-mode-line-update)
1080 ;; If we ended in the middle of some intangible text,
1081 ;; move to the further end of that intangible text.
1082 (let ((after (if (eobp) nil
1083 (get-text-property (point) 'intangible)))
1084 (before (if (bobp) nil
1085 (get-text-property (1- (point)) 'intangible))))
1086 (when (and before after (eq before after))
1089 (next-single-property-change (point) 'intangible)
1090 (previous-single-property-change (point) 'intangible)))))
1092 (if (and (> (length isearch-string) 0) (not nopush))
1093 ;; Update the ring data.
1094 (isearch-update-ring isearch-string isearch-regexp))
1096 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
1097 (run-hooks 'isearch-mode-end-hook))
1099 ;; If there was movement, mark the starting position.
1100 ;; Maybe should test difference between and set mark only if > threshold.
1101 (if (/= (point) isearch-opoint)
1102 (or (and transient-mark-mode mark-active)
1104 (push-mark isearch-opoint t)
1105 (or executing-kbd-macro (> (minibuffer-depth) 0) edit
1106 (message "Mark saved where search started")))))
1108 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
1110 (defun isearch-update-ring (string &optional regexp)
1111 "Add STRING to the beginning of the search ring.
1112 REGEXP if non-nil says use the regexp search ring."
1114 (if regexp 'regexp-search-ring 'search-ring)
1116 (if regexp regexp-search-ring-max search-ring-max)))
1118 ;; Switching buffers should first terminate isearch-mode.
1119 ;; ;; For Emacs 19, the frame switch event is handled.
1120 ;; (defun isearch-switch-frame-handler ()
1121 ;; (interactive) ;; Is this necessary?
1122 ;; ;; First terminate isearch-mode.
1124 ;; (isearch-clean-overlays)
1125 ;; (handle-switch-frame (car (cdr last-command-event))))
1128 ;; The search status structure and stack.
1130 (cl-defstruct (isearch--state
1133 (:constructor isearch--get-state
1135 (string isearch-string)
1136 (message isearch-message)
1138 (success isearch-success)
1139 (forward isearch-forward)
1140 (other-end isearch-other-end)
1141 (word isearch-regexp-function)
1142 (error isearch-error)
1143 (wrapped isearch-wrapped)
1144 (barrier isearch-barrier)
1145 (case-fold-search isearch-case-fold-search)
1146 (pop-fun (if isearch-push-state-function
1147 (funcall isearch-push-state-function))))))
1148 (string nil :read-only t)
1149 (message nil :read-only t)
1150 (point nil :read-only t)
1151 (success nil :read-only t)
1152 (forward nil :read-only t)
1153 (other-end nil :read-only t)
1154 (word nil :read-only t)
1155 (error nil :read-only t)
1156 (wrapped nil :read-only t)
1157 (barrier nil :read-only t)
1158 (case-fold-search nil :read-only t)
1159 (pop-fun nil :read-only t))
1161 (defun isearch--set-state (cmd)
1162 (setq isearch-string (isearch--state-string cmd)
1163 isearch-message (isearch--state-message cmd)
1164 isearch-success (isearch--state-success cmd)
1165 isearch-forward (isearch--state-forward cmd)
1166 isearch-other-end (isearch--state-other-end cmd)
1167 isearch-regexp-function (isearch--state-word cmd)
1168 isearch-error (isearch--state-error cmd)
1169 isearch-wrapped (isearch--state-wrapped cmd)
1170 isearch-barrier (isearch--state-barrier cmd)
1171 isearch-case-fold-search (isearch--state-case-fold-search cmd))
1172 (if (functionp (isearch--state-pop-fun cmd))
1173 (funcall (isearch--state-pop-fun cmd) cmd))
1174 (goto-char (isearch--state-point cmd)))
1176 (defun isearch-pop-state ()
1177 (setq isearch-cmds (cdr isearch-cmds))
1178 (isearch--set-state (car isearch-cmds)))
1180 (defun isearch-push-state ()
1181 (push (isearch--get-state) isearch-cmds))
1184 ;; Commands active while inside of the isearch minor mode.
1186 (defun isearch-exit ()
1187 "Exit search normally.
1188 However, if this is the first command after starting incremental
1189 search and `search-nonincremental-instead' is non-nil, do a
1190 nonincremental search instead via `isearch-edit-string'."
1192 (if (and search-nonincremental-instead
1193 (= 0 (length isearch-string)))
1194 (let ((isearch-nonincremental t))
1195 (isearch-edit-string)) ;; this calls isearch-done as well
1197 (isearch-clean-overlays))
1199 (defun isearch-fail-pos (&optional msg)
1200 "Return position of first mismatch in search string, or nil if none.
1201 If MSG is non-nil, use variable `isearch-message', otherwise `isearch-string'."
1202 (let ((cmds isearch-cmds)
1203 (curr-msg (if msg isearch-message isearch-string))
1205 (when (or (not isearch-success) isearch-error)
1207 (or (not (isearch--state-success (car cmds)))
1208 (isearch--state-error (car cmds))))
1210 (setq succ-msg (and cmds (if msg (isearch--state-message (car cmds))
1211 (isearch--state-string (car cmds)))))
1212 (if (and (stringp succ-msg)
1213 (< (length succ-msg) (length curr-msg))
1215 (substring curr-msg 0 (length succ-msg))))
1219 (defvar isearch-new-regexp-function nil
1220 "Holds the next `isearch-regexp-function' inside `with-isearch-suspended'.
1221 If this is set inside code wrapped by the macro
1222 `with-isearch-suspended', then the value set will be used as the
1223 `isearch-regexp-function' once isearch resumes.")
1224 (define-obsolete-variable-alias 'isearch-new-word
1225 'isearch-new-regexp-function "25.1")
1227 (defmacro with-isearch-suspended (&rest body)
1228 "Exit Isearch mode, run BODY, and reinvoke the pending search.
1229 You can update the global isearch variables by setting new values to
1230 `isearch-new-string', `isearch-new-message', `isearch-new-forward',
1231 `isearch-new-regexp-function', `isearch-new-case-fold'."
1232 ;; This code is very hairy for several reasons, explained in the code.
1233 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1234 ;; If there were a way to catch any change of buffer from the minibuffer,
1235 ;; this could be simplified greatly.
1236 ;; Editing doesn't back up the search point. Should it?
1237 `(condition-case nil
1239 (let ((isearch-nonincremental isearch-nonincremental)
1241 ;; Locally bind all isearch global variables to protect them
1242 ;; from recursive isearching.
1243 ;; isearch-string -message and -forward are not bound
1244 ;; so they may be changed. Instead, save the values.
1245 (isearch-new-string isearch-string)
1246 (isearch-new-message isearch-message)
1247 (isearch-new-forward isearch-forward)
1248 (isearch-new-regexp-function isearch-regexp-function)
1249 (isearch-new-case-fold isearch-case-fold-search)
1251 (isearch-regexp isearch-regexp)
1252 (isearch-op-fun isearch-op-fun)
1253 (isearch-cmds isearch-cmds)
1254 (isearch-success isearch-success)
1255 (isearch-wrapped isearch-wrapped)
1256 (isearch-barrier isearch-barrier)
1257 (isearch-adjusted isearch-adjusted)
1258 (isearch-yank-flag isearch-yank-flag)
1259 (isearch-error isearch-error)
1261 (multi-isearch-file-list-new multi-isearch-file-list)
1262 (multi-isearch-buffer-list-new multi-isearch-buffer-list)
1263 (multi-isearch-next-buffer-function multi-isearch-next-buffer-current-function)
1264 (multi-isearch-current-buffer-new multi-isearch-current-buffer)
1265 ;;; Don't bind this. We want isearch-search, below, to set it.
1266 ;;; And the old value won't matter after that.
1267 ;;; (isearch-other-end isearch-other-end)
1268 ;;; Perhaps some of these other variables should be bound for a
1269 ;;; shorter period, ending before the next isearch-search.
1270 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1271 (isearch-opoint isearch-opoint)
1272 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1273 (isearch-small-window isearch-small-window)
1274 (isearch-recursive-edit isearch-recursive-edit)
1275 ;; Save current configuration so we can restore it here.
1276 (isearch-window-configuration (current-window-configuration))
1278 ;; This could protect the index of the search rings,
1279 ;; but we can't reliably count the number of typed M-p
1280 ;; in `read-from-minibuffer' to adjust the index accordingly.
1281 ;; So when the following is commented out, `isearch-mode'
1282 ;; below resets the index to the predictable value nil.
1283 ;; (search-ring-yank-pointer search-ring-yank-pointer)
1284 ;; (regexp-search-ring-yank-pointer regexp-search-ring-yank-pointer)
1286 ;; Temporarily restore `minibuffer-message-timeout'.
1287 (minibuffer-message-timeout
1288 isearch-original-minibuffer-message-timeout)
1289 (isearch-original-minibuffer-message-timeout
1290 isearch-original-minibuffer-message-timeout)
1291 old-point old-other-end)
1293 ;; Actually terminate isearching until editing is done.
1294 ;; This is so that the user can do anything without failure,
1295 ;; like switch buffers and start another isearch, and return.
1298 (exit nil)) ; was recursive editing
1300 ;; Save old point and isearch-other-end before reading from minibuffer
1301 ;; that can change their values.
1302 (setq old-point (point) old-other-end isearch-other-end)
1307 ;; Always resume isearching by restarting it.
1308 (isearch-mode isearch-forward
1312 isearch-regexp-function)
1314 ;; Copy new local values to isearch globals
1315 (setq isearch-string isearch-new-string
1316 isearch-message isearch-new-message
1317 isearch-forward isearch-new-forward
1318 isearch-regexp-function isearch-new-regexp-function
1319 isearch-case-fold-search isearch-new-case-fold
1320 multi-isearch-current-buffer multi-isearch-current-buffer-new
1321 multi-isearch-file-list multi-isearch-file-list-new
1322 multi-isearch-buffer-list multi-isearch-buffer-list-new)
1324 ;; Restore the minibuffer message before moving point.
1325 (funcall (or isearch-message-function #'isearch-message) nil t)
1327 ;; Set point at the start (end) of old match if forward (backward),
1328 ;; so after exiting minibuffer isearch resumes at the start (end)
1329 ;; of this match and can find it again.
1330 (if (and old-other-end (eq old-point (point))
1331 (eq isearch-forward isearch-new-forward))
1332 (goto-char old-other-end)))
1334 ;; Empty isearch-string means use default.
1335 (when (= 0 (length isearch-string))
1336 (setq isearch-string (or (car (if isearch-regexp
1342 (mapconcat 'isearch-text-char-description
1344 ;; After taking the last element, adjust ring to previous one.
1345 (isearch-ring-adjust1 nil)))
1347 ;; This used to push the state as of before this C-s, but it adds
1348 ;; an inconsistent state where part of variables are from the
1349 ;; previous search (e.g. `isearch-success'), and part of variables
1350 ;; are just entered from the minibuffer (e.g. `isearch-string').
1351 ;; (isearch-push-state)
1353 ;; Reinvoke the pending search.
1355 (isearch-push-state) ; this pushes the correct state
1357 (if isearch-nonincremental
1359 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1361 ;; The search done message is confusing when the string
1362 ;; is empty, so erase it.
1363 (if (equal isearch-string "")
1366 (quit ; handle abort-recursive-edit
1367 (isearch-abort) ;; outside of let to restore outside global values
1370 (defvar minibuffer-history-symbol) ;; from external package gmhist.el
1372 (defun isearch-edit-string ()
1373 "Edit the search string in the minibuffer.
1374 The following additional command keys are active while editing.
1375 \\<minibuffer-local-isearch-map>
1376 \\[exit-minibuffer] to resume incremental searching with the edited string.
1377 \\[isearch-forward-exit-minibuffer] to resume isearching forward.
1378 \\[isearch-reverse-exit-minibuffer] to resume isearching backward.
1379 \\[isearch-complete-edit] to complete the search string using the search ring."
1381 (with-isearch-suspended
1382 (let* ((message-log-max nil)
1383 ;; Don't add a new search string to the search ring here
1384 ;; in `read-from-minibuffer'. It should be added only
1385 ;; by `isearch-update-ring' called from `isearch-done'.
1386 (history-add-new-input nil)
1387 ;; Binding minibuffer-history-symbol to nil is a work-around
1388 ;; for some incompatibility with gmhist.
1389 (minibuffer-history-symbol))
1390 (setq isearch-new-string
1391 (read-from-minibuffer
1392 (isearch-message-prefix nil isearch-nonincremental)
1393 (cons isearch-string (1+ (or (isearch-fail-pos)
1394 (length isearch-string))))
1395 minibuffer-local-isearch-map nil
1397 (cons 'regexp-search-ring
1398 (1+ (or regexp-search-ring-yank-pointer -1)))
1400 (1+ (or search-ring-yank-pointer -1))))
1403 (mapconcat 'isearch-text-char-description
1404 isearch-new-string "")))))
1406 (defun isearch-nonincremental-exit-minibuffer ()
1408 (setq isearch-nonincremental t)
1410 ;; Changing the value of `isearch-nonincremental' has no effect here,
1411 ;; because `isearch-edit-string' ignores this change. Thus marked as obsolete.
1412 (make-obsolete 'isearch-nonincremental-exit-minibuffer 'exit-minibuffer "24.4")
1414 (defun isearch-forward-exit-minibuffer ()
1415 "Resume isearching forward from the minibuffer that edits the search string."
1417 (setq isearch-new-forward t)
1420 (defun isearch-reverse-exit-minibuffer ()
1421 "Resume isearching backward from the minibuffer that edits the search string."
1423 (setq isearch-new-forward nil)
1426 (defun isearch-cancel ()
1427 "Terminate the search and go back to the starting point."
1429 (if (and isearch-push-state-function isearch-cmds)
1430 ;; For defined push-state function, restore the first state.
1431 ;; This calls pop-state function and restores original point.
1432 (let ((isearch-cmds (last isearch-cmds)))
1433 (isearch--set-state (car isearch-cmds)))
1434 (goto-char isearch-opoint))
1435 (isearch-done t) ; Exit isearch..
1436 (isearch-clean-overlays)
1437 (signal 'quit nil)) ; ..and pass on quit signal.
1439 (defun isearch-abort ()
1440 "Abort incremental search mode if searching is successful, signaling quit.
1441 Otherwise, revert to previous successful search and continue searching.
1442 Use `isearch-exit' to quit without signaling."
1444 ;; (ding) signal instead below, if quitting
1446 (if (and isearch-success (not isearch-error))
1447 ;; If search is successful and has no incomplete regexp,
1448 ;; move back to starting point and really do quit.
1450 (setq isearch-success nil)
1452 ;; If search is failing, or has an incomplete regexp,
1453 ;; rub out until it is once more successful.
1454 (while (or (not isearch-success) isearch-error)
1455 (isearch-pop-state))
1458 (defun isearch-repeat (direction)
1459 ;; Utility for isearch-repeat-forward and -backward.
1460 (if (eq isearch-forward (eq direction 'forward))
1461 ;; C-s in forward or C-r in reverse.
1462 (if (equal isearch-string "")
1463 ;; If search string is empty, use last one.
1464 (if (null (if isearch-regexp regexp-search-ring search-ring))
1465 (setq isearch-error "No previous search string")
1466 (setq isearch-string
1467 (car (if isearch-regexp regexp-search-ring search-ring))
1469 (mapconcat 'isearch-text-char-description
1471 isearch-case-fold-search isearch-last-case-fold-search)
1472 ;; After taking the last element, adjust ring to previous one.
1473 (isearch-ring-adjust1 nil))
1474 ;; If already have what to search for, repeat it.
1477 ;; Set isearch-wrapped before calling isearch-wrap-function
1478 (setq isearch-wrapped t)
1479 (if isearch-wrap-function
1480 (funcall isearch-wrap-function)
1481 (goto-char (if isearch-forward (point-min) (point-max)))))))
1482 ;; C-s in reverse or C-r in forward, change direction.
1483 (setq isearch-forward (not isearch-forward)
1486 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1488 (if (equal isearch-string "")
1489 (setq isearch-success t)
1490 (if (and isearch-success
1491 (equal (point) isearch-other-end)
1492 (not isearch-just-started))
1493 ;; If repeating a search that found
1494 ;; an empty string, ensure we advance.
1495 (if (if isearch-forward (eobp) (bobp))
1496 ;; If there's nowhere to advance to, fail (and wrap next time).
1498 (setq isearch-success nil)
1500 (forward-char (if isearch-forward 1 -1))
1504 (isearch-push-state)
1507 (defun isearch-repeat-forward ()
1508 "Repeat incremental search forwards."
1510 (isearch-repeat 'forward))
1512 (defun isearch-repeat-backward ()
1513 "Repeat incremental search backwards."
1515 (isearch-repeat 'backward))
1518 ;;; Toggles for `isearch-regexp-function' and `search-default-mode'.
1519 (defmacro isearch-define-mode-toggle (mode key function &optional docstring &rest body)
1520 "Define a command called `isearch-toggle-MODE' and bind it to `M-s KEY'.
1521 The first line of the command's docstring is auto-generated, the
1522 remainder may be provided in DOCSTRING.
1523 If FUNCTION is a symbol, this command first toggles the value of
1524 `isearch-regexp-function' between nil and FUNCTION. Also set the
1525 `isearch-message-prefix' property of FUNCTION.
1526 The command then executes BODY and updates the isearch prompt."
1527 (declare (indent defun))
1528 (let ((command-name (intern (format "isearch-toggle-%s" mode)))
1529 (key (concat "\M-s" key)))
1531 (defun ,command-name ()
1532 ,(format "Toggle %s searching on or off.%s" mode
1533 (if docstring (concat "\n" docstring) ""))
1536 `((setq isearch-regexp-function
1537 (unless (eq isearch-regexp-function #',function)
1539 (setq isearch-regexp nil)))
1541 (setq isearch-success t isearch-adjusted t)
1543 (define-key isearch-mode-map ,key #',command-name)
1544 ,@(when (and function (symbolp function))
1545 `((put ',function 'isearch-message-prefix ,(format "%s " mode))
1546 (put ',function :advertised-binding ,key)
1547 (cl-callf (lambda (types) (cons 'choice
1548 (cons '(const :tag ,(capitalize (format "%s search" mode)) ,function)
1550 (get 'search-default-mode 'custom-type)))))))
1552 (isearch-define-mode-toggle word "w" word-search-regexp "\
1553 Turning on word search turns off regexp mode.")
1554 (isearch-define-mode-toggle symbol "_" isearch-symbol-regexp "\
1555 Turning on symbol search turns off regexp mode.")
1556 (isearch-define-mode-toggle char-fold "'" char-fold-to-regexp "\
1557 Turning on character-folding turns off regexp mode.")
1558 (put 'char-fold-to-regexp 'isearch-message-prefix "char-fold ")
1560 (isearch-define-mode-toggle regexp "r" nil nil
1561 (setq isearch-regexp (not isearch-regexp))
1562 (if isearch-regexp (setq isearch-regexp-function nil)))
1564 (defun isearch--momentary-message (string)
1565 "Print STRING at the end of the isearch prompt for 1 second"
1566 (let ((message-log-max nil))
1567 (message "%s%s [%s]"
1568 (isearch-message-prefix nil isearch-nonincremental)
1573 (isearch-define-mode-toggle lax-whitespace " " nil
1574 "In ordinary search, toggles the value of the variable
1575 `isearch-lax-whitespace'. In regexp search, toggles the
1576 value of the variable `isearch-regexp-lax-whitespace'."
1577 (isearch--momentary-message
1578 (if (if isearch-regexp
1579 (setq isearch-regexp-lax-whitespace (not isearch-regexp-lax-whitespace))
1580 (setq isearch-lax-whitespace (not isearch-lax-whitespace)))
1581 "match spaces loosely"
1582 "match spaces literally")))
1584 (isearch-define-mode-toggle case-fold "c" nil
1585 "Toggles the value of the variable `isearch-case-fold-search'."
1586 (isearch--momentary-message
1587 (if (setq isearch-case-fold-search
1588 (if isearch-case-fold-search nil 'yes))
1592 (isearch-define-mode-toggle invisible "i" nil
1593 "This determines whether to search inside invisible text or not.
1594 Toggles the variable `isearch-invisible' between values
1595 nil and a non-nil value of the option `search-invisible'
1596 \(or `open' if `search-invisible' is nil)."
1597 "match %svisible text"
1598 (isearch--momentary-message
1599 (if (setq isearch-invisible
1600 (if isearch-invisible
1601 nil (or search-invisible 'open)))
1602 "match invisible text"
1603 "match visible text")))
1608 (defun word-search-regexp (string &optional lax)
1609 "Return a regexp which matches words, ignoring punctuation.
1610 Given STRING, a string of words separated by word delimiters,
1611 compute a regexp that matches those exact words separated by
1612 arbitrary punctuation. If the string begins or ends in whitespace,
1613 the beginning or the end of the string matches arbitrary whitespace.
1614 Otherwise if LAX is non-nil, the beginning or the end of the string
1615 need not match a word boundary.
1617 Used in `word-search-forward', `word-search-backward',
1618 `word-search-forward-lax', `word-search-backward-lax'."
1620 ((equal string "") "")
1621 ((string-match-p "\\`\\W+\\'" string) "\\W+")
1623 (if (string-match-p "\\`\\W" string) "\\W+"
1625 (mapconcat 'regexp-quote (split-string string "\\W+" t) "\\W+")
1626 (if (string-match-p "\\W\\'" string) "\\W+"
1627 (unless lax "\\>"))))))
1629 (defun word-search-backward (string &optional bound noerror count)
1630 "Search backward from point for STRING, ignoring differences in punctuation.
1631 Set point to the beginning of the occurrence found, and return point.
1632 An optional second argument bounds the search; it is a buffer position.
1633 The match found must not begin before that position. A value of nil
1634 means search to the beginning of the accessible portion of the buffer.
1635 Optional third argument, if t, means if fail just return nil (no error).
1636 If not nil and not t, position at limit of search and return nil.
1637 Optional fourth argument COUNT, if a positive number, means to search
1638 for COUNT successive occurrences. If COUNT is negative, search
1639 forward, instead of backward, for -COUNT occurrences. A value of
1640 nil means the same as 1.
1641 With COUNT positive, the match found is the COUNTth to last one (or
1642 last, if COUNT is 1 or nil) in the buffer located entirely before
1643 the origin of the search; correspondingly with COUNT negative.
1645 Relies on the function `word-search-regexp' to convert a sequence
1646 of words in STRING to a regexp used to search words without regard
1648 This command does not support character folding, and lax space matching
1649 has no effect on it."
1650 (interactive "sWord search backward: ")
1651 (re-search-backward (word-search-regexp string nil) bound noerror count))
1653 (defun word-search-forward (string &optional bound noerror count)
1654 "Search forward from point for STRING, ignoring differences in punctuation.
1655 Set point to the end of the occurrence found, and return point.
1656 An optional second argument bounds the search; it is a buffer position.
1657 The match found must not end after that position. A value of nil
1658 means search to the end of the accessible portion of the buffer.
1659 Optional third argument, if t, means if fail just return nil (no error).
1660 If not nil and not t, move to limit of search and return nil.
1661 Optional fourth argument COUNT, if a positive number, means to search
1662 for COUNT successive occurrences. If COUNT is negative, search
1663 backward, instead of forward, for -COUNT occurrences. A value of
1664 nil means the same as 1.
1665 With COUNT positive, the match found is the COUNTth one (or first,
1666 if COUNT is 1 or nil) in the buffer located entirely after the
1667 origin of the search; correspondingly with COUNT negative.
1669 Relies on the function `word-search-regexp' to convert a sequence
1670 of words in STRING to a regexp used to search words without regard
1672 This command does not support character folding, and lax space matching
1673 has no effect on it."
1674 (interactive "sWord search: ")
1675 (re-search-forward (word-search-regexp string nil) bound noerror count))
1677 (defun word-search-backward-lax (string &optional bound noerror count)
1678 "Search backward from point for STRING, ignoring differences in punctuation.
1679 Set point to the beginning of the occurrence found, and return point.
1681 Unlike `word-search-backward', the end of STRING need not match a word
1682 boundary, unless STRING ends in whitespace.
1684 An optional second argument bounds the search; it is a buffer position.
1685 The match found must not begin before that position. A value of nil
1686 means search to the beginning of the accessible portion of the buffer.
1687 Optional third argument, if t, means if fail just return nil (no error).
1688 If not nil and not t, position at limit of search and return nil.
1689 Optional fourth argument COUNT, if a positive number, means to search
1690 for COUNT successive occurrences. If COUNT is negative, search
1691 forward, instead of backward, for -COUNT occurrences. A value of
1692 nil means the same as 1.
1693 With COUNT positive, the match found is the COUNTth to last one (or
1694 last, if COUNT is 1 or nil) in the buffer located entirely before
1695 the origin of the search; correspondingly with COUNT negative.
1697 Relies on the function `word-search-regexp' to convert a sequence
1698 of words in STRING to a regexp used to search words without regard
1700 This command does not support character folding, and lax space matching
1701 has no effect on it."
1702 (interactive "sWord search backward: ")
1703 (re-search-backward (word-search-regexp string t) bound noerror count))
1705 (defun word-search-forward-lax (string &optional bound noerror count)
1706 "Search forward from point for STRING, ignoring differences in punctuation.
1707 Set point to the end of the occurrence found, and return point.
1709 Unlike `word-search-forward', the end of STRING need not match a word
1710 boundary, unless STRING ends in whitespace.
1712 An optional second argument bounds the search; it is a buffer position.
1713 The match found must not end after that position. A value of nil
1714 means search to the end of the accessible portion of the buffer.
1715 Optional third argument, if t, means if fail just return nil (no error).
1716 If not nil and not t, move to limit of search and return nil.
1717 Optional fourth argument COUNT, if a positive number, means to search
1718 for COUNT successive occurrences. If COUNT is negative, search
1719 backward, instead of forward, for -COUNT occurrences. A value of
1720 nil means the same as 1.
1721 With COUNT positive, the match found is the COUNTth one (or first,
1722 if COUNT is 1 or nil) in the buffer located entirely after the
1723 origin of the search; correspondingly with COUNT negative.
1725 Relies on the function `word-search-regexp' to convert a sequence
1726 of words in STRING to a regexp used to search words without regard
1728 This command does not support character folding, and lax space matching
1729 has no effect on it."
1730 (interactive "sWord search: ")
1731 (re-search-forward (word-search-regexp string t) bound noerror count))
1735 (defun isearch-symbol-regexp (string &optional lax)
1736 "Return a regexp which matches STRING as a symbol.
1737 Creates a regexp where STRING is surrounded by symbol delimiters \\_< and \\_>.
1738 If there are more than one symbol, then compute a regexp that matches
1739 those exact symbols separated by non-symbol characters. If the string
1740 begins or ends in whitespace, the beginning or the end of the string
1741 matches arbitrary non-symbol whitespace. Otherwise if LAX is non-nil,
1742 the beginning or the end of the string need not match a symbol boundary."
1743 (let ((not-word-symbol-re
1744 ;; This regexp matches all syntaxes except word and symbol syntax.
1745 ;; FIXME: Replace it with something shorter if possible (bug#14602).
1746 "\\(?:\\s-\\|\\s.\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s/\\|\\s$\\|\\s'\\|\\s<\\|\\s>\\|\\s@\\|\\s!\\|\\s|\\)+"))
1748 ((equal string "") "")
1749 ((string-match-p (format "\\`%s\\'" not-word-symbol-re) string) not-word-symbol-re)
1751 (if (string-match-p (format "\\`%s" not-word-symbol-re) string) not-word-symbol-re
1752 (unless lax "\\_<"))
1753 (mapconcat 'regexp-quote (split-string string not-word-symbol-re t) not-word-symbol-re)
1754 (if (string-match-p (format "%s\\'" not-word-symbol-re) string) not-word-symbol-re
1755 (unless lax "\\_>")))))))
1757 (put 'isearch-symbol-regexp 'isearch-message-prefix "symbol ")
1759 ;; Search with lax whitespace
1761 (defun search-forward-lax-whitespace (string &optional bound noerror count)
1762 "Search forward for STRING, matching a sequence of whitespace chars."
1763 (let ((search-spaces-regexp search-whitespace-regexp))
1764 (re-search-forward (regexp-quote string) bound noerror count)))
1766 (defun search-backward-lax-whitespace (string &optional bound noerror count)
1767 "Search backward for STRING, matching a sequence of whitespace chars."
1768 (let ((search-spaces-regexp search-whitespace-regexp))
1769 (re-search-backward (regexp-quote string) bound noerror count)))
1771 (defun re-search-forward-lax-whitespace (regexp &optional bound noerror count)
1772 "Search forward for REGEXP, matching a sequence of whitespace chars."
1773 (let ((search-spaces-regexp search-whitespace-regexp))
1774 (re-search-forward regexp bound noerror count)))
1776 (defun re-search-backward-lax-whitespace (regexp &optional bound noerror count)
1777 "Search backward for REGEXP, matching a sequence of whitespace chars."
1778 (let ((search-spaces-regexp search-whitespace-regexp))
1779 (re-search-backward regexp bound noerror count)))
1781 (dolist (old '(re-search-forward-lax-whitespace search-backward-lax-whitespace
1782 search-forward-lax-whitespace re-search-backward-lax-whitespace))
1784 "instead, use (let ((search-spaces-regexp search-whitespace-regexp))
1785 (re-search-... ...))"
1789 (defun isearch-query-replace (&optional arg regexp-flag)
1790 "Start `query-replace' with string to replace from last search string.
1791 The ARG (prefix arg if interactive), if non-nil, means replace
1792 only matches surrounded by word boundaries. A negative prefix
1793 arg means replace backward. Note that using the prefix arg
1794 is possible only when `isearch-allow-scroll' is non-nil or
1795 `isearch-allow-prefix' is non-nil, and it doesn't always provide the
1796 correct matches for `query-replace', so the preferred way to run word
1797 replacements from Isearch is `M-s w ... M-%'."
1799 (list current-prefix-arg))
1800 (barf-if-buffer-read-only)
1801 (if regexp-flag (setq isearch-regexp t))
1802 (let ((case-fold-search isearch-case-fold-search)
1803 ;; set `search-upper-case' to nil to not call
1804 ;; `isearch-no-upper-case-p' in `perform-replace'
1805 (search-upper-case nil)
1806 (search-invisible isearch-invisible)
1807 (replace-lax-whitespace
1808 isearch-lax-whitespace)
1809 (replace-regexp-lax-whitespace
1810 isearch-regexp-lax-whitespace)
1811 (delimited (and arg (not (eq arg '-))))
1812 (backward (and arg (eq arg '-)))
1813 ;; Set `isearch-recursive-edit' to nil to prevent calling
1814 ;; `exit-recursive-edit' in `isearch-done' that terminates
1815 ;; the execution of this command when it is non-nil.
1816 ;; We call `exit-recursive-edit' explicitly at the end below.
1817 (isearch-recursive-edit nil))
1818 (isearch-done nil t)
1819 (isearch-clean-overlays)
1820 (if (and isearch-other-end
1822 (> isearch-other-end (point))
1823 (< isearch-other-end (point)))
1824 (not (and transient-mark-mode mark-active
1827 (< (mark) (point))))))
1828 (goto-char isearch-other-end))
1829 (set query-replace-from-history-variable
1830 (cons isearch-string
1831 (symbol-value query-replace-from-history-variable)))
1834 (query-replace-read-to
1836 (concat "Query replace"
1837 (isearch--describe-regexp-mode (or delimited isearch-regexp-function) t)
1838 (if backward " backward" "")
1839 (if (and transient-mark-mode mark-active) " in region" ""))
1841 t isearch-regexp (or delimited isearch-regexp-function) nil nil
1842 (if (and transient-mark-mode mark-active) (region-beginning))
1843 (if (and transient-mark-mode mark-active) (region-end))
1845 (and isearch-recursive-edit (exit-recursive-edit)))
1847 (defun isearch-query-replace-regexp (&optional arg)
1848 "Start `query-replace-regexp' with string to replace from last search string.
1849 See `isearch-query-replace' for more information."
1851 (list current-prefix-arg))
1852 (isearch-query-replace arg t))
1854 (defun isearch-occur (regexp &optional nlines)
1855 "Run `occur' using the last search string as the regexp.
1856 Interactively, REGEXP is constructed using the search string from the
1857 last search command. NLINES has the same meaning as in `occur'.
1859 If the last search command was a word search, REGEXP is computed from
1860 the search words, ignoring punctuation. If the last search
1861 command was a regular expression search, REGEXP is the regular
1862 expression used in that search. If the last search command searched
1863 for a literal string, REGEXP is constructed by quoting all the special
1864 characters in that string."
1866 (let* ((perform-collect (consp current-prefix-arg))
1868 ((functionp isearch-regexp-function)
1869 (funcall isearch-regexp-function isearch-string))
1870 (isearch-regexp-function (word-search-regexp isearch-string))
1871 (isearch-regexp isearch-string)
1872 (t (regexp-quote isearch-string)))))
1875 ;; Perform collect operation
1876 (if (zerop (regexp-opt-depth regexp))
1877 ;; No subexpression so collect the entire match.
1879 ;; Get the regexp for collection pattern.
1880 (let ((default (car occur-collect-regexp-history))
1882 (with-isearch-suspended
1883 (setq regexp-collect
1885 (format "Regexp to collect (default %s): " default)
1886 default 'occur-collect-regexp-history)))
1888 ;; Otherwise normal occur takes numerical prefix argument.
1889 (when current-prefix-arg
1890 (prefix-numeric-value current-prefix-arg))))))
1891 (let ((case-fold-search isearch-case-fold-search)
1892 ;; Set `search-upper-case' to nil to not call
1893 ;; `isearch-no-upper-case-p' in `occur-1'.
1894 (search-upper-case nil)
1895 (search-spaces-regexp
1896 (if (if isearch-regexp
1897 isearch-regexp-lax-whitespace
1898 isearch-lax-whitespace)
1899 search-whitespace-regexp)))
1900 (occur (if isearch-regexp-function
1902 'isearch-string isearch-string
1903 'isearch-regexp-function-descr
1904 (isearch--describe-regexp-mode isearch-regexp-function))
1908 (declare-function hi-lock-read-face-name "hi-lock" ())
1910 (defun isearch-highlight-regexp ()
1911 "Run `highlight-regexp' with regexp from the current search string.
1912 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1913 argument from the last search regexp or a quoted search string,
1914 and reads its face argument using `hi-lock-read-face-name'."
1917 ;; Set `isearch-recursive-edit' to nil to prevent calling
1918 ;; `exit-recursive-edit' in `isearch-done' that terminates
1919 ;; the execution of this command when it is non-nil.
1920 ;; We call `exit-recursive-edit' explicitly at the end below.
1921 (isearch-recursive-edit nil))
1922 (isearch-done nil t)
1923 (isearch-clean-overlays))
1924 (require 'hi-lock nil t)
1925 (let ((regexp (cond ((functionp isearch-regexp-function)
1926 (funcall isearch-regexp-function isearch-string))
1927 (isearch-regexp-function (word-search-regexp isearch-string))
1928 (isearch-regexp isearch-string)
1929 ((if (and (eq isearch-case-fold-search t)
1931 (isearch-no-upper-case-p
1932 isearch-string isearch-regexp)
1933 isearch-case-fold-search)
1934 ;; Turn isearch-string into a case-insensitive
1938 (let ((s (string c)))
1939 (if (string-match "[[:alpha:]]" s)
1940 (format "[%s%s]" (upcase s) (downcase s))
1943 (t (regexp-quote isearch-string)))))
1944 (hi-lock-face-buffer regexp (hi-lock-read-face-name)))
1945 (and isearch-recursive-edit (exit-recursive-edit)))
1948 (defun isearch-delete-char ()
1949 "Discard last input item and move point back.
1950 Last input means the last character or the last isearch command
1951 that added or deleted characters from the search string,
1952 moved point, toggled regexp mode or case-sensitivity, etc.
1953 If no previous match was done, just beep."
1955 (if (null (cdr isearch-cmds))
1957 (isearch-pop-state))
1960 (defun isearch-del-char (&optional arg)
1961 "Delete character from end of search string and search again.
1962 Unlike `isearch-delete-char', it only deletes the last character,
1963 but doesn't cancel the effect of other isearch command.
1964 If search string is empty, just beep."
1966 (if (= 0 (length isearch-string))
1968 (setq isearch-string (substring isearch-string 0
1970 (length isearch-string))))
1971 isearch-message (mapconcat 'isearch-text-char-description
1972 isearch-string "")))
1973 ;; Do the following before moving point.
1974 (funcall (or isearch-message-function #'isearch-message) nil t)
1975 ;; Use the isearch-other-end as new starting point to be able
1976 ;; to find the remaining part of the search string again.
1977 ;; This is like what `isearch-search-and-update' does,
1978 ;; but currently it doesn't support deletion of characters
1979 ;; for the case where unsuccessful search may become successful
1980 ;; by deletion of characters.
1981 (if isearch-other-end (goto-char isearch-other-end))
1983 (isearch-push-state)
1986 (defun isearch-yank-string (string)
1987 "Pull STRING into search string."
1988 ;; Downcase the string if not supposed to case-fold yanked strings.
1989 (if (and isearch-case-fold-search
1990 (eq 'not-yanks search-upper-case))
1991 (setq string (downcase string)))
1992 (if isearch-regexp (setq string (regexp-quote string)))
1993 ;; Don't move cursor in reverse search.
1994 (setq isearch-yank-flag t)
1995 (isearch-process-search-string
1996 string (mapconcat 'isearch-text-char-description string "")))
1998 (defun isearch-yank-kill ()
1999 "Pull string from kill ring into search string."
2001 (isearch-yank-string (current-kill 0)))
2003 (defun isearch-yank-pop ()
2004 "Replace just-yanked search string with previously killed string."
2006 (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop)))
2007 ;; Fall back on `isearch-yank-kill' for the benefits of people
2008 ;; who are used to the old behavior of `M-y' in isearch mode. In
2009 ;; future, this fallback may be changed if we ever change
2010 ;; `yank-pop' to do something like the kill-ring-browser.
2013 (isearch-yank-string (current-kill 1))))
2015 (defun isearch-yank-x-selection ()
2016 "Pull current X selection into search string."
2018 (isearch-yank-string (gui-get-selection))
2019 ;; If `gui-get-selection' returned the text from the active region,
2020 ;; then it "used" the mark which we should hence deactivate.
2021 (when select-active-regions (deactivate-mark)))
2024 (defun isearch-mouse-2 (click)
2025 "Handle mouse-2 in Isearch mode.
2026 For a click in the echo area, invoke `isearch-yank-x-selection'.
2027 Otherwise invoke whatever the calling mouse-2 command sequence
2028 is bound to outside of Isearch."
2030 (let* ((w (posn-window (event-start click)))
2031 (overriding-terminal-local-map nil)
2032 (binding (key-binding (this-command-keys-vector) t)))
2033 (if (and (window-minibuffer-p w)
2034 (not (minibuffer-window-active-p w))) ; in echo area
2035 (isearch-yank-x-selection)
2036 (when (functionp binding)
2037 (call-interactively binding)))))
2039 (declare-function xterm--pasted-text "term/xterm" ())
2041 (defun isearch-xterm-paste ()
2042 "Pull terminal paste into search string."
2044 (isearch-yank-string (xterm--pasted-text)))
2046 (defun isearch-yank-internal (jumpform)
2047 "Pull the text from point to the point reached by JUMPFORM.
2048 JUMPFORM is a lambda expression that takes no arguments and returns
2049 a buffer position, possibly having moved point to that position.
2050 For example, it might move point forward by a word and return point,
2051 or it might return the position of the end of the line."
2052 (isearch-yank-string
2054 (and (not isearch-forward) isearch-other-end
2055 (goto-char isearch-other-end))
2056 (buffer-substring-no-properties (point) (funcall jumpform)))))
2058 (defun isearch-yank-char-in-minibuffer (&optional arg)
2059 "Pull next character from buffer into end of search string in minibuffer."
2063 (with-current-buffer (cadr (buffer-list))
2064 (buffer-substring-no-properties
2065 (point) (progn (forward-char arg) (point)))))
2066 (forward-char arg)))
2068 (defun isearch-yank-char (&optional arg)
2069 "Pull next character from buffer into search string.
2070 If optional ARG is non-nil, pull in the next ARG characters."
2072 (isearch-yank-internal (lambda () (forward-char arg) (point))))
2074 (declare-function subword-forward "subword" (&optional arg))
2075 (defun isearch-yank-word-or-char ()
2076 "Pull next character, subword or word from buffer into search string.
2077 Subword is used when `subword-mode' is activated. "
2079 (isearch-yank-internal
2081 (if (or (= (char-syntax (or (char-after) 0)) ?w)
2082 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
2083 (if (or (and (boundp 'subword-mode) subword-mode)
2084 (and (boundp 'superword-mode) superword-mode))
2090 (defun isearch-yank-word (&optional arg)
2091 "Pull next word from buffer into search string.
2092 If optional ARG is non-nil, pull in the next ARG words."
2094 (isearch-yank-internal (lambda () (forward-word arg) (point))))
2096 (defun isearch-yank-line (&optional arg)
2097 "Pull rest of line from buffer into search string.
2098 If optional ARG is non-nil, yank the next ARG lines."
2100 (isearch-yank-internal
2101 (lambda () (let ((inhibit-field-text-motion t))
2102 (line-end-position (if (eolp) (1+ arg) arg))))))
2104 (defun isearch-char-by-name (&optional count)
2105 "Read a character by its Unicode name and add it to the search string.
2106 Completion is available like in `read-char-by-name' used by `insert-char'.
2107 With argument, add COUNT copies of the character."
2109 (with-isearch-suspended
2110 (let ((char (read-char-by-name "Add character to search (Unicode name or hex): ")))
2112 (let ((string (if (and (integerp count) (> count 1))
2113 (make-string count char)
2114 (char-to-string char))))
2115 (setq isearch-new-string (concat isearch-string string)
2116 isearch-new-message (concat isearch-message
2117 (mapconcat 'isearch-text-char-description
2120 (defun isearch-search-and-update ()
2121 ;; Do the search and update the display.
2122 (when (or isearch-success
2123 ;; Unsuccessful regexp search may become successful by
2124 ;; addition of characters which make isearch-string valid
2126 ;; If the string was found but was completely invisible,
2127 ;; it might now be partly visible, so try again.
2128 (prog1 isearch-hidden (setq isearch-hidden nil)))
2129 ;; In reverse search, adding stuff at
2130 ;; the end may cause zero or many more chars to be
2131 ;; matched, in the string following point.
2132 ;; Allow all those possibilities without moving point as
2133 ;; long as the match does not extend past search origin.
2134 (if (and (not isearch-forward) (not isearch-adjusted)
2136 (let ((case-fold-search isearch-case-fold-search))
2137 (if (and (eq case-fold-search t) search-upper-case)
2138 (setq case-fold-search
2139 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2141 ((functionp isearch-regexp-function)
2142 (funcall isearch-regexp-function isearch-string t))
2143 (isearch-regexp-function (word-search-regexp isearch-string t))
2144 (isearch-regexp isearch-string)
2145 (t (regexp-quote isearch-string)))))
2147 (or isearch-yank-flag
2149 (min isearch-opoint isearch-barrier))))
2151 (setq isearch-success t
2153 isearch-other-end (match-end 0))
2154 (if (and (eq isearch-case-fold-search t) search-upper-case)
2155 (setq isearch-case-fold-search
2156 (isearch-no-upper-case-p isearch-string isearch-regexp))))
2157 ;; Not regexp, not reverse, or no match at point.
2158 ;; Do the following before moving point.
2159 (funcall (or isearch-message-function #'isearch-message) nil t)
2160 (if (and isearch-other-end (not isearch-adjusted))
2161 (goto-char (if isearch-forward isearch-other-end
2164 (1+ isearch-other-end)))))
2167 (isearch-push-state)
2168 (if isearch-op-fun (funcall isearch-op-fun))
2172 ;; *, ?, }, and | chars can make a regexp more liberal.
2173 ;; They can make a regexp match sooner or make it succeed instead of failing.
2174 ;; So go back to place last successful search started
2175 ;; or to the last ^S/^R (barrier), whichever is nearer.
2176 ;; + needs no special handling because the string must match at least once.
2178 (defun isearch-backslash (str)
2179 "Return t if STR ends in an odd number of backslashes."
2180 (= (mod (- (length str) (string-match "\\\\*\\'" str)) 2) 1))
2182 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
2183 "Return point to previous successful match to allow regexp liberalization.
2184 \\<isearch-mode-map>
2185 Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by \
2186 stopping at `isearch-barrier' as needed.
2188 Do nothing if a backslash is escaping the liberalizing character.
2189 If WANT-BACKSLASH is non-nil, invert this behavior (for \\} and \\|).
2191 Do nothing if regexp has recently been invalid unless optional
2192 ALLOW-INVALID non-nil.
2194 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
2196 ;; (eq (not a) (not b)) makes all non-nil values equivalent
2197 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
2198 (not want-backslash))
2199 ;; We have to check 2 stack frames because the last might be
2200 ;; invalid just because of a backslash.
2201 (or (not isearch-error)
2202 (not (isearch--state-error (cadr isearch-cmds)))
2205 (progn (goto-char isearch-barrier)
2206 (setq isearch-adjusted t))
2207 (let* ((stack isearch-cmds)
2208 (previous (cdr stack)) ; lookbelow in the stack
2209 (frame (car stack)))
2210 ;; Walk down the stack looking for a valid regexp (as of course only
2211 ;; they can be the previous successful match); this conveniently
2212 ;; removes all bracket-sets and groups that might be in the way, as
2213 ;; well as partial \{\} constructs that the code below leaves behind.
2214 ;; Also skip over postfix operators -- though horrid,
2215 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
2216 (while (and previous
2217 (or (isearch--state-error frame)
2218 (let* ((string (isearch--state-string frame))
2219 (lchar (aref string (1- (length string)))))
2220 ;; The operators aren't always operators; check
2221 ;; backslashes. This doesn't handle the case of
2222 ;; operators at the beginning of the regexp not
2223 ;; being special, but then we should fall back to
2224 ;; the barrier anyway because it's all optional.
2225 (if (isearch-backslash
2226 (isearch--state-string (car previous)))
2228 (memq lchar '(?* ?? ?+))))))
2229 (setq stack previous previous (cdr previous) frame (car stack)))
2231 ;; `stack' now refers the most recent valid regexp that is not at
2232 ;; all optional in its last term. Now dig one level deeper and find
2233 ;; what matched before that.
2234 (let ((last-other-end
2235 (or (and (car previous)
2236 (isearch--state-other-end (car previous)))
2238 (goto-char (if isearch-forward
2239 (max last-other-end isearch-barrier)
2240 (min last-other-end isearch-barrier)))
2241 (setq isearch-adjusted t)))))))
2243 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2244 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
2246 ;; The idea here is that certain vertical scrolling commands (like C-l
2247 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
2248 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
2249 ;; tamper with isearch's state, or move point. It is unacceptable for the
2250 ;; search string to be scrolled out of the current window. If a command
2251 ;; attempts this, we scroll the text back again.
2253 ;; We implement this feature with a property called `isearch-scroll'.
2254 ;; If a command's symbol has the value t for this property or for the
2255 ;; `scroll-command' property, it is a scrolling command. The feature
2256 ;; needs to be enabled by setting the customizable variable
2257 ;; `isearch-allow-scroll' to a non-nil value.
2259 ;; The universal argument commands (e.g. C-u) in simple.el are marked
2260 ;; as scrolling commands, and isearch.el has been amended to allow
2261 ;; prefix arguments to be passed through to scrolling commands. Thus
2262 ;; M-0 C-l will scroll point to the top of the window.
2264 ;; Horizontal scrolling commands are currently not catered for.
2265 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2267 ;; Set the isearch-scroll property on some standard functions:
2268 ;; Scroll-bar functions:
2269 (if (fboundp 'scroll-bar-toolkit-scroll)
2270 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
2271 (if (fboundp 'w32-handle-scroll-bar-event)
2272 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
2274 ;; Commands which scroll the window (some scroll commands
2275 ;; already have the `scroll-command' property on them):
2276 (put 'recenter 'isearch-scroll t)
2277 (put 'recenter-top-bottom 'isearch-scroll t)
2278 (put 'reposition-window 'isearch-scroll t)
2280 ;; Commands which act on the other window
2281 (put 'list-buffers 'isearch-scroll t)
2282 (put 'scroll-other-window 'isearch-scroll t)
2283 (put 'scroll-other-window-down 'isearch-scroll t)
2284 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
2285 (put 'end-of-buffer-other-window 'isearch-scroll t)
2287 ;; Commands which change the window layout
2288 (put 'delete-other-windows 'isearch-scroll t)
2289 (put 'balance-windows 'isearch-scroll t)
2290 (put 'split-window-right 'isearch-scroll t)
2291 (put 'split-window-below 'isearch-scroll t)
2292 (put 'enlarge-window 'isearch-scroll t)
2294 ;; Aliases for split-window-*
2295 (put 'split-window-vertically 'isearch-scroll t)
2296 (put 'split-window-horizontally 'isearch-scroll t)
2298 ;; Universal argument commands
2299 (put 'universal-argument 'isearch-scroll t)
2300 (put 'universal-argument-more 'isearch-scroll t)
2301 (put 'negative-argument 'isearch-scroll t)
2302 (put 'digit-argument 'isearch-scroll t)
2304 (defcustom isearch-allow-scroll nil
2305 "Whether scrolling is allowed during incremental search.
2306 If non-nil, scrolling commands can be used in Isearch mode.
2307 However, the current match will never scroll offscreen.
2308 If nil, scrolling commands will first cancel Isearch mode."
2312 (defcustom isearch-allow-prefix t
2313 "Whether prefix arguments are allowed during incremental search.
2314 If non-nil, entering a prefix argument will not terminate the
2315 search. This option is ignored \(presumed t) when
2316 `isearch-allow-scroll' is set."
2321 (defun isearch-string-out-of-window (isearch-point)
2322 "Test whether the search string is currently outside of the window.
2323 Return nil if it's completely visible, or if point is visible,
2324 together with as much of the search string as will fit; the symbol
2325 `above' if we need to scroll the text downwards; the symbol `below',
2327 (let ((w-start (window-group-start))
2328 (w-end (window-group-end nil t))
2329 (w-L1 (save-excursion
2330 (save-selected-window (move-to-window-group-line 1) (point))))
2331 (w-L-1 (save-excursion
2332 (save-selected-window (move-to-window-group-line -1) (point))))
2333 start end) ; start and end of search string in buffer
2335 (setq end isearch-point start (or isearch-other-end isearch-point))
2336 (setq start isearch-point end (or isearch-other-end isearch-point)))
2337 (cond ((or (and (>= start w-start) (<= end w-end))
2339 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
2340 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
2342 ((and (< start w-start)
2343 (< isearch-point w-L-1))
2347 (defun isearch-back-into-window (above isearch-point)
2348 "Scroll the window to bring the search string back into view.
2349 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
2350 search string is above the top of the window, nil when it is beneath
2354 (setq end isearch-point start (or isearch-other-end isearch-point))
2355 (setq start isearch-point end (or isearch-other-end isearch-point)))
2359 (recenter-window-group 0)
2360 (when (>= isearch-point (window-group-end nil t))
2361 (goto-char isearch-point)
2362 (recenter-window-group -1)))
2364 (recenter-window-group -1)
2365 (when (< isearch-point (window-group-start))
2366 (goto-char isearch-point)
2367 (recenter-window-group 0))))
2368 (goto-char isearch-point))
2370 (defvar isearch-pre-scroll-point nil)
2372 (defun isearch-pre-command-hook ()
2373 "Decide whether to exit Isearch mode before executing the command.
2374 Don't exit Isearch if the key sequence that invoked this command
2375 is bound in `isearch-mode-map', or if the invoked command is
2376 a prefix argument command (when `isearch-allow-prefix' is non-nil),
2377 or it is a scrolling command (when `isearch-allow-scroll' is non-nil).
2378 Otherwise, exit Isearch (when `search-exit-option' is non-nil)
2379 before the command is executed globally with terminated Isearch."
2380 (let* ((key (this-single-command-keys))
2381 (main-event (aref key 0)))
2383 ;; Don't exit Isearch if we're in the middle of some
2384 ;; `set-transient-map' thingy like `universal-argument--mode'.
2385 ((not (eq overriding-terminal-local-map isearch--saved-overriding-local-map)))
2386 ;; Don't exit Isearch for isearch key bindings.
2387 ((commandp (lookup-key isearch-mode-map key nil)))
2388 ;; Optionally edit the search string instead of exiting.
2389 ((eq search-exit-option 'edit)
2390 (setq this-command 'isearch-edit-string))
2391 ;; Handle a scrolling function or prefix argument.
2392 ((or (and isearch-allow-prefix
2393 (memq this-command '(universal-argument universal-argument-more
2394 digit-argument negative-argument)))
2395 (and isearch-allow-scroll
2396 (symbolp this-command)
2397 (or (eq (get this-command 'isearch-scroll) t)
2398 (eq (get this-command 'scroll-command) t))))
2399 (when isearch-allow-scroll
2400 (setq isearch-pre-scroll-point (point))))
2401 ;; A mouse click on the isearch message starts editing the search string.
2402 ((and (eq (car-safe main-event) 'down-mouse-1)
2403 (window-minibuffer-p (posn-window (event-start main-event))))
2404 ;; Swallow the up-event.
2406 (setq this-command 'isearch-edit-string))
2407 ;; Other characters terminate the search and are then executed normally.
2410 (isearch-clean-overlays))
2411 ;; If search-exit-option is nil, run the command without exiting Isearch.
2413 (isearch-process-search-string key key)))))
2415 (defun isearch-post-command-hook ()
2416 (when isearch-pre-scroll-point
2417 (let ((ab-bel (isearch-string-out-of-window isearch-pre-scroll-point)))
2419 (isearch-back-into-window (eq ab-bel 'above) isearch-pre-scroll-point)
2420 (goto-char isearch-pre-scroll-point)))
2421 (setq isearch-pre-scroll-point nil)
2424 (defun isearch-quote-char (&optional count)
2425 "Quote special characters for incremental search.
2426 With argument, add COUNT copies of the character."
2428 (let ((char (read-quoted-char (isearch-message t))))
2429 (unless (characterp char)
2430 (user-error "%s is not a valid character"
2431 (key-description (vector char))))
2432 ;; Assume character codes 0200 - 0377 stand for characters in some
2433 ;; single-byte character set, and convert them to Emacs
2435 (if (and isearch-regexp isearch-regexp-lax-whitespace (= char ?\s))
2436 (if (subregexp-context-p isearch-string (length isearch-string))
2437 (isearch-process-search-string "[ ]" " ")
2438 (isearch-process-search-char char count))
2439 ;; This used to assume character codes 0240 - 0377 stand for
2440 ;; characters in some single-byte character set, and converted them
2441 ;; to Emacs characters. But in 23.1 this feature is deprecated
2442 ;; in favor of inserting the corresponding Unicode characters.
2443 ;; (and enable-multibyte-characters
2446 ;; (setq char (unibyte-char-to-multibyte char)))
2447 (isearch-process-search-char char count))))
2449 (defun isearch-printing-char (&optional char count)
2450 "Add this ordinary printing CHAR to the search string and search.
2451 With argument, add COUNT copies of the character."
2452 (interactive (list last-command-event
2453 (prefix-numeric-value current-prefix-arg)))
2454 (let ((char (or char last-command-event)))
2457 (if current-input-method
2458 (isearch-process-search-multibyte-characters char count)
2459 (isearch-process-search-char char count))))
2461 (defun isearch-process-search-char (char &optional count)
2462 "Add CHAR to the search string, COUNT times.
2463 Search is updated accordingly."
2464 ;; * and ? are special in regexps when not preceded by \.
2465 ;; } and | are special in regexps when preceded by \.
2466 ;; Nothing special for + because it matches at least once.
2468 ((memq char '(?* ??)) (isearch-fallback nil))
2469 ((eq char ?\}) (isearch-fallback t t))
2470 ((eq char ?|) (isearch-fallback t nil t)))
2472 ;; Append the char(s) to the search string,
2473 ;; update the message and re-search.
2474 (let* ((string (if (and (integerp count) (> count 1))
2475 (make-string count char)
2476 (char-to-string char)))
2477 (message (if (>= char ?\200)
2479 (mapconcat 'isearch-text-char-description string ""))))
2480 (isearch-process-search-string string message)))
2482 (defun isearch-process-search-string (string message)
2483 (setq isearch-string (concat isearch-string string)
2484 isearch-message (concat isearch-message message))
2485 (isearch-search-and-update))
2490 (defun isearch-ring-adjust1 (advance)
2491 ;; Helper for isearch-ring-adjust
2492 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2493 (length (length ring))
2494 (yank-pointer-name (if isearch-regexp
2495 'regexp-search-ring-yank-pointer
2496 'search-ring-yank-pointer))
2497 (yank-pointer (eval yank-pointer-name)))
2500 (set yank-pointer-name
2502 (mod (+ (or yank-pointer (if advance 0 -1))
2505 (setq isearch-string (nth yank-pointer ring)
2506 isearch-message (mapconcat 'isearch-text-char-description
2507 isearch-string "")))))
2509 (defun isearch-ring-adjust (advance)
2510 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2511 (isearch-ring-adjust1 advance)
2512 (if search-ring-update
2514 (funcall (or isearch-message-function #'isearch-message) nil t)
2516 (isearch-push-state)
2518 ;; Otherwise, edit the search string instead. Note that there is
2519 ;; no need to push the search state after isearch-edit-string here
2520 ;; since isearch-edit-string already pushes its state
2521 (isearch-edit-string)))
2523 (defun isearch-ring-advance ()
2524 "Advance to the next search string in the ring."
2525 ;; This could be more general to handle a prefix arg, but who would use it.
2527 (isearch-ring-adjust 'advance))
2529 (defun isearch-ring-retreat ()
2530 "Retreat to the previous search string in the ring."
2532 (isearch-ring-adjust nil))
2534 (defun isearch-complete1 ()
2535 ;; Helper for isearch-complete and isearch-complete-edit
2536 ;; Return t if completion OK, nil if no completion exists.
2537 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2538 (completion-ignore-case case-fold-search)
2539 (completion (try-completion isearch-string ring)))
2542 ;; isearch-string stays the same
2544 ((or completion ; not nil, must be a string
2545 (= 0 (length isearch-string))) ; shouldn't have to say this
2546 (if (equal completion isearch-string) ;; no extension?
2548 (if completion-auto-help
2549 (with-output-to-temp-buffer "*Isearch completions*"
2550 (display-completion-list
2551 (all-completions isearch-string ring))))
2554 (setq isearch-string completion))))
2556 (message "No completion") ; waits a second if in minibuffer
2559 (defun isearch-complete ()
2560 "Complete the search string from the strings on the search ring.
2561 The completed string is then editable in the minibuffer.
2562 If there is no completion possible, say so and continue searching."
2564 (if (isearch-complete1)
2565 (progn (setq isearch-message
2566 (mapconcat 'isearch-text-char-description
2568 (isearch-edit-string))
2573 (defun isearch-complete-edit ()
2574 "Same as `isearch-complete' except in the minibuffer."
2576 (setq isearch-string (field-string))
2577 (if (isearch-complete1)
2580 (insert isearch-string))))
2585 (defun isearch-message (&optional c-q-hack ellipsis)
2586 ;; Generate and print the message string.
2588 ;; N.B.: This function should always be called with point at the
2589 ;; search point, because in certain (rare) circumstances, undesired
2590 ;; scrolling can happen when point is elsewhere. These
2591 ;; circumstances are when follow-mode is active, the search string
2592 ;; spans two (or several) windows, and the message about to be
2593 ;; displayed will cause the echo area to expand.
2594 (let ((cursor-in-echo-area ellipsis)
2596 (fail-pos (isearch-fail-pos t)))
2597 ;; Highlight failed part
2599 (setq m (copy-sequence m))
2600 (add-text-properties fail-pos (length m) '(face isearch-fail) m)
2601 ;; Highlight failed trailing whitespace
2602 (when (string-match " +$" m)
2603 (add-text-properties (match-beginning 0) (match-end 0)
2604 '(face trailing-whitespace) m)))
2606 (isearch-message-prefix ellipsis isearch-nonincremental)
2608 (isearch-message-suffix c-q-hack)))
2609 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2611 (defun isearch--describe-regexp-mode (regexp-function &optional space-before)
2612 "Make a string for describing REGEXP-FUNCTION.
2613 If SPACE-BEFORE is non-nil, put a space before, instead of after,
2615 (when (eq regexp-function t)
2616 (setq regexp-function #'word-search-regexp))
2619 ;; 1. Do not use a description on the default search mode,
2620 ;; but only if the default search mode is non-nil.
2621 ((or (and search-default-mode
2622 (equal search-default-mode regexp-function))
2623 ;; Special case where `search-default-mode' is t
2624 ;; (defaults to regexp searches).
2625 (and (eq search-default-mode t)
2626 (eq search-default-mode isearch-regexp))) "")
2627 ;; 2. Use the `isearch-message-prefix' set for
2628 ;; `regexp-function' if available.
2630 (and (symbolp regexp-function)
2631 (or (get regexp-function 'isearch-message-prefix)
2633 ;; 3. Else if `isearch-regexp' is non-nil, set description
2635 (isearch-regexp "regexp ")
2636 ;; 4. Else if we're in literal mode (and if the default
2637 ;; mode is also not literal), describe it.
2638 ((functionp search-default-mode) "literal ")
2639 ;; 5. And finally, if none of the above is true, set the
2640 ;; description to an empty string.
2643 ;; Move space from the end to the beginning.
2644 (replace-regexp-in-string "\\(.*\\) \\'" " \\1" description)
2646 (define-obsolete-function-alias 'isearch--describe-word-mode
2647 'isearch--describe-regexp-mode "25.1")
2649 (defun isearch-message-prefix (&optional ellipsis nonincremental)
2650 ;; If about to search, and previous search regexp was invalid,
2651 ;; check that it still is. If it is valid now,
2652 ;; let the message we display while searching say that it is valid.
2653 (and isearch-error ellipsis
2655 (progn (re-search-forward isearch-string (point) t)
2656 (setq isearch-error nil))
2658 ;; If currently failing, display no ellipsis.
2659 (or isearch-success (setq ellipsis nil))
2660 (let ((m (concat (if isearch-success "" "failing ")
2661 (if isearch-adjusted "pending " "")
2662 (if (and isearch-wrapped
2663 (not isearch-wrap-function)
2665 (> (point) isearch-opoint)
2666 (< (point) isearch-opoint)))
2668 (if isearch-wrapped "wrapped ")
2670 (advice-function-mapc
2672 (let ((np (cdr (assq 'isearch-message-prefix props))))
2673 (if np (setq prefix (concat np prefix)))))
2674 isearch-filter-predicate)
2676 (isearch--describe-regexp-mode isearch-regexp-function)
2678 (multi-isearch-file-list "multi-file ")
2679 (multi-isearch-buffer-list "multi-buffer ")
2681 (or isearch-message-prefix-add "")
2682 (if nonincremental "search" "I-search")
2683 (if isearch-forward "" " backward")
2684 (if current-input-method
2685 ;; Input methods for RTL languages use RTL
2686 ;; characters for their title, and that messes
2687 ;; up the display of search text after the prompt.
2688 (bidi-string-mark-left-to-right
2689 (concat " [" current-input-method-title "]: "))
2692 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2693 'face 'minibuffer-prompt)))
2695 (defun isearch-message-suffix (&optional c-q-hack)
2696 (concat (if c-q-hack "^Q" "")
2698 (concat " [" isearch-error "]")
2700 (or isearch-message-suffix-add "")))
2705 (defvar isearch-search-fun-function 'isearch-search-fun-default
2706 "Non-default value overrides the behavior of `isearch-search-fun-default'.
2707 This variable's value should be a function, which will be called
2708 with no arguments, and should return a function that takes three
2709 arguments: STRING, BOUND, and NOERROR. STRING is the string to
2710 be searched for. See `re-search-forward' for the meaning of
2711 BOUND and NOERROR arguments.
2713 This returned function will be used by `isearch-search-string' to
2714 search for the first occurrence of STRING.")
2716 (defun isearch-search-fun ()
2717 "Return the function to use for the search.
2718 Can be changed via `isearch-search-fun-function' for special needs."
2719 (funcall (or isearch-search-fun-function 'isearch-search-fun-default)))
2721 (defun isearch--lax-regexp-function-p ()
2722 "Non-nil if next regexp-function call should be lax."
2723 (not (or isearch-nonincremental
2724 (null (car isearch-cmds))
2725 (eq (length isearch-string)
2726 (length (isearch--state-string
2727 (car isearch-cmds)))))))
2729 (defun isearch-search-fun-default ()
2730 "Return default functions to use for the search."
2731 (lambda (string &optional bound noerror count)
2732 ;; Use lax versions to not fail at the end of the word while
2733 ;; the user adds and removes characters in the search string
2734 ;; (or when using nonincremental word isearch)
2735 (let ((search-spaces-regexp (when (cond
2736 (isearch-regexp isearch-regexp-lax-whitespace)
2737 (t isearch-lax-whitespace))
2738 search-whitespace-regexp)))
2741 (if isearch-forward #'re-search-forward #'re-search-backward)
2742 (cond (isearch-regexp-function
2743 (let ((lax (isearch--lax-regexp-function-p)))
2744 (if (functionp isearch-regexp-function)
2745 (funcall isearch-regexp-function string lax)
2746 (word-search-regexp string lax))))
2747 (isearch-regexp string)
2748 (t (regexp-quote string)))
2749 bound noerror count)
2752 (let ((prefix (get isearch-regexp-function 'isearch-message-prefix)))
2753 (if (and isearch-regexp-function (stringp prefix))
2754 (list (format "%s [using %ssearch]" string prefix))
2757 (defun isearch-search-string (string bound noerror)
2758 "Search for the first occurrence of STRING or its translation.
2759 STRING's characters are translated using `translation-table-for-input'
2761 If found, move point to the end of the occurrence,
2762 update the match data, and return point.
2763 An optional second argument bounds the search; it is a buffer position.
2764 The match found must not extend after that position.
2765 Optional third argument, if t, means if fail just return nil (no error).
2766 If not nil and not t, move to limit of search and return nil."
2767 (let* ((func (isearch-search-fun))
2768 (pos1 (save-excursion (funcall func string bound noerror)))
2771 ;; Avoid "obsolete" warnings for translation-table-for-input.
2773 (char-table-p translation-table-for-input))
2774 (multibyte-string-p string)
2775 ;; Minor optimization.
2776 (string-match-p "[^[:ascii:]]" string))
2781 ;; Avoid "obsolete" warnings for
2782 ;; translation-table-for-input.
2784 (aref translation-table-for-input c))
2791 (if (setq pos2 (funcall func translated bound noerror))
2792 (setq match-data (match-data t)))))
2795 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2797 (set-match-data match-data)))))
2799 ;; When using multiple buffers isearch, switch to the new buffer here,
2800 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2801 (if (and multi-isearch-next-buffer-current-function
2802 (buffer-live-p multi-isearch-current-buffer))
2803 (switch-to-buffer multi-isearch-current-buffer))
2807 (defun isearch-search ()
2808 ;; Do the search with the current search string.
2809 (if (and (eq isearch-case-fold-search t) search-upper-case)
2810 (setq isearch-case-fold-search
2811 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2812 (condition-case lossage
2813 (let ((inhibit-point-motion-hooks isearch-invisible)
2815 (case-fold-search isearch-case-fold-search)
2816 (search-invisible isearch-invisible)
2818 (setq isearch-error nil)
2820 (setq isearch-success
2821 (isearch-search-string isearch-string nil t))
2822 ;; Clear RETRY unless the search predicate says
2823 ;; to skip this search hit.
2824 (if (or (not isearch-success)
2826 (= (match-beginning 0) (match-end 0))
2827 (funcall isearch-filter-predicate
2828 (match-beginning 0) (match-end 0)))
2830 (setq isearch-just-started nil)
2832 (setq isearch-other-end
2833 (if isearch-forward (match-beginning 0) (match-end 0)))))
2835 (quit (isearch-unread ?\C-g)
2836 (setq isearch-success nil))
2839 (setq isearch-error (car (cdr lossage)))
2842 "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
2844 (setq isearch-error "incomplete input"))
2845 ((and (not isearch-regexp)
2846 (string-match "\\`Regular expression too big" isearch-error))
2848 (isearch-regexp-function
2849 (setq isearch-error "Too many words"))
2850 ((and isearch-lax-whitespace search-whitespace-regexp)
2851 (setq isearch-error "Too many spaces for whitespace matching"))))))
2854 (setq isearch-success nil)
2855 (setq isearch-error (nth 2 lossage)))
2858 ;; stack overflow in regexp search.
2859 (setq isearch-error (format "%s" lossage))))
2863 ;; Ding if failed this time after succeeding last time.
2864 (and (isearch--state-success (car isearch-cmds))
2866 (if (functionp (isearch--state-pop-fun (car isearch-cmds)))
2867 (funcall (isearch--state-pop-fun (car isearch-cmds))
2868 (car isearch-cmds)))
2869 (goto-char (isearch--state-point (car isearch-cmds)))))
2872 ;; Called when opening an overlay, and we are still in isearch.
2873 (defun isearch-open-overlay-temporary (ov)
2874 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2875 ;; Some modes would want to open the overlays temporary during
2876 ;; isearch in their own way, they should set the
2877 ;; `isearch-open-invisible-temporary' to a function doing this.
2878 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2879 ;; Store the values for the `invisible' property, and then set it to nil.
2880 ;; This way the text hidden by this overlay becomes visible.
2882 ;; In 19.34 this does not exist so I cannot test it.
2883 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2884 (overlay-put ov 'invisible nil)))
2887 ;; This is called at the end of isearch. It will open the overlays
2888 ;; that contain the latest match. Obviously in case of a C-g the
2889 ;; point returns to the original location which surely is not contain
2890 ;; in any of these overlays, se we are safe in this case too.
2891 (defun isearch-open-necessary-overlays (ov)
2892 (let ((inside-overlay (and (> (point) (overlay-start ov))
2893 (<= (point) (overlay-end ov))))
2894 ;; If this exists it means that the overlay was opened using
2895 ;; this function, not by us tweaking the overlay properties.
2896 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2897 (when (or inside-overlay (not fct-temp))
2898 ;; restore the values for the `invisible' properties.
2899 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2900 (overlay-put ov 'isearch-invisible nil))
2902 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2904 (funcall fct-temp ov t)))))
2906 ;; This is called when exiting isearch. It closes the temporary
2907 ;; opened overlays, except the ones that contain the latest match.
2908 (defun isearch-clean-overlays ()
2909 (when isearch-opened-overlays
2910 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2911 (setq isearch-opened-overlays nil)))
2914 (defun isearch-intersects-p (start0 end0 start1 end1)
2915 "Return t if regions START0..END0 and START1..END1 intersect."
2916 (or (and (>= start0 start1) (< start0 end1))
2917 (and (> end0 start1) (<= end0 end1))
2918 (and (>= start1 start0) (< start1 end0))
2919 (and (> end1 start0) (<= end1 end0))))
2922 ;; Verify if the current match is outside of each element of
2923 ;; `isearch-opened-overlays', if so close that overlay.
2925 (defun isearch-close-unnecessary-overlays (begin end)
2926 (let ((overlays isearch-opened-overlays))
2927 (setq isearch-opened-overlays nil)
2928 (dolist (ov overlays)
2929 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2930 (push ov isearch-opened-overlays)
2931 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2933 ;; If this exists it means that the overlay was opened
2934 ;; using this function, not by us tweaking the overlay
2936 (funcall fct-temp ov t)
2937 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2938 (overlay-put ov 'isearch-invisible nil)))))))
2941 (defun isearch-range-invisible (beg end)
2942 "Return t if all the text from BEG to END is invisible."
2944 ;; Check that invisibility runs up to END.
2947 (let (;; can-be-opened keeps track if we can open some overlays.
2948 (can-be-opened (eq search-invisible 'open))
2949 ;; the list of overlays that could be opened
2951 (when (and can-be-opened isearch-hide-immediately)
2952 (isearch-close-unnecessary-overlays beg end))
2953 ;; If the following character is currently invisible,
2954 ;; skip all characters with that same `invisible' property value.
2955 ;; Do that over and over.
2956 (while (and (< (point) end) (invisible-p (point)))
2957 (if (invisible-p (get-text-property (point) 'invisible))
2959 (goto-char (next-single-property-change (point) 'invisible
2961 ;; if text is hidden by an `invisible' text property
2962 ;; we cannot open it at all.
2963 (setq can-be-opened nil))
2965 (let ((overlays (overlays-at (point)))
2970 (setq o (car overlays)
2971 invis-prop (overlay-get o 'invisible))
2972 (if (invisible-p invis-prop)
2973 (if (overlay-get o 'isearch-open-invisible)
2974 (setq ov-list (cons o ov-list))
2975 ;; We found one overlay that cannot be
2976 ;; opened, that means the whole chunk
2977 ;; cannot be opened.
2978 (setq can-be-opened nil)))
2979 (setq overlays (cdr overlays)))
2981 ;; It makes sense to append to the open
2982 ;; overlays list only if we know that this is
2984 (setq crt-overlays (append ov-list crt-overlays)))))
2985 (goto-char (next-overlay-change (point)))))
2986 ;; See if invisibility reaches up thru END.
2987 (if (>= (point) end)
2988 (if (and can-be-opened (consp crt-overlays))
2990 (setq isearch-opened-overlays
2991 (append isearch-opened-overlays crt-overlays))
2992 (mapc 'isearch-open-overlay-temporary crt-overlays)
2994 (setq isearch-hidden t)))))))
2996 (defun isearch-filter-visible (beg end)
2997 "Test whether the current search hit is visible at least partially.
2998 Return non-nil if the text from BEG to END is visible to Isearch as
2999 determined by `isearch-range-invisible' unless invisible text can be
3000 searched too when `search-invisible' is t."
3001 (or (eq search-invisible t)
3002 (not (isearch-range-invisible beg end))))
3005 ;; General utilities
3007 (defun isearch-no-upper-case-p (string regexp-flag)
3008 "Return t if there are no upper case chars in STRING.
3009 If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
3010 since they have special meaning in a regexp."
3011 (let (quote-flag (i 0) (len (length string)) found)
3012 (while (and (not found) (< i len))
3013 (let ((char (aref string i)))
3014 (if (and regexp-flag (eq char ?\\))
3015 (setq quote-flag (not quote-flag))
3016 (if (and (not quote-flag) (not (eq char (downcase char))))
3018 (setq quote-flag nil)))
3021 ;; Even if there's no uppercase char, we want to detect the use
3022 ;; of [:upper:] or [:lower:] char-class, which indicates
3023 ;; clearly that the user cares about case distinction.
3024 (and regexp-flag (string-match "\\[:\\(upp\\|low\\)er:]" string)
3027 (string-match (substring string 0 (match-beginning 0))
3031 (equal "Unmatched [ or [^" (cadr err)))))))))
3033 ;; Portability functions to support various Emacs versions.
3035 (defun isearch-text-char-description (c)
3037 ((< c ?\s) (propertize
3039 'display (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph)))
3040 ((= c ?\^?) (propertize
3042 'display (propertize "^?" 'face 'escape-glyph)))
3043 (t (char-to-string c))))
3045 ;; General function to unread characters or events.
3046 ;; Also insert them in a keyboard macro being defined.
3047 (defun isearch-unread (&rest char-or-events)
3048 (mapc 'store-kbd-macro-event char-or-events)
3049 (setq unread-command-events
3050 (append char-or-events unread-command-events)))
3055 (defvar isearch-overlay nil)
3057 (defun isearch-highlight (beg end)
3058 (if search-highlight
3060 ;; Overlay already exists, just move it.
3061 (move-overlay isearch-overlay beg end (current-buffer))
3062 ;; Overlay doesn't exist, create it.
3063 (setq isearch-overlay (make-overlay beg end))
3064 ;; 1001 is higher than lazy's 1000 and ediff's 100+
3065 (overlay-put isearch-overlay 'priority 1001)
3066 (overlay-put isearch-overlay 'face isearch-face))))
3068 (defun isearch-dehighlight ()
3069 (when isearch-overlay
3070 (delete-overlay isearch-overlay)))
3072 ;; isearch-lazy-highlight feature
3073 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
3075 ;; When active, *every* match for the current search string is
3076 ;; highlighted: the current one using the normal isearch match color
3077 ;; and all the others using `isearch-lazy-highlight'. The extra
3078 ;; highlighting makes it easier to anticipate where the cursor will
3079 ;; land each time you press C-s or C-r to repeat a pending search.
3080 ;; Highlighting of these additional matches happens in a deferred
3081 ;; fashion using "idle timers," so the cycles needed do not rob
3082 ;; isearch of its usual snappy response.
3084 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
3086 ;; - `isearch-update' is expected to be called (at least) every time
3087 ;; the search string or window-start changes;
3088 ;; - `isearch-string' is expected to contain the current search
3089 ;; string as entered by the user;
3090 ;; - the type of the current search is expected to be given by
3091 ;; `isearch-regexp-function' and `isearch-regexp';
3092 ;; - the direction of the current search is expected to be given by
3093 ;; `isearch-forward';
3094 ;; - the variable `isearch-error' is expected to be true
3095 ;; only if `isearch-string' is an invalid regexp.
3097 (defvar isearch-lazy-highlight-overlays nil)
3098 (defvar isearch-lazy-highlight-wrapped nil)
3099 (defvar isearch-lazy-highlight-start-limit nil)
3100 (defvar isearch-lazy-highlight-end-limit nil)
3101 (defvar isearch-lazy-highlight-start nil)
3102 (defvar isearch-lazy-highlight-end nil)
3103 (defvar isearch-lazy-highlight-timer nil)
3104 (defvar isearch-lazy-highlight-last-string nil)
3105 (defvar isearch-lazy-highlight-window nil)
3106 (defvar isearch-lazy-highlight-window-group nil)
3107 (defvar isearch-lazy-highlight-window-start nil)
3108 (defvar isearch-lazy-highlight-window-end nil)
3109 (defvar isearch-lazy-highlight-case-fold-search nil)
3110 (defvar isearch-lazy-highlight-regexp nil)
3111 (defvar isearch-lazy-highlight-lax-whitespace nil)
3112 (defvar isearch-lazy-highlight-regexp-lax-whitespace nil)
3113 (defvar isearch-lazy-highlight-regexp-function nil)
3114 (define-obsolete-variable-alias 'isearch-lazy-highlight-word
3115 'isearch-lazy-highlight-regexp-function "25.1")
3116 (defvar isearch-lazy-highlight-forward nil)
3117 (defvar isearch-lazy-highlight-error nil)
3119 (defun lazy-highlight-cleanup (&optional force)
3120 "Stop lazy highlighting and remove extra highlighting from current buffer.
3121 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
3122 is nil. This function is called when exiting an incremental search if
3123 `lazy-highlight-cleanup' is non-nil."
3125 (if (or force lazy-highlight-cleanup)
3126 (while isearch-lazy-highlight-overlays
3127 (delete-overlay (car isearch-lazy-highlight-overlays))
3128 (setq isearch-lazy-highlight-overlays
3129 (cdr isearch-lazy-highlight-overlays))))
3130 (when isearch-lazy-highlight-timer
3131 (cancel-timer isearch-lazy-highlight-timer)
3132 (setq isearch-lazy-highlight-timer nil)))
3134 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
3135 'lazy-highlight-cleanup
3138 (defun isearch-lazy-highlight-new-loop (&optional beg end)
3139 "Cleanup any previous `lazy-highlight' loop and begin a new one.
3140 BEG and END specify the bounds within which highlighting should occur.
3141 This is called when `isearch-update' is invoked (which can cause the
3142 search string to change or the window to scroll). It is also used
3143 by other Emacs features."
3144 (when (and (null executing-kbd-macro)
3145 (sit-for 0) ;make sure (window-start) is credible
3146 (or (not (equal isearch-string
3147 isearch-lazy-highlight-last-string))
3148 (not (memq (selected-window)
3149 isearch-lazy-highlight-window-group))
3150 (not (eq isearch-lazy-highlight-case-fold-search
3151 isearch-case-fold-search))
3152 (not (eq isearch-lazy-highlight-regexp
3154 (not (eq isearch-lazy-highlight-regexp-function
3155 isearch-regexp-function))
3156 (not (eq isearch-lazy-highlight-lax-whitespace
3157 isearch-lax-whitespace))
3158 (not (eq isearch-lazy-highlight-regexp-lax-whitespace
3159 isearch-regexp-lax-whitespace))
3160 (not (= (window-group-start)
3161 isearch-lazy-highlight-window-start))
3162 (not (= (window-group-end) ; Window may have been split/joined.
3163 isearch-lazy-highlight-window-end))
3164 (not (eq isearch-forward
3165 isearch-lazy-highlight-forward))
3166 ;; In case we are recovering from an error.
3167 (not (equal isearch-error
3168 isearch-lazy-highlight-error))))
3169 ;; something important did indeed change
3170 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
3171 (setq isearch-lazy-highlight-error isearch-error)
3172 ;; It used to check for `(not isearch-error)' here, but actually
3173 ;; lazy-highlighting might find matches to highlight even when
3174 ;; `isearch-error' is non-nil. (Bug#9918)
3175 (setq isearch-lazy-highlight-start-limit beg
3176 isearch-lazy-highlight-end-limit end)
3177 (setq isearch-lazy-highlight-window (selected-window)
3178 isearch-lazy-highlight-window-group (selected-window-group)
3179 isearch-lazy-highlight-window-start (window-group-start)
3180 isearch-lazy-highlight-window-end (window-group-end)
3181 ;; Start lazy-highlighting at the beginning of the found
3182 ;; match (`isearch-other-end'). If no match, use point.
3183 ;; One of the next two variables (depending on search direction)
3184 ;; is used to define the starting position of lazy-highlighting
3185 ;; and also to remember the current position of point between
3186 ;; calls of `isearch-lazy-highlight-update', and another variable
3187 ;; is used to define where the wrapped search must stop.
3188 isearch-lazy-highlight-start (or isearch-other-end (point))
3189 isearch-lazy-highlight-end (or isearch-other-end (point))
3190 isearch-lazy-highlight-wrapped nil
3191 isearch-lazy-highlight-last-string isearch-string
3192 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
3193 isearch-lazy-highlight-regexp isearch-regexp
3194 isearch-lazy-highlight-lax-whitespace isearch-lax-whitespace
3195 isearch-lazy-highlight-regexp-lax-whitespace isearch-regexp-lax-whitespace
3196 isearch-lazy-highlight-regexp-function isearch-regexp-function
3197 isearch-lazy-highlight-forward isearch-forward)
3198 (unless (equal isearch-string "")
3199 (setq isearch-lazy-highlight-timer
3200 (run-with-idle-timer lazy-highlight-initial-delay nil
3201 'isearch-lazy-highlight-update)))))
3203 (defun isearch-lazy-highlight-search ()
3204 "Search ahead for the next or previous match, for lazy highlighting.
3205 Attempt to do the search exactly the way the pending Isearch would."
3207 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
3208 (isearch-regexp isearch-lazy-highlight-regexp)
3209 (isearch-regexp-function isearch-lazy-highlight-regexp-function)
3210 (isearch-lax-whitespace
3211 isearch-lazy-highlight-lax-whitespace)
3212 (isearch-regexp-lax-whitespace
3213 isearch-lazy-highlight-regexp-lax-whitespace)
3214 (isearch-forward isearch-lazy-highlight-forward)
3215 (search-invisible nil) ; don't match invisible text
3218 (bound (if isearch-lazy-highlight-forward
3219 (min (or isearch-lazy-highlight-end-limit (point-max))
3220 (if isearch-lazy-highlight-wrapped
3221 (+ isearch-lazy-highlight-start
3222 ;; Extend bound to match whole string at point
3223 (1- (length isearch-lazy-highlight-last-string)))
3224 (window-group-end)))
3225 (max (or isearch-lazy-highlight-start-limit (point-min))
3226 (if isearch-lazy-highlight-wrapped
3227 (- isearch-lazy-highlight-end
3228 ;; Extend bound to match whole string at point
3229 (1- (length isearch-lazy-highlight-last-string)))
3230 (window-group-start))))))
3231 ;; Use a loop like in `isearch-search'.
3233 (setq success (isearch-search-string
3234 isearch-lazy-highlight-last-string bound t))
3235 ;; Clear RETRY unless the search predicate says
3236 ;; to skip this search hit.
3237 (if (or (not success)
3238 (= (point) bound) ; like (bobp) (eobp) in `isearch-search'.
3239 (= (match-beginning 0) (match-end 0))
3240 (funcall isearch-filter-predicate
3241 (match-beginning 0) (match-end 0)))
3246 (defun isearch-lazy-highlight-update ()
3247 "Update highlighting of other matches for current search."
3248 (let ((max lazy-highlight-max-at-a-time)
3252 (save-selected-window
3253 (if (and (window-live-p isearch-lazy-highlight-window)
3254 (not (memq (selected-window) isearch-lazy-highlight-window-group)))
3255 (select-window isearch-lazy-highlight-window))
3258 (goto-char (if isearch-lazy-highlight-forward
3259 isearch-lazy-highlight-end
3260 isearch-lazy-highlight-start))
3262 (let ((found (isearch-lazy-highlight-search)))
3266 (setq looping nil)))
3268 (let ((mb (match-beginning 0))
3270 (if (= mb me) ;zero-length match
3271 (if isearch-lazy-highlight-forward
3272 (if (= mb (if isearch-lazy-highlight-wrapped
3273 isearch-lazy-highlight-start
3274 (window-group-end)))
3277 (if (= mb (if isearch-lazy-highlight-wrapped
3278 isearch-lazy-highlight-end
3279 (window-group-start)))
3283 ;; non-zero-length match
3284 (let ((ov (make-overlay mb me)))
3285 (push ov isearch-lazy-highlight-overlays)
3286 ;; 1000 is higher than ediff's 100+,
3287 ;; but lower than isearch main overlay's 1001
3288 (overlay-put ov 'priority 1000)
3289 (overlay-put ov 'face 'lazy-highlight)))
3290 ;(overlay-put ov 'window (selected-window))))
3291 ;; Remember the current position of point for
3292 ;; the next call of `isearch-lazy-highlight-update'
3293 ;; when `lazy-highlight-max-at-a-time' is too small.
3294 (if isearch-lazy-highlight-forward
3295 (setq isearch-lazy-highlight-end (point))
3296 (setq isearch-lazy-highlight-start (point)))))
3298 ;; not found or zero-length match at the search bound
3300 (if isearch-lazy-highlight-wrapped
3303 (setq isearch-lazy-highlight-wrapped t)
3304 (if isearch-lazy-highlight-forward
3306 (setq isearch-lazy-highlight-end (window-group-start))
3307 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
3308 (window-group-start))))
3309 (setq isearch-lazy-highlight-start (window-group-end))
3310 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
3311 (window-group-end))))))))
3313 (setq isearch-lazy-highlight-timer
3314 (run-at-time lazy-highlight-interval nil
3315 'isearch-lazy-highlight-update)))))))))
3317 (defun isearch-resume (string regexp word forward message case-fold)
3318 "Resume an incremental search.
3319 STRING is the string or regexp searched for.
3320 REGEXP non-nil means the resumed search was a regexp search.
3321 WORD non-nil means resume a word search.
3322 FORWARD non-nil means resume a forward search.
3323 MESSAGE is the echo-area message recorded for the search resumed.
3324 CASE-FOLD non-nil means the search was case-insensitive."
3325 (isearch-mode forward regexp nil nil word)
3326 (setq isearch-string string
3327 isearch-message message
3328 isearch-case-fold-search case-fold)
3334 ;;; isearch.el ends here