1 ;;; isearch.el --- incremental search minor mode
3 ;; Copyright (C) 1992-1997, 1999-2011 Free Software Foundation, Inc.
5 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
29 ;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
30 ;; isearch-mode behaves modally and does not return until the search
31 ;; is completed. It uses a recursive-edit to behave this way.
33 ;; The key bindings active within isearch-mode are defined below in
34 ;; `isearch-mode-map' which is given bindings close to the default
35 ;; characters of the original isearch.el. With `isearch-mode',
36 ;; however, you can bind multi-character keys and it should be easier
37 ;; to add new commands. One bug though: keys with meta-prefix cannot
38 ;; be longer than two chars. Also see minibuffer-local-isearch-map
39 ;; for bindings active during `isearch-edit-string'.
41 ;; isearch-mode should work even if you switch windows with the mouse,
42 ;; in which case isearch-mode is terminated automatically before the
45 ;; The search ring and completion commands automatically put you in
46 ;; the minibuffer to edit the string. This gives you a chance to
47 ;; modify the search string before executing the search. There are
48 ;; three commands to terminate the editing: C-s and C-r exit the
49 ;; minibuffer and search forward and reverse respectively, while C-m
50 ;; exits and does a nonincremental search.
52 ;; Exiting immediately from isearch uses isearch-edit-string instead
53 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
54 ;; The name of this option should probably be changed if we decide to
55 ;; keep the behavior. No point in forcing nonincremental search until
56 ;; the last possible moment.
61 ;; Some additional options and constants.
64 "Incremental search minor mode."
65 :link
'(emacs-commentary-link "isearch")
66 :link
'(custom-manual "(emacs)Incremental Search")
72 (defcustom search-exit-option t
73 "Non-nil means random control characters terminate incremental search."
77 (defcustom search-slow-window-lines
1
78 "Number of lines in slow search display windows.
79 These are the short windows used during incremental search on slow terminals.
80 Negative means put the slow search window at the top (normally it's at bottom)
81 and the value is minus the number of lines."
85 (defcustom search-slow-speed
1200
86 "Highest terminal speed at which to use \"slow\" style incremental search.
87 This is the style where a one-line window is created to show the line
88 that the search has reached."
92 (defcustom search-upper-case
'not-yanks
93 "If non-nil, upper case chars disable case fold searching.
94 That is, upper and lower case chars must match exactly.
95 This applies no matter where the chars come from, but does not
96 apply to chars in regexps that are prefixed with `\\'.
97 If this value is `not-yanks', text yanked into the search string
98 in Isearch mode is always downcased."
99 :type
'(choice (const :tag
"off" nil
)
104 (defcustom search-nonincremental-instead t
105 "If non-nil, do a nonincremental search instead if exiting immediately.
106 Actually, `isearch-edit-string' is called to let you enter the search
107 string, and RET terminates editing and does a nonincremental search."
111 (defcustom search-whitespace-regexp
(purecopy "\\s-+")
112 "If non-nil, regular expression to match a sequence of whitespace chars.
113 This applies to regular expression incremental search.
114 When you put a space or spaces in the incremental regexp, it stands for
115 this, unless it is inside of a regexp construct such as [...] or *, + or ?.
116 You might want to use something like \"[ \\t\\r\\n]+\" instead.
117 In the Customization buffer, that is `[' followed by a space,
118 a tab, a carriage return (control-M), a newline, and `]+'.
120 When this is nil, each space you type matches literally, against one space."
121 :type
'(choice (const :tag
"Find Spaces Literally" nil
)
125 (defcustom search-invisible
'open
126 "If t incremental search can match hidden text.
127 A nil value means don't match invisible text.
128 When the value is `open', if the text matched is made invisible by
129 an overlay having an `invisible' property and that overlay has a property
130 `isearch-open-invisible', then incremental search will show the contents.
131 \(This applies when using `outline.el' and `hideshow.el'.)
132 See also `reveal-mode' if you want overlays to automatically be opened
133 whenever point is in one of them."
134 :type
'(choice (const :tag
"Match hidden text" t
)
135 (const :tag
"Open overlays" open
)
136 (const :tag
"Don't match hidden text" nil
))
139 (defcustom isearch-hide-immediately t
140 "If non-nil, re-hide an invisible match right away.
141 This variable makes a difference when `search-invisible' is set to `open'.
142 It means that after search makes some invisible text visible
143 to show the match, it makes the text invisible again when the match moves.
144 Ordinarily the text becomes invisible again at the end of the search."
148 (defcustom isearch-resume-in-command-history nil
149 "If non-nil, `isearch-resume' commands are added to the command history.
150 This allows you to resume earlier Isearch sessions through the
155 (defvar isearch-mode-hook nil
156 "Function(s) to call after starting up an incremental search.")
158 (defvar isearch-update-post-hook nil
159 "Function(s) to call after isearch has found matches in the buffer.")
161 (defvar isearch-mode-end-hook nil
162 "Function(s) to call after terminating an incremental search.
163 When these functions are called, `isearch-mode-end-hook-quit'
164 is non-nil if the user quits the search.")
166 (defvar isearch-mode-end-hook-quit nil
167 "Non-nil while running `isearch-mode-end-hook' if the user quits the search.")
169 (defvar isearch-message-function nil
170 "Function to call to display the search prompt.
171 If nil, use `isearch-message'.")
173 (defvar isearch-wrap-function nil
174 "Function to call to wrap the search when search is failed.
175 If nil, move point to the beginning of the buffer for a forward search,
176 or to the end of the buffer for a backward search.")
178 (defvar isearch-push-state-function nil
179 "Function to save a function restoring the mode-specific Isearch state
180 to the search status stack.")
182 (defvar isearch-filter-predicate
'isearch-filter-visible
183 "Predicate that filters the search hits that would normally be available.
184 Search hits that dissatisfy the predicate are skipped. The function
185 has two arguments: the positions of start and end of text matched by
186 the search. If this function returns nil, continue searching without
187 stopping at this match.")
191 (defvar search-ring nil
192 "List of search string sequences.")
193 (defvar regexp-search-ring nil
194 "List of regular expression search string sequences.")
196 (defcustom search-ring-max
16
197 "Maximum length of search ring before oldest elements are thrown away."
200 (defcustom regexp-search-ring-max
16
201 "Maximum length of regexp search ring before oldest elements are thrown away."
205 (defvar search-ring-yank-pointer nil
206 "Index in `search-ring' of last string reused.
207 It is nil if none yet.")
208 (defvar regexp-search-ring-yank-pointer nil
209 "Index in `regexp-search-ring' of last string reused.
210 It is nil if none yet.")
212 (defcustom search-ring-update nil
213 "Non-nil if advancing or retreating in the search ring should cause search.
214 Default value, nil, means edit the string instead."
218 ;;; isearch highlight customization.
220 (defcustom search-highlight t
221 "Non-nil means incremental search highlights the current match."
226 '((((class color
) (min-colors 88) (background light
))
227 ;; The background must not be too dark, for that means
228 ;; the character is hard to see when the cursor is there.
229 (:background
"magenta3" :foreground
"lightskyblue1"))
230 (((class color
) (min-colors 88) (background dark
))
231 (:background
"palevioletred2" :foreground
"brown4"))
232 (((class color
) (min-colors 16))
233 (:background
"magenta4" :foreground
"cyan1"))
234 (((class color
) (min-colors 8))
235 (:background
"magenta4" :foreground
"cyan1"))
236 (t (:inverse-video t
)))
237 "Face for highlighting Isearch matches."
240 (defvar isearch-face
'isearch
)
242 (defface isearch-fail
243 '((((class color
) (min-colors 88) (background light
))
244 (:background
"RosyBrown1"))
245 (((class color
) (min-colors 88) (background dark
))
246 (:background
"red4"))
247 (((class color
) (min-colors 16))
249 (((class color
) (min-colors 8))
251 (((class color grayscale
))
253 (t (:inverse-video t
)))
254 "Face for highlighting failed part in Isearch echo-area message."
258 (defcustom isearch-lazy-highlight t
259 "Controls the lazy-highlighting during incremental search.
260 When non-nil, all text in the buffer matching the current search
261 string is highlighted lazily (see `lazy-highlight-initial-delay'
262 and `lazy-highlight-interval')."
264 :group
'lazy-highlight
267 ;;; Lazy highlight customization.
269 (defgroup lazy-highlight nil
270 "Lazy highlighting feature for matching strings."
271 :prefix
"lazy-highlight-"
276 (define-obsolete-variable-alias 'isearch-lazy-highlight-cleanup
277 'lazy-highlight-cleanup
280 (defcustom lazy-highlight-cleanup t
281 "Controls whether to remove extra highlighting after a search.
282 If this is nil, extra highlighting can be \"manually\" removed with
283 \\[lazy-highlight-cleanup]."
285 :group
'lazy-highlight
)
287 (define-obsolete-variable-alias 'isearch-lazy-highlight-initial-delay
288 'lazy-highlight-initial-delay
291 (defcustom lazy-highlight-initial-delay
0.25
292 "Seconds to wait before beginning to lazily highlight all matches."
294 :group
'lazy-highlight
)
296 (define-obsolete-variable-alias 'isearch-lazy-highlight-interval
297 'lazy-highlight-interval
300 (defcustom lazy-highlight-interval
0 ; 0.0625
301 "Seconds between lazily highlighting successive matches."
303 :group
'lazy-highlight
)
305 (define-obsolete-variable-alias 'isearch-lazy-highlight-max-at-a-time
306 'lazy-highlight-max-at-a-time
309 (defcustom lazy-highlight-max-at-a-time
20
310 "Maximum matches to highlight at a time (for `lazy-highlight').
311 Larger values may reduce Isearch's responsiveness to user input;
312 smaller values make matches highlight slowly.
313 A value of nil means highlight all matches."
314 :type
'(choice (const :tag
"All" nil
)
315 (integer :tag
"Some"))
316 :group
'lazy-highlight
)
318 (defface lazy-highlight
319 '((((class color
) (min-colors 88) (background light
))
320 (:background
"paleturquoise"))
321 (((class color
) (min-colors 88) (background dark
))
322 (:background
"paleturquoise4"))
323 (((class color
) (min-colors 16))
324 (:background
"turquoise3"))
325 (((class color
) (min-colors 8))
326 (:background
"turquoise3"))
328 "Face for lazy highlighting of matches other than the current one."
329 :group
'lazy-highlight
331 (define-obsolete-face-alias 'isearch-lazy-highlight-face
'lazy-highlight
"22.1")
332 (define-obsolete-variable-alias 'isearch-lazy-highlight-face
335 (defvar lazy-highlight-face
'lazy-highlight
)
337 ;; Define isearch help map.
339 (defvar isearch-help-map
340 (let ((map (make-sparse-keymap)))
341 (define-key map
[t] 'isearch-other-control-char)
342 (define-key map (char-to-string help-char) 'isearch-help-for-help)
343 (define-key map [help] 'isearch-help-for-help)
344 (define-key map [f1] 'isearch-help-for-help)
345 (define-key map "?" 'isearch-help-for-help)
346 (define-key map "b" 'isearch-describe-bindings)
347 (define-key map "k" 'isearch-describe-key)
348 (define-key map "m" 'isearch-describe-mode)
349 (define-key map "q" 'help-quit)
351 "Keymap for characters following the Help key for Isearch mode.")
353 (eval-when-compile (require 'help-macro))
355 (make-help-screen isearch-help-for-help-internal
356 (purecopy "Type a help option: [bkm] or ?")
357 "You have typed %THIS-KEY%, the help character. Type a Help option:
358 \(Type \\<help-map>\\[help-quit] to exit the Help command.)
360 b Display all Isearch key bindings.
361 k KEYS Display full documentation of Isearch key sequence.
362 m Display documentation of Isearch mode.
364 You can't type here other help keys available in the global help map,
365 but outside of this help window when you type them in Isearch mode,
366 they exit Isearch mode before displaying global help."
369 (defun isearch-help-for-help ()
370 "Display Isearch help menu."
372 (let (same-window-buffer-names same-window-regexps)
373 (isearch-help-for-help-internal))
376 (defun isearch-describe-bindings ()
377 "Show a list of all keys defined in Isearch mode, and their definitions.
378 This is like `describe-bindings', but displays only Isearch keys."
380 (let (same-window-buffer-names same-window-regexps)
381 (with-help-window "*Help*"
382 (with-current-buffer standard-output
383 (princ "Isearch Mode Bindings:\n")
384 (princ (substitute-command-keys "\\{isearch-mode-map}"))))))
386 (defun isearch-describe-key ()
387 "Display documentation of the function invoked by isearch key."
389 (let (same-window-buffer-names same-window-regexps)
390 (call-interactively 'describe-key))
393 (defun isearch-describe-mode ()
394 "Display documentation of Isearch mode."
396 (let (same-window-buffer-names same-window-regexps)
397 (describe-function 'isearch-forward))
400 (defalias 'isearch-mode-help 'isearch-describe-mode)
403 ;; Define isearch-mode keymap.
405 (defvar isearch-mode-map
408 (or (char-table-p (nth 1 map))
409 (error "The initialization of isearch-mode-map must be updated"))
410 ;; Make all multibyte characters search for themselves.
411 (set-char-table-range (nth 1 map) (cons #x100 (max-char))
412 'isearch-printing-char)
413 ;; Make function keys, etc, which aren't bound to a scrolling-function
415 (define-key map [t] 'isearch-other-control-char
)
416 ;; Control chars, by default, end isearch mode transparently.
417 ;; We need these explicit definitions because, in a dense keymap,
418 ;; the binding for t does not affect characters.
419 ;; We use a dense keymap to save space.
421 (define-key map
(make-string 1 i
) 'isearch-other-control-char
)
424 ;; Single-byte printing chars extend the search string by default.
427 (define-key map
(vector i
) 'isearch-printing-char
)
430 ;; To handle local bindings with meta char prefix keys, define
431 ;; another full keymap. This must be done for any other prefix
432 ;; keys as well, one full keymap per char of the prefix key. It
433 ;; would be simpler to disable the global keymap, and/or have a
434 ;; default local key binding for any key not otherwise bound.
435 (let ((meta-map (make-sparse-keymap)))
436 (define-key map
(char-to-string meta-prefix-char
) meta-map
)
437 (define-key map
[escape] meta-map))
438 (define-key map (vector meta-prefix-char t) 'isearch-other-meta-char)
440 ;; Several non-printing chars change the searching behavior.
441 (define-key map "\C-s" 'isearch-repeat-forward)
442 (define-key map "\C-r" 'isearch-repeat-backward)
443 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
444 ;; combinations can be used to repeat regexp isearches that can
445 ;; be used to start these searches.
446 (define-key map "\M-\C-s" 'isearch-repeat-forward)
447 (define-key map "\M-\C-r" 'isearch-repeat-backward)
448 (define-key map "\177" 'isearch-delete-char)
449 (define-key map "\C-g" 'isearch-abort)
451 ;; This assumes \e is the meta-prefix-char.
452 (or (= ?\e meta-prefix-char)
453 (error "Inconsistency in isearch.el"))
454 (define-key map "\e\e\e" 'isearch-cancel)
455 (define-key map [escape escape escape] 'isearch-cancel)
457 (define-key map "\C-q" 'isearch-quote-char)
459 (define-key map "\r" 'isearch-exit)
460 (define-key map "\C-j" 'isearch-printing-char)
461 (define-key map "\t" 'isearch-printing-char)
462 (define-key map [?\S-\ ] 'isearch-printing-char)
464 (define-key map "\C-w" 'isearch-yank-word-or-char)
465 (define-key map "\M-\C-w" 'isearch-del-char)
466 (define-key map "\M-\C-y" 'isearch-yank-char)
467 (define-key map "\C-y" 'isearch-yank-kill)
468 (define-key map "\M-s\C-e" 'isearch-yank-line)
470 (define-key map (char-to-string help-char) isearch-help-map)
471 (define-key map [help] isearch-help-map)
472 (define-key map [f1] isearch-help-map)
474 (define-key map "\M-n" 'isearch-ring-advance)
475 (define-key map "\M-p" 'isearch-ring-retreat)
476 (define-key map "\M-y" 'isearch-yank-pop)
478 (define-key map "\M-\t" 'isearch-complete)
480 ;; Pass frame events transparently so they won't exit the search.
481 ;; In particular, if we have more than one display open, then a
482 ;; switch-frame might be generated by someone typing at another keyboard.
483 (define-key map [switch-frame] nil)
484 (define-key map [delete-frame] nil)
485 (define-key map [iconify-frame] nil)
486 (define-key map [make-frame-visible] nil)
487 (define-key map [mouse-movement] nil)
488 (define-key map [language-change] nil)
490 ;; For searching multilingual text.
491 (define-key map "\C-\\" 'isearch-toggle-input-method)
492 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
494 ;; People expect to be able to paste with the mouse.
495 (define-key map [mouse-2] #'isearch-mouse-2)
496 (define-key map [down-mouse-2] nil)
498 ;; Some bindings you may want to put in your isearch-mode-hook.
499 ;; Suggest some alternates...
500 (define-key map "\M-c" 'isearch-toggle-case-fold)
501 (define-key map "\M-r" 'isearch-toggle-regexp)
502 (define-key map "\M-e" 'isearch-edit-string)
504 (define-key map "\M-sr" 'isearch-toggle-regexp)
505 (define-key map "\M-sw" 'isearch-toggle-word)
507 (define-key map [?\M-%] 'isearch-query-replace)
508 (define-key map [?\C-\M-%] 'isearch-query-replace-regexp)
509 (define-key map "\M-so" 'isearch-occur)
510 (define-key map "\M-shr" 'isearch-highlight-regexp)
513 "Keymap for `isearch-mode'.")
515 (defvar minibuffer-local-isearch-map
516 (let ((map (make-sparse-keymap)))
517 (set-keymap-parent map minibuffer-local-map)
518 (define-key map "\r" 'isearch-nonincremental-exit-minibuffer)
519 (define-key map "\M-\t" 'isearch-complete-edit)
520 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
521 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
522 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
523 (define-key map [right] 'isearch-yank-char-in-minibuffer)
525 "Keymap for editing Isearch strings in the minibuffer.")
527 ;; Internal variables declared globally for byte-compiler.
528 ;; These are all set with setq while isearching
529 ;; and bound locally while editing the search string.
531 (defvar isearch-forward nil) ; Searching in the forward direction.
532 (defvar isearch-regexp nil) ; Searching for a regexp.
533 (defvar isearch-word nil) ; Searching for words.
534 (defvar isearch-hidden nil) ; Non-nil if the string exists but is invisible.
536 (defvar isearch-cmds nil
537 "Stack of search status sets.
538 Each set is a vector of the form:
539 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
540 INVALID-REGEXP WRAPPED BARRIER WITHIN-BRACKETS CASE-FOLD-SEARCH]")
542 (defvar isearch-string "") ; The current search string.
543 (defvar isearch-message "") ; text-char-description version of isearch-string
545 (defvar isearch-message-prefix-add nil) ; Additonal text for the message prefix
546 (defvar isearch-message-suffix-add nil) ; Additonal text for the message suffix
548 (defvar isearch-success t) ; Searching is currently successful.
549 (defvar isearch-error nil) ; Error message for failed search.
550 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
551 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
552 (defvar isearch-barrier 0
553 "Recorded minimum/maximal point for the current search.")
554 (defvar isearch-just-started nil)
555 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
557 ;; case-fold-search while searching.
558 ;; either nil, t, or 'yes. 'yes means the same as t except that mixed
559 ;; case in the search string is ignored.
560 (defvar isearch-case-fold-search nil)
562 (defvar isearch-last-case-fold-search nil)
564 ;; Used to save default value while isearch is active
565 (defvar isearch-original-minibuffer-message-timeout nil)
567 (defvar isearch-adjusted nil)
568 (defvar isearch-slow-terminal-mode nil)
569 ;; If t, using a small window.
570 (defvar isearch-small-window nil)
571 (defvar isearch-opoint 0)
572 ;; The window configuration active at the beginning of the search.
573 (defvar isearch-window-configuration nil)
575 ;; Flag to indicate a yank occurred, so don't move the cursor.
576 (defvar isearch-yank-flag nil)
578 ;; A function to be called after each input character is processed.
579 ;; (It is not called after characters that exit the search.)
580 ;; It is only set from an optional argument to `isearch-mode'.
581 (defvar isearch-op-fun nil)
583 ;; Is isearch-mode in a recursive edit for modal searching.
584 (defvar isearch-recursive-edit nil)
586 ;; Should isearch be terminated after doing one search?
587 (defvar isearch-nonincremental nil)
589 ;; New value of isearch-forward after isearch-edit-string.
590 (defvar isearch-new-forward nil)
592 ;; Accumulate here the overlays opened during searching.
593 (defvar isearch-opened-overlays nil)
595 ;; The value of input-method-function when isearch is invoked.
596 (defvar isearch-input-method-function nil)
598 ;; A flag to tell if input-method-function is locally bound when
599 ;; isearch is invoked.
600 (defvar isearch-input-method-local-p nil)
602 ;; Minor-mode-alist changes - kind of redundant with the
603 ;; echo area, but if isearching in multiple windows, it can be useful.
605 (or (assq 'isearch-mode minor-mode-alist)
606 (nconc minor-mode-alist
607 (list '(isearch-mode isearch-mode))))
609 (defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
610 (make-variable-buffer-local 'isearch-mode)
612 (define-key global-map "\C-s" 'isearch-forward)
613 (define-key esc-map "\C-s" 'isearch-forward-regexp)
614 (define-key global-map "\C-r" 'isearch-backward)
615 (define-key esc-map "\C-r" 'isearch-backward-regexp)
616 (define-key search-map "w" 'isearch-forward-word)
618 ;; Entry points to isearch-mode.
620 (defun isearch-forward (&optional regexp-p no-recursive-edit)
622 Do incremental search forward.
623 With a prefix argument, do an incremental regular expression search instead.
625 As you type characters, they add to the search string and are found.
626 The following non-printing keys are bound in `isearch-mode-map'.
628 Type \\[isearch-delete-char] to cancel last input item from end of search string.
629 Type \\[isearch-exit] to exit, leaving point at location found.
630 Type LFD (C-j) to match end of line.
631 Type \\[isearch-repeat-forward] to search again forward,\
632 \\[isearch-repeat-backward] to search again backward.
633 Type \\[isearch-yank-word-or-char] to yank next word or character in buffer
634 onto the end of the search string, and search for it.
635 Type \\[isearch-del-char] to delete character from end of search string.
636 Type \\[isearch-yank-char] to yank char from buffer onto end of search\
637 string and search for it.
638 Type \\[isearch-yank-line] to yank rest of line onto end of search string\
640 Type \\[isearch-yank-kill] to yank the last string of killed text.
641 Type \\[isearch-yank-pop] to replace string just yanked into search prompt
642 with string killed before it.
643 Type \\[isearch-quote-char] to quote control character to search for it.
644 \\[isearch-abort] while searching or when search has failed cancels input\
646 been found successfully.
647 \\[isearch-abort] when search is successful aborts and moves point to\
650 If you try to exit with the search string still empty, it invokes
651 nonincremental search.
653 Type \\[isearch-toggle-case-fold] to toggle search case-sensitivity.
654 Type \\[isearch-toggle-regexp] to toggle regular-expression mode.
655 Type \\[isearch-toggle-word] to toggle word mode.
656 Type \\[isearch-edit-string] to edit the search string in the minibuffer.
658 Also supported is a search ring of the previous 16 search strings.
659 Type \\[isearch-ring-advance] to search for the next item in the search ring.
660 Type \\[isearch-ring-retreat] to search for the previous item in the search\
662 Type \\[isearch-complete] to complete the search string using the search ring.
664 Type \\[isearch-query-replace] to run `query-replace' with string to\
665 replace from last search string.
666 Type \\[isearch-query-replace-regexp] to run `query-replace-regexp'\
667 with the last search string.
668 Type \\[isearch-occur] to run `occur' that shows\
669 the last search string.
670 Type \\[isearch-highlight-regexp] to run `highlight-regexp'\
671 that highlights the last search string.
673 Type \\[isearch-describe-bindings] to display all Isearch key bindings.
674 Type \\[isearch-describe-key] to display documentation of Isearch key.
675 Type \\[isearch-describe-mode] to display documentation of Isearch mode.
677 If an input method is turned on in the current buffer, that input
678 method is also active while you are typing characters to search.
679 To toggle the input method, type \\[isearch-toggle-input-method]. \
680 It also toggles the input
681 method in the current buffer.
683 To use a different input method for searching, type \
684 \\[isearch-toggle-specified-input-method],
685 and specify an input method you want to use.
687 The above keys, bound in `isearch-mode-map', are often controlled by
688 options; do \\[apropos] on search-.* to find them.
689 Other control and meta characters terminate the search
690 and are then executed normally (depending on `search-exit-option').
691 Likewise for function keys and mouse button events.
693 If this function is called non-interactively, it does not return to
694 the calling function until the search is done."
697 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
699 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
701 Do incremental search forward for regular expression.
702 With a prefix argument, do a regular string search instead.
703 Like ordinary incremental search except that your input is treated
704 as a regexp. See the command `isearch-forward' for more information.
706 In regexp incremental searches, a space or spaces normally matches
707 any whitespace (the variable `search-whitespace-regexp' controls
708 precisely what that means). If you want to search for a literal space
709 and nothing else, enter C-q SPC."
711 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
713 (defun isearch-forward-word (&optional not-word no-recursive-edit)
715 Do incremental search forward for a sequence of words.
716 With a prefix argument, do a regular string search instead.
717 Like ordinary incremental search except that your input is treated
718 as a sequence of words without regard to how the words are separated.
719 See the command `isearch-forward' for more information."
721 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
723 (defun isearch-backward (&optional regexp-p no-recursive-edit)
725 Do incremental search backward.
726 With a prefix argument, do a regular expression search instead.
727 See the command `isearch-forward' for more information."
729 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
731 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
733 Do incremental search backward for regular expression.
734 With a prefix argument, do a regular string search instead.
735 Like ordinary incremental search except that your input is treated
736 as a regexp. See the command `isearch-forward' for more information."
738 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
741 ;; isearch-mode only sets up incremental search for the minor mode.
742 ;; All the work is done by the isearch-mode commands.
745 ;;(defvar isearch-commands '(isearch-forward isearch-backward
746 ;; isearch-forward-regexp isearch-backward-regexp)
747 ;; "List of commands for which isearch-mode does not recursive-edit.")
750 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p)
751 "Start Isearch minor mode.
752 It is called by the function `isearch-forward' and other related functions."
754 ;; Initialize global vars.
755 (setq isearch-forward forward
756 isearch-regexp regexp
758 isearch-op-fun op-fun
759 isearch-last-case-fold-search isearch-case-fold-search
760 isearch-case-fold-search case-fold-search
766 isearch-barrier (point)
768 isearch-yank-flag nil
770 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
773 (abs search-slow-window-lines))))
774 isearch-other-end nil
775 isearch-small-window nil
776 isearch-just-started t
777 isearch-start-hscroll (window-hscroll)
779 isearch-opoint (point)
780 search-ring-yank-pointer nil
781 isearch-opened-overlays nil
782 isearch-input-method-function input-method-function
783 isearch-input-method-local-p (local-variable-p 'input-method-function)
784 regexp-search-ring-yank-pointer nil
786 ;; Save the original value of `minibuffer-message-timeout', and
787 ;; set it to nil so that isearch's messages don't get timed out.
788 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
789 minibuffer-message-timeout nil)
791 ;; We must bypass input method while reading key. When a user type
792 ;; printable character, appropriate input method is turned on in
793 ;; minibuffer to read multibyte characters.
794 (or isearch-input-method-local-p
795 (make-local-variable 'input-method-function))
796 (setq input-method-function nil)
799 (setq isearch-window-configuration
800 (if isearch-slow-terminal-mode (current-window-configuration) nil))
802 ;; Maybe make minibuffer frame visible and/or raise it.
803 (let ((frame (window-frame (minibuffer-window))))
804 (unless (memq (frame-live-p frame) '(nil t))
805 (unless (frame-visible-p frame)
806 (make-frame-visible frame))
807 (if minibuffer-auto-raise
808 (raise-frame frame))))
810 (setq isearch-mode " Isearch") ;; forward? regexp?
811 (force-mode-line-update)
813 (setq overriding-terminal-local-map isearch-mode-map)
814 (run-hooks 'isearch-mode-hook)
816 ;; Pushing the initial state used to be before running isearch-mode-hook,
817 ;; but a hook might set `isearch-push-state-function' used in
818 ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994)
823 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
824 (add-hook 'kbd-macro-termination-hook 'isearch-done)
826 ;; isearch-mode can be made modal (in the sense of not returning to
827 ;; the calling function until searching is completed) by entering
828 ;; a recursive-edit and exiting it when done isearching.
830 (let ((isearch-recursive-edit t))
835 ;; Some high level utilities. Others below.
837 (defun isearch-update ()
838 ;; Called after each command to update the display.
839 (if (and (null unread-command-events)
840 (null executing-kbd-macro))
842 (if (not (input-pending-p))
843 (if isearch-message-function
844 (funcall isearch-message-function)
846 (if (and isearch-slow-terminal-mode
847 (not (or isearch-small-window
848 (pos-visible-in-window-p))))
849 (let ((found-point (point)))
850 (setq isearch-small-window t)
851 (move-to-window-line 0)
852 (let ((window-min-height 1))
853 (split-window nil (if (< search-slow-window-lines 0)
854 (1+ (- search-slow-window-lines))
856 (1+ search-slow-window-lines)))))
857 (if (< search-slow-window-lines 0)
858 (progn (vertical-motion (- 1 search-slow-window-lines))
859 (set-window-start (next-window) (point))
860 (set-window-hscroll (next-window)
862 (set-window-hscroll (selected-window) 0))
864 (goto-char found-point))
865 ;; Keep same hscrolling as at the start of the search when possible
866 (let ((current-scroll (window-hscroll)))
867 (set-window-hscroll (selected-window) isearch-start-hscroll)
868 (unless (pos-visible-in-window-p)
869 (set-window-hscroll (selected-window) current-scroll))))
870 (if isearch-other-end
871 (if (< isearch-other-end (point)) ; isearch-forward?
872 (isearch-highlight isearch-other-end (point))
873 (isearch-highlight (point) isearch-other-end))
874 (isearch-dehighlight))
876 (setq ;; quit-flag nil not for isearch-mode
878 isearch-yank-flag nil)
879 (when isearch-lazy-highlight
880 (isearch-lazy-highlight-new-loop))
881 ;; We must prevent the point moving to the end of composition when a
882 ;; part of the composition has just been searched.
883 (setq disable-point-adjustment t)
884 (run-hooks 'isearch-update-post-hook))
886 (defun isearch-done (&optional nopush edit)
888 For successful search, pass no args.
889 For a failing search, NOPUSH is t.
890 For going to the minibuffer to edit the search string,
891 NOPUSH is t and EDIT is t."
893 (if isearch-resume-in-command-history
894 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
895 ,isearch-word ,isearch-forward
897 ',isearch-case-fold-search)))
898 (unless (equal (car command-history) command)
899 (setq command-history (cons command command-history)))))
901 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
902 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
903 (setq isearch-lazy-highlight-start nil)
905 ;; Called by all commands that terminate isearch-mode.
906 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
907 (setq overriding-terminal-local-map nil)
908 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
909 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
910 (isearch-dehighlight)
911 (lazy-highlight-cleanup lazy-highlight-cleanup)
912 (let ((found-start (window-start (selected-window)))
913 (found-point (point)))
914 (when isearch-window-configuration
915 (set-window-configuration isearch-window-configuration)
916 (if isearch-small-window
917 (goto-char found-point)
918 ;; set-window-configuration clobbers window-start; restore it.
919 ;; This has an annoying side effect of clearing the last_modiff
920 ;; field of the window, which can cause unwanted scrolling,
921 ;; so don't do it unless truly necessary.
922 (set-window-start (selected-window) found-start t))))
924 (setq isearch-mode nil)
925 (if isearch-input-method-local-p
926 (setq input-method-function isearch-input-method-function)
927 (kill-local-variable 'input-method-function))
929 (force-mode-line-update)
931 ;; If we ended in the middle of some intangible text,
932 ;; move to the further end of that intangible text.
933 (let ((after (if (eobp) nil
934 (get-text-property (point) 'intangible)))
935 (before (if (bobp) nil
936 (get-text-property (1- (point)) 'intangible))))
937 (when (and before after (eq before after))
939 (goto-char (next-single-property-change (point) 'intangible))
940 (goto-char (previous-single-property-change (point) 'intangible)))))
942 (if (and (> (length isearch-string) 0) (not nopush))
943 ;; Update the ring data.
944 (isearch-update-ring isearch-string isearch-regexp))
946 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
947 (run-hooks 'isearch-mode-end-hook))
949 ;; If there was movement, mark the starting position.
950 ;; Maybe should test difference between and set mark only if > threshold.
951 (if (/= (point) isearch-opoint)
952 (or (and transient-mark-mode mark-active)
954 (push-mark isearch-opoint t)
955 (or executing-kbd-macro (> (minibuffer-depth) 0) edit
956 (message "Mark saved where search started")))))
958 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
960 (defun isearch-update-ring (string &optional regexp)
961 "Add STRING to the beginning of the search ring.
962 REGEXP if non-nil says use the regexp search ring."
964 (if regexp 'regexp-search-ring 'search-ring)
966 (if regexp regexp-search-ring-max search-ring-max)))
968 ;; Switching buffers should first terminate isearch-mode.
969 ;; ;; For Emacs 19, the frame switch event is handled.
970 ;; (defun isearch-switch-frame-handler ()
971 ;; (interactive) ;; Is this necessary?
972 ;; ;; First terminate isearch-mode.
974 ;; (isearch-clean-overlays)
975 ;; (handle-switch-frame (car (cdr last-command-event))))
978 ;; The search status structure and stack.
980 (defsubst isearch-string-state (frame)
981 "Return the search string in FRAME."
983 (defsubst isearch-message-state (frame)
984 "Return the search string to display to the user in FRAME."
986 (defsubst isearch-point-state (frame)
987 "Return the point in FRAME."
989 (defsubst isearch-success-state (frame)
990 "Return the success flag in FRAME."
992 (defsubst isearch-forward-state (frame)
993 "Return the searching-forward flag in FRAME."
995 (defsubst isearch-other-end-state (frame)
996 "Return the other end of the match in FRAME."
998 (defsubst isearch-word-state (frame)
999 "Return the search-by-word flag in FRAME."
1001 (defsubst isearch-error-state (frame)
1002 "Return the regexp error message in FRAME, or nil if its regexp is valid."
1004 (defsubst isearch-wrapped-state (frame)
1005 "Return the search-wrapped flag in FRAME."
1007 (defsubst isearch-barrier-state (frame)
1008 "Return the barrier value in FRAME."
1010 (defsubst isearch-case-fold-search-state (frame)
1011 "Return the case-folding flag in FRAME."
1013 (defsubst isearch-pop-fun-state (frame)
1014 "Return the function restoring the mode-specific Isearch state in FRAME."
1017 (defun isearch-top-state ()
1018 (let ((cmd (car isearch-cmds)))
1019 (setq isearch-string (isearch-string-state cmd)
1020 isearch-message (isearch-message-state cmd)
1021 isearch-success (isearch-success-state cmd)
1022 isearch-forward (isearch-forward-state cmd)
1023 isearch-other-end (isearch-other-end-state cmd)
1024 isearch-word (isearch-word-state cmd)
1025 isearch-error (isearch-error-state cmd)
1026 isearch-wrapped (isearch-wrapped-state cmd)
1027 isearch-barrier (isearch-barrier-state cmd)
1028 isearch-case-fold-search (isearch-case-fold-search-state cmd))
1029 (if (functionp (isearch-pop-fun-state cmd))
1030 (funcall (isearch-pop-fun-state cmd) cmd))
1031 (goto-char (isearch-point-state cmd))))
1033 (defun isearch-pop-state ()
1034 (setq isearch-cmds (cdr isearch-cmds))
1035 (isearch-top-state))
1037 (defun isearch-push-state ()
1039 (cons (vector isearch-string isearch-message (point)
1040 isearch-success isearch-forward isearch-other-end
1042 isearch-error isearch-wrapped isearch-barrier
1043 isearch-case-fold-search
1044 (if isearch-push-state-function
1045 (funcall isearch-push-state-function)))
1049 ;; Commands active while inside of the isearch minor mode.
1051 (defun isearch-exit ()
1052 "Exit search normally.
1053 However, if this is the first command after starting incremental
1054 search and `search-nonincremental-instead' is non-nil, do a
1055 nonincremental search instead via `isearch-edit-string'."
1057 (if (and search-nonincremental-instead
1058 (= 0 (length isearch-string)))
1059 (let ((isearch-nonincremental t))
1060 (isearch-edit-string)))
1062 (isearch-clean-overlays))
1064 (defvar minibuffer-history-symbol) ;; from external package gmhist.el
1066 (defun isearch-fail-pos ()
1067 "Position of first mismatch in search string, or its length if none."
1068 (let ((cmds isearch-cmds))
1069 (if (and isearch-success (not isearch-error))
1070 (length isearch-message)
1071 (while (or (not (isearch-success-state (car cmds)))
1072 (isearch-error-state (car cmds)))
1074 (let ((succ-msg (and cmds (isearch-message-state (car cmds)))))
1075 (if (and (stringp succ-msg)
1076 (< (length succ-msg) (length isearch-message))
1078 (substring isearch-message 0 (length succ-msg))))
1082 (defun isearch-edit-string ()
1083 "Edit the search string in the minibuffer.
1084 The following additional command keys are active while editing.
1085 \\<minibuffer-local-isearch-map>
1086 \\[exit-minibuffer] to resume incremental searching with the edited string.
1087 \\[isearch-nonincremental-exit-minibuffer] to do one nonincremental search.
1088 \\[isearch-forward-exit-minibuffer] to resume isearching forward.
1089 \\[isearch-reverse-exit-minibuffer] to resume isearching backward.
1090 \\[isearch-complete-edit] to complete the search string using the search ring.
1091 \\<isearch-mode-map>
1092 If first char entered is \\[isearch-yank-word-or-char], then do word search instead."
1094 ;; This code is very hairy for several reasons, explained in the code.
1095 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1096 ;; If there were a way to catch any change of buffer from the minibuffer,
1097 ;; this could be simplified greatly.
1098 ;; Editing doesn't back up the search point. Should it?
1102 (let ((isearch-nonincremental isearch-nonincremental)
1104 ;; Locally bind all isearch global variables to protect them
1105 ;; from recursive isearching.
1106 ;; isearch-string -message and -forward are not bound
1107 ;; so they may be changed. Instead, save the values.
1108 (isearch-new-string isearch-string)
1109 (isearch-new-message isearch-message)
1110 (isearch-new-forward isearch-forward)
1111 (isearch-new-word isearch-word)
1113 (isearch-regexp isearch-regexp)
1114 (isearch-op-fun isearch-op-fun)
1115 (isearch-cmds isearch-cmds)
1116 (isearch-success isearch-success)
1117 (isearch-wrapped isearch-wrapped)
1118 (isearch-barrier isearch-barrier)
1119 (isearch-adjusted isearch-adjusted)
1120 (isearch-yank-flag isearch-yank-flag)
1121 (isearch-error isearch-error)
1122 ;;; Don't bind this. We want isearch-search, below, to set it.
1123 ;;; And the old value won't matter after that.
1124 ;;; (isearch-other-end isearch-other-end)
1125 ;;; Perhaps some of these other variables should be bound for a
1126 ;;; shorter period, ending before the next isearch-search.
1127 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1128 (isearch-opoint isearch-opoint)
1129 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1130 (isearch-small-window isearch-small-window)
1131 (isearch-recursive-edit isearch-recursive-edit)
1132 ;; Save current configuration so we can restore it here.
1133 (isearch-window-configuration (current-window-configuration))
1135 ;; This could protect the index of the search rings,
1136 ;; but we can't reliably count the number of typed M-p
1137 ;; in `read-from-minibuffer' to adjust the index accordingly.
1138 ;; So when the following is commented out, `isearch-mode'
1139 ;; below resets the index to the predictable value nil.
1140 ;; (search-ring-yank-pointer search-ring-yank-pointer)
1141 ;; (regexp-search-ring-yank-pointer regexp-search-ring-yank-pointer)
1143 ;; Temporarily restore `minibuffer-message-timeout'.
1144 (minibuffer-message-timeout
1145 isearch-original-minibuffer-message-timeout)
1146 (isearch-original-minibuffer-message-timeout
1147 isearch-original-minibuffer-message-timeout)
1148 old-point old-other-end)
1150 ;; Actually terminate isearching until editing is done.
1151 ;; This is so that the user can do anything without failure,
1152 ;; like switch buffers and start another isearch, and return.
1155 (exit nil)) ; was recursive editing
1157 ;; Save old point and isearch-other-end before reading from minibuffer
1158 ;; that can change their values.
1159 (setq old-point (point) old-other-end isearch-other-end)
1162 (let* ((message-log-max nil)
1163 ;; Protect global value of search rings from updating
1164 ;; by `read-from-minibuffer'. It should be updated only
1165 ;; by `isearch-update-ring' in `isearch-done', not here.
1166 (search-ring search-ring)
1167 (regexp-search-ring regexp-search-ring)
1168 ;; Binding minibuffer-history-symbol to nil is a work-around
1169 ;; for some incompatibility with gmhist.
1170 (minibuffer-history-symbol))
1171 (setq isearch-new-string
1172 (read-from-minibuffer
1173 (isearch-message-prefix nil nil isearch-nonincremental)
1174 (cons isearch-string (1+ (isearch-fail-pos)))
1175 minibuffer-local-isearch-map nil
1177 (cons 'regexp-search-ring
1178 (1+ (or regexp-search-ring-yank-pointer -1)))
1180 (1+ (or search-ring-yank-pointer -1))))
1183 (mapconcat 'isearch-text-char-description
1184 isearch-new-string "")))
1186 ;; Set point at the start (end) of old match if forward (backward),
1187 ;; so after exiting minibuffer isearch resumes at the start (end)
1188 ;; of this match and can find it again.
1189 (if (and old-other-end (eq old-point (point))
1190 (eq isearch-forward isearch-new-forward))
1191 (goto-char old-other-end))
1193 ;; Always resume isearching by restarting it.
1194 (isearch-mode isearch-forward
1200 ;; Copy new local values to isearch globals
1201 (setq isearch-string isearch-new-string
1202 isearch-message isearch-new-message
1203 isearch-forward isearch-new-forward
1204 isearch-word isearch-new-word))
1206 ;; Empty isearch-string means use default.
1207 (when (= 0 (length isearch-string))
1208 (setq isearch-string (or (car (if isearch-regexp
1214 (mapconcat 'isearch-text-char-description
1216 ;; After taking the last element, adjust ring to previous one.
1217 (isearch-ring-adjust1 nil)))
1219 ;; This used to push the state as of before this C-s, but it adds
1220 ;; an inconsistent state where part of variables are from the
1221 ;; previous search (e.g. `isearch-success'), and part of variables
1222 ;; are just entered from the minibuffer (e.g. `isearch-string').
1223 ;; (isearch-push-state)
1225 ;; Reinvoke the pending search.
1227 (isearch-push-state) ; this pushes the correct state
1229 (if isearch-nonincremental
1231 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1233 ;; The search done message is confusing when the string
1234 ;; is empty, so erase it.
1235 (if (equal isearch-string "")
1238 (quit ; handle abort-recursive-edit
1239 (isearch-abort) ;; outside of let to restore outside global values
1242 (defun isearch-nonincremental-exit-minibuffer ()
1244 (setq isearch-nonincremental t)
1247 (defun isearch-forward-exit-minibuffer ()
1249 (setq isearch-new-forward t)
1252 (defun isearch-reverse-exit-minibuffer ()
1254 (setq isearch-new-forward nil)
1257 (defun isearch-cancel ()
1258 "Terminate the search and go back to the starting point."
1260 (if (and isearch-push-state-function isearch-cmds)
1261 ;; For defined push-state function, restore the first state.
1262 ;; This calls pop-state function and restores original point.
1263 (let ((isearch-cmds (last isearch-cmds)))
1264 (isearch-top-state))
1265 (goto-char isearch-opoint))
1266 (isearch-done t) ; exit isearch
1267 (isearch-clean-overlays)
1268 (signal 'quit nil)) ; and pass on quit signal
1270 (defun isearch-abort ()
1271 "Abort incremental search mode if searching is successful, signaling quit.
1272 Otherwise, revert to previous successful search and continue searching.
1273 Use `isearch-exit' to quit without signaling."
1275 ;; (ding) signal instead below, if quitting
1277 (if (and isearch-success (not isearch-error))
1278 ;; If search is successful and has no incomplete regexp,
1279 ;; move back to starting point and really do quit.
1281 (setq isearch-success nil)
1283 ;; If search is failing, or has an incomplete regexp,
1284 ;; rub out until it is once more successful.
1285 (while (or (not isearch-success) isearch-error)
1286 (isearch-pop-state))
1289 (defun isearch-repeat (direction)
1290 ;; Utility for isearch-repeat-forward and -backward.
1291 (if (eq isearch-forward (eq direction 'forward))
1292 ;; C-s in forward or C-r in reverse.
1293 (if (equal isearch-string "")
1294 ;; If search string is empty, use last one.
1295 (if (null (if isearch-regexp regexp-search-ring search-ring))
1296 (setq isearch-error "No previous search string")
1297 (setq isearch-string
1299 (car regexp-search-ring)
1302 (mapconcat 'isearch-text-char-description
1304 isearch-case-fold-search isearch-last-case-fold-search)
1305 ;; After taking the last element, adjust ring to previous one.
1306 (isearch-ring-adjust1 nil))
1307 ;; If already have what to search for, repeat it.
1310 ;; Set isearch-wrapped before calling isearch-wrap-function
1311 (setq isearch-wrapped t)
1312 (if isearch-wrap-function
1313 (funcall isearch-wrap-function)
1314 (goto-char (if isearch-forward (point-min) (point-max)))))))
1315 ;; C-s in reverse or C-r in forward, change direction.
1316 (setq isearch-forward (not isearch-forward)
1319 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1321 (if (equal isearch-string "")
1322 (setq isearch-success t)
1323 (if (and isearch-success
1324 (equal (point) isearch-other-end)
1325 (not isearch-just-started))
1326 ;; If repeating a search that found
1327 ;; an empty string, ensure we advance.
1328 (if (if isearch-forward (eobp) (bobp))
1329 ;; If there's nowhere to advance to, fail (and wrap next time).
1331 (setq isearch-success nil)
1333 (forward-char (if isearch-forward 1 -1))
1337 (isearch-push-state)
1340 (defun isearch-repeat-forward ()
1341 "Repeat incremental search forwards."
1343 (isearch-repeat 'forward))
1345 (defun isearch-repeat-backward ()
1346 "Repeat incremental search backwards."
1348 (isearch-repeat 'backward))
1350 (defun isearch-toggle-regexp ()
1351 "Toggle regexp searching on or off."
1352 ;; The status stack is left unchanged.
1354 (setq isearch-regexp (not isearch-regexp))
1355 (if isearch-regexp (setq isearch-word nil))
1356 (setq isearch-success t isearch-adjusted t)
1359 (defun isearch-toggle-word ()
1360 "Toggle word searching on or off."
1362 (setq isearch-word (not isearch-word))
1363 (setq isearch-success t isearch-adjusted t)
1366 (defun isearch-toggle-case-fold ()
1367 "Toggle case folding in searching on or off."
1369 (setq isearch-case-fold-search
1370 (if isearch-case-fold-search nil 'yes))
1371 (let ((message-log-max nil))
1372 (message "%s%s [case %ssensitive]"
1373 (isearch-message-prefix nil nil isearch-nonincremental)
1375 (if isearch-case-fold-search "in" "")))
1376 (setq isearch-success t isearch-adjusted t)
1380 (defun isearch-query-replace (&optional delimited regexp-flag)
1381 "Start `query-replace' with string to replace from last search string.
1382 The arg DELIMITED (prefix arg if interactive), if non-nil, means replace
1383 only matches surrounded by word boundaries. Note that using the prefix arg
1384 is possible only when `isearch-allow-scroll' is non-nil, and it don't
1385 always provides the correct matches for `query-replace', so the preferred
1386 way to run word replacements from Isearch is `M-s w ... M-%'."
1388 (list current-prefix-arg))
1389 (barf-if-buffer-read-only)
1390 (if regexp-flag (setq isearch-regexp t))
1391 (let ((case-fold-search isearch-case-fold-search)
1392 ;; set `search-upper-case' to nil to not call
1393 ;; `isearch-no-upper-case-p' in `perform-replace'
1394 (search-upper-case nil)
1395 ;; Set `isearch-recursive-edit' to nil to prevent calling
1396 ;; `exit-recursive-edit' in `isearch-done' that terminates
1397 ;; the execution of this command when it is non-nil.
1398 ;; We call `exit-recursive-edit' explicitly at the end below.
1399 (isearch-recursive-edit nil))
1400 (isearch-done nil t)
1401 (isearch-clean-overlays)
1402 (if (and isearch-other-end
1403 (< isearch-other-end (point))
1404 (not (and transient-mark-mode mark-active
1405 (< (mark) (point)))))
1406 (goto-char isearch-other-end))
1407 (set query-replace-from-history-variable
1408 (cons isearch-string
1409 (symbol-value query-replace-from-history-variable)))
1412 (query-replace-read-to
1414 (concat "Query replace"
1415 (if (or delimited isearch-word) " word" "")
1416 (if isearch-regexp " regexp" "")
1417 (if (and transient-mark-mode mark-active) " in region" ""))
1419 t isearch-regexp (or delimited isearch-word) nil nil
1420 (if (and transient-mark-mode mark-active) (region-beginning))
1421 (if (and transient-mark-mode mark-active) (region-end))))
1422 (and isearch-recursive-edit (exit-recursive-edit)))
1424 (defun isearch-query-replace-regexp (&optional delimited)
1425 "Start `query-replace-regexp' with string to replace from last search string.
1426 See `isearch-query-replace' for more information."
1428 (list current-prefix-arg))
1429 (isearch-query-replace delimited t))
1431 (defun isearch-occur (regexp &optional nlines)
1432 "Run `occur' with regexp to search from the current search string.
1433 Interactively, REGEXP is the current search regexp or a quoted search
1434 string. NLINES has the same meaning as in `occur'."
1438 (isearch-word (concat "\\b" (replace-regexp-in-string
1440 (replace-regexp-in-string
1441 "^\\W+\\|\\W+$" "" isearch-string)
1444 (isearch-regexp isearch-string)
1445 (t (regexp-quote isearch-string)))
1446 (if current-prefix-arg (prefix-numeric-value current-prefix-arg))))
1447 (let ((case-fold-search isearch-case-fold-search)
1448 ;; Set `search-upper-case' to nil to not call
1449 ;; `isearch-no-upper-case-p' in `occur-1'.
1450 (search-upper-case nil)
1451 (search-spaces-regexp search-whitespace-regexp))
1452 (occur regexp nlines)))
1454 (declare-function hi-lock-read-face-name "hi-lock" ())
1456 (defun isearch-highlight-regexp ()
1457 "Run `highlight-regexp' with regexp from the current search string.
1458 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1459 argument from the last search regexp or a quoted search string,
1460 and reads its face argument using `hi-lock-read-face-name'."
1463 ;; Set `isearch-recursive-edit' to nil to prevent calling
1464 ;; `exit-recursive-edit' in `isearch-done' that terminates
1465 ;; the execution of this command when it is non-nil.
1466 ;; We call `exit-recursive-edit' explicitly at the end below.
1467 (isearch-recursive-edit nil))
1468 (isearch-done nil t)
1469 (isearch-clean-overlays))
1470 (require 'hi-lock nil t)
1471 (let ((string (cond (isearch-regexp isearch-string)
1472 ((if (and (eq isearch-case-fold-search t)
1474 (isearch-no-upper-case-p
1475 isearch-string isearch-regexp)
1476 isearch-case-fold-search)
1477 ;; Turn isearch-string into a case-insensitive
1481 (let ((s (string c)))
1482 (if (string-match "[[:alpha:]]" s)
1483 (format "[%s%s]" (upcase s) (downcase s))
1486 (t (regexp-quote isearch-string)))))
1487 (hi-lock-face-buffer string (hi-lock-read-face-name)))
1488 (and isearch-recursive-edit (exit-recursive-edit)))
1491 (defun isearch-delete-char ()
1492 "Discard last input item and move point back.
1493 If no previous match was done, just beep."
1495 (if (null (cdr isearch-cmds))
1497 (isearch-pop-state))
1500 (defun isearch-del-char (&optional arg)
1501 "Delete character from end of search string and search again.
1502 If search string is empty, just beep."
1504 (if (= 0 (length isearch-string))
1506 (setq isearch-string (substring isearch-string 0 (- (or arg 1)))
1507 isearch-message (mapconcat 'isearch-text-char-description
1508 isearch-string "")))
1509 ;; Use the isearch-other-end as new starting point to be able
1510 ;; to find the remaining part of the search string again.
1511 (if isearch-other-end (goto-char isearch-other-end))
1513 (isearch-push-state)
1516 (defun isearch-yank-string (string)
1517 "Pull STRING into search string."
1518 ;; Downcase the string if not supposed to case-fold yanked strings.
1519 (if (and isearch-case-fold-search
1520 (eq 'not-yanks search-upper-case))
1521 (setq string (downcase string)))
1522 (if isearch-regexp (setq string (regexp-quote string)))
1523 ;; Don't move cursor in reverse search.
1524 (setq isearch-yank-flag t)
1525 (isearch-process-search-string
1526 string (mapconcat 'isearch-text-char-description string "")))
1528 (defun isearch-yank-kill ()
1529 "Pull string from kill ring into search string."
1531 (isearch-yank-string (current-kill 0)))
1533 (defun isearch-yank-pop ()
1534 "Replace just-yanked search string with previously killed string."
1536 (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop)))
1537 ;; Fall back on `isearch-yank-kill' for the benefits of people
1538 ;; who are used to the old behavior of `M-y' in isearch mode. In
1539 ;; future, this fallback may be changed if we ever change
1540 ;; `yank-pop' to do something like the kill-ring-browser.
1543 (isearch-yank-string (current-kill 1))))
1545 (defun isearch-yank-x-selection ()
1546 "Pull current X selection into search string."
1548 (isearch-yank-string (x-get-selection)))
1551 (defun isearch-mouse-2 (click)
1552 "Handle mouse-2 in Isearch mode.
1553 For a click in the echo area, invoke `isearch-yank-x-selection'.
1554 Otherwise invoke whatever the calling mouse-2 command sequence
1555 is bound to outside of Isearch."
1557 (let* ((w (posn-window (event-start click)))
1558 (overriding-terminal-local-map nil)
1559 (binding (key-binding (this-command-keys-vector) t)))
1560 (if (and (window-minibuffer-p w)
1561 (not (minibuffer-window-active-p w))) ; in echo area
1562 (isearch-yank-x-selection)
1563 (when (functionp binding)
1564 (call-interactively binding)))))
1566 (defun isearch-yank-internal (jumpform)
1567 "Pull the text from point to the point reached by JUMPFORM.
1568 JUMPFORM is a lambda expression that takes no arguments and returns
1569 a buffer position, possibly having moved point to that position.
1570 For example, it might move point forward by a word and return point,
1571 or it might return the position of the end of the line."
1572 (isearch-yank-string
1574 (and (not isearch-forward) isearch-other-end
1575 (goto-char isearch-other-end))
1576 (buffer-substring-no-properties (point) (funcall jumpform)))))
1578 (defun isearch-yank-char-in-minibuffer (&optional arg)
1579 "Pull next character from buffer into end of search string in minibuffer."
1583 (with-current-buffer (cadr (buffer-list))
1584 (buffer-substring-no-properties
1585 (point) (progn (forward-char arg) (point)))))
1586 (forward-char arg)))
1588 (defun isearch-yank-char (&optional arg)
1589 "Pull next character from buffer into search string."
1591 (isearch-yank-internal (lambda () (forward-char arg) (point))))
1593 (declare-function subword-forward "subword" (&optional arg))
1594 (defun isearch-yank-word-or-char ()
1595 "Pull next character, subword or word from buffer into search string.
1596 Subword is used when `subword-mode' is activated. "
1598 (isearch-yank-internal
1600 (if (or (= (char-syntax (or (char-after) 0)) ?w)
1601 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
1602 (if (and (boundp 'subword-mode) subword-mode)
1605 (forward-char 1)) (point))))
1607 (defun isearch-yank-word ()
1608 "Pull next word from buffer into search string."
1610 (isearch-yank-internal (lambda () (forward-word 1) (point))))
1612 (defun isearch-yank-line ()
1613 "Pull rest of line from buffer into search string."
1615 (isearch-yank-internal
1616 (lambda () (let ((inhibit-field-text-motion t))
1617 (line-end-position (if (eolp) 2 1))))))
1619 (defun isearch-search-and-update ()
1620 ;; Do the search and update the display.
1621 (when (or isearch-success
1622 ;; Unsuccessful regexp search may become successful by
1623 ;; addition of characters which make isearch-string valid
1625 ;; If the string was found but was completely invisible,
1626 ;; it might now be partly visible, so try again.
1627 (prog1 isearch-hidden (setq isearch-hidden nil)))
1628 ;; In reverse search, adding stuff at
1629 ;; the end may cause zero or many more chars to be
1630 ;; matched, in the string following point.
1631 ;; Allow all those possibilities without moving point as
1632 ;; long as the match does not extend past search origin.
1633 (if (and (not isearch-forward) (not isearch-adjusted)
1635 (let ((case-fold-search isearch-case-fold-search))
1636 (if (and (eq case-fold-search t) search-upper-case)
1637 (setq case-fold-search
1638 (isearch-no-upper-case-p isearch-string isearch-regexp)))
1639 (looking-at (if isearch-regexp isearch-string
1640 (regexp-quote isearch-string))))
1642 (or isearch-yank-flag
1644 (min isearch-opoint isearch-barrier))))
1646 (setq isearch-success t
1648 isearch-other-end (match-end 0))
1649 (if (and (eq isearch-case-fold-search t) search-upper-case)
1650 (setq isearch-case-fold-search
1651 (isearch-no-upper-case-p isearch-string isearch-regexp))))
1652 ;; Not regexp, not reverse, or no match at point.
1653 (if (and isearch-other-end (not isearch-adjusted))
1654 (goto-char (if isearch-forward isearch-other-end
1657 (1+ isearch-other-end)))))
1660 (isearch-push-state)
1661 (if isearch-op-fun (funcall isearch-op-fun))
1665 ;; *, ?, }, and | chars can make a regexp more liberal.
1666 ;; They can make a regexp match sooner or make it succeed instead of failing.
1667 ;; So go back to place last successful search started
1668 ;; or to the last ^S/^R (barrier), whichever is nearer.
1669 ;; + needs no special handling because the string must match at least once.
1671 (defun isearch-backslash (str)
1672 "Return t if STR ends in an odd number of backslashes."
1673 (= (mod (- (length str) (string-match "\\\\*\\'" str)) 2) 1))
1675 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
1676 "Return point to previous successful match to allow regexp liberalization.
1677 \\<isearch-mode-map>
1678 Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by \
1679 stopping at `isearch-barrier' as needed.
1681 Do nothing if a backslash is escaping the liberalizing character.
1682 If WANT-BACKSLASH is non-nil, invert this behavior (for \\} and \\|).
1684 Do nothing if regexp has recently been invalid unless optional
1685 ALLOW-INVALID non-nil.
1687 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
1689 ;; (eq (not a) (not b)) makes all non-nil values equivalent
1690 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
1691 (not want-backslash))
1692 ;; We have to check 2 stack frames because the last might be
1693 ;; invalid just because of a backslash.
1694 (or (not isearch-error)
1695 (not (isearch-error-state (cadr isearch-cmds)))
1698 (progn (goto-char isearch-barrier)
1699 (setq isearch-adjusted t))
1700 (let* ((stack isearch-cmds)
1701 (previous (cdr stack)) ; lookbelow in the stack
1702 (frame (car stack)))
1703 ;; Walk down the stack looking for a valid regexp (as of course only
1704 ;; they can be the previous successful match); this conveniently
1705 ;; removes all bracket-sets and groups that might be in the way, as
1706 ;; well as partial \{\} constructs that the code below leaves behind.
1707 ;; Also skip over postfix operators -- though horrid,
1708 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
1709 (while (and previous
1710 (or (isearch-error-state frame)
1711 (let* ((string (isearch-string-state frame))
1712 (lchar (aref string (1- (length string)))))
1713 ;; The operators aren't always operators; check
1714 ;; backslashes. This doesn't handle the case of
1715 ;; operators at the beginning of the regexp not
1716 ;; being special, but then we should fall back to
1717 ;; the barrier anyway because it's all optional.
1718 (if (isearch-backslash
1719 (isearch-string-state (car previous)))
1721 (memq lchar '(?* ?? ?+))))))
1722 (setq stack previous previous (cdr previous) frame (car stack)))
1724 ;; `stack' now refers the most recent valid regexp that is not at
1725 ;; all optional in its last term. Now dig one level deeper and find
1726 ;; what matched before that.
1727 (let ((last-other-end
1728 (or (and (car previous)
1729 (isearch-other-end-state (car previous)))
1731 (goto-char (if isearch-forward
1732 (max last-other-end isearch-barrier)
1733 (min last-other-end isearch-barrier)))
1734 (setq isearch-adjusted t)))))))
1736 (defun isearch-unread-key-sequence (keylist)
1737 "Unread the given key-sequence KEYLIST.
1738 Scroll-bar or mode-line events are processed appropriately."
1739 (cancel-kbd-macro-events)
1740 (apply 'isearch-unread keylist)
1741 ;; If the event was a scroll-bar or mode-line click, the event will have
1742 ;; been prefixed by a symbol such as vertical-scroll-bar. We must remove
1743 ;; it here, because this symbol will be attached to the event again next
1744 ;; time it gets read by read-key-sequence.
1746 ;; (Old comment from isearch-other-meta-char: "Note that we don't have to
1747 ;; modify the event anymore in 21 because read_key_sequence no longer
1748 ;; modifies events to produce fake prefix keys.")
1749 (if (and (> (length keylist) 1)
1750 (symbolp (car keylist))
1751 (listp (cadr keylist))
1752 (not (numberp (posn-point
1753 (event-start (cadr keylist) )))))
1754 (pop unread-command-events)))
1756 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1757 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
1759 ;; The idea here is that certain vertical scrolling commands (like C-l
1760 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
1761 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
1762 ;; tamper with isearch's state, or move point. It is unacceptable for the
1763 ;; search string to be scrolled out of the current window. If a command
1764 ;; attempts this, we scroll the text back again.
1766 ;; We implement this feature with a property called `isearch-scroll'.
1767 ;; If a command's symbol has the value t for this property or for the
1768 ;; `scroll-command' property, it is a scrolling command. The feature
1769 ;; needs to be enabled by setting the customizable variable
1770 ;; `isearch-allow-scroll' to a non-nil value.
1772 ;; The universal argument commands (e.g. C-u) in simple.el are marked
1773 ;; as scrolling commands, and isearch.el has been amended to allow
1774 ;; prefix arguments to be passed through to scrolling commands. Thus
1775 ;; M-0 C-l will scroll point to the top of the window.
1777 ;; Horizontal scrolling commands are currently not catered for.
1778 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1780 ;; Set the isearch-scroll property on some standard functions:
1781 ;; Scroll-bar functions:
1782 (if (fboundp 'scroll-bar-toolkit-scroll)
1783 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
1784 (if (fboundp 'w32-handle-scroll-bar-event)
1785 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
1787 ;; Commands which scroll the window (some scroll commands
1788 ;; already have the `scroll-command' property on them):
1789 (put 'recenter 'isearch-scroll t)
1790 (put 'recenter-top-bottom 'isearch-scroll t)
1791 (put 'reposition-window 'isearch-scroll t)
1793 ;; Commands which act on the other window
1794 (put 'list-buffers 'isearch-scroll t)
1795 (put 'scroll-other-window 'isearch-scroll t)
1796 (put 'scroll-other-window-down 'isearch-scroll t)
1797 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
1798 (put 'end-of-buffer-other-window 'isearch-scroll t)
1800 ;; Commands which change the window layout
1801 (put 'delete-other-windows 'isearch-scroll t)
1802 (put 'balance-windows 'isearch-scroll t)
1803 (put 'split-window-vertically 'isearch-scroll t)
1804 (put 'split-window-horizontally 'isearch-scroll t)
1805 (put 'enlarge-window 'isearch-scroll t)
1807 ;; Universal argument commands
1808 (put 'universal-argument 'isearch-scroll t)
1809 (put 'negative-argument 'isearch-scroll t)
1810 (put 'digit-argument 'isearch-scroll t)
1812 (defcustom isearch-allow-scroll nil
1813 "Whether scrolling is allowed during incremental search.
1814 If non-nil, scrolling commands can be used in Isearch mode.
1815 However, the current match will never scroll offscreen.
1816 If nil, scrolling commands will first cancel Isearch mode."
1820 (defun isearch-string-out-of-window (isearch-point)
1821 "Test whether the search string is currently outside of the window.
1822 Return nil if it's completely visible, or if point is visible,
1823 together with as much of the search string as will fit; the symbol
1824 `above' if we need to scroll the text downwards; the symbol `below',
1826 (let ((w-start (window-start))
1827 (w-end (window-end nil t))
1828 (w-L1 (save-excursion (move-to-window-line 1) (point)))
1829 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
1830 start end) ; start and end of search string in buffer
1832 (setq end isearch-point start (or isearch-other-end isearch-point))
1833 (setq start isearch-point end (or isearch-other-end isearch-point)))
1834 (cond ((or (and (>= start w-start) (<= end w-end))
1836 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
1837 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
1839 ((and (< start w-start)
1840 (< isearch-point w-L-1))
1844 (defun isearch-back-into-window (above isearch-point)
1845 "Scroll the window to bring the search string back into view.
1846 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
1847 search string is above the top of the window, nil when it is beneath
1851 (setq end isearch-point start (or isearch-other-end isearch-point))
1852 (setq start isearch-point end (or isearch-other-end isearch-point)))
1857 (when (>= isearch-point (window-end nil t))
1858 (goto-char isearch-point)
1862 (when (< isearch-point (window-start))
1863 (goto-char isearch-point)
1865 (goto-char isearch-point))
1867 (defun isearch-reread-key-sequence-naturally (keylist)
1868 "Reread key sequence KEYLIST with Isearch mode's keymap deactivated.
1869 Return the key sequence as a string/vector."
1870 (isearch-unread-key-sequence keylist)
1871 (let (overriding-terminal-local-map)
1872 (read-key-sequence nil))) ; This will go through function-key-map, if nec.
1874 (defun isearch-lookup-scroll-key (key-seq)
1875 "If KEY-SEQ is bound to a scrolling command, return it as a symbol.
1876 Otherwise return nil."
1877 (let* ((overriding-terminal-local-map nil)
1878 (binding (key-binding key-seq)))
1879 (and binding (symbolp binding) (commandp binding)
1880 (or (eq (get binding 'isearch-scroll) t)
1881 (eq (get binding 'scroll-command) t))
1884 (defalias 'isearch-other-control-char 'isearch-other-meta-char)
1886 (defun isearch-other-meta-char (&optional arg)
1887 "Process a miscellaneous key sequence in Isearch mode.
1889 Try to convert the current key-sequence to something usable in Isearch
1890 mode, either by converting it with `function-key-map', downcasing a
1891 key with C-<upper case>, or finding a \"scrolling command\" bound to
1892 it. \(In the last case, we may have to read more events.) If so,
1893 either unread the converted sequence or execute the command.
1895 Otherwise, if `search-exit-option' is non-nil (the default) unread the
1896 key-sequence and exit the search normally. If it is the symbol
1897 `edit', the search string is edited in the minibuffer and the meta
1898 character is unread so that it applies to editing the string.
1900 ARG is the prefix argument. It will be transmitted through to the
1901 scrolling command or to the command whose key-sequence exits
1904 (let* ((key (if current-prefix-arg ; not nec the same as ARG
1905 (substring (this-command-keys) universal-argument-num-events)
1906 (this-command-keys)))
1907 (main-event (aref key 0))
1908 (keylist (listify-key-sequence key))
1909 scroll-command isearch-point)
1910 (cond ((and (= (length key) 1)
1911 (let ((lookup (lookup-key local-function-key-map key)))
1912 (not (or (null lookup) (integerp lookup)
1913 (keymapp lookup)))))
1914 ;; Handle a function key that translates into something else.
1915 ;; If the key has a global definition too,
1916 ;; exit and unread the key itself, so its global definition runs.
1917 ;; Otherwise, unread the translation,
1918 ;; so that the translated key takes effect within isearch.
1919 (cancel-kbd-macro-events)
1920 (if (lookup-key global-map key)
1923 (setq prefix-arg arg)
1924 (apply 'isearch-unread keylist))
1926 (listify-key-sequence (lookup-key local-function-key-map key)))
1928 (setq key (car keylist))
1929 ;; If KEY is a printing char, we handle it here
1930 ;; directly to avoid the input method and keyboard
1931 ;; coding system translating it.
1932 (if (and (integerp key)
1933 (>= key ?\s) (/= key 127) (< key 256))
1935 (isearch-process-search-char key)
1936 (setq keylist (cdr keylist)))
1937 ;; As the remaining keys in KEYLIST can't be handled
1938 ;; here, we must reread them.
1939 (setq prefix-arg arg)
1940 (apply 'isearch-unread keylist)
1941 (setq keylist nil)))))
1943 ;; Handle an undefined shifted control character
1944 ;; by downshifting it if that makes it defined.
1945 ;; (As read-key-sequence would normally do,
1946 ;; if we didn't have a default definition.)
1947 (let ((mods (event-modifiers main-event)))
1948 (and (integerp main-event)
1950 (memq 'control mods)
1951 (not (memq (lookup-key isearch-mode-map
1952 (let ((copy (copy-sequence key)))
1955 (- ?\C-\S-a ?\C-a)))
1959 isearch-other-control-char)))))
1960 (setcar keylist (- main-event (- ?\C-\S-a ?\C-a)))
1961 (cancel-kbd-macro-events)
1962 (setq prefix-arg arg)
1963 (apply 'isearch-unread keylist))
1964 ((eq search-exit-option 'edit)
1965 (setq prefix-arg arg)
1966 (apply 'isearch-unread keylist)
1967 (isearch-edit-string))
1968 ;; Handle a scrolling function.
1969 ((and isearch-allow-scroll
1970 (progn (setq key (isearch-reread-key-sequence-naturally keylist))
1971 (setq keylist (listify-key-sequence key))
1972 (setq main-event (aref key 0))
1973 (setq scroll-command (isearch-lookup-scroll-key key))))
1974 ;; From this point onwards, KEY, KEYLIST and MAIN-EVENT hold a
1975 ;; complete key sequence, possibly as modified by function-key-map,
1976 ;; not merely the one or two event fragment which invoked
1977 ;; isearch-other-meta-char in the first place.
1978 (setq isearch-point (point))
1979 (setq prefix-arg arg)
1980 (command-execute scroll-command)
1981 (let ((ab-bel (isearch-string-out-of-window isearch-point)))
1983 (isearch-back-into-window (eq ab-bel 'above) isearch-point)
1984 (goto-char isearch-point)))
1986 ;; A mouse click on the isearch message starts editing the search string
1987 ((and (eq (car-safe main-event) 'down-mouse-1)
1988 (window-minibuffer-p (posn-window (event-start main-event))))
1989 ;; Swallow the up-event.
1991 (isearch-edit-string))
1994 (setq prefix-arg arg)
1995 (isearch-unread-key-sequence keylist)
1996 (setq main-event (car unread-command-events))
1998 ;; If we got a mouse click event, that event contains the
1999 ;; window clicked on. maybe it was read with the buffer
2000 ;; it was clicked on. If so, that buffer, not the current one,
2001 ;; is in isearch mode. So end the search in that buffer.
2003 ;; ??? I have no idea what this if checks for, but it's
2004 ;; obviously wrong for the case that a down-mouse event
2005 ;; on another window invokes this function. The event
2006 ;; will contain the window clicked on and that window's
2007 ;; buffer is certainly not always in Isearch mode.
2009 ;; Leave the code in, but check for current buffer not
2010 ;; being in Isearch mode for now, until someone tells
2011 ;; what it's really supposed to do.
2013 ;; --gerd 2001-08-10.
2015 (if (and (not isearch-mode)
2017 (setq window (posn-window (event-start main-event)))
2019 (or (> (minibuffer-depth) 0)
2020 (not (window-minibuffer-p window))))
2021 (with-current-buffer (window-buffer window)
2023 (isearch-clean-overlays))
2025 (isearch-clean-overlays)
2026 (setq prefix-arg arg))))
2028 (isearch-process-search-string key key)))))
2030 (defun isearch-quote-char ()
2031 "Quote special characters for incremental search."
2033 (let ((char (read-quoted-char (isearch-message t))))
2034 ;; Assume character codes 0200 - 0377 stand for characters in some
2035 ;; single-byte character set, and convert them to Emacs
2037 (if (and isearch-regexp (= char ?\s))
2038 (if (subregexp-context-p isearch-string (length isearch-string))
2039 (isearch-process-search-string "[ ]" " ")
2040 (isearch-process-search-char char))
2041 (and enable-multibyte-characters
2044 (setq char (unibyte-char-to-multibyte char)))
2045 (isearch-process-search-char char))))
2047 (defun isearch-printing-char ()
2048 "Add this ordinary printing character to the search string and search."
2050 (let ((char last-command-event))
2053 (if current-input-method
2054 (isearch-process-search-multibyte-characters char)
2055 (isearch-process-search-char char))))
2057 (defun isearch-process-search-char (char)
2058 ;; * and ? are special in regexps when not preceded by \.
2059 ;; } and | are special in regexps when preceded by \.
2060 ;; Nothing special for + because it matches at least once.
2062 ((memq char '(?* ??)) (isearch-fallback nil))
2063 ((eq char ?\}) (isearch-fallback t t))
2064 ((eq char ?|) (isearch-fallback t nil t)))
2066 ;; Append the char to the search string, update the message and re-search.
2067 (isearch-process-search-string
2068 (char-to-string char)
2070 (char-to-string char)
2071 (isearch-text-char-description char))))
2073 (defun isearch-process-search-string (string message)
2074 (setq isearch-string (concat isearch-string string)
2075 isearch-message (concat isearch-message message))
2076 (isearch-search-and-update))
2081 (defun isearch-ring-adjust1 (advance)
2082 ;; Helper for isearch-ring-adjust
2083 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2084 (length (length ring))
2085 (yank-pointer-name (if isearch-regexp
2086 'regexp-search-ring-yank-pointer
2087 'search-ring-yank-pointer))
2088 (yank-pointer (eval yank-pointer-name)))
2091 (set yank-pointer-name
2093 (mod (+ (or yank-pointer (if advance 0 -1))
2096 (setq isearch-string (nth yank-pointer ring)
2097 isearch-message (mapconcat 'isearch-text-char-description
2098 isearch-string "")))))
2100 (defun isearch-ring-adjust (advance)
2101 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2102 (isearch-ring-adjust1 advance)
2103 (if search-ring-update
2106 (isearch-push-state)
2108 ;; Otherwise, edit the search string instead. Note that there is
2109 ;; no need to push the search state after isearch-edit-string here
2110 ;; since isearch-edit-string already pushes its state
2111 (isearch-edit-string)))
2113 (defun isearch-ring-advance ()
2114 "Advance to the next search string in the ring."
2115 ;; This could be more general to handle a prefix arg, but who would use it.
2117 (isearch-ring-adjust 'advance))
2119 (defun isearch-ring-retreat ()
2120 "Retreat to the previous search string in the ring."
2122 (isearch-ring-adjust nil))
2124 (defun isearch-complete1 ()
2125 ;; Helper for isearch-complete and isearch-complete-edit
2126 ;; Return t if completion OK, nil if no completion exists.
2127 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2128 (completion-ignore-case case-fold-search)
2129 (completion (try-completion isearch-string ring)))
2132 ;; isearch-string stays the same
2134 ((or completion ; not nil, must be a string
2135 (= 0 (length isearch-string))) ; shouldn't have to say this
2136 (if (equal completion isearch-string) ;; no extension?
2138 (if completion-auto-help
2139 (with-output-to-temp-buffer "*Isearch completions*"
2140 (display-completion-list
2141 (all-completions isearch-string ring))))
2144 (setq isearch-string completion))))
2146 (message "No completion") ; waits a second if in minibuffer
2149 (defun isearch-complete ()
2150 "Complete the search string from the strings on the search ring.
2151 The completed string is then editable in the minibuffer.
2152 If there is no completion possible, say so and continue searching."
2154 (if (isearch-complete1)
2155 (progn (setq isearch-message
2156 (mapconcat 'isearch-text-char-description
2158 (isearch-edit-string))
2163 (defun isearch-complete-edit ()
2164 "Same as `isearch-complete' except in the minibuffer."
2166 (setq isearch-string (field-string))
2167 (if (isearch-complete1)
2170 (insert isearch-string))))
2175 (defun isearch-message (&optional c-q-hack ellipsis)
2176 ;; Generate and print the message string.
2177 (let ((cursor-in-echo-area ellipsis)
2181 (when (or (not isearch-success) isearch-error)
2182 ;; Highlight failed part
2183 (while (or (not (isearch-success-state (car cmds)))
2184 (isearch-error-state (car cmds)))
2186 (setq succ-msg (and cmds (isearch-message-state (car cmds)))
2187 m (copy-sequence m))
2188 (add-text-properties
2189 (if (and (stringp succ-msg)
2190 (< (length succ-msg) (length m))
2191 (equal succ-msg (substring m 0 (length succ-msg))))
2194 (length m) '(face isearch-fail) m)
2195 ;; Highlight failed trailing whitespace
2196 (when (string-match " +$" m)
2197 (add-text-properties (match-beginning 0) (match-end 0)
2198 '(face trailing-whitespace) m)))
2200 (isearch-message-prefix c-q-hack ellipsis isearch-nonincremental)
2202 (isearch-message-suffix c-q-hack ellipsis)))
2203 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2205 (defun isearch-message-prefix (&optional _c-q-hack ellipsis nonincremental)
2206 ;; If about to search, and previous search regexp was invalid,
2207 ;; check that it still is. If it is valid now,
2208 ;; let the message we display while searching say that it is valid.
2209 (and isearch-error ellipsis
2211 (progn (re-search-forward isearch-string (point) t)
2212 (setq isearch-error nil))
2214 ;; If currently failing, display no ellipsis.
2215 (or isearch-success (setq ellipsis nil))
2216 (let ((m (concat (if isearch-success "" "failing ")
2217 (if isearch-adjusted "pending " "")
2218 (if (and isearch-wrapped
2219 (not isearch-wrap-function)
2221 (> (point) isearch-opoint)
2222 (< (point) isearch-opoint)))
2224 (if isearch-wrapped "wrapped ")
2225 (if isearch-word "word " "")
2226 (if isearch-regexp "regexp " "")
2227 (if multi-isearch-next-buffer-current-function "multi " "")
2228 (or isearch-message-prefix-add "")
2229 (if nonincremental "search" "I-search")
2230 (if isearch-forward "" " backward")
2231 (if current-input-method
2232 (concat " [" current-input-method-title "]: ")
2235 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2236 'face 'minibuffer-prompt)))
2238 (defun isearch-message-suffix (&optional c-q-hack _ellipsis)
2239 (concat (if c-q-hack "^Q" "")
2241 (concat " [" isearch-error "]")
2243 (or isearch-message-suffix-add "")))
2248 (defvar isearch-search-fun-function nil
2249 "Overrides the default `isearch-search-fun' behaviour.
2250 This variable's value should be a function, which will be called
2251 with no arguments, and should return a function that takes three
2252 arguments: STRING, BOUND, and NOERROR.
2254 This returned function will be used by `isearch-search-string' to
2255 search for the first occurrence of STRING or its translation.")
2257 (defun isearch-search-fun ()
2258 "Return the function to use for the search.
2259 Can be changed via `isearch-search-fun-function' for special needs."
2260 (if isearch-search-fun-function
2261 (funcall isearch-search-fun-function)
2264 ;; Use lax versions to not fail at the end of the word while
2265 ;; the user adds and removes characters in the search string
2266 ;; (or when using nonincremental word isearch)
2267 (if (or isearch-nonincremental
2268 (eq (length isearch-string)
2269 (length (isearch-string-state (car isearch-cmds)))))
2270 (if isearch-forward 'word-search-forward 'word-search-backward)
2271 (if isearch-forward 'word-search-forward-lax 'word-search-backward-lax)))
2273 (if isearch-forward 're-search-forward 're-search-backward))
2275 (if isearch-forward 'search-forward 'search-backward)))))
2277 (defun isearch-search-string (string bound noerror)
2278 "Search for the first occurrence of STRING or its translation.
2279 If found, move point to the end of the occurrence,
2280 update the match data, and return point."
2281 (let* ((func (isearch-search-fun))
2282 (pos1 (save-excursion (funcall func string bound noerror)))
2285 ;; Avoid "obsolete" warnings for translation-table-for-input.
2287 (char-table-p translation-table-for-input))
2288 (multibyte-string-p string)
2289 ;; Minor optimization.
2290 (string-match-p "[^[:ascii:]]" string))
2295 ;; Avoid "obsolete" warnings for
2296 ;; translation-table-for-input.
2298 (aref translation-table-for-input c))
2305 (if (setq pos2 (funcall func translated bound noerror))
2306 (setq match-data (match-data t)))))
2309 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2311 (set-match-data match-data)))))
2313 ;; When using multiple buffers isearch, switch to the new buffer here,
2314 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2315 (if (and multi-isearch-next-buffer-current-function
2316 (buffer-live-p multi-isearch-current-buffer))
2317 (switch-to-buffer multi-isearch-current-buffer))
2321 (defun isearch-search ()
2322 ;; Do the search with the current search string.
2323 (if isearch-message-function
2324 (funcall isearch-message-function nil t)
2325 (isearch-message nil t))
2326 (if (and (eq isearch-case-fold-search t) search-upper-case)
2327 (setq isearch-case-fold-search
2328 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2329 (condition-case lossage
2330 (let ((inhibit-point-motion-hooks
2331 (and (eq isearch-filter-predicate 'isearch-filter-visible)
2334 (case-fold-search isearch-case-fold-search)
2335 (search-spaces-regexp search-whitespace-regexp)
2337 (setq isearch-error nil)
2339 (setq isearch-success
2340 (isearch-search-string isearch-string nil t))
2341 ;; Clear RETRY unless the search predicate says
2342 ;; to skip this search hit.
2343 (if (or (not isearch-success)
2345 (= (match-beginning 0) (match-end 0))
2346 (funcall isearch-filter-predicate
2347 (match-beginning 0) (match-end 0)))
2349 (setq isearch-just-started nil)
2351 (setq isearch-other-end
2352 (if isearch-forward (match-beginning 0) (match-end 0)))))
2354 (quit (isearch-unread ?\C-g)
2355 (setq isearch-success nil))
2358 (setq isearch-error (car (cdr lossage)))
2360 "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
2362 (setq isearch-error "incomplete input")))
2365 (setq isearch-success nil)
2366 (setq isearch-error (nth 2 lossage)))
2369 ;; stack overflow in regexp search.
2370 (setq isearch-error (format "%s" lossage))))
2374 ;; Ding if failed this time after succeeding last time.
2375 (and (isearch-success-state (car isearch-cmds))
2377 (if (functionp (isearch-pop-fun-state (car isearch-cmds)))
2378 (funcall (isearch-pop-fun-state (car isearch-cmds)) (car isearch-cmds)))
2379 (goto-char (isearch-point-state (car isearch-cmds)))))
2382 ;; Called when opening an overlay, and we are still in isearch.
2383 (defun isearch-open-overlay-temporary (ov)
2384 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2385 ;; Some modes would want to open the overlays temporary during
2386 ;; isearch in their own way, they should set the
2387 ;; `isearch-open-invisible-temporary' to a function doing this.
2388 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2389 ;; Store the values for the `invisible' and `intangible'
2390 ;; properties, and then set them to nil. This way the text hidden
2391 ;; by this overlay becomes visible.
2393 ;; Do we really need to set the `intangible' property to t? Can we
2394 ;; have the point inside an overlay with an `intangible' property?
2395 ;; In 19.34 this does not exist so I cannot test it.
2396 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2397 (overlay-put ov 'isearch-intangible (overlay-get ov 'intangible))
2398 (overlay-put ov 'invisible nil)
2399 (overlay-put ov 'intangible nil)))
2402 ;; This is called at the end of isearch. It will open the overlays
2403 ;; that contain the latest match. Obviously in case of a C-g the
2404 ;; point returns to the original location which surely is not contain
2405 ;; in any of these overlays, se we are safe in this case too.
2406 (defun isearch-open-necessary-overlays (ov)
2407 (let ((inside-overlay (and (> (point) (overlay-start ov))
2408 (< (point) (overlay-end ov))))
2409 ;; If this exists it means that the overlay was opened using
2410 ;; this function, not by us tweaking the overlay properties.
2411 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2412 (when (or inside-overlay (not fct-temp))
2413 ;; restore the values for the `invisible' and `intangible'
2415 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2416 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2417 (overlay-put ov 'isearch-invisible nil)
2418 (overlay-put ov 'isearch-intangible nil))
2420 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2422 (funcall fct-temp ov t)))))
2424 ;; This is called when exiting isearch. It closes the temporary
2425 ;; opened overlays, except the ones that contain the latest match.
2426 (defun isearch-clean-overlays ()
2427 (when isearch-opened-overlays
2428 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2429 (setq isearch-opened-overlays nil)))
2432 (defun isearch-intersects-p (start0 end0 start1 end1)
2433 "Return t if regions START0..END0 and START1..END1 intersect."
2434 (or (and (>= start0 start1) (< start0 end1))
2435 (and (> end0 start1) (<= end0 end1))
2436 (and (>= start1 start0) (< start1 end0))
2437 (and (> end1 start0) (<= end1 end0))))
2440 ;; Verify if the current match is outside of each element of
2441 ;; `isearch-opened-overlays', if so close that overlay.
2443 (defun isearch-close-unnecessary-overlays (begin end)
2444 (let ((overlays isearch-opened-overlays))
2445 (setq isearch-opened-overlays nil)
2446 (dolist (ov overlays)
2447 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2448 (push ov isearch-opened-overlays)
2449 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2451 ;; If this exists it means that the overlay was opened
2452 ;; using this function, not by us tweaking the overlay
2454 (funcall fct-temp ov t)
2455 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2456 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2457 (overlay-put ov 'isearch-invisible nil)
2458 (overlay-put ov 'isearch-intangible nil)))))))
2461 (defun isearch-range-invisible (beg end)
2462 "Return t if all the text from BEG to END is invisible."
2464 ;; Check that invisibility runs up to END.
2467 (let (;; can-be-opened keeps track if we can open some overlays.
2468 (can-be-opened (eq search-invisible 'open))
2469 ;; the list of overlays that could be opened
2471 (when (and can-be-opened isearch-hide-immediately)
2472 (isearch-close-unnecessary-overlays beg end))
2473 ;; If the following character is currently invisible,
2474 ;; skip all characters with that same `invisible' property value.
2475 ;; Do that over and over.
2476 (while (and (< (point) end) (invisible-p (point)))
2477 (if (invisible-p (get-text-property (point) 'invisible))
2479 (goto-char (next-single-property-change (point) 'invisible
2481 ;; if text is hidden by an `invisible' text property
2482 ;; we cannot open it at all.
2483 (setq can-be-opened nil))
2485 (let ((overlays (overlays-at (point)))
2490 (setq o (car overlays)
2491 invis-prop (overlay-get o 'invisible))
2492 (if (invisible-p invis-prop)
2493 (if (overlay-get o 'isearch-open-invisible)
2494 (setq ov-list (cons o ov-list))
2495 ;; We found one overlay that cannot be
2496 ;; opened, that means the whole chunk
2497 ;; cannot be opened.
2498 (setq can-be-opened nil)))
2499 (setq overlays (cdr overlays)))
2501 ;; It makes sense to append to the open
2502 ;; overlays list only if we know that this is
2504 (setq crt-overlays (append ov-list crt-overlays)))))
2505 (goto-char (next-overlay-change (point)))))
2506 ;; See if invisibility reaches up thru END.
2507 (if (>= (point) end)
2508 (if (and can-be-opened (consp crt-overlays))
2510 (setq isearch-opened-overlays
2511 (append isearch-opened-overlays crt-overlays))
2512 (mapc 'isearch-open-overlay-temporary crt-overlays)
2514 (setq isearch-hidden t)))))))
2516 (defun isearch-filter-visible (beg end)
2517 "Test whether the current search hit is visible at least partially.
2518 Return non-nil if the text from BEG to END is visible to Isearch as
2519 determined by `isearch-range-invisible' unless invisible text can be
2520 searched too when `search-invisible' is t."
2521 (or (eq search-invisible t)
2522 (not (isearch-range-invisible beg end))))
2525 ;; General utilities
2527 (defun isearch-no-upper-case-p (string regexp-flag)
2528 "Return t if there are no upper case chars in STRING.
2529 If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
2530 since they have special meaning in a regexp."
2531 (let (quote-flag (i 0) (len (length string)) found)
2532 (while (and (not found) (< i len))
2533 (let ((char (aref string i)))
2534 (if (and regexp-flag (eq char ?\\))
2535 (setq quote-flag (not quote-flag))
2536 (if (and (not quote-flag) (not (eq char (downcase char))))
2538 (setq quote-flag nil)))
2541 ;; Even if there's no uppercase char, we want to detect the use
2542 ;; of [:upper:] or [:lower:] char-class, which indicates
2543 ;; clearly that the user cares about case distinction.
2544 (and regexp-flag (string-match "\\[:\\(upp\\|low\\)er:]" string)
2547 (string-match (substring string 0 (match-beginning 0))
2551 (equal "Unmatched [ or [^" (cadr err)))))))))
2553 ;; Portability functions to support various Emacs versions.
2555 (defun isearch-text-char-description (c)
2557 ((< c ?\s) (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph))
2558 ((= c ?\^?) (propertize "^?" 'face 'escape-glyph))
2559 (t (char-to-string c))))
2561 ;; General function to unread characters or events.
2562 ;; Also insert them in a keyboard macro being defined.
2563 (defun isearch-unread (&rest char-or-events)
2564 (mapc 'store-kbd-macro-event char-or-events)
2565 (setq unread-command-events
2566 (append char-or-events unread-command-events)))
2571 (defvar isearch-overlay nil)
2573 (defun isearch-highlight (beg end)
2574 (if search-highlight
2576 ;; Overlay already exists, just move it.
2577 (move-overlay isearch-overlay beg end (current-buffer))
2578 ;; Overlay doesn't exist, create it.
2579 (setq isearch-overlay (make-overlay beg end))
2580 ;; 1001 is higher than lazy's 1000 and ediff's 100+
2581 (overlay-put isearch-overlay 'priority 1001)
2582 (overlay-put isearch-overlay 'face isearch-face))))
2584 (defun isearch-dehighlight ()
2585 (when isearch-overlay
2586 (delete-overlay isearch-overlay)))
2588 ;; isearch-lazy-highlight feature
2589 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
2591 ;; When active, *every* match for the current search string is
2592 ;; highlighted: the current one using the normal isearch match color
2593 ;; and all the others using `isearch-lazy-highlight'. The extra
2594 ;; highlighting makes it easier to anticipate where the cursor will
2595 ;; land each time you press C-s or C-r to repeat a pending search.
2596 ;; Highlighting of these additional matches happens in a deferred
2597 ;; fashion using "idle timers," so the cycles needed do not rob
2598 ;; isearch of its usual snappy response.
2600 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
2602 ;; - `isearch-update' is expected to be called (at least) every time
2603 ;; the search string or window-start changes;
2604 ;; - `isearch-string' is expected to contain the current search
2605 ;; string as entered by the user;
2606 ;; - the type of the current search is expected to be given by
2607 ;; `isearch-word' and `isearch-regexp';
2608 ;; - the direction of the current search is expected to be given by
2609 ;; `isearch-forward';
2610 ;; - the variable `isearch-error' is expected to be true
2611 ;; only if `isearch-string' is an invalid regexp.
2613 (defvar isearch-lazy-highlight-overlays nil)
2614 (defvar isearch-lazy-highlight-wrapped nil)
2615 (defvar isearch-lazy-highlight-start-limit nil)
2616 (defvar isearch-lazy-highlight-end-limit nil)
2617 (defvar isearch-lazy-highlight-start nil)
2618 (defvar isearch-lazy-highlight-end nil)
2619 (defvar isearch-lazy-highlight-timer nil)
2620 (defvar isearch-lazy-highlight-last-string nil)
2621 (defvar isearch-lazy-highlight-window nil)
2622 (defvar isearch-lazy-highlight-window-start nil)
2623 (defvar isearch-lazy-highlight-window-end nil)
2624 (defvar isearch-lazy-highlight-case-fold-search nil)
2625 (defvar isearch-lazy-highlight-regexp nil)
2626 (defvar isearch-lazy-highlight-space-regexp nil)
2627 (defvar isearch-lazy-highlight-forward nil)
2628 (defvar isearch-lazy-highlight-error nil)
2630 (defun lazy-highlight-cleanup (&optional force)
2631 "Stop lazy highlighting and remove extra highlighting from current buffer.
2632 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
2633 is nil. This function is called when exiting an incremental search if
2634 `lazy-highlight-cleanup' is non-nil."
2636 (if (or force lazy-highlight-cleanup)
2637 (while isearch-lazy-highlight-overlays
2638 (delete-overlay (car isearch-lazy-highlight-overlays))
2639 (setq isearch-lazy-highlight-overlays
2640 (cdr isearch-lazy-highlight-overlays))))
2641 (when isearch-lazy-highlight-timer
2642 (cancel-timer isearch-lazy-highlight-timer)
2643 (setq isearch-lazy-highlight-timer nil)))
2645 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
2646 'lazy-highlight-cleanup
2649 (defun isearch-lazy-highlight-new-loop (&optional beg end)
2650 "Cleanup any previous `lazy-highlight' loop and begin a new one.
2651 BEG and END specify the bounds within which highlighting should occur.
2652 This is called when `isearch-update' is invoked (which can cause the
2653 search string to change or the window to scroll). It is also used
2654 by other Emacs features."
2655 (when (and (null executing-kbd-macro)
2656 (sit-for 0) ;make sure (window-start) is credible
2657 (or (not (equal isearch-string
2658 isearch-lazy-highlight-last-string))
2659 (not (eq (selected-window)
2660 isearch-lazy-highlight-window))
2661 (not (eq isearch-lazy-highlight-case-fold-search
2662 isearch-case-fold-search))
2663 (not (eq isearch-lazy-highlight-regexp
2665 (not (= (window-start)
2666 isearch-lazy-highlight-window-start))
2667 (not (= (window-end) ; Window may have been split/joined.
2668 isearch-lazy-highlight-window-end))
2669 (not (eq isearch-forward
2670 isearch-lazy-highlight-forward))
2671 ;; In case we are recovering from an error.
2672 (not (equal isearch-error
2673 isearch-lazy-highlight-error))))
2674 ;; something important did indeed change
2675 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
2676 (setq isearch-lazy-highlight-error isearch-error)
2677 (when (not isearch-error)
2678 (setq isearch-lazy-highlight-start-limit beg
2679 isearch-lazy-highlight-end-limit end)
2680 (setq isearch-lazy-highlight-window (selected-window)
2681 isearch-lazy-highlight-window-start (window-start)
2682 isearch-lazy-highlight-window-end (window-end)
2683 isearch-lazy-highlight-start (point)
2684 isearch-lazy-highlight-end (point)
2685 isearch-lazy-highlight-last-string isearch-string
2686 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
2687 isearch-lazy-highlight-regexp isearch-regexp
2688 isearch-lazy-highlight-wrapped nil
2689 isearch-lazy-highlight-space-regexp search-whitespace-regexp
2690 isearch-lazy-highlight-forward isearch-forward)
2691 (unless (equal isearch-string "")
2692 (setq isearch-lazy-highlight-timer
2693 (run-with-idle-timer lazy-highlight-initial-delay nil
2694 'isearch-lazy-highlight-update))))))
2696 (defun isearch-lazy-highlight-search ()
2697 "Search ahead for the next or previous match, for lazy highlighting.
2698 Attempt to do the search exactly the way the pending Isearch would."
2700 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
2701 (isearch-regexp isearch-lazy-highlight-regexp)
2702 (search-spaces-regexp isearch-lazy-highlight-space-regexp)
2703 (search-invisible nil) ; don't match invisible text
2706 (isearch-forward isearch-lazy-highlight-forward)
2707 (bound (if isearch-lazy-highlight-forward
2708 (min (or isearch-lazy-highlight-end-limit (point-max))
2709 (if isearch-lazy-highlight-wrapped
2710 isearch-lazy-highlight-start
2712 (max (or isearch-lazy-highlight-start-limit (point-min))
2713 (if isearch-lazy-highlight-wrapped
2714 isearch-lazy-highlight-end
2716 ;; Use a loop like in `isearch-search'.
2718 (setq success (isearch-search-string
2719 isearch-lazy-highlight-last-string bound t))
2720 ;; Clear RETRY unless the search predicate says
2721 ;; to skip this search hit.
2722 (if (or (not success)
2723 (= (point) bound) ; like (bobp) (eobp) in `isearch-search'.
2724 (= (match-beginning 0) (match-end 0))
2725 (funcall isearch-filter-predicate
2726 (match-beginning 0) (match-end 0)))
2731 (defun isearch-lazy-highlight-update ()
2732 "Update highlighting of other matches for current search."
2733 (let ((max lazy-highlight-max-at-a-time)
2737 (save-selected-window
2738 (if (and (window-live-p isearch-lazy-highlight-window)
2739 (not (eq (selected-window) isearch-lazy-highlight-window)))
2740 (select-window isearch-lazy-highlight-window))
2743 (goto-char (if isearch-lazy-highlight-forward
2744 isearch-lazy-highlight-end
2745 isearch-lazy-highlight-start))
2747 (let ((found (isearch-lazy-highlight-search)))
2751 (setq looping nil)))
2753 (let ((mb (match-beginning 0))
2755 (if (= mb me) ;zero-length match
2756 (if isearch-lazy-highlight-forward
2757 (if (= mb (if isearch-lazy-highlight-wrapped
2758 isearch-lazy-highlight-start
2762 (if (= mb (if isearch-lazy-highlight-wrapped
2763 isearch-lazy-highlight-end
2768 ;; non-zero-length match
2769 (let ((ov (make-overlay mb me)))
2770 (push ov isearch-lazy-highlight-overlays)
2771 ;; 1000 is higher than ediff's 100+,
2772 ;; but lower than isearch main overlay's 1001
2773 (overlay-put ov 'priority 1000)
2774 (overlay-put ov 'face lazy-highlight-face)
2775 (overlay-put ov 'window (selected-window))))
2776 (if isearch-lazy-highlight-forward
2777 (setq isearch-lazy-highlight-end (point))
2778 (setq isearch-lazy-highlight-start (point)))))
2780 ;; not found or zero-length match at the search bound
2782 (if isearch-lazy-highlight-wrapped
2785 (setq isearch-lazy-highlight-wrapped t)
2786 (if isearch-lazy-highlight-forward
2788 (setq isearch-lazy-highlight-end (window-start))
2789 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
2791 (setq isearch-lazy-highlight-start (window-end))
2792 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
2795 (setq isearch-lazy-highlight-timer
2796 (run-at-time lazy-highlight-interval nil
2797 'isearch-lazy-highlight-update)))))))))
2799 (defun isearch-resume (string regexp word forward message case-fold)
2800 "Resume an incremental search.
2801 STRING is the string or regexp searched for.
2802 REGEXP non-nil means the resumed search was a regexp search.
2803 WORD non-nil means resume a word search.
2804 FORWARD non-nil means resume a forward search.
2805 MESSAGE is the echo-area message recorded for the search resumed.
2806 CASE-FOLD non-nil means the search was case-insensitive."
2807 (isearch-mode forward regexp nil nil word)
2808 (setq isearch-string string
2809 isearch-message message
2810 isearch-case-fold-search case-fold)
2814 ;;; isearch.el ends here