1 ;;; isearch.el --- incremental search minor mode
3 ;; Copyright (C) 1992-1997, 1999-2013 Free Software Foundation, Inc.
5 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
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' which is given bindings close to the default
35 ;; characters of the original isearch.el. With `isearch-mode',
36 ;; however, you can bind multi-character keys and it should be easier
37 ;; to add new commands. One bug though: keys with meta-prefix cannot
38 ;; be longer than two chars. Also see minibuffer-local-isearch-map
39 ;; for bindings active during `isearch-edit-string'.
41 ;; isearch-mode should work even if you switch windows with the mouse,
42 ;; in which case isearch-mode is terminated automatically before the
45 ;; The search ring and completion commands automatically put you in
46 ;; the minibuffer to edit the string. This gives you a chance to
47 ;; modify the search string before executing the search. There are
48 ;; three commands to terminate the editing: C-s and C-r exit the
49 ;; minibuffer and search forward and reverse respectively, while C-m
50 ;; exits and searches in the last search direction.
52 ;; Exiting immediately from isearch uses isearch-edit-string instead
53 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
54 ;; The name of this option should probably be changed if we decide to
55 ;; keep the behavior. No point in forcing nonincremental search until
56 ;; the last possible moment.
60 (eval-when-compile (require 'cl-lib
))
62 ;; Some additional options and constants.
65 "Incremental search minor mode."
66 :link
'(emacs-commentary-link "isearch")
67 :link
'(custom-manual "(emacs)Incremental Search")
73 (defcustom search-exit-option t
74 "Non-nil means random control characters terminate incremental search."
78 (defcustom search-slow-window-lines
1
79 "Number of lines in slow search display windows.
80 These are the short windows used during incremental search on slow terminals.
81 Negative means put the slow search window at the top (normally it's at bottom)
82 and the value is minus the number of lines."
86 (defcustom search-slow-speed
1200
87 "Highest terminal speed at which to use \"slow\" style incremental search.
88 This is the style where a one-line window is created to show the line
89 that the search has reached."
93 (defcustom search-upper-case
'not-yanks
94 "If non-nil, upper case chars disable case fold searching.
95 That is, upper and lower case chars must match exactly.
96 This applies no matter where the chars come from, but does not
97 apply to chars in regexps that are prefixed with `\\'.
98 If this value is `not-yanks', text yanked into the search string
99 in Isearch mode is always downcased."
100 :type
'(choice (const :tag
"off" nil
)
105 (defcustom search-nonincremental-instead t
106 "If non-nil, do a nonincremental search instead of exiting immediately.
107 Actually, `isearch-edit-string' is called to let you enter the search
108 string, and RET terminates editing and does a nonincremental search."
112 (defcustom search-whitespace-regexp
(purecopy "\\s-+")
113 "If non-nil, regular expression to match a sequence of whitespace chars.
114 When you enter a space or spaces in the incremental search, it
115 will match any sequence matched by this regexp. As an exception,
116 spaces are treated normally in regexp incremental search if they
117 occur in a regexp construct like [...] or *, + or ?.
119 If the value is a string, it applies to both ordinary and
120 regexp incremental search. If the value is nil, or
121 `isearch-lax-whitespace' is nil for ordinary incremental search, or
122 `isearch-regexp-lax-whitespace' is nil for regexp incremental search,
123 then each space you type matches literally, against one space.
125 You might want to use something like \"[ \\t\\r\\n]+\" instead.
126 In the Customization buffer, that is `[' followed by a space,
127 a tab, a carriage return (control-M), a newline, and `]+'."
128 :type
'(choice (const :tag
"Match Spaces Literally" nil
)
133 (defcustom search-invisible
'open
134 "If t incremental search can match hidden text.
135 A nil value means don't match invisible text.
136 When the value is `open', if the text matched is made invisible by
137 an overlay having an `invisible' property and that overlay has a property
138 `isearch-open-invisible', then incremental search will show the contents.
139 \(This applies when using `outline.el' and `hideshow.el'.)
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
))
147 (defcustom isearch-hide-immediately t
148 "If non-nil, re-hide an invisible match right away.
149 This variable makes a difference when `search-invisible' is set to `open'.
150 It means that after search makes some invisible text visible
151 to show the match, it makes the text invisible again when the match moves.
152 Ordinarily the text becomes invisible again at the end of the search."
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
163 (defvar isearch-mode-hook nil
164 "Function(s) to call after starting up an incremental search.")
166 (defvar isearch-update-post-hook nil
167 "Function(s) to call after isearch has found matches in the buffer.")
169 (defvar isearch-mode-end-hook nil
170 "Function(s) to call after terminating an incremental search.
171 When these functions are called, `isearch-mode-end-hook-quit'
172 is non-nil if the user quits the search.")
174 (defvar isearch-mode-end-hook-quit nil
175 "Non-nil while running `isearch-mode-end-hook' if the user quits the search.")
177 (defvar isearch-message-function nil
178 "Function to call to display the search prompt.
179 If nil, use function `isearch-message'.")
181 (defvar isearch-wrap-function nil
182 "Function to call to wrap the search when search is failed.
183 If nil, move point to the beginning of the buffer for a forward search,
184 or to the end of the buffer for a backward search.")
186 (defvar isearch-push-state-function nil
187 "Function to save a function restoring the mode-specific Isearch state
188 to the search status stack.")
190 (defvar isearch-filter-predicate
#'isearch-filter-visible
191 "Predicate that filter the search hits that would normally be available.
192 Search hits that dissatisfy the predicate are skipped. The function
193 has two arguments: the positions of start and end of text matched by
194 the search. If this function returns nil, continue searching without
195 stopping at this match.
196 If you use `add-function' to modify this variable, you can use the
197 `isearch-message-prefix' advice property to specify the prefix string
198 displayed in the search message.")
202 (defvar search-ring nil
203 "List of search string sequences.")
204 (defvar regexp-search-ring nil
205 "List of regular expression search string sequences.")
207 (defcustom search-ring-max
16
208 "Maximum length of search ring before oldest elements are thrown away."
211 (defcustom regexp-search-ring-max
16
212 "Maximum length of regexp search ring before oldest elements are thrown away."
216 (defvar search-ring-yank-pointer nil
217 "Index in `search-ring' of last string reused.
218 It is nil if none yet.")
219 (defvar regexp-search-ring-yank-pointer nil
220 "Index in `regexp-search-ring' of last string reused.
221 It is nil if none yet.")
223 (defcustom search-ring-update nil
224 "Non-nil if advancing or retreating in the search ring should cause search.
225 Default value, nil, means edit the string instead."
229 ;;; isearch highlight customization.
231 (defcustom search-highlight t
232 "Non-nil means incremental search highlights the current match."
237 '((((class color
) (min-colors 88) (background light
))
238 ;; The background must not be too dark, for that means
239 ;; the character is hard to see when the cursor is there.
240 (:background
"magenta3" :foreground
"lightskyblue1"))
241 (((class color
) (min-colors 88) (background dark
))
242 (:background
"palevioletred2" :foreground
"brown4"))
243 (((class color
) (min-colors 16))
244 (:background
"magenta4" :foreground
"cyan1"))
245 (((class color
) (min-colors 8))
246 (:background
"magenta4" :foreground
"cyan1"))
247 (t (:inverse-video t
)))
248 "Face for highlighting Isearch matches."
251 (defvar isearch-face
'isearch
)
253 (defface isearch-fail
254 '((((class color
) (min-colors 88) (background light
))
255 (:background
"RosyBrown1"))
256 (((class color
) (min-colors 88) (background dark
))
257 (:background
"red4"))
258 (((class color
) (min-colors 16))
260 (((class color
) (min-colors 8))
262 (((class color grayscale
))
264 (t (:inverse-video t
)))
265 "Face for highlighting failed part in Isearch echo-area message."
269 (defcustom isearch-lazy-highlight t
270 "Controls the lazy-highlighting during incremental search.
271 When non-nil, all text in the buffer matching the current search
272 string is highlighted lazily (see `lazy-highlight-initial-delay'
273 and `lazy-highlight-interval')."
275 :group
'lazy-highlight
278 ;;; Lazy highlight customization.
280 (defgroup lazy-highlight nil
281 "Lazy highlighting feature for matching strings."
282 :prefix
"lazy-highlight-"
287 (define-obsolete-variable-alias 'isearch-lazy-highlight-cleanup
288 'lazy-highlight-cleanup
291 (defcustom lazy-highlight-cleanup t
292 "Controls whether to remove extra highlighting after a search.
293 If this is nil, extra highlighting can be \"manually\" removed with
294 \\[lazy-highlight-cleanup]."
296 :group
'lazy-highlight
)
298 (define-obsolete-variable-alias 'isearch-lazy-highlight-initial-delay
299 'lazy-highlight-initial-delay
302 (defcustom lazy-highlight-initial-delay
0.25
303 "Seconds to wait before beginning to lazily highlight all matches."
305 :group
'lazy-highlight
)
307 (define-obsolete-variable-alias 'isearch-lazy-highlight-interval
308 'lazy-highlight-interval
311 (defcustom lazy-highlight-interval
0 ; 0.0625
312 "Seconds between lazily highlighting successive matches."
314 :group
'lazy-highlight
)
316 (define-obsolete-variable-alias 'isearch-lazy-highlight-max-at-a-time
317 'lazy-highlight-max-at-a-time
320 (defcustom lazy-highlight-max-at-a-time
20
321 "Maximum matches to highlight at a time (for `lazy-highlight').
322 Larger values may reduce Isearch's responsiveness to user input;
323 smaller values make matches highlight slowly.
324 A value of nil means highlight all matches."
325 :type
'(choice (const :tag
"All" nil
)
326 (integer :tag
"Some"))
327 :group
'lazy-highlight
)
329 (defface lazy-highlight
330 '((((class color
) (min-colors 88) (background light
))
331 (:background
"paleturquoise"))
332 (((class color
) (min-colors 88) (background dark
))
333 (:background
"paleturquoise4"))
334 (((class color
) (min-colors 16))
335 (:background
"turquoise3"))
336 (((class color
) (min-colors 8))
337 (:background
"turquoise3"))
339 "Face for lazy highlighting of matches other than the current one."
340 :group
'lazy-highlight
342 (define-obsolete-face-alias 'isearch-lazy-highlight-face
'lazy-highlight
"22.1")
343 (define-obsolete-variable-alias 'isearch-lazy-highlight-face
346 (defvar lazy-highlight-face
'lazy-highlight
)
348 ;; Define isearch help map.
350 (defvar isearch-help-map
351 (let ((map (make-sparse-keymap)))
352 (define-key map
(char-to-string help-char
) 'isearch-help-for-help
)
353 (define-key map
[help] 'isearch-help-for-help)
354 (define-key map [f1] 'isearch-help-for-help)
355 (define-key map "?" 'isearch-help-for-help)
356 (define-key map "b" 'isearch-describe-bindings)
357 (define-key map "k" 'isearch-describe-key)
358 (define-key map "m" 'isearch-describe-mode)
359 (define-key map "q" 'help-quit)
361 "Keymap for characters following the Help key for Isearch mode.")
363 (eval-when-compile (require 'help-macro))
365 (make-help-screen isearch-help-for-help-internal
366 (purecopy "Type a help option: [bkm] or ?")
367 "You have typed %THIS-KEY%, the help character. Type a Help option:
368 \(Type \\<help-map>\\[help-quit] to exit the Help command.)
370 b Display all Isearch key bindings.
371 k KEYS Display full documentation of Isearch key sequence.
372 m Display documentation of Isearch mode.
374 You can't type here other help keys available in the global help map,
375 but outside of this help window when you type them in Isearch mode,
376 they exit Isearch mode before displaying global help."
379 (defvar isearch--display-help-action '(nil (inhibit-same-window . t)))
381 (defun isearch-help-for-help ()
382 "Display Isearch help menu."
384 (let ((display-buffer-overriding-action isearch--display-help-action))
385 (isearch-help-for-help-internal))
388 (defun isearch-describe-bindings ()
389 "Show a list of all keys defined in Isearch mode, and their definitions.
390 This is like `describe-bindings', but displays only Isearch keys."
392 (let ((display-buffer-overriding-action isearch--display-help-action))
393 (with-help-window "*Help*"
394 (with-current-buffer standard-output
395 (princ "Isearch Mode Bindings:\n")
396 (princ (substitute-command-keys "\\{isearch-mode-map}"))))))
398 (defun isearch-describe-key ()
399 "Display documentation of the function invoked by isearch key."
401 (let ((display-buffer-overriding-action isearch--display-help-action))
402 (call-interactively 'describe-key))
405 (defun isearch-describe-mode ()
406 "Display documentation of Isearch mode."
408 (let ((display-buffer-overriding-action isearch--display-help-action))
409 (describe-function 'isearch-forward))
412 (defalias 'isearch-mode-help 'isearch-describe-mode)
415 ;; Define isearch-mode keymap.
417 (defvar isearch-mode-map
420 (or (char-table-p (nth 1 map))
421 (error "The initialization of isearch-mode-map must be updated"))
422 ;; Make all multibyte characters search for themselves.
423 (set-char-table-range (nth 1 map) (cons #x100 (max-char))
424 'isearch-printing-char)
426 ;; Single-byte printing chars extend the search string by default.
429 (define-key map (vector i) 'isearch-printing-char)
432 ;; To handle local bindings with meta char prefix keys, define
433 ;; another full keymap. This must be done for any other prefix
434 ;; keys as well, one full keymap per char of the prefix key. It
435 ;; would be simpler to disable the global keymap, and/or have a
436 ;; default local key binding for any key not otherwise bound.
437 (let ((meta-map (make-sparse-keymap)))
438 (define-key map (char-to-string meta-prefix-char) meta-map))
440 ;; Several non-printing chars change the searching behavior.
441 (define-key map "\C-s" 'isearch-repeat-forward)
442 (define-key map "\C-r" 'isearch-repeat-backward)
443 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
444 ;; combinations can be used to repeat regexp isearches that can
445 ;; be used to start these searches.
446 (define-key map "\M-\C-s" 'isearch-repeat-forward)
447 (define-key map "\M-\C-r" 'isearch-repeat-backward)
448 (define-key map "\177" 'isearch-delete-char)
449 (define-key map "\C-g" 'isearch-abort)
451 ;; This assumes \e is the meta-prefix-char.
452 (or (= ?\e meta-prefix-char)
453 (error "Inconsistency in isearch.el"))
454 (define-key map "\e\e\e" 'isearch-cancel)
456 (define-key map "\C-q" 'isearch-quote-char)
458 (define-key map "\r" 'isearch-exit)
459 (define-key map "\C-j" 'isearch-printing-char)
460 (define-key map "\t" 'isearch-printing-char)
461 (define-key map [?\S-\ ] 'isearch-printing-char)
463 (define-key map "\C-w" 'isearch-yank-word-or-char)
464 (define-key map "\M-\C-w" 'isearch-del-char)
465 (define-key map "\M-\C-y" 'isearch-yank-char)
466 (define-key map "\C-y" 'isearch-yank-kill)
467 (define-key map "\M-s\C-e" 'isearch-yank-line)
469 (define-key map (char-to-string help-char) isearch-help-map)
470 (define-key map [help] isearch-help-map
)
471 (define-key map
[f1] isearch-help-map)
473 (define-key map "\M-n" 'isearch-ring-advance)
474 (define-key map "\M-p" 'isearch-ring-retreat)
475 (define-key map "\M-y" 'isearch-yank-pop)
477 (define-key map "\M-\t" 'isearch-complete)
479 ;; Pass frame events transparently so they won't exit the search.
480 ;; In particular, if we have more than one display open, then a
481 ;; switch-frame might be generated by someone typing at another keyboard.
482 (define-key map [switch-frame] nil)
483 (define-key map [delete-frame] nil)
484 (define-key map [iconify-frame] nil)
485 (define-key map [make-frame-visible] nil)
486 (define-key map [mouse-movement] nil)
487 (define-key map [language-change] nil)
489 ;; For searching multilingual text.
490 (define-key map "\C-\\" 'isearch-toggle-input-method)
491 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
493 ;; People expect to be able to paste with the mouse.
494 (define-key map [mouse-2] #'isearch-mouse-2)
495 (define-key map [down-mouse-2] nil)
497 ;; Some bindings you may want to put in your isearch-mode-hook.
498 ;; Suggest some alternates...
499 (define-key map "\M-c" 'isearch-toggle-case-fold)
500 (define-key map "\M-r" 'isearch-toggle-regexp)
501 (define-key map "\M-e" 'isearch-edit-string)
503 (define-key map "\M-sc" 'isearch-toggle-case-fold)
504 (define-key map "\M-si" 'isearch-toggle-invisible)
505 (define-key map "\M-sr" 'isearch-toggle-regexp)
506 (define-key map "\M-sw" 'isearch-toggle-word)
507 (define-key map "\M-s_" 'isearch-toggle-symbol)
508 (define-key map "\M-s " 'isearch-toggle-lax-whitespace)
510 (define-key map [?\M-%] 'isearch-query-replace)
511 (define-key map [?\C-\M-%] 'isearch-query-replace-regexp)
512 (define-key map "\M-so" 'isearch-occur)
513 (define-key map "\M-shr" 'isearch-highlight-regexp)
515 ;; The key translations defined in the C-x 8 prefix should add
516 ;; characters to the search string. See iso-transl.el.
517 (define-key map "\C-x8\r" 'isearch-char-by-name)
520 "Keymap for `isearch-mode'.")
522 (defvar minibuffer-local-isearch-map
523 (let ((map (make-sparse-keymap)))
524 (set-keymap-parent map minibuffer-local-map)
525 (define-key map "\r" 'exit-minibuffer)
526 (define-key map "\M-\t" 'isearch-complete-edit)
527 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
528 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
529 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
530 (define-key map [right] 'isearch-yank-char-in-minibuffer)
532 "Keymap for editing Isearch strings in the minibuffer.")
534 ;; Internal variables declared globally for byte-compiler.
535 ;; These are all set with setq while isearching
536 ;; and bound locally while editing the search string.
538 (defvar isearch-forward nil) ; Searching in the forward direction.
539 (defvar isearch-regexp nil) ; Searching for a regexp.
540 (defvar isearch-word nil
541 "Regexp-based search mode for words/symbols.
542 If t, do incremental search for a sequence of words, ignoring punctuation.
543 If the value is a function (e.g. `isearch-symbol-regexp'), it is called to
544 convert the search string to a regexp used by regexp search functions.
545 The property `isearch-message-prefix' put on this function specifies the
546 prefix string displayed in the search message.")
548 (defvar isearch-lax-whitespace t
549 "If non-nil, a space will match a sequence of whitespace chars.
550 When you enter a space or spaces in ordinary incremental search, it
551 will match any sequence matched by the regexp defined by the variable
552 `search-whitespace-regexp'. If the value is nil, each space you type
553 matches literally, against one space. You can toggle the value of this
554 variable by the command `isearch-toggle-lax-whitespace'.")
556 (defvar isearch-regexp-lax-whitespace nil
557 "If non-nil, a space will match a sequence of whitespace chars.
558 When you enter a space or spaces in regexp incremental search, it
559 will match any sequence matched by the regexp defined by the variable
560 `search-whitespace-regexp'. If the value is nil, each space you type
561 matches literally, against one space. You can toggle the value of this
562 variable by the command `isearch-toggle-lax-whitespace'.")
564 (defvar isearch-cmds nil
565 "Stack of search status sets.
566 Each set is a vector of the form:
567 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
568 INVALID-REGEXP WRAPPED BARRIER WITHIN-BRACKETS CASE-FOLD-SEARCH]")
570 (defvar isearch-string "") ; The current search string.
571 (defvar isearch-message "") ; text-char-description version of isearch-string
573 (defvar isearch-message-prefix-add nil) ; Additional text for the message prefix
574 (defvar isearch-message-suffix-add nil) ; Additional text for the message suffix
576 (defvar isearch-success t) ; Searching is currently successful.
577 (defvar isearch-error nil) ; Error message for failed search.
578 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
579 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
580 (defvar isearch-barrier 0
581 "Recorded minimum/maximal point for the current search.")
582 (defvar isearch-just-started nil)
583 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
585 ;; case-fold-search while searching.
586 ;; either nil, t, or 'yes. 'yes means the same as t except that mixed
587 ;; case in the search string is ignored.
588 (defvar isearch-case-fold-search nil)
590 ;; search-invisible while searching.
591 ;; either nil, t, or 'open. 'open means the same as t except that
592 ;; opens hidden overlays.
593 (defvar isearch-invisible search-invisible)
595 (defvar isearch-last-case-fold-search nil)
597 ;; Used to save default value while isearch is active
598 (defvar isearch-original-minibuffer-message-timeout nil)
600 (defvar isearch-adjusted nil)
601 (defvar isearch-slow-terminal-mode nil)
602 ;; If t, using a small window.
603 (defvar isearch-small-window nil)
604 (defvar isearch-opoint 0)
605 ;; The window configuration active at the beginning of the search.
606 (defvar isearch-window-configuration nil)
608 ;; Flag to indicate a yank occurred, so don't move the cursor.
609 (defvar isearch-yank-flag nil)
611 ;; A function to be called after each input character is processed.
612 ;; (It is not called after characters that exit the search.)
613 ;; It is only set from an optional argument to `isearch-mode'.
614 (defvar isearch-op-fun nil)
616 ;; Is isearch-mode in a recursive edit for modal searching.
617 (defvar isearch-recursive-edit nil)
619 ;; Should isearch be terminated after doing one search?
620 (defvar isearch-nonincremental nil)
622 ;; New value of isearch-forward after isearch-edit-string.
623 (defvar isearch-new-forward nil)
625 ;; Accumulate here the overlays opened during searching.
626 (defvar isearch-opened-overlays nil)
628 ;; Non-nil if the string exists but is invisible.
629 (defvar isearch-hidden nil)
631 ;; The value of input-method-function when isearch is invoked.
632 (defvar isearch-input-method-function nil)
634 ;; A flag to tell if input-method-function is locally bound when
635 ;; isearch is invoked.
636 (defvar isearch-input-method-local-p nil)
638 (defvar isearch--saved-overriding-local-map nil)
640 ;; Minor-mode-alist changes - kind of redundant with the
641 ;; echo area, but if isearching in multiple windows, it can be useful.
643 (or (assq 'isearch-mode minor-mode-alist)
644 (nconc minor-mode-alist
645 (list '(isearch-mode isearch-mode))))
647 (defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
648 (make-variable-buffer-local 'isearch-mode)
650 (define-key global-map "\C-s" 'isearch-forward)
651 (define-key esc-map "\C-s" 'isearch-forward-regexp)
652 (define-key global-map "\C-r" 'isearch-backward)
653 (define-key esc-map "\C-r" 'isearch-backward-regexp)
654 (define-key search-map "w" 'isearch-forward-word)
655 (define-key search-map "_" 'isearch-forward-symbol)
656 (define-key search-map "." 'isearch-forward-symbol-at-point)
658 ;; Entry points to isearch-mode.
660 (defun isearch-forward (&optional regexp-p no-recursive-edit)
662 Do incremental search forward.
663 With a prefix argument, do an incremental regular expression search instead.
665 As you type characters, they add to the search string and are found.
666 The following non-printing keys are bound in `isearch-mode-map'.
668 Type \\[isearch-delete-char] to cancel last input item from end of search string.
669 Type \\[isearch-exit] to exit, leaving point at location found.
670 Type LFD (C-j) to match end of line.
671 Type \\[isearch-repeat-forward] to search again forward,\
672 \\[isearch-repeat-backward] to search again backward.
673 Type \\[isearch-yank-word-or-char] to yank next word or character in buffer
674 onto the end of the search string, and search for it.
675 Type \\[isearch-del-char] to delete character from end of search string.
676 Type \\[isearch-yank-char] to yank char from buffer onto end of search\
677 string and search for it.
678 Type \\[isearch-yank-line] to yank rest of line onto end of search string\
680 Type \\[isearch-yank-kill] to yank the last string of killed text.
681 Type \\[isearch-yank-pop] to replace string just yanked into search prompt
682 with string killed before it.
683 Type \\[isearch-quote-char] to quote control character to search for it.
684 Type \\[isearch-char-by-name] to add a character to search by Unicode name,\
686 \\[isearch-abort] while searching or when search has failed cancels input\
688 been found successfully.
689 \\[isearch-abort] when search is successful aborts and moves point to\
692 If you try to exit with the search string still empty, it invokes
693 nonincremental search.
695 Type \\[isearch-toggle-case-fold] to toggle search case-sensitivity.
696 Type \\[isearch-toggle-invisible] to toggle search in invisible text.
697 Type \\[isearch-toggle-regexp] to toggle regular-expression mode.
698 Type \\[isearch-toggle-word] to toggle word mode.
699 Type \\[isearch-toggle-symbol] to toggle symbol mode.
701 Type \\[isearch-toggle-lax-whitespace] to toggle whitespace matching.
702 In incremental searches, a space or spaces normally matches any whitespace
703 defined by the variable `search-whitespace-regexp'; see also the variables
704 `isearch-lax-whitespace' and `isearch-regexp-lax-whitespace'.
706 Type \\[isearch-edit-string] to edit the search string in the minibuffer.
708 Also supported is a search ring of the previous 16 search strings.
709 Type \\[isearch-ring-advance] to search for the next item in the search ring.
710 Type \\[isearch-ring-retreat] to search for the previous item in the search\
712 Type \\[isearch-complete] to complete the search string using the search ring.
714 Type \\[isearch-query-replace] to run `query-replace' with string to\
715 replace from last search string.
716 Type \\[isearch-query-replace-regexp] to run `query-replace-regexp'\
717 with the last search string.
718 Type \\[isearch-occur] to run `occur' that shows\
719 the last search string.
720 Type \\[isearch-highlight-regexp] to run `highlight-regexp'\
721 that highlights the last search string.
723 Type \\[isearch-describe-bindings] to display all Isearch key bindings.
724 Type \\[isearch-describe-key] to display documentation of Isearch key.
725 Type \\[isearch-describe-mode] to display documentation of Isearch mode.
727 If an input method is turned on in the current buffer, that input
728 method is also active while you are typing characters to search.
729 To toggle the input method, type \\[isearch-toggle-input-method]. \
730 It also toggles the input
731 method in the current buffer.
733 To use a different input method for searching, type \
734 \\[isearch-toggle-specified-input-method],
735 and specify an input method you want to use.
737 The above keys, bound in `isearch-mode-map', are often controlled by
738 options; do \\[apropos] on search-.* to find them.
739 Other control and meta characters terminate the search
740 and are then executed normally (depending on `search-exit-option').
741 Likewise for function keys and mouse button events.
743 If this function is called non-interactively with a nil NO-RECURSIVE-EDIT,
744 it does not return to the calling function until the search is done.
745 See the function `isearch-mode' for more information."
748 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
750 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
751 "Do incremental search forward for regular expression.
752 With a prefix argument, do a regular string search instead.
753 Like ordinary incremental search except that your input is treated
754 as a regexp. See the command `isearch-forward' for more information.
756 In incremental searches, a space or spaces normally matches any
757 whitespace defined by the variable `search-whitespace-regexp'.
758 To search for a literal space and nothing else, enter C-q SPC.
759 To toggle whitespace matching, use `isearch-toggle-lax-whitespace'."
761 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
763 (defun isearch-forward-word (&optional not-word no-recursive-edit)
764 "Do incremental search forward for a sequence of words.
765 With a prefix argument, do a regular string search instead.
766 Like ordinary incremental search except that your input is treated
767 as a sequence of words without regard to how the words are separated.
768 See the command `isearch-forward' for more information."
770 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
772 (defun isearch-forward-symbol (&optional _not-symbol no-recursive-edit)
773 "Do incremental search forward for a symbol.
774 The prefix argument is currently unused.
775 Like ordinary incremental search except that your input is treated
776 as a symbol surrounded by symbol boundary constructs \\_< and \\_>.
777 See the command `isearch-forward' for more information."
779 (isearch-mode t nil nil (not no-recursive-edit) 'isearch-symbol-regexp))
781 (defun isearch-backward (&optional regexp-p no-recursive-edit)
782 "Do incremental search backward.
783 With a prefix argument, do a regular expression search instead.
784 See the command `isearch-forward' for more information."
786 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
788 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
789 "Do incremental search backward for regular expression.
790 With a prefix argument, do a regular string search instead.
791 Like ordinary incremental search except that your input is treated
792 as a regexp. See the command `isearch-forward' for more information."
794 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
796 (defun isearch-forward-symbol-at-point ()
797 "Do incremental search forward for a symbol found near point.
798 Like ordinary incremental search except that the symbol found at point
799 is added to the search string initially as a regexp surrounded
800 by symbol boundary constructs \\_< and \\_>.
801 See the command `isearch-forward-symbol' for more information."
803 (isearch-forward-symbol nil 1)
804 (let ((bounds (find-tag-default-bounds)))
807 (when (< (car bounds) (point))
808 (goto-char (car bounds)))
810 (buffer-substring-no-properties (car bounds) (cdr bounds))))
812 (setq isearch-error "No symbol at point")
816 ;; isearch-mode only sets up incremental search for the minor mode.
817 ;; All the work is done by the isearch-mode commands.
820 ;;(defvar isearch-commands '(isearch-forward isearch-backward
821 ;; isearch-forward-regexp isearch-backward-regexp)
822 ;; "List of commands for which isearch-mode does not recursive-edit.")
825 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word)
826 "Start Isearch minor mode.
827 It is called by the function `isearch-forward' and other related functions.
829 The non-nil arg FORWARD means searching in the forward direction.
831 The non-nil arg REGEXP does an incremental regular expression search.
833 The arg OP-FUN is a function to be called after each input character
834 is processed. (It is not called after characters that exit the search.)
836 When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and
837 does not return to the calling function until the search is completed.
838 To behave this way it enters a recursive-edit and exits it when done
841 The arg WORD, if t, does incremental search for a sequence of words,
842 ignoring punctuation. If the value is a function, it is called to
843 convert the search string to a regexp used by regexp search functions."
845 ;; Initialize global vars.
846 (setq isearch-forward forward
847 isearch-regexp regexp
849 isearch-op-fun op-fun
850 isearch-last-case-fold-search isearch-case-fold-search
851 isearch-case-fold-search case-fold-search
852 isearch-invisible search-invisible
858 isearch-barrier (point)
860 isearch-yank-flag nil
862 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
865 (abs search-slow-window-lines))))
866 isearch-other-end nil
867 isearch-small-window nil
868 isearch-just-started t
869 isearch-start-hscroll (window-hscroll)
871 isearch-opoint (point)
872 search-ring-yank-pointer nil
873 isearch-opened-overlays nil
874 isearch-input-method-function input-method-function
875 isearch-input-method-local-p (local-variable-p 'input-method-function)
876 regexp-search-ring-yank-pointer nil
878 ;; Save the original value of `minibuffer-message-timeout', and
879 ;; set it to nil so that isearch's messages don't get timed out.
880 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
881 minibuffer-message-timeout nil)
883 ;; We must bypass input method while reading key. When a user type
884 ;; printable character, appropriate input method is turned on in
885 ;; minibuffer to read multibyte characters.
886 (or isearch-input-method-local-p
887 (make-local-variable 'input-method-function))
888 (setq input-method-function nil)
891 (setq isearch-window-configuration
892 (if isearch-slow-terminal-mode (current-window-configuration) nil))
894 ;; Maybe make minibuffer frame visible and/or raise it.
895 (let ((frame (window-frame (minibuffer-window))))
896 (unless (memq (frame-live-p frame) '(nil t))
897 (unless (frame-visible-p frame)
898 (make-frame-visible frame))
899 (if minibuffer-auto-raise
900 (raise-frame frame))))
902 (setq isearch-mode " Isearch") ;; forward? regexp?
903 (force-mode-line-update)
905 (setq overriding-terminal-local-map isearch-mode-map)
906 (run-hooks 'isearch-mode-hook)
907 ;; Remember the initial map possibly modified
908 ;; by external packages in isearch-mode-hook. (Bug#16035)
909 (setq isearch--saved-overriding-local-map overriding-terminal-local-map)
911 ;; Pushing the initial state used to be before running isearch-mode-hook,
912 ;; but a hook might set `isearch-push-state-function' used in
913 ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994)
918 (add-hook 'pre-command-hook 'isearch-pre-command-hook)
919 (add-hook 'post-command-hook 'isearch-post-command-hook)
920 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
921 (add-hook 'kbd-macro-termination-hook 'isearch-done)
923 ;; isearch-mode can be made modal (in the sense of not returning to
924 ;; the calling function until searching is completed) by entering
925 ;; a recursive-edit and exiting it when done isearching.
927 (let ((isearch-recursive-edit t))
932 ;; Some high level utilities. Others below.
934 (defun isearch-update ()
935 "This is called after every isearch command to update the display.
936 The last thing it does is to run `isearch-update-post-hook'."
937 (if (and (null unread-command-events)
938 (null executing-kbd-macro))
940 (if (not (input-pending-p))
941 (if isearch-message-function
942 (funcall isearch-message-function)
944 (if (and isearch-slow-terminal-mode
945 (not (or isearch-small-window
946 (pos-visible-in-window-p))))
947 (let ((found-point (point)))
948 (setq isearch-small-window t)
949 (move-to-window-line 0)
950 (let ((window-min-height 1))
951 (split-window nil (if (< search-slow-window-lines 0)
952 (1+ (- search-slow-window-lines))
954 (1+ search-slow-window-lines)))))
955 (if (< search-slow-window-lines 0)
956 (progn (vertical-motion (- 1 search-slow-window-lines))
957 (set-window-start (next-window) (point))
958 (set-window-hscroll (next-window)
960 (set-window-hscroll (selected-window) 0))
962 (goto-char found-point))
963 ;; Keep same hscrolling as at the start of the search when possible
964 (let ((current-scroll (window-hscroll)))
965 (set-window-hscroll (selected-window) isearch-start-hscroll)
966 (unless (pos-visible-in-window-p)
967 (set-window-hscroll (selected-window) current-scroll))))
968 (if isearch-other-end
969 (if (< isearch-other-end (point)) ; isearch-forward?
970 (isearch-highlight isearch-other-end (point))
971 (isearch-highlight (point) isearch-other-end))
972 (isearch-dehighlight))))
973 (setq ;; quit-flag nil not for isearch-mode
975 isearch-yank-flag nil)
976 (when isearch-lazy-highlight
977 (isearch-lazy-highlight-new-loop))
978 ;; We must prevent the point moving to the end of composition when a
979 ;; part of the composition has just been searched.
980 (setq disable-point-adjustment t)
981 (run-hooks 'isearch-update-post-hook))
983 (defun isearch-done (&optional nopush edit)
985 For successful search, pass no args.
986 For a failing search, NOPUSH is t.
987 For going to the minibuffer to edit the search string,
988 NOPUSH is t and EDIT is t."
990 (if isearch-resume-in-command-history
991 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
992 ,isearch-word ,isearch-forward
994 ',isearch-case-fold-search)))
995 (unless (equal (car command-history) command)
996 (setq command-history (cons command command-history)))))
998 (remove-hook 'pre-command-hook 'isearch-pre-command-hook)
999 (remove-hook 'post-command-hook 'isearch-post-command-hook)
1000 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
1001 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
1002 (setq isearch-lazy-highlight-start nil)
1004 ;; Called by all commands that terminate isearch-mode.
1005 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
1006 (setq overriding-terminal-local-map nil)
1007 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
1008 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
1009 (isearch-dehighlight)
1010 (lazy-highlight-cleanup lazy-highlight-cleanup)
1011 (let ((found-start (window-start))
1012 (found-point (point)))
1013 (when isearch-window-configuration
1014 (set-window-configuration isearch-window-configuration)
1015 (if isearch-small-window
1016 (goto-char found-point)
1017 ;; set-window-configuration clobbers window-start; restore it.
1018 ;; This has an annoying side effect of clearing the last_modiff
1019 ;; field of the window, which can cause unwanted scrolling,
1020 ;; so don't do it unless truly necessary.
1021 (set-window-start (selected-window) found-start t))))
1023 (setq isearch-mode nil)
1024 (if isearch-input-method-local-p
1025 (setq input-method-function isearch-input-method-function)
1026 (kill-local-variable 'input-method-function))
1028 (force-mode-line-update)
1030 ;; If we ended in the middle of some intangible text,
1031 ;; move to the further end of that intangible text.
1032 (let ((after (if (eobp) nil
1033 (get-text-property (point) 'intangible)))
1034 (before (if (bobp) nil
1035 (get-text-property (1- (point)) 'intangible))))
1036 (when (and before after (eq before after))
1039 (next-single-property-change (point) 'intangible)
1040 (previous-single-property-change (point) 'intangible)))))
1042 (if (and (> (length isearch-string) 0) (not nopush))
1043 ;; Update the ring data.
1044 (isearch-update-ring isearch-string isearch-regexp))
1046 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
1047 (run-hooks 'isearch-mode-end-hook))
1049 ;; If there was movement, mark the starting position.
1050 ;; Maybe should test difference between and set mark only if > threshold.
1051 (if (/= (point) isearch-opoint)
1052 (or (and transient-mark-mode mark-active)
1054 (push-mark isearch-opoint t)
1055 (or executing-kbd-macro (> (minibuffer-depth) 0) edit
1056 (message "Mark saved where search started")))))
1058 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
1060 (defun isearch-update-ring (string &optional regexp)
1061 "Add STRING to the beginning of the search ring.
1062 REGEXP if non-nil says use the regexp search ring."
1064 (if regexp 'regexp-search-ring 'search-ring)
1066 (if regexp regexp-search-ring-max search-ring-max)))
1068 ;; Switching buffers should first terminate isearch-mode.
1069 ;; ;; For Emacs 19, the frame switch event is handled.
1070 ;; (defun isearch-switch-frame-handler ()
1071 ;; (interactive) ;; Is this necessary?
1072 ;; ;; First terminate isearch-mode.
1074 ;; (isearch-clean-overlays)
1075 ;; (handle-switch-frame (car (cdr last-command-event))))
1078 ;; The search status structure and stack.
1080 (cl-defstruct (isearch--state
1083 (:constructor isearch--get-state
1085 (string isearch-string)
1086 (message isearch-message)
1088 (success isearch-success)
1089 (forward isearch-forward)
1090 (other-end isearch-other-end)
1092 (error isearch-error)
1093 (wrapped isearch-wrapped)
1094 (barrier isearch-barrier)
1095 (case-fold-search isearch-case-fold-search)
1096 (pop-fun (if isearch-push-state-function
1097 (funcall isearch-push-state-function))))))
1098 (string :read-only t)
1099 (message :read-only t)
1100 (point :read-only t)
1101 (success :read-only t)
1102 (forward :read-only t)
1103 (other-end :read-only t)
1105 (error :read-only t)
1106 (wrapped :read-only t)
1107 (barrier :read-only t)
1108 (case-fold-search :read-only t)
1109 (pop-fun :read-only t))
1111 (defun isearch--set-state (cmd)
1112 (setq isearch-string (isearch--state-string cmd)
1113 isearch-message (isearch--state-message cmd)
1114 isearch-success (isearch--state-success cmd)
1115 isearch-forward (isearch--state-forward cmd)
1116 isearch-other-end (isearch--state-other-end cmd)
1117 isearch-word (isearch--state-word cmd)
1118 isearch-error (isearch--state-error cmd)
1119 isearch-wrapped (isearch--state-wrapped cmd)
1120 isearch-barrier (isearch--state-barrier cmd)
1121 isearch-case-fold-search (isearch--state-case-fold-search cmd))
1122 (if (functionp (isearch--state-pop-fun cmd))
1123 (funcall (isearch--state-pop-fun cmd) cmd))
1124 (goto-char (isearch--state-point cmd)))
1126 (defun isearch-pop-state ()
1127 (setq isearch-cmds (cdr isearch-cmds))
1128 (isearch--set-state (car isearch-cmds)))
1130 (defun isearch-push-state ()
1131 (push (isearch--get-state) isearch-cmds))
1134 ;; Commands active while inside of the isearch minor mode.
1136 (defun isearch-exit ()
1137 "Exit search normally.
1138 However, if this is the first command after starting incremental
1139 search and `search-nonincremental-instead' is non-nil, do a
1140 nonincremental search instead via `isearch-edit-string'."
1142 (if (and search-nonincremental-instead
1143 (= 0 (length isearch-string)))
1144 (let ((isearch-nonincremental t))
1145 (isearch-edit-string)))
1147 (isearch-clean-overlays))
1149 (defvar minibuffer-history-symbol) ;; from external package gmhist.el
1151 (defun isearch-fail-pos (&optional msg)
1152 "Return position of first mismatch in search string, or nil if none.
1153 If MSG is non-nil, use variable `isearch-message', otherwise `isearch-string'."
1154 (let ((cmds isearch-cmds)
1155 (curr-msg (if msg isearch-message isearch-string))
1157 (when (or (not isearch-success) isearch-error)
1159 (or (not (isearch--state-success (car cmds)))
1160 (isearch--state-error (car cmds))))
1162 (setq succ-msg (and cmds (if msg (isearch--state-message (car cmds))
1163 (isearch--state-string (car cmds)))))
1164 (if (and (stringp succ-msg)
1165 (< (length succ-msg) (length curr-msg))
1167 (substring curr-msg 0 (length succ-msg))))
1171 (defmacro with-isearch-suspended (&rest body)
1172 "Exit Isearch mode, run BODY, and reinvoke the pending search.
1173 You can update the global isearch variables by setting new values to
1174 `isearch-new-string', `isearch-new-message', `isearch-new-forward',
1175 `isearch-new-word', `isearch-new-case-fold'."
1176 ;; This code is very hairy for several reasons, explained in the code.
1177 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1178 ;; If there were a way to catch any change of buffer from the minibuffer,
1179 ;; this could be simplified greatly.
1180 ;; Editing doesn't back up the search point. Should it?
1181 `(condition-case nil
1183 (let ((isearch-nonincremental isearch-nonincremental)
1185 ;; Locally bind all isearch global variables to protect them
1186 ;; from recursive isearching.
1187 ;; isearch-string -message and -forward are not bound
1188 ;; so they may be changed. Instead, save the values.
1189 (isearch-new-string isearch-string)
1190 (isearch-new-message isearch-message)
1191 (isearch-new-forward isearch-forward)
1192 (isearch-new-word isearch-word)
1193 (isearch-new-case-fold isearch-case-fold-search)
1195 (isearch-regexp isearch-regexp)
1196 (isearch-op-fun isearch-op-fun)
1197 (isearch-cmds isearch-cmds)
1198 (isearch-success isearch-success)
1199 (isearch-wrapped isearch-wrapped)
1200 (isearch-barrier isearch-barrier)
1201 (isearch-adjusted isearch-adjusted)
1202 (isearch-yank-flag isearch-yank-flag)
1203 (isearch-error isearch-error)
1204 ;;; Don't bind this. We want isearch-search, below, to set it.
1205 ;;; And the old value won't matter after that.
1206 ;;; (isearch-other-end isearch-other-end)
1207 ;;; Perhaps some of these other variables should be bound for a
1208 ;;; shorter period, ending before the next isearch-search.
1209 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1210 (isearch-opoint isearch-opoint)
1211 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1212 (isearch-small-window isearch-small-window)
1213 (isearch-recursive-edit isearch-recursive-edit)
1214 ;; Save current configuration so we can restore it here.
1215 (isearch-window-configuration (current-window-configuration))
1217 ;; This could protect the index of the search rings,
1218 ;; but we can't reliably count the number of typed M-p
1219 ;; in `read-from-minibuffer' to adjust the index accordingly.
1220 ;; So when the following is commented out, `isearch-mode'
1221 ;; below resets the index to the predictable value nil.
1222 ;; (search-ring-yank-pointer search-ring-yank-pointer)
1223 ;; (regexp-search-ring-yank-pointer regexp-search-ring-yank-pointer)
1225 ;; Temporarily restore `minibuffer-message-timeout'.
1226 (minibuffer-message-timeout
1227 isearch-original-minibuffer-message-timeout)
1228 (isearch-original-minibuffer-message-timeout
1229 isearch-original-minibuffer-message-timeout)
1230 old-point old-other-end)
1232 ;; Actually terminate isearching until editing is done.
1233 ;; This is so that the user can do anything without failure,
1234 ;; like switch buffers and start another isearch, and return.
1237 (exit nil)) ; was recursive editing
1239 ;; Save old point and isearch-other-end before reading from minibuffer
1240 ;; that can change their values.
1241 (setq old-point (point) old-other-end isearch-other-end)
1246 ;; Set point at the start (end) of old match if forward (backward),
1247 ;; so after exiting minibuffer isearch resumes at the start (end)
1248 ;; of this match and can find it again.
1249 (if (and old-other-end (eq old-point (point))
1250 (eq isearch-forward isearch-new-forward))
1251 (goto-char old-other-end))
1253 ;; Always resume isearching by restarting it.
1254 (isearch-mode isearch-forward
1260 ;; Copy new local values to isearch globals
1261 (setq isearch-string isearch-new-string
1262 isearch-message isearch-new-message
1263 isearch-forward isearch-new-forward
1264 isearch-word isearch-new-word
1265 isearch-case-fold-search isearch-new-case-fold))
1267 ;; Empty isearch-string means use default.
1268 (when (= 0 (length isearch-string))
1269 (setq isearch-string (or (car (if isearch-regexp
1275 (mapconcat 'isearch-text-char-description
1277 ;; After taking the last element, adjust ring to previous one.
1278 (isearch-ring-adjust1 nil)))
1280 ;; This used to push the state as of before this C-s, but it adds
1281 ;; an inconsistent state where part of variables are from the
1282 ;; previous search (e.g. `isearch-success'), and part of variables
1283 ;; are just entered from the minibuffer (e.g. `isearch-string').
1284 ;; (isearch-push-state)
1286 ;; Reinvoke the pending search.
1288 (isearch-push-state) ; this pushes the correct state
1290 (if isearch-nonincremental
1292 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1294 ;; The search done message is confusing when the string
1295 ;; is empty, so erase it.
1296 (if (equal isearch-string "")
1299 (quit ; handle abort-recursive-edit
1300 (isearch-abort) ;; outside of let to restore outside global values
1303 (defun isearch-edit-string ()
1304 "Edit the search string in the minibuffer.
1305 The following additional command keys are active while editing.
1306 \\<minibuffer-local-isearch-map>
1307 \\[exit-minibuffer] to resume incremental searching with the edited string.
1308 \\[isearch-forward-exit-minibuffer] to resume isearching forward.
1309 \\[isearch-reverse-exit-minibuffer] to resume isearching backward.
1310 \\[isearch-complete-edit] to complete the search string using the search ring."
1312 (with-isearch-suspended
1313 (let* ((message-log-max nil)
1314 ;; Don't add a new search string to the search ring here
1315 ;; in `read-from-minibuffer'. It should be added only
1316 ;; by `isearch-update-ring' called from `isearch-done'.
1317 (history-add-new-input nil)
1318 ;; Binding minibuffer-history-symbol to nil is a work-around
1319 ;; for some incompatibility with gmhist.
1320 (minibuffer-history-symbol))
1321 (setq isearch-new-string
1322 (read-from-minibuffer
1323 (isearch-message-prefix nil isearch-nonincremental)
1324 (cons isearch-string (1+ (or (isearch-fail-pos)
1325 (length isearch-string))))
1326 minibuffer-local-isearch-map nil
1328 (cons 'regexp-search-ring
1329 (1+ (or regexp-search-ring-yank-pointer -1)))
1331 (1+ (or search-ring-yank-pointer -1))))
1334 (mapconcat 'isearch-text-char-description
1335 isearch-new-string "")))))
1337 (defun isearch-nonincremental-exit-minibuffer ()
1339 (setq isearch-nonincremental t)
1341 ;; Changing the value of `isearch-nonincremental' has no effect here,
1342 ;; because `isearch-edit-string' ignores this change. Thus marked as obsolete.
1343 (make-obsolete 'isearch-nonincremental-exit-minibuffer 'exit-minibuffer "24.4")
1345 (defun isearch-forward-exit-minibuffer ()
1346 "Resume isearching forward from the minibuffer that edits the search string."
1348 (setq isearch-new-forward t)
1351 (defun isearch-reverse-exit-minibuffer ()
1352 "Resume isearching backward from the minibuffer that edits the search string."
1354 (setq isearch-new-forward nil)
1357 (defun isearch-cancel ()
1358 "Terminate the search and go back to the starting point."
1360 (if (and isearch-push-state-function isearch-cmds)
1361 ;; For defined push-state function, restore the first state.
1362 ;; This calls pop-state function and restores original point.
1363 (let ((isearch-cmds (last isearch-cmds)))
1364 (isearch--set-state (car isearch-cmds)))
1365 (goto-char isearch-opoint))
1366 (isearch-done t) ; Exit isearch..
1367 (isearch-clean-overlays)
1368 (signal 'quit nil)) ; ..and pass on quit signal.
1370 (defun isearch-abort ()
1371 "Abort incremental search mode if searching is successful, signaling quit.
1372 Otherwise, revert to previous successful search and continue searching.
1373 Use `isearch-exit' to quit without signaling."
1375 ;; (ding) signal instead below, if quitting
1377 (if (and isearch-success (not isearch-error))
1378 ;; If search is successful and has no incomplete regexp,
1379 ;; move back to starting point and really do quit.
1381 (setq isearch-success nil)
1383 ;; If search is failing, or has an incomplete regexp,
1384 ;; rub out until it is once more successful.
1385 (while (or (not isearch-success) isearch-error)
1386 (isearch-pop-state))
1389 (defun isearch-repeat (direction)
1390 ;; Utility for isearch-repeat-forward and -backward.
1391 (if (eq isearch-forward (eq direction 'forward))
1392 ;; C-s in forward or C-r in reverse.
1393 (if (equal isearch-string "")
1394 ;; If search string is empty, use last one.
1395 (if (null (if isearch-regexp regexp-search-ring search-ring))
1396 (setq isearch-error "No previous search string")
1397 (setq isearch-string
1398 (car (if isearch-regexp regexp-search-ring search-ring))
1400 (mapconcat 'isearch-text-char-description
1402 isearch-case-fold-search isearch-last-case-fold-search)
1403 ;; After taking the last element, adjust ring to previous one.
1404 (isearch-ring-adjust1 nil))
1405 ;; If already have what to search for, repeat it.
1408 ;; Set isearch-wrapped before calling isearch-wrap-function
1409 (setq isearch-wrapped t)
1410 (if isearch-wrap-function
1411 (funcall isearch-wrap-function)
1412 (goto-char (if isearch-forward (point-min) (point-max)))))))
1413 ;; C-s in reverse or C-r in forward, change direction.
1414 (setq isearch-forward (not isearch-forward)
1417 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1419 (if (equal isearch-string "")
1420 (setq isearch-success t)
1421 (if (and isearch-success
1422 (equal (point) isearch-other-end)
1423 (not isearch-just-started))
1424 ;; If repeating a search that found
1425 ;; an empty string, ensure we advance.
1426 (if (if isearch-forward (eobp) (bobp))
1427 ;; If there's nowhere to advance to, fail (and wrap next time).
1429 (setq isearch-success nil)
1431 (forward-char (if isearch-forward 1 -1))
1435 (isearch-push-state)
1438 (defun isearch-repeat-forward ()
1439 "Repeat incremental search forwards."
1441 (isearch-repeat 'forward))
1443 (defun isearch-repeat-backward ()
1444 "Repeat incremental search backwards."
1446 (isearch-repeat 'backward))
1448 (defun isearch-toggle-regexp ()
1449 "Toggle regexp searching on or off."
1450 ;; The status stack is left unchanged.
1452 (setq isearch-regexp (not isearch-regexp))
1453 (if isearch-regexp (setq isearch-word nil))
1454 (setq isearch-success t isearch-adjusted t)
1457 (defun isearch-toggle-word ()
1458 "Toggle word searching on or off."
1459 ;; The status stack is left unchanged.
1461 (setq isearch-word (not isearch-word))
1462 (if isearch-word (setq isearch-regexp nil))
1463 (setq isearch-success t isearch-adjusted t)
1466 (defun isearch-toggle-symbol ()
1467 "Toggle symbol searching on or off."
1469 (setq isearch-word (unless (eq isearch-word 'isearch-symbol-regexp)
1470 'isearch-symbol-regexp))
1471 (if isearch-word (setq isearch-regexp nil))
1472 (setq isearch-success t isearch-adjusted t)
1475 (defun isearch-toggle-lax-whitespace ()
1476 "Toggle whitespace matching in searching on or off.
1477 In ordinary search, toggles the value of the variable
1478 `isearch-lax-whitespace'. In regexp search, toggles the
1479 value of the variable `isearch-regexp-lax-whitespace'."
1482 (setq isearch-regexp-lax-whitespace (not isearch-regexp-lax-whitespace))
1483 (setq isearch-lax-whitespace (not isearch-lax-whitespace)))
1484 (let ((message-log-max nil))
1485 (message "%s%s [%s]"
1486 (isearch-message-prefix nil isearch-nonincremental)
1488 (if (if isearch-regexp
1489 isearch-regexp-lax-whitespace
1490 isearch-lax-whitespace)
1491 "match spaces loosely"
1492 "match spaces literally")))
1493 (setq isearch-success t isearch-adjusted t)
1497 (defun isearch-toggle-case-fold ()
1498 "Toggle case folding in searching on or off.
1499 Toggles the value of the variable `isearch-case-fold-search'."
1501 (setq isearch-case-fold-search
1502 (if isearch-case-fold-search nil 'yes))
1503 (let ((message-log-max nil))
1504 (message "%s%s [case %ssensitive]"
1505 (isearch-message-prefix nil isearch-nonincremental)
1507 (if isearch-case-fold-search "in" "")))
1508 (setq isearch-success t isearch-adjusted t)
1512 (defun isearch-toggle-invisible ()
1513 "Toggle searching in invisible text on or off.
1514 Toggles the variable `isearch-invisible' between values
1515 nil and a non-nil value of the option `search-invisible'
1516 \(or `open' if `search-invisible' is nil)."
1518 (setq isearch-invisible
1519 (if isearch-invisible nil (or search-invisible 'open)))
1520 (let ((message-log-max nil))
1521 (message "%s%s [match %svisible text]"
1522 (isearch-message-prefix nil isearch-nonincremental)
1524 (if isearch-invisible "in" "")))
1525 (setq isearch-success t isearch-adjusted t)
1532 (defun word-search-regexp (string &optional lax)
1533 "Return a regexp which matches words, ignoring punctuation.
1534 Given STRING, a string of words separated by word delimiters,
1535 compute a regexp that matches those exact words separated by
1536 arbitrary punctuation. If the string begins or ends in whitespace,
1537 the beginning or the end of the string matches arbitrary whitespace.
1538 Otherwise if LAX is non-nil, the beginning or the end of the string
1539 need not match a word boundary.
1541 Used in `word-search-forward', `word-search-backward',
1542 `word-search-forward-lax', `word-search-backward-lax'."
1544 ((equal string "") "")
1545 ((string-match-p "\\`\\W+\\'" string) "\\W+")
1547 (if (string-match-p "\\`\\W" string) "\\W+"
1549 (mapconcat 'regexp-quote (split-string string "\\W+" t) "\\W+")
1550 (if (string-match-p "\\W\\'" string) "\\W+"
1551 (unless lax "\\>"))))))
1553 (defun word-search-backward (string &optional bound noerror count)
1554 "Search backward from point for STRING, ignoring differences in punctuation.
1555 Set point to the beginning of the occurrence found, and return point.
1556 An optional second argument bounds the search; it is a buffer position.
1557 The match found must not extend before that position.
1558 Optional third argument, if t, means if fail just return nil (no error).
1559 If not nil and not t, move to limit of search and return nil.
1560 Optional fourth argument is repeat count--search for successive occurrences.
1562 Relies on the function `word-search-regexp' to convert a sequence
1563 of words in STRING to a regexp used to search words without regard
1565 (interactive "sWord search backward: ")
1566 (re-search-backward (word-search-regexp string nil) bound noerror count))
1568 (defun word-search-forward (string &optional bound noerror count)
1569 "Search forward from point for STRING, ignoring differences in punctuation.
1570 Set point to the end of the occurrence found, and return point.
1571 An optional second argument bounds the search; it is a buffer position.
1572 The match found must not extend after that position.
1573 Optional third argument, if t, means if fail just return nil (no error).
1574 If not nil and not t, move to limit of search and return nil.
1575 Optional fourth argument is repeat count--search for successive occurrences.
1577 Relies on the function `word-search-regexp' to convert a sequence
1578 of words in STRING to a regexp used to search words without regard
1580 (interactive "sWord search: ")
1581 (re-search-forward (word-search-regexp string nil) bound noerror count))
1583 (defun word-search-backward-lax (string &optional bound noerror count)
1584 "Search backward from point for STRING, ignoring differences in punctuation.
1585 Set point to the beginning of the occurrence found, and return point.
1587 Unlike `word-search-backward', the end of STRING need not match a word
1588 boundary, unless STRING ends in whitespace.
1590 An optional second argument bounds the search; it is a buffer position.
1591 The match found must not extend before that position.
1592 Optional third argument, if t, means if fail just return nil (no error).
1593 If not nil and not t, move to limit of search and return nil.
1594 Optional fourth argument is repeat count--search for successive occurrences.
1596 Relies on the function `word-search-regexp' to convert a sequence
1597 of words in STRING to a regexp used to search words without regard
1599 (interactive "sWord search backward: ")
1600 (re-search-backward (word-search-regexp string t) bound noerror count))
1602 (defun word-search-forward-lax (string &optional bound noerror count)
1603 "Search forward from point for STRING, ignoring differences in punctuation.
1604 Set point to the end of the occurrence found, and return point.
1606 Unlike `word-search-forward', the end of STRING need not match a word
1607 boundary, unless STRING ends in whitespace.
1609 An optional second argument bounds the search; it is a buffer position.
1610 The match found must not extend after that position.
1611 Optional third argument, if t, means if fail just return nil (no error).
1612 If not nil and not t, move to limit of search and return nil.
1613 Optional fourth argument is repeat count--search for successive occurrences.
1615 Relies on the function `word-search-regexp' to convert a sequence
1616 of words in STRING to a regexp used to search words without regard
1618 (interactive "sWord search: ")
1619 (re-search-forward (word-search-regexp string t) bound noerror count))
1623 (defun isearch-symbol-regexp (string &optional lax)
1624 "Return a regexp which matches STRING as a symbol.
1625 Creates a regexp where STRING is surrounded by symbol delimiters \\_< and \\_>.
1626 If there are more than one symbol, then compute a regexp that matches
1627 those exact symbols separated by non-symbol characters. If the string
1628 begins or ends in whitespace, the beginning or the end of the string
1629 matches arbitrary non-symbol whitespace. Otherwise if LAX is non-nil,
1630 the beginning or the end of the string need not match a symbol boundary."
1631 (let ((not-word-symbol-re
1632 ;; This regexp matches all syntaxes except word and symbol syntax.
1633 ;; FIXME: Replace it with something shorter if possible (bug#14602).
1634 "\\(?:\\s-\\|\\s.\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s/\\|\\s$\\|\\s'\\|\\s<\\|\\s>\\|\\s@\\|\\s!\\|\\s|\\)+"))
1636 ((equal string "") "")
1637 ((string-match-p (format "\\`%s\\'" not-word-symbol-re) string) not-word-symbol-re)
1639 (if (string-match-p (format "\\`%s" not-word-symbol-re) string) not-word-symbol-re
1640 (unless lax "\\_<"))
1641 (mapconcat 'regexp-quote (split-string string not-word-symbol-re t) not-word-symbol-re)
1642 (if (string-match-p (format "%s\\'" not-word-symbol-re) string) not-word-symbol-re
1643 (unless lax "\\_>")))))))
1645 (put 'isearch-symbol-regexp 'isearch-message-prefix "symbol ")
1647 ;; Search with lax whitespace
1649 (defun search-forward-lax-whitespace (string &optional bound noerror count)
1650 "Search forward for STRING, matching a sequence of whitespace chars."
1651 (let ((search-spaces-regexp search-whitespace-regexp))
1652 (re-search-forward (regexp-quote string) bound noerror count)))
1654 (defun search-backward-lax-whitespace (string &optional bound noerror count)
1655 "Search backward for STRING, matching a sequence of whitespace chars."
1656 (let ((search-spaces-regexp search-whitespace-regexp))
1657 (re-search-backward (regexp-quote string) bound noerror count)))
1659 (defun re-search-forward-lax-whitespace (regexp &optional bound noerror count)
1660 "Search forward for REGEXP, matching a sequence of whitespace chars."
1661 (let ((search-spaces-regexp search-whitespace-regexp))
1662 (re-search-forward regexp bound noerror count)))
1664 (defun re-search-backward-lax-whitespace (regexp &optional bound noerror count)
1665 "Search backward for REGEXP, matching a sequence of whitespace chars."
1666 (let ((search-spaces-regexp search-whitespace-regexp))
1667 (re-search-backward regexp bound noerror count)))
1670 (defun isearch-query-replace (&optional arg regexp-flag)
1671 "Start `query-replace' with string to replace from last search string.
1672 The ARG (prefix arg if interactive), if non-nil, means replace
1673 only matches surrounded by word boundaries. A negative prefix
1674 arg means replace backward. Note that using the prefix arg
1675 is possible only when `isearch-allow-scroll' is non-nil or
1676 `isearch-allow-prefix' is non-nil, and it doesn't always provide the
1677 correct matches for `query-replace', so the preferred way to run word
1678 replacements from Isearch is `M-s w ... M-%'."
1680 (list current-prefix-arg))
1681 (barf-if-buffer-read-only)
1682 (if regexp-flag (setq isearch-regexp t))
1683 (let ((case-fold-search isearch-case-fold-search)
1684 ;; set `search-upper-case' to nil to not call
1685 ;; `isearch-no-upper-case-p' in `perform-replace'
1686 (search-upper-case nil)
1687 (search-invisible isearch-invisible)
1688 (replace-lax-whitespace
1689 isearch-lax-whitespace)
1690 (replace-regexp-lax-whitespace
1691 isearch-regexp-lax-whitespace)
1692 (delimited (and arg (not (eq arg '-))))
1693 (backward (and arg (eq arg '-)))
1694 ;; Set `isearch-recursive-edit' to nil to prevent calling
1695 ;; `exit-recursive-edit' in `isearch-done' that terminates
1696 ;; the execution of this command when it is non-nil.
1697 ;; We call `exit-recursive-edit' explicitly at the end below.
1698 (isearch-recursive-edit nil))
1699 (isearch-done nil t)
1700 (isearch-clean-overlays)
1701 (if (and isearch-other-end
1703 (> isearch-other-end (point))
1704 (< isearch-other-end (point)))
1705 (not (and transient-mark-mode mark-active
1708 (< (mark) (point))))))
1709 (goto-char isearch-other-end))
1710 (set query-replace-from-history-variable
1711 (cons isearch-string
1712 (symbol-value query-replace-from-history-variable)))
1715 (query-replace-read-to
1717 (concat "Query replace"
1718 (if (or delimited isearch-word)
1719 (let* ((symbol (or delimited isearch-word))
1720 (string (and symbol (symbolp symbol)
1721 (get symbol 'isearch-message-prefix))))
1722 (if (stringp string)
1723 ;; Move space from the end to the beginning.
1724 (replace-regexp-in-string "\\(.*\\) \\'" " \\1" string)
1727 (if isearch-regexp " regexp" "")
1728 (if backward " backward" "")
1729 (if (and transient-mark-mode mark-active) " in region" ""))
1731 t isearch-regexp (or delimited isearch-word) nil nil
1732 (if (and transient-mark-mode mark-active) (region-beginning))
1733 (if (and transient-mark-mode mark-active) (region-end))
1735 (and isearch-recursive-edit (exit-recursive-edit)))
1737 (defun isearch-query-replace-regexp (&optional arg)
1738 "Start `query-replace-regexp' with string to replace from last search string.
1739 See `isearch-query-replace' for more information."
1741 (list current-prefix-arg))
1742 (isearch-query-replace arg t))
1744 (defun isearch-occur (regexp &optional nlines)
1745 "Run `occur' using the last search string as the regexp.
1746 Interactively, REGEXP is constructed using the search string from the
1747 last search command. NLINES has the same meaning as in `occur'.
1749 If the last search command was a word search, REGEXP is computed from
1750 the search words, ignoring punctuation. If the last search
1751 command was a regular expression search, REGEXP is the regular
1752 expression used in that search. If the last search command searched
1753 for a literal string, REGEXP is constructed by quoting all the special
1754 characters in that string."
1756 (let* ((perform-collect (consp current-prefix-arg))
1758 ((functionp isearch-word)
1759 (funcall isearch-word isearch-string))
1760 (isearch-word (word-search-regexp isearch-string))
1761 (isearch-regexp isearch-string)
1762 (t (regexp-quote isearch-string)))))
1765 ;; Perform collect operation
1766 (if (zerop (regexp-opt-depth regexp))
1767 ;; No subexpression so collect the entire match.
1769 ;; Get the regexp for collection pattern.
1770 (let ((default (car occur-collect-regexp-history))
1772 (with-isearch-suspended
1773 (setq regexp-collect
1775 (format "Regexp to collect (default %s): " default)
1776 default 'occur-collect-regexp-history)))
1778 ;; Otherwise normal occur takes numerical prefix argument.
1779 (when current-prefix-arg
1780 (prefix-numeric-value current-prefix-arg))))))
1781 (let ((case-fold-search isearch-case-fold-search)
1782 ;; Set `search-upper-case' to nil to not call
1783 ;; `isearch-no-upper-case-p' in `occur-1'.
1784 (search-upper-case nil)
1785 (search-spaces-regexp
1786 (if (if isearch-regexp
1787 isearch-regexp-lax-whitespace
1788 isearch-lax-whitespace)
1789 search-whitespace-regexp)))
1790 (occur regexp nlines)))
1792 (declare-function hi-lock-read-face-name "hi-lock" ())
1794 (defun isearch-highlight-regexp ()
1795 "Run `highlight-regexp' with regexp from the current search string.
1796 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1797 argument from the last search regexp or a quoted search string,
1798 and reads its face argument using `hi-lock-read-face-name'."
1801 ;; Set `isearch-recursive-edit' to nil to prevent calling
1802 ;; `exit-recursive-edit' in `isearch-done' that terminates
1803 ;; the execution of this command when it is non-nil.
1804 ;; We call `exit-recursive-edit' explicitly at the end below.
1805 (isearch-recursive-edit nil))
1806 (isearch-done nil t)
1807 (isearch-clean-overlays))
1808 (require 'hi-lock nil t)
1809 (let ((regexp (cond ((functionp isearch-word)
1810 (funcall isearch-word isearch-string))
1811 (isearch-word (word-search-regexp isearch-string))
1812 (isearch-regexp isearch-string)
1813 ((if (and (eq isearch-case-fold-search t)
1815 (isearch-no-upper-case-p
1816 isearch-string isearch-regexp)
1817 isearch-case-fold-search)
1818 ;; Turn isearch-string into a case-insensitive
1822 (let ((s (string c)))
1823 (if (string-match "[[:alpha:]]" s)
1824 (format "[%s%s]" (upcase s) (downcase s))
1827 (t (regexp-quote isearch-string)))))
1828 (hi-lock-face-buffer regexp (hi-lock-read-face-name)))
1829 (and isearch-recursive-edit (exit-recursive-edit)))
1832 (defun isearch-delete-char ()
1833 "Discard last input item and move point back.
1834 Last input means the last character or the last isearch command
1835 that added or deleted characters from the search string,
1836 moved point, toggled regexp mode or case-sensitivity, etc.
1837 If no previous match was done, just beep."
1839 (if (null (cdr isearch-cmds))
1841 (isearch-pop-state))
1844 (defun isearch-del-char (&optional arg)
1845 "Delete character from end of search string and search again.
1846 Unlike `isearch-delete-char', it only deletes the last character,
1847 but doesn't cancel the effect of other isearch command.
1848 If search string is empty, just beep."
1850 (if (= 0 (length isearch-string))
1852 (setq isearch-string (substring isearch-string 0
1854 (length isearch-string))))
1855 isearch-message (mapconcat 'isearch-text-char-description
1856 isearch-string "")))
1857 ;; Use the isearch-other-end as new starting point to be able
1858 ;; to find the remaining part of the search string again.
1859 ;; This is like what `isearch-search-and-update' does,
1860 ;; but currently it doesn't support deletion of characters
1861 ;; for the case where unsuccessful search may become successful
1862 ;; by deletion of characters.
1863 (if isearch-other-end (goto-char isearch-other-end))
1865 (isearch-push-state)
1868 (defun isearch-yank-string (string)
1869 "Pull STRING into search string."
1870 ;; Downcase the string if not supposed to case-fold yanked strings.
1871 (if (and isearch-case-fold-search
1872 (eq 'not-yanks search-upper-case))
1873 (setq string (downcase string)))
1874 (if isearch-regexp (setq string (regexp-quote string)))
1875 ;; Don't move cursor in reverse search.
1876 (setq isearch-yank-flag t)
1877 (isearch-process-search-string
1878 string (mapconcat 'isearch-text-char-description string "")))
1880 (defun isearch-yank-kill ()
1881 "Pull string from kill ring into search string."
1883 (isearch-yank-string (current-kill 0)))
1885 (defun isearch-yank-pop ()
1886 "Replace just-yanked search string with previously killed string."
1888 (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop)))
1889 ;; Fall back on `isearch-yank-kill' for the benefits of people
1890 ;; who are used to the old behavior of `M-y' in isearch mode. In
1891 ;; future, this fallback may be changed if we ever change
1892 ;; `yank-pop' to do something like the kill-ring-browser.
1895 (isearch-yank-string (current-kill 1))))
1897 (defun isearch-yank-x-selection ()
1898 "Pull current X selection into search string."
1900 (isearch-yank-string (x-get-selection))
1901 ;; If `x-get-selection' returned the text from the active region,
1902 ;; then it "used" the mark which we should hence deactivate.
1903 (when select-active-regions (deactivate-mark)))
1906 (defun isearch-mouse-2 (click)
1907 "Handle mouse-2 in Isearch mode.
1908 For a click in the echo area, invoke `isearch-yank-x-selection'.
1909 Otherwise invoke whatever the calling mouse-2 command sequence
1910 is bound to outside of Isearch."
1912 (let* ((w (posn-window (event-start click)))
1913 (overriding-terminal-local-map nil)
1914 (binding (key-binding (this-command-keys-vector) t)))
1915 (if (and (window-minibuffer-p w)
1916 (not (minibuffer-window-active-p w))) ; in echo area
1917 (isearch-yank-x-selection)
1918 (when (functionp binding)
1919 (call-interactively binding)))))
1921 (defun isearch-yank-internal (jumpform)
1922 "Pull the text from point to the point reached by JUMPFORM.
1923 JUMPFORM is a lambda expression that takes no arguments and returns
1924 a buffer position, possibly having moved point to that position.
1925 For example, it might move point forward by a word and return point,
1926 or it might return the position of the end of the line."
1927 (isearch-yank-string
1929 (and (not isearch-forward) isearch-other-end
1930 (goto-char isearch-other-end))
1931 (buffer-substring-no-properties (point) (funcall jumpform)))))
1933 (defun isearch-yank-char-in-minibuffer (&optional arg)
1934 "Pull next character from buffer into end of search string in minibuffer."
1938 (with-current-buffer (cadr (buffer-list))
1939 (buffer-substring-no-properties
1940 (point) (progn (forward-char arg) (point)))))
1941 (forward-char arg)))
1943 (defun isearch-yank-char (&optional arg)
1944 "Pull next character from buffer into search string."
1946 (isearch-yank-internal (lambda () (forward-char arg) (point))))
1948 (declare-function subword-forward "subword" (&optional arg))
1949 (defun isearch-yank-word-or-char ()
1950 "Pull next character, subword or word from buffer into search string.
1951 Subword is used when `subword-mode' is activated. "
1953 (isearch-yank-internal
1955 (if (or (= (char-syntax (or (char-after) 0)) ?w)
1956 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
1957 (if (and (boundp 'subword-mode) subword-mode)
1960 (forward-char 1)) (point))))
1962 (defun isearch-yank-word (&optional arg)
1963 "Pull next word from buffer into search string."
1965 (isearch-yank-internal (lambda () (forward-word arg) (point))))
1967 (defun isearch-yank-line (&optional arg)
1968 "Pull rest of line from buffer into search string."
1970 (isearch-yank-internal
1971 (lambda () (let ((inhibit-field-text-motion t))
1972 (line-end-position (if (eolp) (1+ arg) arg))))))
1974 (defun isearch-char-by-name (&optional count)
1975 "Read a character by its Unicode name and add it to the search string.
1976 Completion is available like in `read-char-by-name' used by `insert-char'.
1977 With argument, add COUNT copies of the character."
1979 (with-isearch-suspended
1980 (let ((char (read-char-by-name "Add character to search (Unicode name or hex): ")))
1982 (let ((string (if (and (integerp count) (> count 1))
1983 (make-string count char)
1984 (char-to-string char))))
1985 (setq isearch-new-string (concat isearch-string string)
1986 isearch-new-message (concat isearch-message
1987 (mapconcat 'isearch-text-char-description
1990 (defun isearch-search-and-update ()
1991 ;; Do the search and update the display.
1992 (when (or isearch-success
1993 ;; Unsuccessful regexp search may become successful by
1994 ;; addition of characters which make isearch-string valid
1996 ;; If the string was found but was completely invisible,
1997 ;; it might now be partly visible, so try again.
1998 (prog1 isearch-hidden (setq isearch-hidden nil)))
1999 ;; In reverse search, adding stuff at
2000 ;; the end may cause zero or many more chars to be
2001 ;; matched, in the string following point.
2002 ;; Allow all those possibilities without moving point as
2003 ;; long as the match does not extend past search origin.
2004 (if (and (not isearch-forward) (not isearch-adjusted)
2006 (let ((case-fold-search isearch-case-fold-search))
2007 (if (and (eq case-fold-search t) search-upper-case)
2008 (setq case-fold-search
2009 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2011 ((functionp isearch-word)
2012 (funcall isearch-word isearch-string t))
2013 (isearch-word (word-search-regexp isearch-string t))
2014 (isearch-regexp isearch-string)
2015 (t (regexp-quote isearch-string)))))
2017 (or isearch-yank-flag
2019 (min isearch-opoint isearch-barrier))))
2021 (setq isearch-success t
2023 isearch-other-end (match-end 0))
2024 (if (and (eq isearch-case-fold-search t) search-upper-case)
2025 (setq isearch-case-fold-search
2026 (isearch-no-upper-case-p isearch-string isearch-regexp))))
2027 ;; Not regexp, not reverse, or no match at point.
2028 (if (and isearch-other-end (not isearch-adjusted))
2029 (goto-char (if isearch-forward isearch-other-end
2032 (1+ isearch-other-end)))))
2035 (isearch-push-state)
2036 (if isearch-op-fun (funcall isearch-op-fun))
2040 ;; *, ?, }, and | chars can make a regexp more liberal.
2041 ;; They can make a regexp match sooner or make it succeed instead of failing.
2042 ;; So go back to place last successful search started
2043 ;; or to the last ^S/^R (barrier), whichever is nearer.
2044 ;; + needs no special handling because the string must match at least once.
2046 (defun isearch-backslash (str)
2047 "Return t if STR ends in an odd number of backslashes."
2048 (= (mod (- (length str) (string-match "\\\\*\\'" str)) 2) 1))
2050 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
2051 "Return point to previous successful match to allow regexp liberalization.
2052 \\<isearch-mode-map>
2053 Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by \
2054 stopping at `isearch-barrier' as needed.
2056 Do nothing if a backslash is escaping the liberalizing character.
2057 If WANT-BACKSLASH is non-nil, invert this behavior (for \\} and \\|).
2059 Do nothing if regexp has recently been invalid unless optional
2060 ALLOW-INVALID non-nil.
2062 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
2064 ;; (eq (not a) (not b)) makes all non-nil values equivalent
2065 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
2066 (not want-backslash))
2067 ;; We have to check 2 stack frames because the last might be
2068 ;; invalid just because of a backslash.
2069 (or (not isearch-error)
2070 (not (isearch--state-error (cadr isearch-cmds)))
2073 (progn (goto-char isearch-barrier)
2074 (setq isearch-adjusted t))
2075 (let* ((stack isearch-cmds)
2076 (previous (cdr stack)) ; lookbelow in the stack
2077 (frame (car stack)))
2078 ;; Walk down the stack looking for a valid regexp (as of course only
2079 ;; they can be the previous successful match); this conveniently
2080 ;; removes all bracket-sets and groups that might be in the way, as
2081 ;; well as partial \{\} constructs that the code below leaves behind.
2082 ;; Also skip over postfix operators -- though horrid,
2083 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
2084 (while (and previous
2085 (or (isearch--state-error frame)
2086 (let* ((string (isearch--state-string frame))
2087 (lchar (aref string (1- (length string)))))
2088 ;; The operators aren't always operators; check
2089 ;; backslashes. This doesn't handle the case of
2090 ;; operators at the beginning of the regexp not
2091 ;; being special, but then we should fall back to
2092 ;; the barrier anyway because it's all optional.
2093 (if (isearch-backslash
2094 (isearch--state-string (car previous)))
2096 (memq lchar '(?* ?? ?+))))))
2097 (setq stack previous previous (cdr previous) frame (car stack)))
2099 ;; `stack' now refers the most recent valid regexp that is not at
2100 ;; all optional in its last term. Now dig one level deeper and find
2101 ;; what matched before that.
2102 (let ((last-other-end
2103 (or (and (car previous)
2104 (isearch--state-other-end (car previous)))
2106 (goto-char (if isearch-forward
2107 (max last-other-end isearch-barrier)
2108 (min last-other-end isearch-barrier)))
2109 (setq isearch-adjusted t)))))))
2111 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2112 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
2114 ;; The idea here is that certain vertical scrolling commands (like C-l
2115 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
2116 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
2117 ;; tamper with isearch's state, or move point. It is unacceptable for the
2118 ;; search string to be scrolled out of the current window. If a command
2119 ;; attempts this, we scroll the text back again.
2121 ;; We implement this feature with a property called `isearch-scroll'.
2122 ;; If a command's symbol has the value t for this property or for the
2123 ;; `scroll-command' property, it is a scrolling command. The feature
2124 ;; needs to be enabled by setting the customizable variable
2125 ;; `isearch-allow-scroll' to a non-nil value.
2127 ;; The universal argument commands (e.g. C-u) in simple.el are marked
2128 ;; as scrolling commands, and isearch.el has been amended to allow
2129 ;; prefix arguments to be passed through to scrolling commands. Thus
2130 ;; M-0 C-l will scroll point to the top of the window.
2132 ;; Horizontal scrolling commands are currently not catered for.
2133 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2135 ;; Set the isearch-scroll property on some standard functions:
2136 ;; Scroll-bar functions:
2137 (if (fboundp 'scroll-bar-toolkit-scroll)
2138 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
2139 (if (fboundp 'w32-handle-scroll-bar-event)
2140 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
2142 ;; Commands which scroll the window (some scroll commands
2143 ;; already have the `scroll-command' property on them):
2144 (put 'recenter 'isearch-scroll t)
2145 (put 'recenter-top-bottom 'isearch-scroll t)
2146 (put 'reposition-window 'isearch-scroll t)
2148 ;; Commands which act on the other window
2149 (put 'list-buffers 'isearch-scroll t)
2150 (put 'scroll-other-window 'isearch-scroll t)
2151 (put 'scroll-other-window-down 'isearch-scroll t)
2152 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
2153 (put 'end-of-buffer-other-window 'isearch-scroll t)
2155 ;; Commands which change the window layout
2156 (put 'delete-other-windows 'isearch-scroll t)
2157 (put 'balance-windows 'isearch-scroll t)
2158 (put 'split-window-right 'isearch-scroll t)
2159 (put 'split-window-below 'isearch-scroll t)
2160 (put 'enlarge-window 'isearch-scroll t)
2162 ;; Aliases for split-window-*
2163 (put 'split-window-vertically 'isearch-scroll t)
2164 (put 'split-window-horizontally 'isearch-scroll t)
2166 ;; Universal argument commands
2167 (put 'universal-argument 'isearch-scroll t)
2168 (put 'negative-argument 'isearch-scroll t)
2169 (put 'digit-argument 'isearch-scroll t)
2171 (defcustom isearch-allow-scroll nil
2172 "Whether scrolling is allowed during incremental search.
2173 If non-nil, scrolling commands can be used in Isearch mode.
2174 However, the current match will never scroll offscreen.
2175 If nil, scrolling commands will first cancel Isearch mode."
2179 (defcustom isearch-allow-prefix t
2180 "Whether prefix arguments are allowed during incremental search.
2181 If non-nil, entering a prefix argument will not terminate the
2182 search. This option is ignored \(presumed t) when
2183 `isearch-allow-scroll' is set."
2188 (defun isearch-string-out-of-window (isearch-point)
2189 "Test whether the search string is currently outside of the window.
2190 Return nil if it's completely visible, or if point is visible,
2191 together with as much of the search string as will fit; the symbol
2192 `above' if we need to scroll the text downwards; the symbol `below',
2194 (let ((w-start (window-start))
2195 (w-end (window-end nil t))
2196 (w-L1 (save-excursion (move-to-window-line 1) (point)))
2197 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
2198 start end) ; start and end of search string in buffer
2200 (setq end isearch-point start (or isearch-other-end isearch-point))
2201 (setq start isearch-point end (or isearch-other-end isearch-point)))
2202 (cond ((or (and (>= start w-start) (<= end w-end))
2204 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
2205 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
2207 ((and (< start w-start)
2208 (< isearch-point w-L-1))
2212 (defun isearch-back-into-window (above isearch-point)
2213 "Scroll the window to bring the search string back into view.
2214 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
2215 search string is above the top of the window, nil when it is beneath
2219 (setq end isearch-point start (or isearch-other-end isearch-point))
2220 (setq start isearch-point end (or isearch-other-end isearch-point)))
2225 (when (>= isearch-point (window-end nil t))
2226 (goto-char isearch-point)
2230 (when (< isearch-point (window-start))
2231 (goto-char isearch-point)
2233 (goto-char isearch-point))
2235 (defvar isearch-pre-scroll-point nil)
2237 (defun isearch-pre-command-hook ()
2238 "Decide whether to exit Isearch mode before executing the command.
2239 Don't exit Isearch if the key sequence that invoked this command
2240 is bound in `isearch-mode-map', or if the invoked command is
2241 a prefix argument command (when `isearch-allow-prefix' is non-nil),
2242 or it is a scrolling command (when `isearch-allow-scroll' is non-nil).
2243 Otherwise, exit Isearch (when `search-exit-option' is non-nil)
2244 before the command is executed globally with terminated Isearch."
2245 (let* ((key (this-single-command-keys))
2246 (main-event (aref key 0)))
2248 ;; Don't exit Isearch if we're in the middle of some
2249 ;; set-temporary-overlay-map thingy like universal-argument--mode.
2250 ((not (eq overriding-terminal-local-map isearch--saved-overriding-local-map)))
2251 ;; Don't exit Isearch for isearch key bindings.
2252 ((commandp (lookup-key isearch-mode-map key nil)))
2253 ;; Optionally edit the search string instead of exiting.
2254 ((eq search-exit-option 'edit)
2255 (setq this-command 'isearch-edit-string))
2256 ;; Handle a scrolling function or prefix argument.
2257 ((or (and isearch-allow-prefix
2258 (memq this-command '(universal-argument
2259 digit-argument negative-argument)))
2260 (and isearch-allow-scroll
2261 (symbolp this-command)
2262 (or (eq (get this-command 'isearch-scroll) t)
2263 (eq (get this-command 'scroll-command) t))))
2264 (when isearch-allow-scroll
2265 (setq isearch-pre-scroll-point (point))))
2266 ;; A mouse click on the isearch message starts editing the search string.
2267 ((and (eq (car-safe main-event) 'down-mouse-1)
2268 (window-minibuffer-p (posn-window (event-start main-event))))
2269 ;; Swallow the up-event.
2271 (setq this-command 'isearch-edit-string))
2272 ;; Other characters terminate the search and are then executed normally.
2275 (isearch-clean-overlays))
2276 ;; If search-exit-option is nil, run the command without exiting Isearch.
2278 (isearch-process-search-string key key)))))
2280 (defun isearch-post-command-hook ()
2281 (when isearch-pre-scroll-point
2282 (let ((ab-bel (isearch-string-out-of-window isearch-pre-scroll-point)))
2284 (isearch-back-into-window (eq ab-bel 'above) isearch-pre-scroll-point)
2285 (goto-char isearch-pre-scroll-point)))
2286 (setq isearch-pre-scroll-point nil)
2289 (defun isearch-quote-char (&optional count)
2290 "Quote special characters for incremental search.
2291 With argument, add COUNT copies of the character."
2293 (let ((char (read-quoted-char (isearch-message t))))
2294 ;; Assume character codes 0200 - 0377 stand for characters in some
2295 ;; single-byte character set, and convert them to Emacs
2297 (if (and isearch-regexp isearch-regexp-lax-whitespace (= char ?\s))
2298 (if (subregexp-context-p isearch-string (length isearch-string))
2299 (isearch-process-search-string "[ ]" " ")
2300 (isearch-process-search-char char count))
2301 ;; This used to assume character codes 0240 - 0377 stand for
2302 ;; characters in some single-byte character set, and converted them
2303 ;; to Emacs characters. But in 23.1 this feature is deprecated
2304 ;; in favor of inserting the corresponding Unicode characters.
2305 ;; (and enable-multibyte-characters
2308 ;; (setq char (unibyte-char-to-multibyte char)))
2309 (isearch-process-search-char char count))))
2311 (defun isearch-printing-char (&optional char count)
2312 "Add this ordinary printing CHAR to the search string and search.
2313 With argument, add COUNT copies of the character."
2314 (interactive (list last-command-event
2315 (prefix-numeric-value current-prefix-arg)))
2316 (let ((char (or char last-command-event)))
2319 (if current-input-method
2320 (isearch-process-search-multibyte-characters char count)
2321 (isearch-process-search-char char count))))
2323 (defun isearch-process-search-char (char &optional count)
2324 ;; * and ? are special in regexps when not preceded by \.
2325 ;; } and | are special in regexps when preceded by \.
2326 ;; Nothing special for + because it matches at least once.
2328 ((memq char '(?* ??)) (isearch-fallback nil))
2329 ((eq char ?\}) (isearch-fallback t t))
2330 ((eq char ?|) (isearch-fallback t nil t)))
2332 ;; Append the char(s) to the search string,
2333 ;; update the message and re-search.
2334 (let* ((string (if (and (integerp count) (> count 1))
2335 (make-string count char)
2336 (char-to-string char)))
2337 (message (if (>= char ?\200)
2339 (mapconcat 'isearch-text-char-description string ""))))
2340 (isearch-process-search-string string message)))
2342 (defun isearch-process-search-string (string message)
2343 (setq isearch-string (concat isearch-string string)
2344 isearch-message (concat isearch-message message))
2345 (isearch-search-and-update))
2350 (defun isearch-ring-adjust1 (advance)
2351 ;; Helper for isearch-ring-adjust
2352 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2353 (length (length ring))
2354 (yank-pointer-name (if isearch-regexp
2355 'regexp-search-ring-yank-pointer
2356 'search-ring-yank-pointer))
2357 (yank-pointer (eval yank-pointer-name)))
2360 (set yank-pointer-name
2362 (mod (+ (or yank-pointer (if advance 0 -1))
2365 (setq isearch-string (nth yank-pointer ring)
2366 isearch-message (mapconcat 'isearch-text-char-description
2367 isearch-string "")))))
2369 (defun isearch-ring-adjust (advance)
2370 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2371 (isearch-ring-adjust1 advance)
2372 (if search-ring-update
2375 (isearch-push-state)
2377 ;; Otherwise, edit the search string instead. Note that there is
2378 ;; no need to push the search state after isearch-edit-string here
2379 ;; since isearch-edit-string already pushes its state
2380 (isearch-edit-string)))
2382 (defun isearch-ring-advance ()
2383 "Advance to the next search string in the ring."
2384 ;; This could be more general to handle a prefix arg, but who would use it.
2386 (isearch-ring-adjust 'advance))
2388 (defun isearch-ring-retreat ()
2389 "Retreat to the previous search string in the ring."
2391 (isearch-ring-adjust nil))
2393 (defun isearch-complete1 ()
2394 ;; Helper for isearch-complete and isearch-complete-edit
2395 ;; Return t if completion OK, nil if no completion exists.
2396 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2397 (completion-ignore-case case-fold-search)
2398 (completion (try-completion isearch-string ring)))
2401 ;; isearch-string stays the same
2403 ((or completion ; not nil, must be a string
2404 (= 0 (length isearch-string))) ; shouldn't have to say this
2405 (if (equal completion isearch-string) ;; no extension?
2407 (if completion-auto-help
2408 (with-output-to-temp-buffer "*Isearch completions*"
2409 (display-completion-list
2410 (all-completions isearch-string ring))))
2413 (setq isearch-string completion))))
2415 (message "No completion") ; waits a second if in minibuffer
2418 (defun isearch-complete ()
2419 "Complete the search string from the strings on the search ring.
2420 The completed string is then editable in the minibuffer.
2421 If there is no completion possible, say so and continue searching."
2423 (if (isearch-complete1)
2424 (progn (setq isearch-message
2425 (mapconcat 'isearch-text-char-description
2427 (isearch-edit-string))
2432 (defun isearch-complete-edit ()
2433 "Same as `isearch-complete' except in the minibuffer."
2435 (setq isearch-string (field-string))
2436 (if (isearch-complete1)
2439 (insert isearch-string))))
2444 (defun isearch-message (&optional c-q-hack ellipsis)
2445 ;; Generate and print the message string.
2446 (let ((cursor-in-echo-area ellipsis)
2448 (fail-pos (isearch-fail-pos t)))
2449 ;; Highlight failed part
2451 (setq m (copy-sequence m))
2452 (add-text-properties fail-pos (length m) '(face isearch-fail) m)
2453 ;; Highlight failed trailing whitespace
2454 (when (string-match " +$" m)
2455 (add-text-properties (match-beginning 0) (match-end 0)
2456 '(face trailing-whitespace) m)))
2458 (isearch-message-prefix ellipsis isearch-nonincremental)
2460 (isearch-message-suffix c-q-hack)))
2461 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2463 (defun isearch-message-prefix (&optional ellipsis nonincremental)
2464 ;; If about to search, and previous search regexp was invalid,
2465 ;; check that it still is. If it is valid now,
2466 ;; let the message we display while searching say that it is valid.
2467 (and isearch-error ellipsis
2469 (progn (re-search-forward isearch-string (point) t)
2470 (setq isearch-error nil))
2472 ;; If currently failing, display no ellipsis.
2473 (or isearch-success (setq ellipsis nil))
2474 (let ((m (concat (if isearch-success "" "failing ")
2475 (if isearch-adjusted "pending " "")
2476 (if (and isearch-wrapped
2477 (not isearch-wrap-function)
2479 (> (point) isearch-opoint)
2480 (< (point) isearch-opoint)))
2482 (if isearch-wrapped "wrapped ")
2484 (advice-function-mapc
2486 (let ((np (cdr (assq 'isearch-message-prefix props))))
2487 (if np (setq prefix (concat np prefix)))))
2488 isearch-filter-predicate)
2491 (or (and (symbolp isearch-word)
2492 (get isearch-word 'isearch-message-prefix))
2495 (if isearch-regexp "regexp " "")
2496 (if multi-isearch-next-buffer-current-function "multi " "")
2497 (or isearch-message-prefix-add "")
2498 (if nonincremental "search" "I-search")
2499 (if isearch-forward "" " backward")
2500 (if current-input-method
2501 ;; Input methods for RTL languages use RTL
2502 ;; characters for their title, and that messes
2503 ;; up the display of search text after the prompt.
2504 (bidi-string-mark-left-to-right
2505 (concat " [" current-input-method-title "]: "))
2508 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2509 'face 'minibuffer-prompt)))
2511 (defun isearch-message-suffix (&optional c-q-hack)
2512 (concat (if c-q-hack "^Q" "")
2514 (concat " [" isearch-error "]")
2516 (or isearch-message-suffix-add "")))
2521 (defvar isearch-search-fun-function 'isearch-search-fun-default
2522 "Non-default value overrides the behavior of `isearch-search-fun-default'.
2523 This variable's value should be a function, which will be called
2524 with no arguments, and should return a function that takes three
2525 arguments: STRING, BOUND, and NOERROR.
2527 This returned function will be used by `isearch-search-string' to
2528 search for the first occurrence of STRING or its translation.")
2530 (defun isearch-search-fun ()
2531 "Return the function to use for the search.
2532 Can be changed via `isearch-search-fun-function' for special needs."
2533 (funcall (or isearch-search-fun-function 'isearch-search-fun-default)))
2535 (defun isearch-search-fun-default ()
2536 "Return default functions to use for the search."
2539 (lambda (string &optional bound noerror count)
2540 ;; Use lax versions to not fail at the end of the word while
2541 ;; the user adds and removes characters in the search string
2542 ;; (or when using nonincremental word isearch)
2543 (let ((lax (not (or isearch-nonincremental
2544 (null (car isearch-cmds))
2545 (eq (length isearch-string)
2546 (length (isearch--state-string
2547 (car isearch-cmds))))))))
2549 (if isearch-forward #'re-search-forward #'re-search-backward)
2550 (if (functionp isearch-word)
2551 (funcall isearch-word string lax)
2552 (word-search-regexp string lax))
2553 bound noerror count))))
2554 ((and isearch-regexp isearch-regexp-lax-whitespace
2555 search-whitespace-regexp)
2557 're-search-forward-lax-whitespace
2558 're-search-backward-lax-whitespace))
2560 (if isearch-forward 're-search-forward 're-search-backward))
2561 ((and isearch-lax-whitespace search-whitespace-regexp)
2563 'search-forward-lax-whitespace
2564 'search-backward-lax-whitespace))
2566 (if isearch-forward 'search-forward 'search-backward))))
2568 (defun isearch-search-string (string bound noerror)
2569 "Search for the first occurrence of STRING or its translation.
2570 If found, move point to the end of the occurrence,
2571 update the match data, and return point."
2572 (let* ((func (isearch-search-fun))
2573 (pos1 (save-excursion (funcall func string bound noerror)))
2576 ;; Avoid "obsolete" warnings for translation-table-for-input.
2578 (char-table-p translation-table-for-input))
2579 (multibyte-string-p string)
2580 ;; Minor optimization.
2581 (string-match-p "[^[:ascii:]]" string))
2586 ;; Avoid "obsolete" warnings for
2587 ;; translation-table-for-input.
2589 (aref translation-table-for-input c))
2596 (if (setq pos2 (funcall func translated bound noerror))
2597 (setq match-data (match-data t)))))
2600 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2602 (set-match-data match-data)))))
2604 ;; When using multiple buffers isearch, switch to the new buffer here,
2605 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2606 (if (and multi-isearch-next-buffer-current-function
2607 (buffer-live-p multi-isearch-current-buffer))
2608 (switch-to-buffer multi-isearch-current-buffer))
2612 (defun isearch-search ()
2613 ;; Do the search with the current search string.
2614 (if isearch-message-function
2615 (funcall isearch-message-function nil t)
2616 (isearch-message nil t))
2617 (if (and (eq isearch-case-fold-search t) search-upper-case)
2618 (setq isearch-case-fold-search
2619 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2620 (condition-case lossage
2621 (let ((inhibit-point-motion-hooks isearch-invisible)
2623 (case-fold-search isearch-case-fold-search)
2624 (search-invisible isearch-invisible)
2626 (setq isearch-error nil)
2628 (setq isearch-success
2629 (isearch-search-string isearch-string nil t))
2630 ;; Clear RETRY unless the search predicate says
2631 ;; to skip this search hit.
2632 (if (or (not isearch-success)
2634 (= (match-beginning 0) (match-end 0))
2635 (funcall isearch-filter-predicate
2636 (match-beginning 0) (match-end 0)))
2638 (setq isearch-just-started nil)
2640 (setq isearch-other-end
2641 (if isearch-forward (match-beginning 0) (match-end 0)))))
2643 (quit (isearch-unread ?\C-g)
2644 (setq isearch-success nil))
2647 (setq isearch-error (car (cdr lossage)))
2650 "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
2652 (setq isearch-error "incomplete input"))
2653 ((and (not isearch-regexp)
2654 (string-match "\\`Regular expression too big" isearch-error))
2657 (setq isearch-error "Too many words"))
2658 ((and isearch-lax-whitespace search-whitespace-regexp)
2659 (setq isearch-error "Too many spaces for whitespace matching"))))))
2662 (setq isearch-success nil)
2663 (setq isearch-error (nth 2 lossage)))
2666 ;; stack overflow in regexp search.
2667 (setq isearch-error (format "%s" lossage))))
2671 ;; Ding if failed this time after succeeding last time.
2672 (and (isearch--state-success (car isearch-cmds))
2674 (if (functionp (isearch--state-pop-fun (car isearch-cmds)))
2675 (funcall (isearch--state-pop-fun (car isearch-cmds))
2676 (car isearch-cmds)))
2677 (goto-char (isearch--state-point (car isearch-cmds)))))
2680 ;; Called when opening an overlay, and we are still in isearch.
2681 (defun isearch-open-overlay-temporary (ov)
2682 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2683 ;; Some modes would want to open the overlays temporary during
2684 ;; isearch in their own way, they should set the
2685 ;; `isearch-open-invisible-temporary' to a function doing this.
2686 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2687 ;; Store the values for the `invisible' and `intangible'
2688 ;; properties, and then set them to nil. This way the text hidden
2689 ;; by this overlay becomes visible.
2691 ;; Do we really need to set the `intangible' property to t? Can we
2692 ;; have the point inside an overlay with an `intangible' property?
2693 ;; In 19.34 this does not exist so I cannot test it.
2694 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2695 (overlay-put ov 'isearch-intangible (overlay-get ov 'intangible))
2696 (overlay-put ov 'invisible nil)
2697 (overlay-put ov 'intangible nil)))
2700 ;; This is called at the end of isearch. It will open the overlays
2701 ;; that contain the latest match. Obviously in case of a C-g the
2702 ;; point returns to the original location which surely is not contain
2703 ;; in any of these overlays, se we are safe in this case too.
2704 (defun isearch-open-necessary-overlays (ov)
2705 (let ((inside-overlay (and (> (point) (overlay-start ov))
2706 (< (point) (overlay-end ov))))
2707 ;; If this exists it means that the overlay was opened using
2708 ;; this function, not by us tweaking the overlay properties.
2709 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2710 (when (or inside-overlay (not fct-temp))
2711 ;; restore the values for the `invisible' and `intangible'
2713 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2714 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2715 (overlay-put ov 'isearch-invisible nil)
2716 (overlay-put ov 'isearch-intangible nil))
2718 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2720 (funcall fct-temp ov t)))))
2722 ;; This is called when exiting isearch. It closes the temporary
2723 ;; opened overlays, except the ones that contain the latest match.
2724 (defun isearch-clean-overlays ()
2725 (when isearch-opened-overlays
2726 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2727 (setq isearch-opened-overlays nil)))
2730 (defun isearch-intersects-p (start0 end0 start1 end1)
2731 "Return t if regions START0..END0 and START1..END1 intersect."
2732 (or (and (>= start0 start1) (< start0 end1))
2733 (and (> end0 start1) (<= end0 end1))
2734 (and (>= start1 start0) (< start1 end0))
2735 (and (> end1 start0) (<= end1 end0))))
2738 ;; Verify if the current match is outside of each element of
2739 ;; `isearch-opened-overlays', if so close that overlay.
2741 (defun isearch-close-unnecessary-overlays (begin end)
2742 (let ((overlays isearch-opened-overlays))
2743 (setq isearch-opened-overlays nil)
2744 (dolist (ov overlays)
2745 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2746 (push ov isearch-opened-overlays)
2747 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2749 ;; If this exists it means that the overlay was opened
2750 ;; using this function, not by us tweaking the overlay
2752 (funcall fct-temp ov t)
2753 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2754 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2755 (overlay-put ov 'isearch-invisible nil)
2756 (overlay-put ov 'isearch-intangible nil)))))))
2759 (defun isearch-range-invisible (beg end)
2760 "Return t if all the text from BEG to END is invisible."
2762 ;; Check that invisibility runs up to END.
2765 (let (;; can-be-opened keeps track if we can open some overlays.
2766 (can-be-opened (eq search-invisible 'open))
2767 ;; the list of overlays that could be opened
2769 (when (and can-be-opened isearch-hide-immediately)
2770 (isearch-close-unnecessary-overlays beg end))
2771 ;; If the following character is currently invisible,
2772 ;; skip all characters with that same `invisible' property value.
2773 ;; Do that over and over.
2774 (while (and (< (point) end) (invisible-p (point)))
2775 (if (invisible-p (get-text-property (point) 'invisible))
2777 (goto-char (next-single-property-change (point) 'invisible
2779 ;; if text is hidden by an `invisible' text property
2780 ;; we cannot open it at all.
2781 (setq can-be-opened nil))
2783 (let ((overlays (overlays-at (point)))
2788 (setq o (car overlays)
2789 invis-prop (overlay-get o 'invisible))
2790 (if (invisible-p invis-prop)
2791 (if (overlay-get o 'isearch-open-invisible)
2792 (setq ov-list (cons o ov-list))
2793 ;; We found one overlay that cannot be
2794 ;; opened, that means the whole chunk
2795 ;; cannot be opened.
2796 (setq can-be-opened nil)))
2797 (setq overlays (cdr overlays)))
2799 ;; It makes sense to append to the open
2800 ;; overlays list only if we know that this is
2802 (setq crt-overlays (append ov-list crt-overlays)))))
2803 (goto-char (next-overlay-change (point)))))
2804 ;; See if invisibility reaches up thru END.
2805 (if (>= (point) end)
2806 (if (and can-be-opened (consp crt-overlays))
2808 (setq isearch-opened-overlays
2809 (append isearch-opened-overlays crt-overlays))
2810 (mapc 'isearch-open-overlay-temporary crt-overlays)
2812 (setq isearch-hidden t)))))))
2814 (defun isearch-filter-visible (beg end)
2815 "Test whether the current search hit is visible at least partially.
2816 Return non-nil if the text from BEG to END is visible to Isearch as
2817 determined by `isearch-range-invisible' unless invisible text can be
2818 searched too when `search-invisible' is t."
2819 (or (eq search-invisible t)
2820 (not (isearch-range-invisible beg end))))
2823 ;; General utilities
2825 (defun isearch-no-upper-case-p (string regexp-flag)
2826 "Return t if there are no upper case chars in STRING.
2827 If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
2828 since they have special meaning in a regexp."
2829 (let (quote-flag (i 0) (len (length string)) found)
2830 (while (and (not found) (< i len))
2831 (let ((char (aref string i)))
2832 (if (and regexp-flag (eq char ?\\))
2833 (setq quote-flag (not quote-flag))
2834 (if (and (not quote-flag) (not (eq char (downcase char))))
2836 (setq quote-flag nil)))
2839 ;; Even if there's no uppercase char, we want to detect the use
2840 ;; of [:upper:] or [:lower:] char-class, which indicates
2841 ;; clearly that the user cares about case distinction.
2842 (and regexp-flag (string-match "\\[:\\(upp\\|low\\)er:]" string)
2845 (string-match (substring string 0 (match-beginning 0))
2849 (equal "Unmatched [ or [^" (cadr err)))))))))
2851 ;; Portability functions to support various Emacs versions.
2853 (defun isearch-text-char-description (c)
2855 ((< c ?\s) (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph))
2856 ((= c ?\^?) (propertize "^?" 'face 'escape-glyph))
2857 (t (char-to-string c))))
2859 ;; General function to unread characters or events.
2860 ;; Also insert them in a keyboard macro being defined.
2861 (defun isearch-unread (&rest char-or-events)
2862 (mapc 'store-kbd-macro-event char-or-events)
2863 (setq unread-command-events
2864 (append char-or-events unread-command-events)))
2869 (defvar isearch-overlay nil)
2871 (defun isearch-highlight (beg end)
2872 (if search-highlight
2874 ;; Overlay already exists, just move it.
2875 (move-overlay isearch-overlay beg end (current-buffer))
2876 ;; Overlay doesn't exist, create it.
2877 (setq isearch-overlay (make-overlay beg end))
2878 ;; 1001 is higher than lazy's 1000 and ediff's 100+
2879 (overlay-put isearch-overlay 'priority 1001)
2880 (overlay-put isearch-overlay 'face isearch-face))))
2882 (defun isearch-dehighlight ()
2883 (when isearch-overlay
2884 (delete-overlay isearch-overlay)))
2886 ;; isearch-lazy-highlight feature
2887 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
2889 ;; When active, *every* match for the current search string is
2890 ;; highlighted: the current one using the normal isearch match color
2891 ;; and all the others using `isearch-lazy-highlight'. The extra
2892 ;; highlighting makes it easier to anticipate where the cursor will
2893 ;; land each time you press C-s or C-r to repeat a pending search.
2894 ;; Highlighting of these additional matches happens in a deferred
2895 ;; fashion using "idle timers," so the cycles needed do not rob
2896 ;; isearch of its usual snappy response.
2898 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
2900 ;; - `isearch-update' is expected to be called (at least) every time
2901 ;; the search string or window-start changes;
2902 ;; - `isearch-string' is expected to contain the current search
2903 ;; string as entered by the user;
2904 ;; - the type of the current search is expected to be given by
2905 ;; `isearch-word' and `isearch-regexp';
2906 ;; - the direction of the current search is expected to be given by
2907 ;; `isearch-forward';
2908 ;; - the variable `isearch-error' is expected to be true
2909 ;; only if `isearch-string' is an invalid regexp.
2911 (defvar isearch-lazy-highlight-overlays nil)
2912 (defvar isearch-lazy-highlight-wrapped nil)
2913 (defvar isearch-lazy-highlight-start-limit nil)
2914 (defvar isearch-lazy-highlight-end-limit nil)
2915 (defvar isearch-lazy-highlight-start nil)
2916 (defvar isearch-lazy-highlight-end nil)
2917 (defvar isearch-lazy-highlight-timer nil)
2918 (defvar isearch-lazy-highlight-last-string nil)
2919 (defvar isearch-lazy-highlight-window nil)
2920 (defvar isearch-lazy-highlight-window-start nil)
2921 (defvar isearch-lazy-highlight-window-end nil)
2922 (defvar isearch-lazy-highlight-case-fold-search nil)
2923 (defvar isearch-lazy-highlight-regexp nil)
2924 (defvar isearch-lazy-highlight-lax-whitespace nil)
2925 (defvar isearch-lazy-highlight-regexp-lax-whitespace nil)
2926 (defvar isearch-lazy-highlight-word nil)
2927 (defvar isearch-lazy-highlight-forward nil)
2928 (defvar isearch-lazy-highlight-error nil)
2930 (defun lazy-highlight-cleanup (&optional force)
2931 "Stop lazy highlighting and remove extra highlighting from current buffer.
2932 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
2933 is nil. This function is called when exiting an incremental search if
2934 `lazy-highlight-cleanup' is non-nil."
2936 (if (or force lazy-highlight-cleanup)
2937 (while isearch-lazy-highlight-overlays
2938 (delete-overlay (car isearch-lazy-highlight-overlays))
2939 (setq isearch-lazy-highlight-overlays
2940 (cdr isearch-lazy-highlight-overlays))))
2941 (when isearch-lazy-highlight-timer
2942 (cancel-timer isearch-lazy-highlight-timer)
2943 (setq isearch-lazy-highlight-timer nil)))
2945 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
2946 'lazy-highlight-cleanup
2949 (defun isearch-lazy-highlight-new-loop (&optional beg end)
2950 "Cleanup any previous `lazy-highlight' loop and begin a new one.
2951 BEG and END specify the bounds within which highlighting should occur.
2952 This is called when `isearch-update' is invoked (which can cause the
2953 search string to change or the window to scroll). It is also used
2954 by other Emacs features."
2955 (when (and (null executing-kbd-macro)
2956 (sit-for 0) ;make sure (window-start) is credible
2957 (or (not (equal isearch-string
2958 isearch-lazy-highlight-last-string))
2959 (not (eq (selected-window)
2960 isearch-lazy-highlight-window))
2961 (not (eq isearch-lazy-highlight-case-fold-search
2962 isearch-case-fold-search))
2963 (not (eq isearch-lazy-highlight-regexp
2965 (not (eq isearch-lazy-highlight-word
2967 (not (eq isearch-lazy-highlight-lax-whitespace
2968 isearch-lax-whitespace))
2969 (not (eq isearch-lazy-highlight-regexp-lax-whitespace
2970 isearch-regexp-lax-whitespace))
2971 (not (= (window-start)
2972 isearch-lazy-highlight-window-start))
2973 (not (= (window-end) ; Window may have been split/joined.
2974 isearch-lazy-highlight-window-end))
2975 (not (eq isearch-forward
2976 isearch-lazy-highlight-forward))
2977 ;; In case we are recovering from an error.
2978 (not (equal isearch-error
2979 isearch-lazy-highlight-error))))
2980 ;; something important did indeed change
2981 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
2982 (setq isearch-lazy-highlight-error isearch-error)
2983 ;; It used to check for `(not isearch-error)' here, but actually
2984 ;; lazy-highlighting might find matches to highlight even when
2985 ;; `isearch-error' is non-nil. (Bug#9918)
2986 (setq isearch-lazy-highlight-start-limit beg
2987 isearch-lazy-highlight-end-limit end)
2988 (setq isearch-lazy-highlight-window (selected-window)
2989 isearch-lazy-highlight-window-start (window-start)
2990 isearch-lazy-highlight-window-end (window-end)
2991 ;; Start lazy-highlighting at the beginning of the found
2992 ;; match (`isearch-other-end'). If no match, use point.
2993 ;; One of the next two variables (depending on search direction)
2994 ;; is used to define the starting position of lazy-highlighting
2995 ;; and also to remember the current position of point between
2996 ;; calls of `isearch-lazy-highlight-update', and another variable
2997 ;; is used to define where the wrapped search must stop.
2998 isearch-lazy-highlight-start (or isearch-other-end (point))
2999 isearch-lazy-highlight-end (or isearch-other-end (point))
3000 isearch-lazy-highlight-wrapped nil
3001 isearch-lazy-highlight-last-string isearch-string
3002 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
3003 isearch-lazy-highlight-regexp isearch-regexp
3004 isearch-lazy-highlight-lax-whitespace isearch-lax-whitespace
3005 isearch-lazy-highlight-regexp-lax-whitespace isearch-regexp-lax-whitespace
3006 isearch-lazy-highlight-word isearch-word
3007 isearch-lazy-highlight-forward isearch-forward)
3008 (unless (equal isearch-string "")
3009 (setq isearch-lazy-highlight-timer
3010 (run-with-idle-timer lazy-highlight-initial-delay nil
3011 'isearch-lazy-highlight-update)))))
3013 (defun isearch-lazy-highlight-search ()
3014 "Search ahead for the next or previous match, for lazy highlighting.
3015 Attempt to do the search exactly the way the pending Isearch would."
3017 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
3018 (isearch-regexp isearch-lazy-highlight-regexp)
3019 (isearch-word isearch-lazy-highlight-word)
3020 (isearch-lax-whitespace
3021 isearch-lazy-highlight-lax-whitespace)
3022 (isearch-regexp-lax-whitespace
3023 isearch-lazy-highlight-regexp-lax-whitespace)
3024 (isearch-forward isearch-lazy-highlight-forward)
3025 (search-invisible nil) ; don't match invisible text
3028 (bound (if isearch-lazy-highlight-forward
3029 (min (or isearch-lazy-highlight-end-limit (point-max))
3030 (if isearch-lazy-highlight-wrapped
3031 isearch-lazy-highlight-start
3033 (max (or isearch-lazy-highlight-start-limit (point-min))
3034 (if isearch-lazy-highlight-wrapped
3035 isearch-lazy-highlight-end
3037 ;; Use a loop like in `isearch-search'.
3039 (setq success (isearch-search-string
3040 isearch-lazy-highlight-last-string bound t))
3041 ;; Clear RETRY unless the search predicate says
3042 ;; to skip this search hit.
3043 (if (or (not success)
3044 (= (point) bound) ; like (bobp) (eobp) in `isearch-search'.
3045 (= (match-beginning 0) (match-end 0))
3046 (funcall isearch-filter-predicate
3047 (match-beginning 0) (match-end 0)))
3052 (defun isearch-lazy-highlight-update ()
3053 "Update highlighting of other matches for current search."
3054 (let ((max lazy-highlight-max-at-a-time)
3058 (save-selected-window
3059 (if (and (window-live-p isearch-lazy-highlight-window)
3060 (not (eq (selected-window) isearch-lazy-highlight-window)))
3061 (select-window isearch-lazy-highlight-window))
3064 (goto-char (if isearch-lazy-highlight-forward
3065 isearch-lazy-highlight-end
3066 isearch-lazy-highlight-start))
3068 (let ((found (isearch-lazy-highlight-search)))
3072 (setq looping nil)))
3074 (let ((mb (match-beginning 0))
3076 (if (= mb me) ;zero-length match
3077 (if isearch-lazy-highlight-forward
3078 (if (= mb (if isearch-lazy-highlight-wrapped
3079 isearch-lazy-highlight-start
3083 (if (= mb (if isearch-lazy-highlight-wrapped
3084 isearch-lazy-highlight-end
3089 ;; non-zero-length match
3090 (let ((ov (make-overlay mb me)))
3091 (push ov isearch-lazy-highlight-overlays)
3092 ;; 1000 is higher than ediff's 100+,
3093 ;; but lower than isearch main overlay's 1001
3094 (overlay-put ov 'priority 1000)
3095 (overlay-put ov 'face lazy-highlight-face)
3096 (overlay-put ov 'window (selected-window))))
3097 ;; Remember the current position of point for
3098 ;; the next call of `isearch-lazy-highlight-update'
3099 ;; when `lazy-highlight-max-at-a-time' is too small.
3100 (if isearch-lazy-highlight-forward
3101 (setq isearch-lazy-highlight-end (point))
3102 (setq isearch-lazy-highlight-start (point)))))
3104 ;; not found or zero-length match at the search bound
3106 (if isearch-lazy-highlight-wrapped
3109 (setq isearch-lazy-highlight-wrapped t)
3110 (if isearch-lazy-highlight-forward
3112 (setq isearch-lazy-highlight-end (window-start))
3113 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
3115 (setq isearch-lazy-highlight-start (window-end))
3116 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
3119 (setq isearch-lazy-highlight-timer
3120 (run-at-time lazy-highlight-interval nil
3121 'isearch-lazy-highlight-update)))))))))
3123 (defun isearch-resume (string regexp word forward message case-fold)
3124 "Resume an incremental search.
3125 STRING is the string or regexp searched for.
3126 REGEXP non-nil means the resumed search was a regexp search.
3127 WORD non-nil means resume a word search.
3128 FORWARD non-nil means resume a forward search.
3129 MESSAGE is the echo-area message recorded for the search resumed.
3130 CASE-FOLD non-nil means the search was case-insensitive."
3131 (isearch-mode forward regexp nil nil word)
3132 (setq isearch-string string
3133 isearch-message message
3134 isearch-case-fold-search case-fold)
3138 ;;; isearch.el ends here