1 ;;; isearch.el --- incremental search minor mode
3 ;; Copyright (C) 1992-1997, 1999-2015 Free Software Foundation, Inc.
5 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
6 ;; Maintainer: emacs-devel@gnu.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
30 ;; isearch-mode behaves modally and does not return until the search
31 ;; is completed. It uses a recursive-edit to behave this way.
33 ;; The key bindings active within isearch-mode are defined below in
34 ;; `isearch-mode-map'. Also see minibuffer-local-isearch-map
35 ;; for bindings active during `isearch-edit-string'.
37 ;; isearch-mode should work even if you switch windows with the mouse,
38 ;; in which case isearch-mode is terminated automatically before the
41 ;; The search ring and completion commands automatically put you in
42 ;; the minibuffer to edit the string. This gives you a chance to
43 ;; modify the search string before executing the search. There are
44 ;; three commands to terminate the editing: C-s and C-r exit the
45 ;; minibuffer and search forward and reverse respectively, while C-m
46 ;; exits and searches in the last search direction.
48 ;; Exiting immediately from isearch uses isearch-edit-string instead
49 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
50 ;; The name of this option should probably be changed if we decide to
51 ;; keep the behavior. No point in forcing nonincremental search until
52 ;; the last possible moment.
56 (eval-when-compile (require 'cl-lib))
58 ;; Some additional options and constants.
61 "Incremental search minor mode."
62 :link '(emacs-commentary-link "isearch")
63 :link '(custom-manual "(emacs)Incremental Search")
69 (defcustom search-exit-option t
70 "Non-nil means random control characters terminate incremental search."
73 (defcustom search-slow-window-lines 1
74 "Number of lines in slow search display windows.
75 These are the short windows used during incremental search on slow terminals.
76 Negative means put the slow search window at the top (normally it's at bottom)
77 and the value is minus the number of lines."
80 (defcustom search-slow-speed 1200
81 "Highest terminal speed at which to use \"slow\" style incremental search.
82 This is the style where a one-line window is created to show the line
83 that the search has reached."
86 (defcustom search-upper-case 'not-yanks
87 "If non-nil, upper case chars disable case fold searching.
88 That is, upper and lower case chars must match exactly.
89 This applies no matter where the chars come from, but does not
90 apply to chars in regexps that are prefixed with `\\'.
91 If this value is `not-yanks', text yanked into the search string
92 in Isearch mode is always downcased."
93 :type '(choice (const :tag "off" nil)
97 (defcustom search-nonincremental-instead t
98 "If non-nil, do a nonincremental search instead of exiting immediately.
99 This affects the behavior of `isearch-exit' and any key bound to that
100 command: if this variable is nil, `isearch-exit' always exits the search;
101 if the value is non-nil, and the search string is empty, `isearch-exit'
102 starts a nonincremental search instead. (Actually, `isearch-edit-string'
103 is called to let you enter the search string, and RET terminates editing
104 and does a nonincremental search.)"
107 (defcustom search-whitespace-regexp (purecopy "\\s-+")
108 "If non-nil, regular expression to match a sequence of whitespace chars.
109 When you enter a space or spaces in the incremental search, it
110 will match any sequence matched by this regexp. As an exception,
111 spaces are treated normally in regexp incremental search if they
112 occur in a regexp construct like [...] or *, + or ?.
114 If the value is a string, it applies to both ordinary and
115 regexp incremental search. If the value is nil, or
116 `isearch-lax-whitespace' is nil for ordinary incremental search, or
117 `isearch-regexp-lax-whitespace' is nil for regexp incremental search,
118 then each space you type matches literally, against one space.
120 You might want to use something like \"[ \\t\\r\\n]+\" instead.
121 In the Customization buffer, that is `[' followed by a space,
122 a tab, a carriage return (control-M), a newline, and `]+'."
123 :type '(choice (const :tag "Match Spaces Literally" nil)
127 (defcustom search-invisible 'open
128 "If t incremental search/query-replace can match hidden text.
129 A nil value means don't match invisible text.
130 When the value is `open', if the text matched is made invisible by
131 an overlay having an `invisible' property and that overlay has a property
132 `isearch-open-invisible', then incremental search will show the contents.
133 \(This applies when using `outline.el' and `hideshow.el'.)
135 To temporarily change the value for an active incremental search,
136 use \\<isearch-mode-map>\\[isearch-toggle-invisible].
138 See also the related option `isearch-hide-immediately'.
140 See also `reveal-mode' if you want overlays to automatically be opened
141 whenever point is in one of them."
142 :type '(choice (const :tag "Match hidden text" t)
143 (const :tag "Open overlays" open)
144 (const :tag "Don't match hidden text" nil)))
146 (defcustom isearch-hide-immediately t
147 "If non-nil, re-hide an invisible match right away.
148 This variable makes a difference when `search-invisible' is set to `open'.
149 If non-nil, invisible matches are re-hidden as soon as the match moves
150 off the invisible text surrounding the match.
151 If nil then do not re-hide opened invisible text when the match moves.
152 Whatever the value, all opened invisible text is hidden again after exiting
153 the search, with the exception of the last successful match, if any."
156 (defcustom isearch-resume-in-command-history nil
157 "If non-nil, `isearch-resume' commands are added to the command history.
158 This allows you to resume earlier Isearch sessions through the
162 (defvar isearch-mode-hook nil
163 "Function(s) to call after starting up an incremental search.")
165 (defvar isearch-update-post-hook nil
166 "Function(s) to call after isearch has found matches in the buffer.")
168 (defvar isearch-mode-end-hook nil
169 "Function(s) to call after terminating an incremental search.
170 When these functions are called, `isearch-mode-end-hook-quit'
171 is non-nil if the user quits the search.")
173 (defvar isearch-mode-end-hook-quit nil
174 "Non-nil while running `isearch-mode-end-hook' if the user quits the search.")
176 (defvar isearch-message-function nil
177 "Function to call to display the search prompt.
178 If nil, use function `isearch-message'.")
180 (defvar isearch-wrap-function nil
181 "Function to call to wrap the search when search is failed.
182 If nil, move point to the beginning of the buffer for a forward search,
183 or to the end of the buffer for a backward search.")
185 (defvar isearch-push-state-function nil
186 "Function to save a function restoring the mode-specific Isearch state
187 to the search status stack.")
189 (defvar isearch-filter-predicate #'isearch-filter-visible
190 "Predicate that filters the search hits that would normally be available.
191 Search hits that dissatisfy the predicate are skipped. The function
192 has two arguments: the positions of start and end of text matched by
193 the search. If this function returns nil, continue searching without
194 stopping at this match.
195 If you use `add-function' to modify this variable, you can use the
196 `isearch-message-prefix' advice property to specify the prefix string
197 displayed in the search message.")
201 (defvar search-ring nil
202 "List of search string sequences.")
203 (defvar regexp-search-ring nil
204 "List of regular expression search string sequences.")
206 (defcustom search-ring-max 16
207 "Maximum length of search ring before oldest elements are thrown away."
209 (defcustom regexp-search-ring-max 16
210 "Maximum length of regexp search ring before oldest elements are thrown away."
213 (defvar search-ring-yank-pointer nil
214 "Index in `search-ring' of last string reused.
215 It is nil if none yet.")
216 (defvar regexp-search-ring-yank-pointer nil
217 "Index in `regexp-search-ring' of last string reused.
218 It is nil if none yet.")
220 (defcustom search-ring-update nil
221 "Non-nil if advancing or retreating in the search ring should cause search.
222 Default value, nil, means edit the string instead."
225 (autoload 'character-fold-to-regexp "character-fold")
227 (defcustom search-default-regexp-mode #'character-fold-to-regexp
228 "Default mode to use when starting isearch.
229 Value is nil, t, or a function.
231 If nil, default to literal searches (note that `case-fold-search'
232 and `isearch-lax-whitespace' may still be applied).\\<isearch-mode-map>
233 If t, default to regexp searches (as if typing `\\[isearch-toggle-regexp]' during
236 If a function, use that function as an `isearch-regexp-function'.
237 Example functions are `word-search-regexp' \(`\\[isearch-toggle-word]'),
238 `isearch-symbol-regexp' \(`\\[isearch-toggle-symbol]'), and
239 `character-fold-to-regexp' \(`\\[isearch-toggle-character-fold]')."
240 ;; :type is set below by `isearch-define-mode-toggle'.
241 :type '(choice (const :tag "Literal search" nil)
242 (const :tag "Regexp search" t)
243 (function :tag "Other"))
246 ;;; isearch highlight customization.
248 (defcustom search-highlight t
249 "Non-nil means incremental search highlights the current match."
253 '((((class color) (min-colors 88) (background light))
254 ;; The background must not be too dark, for that means
255 ;; the character is hard to see when the cursor is there.
256 (:background "magenta3" :foreground "lightskyblue1"))
257 (((class color) (min-colors 88) (background dark))
258 (:background "palevioletred2" :foreground "brown4"))
259 (((class color) (min-colors 16))
260 (:background "magenta4" :foreground "cyan1"))
261 (((class color) (min-colors 8))
262 (:background "magenta4" :foreground "cyan1"))
263 (t (:inverse-video t)))
264 "Face for highlighting Isearch matches."
267 (defvar isearch-face 'isearch)
269 (defface isearch-fail
270 '((((class color) (min-colors 88) (background light))
271 (:background "RosyBrown1"))
272 (((class color) (min-colors 88) (background dark))
273 (:background "red4"))
274 (((class color) (min-colors 16))
276 (((class color) (min-colors 8))
278 (((class color grayscale))
280 (t (:inverse-video t)))
281 "Face for highlighting failed part in Isearch echo-area message."
284 (defcustom isearch-lazy-highlight t
285 "Controls the lazy-highlighting during incremental search.
286 When non-nil, all text in the buffer matching the current search
287 string is highlighted lazily (see `lazy-highlight-initial-delay'
288 and `lazy-highlight-interval')."
290 :group 'lazy-highlight
293 ;;; Lazy highlight customization.
295 (defgroup lazy-highlight nil
296 "Lazy highlighting feature for matching strings."
297 :prefix "lazy-highlight-"
302 (define-obsolete-variable-alias 'isearch-lazy-highlight-cleanup
303 'lazy-highlight-cleanup
306 (defcustom lazy-highlight-cleanup t
307 "Controls whether to remove extra highlighting after a search.
308 If this is nil, extra highlighting can be \"manually\" removed with
309 \\[lazy-highlight-cleanup]."
311 :group 'lazy-highlight)
313 (define-obsolete-variable-alias 'isearch-lazy-highlight-initial-delay
314 'lazy-highlight-initial-delay
317 (defcustom lazy-highlight-initial-delay 0.25
318 "Seconds to wait before beginning to lazily highlight all matches."
320 :group 'lazy-highlight)
322 (define-obsolete-variable-alias 'isearch-lazy-highlight-interval
323 'lazy-highlight-interval
326 (defcustom lazy-highlight-interval 0 ; 0.0625
327 "Seconds between lazily highlighting successive matches."
329 :group 'lazy-highlight)
331 (define-obsolete-variable-alias 'isearch-lazy-highlight-max-at-a-time
332 'lazy-highlight-max-at-a-time
335 (defcustom lazy-highlight-max-at-a-time 20
336 "Maximum matches to highlight at a time (for `lazy-highlight').
337 Larger values may reduce Isearch's responsiveness to user input;
338 smaller values make matches highlight slowly.
339 A value of nil means highlight all matches."
340 :type '(choice (const :tag "All" nil)
341 (integer :tag "Some"))
342 :group 'lazy-highlight)
344 (defface lazy-highlight
345 '((((class color) (min-colors 88) (background light))
346 (:background "paleturquoise"))
347 (((class color) (min-colors 88) (background dark))
348 (:background "paleturquoise4"))
349 (((class color) (min-colors 16))
350 (:background "turquoise3"))
351 (((class color) (min-colors 8))
352 (:background "turquoise3"))
354 "Face for lazy highlighting of matches other than the current one."
355 :group 'lazy-highlight
357 (define-obsolete-face-alias 'isearch-lazy-highlight-face 'lazy-highlight "22.1")
358 (define-obsolete-variable-alias 'isearch-lazy-highlight-face
361 (defvar lazy-highlight-face 'lazy-highlight)
363 ;; Define isearch help map.
365 (defvar isearch-help-map
366 (let ((map (make-sparse-keymap)))
367 (define-key map (char-to-string help-char) 'isearch-help-for-help)
368 (define-key map [help] 'isearch-help-for-help)
369 (define-key map [f1] 'isearch-help-for-help)
370 (define-key map "?" 'isearch-help-for-help)
371 (define-key map "b" 'isearch-describe-bindings)
372 (define-key map "k" 'isearch-describe-key)
373 (define-key map "m" 'isearch-describe-mode)
374 (define-key map "q" 'help-quit)
376 "Keymap for characters following the Help key for Isearch mode.")
378 (eval-when-compile (require 'help-macro))
380 (make-help-screen isearch-help-for-help-internal
381 (purecopy "Type a help option: [bkm] or ?")
382 "You have typed %THIS-KEY%, the help character. Type a Help option:
383 \(Type \\<help-map>\\[help-quit] to exit the Help command.)
385 b Display all Isearch key bindings.
386 k KEYS Display full documentation of Isearch key sequence.
387 m Display documentation of Isearch mode.
389 You can't type here other help keys available in the global help map,
390 but outside of this help window when you type them in Isearch mode,
391 they exit Isearch mode before displaying global help."
394 (defvar isearch--display-help-action '(nil (inhibit-same-window . t)))
396 (defun isearch-help-for-help ()
397 "Display Isearch help menu."
399 (let ((display-buffer-overriding-action isearch--display-help-action))
400 (isearch-help-for-help-internal))
403 (defun isearch-describe-bindings ()
404 "Show a list of all keys defined in Isearch mode, and their definitions.
405 This is like `describe-bindings', but displays only Isearch keys."
407 (let ((display-buffer-overriding-action isearch--display-help-action))
408 (with-help-window "*Help*"
409 (with-current-buffer standard-output
410 (princ "Isearch Mode Bindings:\n")
411 (princ (substitute-command-keys "\\{isearch-mode-map}"))))))
413 (defun isearch-describe-key ()
414 "Display documentation of the function invoked by isearch key."
416 (let ((display-buffer-overriding-action isearch--display-help-action))
417 (call-interactively 'describe-key))
420 (defun isearch-describe-mode ()
421 "Display documentation of Isearch mode."
423 (let ((display-buffer-overriding-action isearch--display-help-action))
424 (describe-function 'isearch-forward))
427 (defalias 'isearch-mode-help 'isearch-describe-mode)
430 ;; Define isearch-mode keymap.
432 (defvar isearch-mode-map
435 (or (char-table-p (nth 1 map))
436 (error "The initialization of isearch-mode-map must be updated"))
437 ;; Make all multibyte characters search for themselves.
438 (set-char-table-range (nth 1 map) (cons #x100 (max-char))
439 'isearch-printing-char)
441 ;; Single-byte printing chars extend the search string by default.
444 (define-key map (vector i) 'isearch-printing-char)
447 ;; To handle local bindings with meta char prefix keys, define
448 ;; another full keymap. This must be done for any other prefix
449 ;; keys as well, one full keymap per char of the prefix key. It
450 ;; would be simpler to disable the global keymap, and/or have a
451 ;; default local key binding for any key not otherwise bound.
452 (let ((meta-map (make-sparse-keymap)))
453 (define-key map (char-to-string meta-prefix-char) meta-map))
455 ;; Several non-printing chars change the searching behavior.
456 (define-key map "\C-s" 'isearch-repeat-forward)
457 (define-key map "\C-r" 'isearch-repeat-backward)
458 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
459 ;; combinations can be used to repeat regexp isearches that can
460 ;; be used to start these searches.
461 (define-key map "\M-\C-s" 'isearch-repeat-forward)
462 (define-key map "\M-\C-r" 'isearch-repeat-backward)
463 (define-key map "\177" 'isearch-delete-char)
464 (define-key map [backspace] 'undefined) ;bug#20466.
465 (define-key map "\C-g" 'isearch-abort)
467 ;; This assumes \e is the meta-prefix-char.
468 (or (= ?\e meta-prefix-char)
469 (error "Inconsistency in isearch.el"))
470 (define-key map "\e\e\e" 'isearch-cancel)
472 (define-key map "\C-q" 'isearch-quote-char)
474 (define-key map "\r" 'isearch-exit)
475 (define-key map [return] 'isearch-exit)
476 (define-key map "\C-j" 'isearch-printing-char)
477 (define-key map "\t" 'isearch-printing-char)
478 (define-key map [?\S-\ ] 'isearch-printing-char)
480 (define-key map "\C-w" 'isearch-yank-word-or-char)
481 (define-key map "\M-\C-w" 'isearch-del-char)
482 (define-key map "\M-\C-y" 'isearch-yank-char)
483 (define-key map "\C-y" 'isearch-yank-kill)
484 (define-key map "\M-s\C-e" 'isearch-yank-line)
486 (define-key map (char-to-string help-char) isearch-help-map)
487 (define-key map [help] isearch-help-map)
488 (define-key map [f1] isearch-help-map)
490 (define-key map "\M-n" 'isearch-ring-advance)
491 (define-key map "\M-p" 'isearch-ring-retreat)
492 (define-key map "\M-y" 'isearch-yank-pop)
494 (define-key map "\M-\t" 'isearch-complete)
496 ;; Pass frame events transparently so they won't exit the search.
497 ;; In particular, if we have more than one display open, then a
498 ;; switch-frame might be generated by someone typing at another keyboard.
499 (define-key map [switch-frame] nil)
500 (define-key map [delete-frame] nil)
501 (define-key map [iconify-frame] nil)
502 (define-key map [make-frame-visible] nil)
503 (define-key map [mouse-movement] nil)
504 (define-key map [language-change] nil)
506 ;; For searching multilingual text.
507 (define-key map "\C-\\" 'isearch-toggle-input-method)
508 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
510 ;; People expect to be able to paste with the mouse.
511 (define-key map [mouse-2] #'isearch-mouse-2)
512 (define-key map [down-mouse-2] nil)
514 ;; Some bindings you may want to put in your isearch-mode-hook.
515 ;; Suggest some alternates...
516 (define-key map "\M-c" 'isearch-toggle-case-fold)
517 (define-key map "\M-r" 'isearch-toggle-regexp)
518 (define-key map "\M-e" 'isearch-edit-string)
520 (put 'isearch-edit-string :advertised-binding "\M-se")
522 (define-key map "\M-se" 'isearch-edit-string)
523 ;; More toggles defined by `isearch-define-mode-toggle'.
525 (define-key map [?\M-%] 'isearch-query-replace)
526 (define-key map [?\C-\M-%] 'isearch-query-replace-regexp)
527 (define-key map "\M-so" 'isearch-occur)
528 (define-key map "\M-shr" 'isearch-highlight-regexp)
530 ;; The key translations defined in the C-x 8 prefix should add
531 ;; characters to the search string. See iso-transl.el.
532 (define-key map "\C-x8\r" 'isearch-char-by-name)
535 "Keymap for `isearch-mode'.")
537 (defvar minibuffer-local-isearch-map
538 (let ((map (make-sparse-keymap)))
539 (set-keymap-parent map minibuffer-local-map)
540 (define-key map "\r" 'exit-minibuffer)
541 (define-key map "\M-\t" 'isearch-complete-edit)
542 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
543 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
544 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
545 (define-key map [right] 'isearch-yank-char-in-minibuffer)
547 "Keymap for editing Isearch strings in the minibuffer.")
549 ;; Internal variables declared globally for byte-compiler.
550 ;; These are all set with setq while isearching
551 ;; and bound locally while editing the search string.
553 (defvar isearch-forward nil) ; Searching in the forward direction.
554 (defvar isearch-regexp nil) ; Searching for a regexp.
555 (defvar isearch-regexp-function nil
556 "Regexp-based search mode for words/symbols.
557 If the value is a function (e.g. `isearch-symbol-regexp'), it is
558 called to convert a plain search string to a regexp used by
559 regexp search functions.
560 The symbol property `isearch-message-prefix' put on this function
561 specifies the prefix string displayed in the search message.")
562 ;; We still support setting this to t for backwards compatibility.
563 (define-obsolete-variable-alias 'isearch-word
564 'isearch-regexp-function "25.1")
566 (defvar isearch-lax-whitespace t
567 "If non-nil, a space will match a sequence of whitespace chars.
568 When you enter a space or spaces in ordinary incremental search, it
569 will match any sequence matched by the regexp defined by the variable
570 `search-whitespace-regexp'. If the value is nil, each space you type
571 matches literally, against one space. You can toggle the value of this
572 variable by the command `isearch-toggle-lax-whitespace'.")
574 (defvar isearch-regexp-lax-whitespace nil
575 "If non-nil, a space will match a sequence of whitespace chars.
576 When you enter a space or spaces in regexp incremental search, it
577 will match any sequence matched by the regexp defined by the variable
578 `search-whitespace-regexp'. If the value is nil, each space you type
579 matches literally, against one space. You can toggle the value of this
580 variable by the command `isearch-toggle-lax-whitespace'.")
582 (defvar isearch-cmds nil
583 "Stack of search status elements.
584 Each element is an `isearch--state' struct where the slots are
585 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
586 ERROR WRAPPED BARRIER CASE-FOLD-SEARCH]")
588 (defvar isearch-string "") ; The current search string.
589 (defvar isearch-message "") ; text-char-description version of isearch-string
591 (defvar isearch-message-prefix-add nil) ; Additional text for the message prefix
592 (defvar isearch-message-suffix-add nil) ; Additional text for the message suffix
594 (defvar isearch-success t) ; Searching is currently successful.
595 (defvar isearch-error nil) ; Error message for failed search.
596 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
597 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
598 (defvar isearch-barrier 0
599 "Recorded minimum/maximal point for the current search.")
600 (defvar isearch-just-started nil)
601 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
603 ;; case-fold-search while searching.
604 ;; either nil, t, or 'yes. 'yes means the same as t except that mixed
605 ;; case in the search string is ignored.
606 (defvar isearch-case-fold-search nil)
608 ;; search-invisible while searching.
609 ;; either nil, t, or 'open. 'open means the same as t except that
610 ;; opens hidden overlays.
611 (defvar isearch-invisible search-invisible)
613 (defvar isearch-last-case-fold-search nil)
615 ;; Used to save default value while isearch is active
616 (defvar isearch-original-minibuffer-message-timeout nil)
618 (defvar isearch-adjusted nil)
619 (defvar isearch-slow-terminal-mode nil)
620 ;; If t, using a small window.
621 (defvar isearch-small-window nil)
622 (defvar isearch-opoint 0)
623 ;; The window configuration active at the beginning of the search.
624 (defvar isearch-window-configuration nil)
626 ;; Flag to indicate a yank occurred, so don't move the cursor.
627 (defvar isearch-yank-flag nil)
629 ;; A function to be called after each input character is processed.
630 ;; (It is not called after characters that exit the search.)
631 ;; It is only set from an optional argument to `isearch-mode'.
632 (defvar isearch-op-fun nil)
634 ;; Is isearch-mode in a recursive edit for modal searching.
635 (defvar isearch-recursive-edit nil)
637 ;; Should isearch be terminated after doing one search?
638 (defvar isearch-nonincremental nil)
640 ;; New value of isearch-forward after isearch-edit-string.
641 (defvar isearch-new-forward nil)
643 ;; Accumulate here the overlays opened during searching.
644 (defvar isearch-opened-overlays nil)
646 ;; Non-nil if the string exists but is invisible.
647 (defvar isearch-hidden nil)
649 ;; The value of input-method-function when isearch is invoked.
650 (defvar isearch-input-method-function nil)
652 ;; A flag to tell if input-method-function is locally bound when
653 ;; isearch is invoked.
654 (defvar isearch-input-method-local-p nil)
656 (defvar isearch--saved-overriding-local-map nil)
658 ;; Minor-mode-alist changes - kind of redundant with the
659 ;; echo area, but if isearching in multiple windows, it can be useful.
661 (or (assq 'isearch-mode minor-mode-alist)
662 (nconc minor-mode-alist
663 (list '(isearch-mode isearch-mode))))
665 (defvar-local isearch-mode nil) ;; Name of the minor mode, if non-nil.
667 (define-key global-map "\C-s" 'isearch-forward)
668 (define-key esc-map "\C-s" 'isearch-forward-regexp)
669 (define-key global-map "\C-r" 'isearch-backward)
670 (define-key esc-map "\C-r" 'isearch-backward-regexp)
671 (define-key search-map "w" 'isearch-forward-word)
672 (define-key search-map "_" 'isearch-forward-symbol)
673 (define-key search-map "." 'isearch-forward-symbol-at-point)
675 ;; Entry points to isearch-mode.
677 (defun isearch-forward (&optional regexp-p no-recursive-edit)
679 Do incremental search forward.
680 With a prefix argument, do an incremental regular expression search instead.
682 As you type characters, they add to the search string and are found.
683 The following non-printing keys are bound in `isearch-mode-map'.
685 Type \\[isearch-delete-char] to cancel last input item from end of search string.
686 Type \\[isearch-exit] to exit, leaving point at location found.
687 Type LFD (C-j) to match end of line.
688 Type \\[isearch-repeat-forward] to search again forward,\
689 \\[isearch-repeat-backward] to search again backward.
690 Type \\[isearch-yank-word-or-char] to yank next word or character in buffer
691 onto the end of the search string, and search for it.
692 Type \\[isearch-del-char] to delete character from end of search string.
693 Type \\[isearch-yank-char] to yank char from buffer onto end of search\
694 string and search for it.
695 Type \\[isearch-yank-line] to yank rest of line onto end of search string\
697 Type \\[isearch-yank-kill] to yank the last string of killed text.
698 Type \\[isearch-yank-pop] to replace string just yanked into search prompt
699 with string killed before it.
700 Type \\[isearch-quote-char] to quote control character to search for it.
701 Type \\[isearch-char-by-name] to add a character to search by Unicode name,\
703 \\[isearch-abort] while searching or when search has failed cancels input\
705 been found successfully.
706 \\[isearch-abort] when search is successful aborts and moves point to\
709 If you try to exit with the search string still empty, it invokes
710 nonincremental search.
712 Type \\[isearch-toggle-case-fold] to toggle search case-sensitivity.
713 Type \\[isearch-toggle-invisible] to toggle search in invisible text.
714 Type \\[isearch-toggle-regexp] to toggle regular-expression mode.
715 Type \\[isearch-toggle-word] to toggle word mode.
716 Type \\[isearch-toggle-symbol] to toggle symbol mode.
717 Type \\[isearch-toggle-character-fold] to toggle character folding.
719 Type \\[isearch-toggle-lax-whitespace] to toggle whitespace matching.
720 In incremental searches, a space or spaces normally matches any whitespace
721 defined by the variable `search-whitespace-regexp'; see also the variables
722 `isearch-lax-whitespace' and `isearch-regexp-lax-whitespace'.
724 Type \\[isearch-edit-string] to edit the search string in the minibuffer.
726 Also supported is a search ring of the previous 16 search strings.
727 Type \\[isearch-ring-advance] to search for the next item in the search ring.
728 Type \\[isearch-ring-retreat] to search for the previous item in the search\
730 Type \\[isearch-complete] to complete the search string using the search ring.
732 Type \\[isearch-query-replace] to run `query-replace' with string to\
733 replace from last search string.
734 Type \\[isearch-query-replace-regexp] to run `query-replace-regexp'\
735 with the last search string.
736 Type \\[isearch-occur] to run `occur' that shows\
737 the last search string.
738 Type \\[isearch-highlight-regexp] to run `highlight-regexp'\
739 that highlights the last search string.
741 Type \\[isearch-describe-bindings] to display all Isearch key bindings.
742 Type \\[isearch-describe-key] to display documentation of Isearch key.
743 Type \\[isearch-describe-mode] to display documentation of Isearch mode.
745 If an input method is turned on in the current buffer, that input
746 method is also active while you are typing characters to search.
747 To toggle the input method, type \\[isearch-toggle-input-method]. \
748 It also toggles the input
749 method in the current buffer.
751 To use a different input method for searching, type \
752 \\[isearch-toggle-specified-input-method],
753 and specify an input method you want to use.
755 The above keys, bound in `isearch-mode-map', are often controlled by
756 options; do \\[apropos] on search-.* to find them.
757 Other control and meta characters terminate the search
758 and are then executed normally (depending on `search-exit-option').
759 Likewise for function keys and mouse button events.
761 If this function is called non-interactively with a nil NO-RECURSIVE-EDIT,
762 it does not return to the calling function until the search is done.
763 See the function `isearch-mode' for more information."
766 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
768 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
769 "Do incremental search forward for regular expression.
770 With a prefix argument, do a regular string search instead.
771 Like ordinary incremental search except that your input is treated
772 as a regexp. See the command `isearch-forward' for more information.
774 In incremental searches, a space or spaces normally matches any
775 whitespace defined by the variable `search-whitespace-regexp'.
776 To search for a literal space and nothing else, enter C-q SPC.
777 To toggle whitespace matching, use `isearch-toggle-lax-whitespace'.
778 This command does not support character folding."
780 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
782 (defun isearch-forward-word (&optional not-word no-recursive-edit)
783 "Do incremental search forward for a sequence of words.
784 With a prefix argument, do a regular string search instead.
785 Like ordinary incremental search except that your input is treated
786 as a sequence of words without regard to how the words are separated.
787 See the command `isearch-forward' for more information.
788 This command does not support character folding or lax space matching."
790 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
792 (defun isearch-forward-symbol (&optional _not-symbol no-recursive-edit)
793 "Do incremental search forward for a symbol.
794 The prefix argument is currently unused.
795 Like ordinary incremental search except that your input is treated
796 as a symbol surrounded by symbol boundary constructs \\_< and \\_>.
797 See the command `isearch-forward' for more information.
798 This command does not support character folding or lax space matching."
800 (isearch-mode t nil nil (not no-recursive-edit) 'isearch-symbol-regexp))
802 (defun isearch-backward (&optional regexp-p no-recursive-edit)
803 "Do incremental search backward.
804 With a prefix argument, do a regular expression search instead.
805 See the command `isearch-forward' for more information."
807 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
809 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
810 "Do incremental search backward for regular expression.
811 With a prefix argument, do a regular string search instead.
812 Like ordinary incremental search except that your input is treated
813 as a regexp. See the command `isearch-forward-regexp' for more information."
815 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
817 (defun isearch-forward-symbol-at-point ()
818 "Do incremental search forward for a symbol found near point.
819 Like ordinary incremental search except that the symbol found at point
820 is added to the search string initially as a regexp surrounded
821 by symbol boundary constructs \\_< and \\_>.
822 See the command `isearch-forward-symbol' for more information."
824 (isearch-forward-symbol nil 1)
825 (let ((bounds (find-tag-default-bounds)))
828 (when (< (car bounds) (point))
829 (goto-char (car bounds)))
831 (buffer-substring-no-properties (car bounds) (cdr bounds))))
833 (setq isearch-error "No symbol at point")
837 (defvar cursor-sensor-inhibit)
838 ;; isearch-mode only sets up incremental search for the minor mode.
839 ;; All the work is done by the isearch-mode commands.
842 ;;(defvar isearch-commands '(isearch-forward isearch-backward
843 ;; isearch-forward-regexp isearch-backward-regexp)
844 ;; "List of commands for which isearch-mode does not recursive-edit.")
846 (defun isearch-mode (forward &optional regexp op-fun recursive-edit regexp-function)
847 "Start Isearch minor mode.
848 It is called by the function `isearch-forward' and other related functions.
850 The non-nil arg FORWARD means searching in the forward direction.
852 The non-nil arg REGEXP does an incremental regular expression search.
854 The arg OP-FUN is a function to be called after each input character
855 is processed. (It is not called after characters that exit the search.)
857 When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and
858 does not return to the calling function until the search is completed.
859 To behave this way it enters a recursive-edit and exits it when done
862 The arg REGEXP-FUNCTION, if non-nil, should be a function. It is
863 used to set the value of `isearch-regexp-function'."
865 ;; Initialize global vars.
866 (setq isearch-forward forward
867 isearch-regexp (or regexp
868 (and (not regexp-function)
869 (eq search-default-regexp-mode t)))
870 isearch-regexp-function (or regexp-function
871 (and (functionp search-default-regexp-mode)
873 search-default-regexp-mode))
874 isearch-op-fun op-fun
875 isearch-last-case-fold-search isearch-case-fold-search
876 isearch-case-fold-search case-fold-search
877 isearch-invisible search-invisible
883 isearch-barrier (point)
885 isearch-yank-flag nil
887 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
890 (abs search-slow-window-lines))))
891 isearch-other-end nil
892 isearch-small-window nil
893 isearch-just-started t
894 isearch-start-hscroll (window-hscroll)
896 isearch-opoint (point)
897 search-ring-yank-pointer nil
898 isearch-opened-overlays nil
899 isearch-input-method-function input-method-function
900 isearch-input-method-local-p (local-variable-p 'input-method-function)
901 regexp-search-ring-yank-pointer nil
903 ;; Save the original value of `minibuffer-message-timeout', and
904 ;; set it to nil so that isearch's messages don't get timed out.
905 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
906 minibuffer-message-timeout nil)
908 ;; We must bypass input method while reading key. When a user type
909 ;; printable character, appropriate input method is turned on in
910 ;; minibuffer to read multibyte characters.
911 (or isearch-input-method-local-p
912 (make-local-variable 'input-method-function))
913 (setq input-method-function nil)
916 (setq isearch-window-configuration
917 (if isearch-slow-terminal-mode (current-window-configuration) nil))
919 ;; Maybe make minibuffer frame visible and/or raise it.
920 (let ((frame (window-frame (minibuffer-window))))
921 (unless (memq (frame-live-p frame) '(nil t))
922 (unless (frame-visible-p frame)
923 (make-frame-visible frame))
924 (if minibuffer-auto-raise
925 (raise-frame frame))))
927 (setq isearch-mode " Isearch") ;; forward? regexp?
928 (force-mode-line-update)
930 (setq overriding-terminal-local-map isearch-mode-map)
931 (run-hooks 'isearch-mode-hook)
932 ;; Remember the initial map possibly modified
933 ;; by external packages in isearch-mode-hook. (Bug#16035)
934 (setq isearch--saved-overriding-local-map overriding-terminal-local-map)
936 ;; Pushing the initial state used to be before running isearch-mode-hook,
937 ;; but a hook might set `isearch-push-state-function' used in
938 ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994)
943 (add-hook 'pre-command-hook 'isearch-pre-command-hook)
944 (add-hook 'post-command-hook 'isearch-post-command-hook)
945 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
946 (add-hook 'kbd-macro-termination-hook 'isearch-done)
948 ;; isearch-mode can be made modal (in the sense of not returning to
949 ;; the calling function until searching is completed) by entering
950 ;; a recursive-edit and exiting it when done isearching.
952 (let ((isearch-recursive-edit t))
957 ;; Some high level utilities. Others below.
958 (defvar isearch--current-buffer nil)
960 (defun isearch-update ()
961 "This is called after every isearch command to update the display.
962 The last thing it does is to run `isearch-update-post-hook'."
963 (unless (eq (current-buffer) isearch--current-buffer)
964 (when (buffer-live-p isearch--current-buffer)
965 (with-current-buffer isearch--current-buffer
966 (setq cursor-sensor-inhibit (delq 'isearch cursor-sensor-inhibit))))
967 (setq isearch--current-buffer (current-buffer))
968 (make-local-variable 'cursor-sensor-inhibit)
969 (unless (boundp 'cursor-sensor-inhibit)
970 (setq cursor-sensor-inhibit nil))
971 ;; Suspend things like cursor-intangible during Isearch so we can search
972 ;; even within intangible text.
973 (push 'isearch cursor-sensor-inhibit))
975 (if (and (null unread-command-events)
976 (null executing-kbd-macro))
978 (if (not (input-pending-p))
979 (if isearch-message-function
980 (funcall isearch-message-function)
982 (if (and isearch-slow-terminal-mode
983 (not (or isearch-small-window
984 (pos-visible-in-window-p))))
985 (let ((found-point (point)))
986 (setq isearch-small-window t)
987 (move-to-window-line 0)
988 (let ((window-min-height 1))
989 (split-window nil (if (< search-slow-window-lines 0)
990 (1+ (- search-slow-window-lines))
992 (1+ search-slow-window-lines)))))
993 (if (< search-slow-window-lines 0)
994 (progn (vertical-motion (- 1 search-slow-window-lines))
995 (set-window-start (next-window) (point))
996 (set-window-hscroll (next-window)
998 (set-window-hscroll (selected-window) 0))
1000 (goto-char found-point))
1001 ;; Keep same hscrolling as at the start of the search when possible
1002 (let ((current-scroll (window-hscroll))
1004 (set-window-hscroll (selected-window) isearch-start-hscroll)
1005 (setq visible-p (pos-visible-in-window-p nil nil t))
1006 (if (or (not visible-p)
1007 ;; When point is not visible because of hscroll,
1008 ;; pos-visible-in-window-p returns non-nil, but
1009 ;; the X coordinate it returns is 1 pixel beyond
1010 ;; the last visible one.
1011 (>= (car visible-p) (window-body-width nil t)))
1012 (set-window-hscroll (selected-window) current-scroll))))
1013 (if isearch-other-end
1014 (if (< isearch-other-end (point)) ; isearch-forward?
1015 (isearch-highlight isearch-other-end (point))
1016 (isearch-highlight (point) isearch-other-end))
1017 (isearch-dehighlight))))
1018 (setq ;; quit-flag nil not for isearch-mode
1019 isearch-adjusted nil
1020 isearch-yank-flag nil)
1021 (when isearch-lazy-highlight
1022 (isearch-lazy-highlight-new-loop))
1023 ;; We must prevent the point moving to the end of composition when a
1024 ;; part of the composition has just been searched.
1025 (setq disable-point-adjustment t)
1026 (run-hooks 'isearch-update-post-hook))
1028 (defun isearch-done (&optional nopush edit)
1030 For successful search, pass no args.
1031 For a failing search, NOPUSH is t.
1032 For going to the minibuffer to edit the search string,
1033 NOPUSH is t and EDIT is t."
1035 (if isearch-resume-in-command-history
1036 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
1037 ,isearch-regexp-function ,isearch-forward
1039 ',isearch-case-fold-search)))
1040 (unless (equal (car command-history) command)
1041 (setq command-history (cons command command-history)))))
1043 (remove-hook 'pre-command-hook 'isearch-pre-command-hook)
1044 (remove-hook 'post-command-hook 'isearch-post-command-hook)
1045 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
1046 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
1047 (setq isearch-lazy-highlight-start nil)
1048 (with-current-buffer isearch--current-buffer
1049 (setq isearch--current-buffer nil)
1050 (setq cursor-sensor-inhibit (delq 'isearch cursor-sensor-inhibit)))
1052 ;; Called by all commands that terminate isearch-mode.
1053 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
1054 (setq overriding-terminal-local-map nil)
1055 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
1056 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
1057 (isearch-dehighlight)
1058 (lazy-highlight-cleanup lazy-highlight-cleanup)
1059 (let ((found-start (window-start))
1060 (found-point (point)))
1061 (when isearch-window-configuration
1062 (set-window-configuration isearch-window-configuration)
1063 (if isearch-small-window
1064 (goto-char found-point)
1065 ;; set-window-configuration clobbers window-start; restore it.
1066 ;; This has an annoying side effect of clearing the last_modiff
1067 ;; field of the window, which can cause unwanted scrolling,
1068 ;; so don't do it unless truly necessary.
1069 (set-window-start (selected-window) found-start t))))
1071 (setq isearch-mode nil)
1072 (if isearch-input-method-local-p
1073 (setq input-method-function isearch-input-method-function)
1074 (kill-local-variable 'input-method-function))
1076 (force-mode-line-update)
1078 ;; If we ended in the middle of some intangible text,
1079 ;; move to the further end of that intangible text.
1080 (let ((after (if (eobp) nil
1081 (get-text-property (point) 'intangible)))
1082 (before (if (bobp) nil
1083 (get-text-property (1- (point)) 'intangible))))
1084 (when (and before after (eq before after))
1087 (next-single-property-change (point) 'intangible)
1088 (previous-single-property-change (point) 'intangible)))))
1090 (if (and (> (length isearch-string) 0) (not nopush))
1091 ;; Update the ring data.
1092 (isearch-update-ring isearch-string isearch-regexp))
1094 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
1095 (run-hooks 'isearch-mode-end-hook))
1097 ;; If there was movement, mark the starting position.
1098 ;; Maybe should test difference between and set mark only if > threshold.
1099 (if (/= (point) isearch-opoint)
1100 (or (and transient-mark-mode mark-active)
1102 (push-mark isearch-opoint t)
1103 (or executing-kbd-macro (> (minibuffer-depth) 0) edit
1104 (message "Mark saved where search started")))))
1106 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
1108 (defun isearch-update-ring (string &optional regexp)
1109 "Add STRING to the beginning of the search ring.
1110 REGEXP if non-nil says use the regexp search ring."
1112 (if regexp 'regexp-search-ring 'search-ring)
1114 (if regexp regexp-search-ring-max search-ring-max)))
1116 ;; Switching buffers should first terminate isearch-mode.
1117 ;; ;; For Emacs 19, the frame switch event is handled.
1118 ;; (defun isearch-switch-frame-handler ()
1119 ;; (interactive) ;; Is this necessary?
1120 ;; ;; First terminate isearch-mode.
1122 ;; (isearch-clean-overlays)
1123 ;; (handle-switch-frame (car (cdr last-command-event))))
1126 ;; The search status structure and stack.
1128 (cl-defstruct (isearch--state
1131 (:constructor isearch--get-state
1133 (string isearch-string)
1134 (message isearch-message)
1136 (success isearch-success)
1137 (forward isearch-forward)
1138 (other-end isearch-other-end)
1139 (word isearch-regexp-function)
1140 (error isearch-error)
1141 (wrapped isearch-wrapped)
1142 (barrier isearch-barrier)
1143 (case-fold-search isearch-case-fold-search)
1144 (pop-fun (if isearch-push-state-function
1145 (funcall isearch-push-state-function))))))
1146 (string :read-only t)
1147 (message :read-only t)
1148 (point :read-only t)
1149 (success :read-only t)
1150 (forward :read-only t)
1151 (other-end :read-only t)
1153 (error :read-only t)
1154 (wrapped :read-only t)
1155 (barrier :read-only t)
1156 (case-fold-search :read-only t)
1157 (pop-fun :read-only t))
1159 (defun isearch--set-state (cmd)
1160 (setq isearch-string (isearch--state-string cmd)
1161 isearch-message (isearch--state-message cmd)
1162 isearch-success (isearch--state-success cmd)
1163 isearch-forward (isearch--state-forward cmd)
1164 isearch-other-end (isearch--state-other-end cmd)
1165 isearch-regexp-function (isearch--state-word cmd)
1166 isearch-error (isearch--state-error cmd)
1167 isearch-wrapped (isearch--state-wrapped cmd)
1168 isearch-barrier (isearch--state-barrier cmd)
1169 isearch-case-fold-search (isearch--state-case-fold-search cmd))
1170 (if (functionp (isearch--state-pop-fun cmd))
1171 (funcall (isearch--state-pop-fun cmd) cmd))
1172 (goto-char (isearch--state-point cmd)))
1174 (defun isearch-pop-state ()
1175 (setq isearch-cmds (cdr isearch-cmds))
1176 (isearch--set-state (car isearch-cmds)))
1178 (defun isearch-push-state ()
1179 (push (isearch--get-state) isearch-cmds))
1182 ;; Commands active while inside of the isearch minor mode.
1184 (defun isearch-exit ()
1185 "Exit search normally.
1186 However, if this is the first command after starting incremental
1187 search and `search-nonincremental-instead' is non-nil, do a
1188 nonincremental search instead via `isearch-edit-string'."
1190 (if (and search-nonincremental-instead
1191 (= 0 (length isearch-string)))
1192 (let ((isearch-nonincremental t))
1193 (isearch-edit-string)) ;; this calls isearch-done as well
1195 (isearch-clean-overlays))
1197 (defun isearch-fail-pos (&optional msg)
1198 "Return position of first mismatch in search string, or nil if none.
1199 If MSG is non-nil, use variable `isearch-message', otherwise `isearch-string'."
1200 (let ((cmds isearch-cmds)
1201 (curr-msg (if msg isearch-message isearch-string))
1203 (when (or (not isearch-success) isearch-error)
1205 (or (not (isearch--state-success (car cmds)))
1206 (isearch--state-error (car cmds))))
1208 (setq succ-msg (and cmds (if msg (isearch--state-message (car cmds))
1209 (isearch--state-string (car cmds)))))
1210 (if (and (stringp succ-msg)
1211 (< (length succ-msg) (length curr-msg))
1213 (substring curr-msg 0 (length succ-msg))))
1217 (defvar isearch-new-regexp-function nil
1218 "Holds the next `isearch-regexp-function' inside `with-isearch-suspended'.
1219 If this is set inside code wrapped by the macro
1220 `with-isearch-suspended', then the value set will be used as the
1221 `isearch-regexp-function' once isearch resumes.")
1222 (define-obsolete-variable-alias 'isearch-new-word
1223 'isearch-new-regexp-function "25.1")
1225 (defmacro with-isearch-suspended (&rest body)
1226 "Exit Isearch mode, run BODY, and reinvoke the pending search.
1227 You can update the global isearch variables by setting new values to
1228 `isearch-new-string', `isearch-new-message', `isearch-new-forward',
1229 `isearch-new-regexp-function', `isearch-new-case-fold'."
1230 ;; This code is very hairy for several reasons, explained in the code.
1231 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1232 ;; If there were a way to catch any change of buffer from the minibuffer,
1233 ;; this could be simplified greatly.
1234 ;; Editing doesn't back up the search point. Should it?
1235 `(condition-case nil
1237 (let ((isearch-nonincremental isearch-nonincremental)
1239 ;; Locally bind all isearch global variables to protect them
1240 ;; from recursive isearching.
1241 ;; isearch-string -message and -forward are not bound
1242 ;; so they may be changed. Instead, save the values.
1243 (isearch-new-string isearch-string)
1244 (isearch-new-message isearch-message)
1245 (isearch-new-forward isearch-forward)
1246 (isearch-new-regexp-function isearch-regexp-function)
1247 (isearch-new-case-fold isearch-case-fold-search)
1249 (isearch-regexp isearch-regexp)
1250 (isearch-op-fun isearch-op-fun)
1251 (isearch-cmds isearch-cmds)
1252 (isearch-success isearch-success)
1253 (isearch-wrapped isearch-wrapped)
1254 (isearch-barrier isearch-barrier)
1255 (isearch-adjusted isearch-adjusted)
1256 (isearch-yank-flag isearch-yank-flag)
1257 (isearch-error isearch-error)
1258 ;;; Don't bind this. We want isearch-search, below, to set it.
1259 ;;; And the old value won't matter after that.
1260 ;;; (isearch-other-end isearch-other-end)
1261 ;;; Perhaps some of these other variables should be bound for a
1262 ;;; shorter period, ending before the next isearch-search.
1263 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1264 (isearch-opoint isearch-opoint)
1265 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1266 (isearch-small-window isearch-small-window)
1267 (isearch-recursive-edit isearch-recursive-edit)
1268 ;; Save current configuration so we can restore it here.
1269 (isearch-window-configuration (current-window-configuration))
1271 ;; This could protect the index of the search rings,
1272 ;; but we can't reliably count the number of typed M-p
1273 ;; in `read-from-minibuffer' to adjust the index accordingly.
1274 ;; So when the following is commented out, `isearch-mode'
1275 ;; below resets the index to the predictable value nil.
1276 ;; (search-ring-yank-pointer search-ring-yank-pointer)
1277 ;; (regexp-search-ring-yank-pointer regexp-search-ring-yank-pointer)
1279 ;; Temporarily restore `minibuffer-message-timeout'.
1280 (minibuffer-message-timeout
1281 isearch-original-minibuffer-message-timeout)
1282 (isearch-original-minibuffer-message-timeout
1283 isearch-original-minibuffer-message-timeout)
1284 old-point old-other-end)
1286 ;; Actually terminate isearching until editing is done.
1287 ;; This is so that the user can do anything without failure,
1288 ;; like switch buffers and start another isearch, and return.
1291 (exit nil)) ; was recursive editing
1293 ;; Save old point and isearch-other-end before reading from minibuffer
1294 ;; that can change their values.
1295 (setq old-point (point) old-other-end isearch-other-end)
1300 ;; Set point at the start (end) of old match if forward (backward),
1301 ;; so after exiting minibuffer isearch resumes at the start (end)
1302 ;; of this match and can find it again.
1303 (if (and old-other-end (eq old-point (point))
1304 (eq isearch-forward isearch-new-forward))
1305 (goto-char old-other-end))
1307 ;; Always resume isearching by restarting it.
1308 (isearch-mode isearch-forward
1312 isearch-regexp-function)
1314 ;; Copy new local values to isearch globals
1315 (setq isearch-string isearch-new-string
1316 isearch-message isearch-new-message
1317 isearch-forward isearch-new-forward
1318 isearch-regexp-function isearch-new-regexp-function
1319 isearch-case-fold-search isearch-new-case-fold))
1321 ;; Empty isearch-string means use default.
1322 (when (= 0 (length isearch-string))
1323 (setq isearch-string (or (car (if isearch-regexp
1329 (mapconcat 'isearch-text-char-description
1331 ;; After taking the last element, adjust ring to previous one.
1332 (isearch-ring-adjust1 nil)))
1334 ;; This used to push the state as of before this C-s, but it adds
1335 ;; an inconsistent state where part of variables are from the
1336 ;; previous search (e.g. `isearch-success'), and part of variables
1337 ;; are just entered from the minibuffer (e.g. `isearch-string').
1338 ;; (isearch-push-state)
1340 ;; Reinvoke the pending search.
1342 (isearch-push-state) ; this pushes the correct state
1344 (if isearch-nonincremental
1346 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1348 ;; The search done message is confusing when the string
1349 ;; is empty, so erase it.
1350 (if (equal isearch-string "")
1353 (quit ; handle abort-recursive-edit
1354 (isearch-abort) ;; outside of let to restore outside global values
1357 (defvar minibuffer-history-symbol) ;; from external package gmhist.el
1359 (defun isearch-edit-string ()
1360 "Edit the search string in the minibuffer.
1361 The following additional command keys are active while editing.
1362 \\<minibuffer-local-isearch-map>
1363 \\[exit-minibuffer] to resume incremental searching with the edited string.
1364 \\[isearch-forward-exit-minibuffer] to resume isearching forward.
1365 \\[isearch-reverse-exit-minibuffer] to resume isearching backward.
1366 \\[isearch-complete-edit] to complete the search string using the search ring."
1368 (with-isearch-suspended
1369 (let* ((message-log-max nil)
1370 ;; Don't add a new search string to the search ring here
1371 ;; in `read-from-minibuffer'. It should be added only
1372 ;; by `isearch-update-ring' called from `isearch-done'.
1373 (history-add-new-input nil)
1374 ;; Binding minibuffer-history-symbol to nil is a work-around
1375 ;; for some incompatibility with gmhist.
1376 (minibuffer-history-symbol))
1377 (setq isearch-new-string
1378 (read-from-minibuffer
1379 (isearch-message-prefix nil isearch-nonincremental)
1380 (cons isearch-string (1+ (or (isearch-fail-pos)
1381 (length isearch-string))))
1382 minibuffer-local-isearch-map nil
1384 (cons 'regexp-search-ring
1385 (1+ (or regexp-search-ring-yank-pointer -1)))
1387 (1+ (or search-ring-yank-pointer -1))))
1390 (mapconcat 'isearch-text-char-description
1391 isearch-new-string "")))))
1393 (defun isearch-nonincremental-exit-minibuffer ()
1395 (setq isearch-nonincremental t)
1397 ;; Changing the value of `isearch-nonincremental' has no effect here,
1398 ;; because `isearch-edit-string' ignores this change. Thus marked as obsolete.
1399 (make-obsolete 'isearch-nonincremental-exit-minibuffer 'exit-minibuffer "24.4")
1401 (defun isearch-forward-exit-minibuffer ()
1402 "Resume isearching forward from the minibuffer that edits the search string."
1404 (setq isearch-new-forward t)
1407 (defun isearch-reverse-exit-minibuffer ()
1408 "Resume isearching backward from the minibuffer that edits the search string."
1410 (setq isearch-new-forward nil)
1413 (defun isearch-cancel ()
1414 "Terminate the search and go back to the starting point."
1416 (if (and isearch-push-state-function isearch-cmds)
1417 ;; For defined push-state function, restore the first state.
1418 ;; This calls pop-state function and restores original point.
1419 (let ((isearch-cmds (last isearch-cmds)))
1420 (isearch--set-state (car isearch-cmds)))
1421 (goto-char isearch-opoint))
1422 (isearch-done t) ; Exit isearch..
1423 (isearch-clean-overlays)
1424 (signal 'quit nil)) ; ..and pass on quit signal.
1426 (defun isearch-abort ()
1427 "Abort incremental search mode if searching is successful, signaling quit.
1428 Otherwise, revert to previous successful search and continue searching.
1429 Use `isearch-exit' to quit without signaling."
1431 ;; (ding) signal instead below, if quitting
1433 (if (and isearch-success (not isearch-error))
1434 ;; If search is successful and has no incomplete regexp,
1435 ;; move back to starting point and really do quit.
1437 (setq isearch-success nil)
1439 ;; If search is failing, or has an incomplete regexp,
1440 ;; rub out until it is once more successful.
1441 (while (or (not isearch-success) isearch-error)
1442 (isearch-pop-state))
1445 (defun isearch-repeat (direction)
1446 ;; Utility for isearch-repeat-forward and -backward.
1447 (if (eq isearch-forward (eq direction 'forward))
1448 ;; C-s in forward or C-r in reverse.
1449 (if (equal isearch-string "")
1450 ;; If search string is empty, use last one.
1451 (if (null (if isearch-regexp regexp-search-ring search-ring))
1452 (setq isearch-error "No previous search string")
1453 (setq isearch-string
1454 (car (if isearch-regexp regexp-search-ring search-ring))
1456 (mapconcat 'isearch-text-char-description
1458 isearch-case-fold-search isearch-last-case-fold-search)
1459 ;; After taking the last element, adjust ring to previous one.
1460 (isearch-ring-adjust1 nil))
1461 ;; If already have what to search for, repeat it.
1464 ;; Set isearch-wrapped before calling isearch-wrap-function
1465 (setq isearch-wrapped t)
1466 (if isearch-wrap-function
1467 (funcall isearch-wrap-function)
1468 (goto-char (if isearch-forward (point-min) (point-max)))))))
1469 ;; C-s in reverse or C-r in forward, change direction.
1470 (setq isearch-forward (not isearch-forward)
1473 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1475 (if (equal isearch-string "")
1476 (setq isearch-success t)
1477 (if (and isearch-success
1478 (equal (point) isearch-other-end)
1479 (not isearch-just-started))
1480 ;; If repeating a search that found
1481 ;; an empty string, ensure we advance.
1482 (if (if isearch-forward (eobp) (bobp))
1483 ;; If there's nowhere to advance to, fail (and wrap next time).
1485 (setq isearch-success nil)
1487 (forward-char (if isearch-forward 1 -1))
1491 (isearch-push-state)
1494 (defun isearch-repeat-forward ()
1495 "Repeat incremental search forwards."
1497 (isearch-repeat 'forward))
1499 (defun isearch-repeat-backward ()
1500 "Repeat incremental search backwards."
1502 (isearch-repeat 'backward))
1505 ;;; Toggles for `isearch-regexp-function' and `search-default-regexp-mode'.
1506 (defmacro isearch-define-mode-toggle (mode key function &optional docstring &rest body)
1507 "Define a command called `isearch-toggle-MODE' and bind it to `M-s KEY'.
1508 The first line of the command's docstring is auto-generated, the
1509 remainder may be provided in DOCSTRING.
1510 If FUNCTION is a symbol, this command first toggles the value of
1511 `isearch-regexp-function' between nil and FUNCTION. Also set the
1512 `isearch-message-prefix' property of FUNCTION.
1513 The command then executes BODY and updates the isearch prompt."
1514 (declare (indent defun))
1515 (let ((command-name (intern (format "isearch-toggle-%s" mode)))
1516 (key (concat "\M-s" key)))
1518 (defun ,command-name ()
1519 ,(format "Toggle %s searching on or off.%s" mode
1520 (if docstring (concat "\n" docstring) ""))
1523 `((setq isearch-regexp-function
1524 (unless (eq isearch-regexp-function #',function)
1526 (when isearch-regexp-function (setq isearch-regexp nil))))
1528 (setq isearch-success t isearch-adjusted t)
1530 (define-key isearch-mode-map ,key #',command-name)
1531 ,@(when (symbolp function)
1532 `((put ',function 'isearch-message-prefix ,(format "%s " mode))
1533 (put ',function :advertised-binding ,key)
1534 (cl-callf (lambda (types) (cons 'choice
1535 (cons '(const :tag ,(capitalize (format "%s search" mode)) ,function)
1537 (get 'search-default-regexp-mode 'custom-type)))))))
1539 (isearch-define-mode-toggle word "w" word-search-regexp "\
1540 Turning on word search turns off regexp mode.")
1541 (isearch-define-mode-toggle symbol "_" isearch-symbol-regexp "\
1542 Turning on symbol search turns off regexp mode.")
1543 (isearch-define-mode-toggle character-fold "'" character-fold-to-regexp "\
1544 Turning on character-folding turns off regexp mode.")
1545 (put 'character-fold-to-regexp 'isearch-message-prefix "char-fold ")
1547 (isearch-define-mode-toggle regexp "r" nil nil
1548 (setq isearch-regexp (not isearch-regexp))
1549 (if isearch-regexp (setq isearch-regexp-function nil)))
1551 (defun isearch--momentary-message (string)
1552 "Print STRING at the end of the isearch prompt for 1 second"
1553 (let ((message-log-max nil))
1554 (message "%s%s [%s]"
1555 (isearch-message-prefix nil isearch-nonincremental)
1560 (isearch-define-mode-toggle lax-whitespace " " nil
1561 "In ordinary search, toggles the value of the variable
1562 `isearch-lax-whitespace'. In regexp search, toggles the
1563 value of the variable `isearch-regexp-lax-whitespace'."
1564 (isearch--momentary-message
1565 (if (if isearch-regexp
1566 (setq isearch-regexp-lax-whitespace (not isearch-regexp-lax-whitespace))
1567 (setq isearch-lax-whitespace (not isearch-lax-whitespace)))
1568 "match spaces loosely"
1569 "match spaces literally")))
1571 (isearch-define-mode-toggle case-fold "c" nil
1572 "Toggles the value of the variable `isearch-case-fold-search'."
1573 (isearch--momentary-message
1574 (if (setq isearch-case-fold-search
1575 (if isearch-case-fold-search nil 'yes))
1579 (isearch-define-mode-toggle invisible "i" nil
1580 "This determines whether to search inside invisible text or not.
1581 Toggles the variable `isearch-invisible' between values
1582 nil and a non-nil value of the option `search-invisible'
1583 \(or `open' if `search-invisible' is nil)."
1584 "match %svisible text"
1585 (isearch--momentary-message
1586 (if (setq isearch-invisible
1587 (if isearch-invisible
1588 nil (or search-invisible 'open)))
1589 "match invisible text"
1590 "match visible text")))
1595 (defun word-search-regexp (string &optional lax)
1596 "Return a regexp which matches words, ignoring punctuation.
1597 Given STRING, a string of words separated by word delimiters,
1598 compute a regexp that matches those exact words separated by
1599 arbitrary punctuation. If the string begins or ends in whitespace,
1600 the beginning or the end of the string matches arbitrary whitespace.
1601 Otherwise if LAX is non-nil, the beginning or the end of the string
1602 need not match a word boundary.
1604 Used in `word-search-forward', `word-search-backward',
1605 `word-search-forward-lax', `word-search-backward-lax'."
1607 ((equal string "") "")
1608 ((string-match-p "\\`\\W+\\'" string) "\\W+")
1610 (if (string-match-p "\\`\\W" string) "\\W+"
1612 (mapconcat 'regexp-quote (split-string string "\\W+" t) "\\W+")
1613 (if (string-match-p "\\W\\'" string) "\\W+"
1614 (unless lax "\\>"))))))
1616 (defun word-search-backward (string &optional bound noerror count)
1617 "Search backward from point for STRING, ignoring differences in punctuation.
1618 Set point to the beginning of the occurrence found, and return point.
1619 An optional second argument bounds the search; it is a buffer position.
1620 The match found must not extend before that position.
1621 Optional third argument, if t, means if fail just return nil (no error).
1622 If not nil and not t, move to limit of search and return nil.
1623 Optional fourth argument is repeat count--search for successive occurrences.
1625 Relies on the function `word-search-regexp' to convert a sequence
1626 of words in STRING to a regexp used to search words without regard
1628 This command does not support character folding or lax space matching."
1629 (interactive "sWord search backward: ")
1630 (re-search-backward (word-search-regexp string nil) bound noerror count))
1632 (defun word-search-forward (string &optional bound noerror count)
1633 "Search forward from point for STRING, ignoring differences in punctuation.
1634 Set point to the end of the occurrence found, and return point.
1635 An optional second argument bounds the search; it is a buffer position.
1636 The match found must not extend after that position.
1637 Optional third argument, if t, means if fail just return nil (no error).
1638 If not nil and not t, move to limit of search and return nil.
1639 Optional fourth argument is repeat count--search for successive occurrences.
1641 Relies on the function `word-search-regexp' to convert a sequence
1642 of words in STRING to a regexp used to search words without regard
1644 This command does not support character folding or lax space matching."
1645 (interactive "sWord search: ")
1646 (re-search-forward (word-search-regexp string nil) bound noerror count))
1648 (defun word-search-backward-lax (string &optional bound noerror count)
1649 "Search backward from point for STRING, ignoring differences in punctuation.
1650 Set point to the beginning of the occurrence found, and return point.
1652 Unlike `word-search-backward', the end of STRING need not match a word
1653 boundary, unless STRING ends in whitespace.
1655 An optional second argument bounds the search; it is a buffer position.
1656 The match found must not extend before that position.
1657 Optional third argument, if t, means if fail just return nil (no error).
1658 If not nil and not t, move to limit of search and return nil.
1659 Optional fourth argument is repeat count--search for successive occurrences.
1661 Relies on the function `word-search-regexp' to convert a sequence
1662 of words in STRING to a regexp used to search words without regard
1664 This command does not support character folding or lax space matching."
1665 (interactive "sWord search backward: ")
1666 (re-search-backward (word-search-regexp string t) bound noerror count))
1668 (defun word-search-forward-lax (string &optional bound noerror count)
1669 "Search forward from point for STRING, ignoring differences in punctuation.
1670 Set point to the end of the occurrence found, and return point.
1672 Unlike `word-search-forward', the end of STRING need not match a word
1673 boundary, unless STRING ends in whitespace.
1675 An optional second argument bounds the search; it is a buffer position.
1676 The match found must not extend after that position.
1677 Optional third argument, if t, means if fail just return nil (no error).
1678 If not nil and not t, move to limit of search and return nil.
1679 Optional fourth argument is repeat count--search for successive occurrences.
1681 Relies on the function `word-search-regexp' to convert a sequence
1682 of words in STRING to a regexp used to search words without regard
1684 This command does not support character folding or lax space matching."
1685 (interactive "sWord search: ")
1686 (re-search-forward (word-search-regexp string t) bound noerror count))
1690 (defun isearch-symbol-regexp (string &optional lax)
1691 "Return a regexp which matches STRING as a symbol.
1692 Creates a regexp where STRING is surrounded by symbol delimiters \\_< and \\_>.
1693 If there are more than one symbol, then compute a regexp that matches
1694 those exact symbols separated by non-symbol characters. If the string
1695 begins or ends in whitespace, the beginning or the end of the string
1696 matches arbitrary non-symbol whitespace. Otherwise if LAX is non-nil,
1697 the beginning or the end of the string need not match a symbol boundary."
1698 (let ((not-word-symbol-re
1699 ;; This regexp matches all syntaxes except word and symbol syntax.
1700 ;; FIXME: Replace it with something shorter if possible (bug#14602).
1701 "\\(?:\\s-\\|\\s.\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s/\\|\\s$\\|\\s'\\|\\s<\\|\\s>\\|\\s@\\|\\s!\\|\\s|\\)+"))
1703 ((equal string "") "")
1704 ((string-match-p (format "\\`%s\\'" not-word-symbol-re) string) not-word-symbol-re)
1706 (if (string-match-p (format "\\`%s" not-word-symbol-re) string) not-word-symbol-re
1707 (unless lax "\\_<"))
1708 (mapconcat 'regexp-quote (split-string string not-word-symbol-re t) not-word-symbol-re)
1709 (if (string-match-p (format "%s\\'" not-word-symbol-re) string) not-word-symbol-re
1710 (unless lax "\\_>")))))))
1712 (put 'isearch-symbol-regexp 'isearch-message-prefix "symbol ")
1714 ;; Search with lax whitespace
1716 (defun search-forward-lax-whitespace (string &optional bound noerror count)
1717 "Search forward for STRING, matching a sequence of whitespace chars."
1718 (let ((search-spaces-regexp search-whitespace-regexp))
1719 (re-search-forward (regexp-quote string) bound noerror count)))
1721 (defun search-backward-lax-whitespace (string &optional bound noerror count)
1722 "Search backward for STRING, matching a sequence of whitespace chars."
1723 (let ((search-spaces-regexp search-whitespace-regexp))
1724 (re-search-backward (regexp-quote string) bound noerror count)))
1726 (defun re-search-forward-lax-whitespace (regexp &optional bound noerror count)
1727 "Search forward for REGEXP, matching a sequence of whitespace chars."
1728 (let ((search-spaces-regexp search-whitespace-regexp))
1729 (re-search-forward regexp bound noerror count)))
1731 (defun re-search-backward-lax-whitespace (regexp &optional bound noerror count)
1732 "Search backward for REGEXP, matching a sequence of whitespace chars."
1733 (let ((search-spaces-regexp search-whitespace-regexp))
1734 (re-search-backward regexp bound noerror count)))
1736 (dolist (old '(re-search-forward-lax-whitespace search-backward-lax-whitespace
1737 search-forward-lax-whitespace re-search-backward-lax-whitespace))
1739 "instead, use (let ((search-spaces-regexp search-whitespace-regexp))
1740 (re-search-... ...))"
1744 (defun isearch-query-replace (&optional arg regexp-flag)
1745 "Start `query-replace' with string to replace from last search string.
1746 The ARG (prefix arg if interactive), if non-nil, means replace
1747 only matches surrounded by word boundaries. A negative prefix
1748 arg means replace backward. Note that using the prefix arg
1749 is possible only when `isearch-allow-scroll' is non-nil or
1750 `isearch-allow-prefix' is non-nil, and it doesn't always provide the
1751 correct matches for `query-replace', so the preferred way to run word
1752 replacements from Isearch is `M-s w ... M-%'."
1754 (list current-prefix-arg))
1755 (barf-if-buffer-read-only)
1756 (if regexp-flag (setq isearch-regexp t))
1757 (let ((case-fold-search isearch-case-fold-search)
1758 ;; set `search-upper-case' to nil to not call
1759 ;; `isearch-no-upper-case-p' in `perform-replace'
1760 (search-upper-case nil)
1761 (search-invisible isearch-invisible)
1762 (replace-lax-whitespace
1763 isearch-lax-whitespace)
1764 (replace-regexp-lax-whitespace
1765 isearch-regexp-lax-whitespace)
1766 (delimited (and arg (not (eq arg '-))))
1767 (backward (and arg (eq arg '-)))
1768 ;; Set `isearch-recursive-edit' to nil to prevent calling
1769 ;; `exit-recursive-edit' in `isearch-done' that terminates
1770 ;; the execution of this command when it is non-nil.
1771 ;; We call `exit-recursive-edit' explicitly at the end below.
1772 (isearch-recursive-edit nil))
1773 (isearch-done nil t)
1774 (isearch-clean-overlays)
1775 (if (and isearch-other-end
1777 (> isearch-other-end (point))
1778 (< isearch-other-end (point)))
1779 (not (and transient-mark-mode mark-active
1782 (< (mark) (point))))))
1783 (goto-char isearch-other-end))
1784 (set query-replace-from-history-variable
1785 (cons isearch-string
1786 (symbol-value query-replace-from-history-variable)))
1789 (query-replace-read-to
1791 (concat "Query replace"
1792 (isearch--describe-regexp-mode (or delimited isearch-regexp-function) t)
1793 (if backward " backward" "")
1794 (if (and transient-mark-mode mark-active) " in region" ""))
1796 t isearch-regexp (or delimited isearch-regexp-function) nil nil
1797 (if (and transient-mark-mode mark-active) (region-beginning))
1798 (if (and transient-mark-mode mark-active) (region-end))
1800 (and isearch-recursive-edit (exit-recursive-edit)))
1802 (defun isearch-query-replace-regexp (&optional arg)
1803 "Start `query-replace-regexp' with string to replace from last search string.
1804 See `isearch-query-replace' for more information."
1806 (list current-prefix-arg))
1807 (isearch-query-replace arg t))
1809 (defun isearch-occur (regexp &optional nlines)
1810 "Run `occur' using the last search string as the regexp.
1811 Interactively, REGEXP is constructed using the search string from the
1812 last search command. NLINES has the same meaning as in `occur'.
1814 If the last search command was a word search, REGEXP is computed from
1815 the search words, ignoring punctuation. If the last search
1816 command was a regular expression search, REGEXP is the regular
1817 expression used in that search. If the last search command searched
1818 for a literal string, REGEXP is constructed by quoting all the special
1819 characters in that string."
1821 (let* ((perform-collect (consp current-prefix-arg))
1823 ((functionp isearch-regexp-function)
1824 (funcall isearch-regexp-function isearch-string))
1825 (isearch-regexp-function (word-search-regexp isearch-string))
1826 (isearch-regexp isearch-string)
1827 (t (regexp-quote isearch-string)))))
1830 ;; Perform collect operation
1831 (if (zerop (regexp-opt-depth regexp))
1832 ;; No subexpression so collect the entire match.
1834 ;; Get the regexp for collection pattern.
1835 (let ((default (car occur-collect-regexp-history))
1837 (with-isearch-suspended
1838 (setq regexp-collect
1840 (format "Regexp to collect (default %s): " default)
1841 default 'occur-collect-regexp-history)))
1843 ;; Otherwise normal occur takes numerical prefix argument.
1844 (when current-prefix-arg
1845 (prefix-numeric-value current-prefix-arg))))))
1846 (let ((case-fold-search isearch-case-fold-search)
1847 ;; Set `search-upper-case' to nil to not call
1848 ;; `isearch-no-upper-case-p' in `occur-1'.
1849 (search-upper-case nil)
1850 (search-spaces-regexp
1851 (if (if isearch-regexp
1852 isearch-regexp-lax-whitespace
1853 isearch-lax-whitespace)
1854 search-whitespace-regexp)))
1855 (occur (if isearch-regexp-function
1857 'isearch-string isearch-string
1858 'isearch-regexp-function-descr
1859 (isearch--describe-regexp-mode isearch-regexp-function))
1863 (declare-function hi-lock-read-face-name "hi-lock" ())
1865 (defun isearch-highlight-regexp ()
1866 "Run `highlight-regexp' with regexp from the current search string.
1867 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1868 argument from the last search regexp or a quoted search string,
1869 and reads its face argument using `hi-lock-read-face-name'."
1872 ;; Set `isearch-recursive-edit' to nil to prevent calling
1873 ;; `exit-recursive-edit' in `isearch-done' that terminates
1874 ;; the execution of this command when it is non-nil.
1875 ;; We call `exit-recursive-edit' explicitly at the end below.
1876 (isearch-recursive-edit nil))
1877 (isearch-done nil t)
1878 (isearch-clean-overlays))
1879 (require 'hi-lock nil t)
1880 (let ((regexp (cond ((functionp isearch-regexp-function)
1881 (funcall isearch-regexp-function isearch-string))
1882 (isearch-regexp-function (word-search-regexp isearch-string))
1883 (isearch-regexp isearch-string)
1884 ((if (and (eq isearch-case-fold-search t)
1886 (isearch-no-upper-case-p
1887 isearch-string isearch-regexp)
1888 isearch-case-fold-search)
1889 ;; Turn isearch-string into a case-insensitive
1893 (let ((s (string c)))
1894 (if (string-match "[[:alpha:]]" s)
1895 (format "[%s%s]" (upcase s) (downcase s))
1898 (t (regexp-quote isearch-string)))))
1899 (hi-lock-face-buffer regexp (hi-lock-read-face-name)))
1900 (and isearch-recursive-edit (exit-recursive-edit)))
1903 (defun isearch-delete-char ()
1904 "Discard last input item and move point back.
1905 Last input means the last character or the last isearch command
1906 that added or deleted characters from the search string,
1907 moved point, toggled regexp mode or case-sensitivity, etc.
1908 If no previous match was done, just beep."
1910 (if (null (cdr isearch-cmds))
1912 (isearch-pop-state))
1915 (defun isearch-del-char (&optional arg)
1916 "Delete character from end of search string and search again.
1917 Unlike `isearch-delete-char', it only deletes the last character,
1918 but doesn't cancel the effect of other isearch command.
1919 If search string is empty, just beep."
1921 (if (= 0 (length isearch-string))
1923 (setq isearch-string (substring isearch-string 0
1925 (length isearch-string))))
1926 isearch-message (mapconcat 'isearch-text-char-description
1927 isearch-string "")))
1928 ;; Use the isearch-other-end as new starting point to be able
1929 ;; to find the remaining part of the search string again.
1930 ;; This is like what `isearch-search-and-update' does,
1931 ;; but currently it doesn't support deletion of characters
1932 ;; for the case where unsuccessful search may become successful
1933 ;; by deletion of characters.
1934 (if isearch-other-end (goto-char isearch-other-end))
1936 (isearch-push-state)
1939 (defun isearch-yank-string (string)
1940 "Pull STRING into search string."
1941 ;; Downcase the string if not supposed to case-fold yanked strings.
1942 (if (and isearch-case-fold-search
1943 (eq 'not-yanks search-upper-case))
1944 (setq string (downcase string)))
1945 (if isearch-regexp (setq string (regexp-quote string)))
1946 ;; Don't move cursor in reverse search.
1947 (setq isearch-yank-flag t)
1948 (isearch-process-search-string
1949 string (mapconcat 'isearch-text-char-description string "")))
1951 (defun isearch-yank-kill ()
1952 "Pull string from kill ring into search string."
1954 (isearch-yank-string (current-kill 0)))
1956 (defun isearch-yank-pop ()
1957 "Replace just-yanked search string with previously killed string."
1959 (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop)))
1960 ;; Fall back on `isearch-yank-kill' for the benefits of people
1961 ;; who are used to the old behavior of `M-y' in isearch mode. In
1962 ;; future, this fallback may be changed if we ever change
1963 ;; `yank-pop' to do something like the kill-ring-browser.
1966 (isearch-yank-string (current-kill 1))))
1968 (defun isearch-yank-x-selection ()
1969 "Pull current X selection into search string."
1971 (isearch-yank-string (gui-get-selection))
1972 ;; If `gui-get-selection' returned the text from the active region,
1973 ;; then it "used" the mark which we should hence deactivate.
1974 (when select-active-regions (deactivate-mark)))
1977 (defun isearch-mouse-2 (click)
1978 "Handle mouse-2 in Isearch mode.
1979 For a click in the echo area, invoke `isearch-yank-x-selection'.
1980 Otherwise invoke whatever the calling mouse-2 command sequence
1981 is bound to outside of Isearch."
1983 (let* ((w (posn-window (event-start click)))
1984 (overriding-terminal-local-map nil)
1985 (binding (key-binding (this-command-keys-vector) t)))
1986 (if (and (window-minibuffer-p w)
1987 (not (minibuffer-window-active-p w))) ; in echo area
1988 (isearch-yank-x-selection)
1989 (when (functionp binding)
1990 (call-interactively binding)))))
1992 (defun isearch-yank-internal (jumpform)
1993 "Pull the text from point to the point reached by JUMPFORM.
1994 JUMPFORM is a lambda expression that takes no arguments and returns
1995 a buffer position, possibly having moved point to that position.
1996 For example, it might move point forward by a word and return point,
1997 or it might return the position of the end of the line."
1998 (isearch-yank-string
2000 (and (not isearch-forward) isearch-other-end
2001 (goto-char isearch-other-end))
2002 (buffer-substring-no-properties (point) (funcall jumpform)))))
2004 (defun isearch-yank-char-in-minibuffer (&optional arg)
2005 "Pull next character from buffer into end of search string in minibuffer."
2009 (with-current-buffer (cadr (buffer-list))
2010 (buffer-substring-no-properties
2011 (point) (progn (forward-char arg) (point)))))
2012 (forward-char arg)))
2014 (defun isearch-yank-char (&optional arg)
2015 "Pull next character from buffer into search string.
2016 If optional ARG is non-nil, pull in the next ARG characters."
2018 (isearch-yank-internal (lambda () (forward-char arg) (point))))
2020 (declare-function subword-forward "subword" (&optional arg))
2021 (defun isearch-yank-word-or-char ()
2022 "Pull next character, subword or word from buffer into search string.
2023 Subword is used when `subword-mode' is activated. "
2025 (isearch-yank-internal
2027 (if (or (= (char-syntax (or (char-after) 0)) ?w)
2028 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
2029 (if (or (and (boundp 'subword-mode) subword-mode)
2030 (and (boundp 'superword-mode) superword-mode))
2036 (defun isearch-yank-word (&optional arg)
2037 "Pull next word from buffer into search string.
2038 If optional ARG is non-nil, pull in the next ARG words."
2040 (isearch-yank-internal (lambda () (forward-word arg) (point))))
2042 (defun isearch-yank-line (&optional arg)
2043 "Pull rest of line from buffer into search string.
2044 If optional ARG is non-nil, yank the next ARG lines."
2046 (isearch-yank-internal
2047 (lambda () (let ((inhibit-field-text-motion t))
2048 (line-end-position (if (eolp) (1+ arg) arg))))))
2050 (defun isearch-char-by-name (&optional count)
2051 "Read a character by its Unicode name and add it to the search string.
2052 Completion is available like in `read-char-by-name' used by `insert-char'.
2053 With argument, add COUNT copies of the character."
2055 (with-isearch-suspended
2056 (let ((char (read-char-by-name "Add character to search (Unicode name or hex): ")))
2058 (let ((string (if (and (integerp count) (> count 1))
2059 (make-string count char)
2060 (char-to-string char))))
2061 (setq isearch-new-string (concat isearch-string string)
2062 isearch-new-message (concat isearch-message
2063 (mapconcat 'isearch-text-char-description
2066 (defun isearch-search-and-update ()
2067 ;; Do the search and update the display.
2068 (when (or isearch-success
2069 ;; Unsuccessful regexp search may become successful by
2070 ;; addition of characters which make isearch-string valid
2072 ;; If the string was found but was completely invisible,
2073 ;; it might now be partly visible, so try again.
2074 (prog1 isearch-hidden (setq isearch-hidden nil)))
2075 ;; In reverse search, adding stuff at
2076 ;; the end may cause zero or many more chars to be
2077 ;; matched, in the string following point.
2078 ;; Allow all those possibilities without moving point as
2079 ;; long as the match does not extend past search origin.
2080 (if (and (not isearch-forward) (not isearch-adjusted)
2082 (let ((case-fold-search isearch-case-fold-search))
2083 (if (and (eq case-fold-search t) search-upper-case)
2084 (setq case-fold-search
2085 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2087 ((functionp isearch-regexp-function)
2088 (funcall isearch-regexp-function isearch-string t))
2089 (isearch-regexp-function (word-search-regexp isearch-string t))
2090 (isearch-regexp isearch-string)
2091 (t (regexp-quote isearch-string)))))
2093 (or isearch-yank-flag
2095 (min isearch-opoint isearch-barrier))))
2097 (setq isearch-success t
2099 isearch-other-end (match-end 0))
2100 (if (and (eq isearch-case-fold-search t) search-upper-case)
2101 (setq isearch-case-fold-search
2102 (isearch-no-upper-case-p isearch-string isearch-regexp))))
2103 ;; Not regexp, not reverse, or no match at point.
2104 (if (and isearch-other-end (not isearch-adjusted))
2105 (goto-char (if isearch-forward isearch-other-end
2108 (1+ isearch-other-end)))))
2111 (isearch-push-state)
2112 (if isearch-op-fun (funcall isearch-op-fun))
2116 ;; *, ?, }, and | chars can make a regexp more liberal.
2117 ;; They can make a regexp match sooner or make it succeed instead of failing.
2118 ;; So go back to place last successful search started
2119 ;; or to the last ^S/^R (barrier), whichever is nearer.
2120 ;; + needs no special handling because the string must match at least once.
2122 (defun isearch-backslash (str)
2123 "Return t if STR ends in an odd number of backslashes."
2124 (= (mod (- (length str) (string-match "\\\\*\\'" str)) 2) 1))
2126 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
2127 "Return point to previous successful match to allow regexp liberalization.
2128 \\<isearch-mode-map>
2129 Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by \
2130 stopping at `isearch-barrier' as needed.
2132 Do nothing if a backslash is escaping the liberalizing character.
2133 If WANT-BACKSLASH is non-nil, invert this behavior (for \\} and \\|).
2135 Do nothing if regexp has recently been invalid unless optional
2136 ALLOW-INVALID non-nil.
2138 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
2140 ;; (eq (not a) (not b)) makes all non-nil values equivalent
2141 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
2142 (not want-backslash))
2143 ;; We have to check 2 stack frames because the last might be
2144 ;; invalid just because of a backslash.
2145 (or (not isearch-error)
2146 (not (isearch--state-error (cadr isearch-cmds)))
2149 (progn (goto-char isearch-barrier)
2150 (setq isearch-adjusted t))
2151 (let* ((stack isearch-cmds)
2152 (previous (cdr stack)) ; lookbelow in the stack
2153 (frame (car stack)))
2154 ;; Walk down the stack looking for a valid regexp (as of course only
2155 ;; they can be the previous successful match); this conveniently
2156 ;; removes all bracket-sets and groups that might be in the way, as
2157 ;; well as partial \{\} constructs that the code below leaves behind.
2158 ;; Also skip over postfix operators -- though horrid,
2159 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
2160 (while (and previous
2161 (or (isearch--state-error frame)
2162 (let* ((string (isearch--state-string frame))
2163 (lchar (aref string (1- (length string)))))
2164 ;; The operators aren't always operators; check
2165 ;; backslashes. This doesn't handle the case of
2166 ;; operators at the beginning of the regexp not
2167 ;; being special, but then we should fall back to
2168 ;; the barrier anyway because it's all optional.
2169 (if (isearch-backslash
2170 (isearch--state-string (car previous)))
2172 (memq lchar '(?* ?? ?+))))))
2173 (setq stack previous previous (cdr previous) frame (car stack)))
2175 ;; `stack' now refers the most recent valid regexp that is not at
2176 ;; all optional in its last term. Now dig one level deeper and find
2177 ;; what matched before that.
2178 (let ((last-other-end
2179 (or (and (car previous)
2180 (isearch--state-other-end (car previous)))
2182 (goto-char (if isearch-forward
2183 (max last-other-end isearch-barrier)
2184 (min last-other-end isearch-barrier)))
2185 (setq isearch-adjusted t)))))))
2187 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2188 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
2190 ;; The idea here is that certain vertical scrolling commands (like C-l
2191 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
2192 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
2193 ;; tamper with isearch's state, or move point. It is unacceptable for the
2194 ;; search string to be scrolled out of the current window. If a command
2195 ;; attempts this, we scroll the text back again.
2197 ;; We implement this feature with a property called `isearch-scroll'.
2198 ;; If a command's symbol has the value t for this property or for the
2199 ;; `scroll-command' property, it is a scrolling command. The feature
2200 ;; needs to be enabled by setting the customizable variable
2201 ;; `isearch-allow-scroll' to a non-nil value.
2203 ;; The universal argument commands (e.g. C-u) in simple.el are marked
2204 ;; as scrolling commands, and isearch.el has been amended to allow
2205 ;; prefix arguments to be passed through to scrolling commands. Thus
2206 ;; M-0 C-l will scroll point to the top of the window.
2208 ;; Horizontal scrolling commands are currently not catered for.
2209 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2211 ;; Set the isearch-scroll property on some standard functions:
2212 ;; Scroll-bar functions:
2213 (if (fboundp 'scroll-bar-toolkit-scroll)
2214 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
2215 (if (fboundp 'w32-handle-scroll-bar-event)
2216 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
2218 ;; Commands which scroll the window (some scroll commands
2219 ;; already have the `scroll-command' property on them):
2220 (put 'recenter 'isearch-scroll t)
2221 (put 'recenter-top-bottom 'isearch-scroll t)
2222 (put 'reposition-window 'isearch-scroll t)
2224 ;; Commands which act on the other window
2225 (put 'list-buffers 'isearch-scroll t)
2226 (put 'scroll-other-window 'isearch-scroll t)
2227 (put 'scroll-other-window-down 'isearch-scroll t)
2228 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
2229 (put 'end-of-buffer-other-window 'isearch-scroll t)
2231 ;; Commands which change the window layout
2232 (put 'delete-other-windows 'isearch-scroll t)
2233 (put 'balance-windows 'isearch-scroll t)
2234 (put 'split-window-right 'isearch-scroll t)
2235 (put 'split-window-below 'isearch-scroll t)
2236 (put 'enlarge-window 'isearch-scroll t)
2238 ;; Aliases for split-window-*
2239 (put 'split-window-vertically 'isearch-scroll t)
2240 (put 'split-window-horizontally 'isearch-scroll t)
2242 ;; Universal argument commands
2243 (put 'universal-argument 'isearch-scroll t)
2244 (put 'negative-argument 'isearch-scroll t)
2245 (put 'digit-argument 'isearch-scroll t)
2247 (defcustom isearch-allow-scroll nil
2248 "Whether scrolling is allowed during incremental search.
2249 If non-nil, scrolling commands can be used in Isearch mode.
2250 However, the current match will never scroll offscreen.
2251 If nil, scrolling commands will first cancel Isearch mode."
2255 (defcustom isearch-allow-prefix t
2256 "Whether prefix arguments are allowed during incremental search.
2257 If non-nil, entering a prefix argument will not terminate the
2258 search. This option is ignored \(presumed t) when
2259 `isearch-allow-scroll' is set."
2264 (defun isearch-string-out-of-window (isearch-point)
2265 "Test whether the search string is currently outside of the window.
2266 Return nil if it's completely visible, or if point is visible,
2267 together with as much of the search string as will fit; the symbol
2268 `above' if we need to scroll the text downwards; the symbol `below',
2270 (let ((w-start (window-start))
2271 (w-end (window-end nil t))
2272 (w-L1 (save-excursion (move-to-window-line 1) (point)))
2273 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
2274 start end) ; start and end of search string in buffer
2276 (setq end isearch-point start (or isearch-other-end isearch-point))
2277 (setq start isearch-point end (or isearch-other-end isearch-point)))
2278 (cond ((or (and (>= start w-start) (<= end w-end))
2280 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
2281 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
2283 ((and (< start w-start)
2284 (< isearch-point w-L-1))
2288 (defun isearch-back-into-window (above isearch-point)
2289 "Scroll the window to bring the search string back into view.
2290 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
2291 search string is above the top of the window, nil when it is beneath
2295 (setq end isearch-point start (or isearch-other-end isearch-point))
2296 (setq start isearch-point end (or isearch-other-end isearch-point)))
2301 (when (>= isearch-point (window-end nil t))
2302 (goto-char isearch-point)
2306 (when (< isearch-point (window-start))
2307 (goto-char isearch-point)
2309 (goto-char isearch-point))
2311 (defvar isearch-pre-scroll-point nil)
2313 (defun isearch-pre-command-hook ()
2314 "Decide whether to exit Isearch mode before executing the command.
2315 Don't exit Isearch if the key sequence that invoked this command
2316 is bound in `isearch-mode-map', or if the invoked command is
2317 a prefix argument command (when `isearch-allow-prefix' is non-nil),
2318 or it is a scrolling command (when `isearch-allow-scroll' is non-nil).
2319 Otherwise, exit Isearch (when `search-exit-option' is non-nil)
2320 before the command is executed globally with terminated Isearch."
2321 (let* ((key (this-single-command-keys))
2322 (main-event (aref key 0)))
2324 ;; Don't exit Isearch if we're in the middle of some
2325 ;; `set-transient-map' thingy like `universal-argument--mode'.
2326 ((not (eq overriding-terminal-local-map isearch--saved-overriding-local-map)))
2327 ;; Don't exit Isearch for isearch key bindings.
2328 ((commandp (lookup-key isearch-mode-map key nil)))
2329 ;; Optionally edit the search string instead of exiting.
2330 ((eq search-exit-option 'edit)
2331 (setq this-command 'isearch-edit-string))
2332 ;; Handle a scrolling function or prefix argument.
2333 ((or (and isearch-allow-prefix
2334 (memq this-command '(universal-argument
2335 digit-argument negative-argument)))
2336 (and isearch-allow-scroll
2337 (symbolp this-command)
2338 (or (eq (get this-command 'isearch-scroll) t)
2339 (eq (get this-command 'scroll-command) t))))
2340 (when isearch-allow-scroll
2341 (setq isearch-pre-scroll-point (point))))
2342 ;; A mouse click on the isearch message starts editing the search string.
2343 ((and (eq (car-safe main-event) 'down-mouse-1)
2344 (window-minibuffer-p (posn-window (event-start main-event))))
2345 ;; Swallow the up-event.
2347 (setq this-command 'isearch-edit-string))
2348 ;; Other characters terminate the search and are then executed normally.
2351 (isearch-clean-overlays))
2352 ;; If search-exit-option is nil, run the command without exiting Isearch.
2354 (isearch-process-search-string key key)))))
2356 (defun isearch-post-command-hook ()
2357 (when isearch-pre-scroll-point
2358 (let ((ab-bel (isearch-string-out-of-window isearch-pre-scroll-point)))
2360 (isearch-back-into-window (eq ab-bel 'above) isearch-pre-scroll-point)
2361 (goto-char isearch-pre-scroll-point)))
2362 (setq isearch-pre-scroll-point nil)
2365 (defun isearch-quote-char (&optional count)
2366 "Quote special characters for incremental search.
2367 With argument, add COUNT copies of the character."
2369 (let ((char (read-quoted-char (isearch-message t))))
2370 (unless (characterp char)
2371 (user-error "%s is not a valid character"
2372 (key-description (vector char))))
2373 ;; Assume character codes 0200 - 0377 stand for characters in some
2374 ;; single-byte character set, and convert them to Emacs
2376 (if (and isearch-regexp isearch-regexp-lax-whitespace (= char ?\s))
2377 (if (subregexp-context-p isearch-string (length isearch-string))
2378 (isearch-process-search-string "[ ]" " ")
2379 (isearch-process-search-char char count))
2380 ;; This used to assume character codes 0240 - 0377 stand for
2381 ;; characters in some single-byte character set, and converted them
2382 ;; to Emacs characters. But in 23.1 this feature is deprecated
2383 ;; in favor of inserting the corresponding Unicode characters.
2384 ;; (and enable-multibyte-characters
2387 ;; (setq char (unibyte-char-to-multibyte char)))
2388 (isearch-process-search-char char count))))
2390 (defun isearch-printing-char (&optional char count)
2391 "Add this ordinary printing CHAR to the search string and search.
2392 With argument, add COUNT copies of the character."
2393 (interactive (list last-command-event
2394 (prefix-numeric-value current-prefix-arg)))
2395 (let ((char (or char last-command-event)))
2398 (if current-input-method
2399 (isearch-process-search-multibyte-characters char count)
2400 (isearch-process-search-char char count))))
2402 (defun isearch-process-search-char (char &optional count)
2403 "Add CHAR to the search string, COUNT times.
2404 Search is updated accordingly."
2405 ;; * and ? are special in regexps when not preceded by \.
2406 ;; } and | are special in regexps when preceded by \.
2407 ;; Nothing special for + because it matches at least once.
2409 ((memq char '(?* ??)) (isearch-fallback nil))
2410 ((eq char ?\}) (isearch-fallback t t))
2411 ((eq char ?|) (isearch-fallback t nil t)))
2413 ;; Append the char(s) to the search string,
2414 ;; update the message and re-search.
2415 (let* ((string (if (and (integerp count) (> count 1))
2416 (make-string count char)
2417 (char-to-string char)))
2418 (message (if (>= char ?\200)
2420 (mapconcat 'isearch-text-char-description string ""))))
2421 (isearch-process-search-string string message)))
2423 (defun isearch-process-search-string (string message)
2424 (setq isearch-string (concat isearch-string string)
2425 isearch-message (concat isearch-message message))
2426 (isearch-search-and-update))
2431 (defun isearch-ring-adjust1 (advance)
2432 ;; Helper for isearch-ring-adjust
2433 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2434 (length (length ring))
2435 (yank-pointer-name (if isearch-regexp
2436 'regexp-search-ring-yank-pointer
2437 'search-ring-yank-pointer))
2438 (yank-pointer (eval yank-pointer-name)))
2441 (set yank-pointer-name
2443 (mod (+ (or yank-pointer (if advance 0 -1))
2446 (setq isearch-string (nth yank-pointer ring)
2447 isearch-message (mapconcat 'isearch-text-char-description
2448 isearch-string "")))))
2450 (defun isearch-ring-adjust (advance)
2451 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2452 (isearch-ring-adjust1 advance)
2453 (if search-ring-update
2456 (isearch-push-state)
2458 ;; Otherwise, edit the search string instead. Note that there is
2459 ;; no need to push the search state after isearch-edit-string here
2460 ;; since isearch-edit-string already pushes its state
2461 (isearch-edit-string)))
2463 (defun isearch-ring-advance ()
2464 "Advance to the next search string in the ring."
2465 ;; This could be more general to handle a prefix arg, but who would use it.
2467 (isearch-ring-adjust 'advance))
2469 (defun isearch-ring-retreat ()
2470 "Retreat to the previous search string in the ring."
2472 (isearch-ring-adjust nil))
2474 (defun isearch-complete1 ()
2475 ;; Helper for isearch-complete and isearch-complete-edit
2476 ;; Return t if completion OK, nil if no completion exists.
2477 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2478 (completion-ignore-case case-fold-search)
2479 (completion (try-completion isearch-string ring)))
2482 ;; isearch-string stays the same
2484 ((or completion ; not nil, must be a string
2485 (= 0 (length isearch-string))) ; shouldn't have to say this
2486 (if (equal completion isearch-string) ;; no extension?
2488 (if completion-auto-help
2489 (with-output-to-temp-buffer "*Isearch completions*"
2490 (display-completion-list
2491 (all-completions isearch-string ring))))
2494 (setq isearch-string completion))))
2496 (message "No completion") ; waits a second if in minibuffer
2499 (defun isearch-complete ()
2500 "Complete the search string from the strings on the search ring.
2501 The completed string is then editable in the minibuffer.
2502 If there is no completion possible, say so and continue searching."
2504 (if (isearch-complete1)
2505 (progn (setq isearch-message
2506 (mapconcat 'isearch-text-char-description
2508 (isearch-edit-string))
2513 (defun isearch-complete-edit ()
2514 "Same as `isearch-complete' except in the minibuffer."
2516 (setq isearch-string (field-string))
2517 (if (isearch-complete1)
2520 (insert isearch-string))))
2525 (defun isearch-message (&optional c-q-hack ellipsis)
2526 ;; Generate and print the message string.
2527 (let ((cursor-in-echo-area ellipsis)
2529 (fail-pos (isearch-fail-pos t)))
2530 ;; Highlight failed part
2532 (setq m (copy-sequence m))
2533 (add-text-properties fail-pos (length m) '(face isearch-fail) m)
2534 ;; Highlight failed trailing whitespace
2535 (when (string-match " +$" m)
2536 (add-text-properties (match-beginning 0) (match-end 0)
2537 '(face trailing-whitespace) m)))
2539 (isearch-message-prefix ellipsis isearch-nonincremental)
2541 (isearch-message-suffix c-q-hack)))
2542 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2544 (defun isearch--describe-regexp-mode (regexp-function &optional space-before)
2545 "Make a string for describing REGEXP-FUNCTION.
2546 If SPACE-BEFORE is non-nil, put a space before, instead of after,
2548 (when (eq regexp-function t)
2549 (setq regexp-function #'word-search-regexp))
2551 ;; Don't use a description on the default search mode.
2552 (cond ((equal regexp-function search-default-regexp-mode) "")
2554 (and (symbolp regexp-function)
2555 (or (get regexp-function 'isearch-message-prefix)
2557 (isearch-regexp "regexp ")
2558 ;; We're in literal mode. If the default mode is not
2559 ;; literal, then describe it.
2560 ((functionp search-default-regexp-mode) "literal "))))
2562 ;; Move space from the end to the beginning.
2563 (replace-regexp-in-string "\\(.*\\) \\'" " \\1" description)
2565 (define-obsolete-function-alias 'isearch--describe-word-mode
2566 'isearch--describe-regexp-mode "25.1")
2568 (defun isearch-message-prefix (&optional ellipsis nonincremental)
2569 ;; If about to search, and previous search regexp was invalid,
2570 ;; check that it still is. If it is valid now,
2571 ;; let the message we display while searching say that it is valid.
2572 (and isearch-error ellipsis
2574 (progn (re-search-forward isearch-string (point) t)
2575 (setq isearch-error nil))
2577 ;; If currently failing, display no ellipsis.
2578 (or isearch-success (setq ellipsis nil))
2579 (let ((m (concat (if isearch-success "" "failing ")
2580 (if isearch-adjusted "pending " "")
2581 (if (and isearch-wrapped
2582 (not isearch-wrap-function)
2584 (> (point) isearch-opoint)
2585 (< (point) isearch-opoint)))
2587 (if isearch-wrapped "wrapped ")
2589 (advice-function-mapc
2591 (let ((np (cdr (assq 'isearch-message-prefix props))))
2592 (if np (setq prefix (concat np prefix)))))
2593 isearch-filter-predicate)
2595 (isearch--describe-regexp-mode isearch-regexp-function)
2597 (multi-isearch-file-list "multi-file ")
2598 (multi-isearch-buffer-list "multi-buffer ")
2600 (or isearch-message-prefix-add "")
2601 (if nonincremental "search" "I-search")
2602 (if isearch-forward "" " backward")
2603 (if current-input-method
2604 ;; Input methods for RTL languages use RTL
2605 ;; characters for their title, and that messes
2606 ;; up the display of search text after the prompt.
2607 (bidi-string-mark-left-to-right
2608 (concat " [" current-input-method-title "]: "))
2611 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2612 'face 'minibuffer-prompt)))
2614 (defun isearch-message-suffix (&optional c-q-hack)
2615 (concat (if c-q-hack "^Q" "")
2617 (concat " [" isearch-error "]")
2619 (or isearch-message-suffix-add "")))
2624 (defvar isearch-search-fun-function 'isearch-search-fun-default
2625 "Non-default value overrides the behavior of `isearch-search-fun-default'.
2626 This variable's value should be a function, which will be called
2627 with no arguments, and should return a function that takes three
2628 arguments: STRING, BOUND, and NOERROR.
2630 This returned function will be used by `isearch-search-string' to
2631 search for the first occurrence of STRING or its translation.")
2633 (defun isearch-search-fun ()
2634 "Return the function to use for the search.
2635 Can be changed via `isearch-search-fun-function' for special needs."
2636 (funcall (or isearch-search-fun-function 'isearch-search-fun-default)))
2638 (defun isearch--lax-regexp-function-p ()
2639 "Non-nil if next regexp-function call should be lax."
2640 (not (or isearch-nonincremental
2641 (null (car isearch-cmds))
2642 (eq (length isearch-string)
2643 (length (isearch--state-string
2644 (car isearch-cmds)))))))
2646 (defun isearch-search-fun-default ()
2647 "Return default functions to use for the search."
2648 (lambda (string &optional bound noerror count)
2649 ;; Use lax versions to not fail at the end of the word while
2650 ;; the user adds and removes characters in the search string
2651 ;; (or when using nonincremental word isearch)
2652 (let ((search-spaces-regexp (when (cond
2653 (isearch-regexp isearch-regexp-lax-whitespace)
2654 (t isearch-lax-whitespace))
2655 search-whitespace-regexp)))
2658 (if isearch-forward #'re-search-forward #'re-search-backward)
2659 (cond (isearch-regexp-function
2660 (let ((lax (isearch--lax-regexp-function-p)))
2661 (if (functionp isearch-regexp-function)
2662 (funcall isearch-regexp-function string lax)
2663 (word-search-regexp string lax))))
2664 (isearch-regexp string)
2665 (t (regexp-quote string)))
2666 bound noerror count)
2669 (let ((prefix (get isearch-regexp-function 'isearch-message-prefix)))
2670 (if (and isearch-regexp-function (stringp prefix))
2671 (list (format "%s [using %ssearch]" string prefix))
2674 (defun isearch-search-string (string bound noerror)
2675 "Search for the first occurrence of STRING or its translation.
2676 If found, move point to the end of the occurrence,
2677 update the match data, and return point."
2678 (let* ((func (isearch-search-fun))
2679 (pos1 (save-excursion (funcall func string bound noerror)))
2682 ;; Avoid "obsolete" warnings for translation-table-for-input.
2684 (char-table-p translation-table-for-input))
2685 (multibyte-string-p string)
2686 ;; Minor optimization.
2687 (string-match-p "[^[:ascii:]]" string))
2692 ;; Avoid "obsolete" warnings for
2693 ;; translation-table-for-input.
2695 (aref translation-table-for-input c))
2702 (if (setq pos2 (funcall func translated bound noerror))
2703 (setq match-data (match-data t)))))
2706 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2708 (set-match-data match-data)))))
2710 ;; When using multiple buffers isearch, switch to the new buffer here,
2711 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2712 (if (and multi-isearch-next-buffer-current-function
2713 (buffer-live-p multi-isearch-current-buffer))
2714 (switch-to-buffer multi-isearch-current-buffer))
2718 (defun isearch-search ()
2719 ;; Do the search with the current search string.
2720 (if isearch-message-function
2721 (funcall isearch-message-function nil t)
2722 (isearch-message nil t))
2723 (if (and (eq isearch-case-fold-search t) search-upper-case)
2724 (setq isearch-case-fold-search
2725 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2726 (condition-case lossage
2727 (let ((inhibit-point-motion-hooks isearch-invisible)
2729 (case-fold-search isearch-case-fold-search)
2730 (search-invisible isearch-invisible)
2732 (setq isearch-error nil)
2734 (setq isearch-success
2735 (isearch-search-string isearch-string nil t))
2736 ;; Clear RETRY unless the search predicate says
2737 ;; to skip this search hit.
2738 (if (or (not isearch-success)
2740 (= (match-beginning 0) (match-end 0))
2741 (funcall isearch-filter-predicate
2742 (match-beginning 0) (match-end 0)))
2744 (setq isearch-just-started nil)
2746 (setq isearch-other-end
2747 (if isearch-forward (match-beginning 0) (match-end 0)))))
2749 (quit (isearch-unread ?\C-g)
2750 (setq isearch-success nil))
2753 (setq isearch-error (car (cdr lossage)))
2756 "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
2758 (setq isearch-error "incomplete input"))
2759 ((and (not isearch-regexp)
2760 (string-match "\\`Regular expression too big" isearch-error))
2762 (isearch-regexp-function
2763 (setq isearch-error "Too many words"))
2764 ((and isearch-lax-whitespace search-whitespace-regexp)
2765 (setq isearch-error "Too many spaces for whitespace matching"))))))
2768 (setq isearch-success nil)
2769 (setq isearch-error (nth 2 lossage)))
2772 ;; stack overflow in regexp search.
2773 (setq isearch-error (format "%s" lossage))))
2777 ;; Ding if failed this time after succeeding last time.
2778 (and (isearch--state-success (car isearch-cmds))
2780 (if (functionp (isearch--state-pop-fun (car isearch-cmds)))
2781 (funcall (isearch--state-pop-fun (car isearch-cmds))
2782 (car isearch-cmds)))
2783 (goto-char (isearch--state-point (car isearch-cmds)))))
2786 ;; Called when opening an overlay, and we are still in isearch.
2787 (defun isearch-open-overlay-temporary (ov)
2788 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2789 ;; Some modes would want to open the overlays temporary during
2790 ;; isearch in their own way, they should set the
2791 ;; `isearch-open-invisible-temporary' to a function doing this.
2792 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2793 ;; Store the values for the `invisible' property, and then set it to nil.
2794 ;; This way the text hidden by this overlay becomes visible.
2796 ;; In 19.34 this does not exist so I cannot test it.
2797 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2798 (overlay-put ov 'invisible nil)))
2801 ;; This is called at the end of isearch. It will open the overlays
2802 ;; that contain the latest match. Obviously in case of a C-g the
2803 ;; point returns to the original location which surely is not contain
2804 ;; in any of these overlays, se we are safe in this case too.
2805 (defun isearch-open-necessary-overlays (ov)
2806 (let ((inside-overlay (and (> (point) (overlay-start ov))
2807 (<= (point) (overlay-end ov))))
2808 ;; If this exists it means that the overlay was opened using
2809 ;; this function, not by us tweaking the overlay properties.
2810 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2811 (when (or inside-overlay (not fct-temp))
2812 ;; restore the values for the `invisible' properties.
2813 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2814 (overlay-put ov 'isearch-invisible nil))
2816 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2818 (funcall fct-temp ov t)))))
2820 ;; This is called when exiting isearch. It closes the temporary
2821 ;; opened overlays, except the ones that contain the latest match.
2822 (defun isearch-clean-overlays ()
2823 (when isearch-opened-overlays
2824 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2825 (setq isearch-opened-overlays nil)))
2828 (defun isearch-intersects-p (start0 end0 start1 end1)
2829 "Return t if regions START0..END0 and START1..END1 intersect."
2830 (or (and (>= start0 start1) (< start0 end1))
2831 (and (> end0 start1) (<= end0 end1))
2832 (and (>= start1 start0) (< start1 end0))
2833 (and (> end1 start0) (<= end1 end0))))
2836 ;; Verify if the current match is outside of each element of
2837 ;; `isearch-opened-overlays', if so close that overlay.
2839 (defun isearch-close-unnecessary-overlays (begin end)
2840 (let ((overlays isearch-opened-overlays))
2841 (setq isearch-opened-overlays nil)
2842 (dolist (ov overlays)
2843 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2844 (push ov isearch-opened-overlays)
2845 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2847 ;; If this exists it means that the overlay was opened
2848 ;; using this function, not by us tweaking the overlay
2850 (funcall fct-temp ov t)
2851 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2852 (overlay-put ov 'isearch-invisible nil)))))))
2855 (defun isearch-range-invisible (beg end)
2856 "Return t if all the text from BEG to END is invisible."
2858 ;; Check that invisibility runs up to END.
2861 (let (;; can-be-opened keeps track if we can open some overlays.
2862 (can-be-opened (eq search-invisible 'open))
2863 ;; the list of overlays that could be opened
2865 (when (and can-be-opened isearch-hide-immediately)
2866 (isearch-close-unnecessary-overlays beg end))
2867 ;; If the following character is currently invisible,
2868 ;; skip all characters with that same `invisible' property value.
2869 ;; Do that over and over.
2870 (while (and (< (point) end) (invisible-p (point)))
2871 (if (invisible-p (get-text-property (point) 'invisible))
2873 (goto-char (next-single-property-change (point) 'invisible
2875 ;; if text is hidden by an `invisible' text property
2876 ;; we cannot open it at all.
2877 (setq can-be-opened nil))
2879 (let ((overlays (overlays-at (point)))
2884 (setq o (car overlays)
2885 invis-prop (overlay-get o 'invisible))
2886 (if (invisible-p invis-prop)
2887 (if (overlay-get o 'isearch-open-invisible)
2888 (setq ov-list (cons o ov-list))
2889 ;; We found one overlay that cannot be
2890 ;; opened, that means the whole chunk
2891 ;; cannot be opened.
2892 (setq can-be-opened nil)))
2893 (setq overlays (cdr overlays)))
2895 ;; It makes sense to append to the open
2896 ;; overlays list only if we know that this is
2898 (setq crt-overlays (append ov-list crt-overlays)))))
2899 (goto-char (next-overlay-change (point)))))
2900 ;; See if invisibility reaches up thru END.
2901 (if (>= (point) end)
2902 (if (and can-be-opened (consp crt-overlays))
2904 (setq isearch-opened-overlays
2905 (append isearch-opened-overlays crt-overlays))
2906 (mapc 'isearch-open-overlay-temporary crt-overlays)
2908 (setq isearch-hidden t)))))))
2910 (defun isearch-filter-visible (beg end)
2911 "Test whether the current search hit is visible at least partially.
2912 Return non-nil if the text from BEG to END is visible to Isearch as
2913 determined by `isearch-range-invisible' unless invisible text can be
2914 searched too when `search-invisible' is t."
2915 (or (eq search-invisible t)
2916 (not (isearch-range-invisible beg end))))
2919 ;; General utilities
2921 (defun isearch-no-upper-case-p (string regexp-flag)
2922 "Return t if there are no upper case chars in STRING.
2923 If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
2924 since they have special meaning in a regexp."
2925 (let (quote-flag (i 0) (len (length string)) found)
2926 (while (and (not found) (< i len))
2927 (let ((char (aref string i)))
2928 (if (and regexp-flag (eq char ?\\))
2929 (setq quote-flag (not quote-flag))
2930 (if (and (not quote-flag) (not (eq char (downcase char))))
2932 (setq quote-flag nil)))
2935 ;; Even if there's no uppercase char, we want to detect the use
2936 ;; of [:upper:] or [:lower:] char-class, which indicates
2937 ;; clearly that the user cares about case distinction.
2938 (and regexp-flag (string-match "\\[:\\(upp\\|low\\)er:]" string)
2941 (string-match (substring string 0 (match-beginning 0))
2945 (equal "Unmatched [ or [^" (cadr err)))))))))
2947 ;; Portability functions to support various Emacs versions.
2949 (defun isearch-text-char-description (c)
2951 ((< c ?\s) (propertize
2953 'display (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph)))
2954 ((= c ?\^?) (propertize
2956 'display (propertize "^?" 'face 'escape-glyph)))
2957 (t (char-to-string c))))
2959 ;; General function to unread characters or events.
2960 ;; Also insert them in a keyboard macro being defined.
2961 (defun isearch-unread (&rest char-or-events)
2962 (mapc 'store-kbd-macro-event char-or-events)
2963 (setq unread-command-events
2964 (append char-or-events unread-command-events)))
2969 (defvar isearch-overlay nil)
2971 (defun isearch-highlight (beg end)
2972 (if search-highlight
2974 ;; Overlay already exists, just move it.
2975 (move-overlay isearch-overlay beg end (current-buffer))
2976 ;; Overlay doesn't exist, create it.
2977 (setq isearch-overlay (make-overlay beg end))
2978 ;; 1001 is higher than lazy's 1000 and ediff's 100+
2979 (overlay-put isearch-overlay 'priority 1001)
2980 (overlay-put isearch-overlay 'face isearch-face))))
2982 (defun isearch-dehighlight ()
2983 (when isearch-overlay
2984 (delete-overlay isearch-overlay)))
2986 ;; isearch-lazy-highlight feature
2987 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
2989 ;; When active, *every* match for the current search string is
2990 ;; highlighted: the current one using the normal isearch match color
2991 ;; and all the others using `isearch-lazy-highlight'. The extra
2992 ;; highlighting makes it easier to anticipate where the cursor will
2993 ;; land each time you press C-s or C-r to repeat a pending search.
2994 ;; Highlighting of these additional matches happens in a deferred
2995 ;; fashion using "idle timers," so the cycles needed do not rob
2996 ;; isearch of its usual snappy response.
2998 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
3000 ;; - `isearch-update' is expected to be called (at least) every time
3001 ;; the search string or window-start changes;
3002 ;; - `isearch-string' is expected to contain the current search
3003 ;; string as entered by the user;
3004 ;; - the type of the current search is expected to be given by
3005 ;; `isearch-regexp-function' and `isearch-regexp';
3006 ;; - the direction of the current search is expected to be given by
3007 ;; `isearch-forward';
3008 ;; - the variable `isearch-error' is expected to be true
3009 ;; only if `isearch-string' is an invalid regexp.
3011 (defvar isearch-lazy-highlight-overlays nil)
3012 (defvar isearch-lazy-highlight-wrapped nil)
3013 (defvar isearch-lazy-highlight-start-limit nil)
3014 (defvar isearch-lazy-highlight-end-limit nil)
3015 (defvar isearch-lazy-highlight-start nil)
3016 (defvar isearch-lazy-highlight-end nil)
3017 (defvar isearch-lazy-highlight-timer nil)
3018 (defvar isearch-lazy-highlight-last-string nil)
3019 (defvar isearch-lazy-highlight-window nil)
3020 (defvar isearch-lazy-highlight-window-start nil)
3021 (defvar isearch-lazy-highlight-window-end nil)
3022 (defvar isearch-lazy-highlight-case-fold-search nil)
3023 (defvar isearch-lazy-highlight-regexp nil)
3024 (defvar isearch-lazy-highlight-lax-whitespace nil)
3025 (defvar isearch-lazy-highlight-regexp-lax-whitespace nil)
3026 (defvar isearch-lazy-highlight-regexp-function nil)
3027 (define-obsolete-variable-alias 'isearch-lazy-highlight-word
3028 'isearch-lazy-highlight-regexp-function "25.1")
3029 (defvar isearch-lazy-highlight-forward nil)
3030 (defvar isearch-lazy-highlight-error nil)
3032 (defun lazy-highlight-cleanup (&optional force)
3033 "Stop lazy highlighting and remove extra highlighting from current buffer.
3034 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
3035 is nil. This function is called when exiting an incremental search if
3036 `lazy-highlight-cleanup' is non-nil."
3038 (if (or force lazy-highlight-cleanup)
3039 (while isearch-lazy-highlight-overlays
3040 (delete-overlay (car isearch-lazy-highlight-overlays))
3041 (setq isearch-lazy-highlight-overlays
3042 (cdr isearch-lazy-highlight-overlays))))
3043 (when isearch-lazy-highlight-timer
3044 (cancel-timer isearch-lazy-highlight-timer)
3045 (setq isearch-lazy-highlight-timer nil)))
3047 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
3048 'lazy-highlight-cleanup
3051 (defun isearch-lazy-highlight-new-loop (&optional beg end)
3052 "Cleanup any previous `lazy-highlight' loop and begin a new one.
3053 BEG and END specify the bounds within which highlighting should occur.
3054 This is called when `isearch-update' is invoked (which can cause the
3055 search string to change or the window to scroll). It is also used
3056 by other Emacs features."
3057 (when (and (null executing-kbd-macro)
3058 (sit-for 0) ;make sure (window-start) is credible
3059 (or (not (equal isearch-string
3060 isearch-lazy-highlight-last-string))
3061 (not (eq (selected-window)
3062 isearch-lazy-highlight-window))
3063 (not (eq isearch-lazy-highlight-case-fold-search
3064 isearch-case-fold-search))
3065 (not (eq isearch-lazy-highlight-regexp
3067 (not (eq isearch-lazy-highlight-regexp-function
3068 isearch-regexp-function))
3069 (not (eq isearch-lazy-highlight-lax-whitespace
3070 isearch-lax-whitespace))
3071 (not (eq isearch-lazy-highlight-regexp-lax-whitespace
3072 isearch-regexp-lax-whitespace))
3073 (not (= (window-start)
3074 isearch-lazy-highlight-window-start))
3075 (not (= (window-end) ; Window may have been split/joined.
3076 isearch-lazy-highlight-window-end))
3077 (not (eq isearch-forward
3078 isearch-lazy-highlight-forward))
3079 ;; In case we are recovering from an error.
3080 (not (equal isearch-error
3081 isearch-lazy-highlight-error))))
3082 ;; something important did indeed change
3083 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
3084 (setq isearch-lazy-highlight-error isearch-error)
3085 ;; It used to check for `(not isearch-error)' here, but actually
3086 ;; lazy-highlighting might find matches to highlight even when
3087 ;; `isearch-error' is non-nil. (Bug#9918)
3088 (setq isearch-lazy-highlight-start-limit beg
3089 isearch-lazy-highlight-end-limit end)
3090 (setq isearch-lazy-highlight-window (selected-window)
3091 isearch-lazy-highlight-window-start (window-start)
3092 isearch-lazy-highlight-window-end (window-end)
3093 ;; Start lazy-highlighting at the beginning of the found
3094 ;; match (`isearch-other-end'). If no match, use point.
3095 ;; One of the next two variables (depending on search direction)
3096 ;; is used to define the starting position of lazy-highlighting
3097 ;; and also to remember the current position of point between
3098 ;; calls of `isearch-lazy-highlight-update', and another variable
3099 ;; is used to define where the wrapped search must stop.
3100 isearch-lazy-highlight-start (or isearch-other-end (point))
3101 isearch-lazy-highlight-end (or isearch-other-end (point))
3102 isearch-lazy-highlight-wrapped nil
3103 isearch-lazy-highlight-last-string isearch-string
3104 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
3105 isearch-lazy-highlight-regexp isearch-regexp
3106 isearch-lazy-highlight-lax-whitespace isearch-lax-whitespace
3107 isearch-lazy-highlight-regexp-lax-whitespace isearch-regexp-lax-whitespace
3108 isearch-lazy-highlight-regexp-function isearch-regexp-function
3109 isearch-lazy-highlight-forward isearch-forward)
3110 (unless (equal isearch-string "")
3111 (setq isearch-lazy-highlight-timer
3112 (run-with-idle-timer lazy-highlight-initial-delay nil
3113 'isearch-lazy-highlight-update)))))
3115 (defun isearch-lazy-highlight-search ()
3116 "Search ahead for the next or previous match, for lazy highlighting.
3117 Attempt to do the search exactly the way the pending Isearch would."
3119 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
3120 (isearch-regexp isearch-lazy-highlight-regexp)
3121 (isearch-regexp-function isearch-lazy-highlight-regexp-function)
3122 (isearch-lax-whitespace
3123 isearch-lazy-highlight-lax-whitespace)
3124 (isearch-regexp-lax-whitespace
3125 isearch-lazy-highlight-regexp-lax-whitespace)
3126 (isearch-forward isearch-lazy-highlight-forward)
3127 (search-invisible nil) ; don't match invisible text
3130 (bound (if isearch-lazy-highlight-forward
3131 (min (or isearch-lazy-highlight-end-limit (point-max))
3132 (if isearch-lazy-highlight-wrapped
3133 (+ isearch-lazy-highlight-start
3134 ;; Extend bound to match whole string at point
3135 (1- (length isearch-lazy-highlight-last-string)))
3137 (max (or isearch-lazy-highlight-start-limit (point-min))
3138 (if isearch-lazy-highlight-wrapped
3139 (- isearch-lazy-highlight-end
3140 ;; Extend bound to match whole string at point
3141 (1- (length isearch-lazy-highlight-last-string)))
3143 ;; Use a loop like in `isearch-search'.
3145 (setq success (isearch-search-string
3146 isearch-lazy-highlight-last-string bound t))
3147 ;; Clear RETRY unless the search predicate says
3148 ;; to skip this search hit.
3149 (if (or (not success)
3150 (= (point) bound) ; like (bobp) (eobp) in `isearch-search'.
3151 (= (match-beginning 0) (match-end 0))
3152 (funcall isearch-filter-predicate
3153 (match-beginning 0) (match-end 0)))
3158 (defun isearch-lazy-highlight-update ()
3159 "Update highlighting of other matches for current search."
3160 (let ((max lazy-highlight-max-at-a-time)
3164 (save-selected-window
3165 (if (and (window-live-p isearch-lazy-highlight-window)
3166 (not (eq (selected-window) isearch-lazy-highlight-window)))
3167 (select-window isearch-lazy-highlight-window))
3170 (goto-char (if isearch-lazy-highlight-forward
3171 isearch-lazy-highlight-end
3172 isearch-lazy-highlight-start))
3174 (let ((found (isearch-lazy-highlight-search)))
3178 (setq looping nil)))
3180 (let ((mb (match-beginning 0))
3182 (if (= mb me) ;zero-length match
3183 (if isearch-lazy-highlight-forward
3184 (if (= mb (if isearch-lazy-highlight-wrapped
3185 isearch-lazy-highlight-start
3189 (if (= mb (if isearch-lazy-highlight-wrapped
3190 isearch-lazy-highlight-end
3195 ;; non-zero-length match
3196 (let ((ov (make-overlay mb me)))
3197 (push ov isearch-lazy-highlight-overlays)
3198 ;; 1000 is higher than ediff's 100+,
3199 ;; but lower than isearch main overlay's 1001
3200 (overlay-put ov 'priority 1000)
3201 (overlay-put ov 'face lazy-highlight-face)
3202 (overlay-put ov 'window (selected-window))))
3203 ;; Remember the current position of point for
3204 ;; the next call of `isearch-lazy-highlight-update'
3205 ;; when `lazy-highlight-max-at-a-time' is too small.
3206 (if isearch-lazy-highlight-forward
3207 (setq isearch-lazy-highlight-end (point))
3208 (setq isearch-lazy-highlight-start (point)))))
3210 ;; not found or zero-length match at the search bound
3212 (if isearch-lazy-highlight-wrapped
3215 (setq isearch-lazy-highlight-wrapped t)
3216 (if isearch-lazy-highlight-forward
3218 (setq isearch-lazy-highlight-end (window-start))
3219 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
3221 (setq isearch-lazy-highlight-start (window-end))
3222 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
3225 (setq isearch-lazy-highlight-timer
3226 (run-at-time lazy-highlight-interval nil
3227 'isearch-lazy-highlight-update)))))))))
3229 (defun isearch-resume (string regexp word forward message case-fold)
3230 "Resume an incremental search.
3231 STRING is the string or regexp searched for.
3232 REGEXP non-nil means the resumed search was a regexp search.
3233 WORD non-nil means resume a word search.
3234 FORWARD non-nil means resume a forward search.
3235 MESSAGE is the echo-area message recorded for the search resumed.
3236 CASE-FOLD non-nil means the search was case-insensitive."
3237 (isearch-mode forward regexp nil nil word)
3238 (setq isearch-string string
3239 isearch-message message
3240 isearch-case-fold-search case-fold)
3244 ;;; isearch.el ends here