| blob | 4fc9b380ec700bb749d4830dce11664d6c683357 |
1 ;;; isearch.el --- incremental search minor mode
3 ;; Copyright (C) 1992-1997, 1999-2015 Free Software Foundation, Inc.
5 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: matching
8 ;; Package: emacs
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/>.
25 ;;; Commentary:
27 ;; Instructions
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
43 ;; switch.
45 ;; The search ring and completion commands automatically put you in
46 ;; the minibuffer to edit the string. This gives you a chance to
47 ;; modify the search string before executing the search. There are
48 ;; three commands to terminate the editing: C-s and C-r exit the
49 ;; minibuffer and search forward and reverse respectively, while C-m
50 ;; exits and searches in the last search direction.
52 ;; Exiting immediately from isearch uses isearch-edit-string instead
53 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
54 ;; The name of this option should probably be changed if we decide to
55 ;; keep the behavior. No point in forcing nonincremental search until
56 ;; the last possible moment.
58 ;;; Code:
61 \f
62 ;; Some additional options and constants.
65 "Incremental search minor mode."
74 "Non-nil means random control characters terminate incremental search."
79 "Number of lines in slow search display windows.
80 These are the short windows used during incremental search on slow terminals.
81 Negative means put the slow search window at the top (normally it's at bottom)
82 and the value is minus the number of lines."
88 This is the style where a one-line window is created to show the line
89 that the search has reached."
94 "If non-nil, upper case chars disable case fold searching.
95 That is, upper and lower case chars must match exactly.
96 This applies no matter where the chars come from, but does not
98 If this value is `not-yanks', text yanked into the search string
99 in Isearch mode is always downcased."
106 "If non-nil, do a nonincremental search instead of exiting immediately.
107 Actually, `isearch-edit-string' is called to let you enter the search
108 string, and RET terminates editing and does a nonincremental search."
113 "If non-nil, regular expression to match a sequence of whitespace chars.
114 When you enter a space or spaces in the incremental search, it
115 will match any sequence matched by this regexp. As an exception,
116 spaces are treated normally in regexp incremental search if they
117 occur in a regexp construct like [...] or *, + or ?.
119 If the value is a string, it applies to both ordinary and
120 regexp incremental search. If the value is nil, or
121 `isearch-lax-whitespace' is nil for ordinary incremental search, or
122 `isearch-regexp-lax-whitespace' is nil for regexp incremental search,
123 then each space you type matches literally, against one space.
126 In the Customization buffer, that is `[' followed by a space,
127 a tab, a carriage return (control-M), a newline, and `]+'."
129 regexp)
134 "If t incremental search/query-replace can match hidden text.
135 A nil value means don't match invisible text.
136 When the value is `open', if the text matched is made invisible by
137 an overlay having an `invisible' property and that overlay has a property
138 `isearch-open-invisible', then incremental search will show the contents.
139 \(This applies when using `outline.el' and `hideshow.el'.)
141 To temporarily change the value for an active incremental search,
144 See also the related option `isearch-hide-immediately'.
146 See also `reveal-mode' if you want overlays to automatically be opened
147 whenever point is in one of them."
154 "If non-nil, re-hide an invisible match right away.
155 This variable makes a difference when `search-invisible' is set to `open'.
156 If nil then do not re-hide opened invisible text when the match moves.
157 Whatever the value, all opened invisible text is hidden again after exiting
158 the search."
163 "If non-nil, `isearch-resume' commands are added to the command history.
164 This allows you to resume earlier Isearch sessions through the
165 command history."
176 "Function(s) to call after terminating an incremental search.
177 When these functions are called, `isearch-mode-end-hook-quit'
184 "Function to call to display the search prompt.
188 "Function to call to wrap the search when search is failed.
189 If nil, move point to the beginning of the buffer for a forward search,
193 "Function to save a function restoring the mode-specific Isearch state
197 "Predicate that filters the search hits that would normally be available.
198 Search hits that dissatisfy the predicate are skipped. The function
199 has two arguments: the positions of start and end of text matched by
200 the search. If this function returns nil, continue searching without
201 stopping at this match.
202 If you use `add-function' to modify this variable, you can use the
203 `isearch-message-prefix' advice property to specify the prefix string
206 ;; Search ring.
214 "Maximum length of search ring before oldest elements are thrown away."
218 "Maximum length of regexp search ring before oldest elements are thrown away."
223 "Index in `search-ring' of last string reused.
226 "Index in `regexp-search-ring' of last string reused.
230 "Non-nil if advancing or retreating in the search ring should cause search.
231 Default value, nil, means edit the string instead."
235 ;;; isearch highlight customization.
238 "Non-nil means incremental search highlights the current match."
244 ;; The background must not be too dark, for that means
245 ;; the character is hard to see when the cursor is there.
254 "Face for highlighting Isearch matches."
271 "Face for highlighting failed part in Isearch echo-area message."
276 "Controls the lazy-highlighting during incremental search.
277 When non-nil, all text in the buffer matching the current search
278 string is highlighted lazily (see `lazy-highlight-initial-delay'
279 and `lazy-highlight-interval')."
284 ;;; Lazy highlight customization.
287 "Lazy highlighting feature for matching strings."
294 'lazy-highlight-cleanup
298 "Controls whether to remove extra highlighting after a search.
305 'lazy-highlight-initial-delay
309 "Seconds to wait before beginning to lazily highlight all matches."
314 'lazy-highlight-interval
318 "Seconds between lazily highlighting successive matches."
323 'lazy-highlight-max-at-a-time
327 "Maximum matches to highlight at a time (for `lazy-highlight').
328 Larger values may reduce Isearch's responsiveness to user input;
329 smaller values make matches highlight slowly.
330 A value of nil means highlight all matches."
345 "Face for lazy highlighting of matches other than the current one."
350 'lazy-highlight-face
353 \f
354 ;; Define isearch help map.
360 (define-key map [f1] 'isearch-help-for-help)
361 (define-key map "?" 'isearch-help-for-help)
362 (define-key map "b" 'isearch-describe-bindings)
363 (define-key map "k" 'isearch-describe-key)
364 (define-key map "m" 'isearch-describe-mode)
365 (define-key map "q" 'help-quit)
366 map)
367 "Keymap for characters following the Help key for Isearch mode.")
369 (eval-when-compile (require 'help-macro))
371 (make-help-screen isearch-help-for-help-internal
372 (purecopy "Type a help option: [bkm] or ?")
373 "You have typed %THIS-KEY%, the help character. Type a Help option:
376 b Display all Isearch key bindings.
377 k KEYS Display full documentation of Isearch key sequence.
378 m Display documentation of Isearch mode.
380 You can't type here other help keys available in the global help map,
381 but outside of this help window when you type them in Isearch mode,
382 they exit Isearch mode before displaying global help."
383 isearch-help-map)
385 (defvar isearch--display-help-action '(nil (inhibit-same-window . t)))
387 (defun isearch-help-for-help ()
388 "Display Isearch help menu."
389 (interactive)
390 (let ((display-buffer-overriding-action isearch--display-help-action))
391 (isearch-help-for-help-internal))
392 (isearch-update))
394 (defun isearch-describe-bindings ()
395 "Show a list of all keys defined in Isearch mode, and their definitions.
396 This is like `describe-bindings', but displays only Isearch keys."
397 (interactive)
398 (let ((display-buffer-overriding-action isearch--display-help-action))
399 (with-help-window "*Help*"
400 (with-current-buffer standard-output
404 (defun isearch-describe-key ()
405 "Display documentation of the function invoked by isearch key."
406 (interactive)
407 (let ((display-buffer-overriding-action isearch--display-help-action))
408 (call-interactively 'describe-key))
409 (isearch-update))
411 (defun isearch-describe-mode ()
412 "Display documentation of Isearch mode."
413 (interactive)
414 (let ((display-buffer-overriding-action isearch--display-help-action))
415 (describe-function 'isearch-forward))
416 (isearch-update))
418 (defalias 'isearch-mode-help 'isearch-describe-mode)
420 \f
421 ;; Define isearch-mode keymap.
423 (defvar isearch-mode-map
424 (let ((i 0)
425 (map (make-keymap)))
426 (or (char-table-p (nth 1 map))
427 (error "The initialization of isearch-mode-map must be updated"))
428 ;; Make all multibyte characters search for themselves.
429 (set-char-table-range (nth 1 map) (cons #x100 (max-char))
430 'isearch-printing-char)
432 ;; Single-byte printing chars extend the search string by default.
433 (setq i ?\s)
434 (while (< i 256)
435 (define-key map (vector i) 'isearch-printing-char)
436 (setq i (1+ i)))
438 ;; To handle local bindings with meta char prefix keys, define
439 ;; another full keymap. This must be done for any other prefix
440 ;; keys as well, one full keymap per char of the prefix key. It
441 ;; would be simpler to disable the global keymap, and/or have a
442 ;; default local key binding for any key not otherwise bound.
443 (let ((meta-map (make-sparse-keymap)))
444 (define-key map (char-to-string meta-prefix-char) meta-map))
446 ;; Several non-printing chars change the searching behavior.
447 (define-key map "\C-s" 'isearch-repeat-forward)
448 (define-key map "\C-r" 'isearch-repeat-backward)
449 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
450 ;; combinations can be used to repeat regexp isearches that can
451 ;; be used to start these searches.
452 (define-key map "\M-\C-s" 'isearch-repeat-forward)
453 (define-key map "\M-\C-r" 'isearch-repeat-backward)
455 (define-key map [backspace] 'undefined) ;bug#20466.
456 (define-key map "\C-g" 'isearch-abort)
458 ;; This assumes \e is the meta-prefix-char.
459 (or (= ?\e meta-prefix-char)
460 (error "Inconsistency in isearch.el"))
461 (define-key map "\e\e\e" 'isearch-cancel)
463 (define-key map "\C-q" 'isearch-quote-char)
466 (define-key map [return] 'isearch-exit)
467 (define-key map "\C-j" 'isearch-printing-char)
469 (define-key map [?\S-\ ] 'isearch-printing-char)
471 (define-key map "\C-w" 'isearch-yank-word-or-char)
472 (define-key map "\M-\C-w" 'isearch-del-char)
473 (define-key map "\M-\C-y" 'isearch-yank-char)
474 (define-key map "\C-y" 'isearch-yank-kill)
475 (define-key map "\M-s\C-e" 'isearch-yank-line)
477 (define-key map (char-to-string help-char) isearch-help-map)
481 (define-key map "\M-n" 'isearch-ring-advance)
482 (define-key map "\M-p" 'isearch-ring-retreat)
483 (define-key map "\M-y" 'isearch-yank-pop)
487 ;; Pass frame events transparently so they won't exit the search.
488 ;; In particular, if we have more than one display open, then a
489 ;; switch-frame might be generated by someone typing at another keyboard.
490 (define-key map [switch-frame] nil)
491 (define-key map [delete-frame] nil)
492 (define-key map [iconify-frame] nil)
493 (define-key map [make-frame-visible] nil)
494 (define-key map [mouse-movement] nil)
495 (define-key map [language-change] nil)
497 ;; For searching multilingual text.
499 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
501 ;; People expect to be able to paste with the mouse.
502 (define-key map [mouse-2] #'isearch-mouse-2)
503 (define-key map [down-mouse-2] nil)
505 ;; Some bindings you may want to put in your isearch-mode-hook.
506 ;; Suggest some alternates...
507 (define-key map "\M-c" 'isearch-toggle-case-fold)
508 (define-key map "\M-r" 'isearch-toggle-regexp)
509 (define-key map "\M-e" 'isearch-edit-string)
511 (put 'isearch-toggle-case-fold :advertised-binding "\M-sc")
512 (put 'isearch-toggle-regexp :advertised-binding "\M-sr")
513 (put 'isearch-edit-string :advertised-binding "\M-se")
515 (define-key map "\M-se" 'isearch-edit-string)
516 (define-key map "\M-sc" 'isearch-toggle-case-fold)
517 (define-key map "\M-si" 'isearch-toggle-invisible)
518 (define-key map "\M-sr" 'isearch-toggle-regexp)
519 (define-key map "\M-sw" 'isearch-toggle-word)
520 (define-key map "\M-s_" 'isearch-toggle-symbol)
521 (define-key map "\M-s " 'isearch-toggle-lax-whitespace)
522 (define-key map "\M-s'" #'isearch-toggle-character-fold)
524 (define-key map [?\M-%] 'isearch-query-replace)
525 (define-key map [?\C-\M-%] 'isearch-query-replace-regexp)
526 (define-key map "\M-so" 'isearch-occur)
527 (define-key map "\M-shr" 'isearch-highlight-regexp)
529 ;; The key translations defined in the C-x 8 prefix should add
530 ;; characters to the search string. See iso-transl.el.
533 map)
534 "Keymap for `isearch-mode'.")
536 (defvar minibuffer-local-isearch-map
537 (let ((map (make-sparse-keymap)))
538 (set-keymap-parent map minibuffer-local-map)
541 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
542 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
543 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
544 (define-key map [right] 'isearch-yank-char-in-minibuffer)
545 map)
546 "Keymap for editing Isearch strings in the minibuffer.")
548 ;; Internal variables declared globally for byte-compiler.
549 ;; These are all set with setq while isearching
550 ;; and bound locally while editing the search string.
552 (defvar isearch-forward nil) ; Searching in the forward direction.
553 (defvar isearch-regexp nil) ; Searching for a regexp.
554 (defvar isearch-word nil
555 "Regexp-based search mode for words/symbols.
556 If t, do incremental search for a sequence of words, ignoring punctuation.
557 If the value is a function (e.g. `isearch-symbol-regexp'), it is called to
558 convert the search string to a regexp used by regexp search functions.
559 The property `isearch-message-prefix' put on this function specifies the
560 prefix string displayed in the search message.")
562 (defvar isearch-lax-whitespace t
563 "If non-nil, a space will match a sequence of whitespace chars.
564 When you enter a space or spaces in ordinary incremental search, it
565 will match any sequence matched by the regexp defined by the variable
566 `search-whitespace-regexp'. If the value is nil, each space you type
567 matches literally, against one space. You can toggle the value of this
568 variable by the command `isearch-toggle-lax-whitespace'.")
570 (defvar isearch-regexp-lax-whitespace nil
571 "If non-nil, a space will match a sequence of whitespace chars.
572 When you enter a space or spaces in regexp incremental search, it
573 will match any sequence matched by the regexp defined by the variable
574 `search-whitespace-regexp'. If the value is nil, each space you type
575 matches literally, against one space. You can toggle the value of this
576 variable by the command `isearch-toggle-lax-whitespace'.")
578 (defvar isearch-cmds nil
579 "Stack of search status elements.
580 Each element is an `isearch--state' struct where the slots are
581 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
582 ERROR WRAPPED BARRIER CASE-FOLD-SEARCH]")
584 (defvar isearch-string "") ; The current search string.
585 (defvar isearch-message "") ; text-char-description version of isearch-string
587 (defvar isearch-message-prefix-add nil) ; Additional text for the message prefix
588 (defvar isearch-message-suffix-add nil) ; Additional text for the message suffix
590 (defvar isearch-success t) ; Searching is currently successful.
591 (defvar isearch-error nil) ; Error message for failed search.
592 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
593 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
594 (defvar isearch-barrier 0
595 "Recorded minimum/maximal point for the current search.")
596 (defvar isearch-just-started nil)
597 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
599 ;; case-fold-search while searching.
600 ;; either nil, t, or 'yes. 'yes means the same as t except that mixed
601 ;; case in the search string is ignored.
602 (defvar isearch-case-fold-search nil)
604 ;; search-invisible while searching.
605 ;; either nil, t, or 'open. 'open means the same as t except that
606 ;; opens hidden overlays.
607 (defvar isearch-invisible search-invisible)
609 (defvar isearch-last-case-fold-search nil)
611 ;; Used to save default value while isearch is active
612 (defvar isearch-original-minibuffer-message-timeout nil)
614 (defvar isearch-adjusted nil)
615 (defvar isearch-slow-terminal-mode nil)
616 ;; If t, using a small window.
617 (defvar isearch-small-window nil)
618 (defvar isearch-opoint 0)
619 ;; The window configuration active at the beginning of the search.
620 (defvar isearch-window-configuration nil)
622 ;; Flag to indicate a yank occurred, so don't move the cursor.
623 (defvar isearch-yank-flag nil)
625 ;; A function to be called after each input character is processed.
626 ;; (It is not called after characters that exit the search.)
627 ;; It is only set from an optional argument to `isearch-mode'.
628 (defvar isearch-op-fun nil)
630 ;; Is isearch-mode in a recursive edit for modal searching.
631 (defvar isearch-recursive-edit nil)
633 ;; Should isearch be terminated after doing one search?
634 (defvar isearch-nonincremental nil)
636 ;; New value of isearch-forward after isearch-edit-string.
637 (defvar isearch-new-forward nil)
639 ;; Accumulate here the overlays opened during searching.
640 (defvar isearch-opened-overlays nil)
642 ;; Non-nil if the string exists but is invisible.
643 (defvar isearch-hidden nil)
645 ;; The value of input-method-function when isearch is invoked.
646 (defvar isearch-input-method-function nil)
648 ;; A flag to tell if input-method-function is locally bound when
649 ;; isearch is invoked.
650 (defvar isearch-input-method-local-p nil)
652 (defvar isearch--saved-overriding-local-map nil)
654 ;; Minor-mode-alist changes - kind of redundant with the
655 ;; echo area, but if isearching in multiple windows, it can be useful.
657 (or (assq 'isearch-mode minor-mode-alist)
658 (nconc minor-mode-alist
659 (list '(isearch-mode isearch-mode))))
661 (defvar-local isearch-mode nil) ;; Name of the minor mode, if non-nil.
663 (define-key global-map "\C-s" 'isearch-forward)
664 (define-key esc-map "\C-s" 'isearch-forward-regexp)
665 (define-key global-map "\C-r" 'isearch-backward)
666 (define-key esc-map "\C-r" 'isearch-backward-regexp)
667 (define-key search-map "w" 'isearch-forward-word)
668 (define-key search-map "_" 'isearch-forward-symbol)
669 (define-key search-map "." 'isearch-forward-symbol-at-point)
671 ;; Entry points to isearch-mode.
673 (defun isearch-forward (&optional regexp-p no-recursive-edit)
674 "\
675 Do incremental search forward.
676 With a prefix argument, do an incremental regular expression search instead.
678 As you type characters, they add to the search string and are found.
679 The following non-printing keys are bound in `isearch-mode-map'.
683 Type LFD (C-j) to match end of line.
687 onto the end of the search string, and search for it.
690 string and search for it.
692 and search for it.
695 with string killed before it.
698 with completion.
700 back to what has
701 been found successfully.
703 starting point.
705 If you try to exit with the search string still empty, it invokes
706 nonincremental search.
716 In incremental searches, a space or spaces normally matches any whitespace
717 defined by the variable `search-whitespace-regexp'; see also the variables
718 `isearch-lax-whitespace' and `isearch-regexp-lax-whitespace'.
722 Also supported is a search ring of the previous 16 search strings.
725 ring.
729 replace from last search string.
731 with the last search string.
733 the last search string.
735 that highlights the last search string.
741 If an input method is turned on in the current buffer, that input
742 method is also active while you are typing characters to search.
744 It also toggles the input
745 method in the current buffer.
747 To use a different input method for searching, type \
749 and specify an input method you want to use.
751 The above keys, bound in `isearch-mode-map', are often controlled by
753 Other control and meta characters terminate the search
754 and are then executed normally (depending on `search-exit-option').
755 Likewise for function keys and mouse button events.
757 If this function is called non-interactively with a nil NO-RECURSIVE-EDIT,
758 it does not return to the calling function until the search is done.
759 See the function `isearch-mode' for more information."
762 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
764 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
765 "Do incremental search forward for regular expression.
766 With a prefix argument, do a regular string search instead.
767 Like ordinary incremental search except that your input is treated
768 as a regexp. See the command `isearch-forward' for more information.
770 In incremental searches, a space or spaces normally matches any
771 whitespace defined by the variable `search-whitespace-regexp'.
772 To search for a literal space and nothing else, enter C-q SPC.
773 To toggle whitespace matching, use `isearch-toggle-lax-whitespace'."
775 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
777 (defun isearch-forward-word (&optional not-word no-recursive-edit)
778 "Do incremental search forward for a sequence of words.
779 With a prefix argument, do a regular string search instead.
780 Like ordinary incremental search except that your input is treated
781 as a sequence of words without regard to how the words are separated.
782 See the command `isearch-forward' for more information."
784 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
786 (defun isearch-forward-symbol (&optional _not-symbol no-recursive-edit)
787 "Do incremental search forward for a symbol.
788 The prefix argument is currently unused.
789 Like ordinary incremental search except that your input is treated
791 See the command `isearch-forward' for more information."
793 (isearch-mode t nil nil (not no-recursive-edit) 'isearch-symbol-regexp))
795 (defun isearch-backward (&optional regexp-p no-recursive-edit)
796 "Do incremental search backward.
797 With a prefix argument, do a regular expression search instead.
798 See the command `isearch-forward' for more information."
800 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
802 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
803 "Do incremental search backward for regular expression.
804 With a prefix argument, do a regular string search instead.
805 Like ordinary incremental search except that your input is treated
806 as a regexp. See the command `isearch-forward' for more information."
808 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
810 (defun isearch-forward-symbol-at-point ()
811 "Do incremental search forward for a symbol found near point.
812 Like ordinary incremental search except that the symbol found at point
813 is added to the search string initially as a regexp surrounded
815 See the command `isearch-forward-symbol' for more information."
816 (interactive)
817 (isearch-forward-symbol nil 1)
818 (let ((bounds (find-tag-default-bounds)))
819 (cond
820 (bounds
821 (when (< (car bounds) (point))
822 (goto-char (car bounds)))
823 (isearch-yank-string
824 (buffer-substring-no-properties (car bounds) (cdr bounds))))
825 (t
826 (setq isearch-error "No symbol at point")
827 (isearch-update)))))
829 \f
830 (defvar cursor-sensor-inhibit)
831 ;; isearch-mode only sets up incremental search for the minor mode.
832 ;; All the work is done by the isearch-mode commands.
834 ;; Not used yet:
835 ;;(defvar isearch-commands '(isearch-forward isearch-backward
836 ;; isearch-forward-regexp isearch-backward-regexp)
837 ;; "List of commands for which isearch-mode does not recursive-edit.")
839 (autoload 'character-fold-to-regexp "character-fold")
840 (put 'character-fold-to-regexp 'isearch-message-prefix "char-fold ")
841 (defvar character-fold-search)
843 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word)
844 "Start Isearch minor mode.
845 It is called by the function `isearch-forward' and other related functions.
847 The non-nil arg FORWARD means searching in the forward direction.
849 The non-nil arg REGEXP does an incremental regular expression search.
851 The arg OP-FUN is a function to be called after each input character
852 is processed. (It is not called after characters that exit the search.)
854 When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and
855 does not return to the calling function until the search is completed.
856 To behave this way it enters a recursive-edit and exits it when done
857 isearching.
859 The arg WORD, if t, does incremental search for a sequence of words,
860 ignoring punctuation. If the value is a function, it is called to
861 convert the search string to a regexp used by regexp search functions."
863 ;; Initialize global vars.
864 (setq isearch-forward forward
865 isearch-regexp regexp
866 isearch-word (or word (and character-fold-search
867 (not regexp)
868 'character-fold-to-regexp))
869 isearch-op-fun op-fun
870 isearch-last-case-fold-search isearch-case-fold-search
871 isearch-case-fold-search case-fold-search
872 isearch-invisible search-invisible
873 isearch-string ""
874 isearch-message ""
875 isearch-cmds nil
876 isearch-success t
877 isearch-wrapped nil
878 isearch-barrier (point)
879 isearch-adjusted nil
880 isearch-yank-flag nil
881 isearch-error nil
882 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
883 (> (window-height)
884 (* 4
885 (abs search-slow-window-lines))))
886 isearch-other-end nil
887 isearch-small-window nil
888 isearch-just-started t
889 isearch-start-hscroll (window-hscroll)
891 isearch-opoint (point)
892 search-ring-yank-pointer nil
893 isearch-opened-overlays nil
894 isearch-input-method-function input-method-function
895 isearch-input-method-local-p (local-variable-p 'input-method-function)
896 regexp-search-ring-yank-pointer nil
898 ;; Save the original value of `minibuffer-message-timeout', and
899 ;; set it to nil so that isearch's messages don't get timed out.
900 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
901 minibuffer-message-timeout nil)
903 ;; We must bypass input method while reading key. When a user type
904 ;; printable character, appropriate input method is turned on in
905 ;; minibuffer to read multibyte characters.
906 (or isearch-input-method-local-p
907 (make-local-variable 'input-method-function))
908 (setq input-method-function nil)
910 (looking-at "")
911 (setq isearch-window-configuration
912 (if isearch-slow-terminal-mode (current-window-configuration) nil))
914 ;; Maybe make minibuffer frame visible and/or raise it.
915 (let ((frame (window-frame (minibuffer-window))))
916 (unless (memq (frame-live-p frame) '(nil t))
917 (unless (frame-visible-p frame)
918 (make-frame-visible frame))
919 (if minibuffer-auto-raise
920 (raise-frame frame))))
922 (setq isearch-mode " Isearch") ;; forward? regexp?
923 (force-mode-line-update)
925 (setq overriding-terminal-local-map isearch-mode-map)
926 (run-hooks 'isearch-mode-hook)
927 ;; Remember the initial map possibly modified
928 ;; by external packages in isearch-mode-hook. (Bug#16035)
929 (setq isearch--saved-overriding-local-map overriding-terminal-local-map)
931 ;; Pushing the initial state used to be before running isearch-mode-hook,
932 ;; but a hook might set `isearch-push-state-function' used in
933 ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994)
934 (isearch-push-state)
936 (isearch-update)
938 (add-hook 'pre-command-hook 'isearch-pre-command-hook)
939 (add-hook 'post-command-hook 'isearch-post-command-hook)
940 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
941 (add-hook 'kbd-macro-termination-hook 'isearch-done)
943 ;; isearch-mode can be made modal (in the sense of not returning to
944 ;; the calling function until searching is completed) by entering
945 ;; a recursive-edit and exiting it when done isearching.
946 (if recursive-edit
947 (let ((isearch-recursive-edit t))
948 (recursive-edit)))
949 isearch-success)
952 ;; Some high level utilities. Others below.
953 (defvar isearch--current-buffer nil)
955 (defun isearch-update ()
956 "This is called after every isearch command to update the display.
957 The last thing it does is to run `isearch-update-post-hook'."
958 (unless (eq (current-buffer) isearch--current-buffer)
959 (when isearch--current-buffer
960 (with-current-buffer isearch--current-buffer
961 (setq cursor-sensor-inhibit (delq 'isearch cursor-sensor-inhibit))))
962 (setq isearch--current-buffer (current-buffer))
963 (make-local-variable 'cursor-sensor-inhibit)
964 (unless (boundp 'cursor-sensor-inhibit)
965 (setq cursor-sensor-inhibit nil))
966 ;; Suspend things like cursor-intangible during Isearch so we can search
967 ;; even within intangible text.
968 (push 'isearch cursor-sensor-inhibit))
970 (if (and (null unread-command-events)
971 (null executing-kbd-macro))
972 (progn
973 (if (not (input-pending-p))
974 (if isearch-message-function
975 (funcall isearch-message-function)
976 (isearch-message)))
977 (if (and isearch-slow-terminal-mode
978 (not (or isearch-small-window
979 (pos-visible-in-window-p))))
980 (let ((found-point (point)))
981 (setq isearch-small-window t)
982 (move-to-window-line 0)
983 (let ((window-min-height 1))
984 (split-window nil (if (< search-slow-window-lines 0)
985 (1+ (- search-slow-window-lines))
986 (- (window-height)
987 (1+ search-slow-window-lines)))))
988 (if (< search-slow-window-lines 0)
989 (progn (vertical-motion (- 1 search-slow-window-lines))
990 (set-window-start (next-window) (point))
991 (set-window-hscroll (next-window)
992 (window-hscroll))
993 (set-window-hscroll (selected-window) 0))
994 (other-window 1))
995 (goto-char found-point))
996 ;; Keep same hscrolling as at the start of the search when possible
997 (let ((current-scroll (window-hscroll))
998 visible-p)
999 (set-window-hscroll (selected-window) isearch-start-hscroll)
1000 (setq visible-p (pos-visible-in-window-p nil nil t))
1001 (if (or (not visible-p)
1002 ;; When point is not visible because of hscroll,
1003 ;; pos-visible-in-window-p returns non-nil, but
1004 ;; the X coordinate it returns is 1 pixel beyond
1005 ;; the last visible one.
1006 (>= (car visible-p) (window-body-width nil t)))
1007 (set-window-hscroll (selected-window) current-scroll))))
1008 (if isearch-other-end
1009 (if (< isearch-other-end (point)) ; isearch-forward?
1010 (isearch-highlight isearch-other-end (point))
1011 (isearch-highlight (point) isearch-other-end))
1012 (isearch-dehighlight))))
1013 (setq ;; quit-flag nil not for isearch-mode
1014 isearch-adjusted nil
1015 isearch-yank-flag nil)
1016 (when isearch-lazy-highlight
1017 (isearch-lazy-highlight-new-loop))
1018 ;; We must prevent the point moving to the end of composition when a
1019 ;; part of the composition has just been searched.
1020 (setq disable-point-adjustment t)
1021 (run-hooks 'isearch-update-post-hook))
1023 (defun isearch-done (&optional nopush edit)
1024 "Exit Isearch mode.
1025 For successful search, pass no args.
1026 For a failing search, NOPUSH is t.
1027 For going to the minibuffer to edit the search string,
1028 NOPUSH is t and EDIT is t."
1030 (if isearch-resume-in-command-history
1031 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
1032 ,isearch-word ,isearch-forward
1033 ,isearch-message
1034 ',isearch-case-fold-search)))
1035 (unless (equal (car command-history) command)
1036 (setq command-history (cons command command-history)))))
1038 (remove-hook 'pre-command-hook 'isearch-pre-command-hook)
1039 (remove-hook 'post-command-hook 'isearch-post-command-hook)
1040 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
1041 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
1042 (setq isearch-lazy-highlight-start nil)
1043 (with-current-buffer isearch--current-buffer
1044 (setq isearch--current-buffer nil)
1045 (setq cursor-sensor-inhibit (delq 'isearch cursor-sensor-inhibit)))
1047 ;; Called by all commands that terminate isearch-mode.
1048 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
1049 (setq overriding-terminal-local-map nil)
1050 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
1051 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
1052 (isearch-dehighlight)
1053 (lazy-highlight-cleanup lazy-highlight-cleanup)
1054 (let ((found-start (window-start))
1055 (found-point (point)))
1056 (when isearch-window-configuration
1057 (set-window-configuration isearch-window-configuration)
1058 (if isearch-small-window
1059 (goto-char found-point)
1060 ;; set-window-configuration clobbers window-start; restore it.
1061 ;; This has an annoying side effect of clearing the last_modiff
1062 ;; field of the window, which can cause unwanted scrolling,
1063 ;; so don't do it unless truly necessary.
1064 (set-window-start (selected-window) found-start t))))
1066 (setq isearch-mode nil)
1067 (if isearch-input-method-local-p
1068 (setq input-method-function isearch-input-method-function)
1069 (kill-local-variable 'input-method-function))
1071 (force-mode-line-update)
1073 ;; If we ended in the middle of some intangible text,
1074 ;; move to the further end of that intangible text.
1075 (let ((after (if (eobp) nil
1076 (get-text-property (point) 'intangible)))
1077 (before (if (bobp) nil
1078 (get-text-property (1- (point)) 'intangible))))
1079 (when (and before after (eq before after))
1080 (goto-char
1081 (if isearch-forward
1082 (next-single-property-change (point) 'intangible)
1083 (previous-single-property-change (point) 'intangible)))))
1085 (if (and (> (length isearch-string) 0) (not nopush))
1086 ;; Update the ring data.
1087 (isearch-update-ring isearch-string isearch-regexp))
1089 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
1090 (run-hooks 'isearch-mode-end-hook))
1092 ;; If there was movement, mark the starting position.
1093 ;; Maybe should test difference between and set mark only if > threshold.
1094 (if (/= (point) isearch-opoint)
1095 (or (and transient-mark-mode mark-active)
1096 (progn
1097 (push-mark isearch-opoint t)
1098 (or executing-kbd-macro (> (minibuffer-depth) 0) edit
1099 (message "Mark saved where search started")))))
1101 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
1103 (defun isearch-update-ring (string &optional regexp)
1104 "Add STRING to the beginning of the search ring.
1105 REGEXP if non-nil says use the regexp search ring."
1106 (add-to-history
1107 (if regexp 'regexp-search-ring 'search-ring)
1108 string
1109 (if regexp regexp-search-ring-max search-ring-max)))
1111 ;; Switching buffers should first terminate isearch-mode.
1112 ;; ;; For Emacs 19, the frame switch event is handled.
1113 ;; (defun isearch-switch-frame-handler ()
1114 ;; (interactive) ;; Is this necessary?
1115 ;; ;; First terminate isearch-mode.
1116 ;; (isearch-done)
1117 ;; (isearch-clean-overlays)
1118 ;; (handle-switch-frame (car (cdr last-command-event))))
1120 \f
1121 ;; The search status structure and stack.
1123 (cl-defstruct (isearch--state
1124 (:constructor nil)
1125 (:copier nil)
1126 (:constructor isearch--get-state
1127 (&aux
1128 (string isearch-string)
1129 (message isearch-message)
1130 (point (point))
1131 (success isearch-success)
1132 (forward isearch-forward)
1133 (other-end isearch-other-end)
1134 (word isearch-word)
1135 (error isearch-error)
1136 (wrapped isearch-wrapped)
1137 (barrier isearch-barrier)
1138 (case-fold-search isearch-case-fold-search)
1139 (pop-fun (if isearch-push-state-function
1140 (funcall isearch-push-state-function))))))
1141 (string :read-only t)
1142 (message :read-only t)
1143 (point :read-only t)
1144 (success :read-only t)
1145 (forward :read-only t)
1146 (other-end :read-only t)
1147 (word :read-only t)
1148 (error :read-only t)
1149 (wrapped :read-only t)
1150 (barrier :read-only t)
1151 (case-fold-search :read-only t)
1152 (pop-fun :read-only t))
1154 (defun isearch--set-state (cmd)
1155 (setq isearch-string (isearch--state-string cmd)
1156 isearch-message (isearch--state-message cmd)
1157 isearch-success (isearch--state-success cmd)
1158 isearch-forward (isearch--state-forward cmd)
1159 isearch-other-end (isearch--state-other-end cmd)
1160 isearch-word (isearch--state-word cmd)
1161 isearch-error (isearch--state-error cmd)
1162 isearch-wrapped (isearch--state-wrapped cmd)
1163 isearch-barrier (isearch--state-barrier cmd)
1164 isearch-case-fold-search (isearch--state-case-fold-search cmd))
1165 (if (functionp (isearch--state-pop-fun cmd))
1166 (funcall (isearch--state-pop-fun cmd) cmd))
1167 (goto-char (isearch--state-point cmd)))
1169 (defun isearch-pop-state ()
1170 (setq isearch-cmds (cdr isearch-cmds))
1171 (isearch--set-state (car isearch-cmds)))
1173 (defun isearch-push-state ()
1174 (push (isearch--get-state) isearch-cmds))
1176 \f
1177 ;; Commands active while inside of the isearch minor mode.
1179 (defun isearch-exit ()
1180 "Exit search normally.
1181 However, if this is the first command after starting incremental
1182 search and `search-nonincremental-instead' is non-nil, do a
1183 nonincremental search instead via `isearch-edit-string'."
1184 (interactive)
1185 (if (and search-nonincremental-instead
1186 (= 0 (length isearch-string)))
1187 (let ((isearch-nonincremental t))
1188 (isearch-edit-string)) ;; this calls isearch-done as well
1189 (isearch-done))
1190 (isearch-clean-overlays))
1192 (defun isearch-fail-pos (&optional msg)
1193 "Return position of first mismatch in search string, or nil if none.
1194 If MSG is non-nil, use variable `isearch-message', otherwise `isearch-string'."
1195 (let ((cmds isearch-cmds)
1196 (curr-msg (if msg isearch-message isearch-string))
1197 succ-msg)
1198 (when (or (not isearch-success) isearch-error)
1199 (while (and cmds
1200 (or (not (isearch--state-success (car cmds)))
1201 (isearch--state-error (car cmds))))
1202 (pop cmds))
1203 (setq succ-msg (and cmds (if msg (isearch--state-message (car cmds))
1204 (isearch--state-string (car cmds)))))
1205 (if (and (stringp succ-msg)
1206 (< (length succ-msg) (length curr-msg))
1207 (equal succ-msg
1208 (substring curr-msg 0 (length succ-msg))))
1209 (length succ-msg)
1210 0))))
1212 (defmacro with-isearch-suspended (&rest body)
1213 "Exit Isearch mode, run BODY, and reinvoke the pending search.
1214 You can update the global isearch variables by setting new values to
1215 `isearch-new-string', `isearch-new-message', `isearch-new-forward',
1216 `isearch-new-word', `isearch-new-case-fold'."
1217 ;; This code is very hairy for several reasons, explained in the code.
1218 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1219 ;; If there were a way to catch any change of buffer from the minibuffer,
1220 ;; this could be simplified greatly.
1221 ;; Editing doesn't back up the search point. Should it?
1222 `(condition-case nil
1223 (progn
1224 (let ((isearch-nonincremental isearch-nonincremental)
1226 ;; Locally bind all isearch global variables to protect them
1227 ;; from recursive isearching.
1228 ;; isearch-string -message and -forward are not bound
1229 ;; so they may be changed. Instead, save the values.
1230 (isearch-new-string isearch-string)
1231 (isearch-new-message isearch-message)
1232 (isearch-new-forward isearch-forward)
1233 (isearch-new-word isearch-word)
1234 (isearch-new-case-fold isearch-case-fold-search)
1236 (isearch-regexp isearch-regexp)
1237 (isearch-op-fun isearch-op-fun)
1238 (isearch-cmds isearch-cmds)
1239 (isearch-success isearch-success)
1240 (isearch-wrapped isearch-wrapped)
1241 (isearch-barrier isearch-barrier)
1242 (isearch-adjusted isearch-adjusted)
1243 (isearch-yank-flag isearch-yank-flag)
1244 (isearch-error isearch-error)
1245 ;;; Don't bind this. We want isearch-search, below, to set it.
1246 ;;; And the old value won't matter after that.
1247 ;;; (isearch-other-end isearch-other-end)
1248 ;;; Perhaps some of these other variables should be bound for a
1249 ;;; shorter period, ending before the next isearch-search.
1250 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1251 (isearch-opoint isearch-opoint)
1252 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1253 (isearch-small-window isearch-small-window)
1254 (isearch-recursive-edit isearch-recursive-edit)
1255 ;; Save current configuration so we can restore it here.
1256 (isearch-window-configuration (current-window-configuration))
1258 ;; This could protect the index of the search rings,
1259 ;; but we can't reliably count the number of typed M-p
1260 ;; in `read-from-minibuffer' to adjust the index accordingly.
1261 ;; So when the following is commented out, `isearch-mode'
1262 ;; below resets the index to the predictable value nil.
1263 ;; (search-ring-yank-pointer search-ring-yank-pointer)
1264 ;; (regexp-search-ring-yank-pointer regexp-search-ring-yank-pointer)
1266 ;; Temporarily restore `minibuffer-message-timeout'.
1267 (minibuffer-message-timeout
1268 isearch-original-minibuffer-message-timeout)
1269 (isearch-original-minibuffer-message-timeout
1270 isearch-original-minibuffer-message-timeout)
1271 old-point old-other-end)
1273 ;; Actually terminate isearching until editing is done.
1274 ;; This is so that the user can do anything without failure,
1275 ;; like switch buffers and start another isearch, and return.
1276 (condition-case nil
1277 (isearch-done t t)
1278 (exit nil)) ; was recursive editing
1280 ;; Save old point and isearch-other-end before reading from minibuffer
1281 ;; that can change their values.
1282 (setq old-point (point) old-other-end isearch-other-end)
1284 (unwind-protect
1285 (progn ,@body)
1287 ;; Set point at the start (end) of old match if forward (backward),
1288 ;; so after exiting minibuffer isearch resumes at the start (end)
1289 ;; of this match and can find it again.
1290 (if (and old-other-end (eq old-point (point))
1291 (eq isearch-forward isearch-new-forward))
1292 (goto-char old-other-end))
1294 ;; Always resume isearching by restarting it.
1295 (isearch-mode isearch-forward
1296 isearch-regexp
1297 isearch-op-fun
1298 nil
1299 isearch-word)
1301 ;; Copy new local values to isearch globals
1302 (setq isearch-string isearch-new-string
1303 isearch-message isearch-new-message
1304 isearch-forward isearch-new-forward
1305 isearch-word isearch-new-word
1306 isearch-case-fold-search isearch-new-case-fold))
1308 ;; Empty isearch-string means use default.
1309 (when (= 0 (length isearch-string))
1310 (setq isearch-string (or (car (if isearch-regexp
1311 regexp-search-ring
1312 search-ring))
1313 "")
1315 isearch-message
1316 (mapconcat 'isearch-text-char-description
1317 isearch-string ""))
1318 ;; After taking the last element, adjust ring to previous one.
1319 (isearch-ring-adjust1 nil)))
1321 ;; This used to push the state as of before this C-s, but it adds
1322 ;; an inconsistent state where part of variables are from the
1323 ;; previous search (e.g. `isearch-success'), and part of variables
1324 ;; are just entered from the minibuffer (e.g. `isearch-string').
1325 ;; (isearch-push-state)
1327 ;; Reinvoke the pending search.
1328 (isearch-search)
1329 (isearch-push-state) ; this pushes the correct state
1330 (isearch-update)
1331 (if isearch-nonincremental
1332 (progn
1333 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1334 (isearch-done)
1335 ;; The search done message is confusing when the string
1336 ;; is empty, so erase it.
1337 (if (equal isearch-string "")
1338 (message "")))))
1340 (quit ; handle abort-recursive-edit
1341 (isearch-abort) ;; outside of let to restore outside global values
1342 )))
1344 (defvar minibuffer-history-symbol) ;; from external package gmhist.el
1346 (defun isearch-edit-string ()
1347 "Edit the search string in the minibuffer.
1348 The following additional command keys are active while editing.
1354 (interactive)
1355 (with-isearch-suspended
1356 (let* ((message-log-max nil)
1357 ;; Don't add a new search string to the search ring here
1358 ;; in `read-from-minibuffer'. It should be added only
1359 ;; by `isearch-update-ring' called from `isearch-done'.
1360 (history-add-new-input nil)
1361 ;; Binding minibuffer-history-symbol to nil is a work-around
1362 ;; for some incompatibility with gmhist.
1363 (minibuffer-history-symbol))
1364 (setq isearch-new-string
1365 (read-from-minibuffer
1366 (isearch-message-prefix nil isearch-nonincremental)
1367 (cons isearch-string (1+ (or (isearch-fail-pos)
1368 (length isearch-string))))
1369 minibuffer-local-isearch-map nil
1370 (if isearch-regexp
1371 (cons 'regexp-search-ring
1372 (1+ (or regexp-search-ring-yank-pointer -1)))
1373 (cons 'search-ring
1374 (1+ (or search-ring-yank-pointer -1))))
1375 nil t)
1376 isearch-new-message
1377 (mapconcat 'isearch-text-char-description
1378 isearch-new-string "")))))
1380 (defun isearch-nonincremental-exit-minibuffer ()
1381 (interactive)
1382 (setq isearch-nonincremental t)
1383 (exit-minibuffer))
1384 ;; Changing the value of `isearch-nonincremental' has no effect here,
1385 ;; because `isearch-edit-string' ignores this change. Thus marked as obsolete.
1386 (make-obsolete 'isearch-nonincremental-exit-minibuffer 'exit-minibuffer "24.4")
1388 (defun isearch-forward-exit-minibuffer ()
1389 "Resume isearching forward from the minibuffer that edits the search string."
1390 (interactive)
1391 (setq isearch-new-forward t)
1392 (exit-minibuffer))
1394 (defun isearch-reverse-exit-minibuffer ()
1395 "Resume isearching backward from the minibuffer that edits the search string."
1396 (interactive)
1397 (setq isearch-new-forward nil)
1398 (exit-minibuffer))
1400 (defun isearch-cancel ()
1401 "Terminate the search and go back to the starting point."
1402 (interactive)
1403 (if (and isearch-push-state-function isearch-cmds)
1404 ;; For defined push-state function, restore the first state.
1405 ;; This calls pop-state function and restores original point.
1406 (let ((isearch-cmds (last isearch-cmds)))
1407 (isearch--set-state (car isearch-cmds)))
1408 (goto-char isearch-opoint))
1409 (isearch-done t) ; Exit isearch..
1410 (isearch-clean-overlays)
1411 (signal 'quit nil)) ; ..and pass on quit signal.
1413 (defun isearch-abort ()
1414 "Abort incremental search mode if searching is successful, signaling quit.
1415 Otherwise, revert to previous successful search and continue searching.
1416 Use `isearch-exit' to quit without signaling."
1417 (interactive)
1418 ;; (ding) signal instead below, if quitting
1419 (discard-input)
1420 (if (and isearch-success (not isearch-error))
1421 ;; If search is successful and has no incomplete regexp,
1422 ;; move back to starting point and really do quit.
1423 (progn
1424 (setq isearch-success nil)
1425 (isearch-cancel))
1426 ;; If search is failing, or has an incomplete regexp,
1427 ;; rub out until it is once more successful.
1428 (while (or (not isearch-success) isearch-error)
1429 (isearch-pop-state))
1430 (isearch-update)))
1432 (defun isearch-repeat (direction)
1433 ;; Utility for isearch-repeat-forward and -backward.
1434 (if (eq isearch-forward (eq direction 'forward))
1435 ;; C-s in forward or C-r in reverse.
1436 (if (equal isearch-string "")
1437 ;; If search string is empty, use last one.
1438 (if (null (if isearch-regexp regexp-search-ring search-ring))
1439 (setq isearch-error "No previous search string")
1440 (setq isearch-string
1441 (car (if isearch-regexp regexp-search-ring search-ring))
1442 isearch-message
1443 (mapconcat 'isearch-text-char-description
1444 isearch-string "")
1445 isearch-case-fold-search isearch-last-case-fold-search)
1446 ;; After taking the last element, adjust ring to previous one.
1447 (isearch-ring-adjust1 nil))
1448 ;; If already have what to search for, repeat it.
1449 (or isearch-success
1450 (progn
1451 ;; Set isearch-wrapped before calling isearch-wrap-function
1452 (setq isearch-wrapped t)
1453 (if isearch-wrap-function
1454 (funcall isearch-wrap-function)
1455 (goto-char (if isearch-forward (point-min) (point-max)))))))
1456 ;; C-s in reverse or C-r in forward, change direction.
1457 (setq isearch-forward (not isearch-forward)
1458 isearch-success t))
1460 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1462 (if (equal isearch-string "")
1463 (setq isearch-success t)
1464 (if (and isearch-success
1465 (equal (point) isearch-other-end)
1466 (not isearch-just-started))
1467 ;; If repeating a search that found
1468 ;; an empty string, ensure we advance.
1469 (if (if isearch-forward (eobp) (bobp))
1470 ;; If there's nowhere to advance to, fail (and wrap next time).
1471 (progn
1472 (setq isearch-success nil)
1473 (ding))
1474 (forward-char (if isearch-forward 1 -1))
1475 (isearch-search))
1476 (isearch-search)))
1478 (isearch-push-state)
1479 (isearch-update))
1481 (defun isearch-repeat-forward ()
1482 "Repeat incremental search forwards."
1483 (interactive)
1484 (isearch-repeat 'forward))
1486 (defun isearch-repeat-backward ()
1487 "Repeat incremental search backwards."
1488 (interactive)
1489 (isearch-repeat 'backward))
1491 (defun isearch-toggle-regexp ()
1492 "Toggle regexp searching on or off."
1493 ;; The status stack is left unchanged.
1494 (interactive)
1495 (setq isearch-regexp (not isearch-regexp))
1496 (if isearch-regexp (setq isearch-word nil))
1497 (setq isearch-success t isearch-adjusted t)
1498 (isearch-update))
1500 (defun isearch-toggle-word ()
1501 "Toggle word searching on or off."
1502 ;; The status stack is left unchanged.
1503 (interactive)
1504 (setq isearch-word (if (eq isearch-word t) nil t))
1505 (if isearch-word (setq isearch-regexp nil))
1506 (setq isearch-success t isearch-adjusted t)
1507 (isearch-update))
1509 (defun isearch-toggle-symbol ()
1510 "Toggle symbol searching on or off."
1511 (interactive)
1512 (setq isearch-word (unless (eq isearch-word 'isearch-symbol-regexp)
1513 'isearch-symbol-regexp))
1514 (if isearch-word (setq isearch-regexp nil))
1515 (setq isearch-success t isearch-adjusted t)
1516 (isearch-update))
1518 (defun isearch-toggle-character-fold ()
1519 "Toggle character folding in searching on or off."
1520 (interactive)
1521 (setq isearch-word (unless (eq isearch-word #'character-fold-to-regexp)
1522 #'character-fold-to-regexp))
1523 (if isearch-word (setq isearch-regexp nil))
1524 (setq isearch-success t isearch-adjusted t)
1525 (isearch-update))
1527 (defun isearch-toggle-lax-whitespace ()
1528 "Toggle whitespace matching in searching on or off.
1529 In ordinary search, toggles the value of the variable
1530 `isearch-lax-whitespace'. In regexp search, toggles the
1531 value of the variable `isearch-regexp-lax-whitespace'."
1532 (interactive)
1533 (if isearch-regexp
1534 (setq isearch-regexp-lax-whitespace (not isearch-regexp-lax-whitespace))
1535 (setq isearch-lax-whitespace (not isearch-lax-whitespace)))
1536 (let ((message-log-max nil))
1537 (message "%s%s [%s]"
1538 (isearch-message-prefix nil isearch-nonincremental)
1539 isearch-message
1540 (if (if isearch-regexp
1541 isearch-regexp-lax-whitespace
1542 isearch-lax-whitespace)
1543 "match spaces loosely"
1544 "match spaces literally")))
1545 (setq isearch-success t isearch-adjusted t)
1546 (sit-for 1)
1547 (isearch-update))
1549 (defun isearch-toggle-case-fold ()
1550 "Toggle case folding in searching on or off.
1551 Toggles the value of the variable `isearch-case-fold-search'."
1552 (interactive)
1553 (setq isearch-case-fold-search
1554 (if isearch-case-fold-search nil 'yes))
1555 (let ((message-log-max nil))
1556 (message "%s%s [case %ssensitive]"
1557 (isearch-message-prefix nil isearch-nonincremental)
1558 isearch-message
1559 (if isearch-case-fold-search "in" "")))
1560 (setq isearch-success t isearch-adjusted t)
1561 (sit-for 1)
1562 (isearch-update))
1564 (defun isearch-toggle-invisible ()
1565 "Toggle searching in invisible text on or off.
1566 Toggles the variable `isearch-invisible' between values
1567 nil and a non-nil value of the option `search-invisible'
1568 \(or `open' if `search-invisible' is nil)."
1569 (interactive)
1570 (setq isearch-invisible
1571 (if isearch-invisible nil (or search-invisible 'open)))
1572 (let ((message-log-max nil))
1573 (message "%s%s [match %svisible text]"
1574 (isearch-message-prefix nil isearch-nonincremental)
1575 isearch-message
1576 (if isearch-invisible "in" "")))
1577 (setq isearch-success t isearch-adjusted t)
1578 (sit-for 1)
1579 (isearch-update))
1581 \f
1582 ;; Word search
1584 (defun word-search-regexp (string &optional lax)
1585 "Return a regexp which matches words, ignoring punctuation.
1586 Given STRING, a string of words separated by word delimiters,
1587 compute a regexp that matches those exact words separated by
1588 arbitrary punctuation. If the string begins or ends in whitespace,
1589 the beginning or the end of the string matches arbitrary whitespace.
1590 Otherwise if LAX is non-nil, the beginning or the end of the string
1591 need not match a word boundary.
1593 Used in `word-search-forward', `word-search-backward',
1594 `word-search-forward-lax', `word-search-backward-lax'."
1595 (cond
1596 ((equal string "") "")
1598 (t (concat
1605 (defun word-search-backward (string &optional bound noerror count)
1606 "Search backward from point for STRING, ignoring differences in punctuation.
1607 Set point to the beginning of the occurrence found, and return point.
1608 An optional second argument bounds the search; it is a buffer position.
1609 The match found must not extend before that position.
1610 Optional third argument, if t, means if fail just return nil (no error).
1611 If not nil and not t, move to limit of search and return nil.
1612 Optional fourth argument is repeat count--search for successive occurrences.
1614 Relies on the function `word-search-regexp' to convert a sequence
1615 of words in STRING to a regexp used to search words without regard
1616 to punctuation."
1617 (interactive "sWord search backward: ")
1618 (re-search-backward (word-search-regexp string nil) bound noerror count))
1620 (defun word-search-forward (string &optional bound noerror count)
1621 "Search forward from point for STRING, ignoring differences in punctuation.
1622 Set point to the end of the occurrence found, and return point.
1623 An optional second argument bounds the search; it is a buffer position.
1624 The match found must not extend after that position.
1625 Optional third argument, if t, means if fail just return nil (no error).
1626 If not nil and not t, move to limit of search and return nil.
1627 Optional fourth argument is repeat count--search for successive occurrences.
1629 Relies on the function `word-search-regexp' to convert a sequence
1630 of words in STRING to a regexp used to search words without regard
1631 to punctuation."
1632 (interactive "sWord search: ")
1633 (re-search-forward (word-search-regexp string nil) bound noerror count))
1635 (defun word-search-backward-lax (string &optional bound noerror count)
1636 "Search backward from point for STRING, ignoring differences in punctuation.
1637 Set point to the beginning of the occurrence found, and return point.
1639 Unlike `word-search-backward', the end of STRING need not match a word
1640 boundary, unless STRING ends in whitespace.
1642 An optional second argument bounds the search; it is a buffer position.
1643 The match found must not extend before that position.
1644 Optional third argument, if t, means if fail just return nil (no error).
1645 If not nil and not t, move to limit of search and return nil.
1646 Optional fourth argument is repeat count--search for successive occurrences.
1648 Relies on the function `word-search-regexp' to convert a sequence
1649 of words in STRING to a regexp used to search words without regard
1650 to punctuation."
1651 (interactive "sWord search backward: ")
1652 (re-search-backward (word-search-regexp string t) bound noerror count))
1654 (defun word-search-forward-lax (string &optional bound noerror count)
1655 "Search forward from point for STRING, ignoring differences in punctuation.
1656 Set point to the end of the occurrence found, and return point.
1658 Unlike `word-search-forward', the end of STRING need not match a word
1659 boundary, unless STRING ends in whitespace.
1661 An optional second argument bounds the search; it is a buffer position.
1662 The match found must not extend after that position.
1663 Optional third argument, if t, means if fail just return nil (no error).
1664 If not nil and not t, move to limit of search and return nil.
1665 Optional fourth argument is repeat count--search for successive occurrences.
1667 Relies on the function `word-search-regexp' to convert a sequence
1668 of words in STRING to a regexp used to search words without regard
1669 to punctuation."
1670 (interactive "sWord search: ")
1671 (re-search-forward (word-search-regexp string t) bound noerror count))
1673 ;; Symbol search
1675 (defun isearch-symbol-regexp (string &optional lax)
1676 "Return a regexp which matches STRING as a symbol.
1678 If there are more than one symbol, then compute a regexp that matches
1679 those exact symbols separated by non-symbol characters. If the string
1680 begins or ends in whitespace, the beginning or the end of the string
1681 matches arbitrary non-symbol whitespace. Otherwise if LAX is non-nil,
1682 the beginning or the end of the string need not match a symbol boundary."
1683 (let ((not-word-symbol-re
1684 ;; This regexp matches all syntaxes except word and symbol syntax.
1685 ;; FIXME: Replace it with something shorter if possible (bug#14602).
1686 "\\(?:\\s-\\|\\s.\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s/\\|\\s$\\|\\s'\\|\\s<\\|\\s>\\|\\s@\\|\\s!\\|\\s|\\)+"))
1687 (cond
1688 ((equal string "") "")
1690 (t (concat
1693 (mapconcat 'regexp-quote (split-string string not-word-symbol-re t) not-word-symbol-re)
1697 (put 'isearch-symbol-regexp 'isearch-message-prefix "symbol ")
1699 ;; Search with lax whitespace
1701 (defun search-forward-lax-whitespace (string &optional bound noerror count)
1702 "Search forward for STRING, matching a sequence of whitespace chars."
1703 (let ((search-spaces-regexp search-whitespace-regexp))
1704 (re-search-forward (regexp-quote string) bound noerror count)))
1706 (defun search-backward-lax-whitespace (string &optional bound noerror count)
1707 "Search backward for STRING, matching a sequence of whitespace chars."
1708 (let ((search-spaces-regexp search-whitespace-regexp))
1709 (re-search-backward (regexp-quote string) bound noerror count)))
1711 (defun re-search-forward-lax-whitespace (regexp &optional bound noerror count)
1712 "Search forward for REGEXP, matching a sequence of whitespace chars."
1713 (let ((search-spaces-regexp search-whitespace-regexp))
1714 (re-search-forward regexp bound noerror count)))
1716 (defun re-search-backward-lax-whitespace (regexp &optional bound noerror count)
1717 "Search backward for REGEXP, matching a sequence of whitespace chars."
1718 (let ((search-spaces-regexp search-whitespace-regexp))
1719 (re-search-backward regexp bound noerror count)))
1721 \f
1722 (defun isearch-query-replace (&optional arg regexp-flag)
1723 "Start `query-replace' with string to replace from last search string.
1724 The ARG (prefix arg if interactive), if non-nil, means replace
1725 only matches surrounded by word boundaries. A negative prefix
1726 arg means replace backward. Note that using the prefix arg
1727 is possible only when `isearch-allow-scroll' is non-nil or
1728 `isearch-allow-prefix' is non-nil, and it doesn't always provide the
1729 correct matches for `query-replace', so the preferred way to run word
1730 replacements from Isearch is `M-s w ... M-%'."
1731 (interactive
1732 (list current-prefix-arg))
1733 (barf-if-buffer-read-only)
1734 (if regexp-flag (setq isearch-regexp t))
1735 (let ((case-fold-search isearch-case-fold-search)
1736 ;; set `search-upper-case' to nil to not call
1737 ;; `isearch-no-upper-case-p' in `perform-replace'
1738 (search-upper-case nil)
1739 (search-invisible isearch-invisible)
1740 (replace-lax-whitespace
1741 isearch-lax-whitespace)
1742 (replace-regexp-lax-whitespace
1743 isearch-regexp-lax-whitespace)
1744 (delimited (and arg (not (eq arg '-))))
1745 (backward (and arg (eq arg '-)))
1746 ;; Set `isearch-recursive-edit' to nil to prevent calling
1747 ;; `exit-recursive-edit' in `isearch-done' that terminates
1748 ;; the execution of this command when it is non-nil.
1749 ;; We call `exit-recursive-edit' explicitly at the end below.
1750 (isearch-recursive-edit nil))
1751 (isearch-done nil t)
1752 (isearch-clean-overlays)
1753 (if (and isearch-other-end
1754 (if backward
1755 (> isearch-other-end (point))
1756 (< isearch-other-end (point)))
1757 (not (and transient-mark-mode mark-active
1758 (if backward
1759 (> (mark) (point))
1760 (< (mark) (point))))))
1761 (goto-char isearch-other-end))
1762 (set query-replace-from-history-variable
1763 (cons isearch-string
1764 (symbol-value query-replace-from-history-variable)))
1765 (perform-replace
1766 isearch-string
1767 (query-replace-read-to
1768 isearch-string
1769 (concat "Query replace"
1770 (isearch--describe-word-mode (or delimited isearch-word) t)
1771 (if isearch-regexp " regexp" "")
1772 (if backward " backward" "")
1773 (if (and transient-mark-mode mark-active) " in region" ""))
1774 isearch-regexp)
1775 t isearch-regexp (or delimited isearch-word) nil nil
1776 (if (and transient-mark-mode mark-active) (region-beginning))
1777 (if (and transient-mark-mode mark-active) (region-end))
1778 backward))
1779 (and isearch-recursive-edit (exit-recursive-edit)))
1781 (defun isearch-query-replace-regexp (&optional arg)
1782 "Start `query-replace-regexp' with string to replace from last search string.
1783 See `isearch-query-replace' for more information."
1784 (interactive
1785 (list current-prefix-arg))
1786 (isearch-query-replace arg t))
1788 (defun isearch-occur (regexp &optional nlines)
1789 "Run `occur' using the last search string as the regexp.
1790 Interactively, REGEXP is constructed using the search string from the
1791 last search command. NLINES has the same meaning as in `occur'.
1793 If the last search command was a word search, REGEXP is computed from
1794 the search words, ignoring punctuation. If the last search
1795 command was a regular expression search, REGEXP is the regular
1796 expression used in that search. If the last search command searched
1797 for a literal string, REGEXP is constructed by quoting all the special
1798 characters in that string."
1799 (interactive
1800 (let* ((perform-collect (consp current-prefix-arg))
1801 (regexp (cond
1802 ((functionp isearch-word)
1803 (funcall isearch-word isearch-string))
1804 (isearch-word (word-search-regexp isearch-string))
1805 (isearch-regexp isearch-string)
1806 (t (regexp-quote isearch-string)))))
1807 (list regexp
1808 (if perform-collect
1809 ;; Perform collect operation
1810 (if (zerop (regexp-opt-depth regexp))
1811 ;; No subexpression so collect the entire match.
1813 ;; Get the regexp for collection pattern.
1814 (let ((default (car occur-collect-regexp-history))
1815 regexp-collect)
1816 (with-isearch-suspended
1817 (setq regexp-collect
1818 (read-regexp
1819 (format "Regexp to collect (default %s): " default)
1820 default 'occur-collect-regexp-history)))
1821 regexp-collect))
1822 ;; Otherwise normal occur takes numerical prefix argument.
1823 (when current-prefix-arg
1824 (prefix-numeric-value current-prefix-arg))))))
1825 (let ((case-fold-search isearch-case-fold-search)
1826 ;; Set `search-upper-case' to nil to not call
1827 ;; `isearch-no-upper-case-p' in `occur-1'.
1828 (search-upper-case nil)
1829 (search-spaces-regexp
1830 (if (if isearch-regexp
1831 isearch-regexp-lax-whitespace
1832 isearch-lax-whitespace)
1833 search-whitespace-regexp)))
1834 (occur regexp nlines)))
1836 (declare-function hi-lock-read-face-name "hi-lock" ())
1838 (defun isearch-highlight-regexp ()
1839 "Run `highlight-regexp' with regexp from the current search string.
1840 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1841 argument from the last search regexp or a quoted search string,
1842 and reads its face argument using `hi-lock-read-face-name'."
1843 (interactive)
1844 (let (
1845 ;; Set `isearch-recursive-edit' to nil to prevent calling
1846 ;; `exit-recursive-edit' in `isearch-done' that terminates
1847 ;; the execution of this command when it is non-nil.
1848 ;; We call `exit-recursive-edit' explicitly at the end below.
1849 (isearch-recursive-edit nil))
1850 (isearch-done nil t)
1851 (isearch-clean-overlays))
1852 (require 'hi-lock nil t)
1853 (let ((regexp (cond ((functionp isearch-word)
1854 (funcall isearch-word isearch-string))
1855 (isearch-word (word-search-regexp isearch-string))
1856 (isearch-regexp isearch-string)
1857 ((if (and (eq isearch-case-fold-search t)
1858 search-upper-case)
1859 (isearch-no-upper-case-p
1860 isearch-string isearch-regexp)
1861 isearch-case-fold-search)
1862 ;; Turn isearch-string into a case-insensitive
1863 ;; regexp.
1864 (mapconcat
1865 (lambda (c)
1866 (let ((s (string c)))
1867 (if (string-match "[[:alpha:]]" s)
1868 (format "[%s%s]" (upcase s) (downcase s))
1869 (regexp-quote s))))
1870 isearch-string ""))
1871 (t (regexp-quote isearch-string)))))
1872 (hi-lock-face-buffer regexp (hi-lock-read-face-name)))
1873 (and isearch-recursive-edit (exit-recursive-edit)))
1875 \f
1876 (defun isearch-delete-char ()
1877 "Discard last input item and move point back.
1878 Last input means the last character or the last isearch command
1879 that added or deleted characters from the search string,
1880 moved point, toggled regexp mode or case-sensitivity, etc.
1881 If no previous match was done, just beep."
1882 (interactive)
1883 (if (null (cdr isearch-cmds))
1884 (ding)
1885 (isearch-pop-state))
1886 (isearch-update))
1888 (defun isearch-del-char (&optional arg)
1889 "Delete character from end of search string and search again.
1890 Unlike `isearch-delete-char', it only deletes the last character,
1891 but doesn't cancel the effect of other isearch command.
1892 If search string is empty, just beep."
1893 (interactive "p")
1894 (if (= 0 (length isearch-string))
1895 (ding)
1896 (setq isearch-string (substring isearch-string 0
1897 (- (min (or arg 1)
1898 (length isearch-string))))
1899 isearch-message (mapconcat 'isearch-text-char-description
1900 isearch-string "")))
1901 ;; Use the isearch-other-end as new starting point to be able
1902 ;; to find the remaining part of the search string again.
1903 ;; This is like what `isearch-search-and-update' does,
1904 ;; but currently it doesn't support deletion of characters
1905 ;; for the case where unsuccessful search may become successful
1906 ;; by deletion of characters.
1907 (if isearch-other-end (goto-char isearch-other-end))
1908 (isearch-search)
1909 (isearch-push-state)
1910 (isearch-update))
1912 (defun isearch-yank-string (string)
1913 "Pull STRING into search string."
1914 ;; Downcase the string if not supposed to case-fold yanked strings.
1915 (if (and isearch-case-fold-search
1916 (eq 'not-yanks search-upper-case))
1917 (setq string (downcase string)))
1918 (if isearch-regexp (setq string (regexp-quote string)))
1919 ;; Don't move cursor in reverse search.
1920 (setq isearch-yank-flag t)
1921 (isearch-process-search-string
1922 string (mapconcat 'isearch-text-char-description string "")))
1924 (defun isearch-yank-kill ()
1925 "Pull string from kill ring into search string."
1926 (interactive)
1927 (isearch-yank-string (current-kill 0)))
1929 (defun isearch-yank-pop ()
1930 "Replace just-yanked search string with previously killed string."
1931 (interactive)
1932 (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop)))
1933 ;; Fall back on `isearch-yank-kill' for the benefits of people
1934 ;; who are used to the old behavior of `M-y' in isearch mode. In
1935 ;; future, this fallback may be changed if we ever change
1936 ;; `yank-pop' to do something like the kill-ring-browser.
1937 (isearch-yank-kill)
1938 (isearch-pop-state)
1939 (isearch-yank-string (current-kill 1))))
1941 (defun isearch-yank-x-selection ()
1942 "Pull current X selection into search string."
1943 (interactive)
1944 (isearch-yank-string (gui-get-selection))
1945 ;; If `gui-get-selection' returned the text from the active region,
1946 ;; then it "used" the mark which we should hence deactivate.
1947 (when select-active-regions (deactivate-mark)))
1950 (defun isearch-mouse-2 (click)
1951 "Handle mouse-2 in Isearch mode.
1952 For a click in the echo area, invoke `isearch-yank-x-selection'.
1953 Otherwise invoke whatever the calling mouse-2 command sequence
1954 is bound to outside of Isearch."
1955 (interactive "e")
1956 (let* ((w (posn-window (event-start click)))
1957 (overriding-terminal-local-map nil)
1958 (binding (key-binding (this-command-keys-vector) t)))
1959 (if (and (window-minibuffer-p w)
1960 (not (minibuffer-window-active-p w))) ; in echo area
1961 (isearch-yank-x-selection)
1962 (when (functionp binding)
1963 (call-interactively binding)))))
1965 (defun isearch-yank-internal (jumpform)
1966 "Pull the text from point to the point reached by JUMPFORM.
1967 JUMPFORM is a lambda expression that takes no arguments and returns
1968 a buffer position, possibly having moved point to that position.
1969 For example, it might move point forward by a word and return point,
1970 or it might return the position of the end of the line."
1971 (isearch-yank-string
1972 (save-excursion
1973 (and (not isearch-forward) isearch-other-end
1974 (goto-char isearch-other-end))
1975 (buffer-substring-no-properties (point) (funcall jumpform)))))
1977 (defun isearch-yank-char-in-minibuffer (&optional arg)
1978 "Pull next character from buffer into end of search string in minibuffer."
1979 (interactive "p")
1980 (if (eobp)
1981 (insert
1982 (with-current-buffer (cadr (buffer-list))
1983 (buffer-substring-no-properties
1984 (point) (progn (forward-char arg) (point)))))
1985 (forward-char arg)))
1987 (defun isearch-yank-char (&optional arg)
1988 "Pull next character from buffer into search string.
1989 If optional ARG is non-nil, pull in the next ARG characters."
1990 (interactive "p")
1991 (isearch-yank-internal (lambda () (forward-char arg) (point))))
1993 (declare-function subword-forward "subword" (&optional arg))
1994 (defun isearch-yank-word-or-char ()
1995 "Pull next character, subword or word from buffer into search string.
1996 Subword is used when `subword-mode' is activated. "
1997 (interactive)
1998 (isearch-yank-internal
1999 (lambda ()
2000 (if (or (= (char-syntax (or (char-after) 0)) ?w)
2001 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
2002 (if (or (and (boundp 'subword-mode) subword-mode)
2003 (and (boundp 'superword-mode) superword-mode))
2004 (subword-forward 1)
2005 (forward-word 1))
2006 (forward-char 1))
2007 (point))))
2009 (defun isearch-yank-word (&optional arg)
2010 "Pull next word from buffer into search string.
2011 If optional ARG is non-nil, pull in the next ARG words."
2012 (interactive "p")
2013 (isearch-yank-internal (lambda () (forward-word arg) (point))))
2015 (defun isearch-yank-line (&optional arg)
2016 "Pull rest of line from buffer into search string.
2017 If optional ARG is non-nil, yank the next ARG lines."
2018 (interactive "p")
2019 (isearch-yank-internal
2020 (lambda () (let ((inhibit-field-text-motion t))
2021 (line-end-position (if (eolp) (1+ arg) arg))))))
2023 (defun isearch-char-by-name (&optional count)
2024 "Read a character by its Unicode name and add it to the search string.
2025 Completion is available like in `read-char-by-name' used by `insert-char'.
2026 With argument, add COUNT copies of the character."
2027 (interactive "p")
2028 (with-isearch-suspended
2029 (let ((char (read-char-by-name "Add character to search (Unicode name or hex): ")))
2030 (when char
2031 (let ((string (if (and (integerp count) (> count 1))
2032 (make-string count char)
2033 (char-to-string char))))
2034 (setq isearch-new-string (concat isearch-string string)
2035 isearch-new-message (concat isearch-message
2036 (mapconcat 'isearch-text-char-description
2037 string ""))))))))
2039 (defun isearch-search-and-update ()
2040 ;; Do the search and update the display.
2041 (when (or isearch-success
2042 ;; Unsuccessful regexp search may become successful by
2043 ;; addition of characters which make isearch-string valid
2044 isearch-regexp
2045 ;; If the string was found but was completely invisible,
2046 ;; it might now be partly visible, so try again.
2047 (prog1 isearch-hidden (setq isearch-hidden nil)))
2048 ;; In reverse search, adding stuff at
2049 ;; the end may cause zero or many more chars to be
2050 ;; matched, in the string following point.
2051 ;; Allow all those possibilities without moving point as
2052 ;; long as the match does not extend past search origin.
2053 (if (and (not isearch-forward) (not isearch-adjusted)
2054 (condition-case ()
2055 (let ((case-fold-search isearch-case-fold-search))
2056 (if (and (eq case-fold-search t) search-upper-case)
2057 (setq case-fold-search
2058 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2059 (looking-at (cond
2060 ((functionp isearch-word)
2061 (funcall isearch-word isearch-string t))
2062 (isearch-word (word-search-regexp isearch-string t))
2063 (isearch-regexp isearch-string)
2064 (t (regexp-quote isearch-string)))))
2065 (error nil))
2066 (or isearch-yank-flag
2067 (<= (match-end 0)
2068 (min isearch-opoint isearch-barrier))))
2069 (progn
2070 (setq isearch-success t
2071 isearch-error nil
2072 isearch-other-end (match-end 0))
2073 (if (and (eq isearch-case-fold-search t) search-upper-case)
2074 (setq isearch-case-fold-search
2075 (isearch-no-upper-case-p isearch-string isearch-regexp))))
2076 ;; Not regexp, not reverse, or no match at point.
2077 (if (and isearch-other-end (not isearch-adjusted))
2078 (goto-char (if isearch-forward isearch-other-end
2079 (min isearch-opoint
2080 isearch-barrier
2081 (1+ isearch-other-end)))))
2082 (isearch-search)
2083 ))
2084 (isearch-push-state)
2085 (if isearch-op-fun (funcall isearch-op-fun))
2086 (isearch-update))
2089 ;; *, ?, }, and | chars can make a regexp more liberal.
2090 ;; They can make a regexp match sooner or make it succeed instead of failing.
2091 ;; So go back to place last successful search started
2092 ;; or to the last ^S/^R (barrier), whichever is nearer.
2093 ;; + needs no special handling because the string must match at least once.
2095 (defun isearch-backslash (str)
2096 "Return t if STR ends in an odd number of backslashes."
2099 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
2100 "Return point to previous successful match to allow regexp liberalization.
2103 stopping at `isearch-barrier' as needed.
2105 Do nothing if a backslash is escaping the liberalizing character.
2108 Do nothing if regexp has recently been invalid unless optional
2109 ALLOW-INVALID non-nil.
2111 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
2112 to the barrier."
2113 ;; (eq (not a) (not b)) makes all non-nil values equivalent
2114 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
2115 (not want-backslash))
2116 ;; We have to check 2 stack frames because the last might be
2117 ;; invalid just because of a backslash.
2118 (or (not isearch-error)
2119 (not (isearch--state-error (cadr isearch-cmds)))
2120 allow-invalid))
2121 (if to-barrier
2122 (progn (goto-char isearch-barrier)
2123 (setq isearch-adjusted t))
2124 (let* ((stack isearch-cmds)
2125 (previous (cdr stack)) ; lookbelow in the stack
2126 (frame (car stack)))
2127 ;; Walk down the stack looking for a valid regexp (as of course only
2128 ;; they can be the previous successful match); this conveniently
2129 ;; removes all bracket-sets and groups that might be in the way, as
2130 ;; well as partial \{\} constructs that the code below leaves behind.
2131 ;; Also skip over postfix operators -- though horrid,
2132 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
2133 (while (and previous
2134 (or (isearch--state-error frame)
2135 (let* ((string (isearch--state-string frame))
2136 (lchar (aref string (1- (length string)))))
2137 ;; The operators aren't always operators; check
2138 ;; backslashes. This doesn't handle the case of
2139 ;; operators at the beginning of the regexp not
2140 ;; being special, but then we should fall back to
2141 ;; the barrier anyway because it's all optional.
2142 (if (isearch-backslash
2143 (isearch--state-string (car previous)))
2144 (eq lchar ?\})
2145 (memq lchar '(?* ?? ?+))))))
2146 (setq stack previous previous (cdr previous) frame (car stack)))
2147 (when stack
2148 ;; `stack' now refers the most recent valid regexp that is not at
2149 ;; all optional in its last term. Now dig one level deeper and find
2150 ;; what matched before that.
2151 (let ((last-other-end
2152 (or (and (car previous)
2153 (isearch--state-other-end (car previous)))
2154 isearch-barrier)))
2155 (goto-char (if isearch-forward
2156 (max last-other-end isearch-barrier)
2157 (min last-other-end isearch-barrier)))
2158 (setq isearch-adjusted t)))))))
2160 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2161 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
2162 ;;
2163 ;; The idea here is that certain vertical scrolling commands (like C-l
2164 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
2165 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
2166 ;; tamper with isearch's state, or move point. It is unacceptable for the
2167 ;; search string to be scrolled out of the current window. If a command
2168 ;; attempts this, we scroll the text back again.
2169 ;;
2170 ;; We implement this feature with a property called `isearch-scroll'.
2171 ;; If a command's symbol has the value t for this property or for the
2172 ;; `scroll-command' property, it is a scrolling command. The feature
2173 ;; needs to be enabled by setting the customizable variable
2174 ;; `isearch-allow-scroll' to a non-nil value.
2175 ;;
2176 ;; The universal argument commands (e.g. C-u) in simple.el are marked
2177 ;; as scrolling commands, and isearch.el has been amended to allow
2178 ;; prefix arguments to be passed through to scrolling commands. Thus
2179 ;; M-0 C-l will scroll point to the top of the window.
2180 ;;
2181 ;; Horizontal scrolling commands are currently not catered for.
2182 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2184 ;; Set the isearch-scroll property on some standard functions:
2185 ;; Scroll-bar functions:
2186 (if (fboundp 'scroll-bar-toolkit-scroll)
2187 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
2188 (if (fboundp 'w32-handle-scroll-bar-event)
2189 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
2191 ;; Commands which scroll the window (some scroll commands
2192 ;; already have the `scroll-command' property on them):
2193 (put 'recenter 'isearch-scroll t)
2194 (put 'recenter-top-bottom 'isearch-scroll t)
2195 (put 'reposition-window 'isearch-scroll t)
2197 ;; Commands which act on the other window
2198 (put 'list-buffers 'isearch-scroll t)
2199 (put 'scroll-other-window 'isearch-scroll t)
2200 (put 'scroll-other-window-down 'isearch-scroll t)
2201 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
2202 (put 'end-of-buffer-other-window 'isearch-scroll t)
2204 ;; Commands which change the window layout
2205 (put 'delete-other-windows 'isearch-scroll t)
2206 (put 'balance-windows 'isearch-scroll t)
2207 (put 'split-window-right 'isearch-scroll t)
2208 (put 'split-window-below 'isearch-scroll t)
2209 (put 'enlarge-window 'isearch-scroll t)
2211 ;; Aliases for split-window-*
2212 (put 'split-window-vertically 'isearch-scroll t)
2213 (put 'split-window-horizontally 'isearch-scroll t)
2215 ;; Universal argument commands
2216 (put 'universal-argument 'isearch-scroll t)
2217 (put 'negative-argument 'isearch-scroll t)
2218 (put 'digit-argument 'isearch-scroll t)
2220 (defcustom isearch-allow-scroll nil
2221 "Whether scrolling is allowed during incremental search.
2222 If non-nil, scrolling commands can be used in Isearch mode.
2223 However, the current match will never scroll offscreen.
2224 If nil, scrolling commands will first cancel Isearch mode."
2225 :type 'boolean
2226 :group 'isearch)
2228 (defcustom isearch-allow-prefix t
2229 "Whether prefix arguments are allowed during incremental search.
2230 If non-nil, entering a prefix argument will not terminate the
2231 search. This option is ignored \(presumed t) when
2232 `isearch-allow-scroll' is set."
2233 :version "24.4"
2234 :type 'boolean
2235 :group 'isearch)
2237 (defun isearch-string-out-of-window (isearch-point)
2238 "Test whether the search string is currently outside of the window.
2239 Return nil if it's completely visible, or if point is visible,
2240 together with as much of the search string as will fit; the symbol
2241 `above' if we need to scroll the text downwards; the symbol `below',
2242 if upwards."
2243 (let ((w-start (window-start))
2244 (w-end (window-end nil t))
2245 (w-L1 (save-excursion (move-to-window-line 1) (point)))
2246 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
2247 start end) ; start and end of search string in buffer
2248 (if isearch-forward
2249 (setq end isearch-point start (or isearch-other-end isearch-point))
2250 (setq start isearch-point end (or isearch-other-end isearch-point)))
2251 (cond ((or (and (>= start w-start) (<= end w-end))
2252 (if isearch-forward
2253 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
2254 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
2255 nil)
2256 ((and (< start w-start)
2257 (< isearch-point w-L-1))
2258 'above)
2259 (t 'below))))
2261 (defun isearch-back-into-window (above isearch-point)
2262 "Scroll the window to bring the search string back into view.
2263 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
2264 search string is above the top of the window, nil when it is beneath
2265 the bottom."
2266 (let (start end)
2267 (if isearch-forward
2268 (setq end isearch-point start (or isearch-other-end isearch-point))
2269 (setq start isearch-point end (or isearch-other-end isearch-point)))
2270 (if above
2271 (progn
2272 (goto-char start)
2273 (recenter 0)
2274 (when (>= isearch-point (window-end nil t))
2275 (goto-char isearch-point)
2276 (recenter -1)))
2277 (goto-char end)
2278 (recenter -1)
2279 (when (< isearch-point (window-start))
2280 (goto-char isearch-point)
2281 (recenter 0))))
2282 (goto-char isearch-point))
2284 (defvar isearch-pre-scroll-point nil)
2286 (defun isearch-pre-command-hook ()
2287 "Decide whether to exit Isearch mode before executing the command.
2288 Don't exit Isearch if the key sequence that invoked this command
2289 is bound in `isearch-mode-map', or if the invoked command is
2290 a prefix argument command (when `isearch-allow-prefix' is non-nil),
2291 or it is a scrolling command (when `isearch-allow-scroll' is non-nil).
2292 Otherwise, exit Isearch (when `search-exit-option' is non-nil)
2293 before the command is executed globally with terminated Isearch."
2294 (let* ((key (this-single-command-keys))
2295 (main-event (aref key 0)))
2296 (cond
2297 ;; Don't exit Isearch if we're in the middle of some
2298 ;; `set-transient-map' thingy like `universal-argument--mode'.
2299 ((not (eq overriding-terminal-local-map isearch--saved-overriding-local-map)))
2300 ;; Don't exit Isearch for isearch key bindings.
2301 ((commandp (lookup-key isearch-mode-map key nil)))
2302 ;; Optionally edit the search string instead of exiting.
2303 ((eq search-exit-option 'edit)
2304 (setq this-command 'isearch-edit-string))
2305 ;; Handle a scrolling function or prefix argument.
2306 ((or (and isearch-allow-prefix
2307 (memq this-command '(universal-argument
2308 digit-argument negative-argument)))
2309 (and isearch-allow-scroll
2310 (symbolp this-command)
2311 (or (eq (get this-command 'isearch-scroll) t)
2312 (eq (get this-command 'scroll-command) t))))
2313 (when isearch-allow-scroll
2314 (setq isearch-pre-scroll-point (point))))
2315 ;; A mouse click on the isearch message starts editing the search string.
2316 ((and (eq (car-safe main-event) 'down-mouse-1)
2317 (window-minibuffer-p (posn-window (event-start main-event))))
2318 ;; Swallow the up-event.
2319 (read-event)
2320 (setq this-command 'isearch-edit-string))
2321 ;; Other characters terminate the search and are then executed normally.
2322 (search-exit-option
2323 (isearch-done)
2324 (isearch-clean-overlays))
2325 ;; If search-exit-option is nil, run the command without exiting Isearch.
2326 (t
2327 (isearch-process-search-string key key)))))
2329 (defun isearch-post-command-hook ()
2330 (when isearch-pre-scroll-point
2331 (let ((ab-bel (isearch-string-out-of-window isearch-pre-scroll-point)))
2332 (if ab-bel
2333 (isearch-back-into-window (eq ab-bel 'above) isearch-pre-scroll-point)
2334 (goto-char isearch-pre-scroll-point)))
2335 (setq isearch-pre-scroll-point nil)
2336 (isearch-update)))
2338 (defun isearch-quote-char (&optional count)
2339 "Quote special characters for incremental search.
2340 With argument, add COUNT copies of the character."
2341 (interactive "p")
2342 (let ((char (read-quoted-char (isearch-message t))))
2343 (unless (characterp char)
2344 (user-error "%s is not a valid character"
2345 (key-description (vector char))))
2346 ;; Assume character codes 0200 - 0377 stand for characters in some
2347 ;; single-byte character set, and convert them to Emacs
2348 ;; characters.
2349 (if (and isearch-regexp isearch-regexp-lax-whitespace (= char ?\s))
2350 (if (subregexp-context-p isearch-string (length isearch-string))
2351 (isearch-process-search-string "[ ]" " ")
2352 (isearch-process-search-char char count))
2353 ;; This used to assume character codes 0240 - 0377 stand for
2354 ;; characters in some single-byte character set, and converted them
2355 ;; to Emacs characters. But in 23.1 this feature is deprecated
2356 ;; in favor of inserting the corresponding Unicode characters.
2357 ;; (and enable-multibyte-characters
2360 ;; (setq char (unibyte-char-to-multibyte char)))
2361 (isearch-process-search-char char count))))
2363 (defun isearch-printing-char (&optional char count)
2364 "Add this ordinary printing CHAR to the search string and search.
2365 With argument, add COUNT copies of the character."
2366 (interactive (list last-command-event
2367 (prefix-numeric-value current-prefix-arg)))
2368 (let ((char (or char last-command-event)))
2369 (if (= char ?\S-\ )
2370 (setq char ?\s))
2371 (if current-input-method
2372 (isearch-process-search-multibyte-characters char count)
2373 (isearch-process-search-char char count))))
2375 (defun isearch-process-search-char (char &optional count)
2376 "Add CHAR to the search string, COUNT times.
2377 Search is updated accordingly."
2378 ;; * and ? are special in regexps when not preceded by \.
2379 ;; } and | are special in regexps when preceded by \.
2380 ;; Nothing special for + because it matches at least once.
2381 (cond
2382 ((memq char '(?* ??)) (isearch-fallback nil))
2383 ((eq char ?\}) (isearch-fallback t t))
2384 ((eq char ?|) (isearch-fallback t nil t)))
2386 ;; Append the char(s) to the search string,
2387 ;; update the message and re-search.
2388 (let* ((string (if (and (integerp count) (> count 1))
2389 (make-string count char)
2390 (char-to-string char)))
2392 string
2393 (mapconcat 'isearch-text-char-description string ""))))
2394 (isearch-process-search-string string message)))
2396 (defun isearch-process-search-string (string message)
2397 (setq isearch-string (concat isearch-string string)
2398 isearch-message (concat isearch-message message))
2399 (isearch-search-and-update))
2401 \f
2402 ;; Search Ring
2404 (defun isearch-ring-adjust1 (advance)
2405 ;; Helper for isearch-ring-adjust
2406 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2407 (length (length ring))
2408 (yank-pointer-name (if isearch-regexp
2409 'regexp-search-ring-yank-pointer
2410 'search-ring-yank-pointer))
2411 (yank-pointer (eval yank-pointer-name)))
2412 (if (zerop length)
2413 ()
2414 (set yank-pointer-name
2415 (setq yank-pointer
2416 (mod (+ (or yank-pointer (if advance 0 -1))
2417 (if advance -1 1))
2418 length)))
2419 (setq isearch-string (nth yank-pointer ring)
2420 isearch-message (mapconcat 'isearch-text-char-description
2421 isearch-string "")))))
2423 (defun isearch-ring-adjust (advance)
2424 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2425 (isearch-ring-adjust1 advance)
2426 (if search-ring-update
2427 (progn
2428 (isearch-search)
2429 (isearch-push-state)
2430 (isearch-update))
2431 ;; Otherwise, edit the search string instead. Note that there is
2432 ;; no need to push the search state after isearch-edit-string here
2433 ;; since isearch-edit-string already pushes its state
2434 (isearch-edit-string)))
2436 (defun isearch-ring-advance ()
2437 "Advance to the next search string in the ring."
2438 ;; This could be more general to handle a prefix arg, but who would use it.
2439 (interactive)
2440 (isearch-ring-adjust 'advance))
2442 (defun isearch-ring-retreat ()
2443 "Retreat to the previous search string in the ring."
2444 (interactive)
2445 (isearch-ring-adjust nil))
2447 (defun isearch-complete1 ()
2448 ;; Helper for isearch-complete and isearch-complete-edit
2449 ;; Return t if completion OK, nil if no completion exists.
2450 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2451 (completion-ignore-case case-fold-search)
2452 (completion (try-completion isearch-string ring)))
2453 (cond
2454 ((eq completion t)
2455 ;; isearch-string stays the same
2456 t)
2457 ((or completion ; not nil, must be a string
2458 (= 0 (length isearch-string))) ; shouldn't have to say this
2459 (if (equal completion isearch-string) ;; no extension?
2460 (progn
2461 (if completion-auto-help
2462 (with-output-to-temp-buffer "*Isearch completions*"
2463 (display-completion-list
2464 (all-completions isearch-string ring))))
2465 t)
2466 (and completion
2467 (setq isearch-string completion))))
2468 (t
2469 (message "No completion") ; waits a second if in minibuffer
2470 nil))))
2472 (defun isearch-complete ()
2473 "Complete the search string from the strings on the search ring.
2474 The completed string is then editable in the minibuffer.
2475 If there is no completion possible, say so and continue searching."
2476 (interactive)
2477 (if (isearch-complete1)
2478 (progn (setq isearch-message
2479 (mapconcat 'isearch-text-char-description
2480 isearch-string ""))
2481 (isearch-edit-string))
2482 ;; else
2483 (sit-for 1)
2484 (isearch-update)))
2486 (defun isearch-complete-edit ()
2487 "Same as `isearch-complete' except in the minibuffer."
2488 (interactive)
2489 (setq isearch-string (field-string))
2490 (if (isearch-complete1)
2491 (progn
2492 (delete-field)
2493 (insert isearch-string))))
2495 \f
2496 ;; Message string
2498 (defun isearch-message (&optional c-q-hack ellipsis)
2499 ;; Generate and print the message string.
2500 (let ((cursor-in-echo-area ellipsis)
2501 (m isearch-message)
2502 (fail-pos (isearch-fail-pos t)))
2503 ;; Highlight failed part
2504 (when fail-pos
2505 (setq m (copy-sequence m))
2506 (add-text-properties fail-pos (length m) '(face isearch-fail) m)
2507 ;; Highlight failed trailing whitespace
2508 (when (string-match " +$" m)
2509 (add-text-properties (match-beginning 0) (match-end 0)
2510 '(face trailing-whitespace) m)))
2511 (setq m (concat
2512 (isearch-message-prefix ellipsis isearch-nonincremental)
2513 m
2514 (isearch-message-suffix c-q-hack)))
2515 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2517 (defun isearch--describe-word-mode (word-mode &optional space-before)
2518 "Make a string for describing WORD-MODE.
2519 If SPACE-BEFORE is non-nil, put a space before, instead of after,
2520 the word mode."
2521 (let ((description
2522 (cond ((and (symbolp word-mode)
2523 (get word-mode 'isearch-message-prefix))
2524 (get word-mode 'isearch-message-prefix))
2525 (word-mode "word ")
2526 (t ""))))
2527 (if space-before
2528 ;; Move space from the end to the beginning.
2530 description)))
2532 (defun isearch-message-prefix (&optional ellipsis nonincremental)
2533 ;; If about to search, and previous search regexp was invalid,
2534 ;; check that it still is. If it is valid now,
2535 ;; let the message we display while searching say that it is valid.
2536 (and isearch-error ellipsis
2537 (condition-case ()
2538 (progn (re-search-forward isearch-string (point) t)
2539 (setq isearch-error nil))
2540 (error nil)))
2541 ;; If currently failing, display no ellipsis.
2542 (or isearch-success (setq ellipsis nil))
2543 (let ((m (concat (if isearch-success "" "failing ")
2544 (if isearch-adjusted "pending " "")
2545 (if (and isearch-wrapped
2546 (not isearch-wrap-function)
2547 (if isearch-forward
2548 (> (point) isearch-opoint)
2549 (< (point) isearch-opoint)))
2550 "over")
2551 (if isearch-wrapped "wrapped ")
2552 (let ((prefix ""))
2553 (advice-function-mapc
2554 (lambda (_ props)
2555 (let ((np (cdr (assq 'isearch-message-prefix props))))
2556 (if np (setq prefix (concat np prefix)))))
2557 isearch-filter-predicate)
2558 prefix)
2559 (isearch--describe-word-mode isearch-word)
2560 (if isearch-regexp "regexp " "")
2561 (cond
2562 (multi-isearch-file-list "multi-file ")
2563 (multi-isearch-buffer-list "multi-buffer ")
2564 (t ""))
2565 (or isearch-message-prefix-add "")
2566 (if nonincremental "search" "I-search")
2567 (if isearch-forward "" " backward")
2568 (if current-input-method
2569 ;; Input methods for RTL languages use RTL
2570 ;; characters for their title, and that messes
2571 ;; up the display of search text after the prompt.
2572 (bidi-string-mark-left-to-right
2573 (concat " [" current-input-method-title "]: "))
2574 ": ")
2575 )))
2576 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2577 'face 'minibuffer-prompt)))
2579 (defun isearch-message-suffix (&optional c-q-hack)
2580 (concat (if c-q-hack "^Q" "")
2581 (if isearch-error
2582 (concat " [" isearch-error "]")
2583 "")
2584 (or isearch-message-suffix-add "")))
2586 \f
2587 ;; Searching
2589 (defvar isearch-search-fun-function 'isearch-search-fun-default
2590 "Non-default value overrides the behavior of `isearch-search-fun-default'.
2591 This variable's value should be a function, which will be called
2592 with no arguments, and should return a function that takes three
2593 arguments: STRING, BOUND, and NOERROR.
2595 This returned function will be used by `isearch-search-string' to
2596 search for the first occurrence of STRING or its translation.")
2598 (defun isearch-search-fun ()
2599 "Return the function to use for the search.
2600 Can be changed via `isearch-search-fun-function' for special needs."
2601 (funcall (or isearch-search-fun-function 'isearch-search-fun-default)))
2603 (defun isearch-search-fun-default ()
2604 "Return default functions to use for the search."
2605 (cond
2606 (isearch-word
2607 (lambda (string &optional bound noerror count)
2608 ;; Use lax versions to not fail at the end of the word while
2609 ;; the user adds and removes characters in the search string
2610 ;; (or when using nonincremental word isearch)
2611 (let ((lax (not (or isearch-nonincremental
2612 (null (car isearch-cmds))
2613 (eq (length isearch-string)
2614 (length (isearch--state-string
2615 (car isearch-cmds))))))))
2616 (funcall
2617 (if isearch-forward #'re-search-forward #'re-search-backward)
2618 (if (functionp isearch-word)
2619 (funcall isearch-word string lax)
2620 (word-search-regexp string lax))
2621 bound noerror count))))
2622 ((and isearch-regexp isearch-regexp-lax-whitespace
2623 search-whitespace-regexp)
2624 (if isearch-forward
2625 're-search-forward-lax-whitespace
2626 're-search-backward-lax-whitespace))
2627 (isearch-regexp
2628 (if isearch-forward 're-search-forward 're-search-backward))
2629 ((and isearch-lax-whitespace search-whitespace-regexp)
2630 (if isearch-forward
2631 'search-forward-lax-whitespace
2632 'search-backward-lax-whitespace))
2633 (t
2634 (if isearch-forward 'search-forward 'search-backward))))
2636 (defun isearch-search-string (string bound noerror)
2637 "Search for the first occurrence of STRING or its translation.
2638 If found, move point to the end of the occurrence,
2639 update the match data, and return point."
2640 (let* ((func (isearch-search-fun))
2641 (pos1 (save-excursion (funcall func string bound noerror)))
2642 pos2)
2643 (when (and
2644 ;; Avoid "obsolete" warnings for translation-table-for-input.
2645 (with-no-warnings
2646 (char-table-p translation-table-for-input))
2647 (multibyte-string-p string)
2648 ;; Minor optimization.
2649 (string-match-p "[^[:ascii:]]" string))
2650 (let ((translated
2651 (apply 'string
2652 (mapcar (lambda (c)
2653 (or
2654 ;; Avoid "obsolete" warnings for
2655 ;; translation-table-for-input.
2656 (with-no-warnings
2657 (aref translation-table-for-input c))
2658 c))
2659 string)))
2660 match-data)
2661 (when translated
2662 (save-match-data
2663 (save-excursion
2664 (if (setq pos2 (funcall func translated bound noerror))
2665 (setq match-data (match-data t)))))
2666 (when (and pos2
2667 (or (not pos1)
2668 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2669 (setq pos1 pos2)
2670 (set-match-data match-data)))))
2671 (when pos1
2672 ;; When using multiple buffers isearch, switch to the new buffer here,
2673 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2674 (if (and multi-isearch-next-buffer-current-function
2675 (buffer-live-p multi-isearch-current-buffer))
2676 (switch-to-buffer multi-isearch-current-buffer))
2677 (goto-char pos1)
2678 pos1)))
2680 (defun isearch-search ()
2681 ;; Do the search with the current search string.
2682 (if isearch-message-function
2683 (funcall isearch-message-function nil t)
2684 (isearch-message nil t))
2685 (if (and (eq isearch-case-fold-search t) search-upper-case)
2686 (setq isearch-case-fold-search
2687 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2688 (condition-case lossage
2689 (let ((inhibit-point-motion-hooks isearch-invisible)
2690 (inhibit-quit nil)
2691 (case-fold-search isearch-case-fold-search)
2692 (search-invisible isearch-invisible)
2693 (retry t))
2694 (setq isearch-error nil)
2695 (while retry
2696 (setq isearch-success
2697 (isearch-search-string isearch-string nil t))
2698 ;; Clear RETRY unless the search predicate says
2699 ;; to skip this search hit.
2700 (if (or (not isearch-success)
2701 (bobp) (eobp)
2702 (= (match-beginning 0) (match-end 0))
2703 (funcall isearch-filter-predicate
2704 (match-beginning 0) (match-end 0)))
2705 (setq retry nil)))
2706 (setq isearch-just-started nil)
2707 (if isearch-success
2708 (setq isearch-other-end
2709 (if isearch-forward (match-beginning 0) (match-end 0)))))
2711 (quit (isearch-unread ?\C-g)
2712 (setq isearch-success nil))
2714 (invalid-regexp
2715 (setq isearch-error (car (cdr lossage)))
2716 (cond
2717 ((string-match
2719 isearch-error)
2720 (setq isearch-error "incomplete input"))
2721 ((and (not isearch-regexp)
2723 (cond
2724 (isearch-word
2725 (setq isearch-error "Too many words"))
2726 ((and isearch-lax-whitespace search-whitespace-regexp)
2727 (setq isearch-error "Too many spaces for whitespace matching"))))))
2729 (search-failed
2730 (setq isearch-success nil)
2731 (setq isearch-error (nth 2 lossage)))
2733 (error
2734 ;; stack overflow in regexp search.
2735 (setq isearch-error (format "%s" lossage))))
2737 (if isearch-success
2738 nil
2739 ;; Ding if failed this time after succeeding last time.
2740 (and (isearch--state-success (car isearch-cmds))
2741 (ding))
2742 (if (functionp (isearch--state-pop-fun (car isearch-cmds)))
2743 (funcall (isearch--state-pop-fun (car isearch-cmds))
2744 (car isearch-cmds)))
2745 (goto-char (isearch--state-point (car isearch-cmds)))))
2748 ;; Called when opening an overlay, and we are still in isearch.
2749 (defun isearch-open-overlay-temporary (ov)
2750 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2751 ;; Some modes would want to open the overlays temporary during
2752 ;; isearch in their own way, they should set the
2753 ;; `isearch-open-invisible-temporary' to a function doing this.
2754 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2755 ;; Store the values for the `invisible' property, and then set it to nil.
2756 ;; This way the text hidden by this overlay becomes visible.
2758 ;; In 19.34 this does not exist so I cannot test it.
2759 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2760 (overlay-put ov 'invisible nil)))
2763 ;; This is called at the end of isearch. It will open the overlays
2764 ;; that contain the latest match. Obviously in case of a C-g the
2765 ;; point returns to the original location which surely is not contain
2766 ;; in any of these overlays, se we are safe in this case too.
2767 (defun isearch-open-necessary-overlays (ov)
2768 (let ((inside-overlay (and (> (point) (overlay-start ov))
2769 (<= (point) (overlay-end ov))))
2770 ;; If this exists it means that the overlay was opened using
2771 ;; this function, not by us tweaking the overlay properties.
2772 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2773 (when (or inside-overlay (not fct-temp))
2774 ;; restore the values for the `invisible' properties.
2775 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2776 (overlay-put ov 'isearch-invisible nil))
2777 (if inside-overlay
2778 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2779 (if fct-temp
2780 (funcall fct-temp ov t)))))
2782 ;; This is called when exiting isearch. It closes the temporary
2783 ;; opened overlays, except the ones that contain the latest match.
2784 (defun isearch-clean-overlays ()
2785 (when isearch-opened-overlays
2786 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2787 (setq isearch-opened-overlays nil)))
2790 (defun isearch-intersects-p (start0 end0 start1 end1)
2791 "Return t if regions START0..END0 and START1..END1 intersect."
2792 (or (and (>= start0 start1) (< start0 end1))
2793 (and (> end0 start1) (<= end0 end1))
2794 (and (>= start1 start0) (< start1 end0))
2795 (and (> end1 start0) (<= end1 end0))))
2798 ;; Verify if the current match is outside of each element of
2799 ;; `isearch-opened-overlays', if so close that overlay.
2801 (defun isearch-close-unnecessary-overlays (begin end)
2802 (let ((overlays isearch-opened-overlays))
2803 (setq isearch-opened-overlays nil)
2804 (dolist (ov overlays)
2805 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2806 (push ov isearch-opened-overlays)
2807 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2808 (if fct-temp
2809 ;; If this exists it means that the overlay was opened
2810 ;; using this function, not by us tweaking the overlay
2811 ;; properties.
2812 (funcall fct-temp ov t)
2813 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2814 (overlay-put ov 'isearch-invisible nil)))))))
2817 (defun isearch-range-invisible (beg end)
2818 "Return t if all the text from BEG to END is invisible."
2819 (when (/= beg end)
2820 ;; Check that invisibility runs up to END.
2821 (save-excursion
2822 (goto-char beg)
2823 (let (;; can-be-opened keeps track if we can open some overlays.
2824 (can-be-opened (eq search-invisible 'open))
2825 ;; the list of overlays that could be opened
2826 (crt-overlays nil))
2827 (when (and can-be-opened isearch-hide-immediately)
2828 (isearch-close-unnecessary-overlays beg end))
2829 ;; If the following character is currently invisible,
2830 ;; skip all characters with that same `invisible' property value.
2831 ;; Do that over and over.
2832 (while (and (< (point) end) (invisible-p (point)))
2833 (if (invisible-p (get-text-property (point) 'invisible))
2834 (progn
2835 (goto-char (next-single-property-change (point) 'invisible
2836 nil end))
2837 ;; if text is hidden by an `invisible' text property
2838 ;; we cannot open it at all.
2839 (setq can-be-opened nil))
2840 (when can-be-opened
2841 (let ((overlays (overlays-at (point)))
2842 ov-list
2843 o
2844 invis-prop)
2845 (while overlays
2846 (setq o (car overlays)
2847 invis-prop (overlay-get o 'invisible))
2848 (if (invisible-p invis-prop)
2849 (if (overlay-get o 'isearch-open-invisible)
2850 (setq ov-list (cons o ov-list))
2851 ;; We found one overlay that cannot be
2852 ;; opened, that means the whole chunk
2853 ;; cannot be opened.
2854 (setq can-be-opened nil)))
2855 (setq overlays (cdr overlays)))
2856 (if can-be-opened
2857 ;; It makes sense to append to the open
2858 ;; overlays list only if we know that this is
2859 ;; t.
2860 (setq crt-overlays (append ov-list crt-overlays)))))
2861 (goto-char (next-overlay-change (point)))))
2862 ;; See if invisibility reaches up thru END.
2863 (if (>= (point) end)
2864 (if (and can-be-opened (consp crt-overlays))
2865 (progn
2866 (setq isearch-opened-overlays
2867 (append isearch-opened-overlays crt-overlays))
2868 (mapc 'isearch-open-overlay-temporary crt-overlays)
2869 nil)
2870 (setq isearch-hidden t)))))))
2872 (defun isearch-filter-visible (beg end)
2873 "Test whether the current search hit is visible at least partially.
2874 Return non-nil if the text from BEG to END is visible to Isearch as
2875 determined by `isearch-range-invisible' unless invisible text can be
2876 searched too when `search-invisible' is t."
2877 (or (eq search-invisible t)
2878 (not (isearch-range-invisible beg end))))
2880 \f
2881 ;; General utilities
2883 (defun isearch-no-upper-case-p (string regexp-flag)
2884 "Return t if there are no upper case chars in STRING.
2886 since they have special meaning in a regexp."
2887 (let (quote-flag (i 0) (len (length string)) found)
2888 (while (and (not found) (< i len))
2889 (let ((char (aref string i)))
2891 (setq quote-flag (not quote-flag))
2892 (if (and (not quote-flag) (not (eq char (downcase char))))
2893 (setq found t))
2894 (setq quote-flag nil)))
2895 (setq i (1+ i)))
2896 (not (or found
2897 ;; Even if there's no uppercase char, we want to detect the use
2898 ;; of [:upper:] or [:lower:] char-class, which indicates
2899 ;; clearly that the user cares about case distinction.
2901 (condition-case err
2902 (progn
2903 (string-match (substring string 0 (match-beginning 0))
2904 "")
2905 nil)
2906 (invalid-regexp
2907 (equal "Unmatched [ or [^" (cadr err)))))))))
2909 ;; Portability functions to support various Emacs versions.
2911 (defun isearch-text-char-description (c)
2912 (cond
2913 ((< c ?\s) (propertize
2914 (char-to-string c)
2915 'display (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph)))
2916 ((= c ?\^?) (propertize
2917 (char-to-string c)
2918 'display (propertize "^?" 'face 'escape-glyph)))
2919 (t (char-to-string c))))
2921 ;; General function to unread characters or events.
2922 ;; Also insert them in a keyboard macro being defined.
2923 (defun isearch-unread (&rest char-or-events)
2924 (mapc 'store-kbd-macro-event char-or-events)
2925 (setq unread-command-events
2926 (append char-or-events unread-command-events)))
2928 \f
2929 ;; Highlighting
2931 (defvar isearch-overlay nil)
2933 (defun isearch-highlight (beg end)
2934 (if search-highlight
2935 (if isearch-overlay
2936 ;; Overlay already exists, just move it.
2937 (move-overlay isearch-overlay beg end (current-buffer))
2938 ;; Overlay doesn't exist, create it.
2939 (setq isearch-overlay (make-overlay beg end))
2940 ;; 1001 is higher than lazy's 1000 and ediff's 100+
2941 (overlay-put isearch-overlay 'priority 1001)
2942 (overlay-put isearch-overlay 'face isearch-face))))
2944 (defun isearch-dehighlight ()
2945 (when isearch-overlay
2946 (delete-overlay isearch-overlay)))
2947 \f
2948 ;; isearch-lazy-highlight feature
2949 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
2951 ;; When active, *every* match for the current search string is
2952 ;; highlighted: the current one using the normal isearch match color
2953 ;; and all the others using `isearch-lazy-highlight'. The extra
2954 ;; highlighting makes it easier to anticipate where the cursor will
2955 ;; land each time you press C-s or C-r to repeat a pending search.
2956 ;; Highlighting of these additional matches happens in a deferred
2957 ;; fashion using "idle timers," so the cycles needed do not rob
2958 ;; isearch of its usual snappy response.
2960 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
2961 ;; Specifically:
2962 ;; - `isearch-update' is expected to be called (at least) every time
2963 ;; the search string or window-start changes;
2964 ;; - `isearch-string' is expected to contain the current search
2965 ;; string as entered by the user;
2966 ;; - the type of the current search is expected to be given by
2967 ;; `isearch-word' and `isearch-regexp';
2968 ;; - the direction of the current search is expected to be given by
2969 ;; `isearch-forward';
2970 ;; - the variable `isearch-error' is expected to be true
2971 ;; only if `isearch-string' is an invalid regexp.
2973 (defvar isearch-lazy-highlight-overlays nil)
2974 (defvar isearch-lazy-highlight-wrapped nil)
2975 (defvar isearch-lazy-highlight-start-limit nil)
2976 (defvar isearch-lazy-highlight-end-limit nil)
2977 (defvar isearch-lazy-highlight-start nil)
2978 (defvar isearch-lazy-highlight-end nil)
2979 (defvar isearch-lazy-highlight-timer nil)
2980 (defvar isearch-lazy-highlight-last-string nil)
2981 (defvar isearch-lazy-highlight-window nil)
2982 (defvar isearch-lazy-highlight-window-start nil)
2983 (defvar isearch-lazy-highlight-window-end nil)
2984 (defvar isearch-lazy-highlight-case-fold-search nil)
2985 (defvar isearch-lazy-highlight-regexp nil)
2986 (defvar isearch-lazy-highlight-lax-whitespace nil)
2987 (defvar isearch-lazy-highlight-regexp-lax-whitespace nil)
2988 (defvar isearch-lazy-highlight-word nil)
2989 (defvar isearch-lazy-highlight-forward nil)
2990 (defvar isearch-lazy-highlight-error nil)
2992 (defun lazy-highlight-cleanup (&optional force)
2993 "Stop lazy highlighting and remove extra highlighting from current buffer.
2994 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
2995 is nil. This function is called when exiting an incremental search if
2996 `lazy-highlight-cleanup' is non-nil."
2997 (interactive '(t))
2998 (if (or force lazy-highlight-cleanup)
2999 (while isearch-lazy-highlight-overlays
3000 (delete-overlay (car isearch-lazy-highlight-overlays))
3001 (setq isearch-lazy-highlight-overlays
3002 (cdr isearch-lazy-highlight-overlays))))
3003 (when isearch-lazy-highlight-timer
3004 (cancel-timer isearch-lazy-highlight-timer)
3005 (setq isearch-lazy-highlight-timer nil)))
3007 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
3008 'lazy-highlight-cleanup
3009 "22.1")
3011 (defun isearch-lazy-highlight-new-loop (&optional beg end)
3012 "Cleanup any previous `lazy-highlight' loop and begin a new one.
3013 BEG and END specify the bounds within which highlighting should occur.
3014 This is called when `isearch-update' is invoked (which can cause the
3015 search string to change or the window to scroll). It is also used
3016 by other Emacs features."
3017 (when (and (null executing-kbd-macro)
3018 (sit-for 0) ;make sure (window-start) is credible
3019 (or (not (equal isearch-string
3020 isearch-lazy-highlight-last-string))
3021 (not (eq (selected-window)
3022 isearch-lazy-highlight-window))
3023 (not (eq isearch-lazy-highlight-case-fold-search
3024 isearch-case-fold-search))
3025 (not (eq isearch-lazy-highlight-regexp
3026 isearch-regexp))
3027 (not (eq isearch-lazy-highlight-word
3028 isearch-word))
3029 (not (eq isearch-lazy-highlight-lax-whitespace
3030 isearch-lax-whitespace))
3031 (not (eq isearch-lazy-highlight-regexp-lax-whitespace
3032 isearch-regexp-lax-whitespace))
3033 (not (= (window-start)
3034 isearch-lazy-highlight-window-start))
3035 (not (= (window-end) ; Window may have been split/joined.
3036 isearch-lazy-highlight-window-end))
3037 (not (eq isearch-forward
3038 isearch-lazy-highlight-forward))
3039 ;; In case we are recovering from an error.
3040 (not (equal isearch-error
3041 isearch-lazy-highlight-error))))
3042 ;; something important did indeed change
3043 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
3044 (setq isearch-lazy-highlight-error isearch-error)
3045 ;; It used to check for `(not isearch-error)' here, but actually
3046 ;; lazy-highlighting might find matches to highlight even when
3047 ;; `isearch-error' is non-nil. (Bug#9918)
3048 (setq isearch-lazy-highlight-start-limit beg
3049 isearch-lazy-highlight-end-limit end)
3050 (setq isearch-lazy-highlight-window (selected-window)
3051 isearch-lazy-highlight-window-start (window-start)
3052 isearch-lazy-highlight-window-end (window-end)
3053 ;; Start lazy-highlighting at the beginning of the found
3054 ;; match (`isearch-other-end'). If no match, use point.
3055 ;; One of the next two variables (depending on search direction)
3056 ;; is used to define the starting position of lazy-highlighting
3057 ;; and also to remember the current position of point between
3058 ;; calls of `isearch-lazy-highlight-update', and another variable
3059 ;; is used to define where the wrapped search must stop.
3060 isearch-lazy-highlight-start (or isearch-other-end (point))
3061 isearch-lazy-highlight-end (or isearch-other-end (point))
3062 isearch-lazy-highlight-wrapped nil
3063 isearch-lazy-highlight-last-string isearch-string
3064 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
3065 isearch-lazy-highlight-regexp isearch-regexp
3066 isearch-lazy-highlight-lax-whitespace isearch-lax-whitespace
3067 isearch-lazy-highlight-regexp-lax-whitespace isearch-regexp-lax-whitespace
3068 isearch-lazy-highlight-word isearch-word
3069 isearch-lazy-highlight-forward isearch-forward)
3070 (unless (equal isearch-string "")
3071 (setq isearch-lazy-highlight-timer
3072 (run-with-idle-timer lazy-highlight-initial-delay nil
3073 'isearch-lazy-highlight-update)))))
3075 (defun isearch-lazy-highlight-search ()
3076 "Search ahead for the next or previous match, for lazy highlighting.
3077 Attempt to do the search exactly the way the pending Isearch would."
3078 (condition-case nil
3079 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
3080 (isearch-regexp isearch-lazy-highlight-regexp)
3081 (isearch-word isearch-lazy-highlight-word)
3082 (isearch-lax-whitespace
3083 isearch-lazy-highlight-lax-whitespace)
3084 (isearch-regexp-lax-whitespace
3085 isearch-lazy-highlight-regexp-lax-whitespace)
3086 (isearch-forward isearch-lazy-highlight-forward)
3087 (search-invisible nil) ; don't match invisible text
3088 (retry t)
3089 (success nil)
3090 (bound (if isearch-lazy-highlight-forward
3091 (min (or isearch-lazy-highlight-end-limit (point-max))
3092 (if isearch-lazy-highlight-wrapped
3093 (+ isearch-lazy-highlight-start
3094 ;; Extend bound to match whole string at point
3095 (1- (length isearch-lazy-highlight-last-string)))
3096 (window-end)))
3097 (max (or isearch-lazy-highlight-start-limit (point-min))
3098 (if isearch-lazy-highlight-wrapped
3099 (- isearch-lazy-highlight-end
3100 ;; Extend bound to match whole string at point
3101 (1- (length isearch-lazy-highlight-last-string)))
3102 (window-start))))))
3103 ;; Use a loop like in `isearch-search'.
3104 (while retry
3105 (setq success (isearch-search-string
3106 isearch-lazy-highlight-last-string bound t))
3107 ;; Clear RETRY unless the search predicate says
3108 ;; to skip this search hit.
3109 (if (or (not success)
3110 (= (point) bound) ; like (bobp) (eobp) in `isearch-search'.
3111 (= (match-beginning 0) (match-end 0))
3112 (funcall isearch-filter-predicate
3113 (match-beginning 0) (match-end 0)))
3114 (setq retry nil)))
3115 success)
3116 (error nil)))
3118 (defun isearch-lazy-highlight-update ()
3119 "Update highlighting of other matches for current search."
3120 (let ((max lazy-highlight-max-at-a-time)
3121 (looping t)
3122 nomore)
3123 (with-local-quit
3124 (save-selected-window
3125 (if (and (window-live-p isearch-lazy-highlight-window)
3126 (not (eq (selected-window) isearch-lazy-highlight-window)))
3127 (select-window isearch-lazy-highlight-window))
3128 (save-excursion
3129 (save-match-data
3130 (goto-char (if isearch-lazy-highlight-forward
3131 isearch-lazy-highlight-end
3132 isearch-lazy-highlight-start))
3133 (while looping
3134 (let ((found (isearch-lazy-highlight-search)))
3135 (when max
3136 (setq max (1- max))
3137 (if (<= max 0)
3138 (setq looping nil)))
3139 (if found
3140 (let ((mb (match-beginning 0))
3141 (me (match-end 0)))
3142 (if (= mb me) ;zero-length match
3143 (if isearch-lazy-highlight-forward
3144 (if (= mb (if isearch-lazy-highlight-wrapped
3145 isearch-lazy-highlight-start
3146 (window-end)))
3147 (setq found nil)
3148 (forward-char 1))
3149 (if (= mb (if isearch-lazy-highlight-wrapped
3150 isearch-lazy-highlight-end
3151 (window-start)))
3152 (setq found nil)
3153 (forward-char -1)))
3155 ;; non-zero-length match
3156 (let ((ov (make-overlay mb me)))
3157 (push ov isearch-lazy-highlight-overlays)
3158 ;; 1000 is higher than ediff's 100+,
3159 ;; but lower than isearch main overlay's 1001
3160 (overlay-put ov 'priority 1000)
3161 (overlay-put ov 'face lazy-highlight-face)
3162 (overlay-put ov 'window (selected-window))))
3163 ;; Remember the current position of point for
3164 ;; the next call of `isearch-lazy-highlight-update'
3165 ;; when `lazy-highlight-max-at-a-time' is too small.
3166 (if isearch-lazy-highlight-forward
3167 (setq isearch-lazy-highlight-end (point))
3168 (setq isearch-lazy-highlight-start (point)))))
3170 ;; not found or zero-length match at the search bound
3171 (if (not found)
3172 (if isearch-lazy-highlight-wrapped
3173 (setq looping nil
3174 nomore t)
3175 (setq isearch-lazy-highlight-wrapped t)
3176 (if isearch-lazy-highlight-forward
3177 (progn
3178 (setq isearch-lazy-highlight-end (window-start))
3179 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
3180 (window-start))))
3181 (setq isearch-lazy-highlight-start (window-end))
3182 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
3183 (window-end))))))))
3184 (unless nomore
3185 (setq isearch-lazy-highlight-timer
3186 (run-at-time lazy-highlight-interval nil
3187 'isearch-lazy-highlight-update)))))))))
3189 (defun isearch-resume (string regexp word forward message case-fold)
3190 "Resume an incremental search.
3191 STRING is the string or regexp searched for.
3192 REGEXP non-nil means the resumed search was a regexp search.
3193 WORD non-nil means resume a word search.
3194 FORWARD non-nil means resume a forward search.
3195 MESSAGE is the echo-area message recorded for the search resumed.
3196 CASE-FOLD non-nil means the search was case-insensitive."
3197 (isearch-mode forward regexp nil nil word)
3198 (setq isearch-string string
3199 isearch-message message
3200 isearch-case-fold-search case-fold)
3201 (isearch-search)
3202 (isearch-update))
3204 ;;; isearch.el ends here