| blob | 8d4bf24c6fb719a0881aa4e30fd8e4b25a1c023d |
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.
715 In incremental searches, a space or spaces normally matches any whitespace
716 defined by the variable `search-whitespace-regexp'; see also the variables
717 `isearch-lax-whitespace' and `isearch-regexp-lax-whitespace'.
721 Also supported is a search ring of the previous 16 search strings.
724 ring.
728 replace from last search string.
730 with the last search string.
732 the last search string.
734 that highlights the last search string.
740 If an input method is turned on in the current buffer, that input
741 method is also active while you are typing characters to search.
743 It also toggles the input
744 method in the current buffer.
746 To use a different input method for searching, type \
748 and specify an input method you want to use.
750 The above keys, bound in `isearch-mode-map', are often controlled by
752 Other control and meta characters terminate the search
753 and are then executed normally (depending on `search-exit-option').
754 Likewise for function keys and mouse button events.
756 If this function is called non-interactively with a nil NO-RECURSIVE-EDIT,
757 it does not return to the calling function until the search is done.
758 See the function `isearch-mode' for more information."
761 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
763 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
764 "Do incremental search forward for regular expression.
765 With a prefix argument, do a regular string search instead.
766 Like ordinary incremental search except that your input is treated
767 as a regexp. See the command `isearch-forward' for more information.
769 In incremental searches, a space or spaces normally matches any
770 whitespace defined by the variable `search-whitespace-regexp'.
771 To search for a literal space and nothing else, enter C-q SPC.
772 To toggle whitespace matching, use `isearch-toggle-lax-whitespace'."
774 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
776 (defun isearch-forward-word (&optional not-word no-recursive-edit)
777 "Do incremental search forward for a sequence of words.
778 With a prefix argument, do a regular string search instead.
779 Like ordinary incremental search except that your input is treated
780 as a sequence of words without regard to how the words are separated.
781 See the command `isearch-forward' for more information."
783 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
785 (defun isearch-forward-symbol (&optional _not-symbol no-recursive-edit)
786 "Do incremental search forward for a symbol.
787 The prefix argument is currently unused.
788 Like ordinary incremental search except that your input is treated
790 See the command `isearch-forward' for more information."
792 (isearch-mode t nil nil (not no-recursive-edit) 'isearch-symbol-regexp))
794 (defun isearch-backward (&optional regexp-p no-recursive-edit)
795 "Do incremental search backward.
796 With a prefix argument, do a regular expression search instead.
797 See the command `isearch-forward' for more information."
799 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
801 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
802 "Do incremental search backward for regular expression.
803 With a prefix argument, do a regular string search instead.
804 Like ordinary incremental search except that your input is treated
805 as a regexp. See the command `isearch-forward' for more information."
807 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
809 (defun isearch-forward-symbol-at-point ()
810 "Do incremental search forward for a symbol found near point.
811 Like ordinary incremental search except that the symbol found at point
812 is added to the search string initially as a regexp surrounded
814 See the command `isearch-forward-symbol' for more information."
815 (interactive)
816 (isearch-forward-symbol nil 1)
817 (let ((bounds (find-tag-default-bounds)))
818 (cond
819 (bounds
820 (when (< (car bounds) (point))
821 (goto-char (car bounds)))
822 (isearch-yank-string
823 (buffer-substring-no-properties (car bounds) (cdr bounds))))
824 (t
825 (setq isearch-error "No symbol at point")
826 (isearch-update)))))
828 \f
829 (defvar cursor-sensor-inhibit)
830 ;; isearch-mode only sets up incremental search for the minor mode.
831 ;; All the work is done by the isearch-mode commands.
833 ;; Not used yet:
834 ;;(defvar isearch-commands '(isearch-forward isearch-backward
835 ;; isearch-forward-regexp isearch-backward-regexp)
836 ;; "List of commands for which isearch-mode does not recursive-edit.")
838 (autoload 'character-fold-to-regexp "character-fold")
839 (put 'character-fold-to-regexp 'isearch-message-prefix "char-fold ")
840 (defvar character-fold-search)
842 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word)
843 "Start Isearch minor mode.
844 It is called by the function `isearch-forward' and other related functions.
846 The non-nil arg FORWARD means searching in the forward direction.
848 The non-nil arg REGEXP does an incremental regular expression search.
850 The arg OP-FUN is a function to be called after each input character
851 is processed. (It is not called after characters that exit the search.)
853 When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and
854 does not return to the calling function until the search is completed.
855 To behave this way it enters a recursive-edit and exits it when done
856 isearching.
858 The arg WORD, if t, does incremental search for a sequence of words,
859 ignoring punctuation. If the value is a function, it is called to
860 convert the search string to a regexp used by regexp search functions."
862 ;; Initialize global vars.
863 (setq isearch-forward forward
864 isearch-regexp regexp
865 isearch-word (or word (and character-fold-search
866 (not regexp)
867 'character-fold-to-regexp))
868 isearch-op-fun op-fun
869 isearch-last-case-fold-search isearch-case-fold-search
870 isearch-case-fold-search case-fold-search
871 isearch-invisible search-invisible
872 isearch-string ""
873 isearch-message ""
874 isearch-cmds nil
875 isearch-success t
876 isearch-wrapped nil
877 isearch-barrier (point)
878 isearch-adjusted nil
879 isearch-yank-flag nil
880 isearch-error nil
881 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
882 (> (window-height)
883 (* 4
884 (abs search-slow-window-lines))))
885 isearch-other-end nil
886 isearch-small-window nil
887 isearch-just-started t
888 isearch-start-hscroll (window-hscroll)
890 isearch-opoint (point)
891 search-ring-yank-pointer nil
892 isearch-opened-overlays nil
893 isearch-input-method-function input-method-function
894 isearch-input-method-local-p (local-variable-p 'input-method-function)
895 regexp-search-ring-yank-pointer nil
897 ;; Save the original value of `minibuffer-message-timeout', and
898 ;; set it to nil so that isearch's messages don't get timed out.
899 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
900 minibuffer-message-timeout nil)
902 ;; We must bypass input method while reading key. When a user type
903 ;; printable character, appropriate input method is turned on in
904 ;; minibuffer to read multibyte characters.
905 (or isearch-input-method-local-p
906 (make-local-variable 'input-method-function))
907 (setq input-method-function nil)
909 (looking-at "")
910 (setq isearch-window-configuration
911 (if isearch-slow-terminal-mode (current-window-configuration) nil))
913 ;; Maybe make minibuffer frame visible and/or raise it.
914 (let ((frame (window-frame (minibuffer-window))))
915 (unless (memq (frame-live-p frame) '(nil t))
916 (unless (frame-visible-p frame)
917 (make-frame-visible frame))
918 (if minibuffer-auto-raise
919 (raise-frame frame))))
921 (setq isearch-mode " Isearch") ;; forward? regexp?
922 (force-mode-line-update)
924 (setq overriding-terminal-local-map isearch-mode-map)
925 (run-hooks 'isearch-mode-hook)
926 ;; Remember the initial map possibly modified
927 ;; by external packages in isearch-mode-hook. (Bug#16035)
928 (setq isearch--saved-overriding-local-map overriding-terminal-local-map)
930 ;; Pushing the initial state used to be before running isearch-mode-hook,
931 ;; but a hook might set `isearch-push-state-function' used in
932 ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994)
933 (isearch-push-state)
935 (isearch-update)
937 (add-hook 'pre-command-hook 'isearch-pre-command-hook)
938 (add-hook 'post-command-hook 'isearch-post-command-hook)
939 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
940 (add-hook 'kbd-macro-termination-hook 'isearch-done)
942 ;; isearch-mode can be made modal (in the sense of not returning to
943 ;; the calling function until searching is completed) by entering
944 ;; a recursive-edit and exiting it when done isearching.
945 (if recursive-edit
946 (let ((isearch-recursive-edit t))
947 (recursive-edit)))
948 isearch-success)
951 ;; Some high level utilities. Others below.
952 (defvar isearch--current-buffer nil)
954 (defun isearch-update ()
955 "This is called after every isearch command to update the display.
956 The last thing it does is to run `isearch-update-post-hook'."
957 (unless (eq (current-buffer) isearch--current-buffer)
958 (when isearch--current-buffer
959 (with-current-buffer isearch--current-buffer
960 (setq cursor-sensor-inhibit (delq 'isearch cursor-sensor-inhibit))))
961 (setq isearch--current-buffer (current-buffer))
962 (make-local-variable 'cursor-sensor-inhibit)
963 (unless (boundp 'cursor-sensor-inhibit)
964 (setq cursor-sensor-inhibit nil))
965 ;; Suspend things like cursor-intangible during Isearch so we can search
966 ;; even within intangible text.
967 (push 'isearch cursor-sensor-inhibit))
969 (if (and (null unread-command-events)
970 (null executing-kbd-macro))
971 (progn
972 (if (not (input-pending-p))
973 (if isearch-message-function
974 (funcall isearch-message-function)
975 (isearch-message)))
976 (if (and isearch-slow-terminal-mode
977 (not (or isearch-small-window
978 (pos-visible-in-window-p))))
979 (let ((found-point (point)))
980 (setq isearch-small-window t)
981 (move-to-window-line 0)
982 (let ((window-min-height 1))
983 (split-window nil (if (< search-slow-window-lines 0)
984 (1+ (- search-slow-window-lines))
985 (- (window-height)
986 (1+ search-slow-window-lines)))))
987 (if (< search-slow-window-lines 0)
988 (progn (vertical-motion (- 1 search-slow-window-lines))
989 (set-window-start (next-window) (point))
990 (set-window-hscroll (next-window)
991 (window-hscroll))
992 (set-window-hscroll (selected-window) 0))
993 (other-window 1))
994 (goto-char found-point))
995 ;; Keep same hscrolling as at the start of the search when possible
996 (let ((current-scroll (window-hscroll))
997 visible-p)
998 (set-window-hscroll (selected-window) isearch-start-hscroll)
999 (setq visible-p (pos-visible-in-window-p nil nil t))
1000 (if (or (not visible-p)
1001 ;; When point is not visible because of hscroll,
1002 ;; pos-visible-in-window-p returns non-nil, but
1003 ;; the X coordinate it returns is 1 pixel beyond
1004 ;; the last visible one.
1005 (>= (car visible-p) (window-body-width nil t)))
1006 (set-window-hscroll (selected-window) current-scroll))))
1007 (if isearch-other-end
1008 (if (< isearch-other-end (point)) ; isearch-forward?
1009 (isearch-highlight isearch-other-end (point))
1010 (isearch-highlight (point) isearch-other-end))
1011 (isearch-dehighlight))))
1012 (setq ;; quit-flag nil not for isearch-mode
1013 isearch-adjusted nil
1014 isearch-yank-flag nil)
1015 (when isearch-lazy-highlight
1016 (isearch-lazy-highlight-new-loop))
1017 ;; We must prevent the point moving to the end of composition when a
1018 ;; part of the composition has just been searched.
1019 (setq disable-point-adjustment t)
1020 (run-hooks 'isearch-update-post-hook))
1022 (defun isearch-done (&optional nopush edit)
1023 "Exit Isearch mode.
1024 For successful search, pass no args.
1025 For a failing search, NOPUSH is t.
1026 For going to the minibuffer to edit the search string,
1027 NOPUSH is t and EDIT is t."
1029 (if isearch-resume-in-command-history
1030 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
1031 ,isearch-word ,isearch-forward
1032 ,isearch-message
1033 ',isearch-case-fold-search)))
1034 (unless (equal (car command-history) command)
1035 (setq command-history (cons command command-history)))))
1037 (remove-hook 'pre-command-hook 'isearch-pre-command-hook)
1038 (remove-hook 'post-command-hook 'isearch-post-command-hook)
1039 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
1040 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
1041 (setq isearch-lazy-highlight-start nil)
1042 (with-current-buffer isearch--current-buffer
1043 (setq isearch--current-buffer nil)
1044 (setq cursor-sensor-inhibit (delq 'isearch cursor-sensor-inhibit)))
1046 ;; Called by all commands that terminate isearch-mode.
1047 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
1048 (setq overriding-terminal-local-map nil)
1049 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
1050 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
1051 (isearch-dehighlight)
1052 (lazy-highlight-cleanup lazy-highlight-cleanup)
1053 (let ((found-start (window-start))
1054 (found-point (point)))
1055 (when isearch-window-configuration
1056 (set-window-configuration isearch-window-configuration)
1057 (if isearch-small-window
1058 (goto-char found-point)
1059 ;; set-window-configuration clobbers window-start; restore it.
1060 ;; This has an annoying side effect of clearing the last_modiff
1061 ;; field of the window, which can cause unwanted scrolling,
1062 ;; so don't do it unless truly necessary.
1063 (set-window-start (selected-window) found-start t))))
1065 (setq isearch-mode nil)
1066 (if isearch-input-method-local-p
1067 (setq input-method-function isearch-input-method-function)
1068 (kill-local-variable 'input-method-function))
1070 (force-mode-line-update)
1072 ;; If we ended in the middle of some intangible text,
1073 ;; move to the further end of that intangible text.
1074 (let ((after (if (eobp) nil
1075 (get-text-property (point) 'intangible)))
1076 (before (if (bobp) nil
1077 (get-text-property (1- (point)) 'intangible))))
1078 (when (and before after (eq before after))
1079 (goto-char
1080 (if isearch-forward
1081 (next-single-property-change (point) 'intangible)
1082 (previous-single-property-change (point) 'intangible)))))
1084 (if (and (> (length isearch-string) 0) (not nopush))
1085 ;; Update the ring data.
1086 (isearch-update-ring isearch-string isearch-regexp))
1088 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
1089 (run-hooks 'isearch-mode-end-hook))
1091 ;; If there was movement, mark the starting position.
1092 ;; Maybe should test difference between and set mark only if > threshold.
1093 (if (/= (point) isearch-opoint)
1094 (or (and transient-mark-mode mark-active)
1095 (progn
1096 (push-mark isearch-opoint t)
1097 (or executing-kbd-macro (> (minibuffer-depth) 0) edit
1098 (message "Mark saved where search started")))))
1100 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
1102 (defun isearch-update-ring (string &optional regexp)
1103 "Add STRING to the beginning of the search ring.
1104 REGEXP if non-nil says use the regexp search ring."
1105 (add-to-history
1106 (if regexp 'regexp-search-ring 'search-ring)
1107 string
1108 (if regexp regexp-search-ring-max search-ring-max)))
1110 ;; Switching buffers should first terminate isearch-mode.
1111 ;; ;; For Emacs 19, the frame switch event is handled.
1112 ;; (defun isearch-switch-frame-handler ()
1113 ;; (interactive) ;; Is this necessary?
1114 ;; ;; First terminate isearch-mode.
1115 ;; (isearch-done)
1116 ;; (isearch-clean-overlays)
1117 ;; (handle-switch-frame (car (cdr last-command-event))))
1119 \f
1120 ;; The search status structure and stack.
1122 (cl-defstruct (isearch--state
1123 (:constructor nil)
1124 (:copier nil)
1125 (:constructor isearch--get-state
1126 (&aux
1127 (string isearch-string)
1128 (message isearch-message)
1129 (point (point))
1130 (success isearch-success)
1131 (forward isearch-forward)
1132 (other-end isearch-other-end)
1133 (word isearch-word)
1134 (error isearch-error)
1135 (wrapped isearch-wrapped)
1136 (barrier isearch-barrier)
1137 (case-fold-search isearch-case-fold-search)
1138 (pop-fun (if isearch-push-state-function
1139 (funcall isearch-push-state-function))))))
1140 (string :read-only t)
1141 (message :read-only t)
1142 (point :read-only t)
1143 (success :read-only t)
1144 (forward :read-only t)
1145 (other-end :read-only t)
1146 (word :read-only t)
1147 (error :read-only t)
1148 (wrapped :read-only t)
1149 (barrier :read-only t)
1150 (case-fold-search :read-only t)
1151 (pop-fun :read-only t))
1153 (defun isearch--set-state (cmd)
1154 (setq isearch-string (isearch--state-string cmd)
1155 isearch-message (isearch--state-message cmd)
1156 isearch-success (isearch--state-success cmd)
1157 isearch-forward (isearch--state-forward cmd)
1158 isearch-other-end (isearch--state-other-end cmd)
1159 isearch-word (isearch--state-word cmd)
1160 isearch-error (isearch--state-error cmd)
1161 isearch-wrapped (isearch--state-wrapped cmd)
1162 isearch-barrier (isearch--state-barrier cmd)
1163 isearch-case-fold-search (isearch--state-case-fold-search cmd))
1164 (if (functionp (isearch--state-pop-fun cmd))
1165 (funcall (isearch--state-pop-fun cmd) cmd))
1166 (goto-char (isearch--state-point cmd)))
1168 (defun isearch-pop-state ()
1169 (setq isearch-cmds (cdr isearch-cmds))
1170 (isearch--set-state (car isearch-cmds)))
1172 (defun isearch-push-state ()
1173 (push (isearch--get-state) isearch-cmds))
1175 \f
1176 ;; Commands active while inside of the isearch minor mode.
1178 (defun isearch-exit ()
1179 "Exit search normally.
1180 However, if this is the first command after starting incremental
1181 search and `search-nonincremental-instead' is non-nil, do a
1182 nonincremental search instead via `isearch-edit-string'."
1183 (interactive)
1184 (if (and search-nonincremental-instead
1185 (= 0 (length isearch-string)))
1186 (let ((isearch-nonincremental t))
1187 (isearch-edit-string)) ;; this calls isearch-done as well
1188 (isearch-done))
1189 (isearch-clean-overlays))
1191 (defun isearch-fail-pos (&optional msg)
1192 "Return position of first mismatch in search string, or nil if none.
1193 If MSG is non-nil, use variable `isearch-message', otherwise `isearch-string'."
1194 (let ((cmds isearch-cmds)
1195 (curr-msg (if msg isearch-message isearch-string))
1196 succ-msg)
1197 (when (or (not isearch-success) isearch-error)
1198 (while (and cmds
1199 (or (not (isearch--state-success (car cmds)))
1200 (isearch--state-error (car cmds))))
1201 (pop cmds))
1202 (setq succ-msg (and cmds (if msg (isearch--state-message (car cmds))
1203 (isearch--state-string (car cmds)))))
1204 (if (and (stringp succ-msg)
1205 (< (length succ-msg) (length curr-msg))
1206 (equal succ-msg
1207 (substring curr-msg 0 (length succ-msg))))
1208 (length succ-msg)
1209 0))))
1211 (defmacro with-isearch-suspended (&rest body)
1212 "Exit Isearch mode, run BODY, and reinvoke the pending search.
1213 You can update the global isearch variables by setting new values to
1214 `isearch-new-string', `isearch-new-message', `isearch-new-forward',
1215 `isearch-new-word', `isearch-new-case-fold'."
1216 ;; This code is very hairy for several reasons, explained in the code.
1217 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1218 ;; If there were a way to catch any change of buffer from the minibuffer,
1219 ;; this could be simplified greatly.
1220 ;; Editing doesn't back up the search point. Should it?
1221 `(condition-case nil
1222 (progn
1223 (let ((isearch-nonincremental isearch-nonincremental)
1225 ;; Locally bind all isearch global variables to protect them
1226 ;; from recursive isearching.
1227 ;; isearch-string -message and -forward are not bound
1228 ;; so they may be changed. Instead, save the values.
1229 (isearch-new-string isearch-string)
1230 (isearch-new-message isearch-message)
1231 (isearch-new-forward isearch-forward)
1232 (isearch-new-word isearch-word)
1233 (isearch-new-case-fold isearch-case-fold-search)
1235 (isearch-regexp isearch-regexp)
1236 (isearch-op-fun isearch-op-fun)
1237 (isearch-cmds isearch-cmds)
1238 (isearch-success isearch-success)
1239 (isearch-wrapped isearch-wrapped)
1240 (isearch-barrier isearch-barrier)
1241 (isearch-adjusted isearch-adjusted)
1242 (isearch-yank-flag isearch-yank-flag)
1243 (isearch-error isearch-error)
1244 ;;; Don't bind this. We want isearch-search, below, to set it.
1245 ;;; And the old value won't matter after that.
1246 ;;; (isearch-other-end isearch-other-end)
1247 ;;; Perhaps some of these other variables should be bound for a
1248 ;;; shorter period, ending before the next isearch-search.
1249 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1250 (isearch-opoint isearch-opoint)
1251 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1252 (isearch-small-window isearch-small-window)
1253 (isearch-recursive-edit isearch-recursive-edit)
1254 ;; Save current configuration so we can restore it here.
1255 (isearch-window-configuration (current-window-configuration))
1257 ;; This could protect the index of the search rings,
1258 ;; but we can't reliably count the number of typed M-p
1259 ;; in `read-from-minibuffer' to adjust the index accordingly.
1260 ;; So when the following is commented out, `isearch-mode'
1261 ;; below resets the index to the predictable value nil.
1262 ;; (search-ring-yank-pointer search-ring-yank-pointer)
1263 ;; (regexp-search-ring-yank-pointer regexp-search-ring-yank-pointer)
1265 ;; Temporarily restore `minibuffer-message-timeout'.
1266 (minibuffer-message-timeout
1267 isearch-original-minibuffer-message-timeout)
1268 (isearch-original-minibuffer-message-timeout
1269 isearch-original-minibuffer-message-timeout)
1270 old-point old-other-end)
1272 ;; Actually terminate isearching until editing is done.
1273 ;; This is so that the user can do anything without failure,
1274 ;; like switch buffers and start another isearch, and return.
1275 (condition-case nil
1276 (isearch-done t t)
1277 (exit nil)) ; was recursive editing
1279 ;; Save old point and isearch-other-end before reading from minibuffer
1280 ;; that can change their values.
1281 (setq old-point (point) old-other-end isearch-other-end)
1283 (unwind-protect
1284 (progn ,@body)
1286 ;; Set point at the start (end) of old match if forward (backward),
1287 ;; so after exiting minibuffer isearch resumes at the start (end)
1288 ;; of this match and can find it again.
1289 (if (and old-other-end (eq old-point (point))
1290 (eq isearch-forward isearch-new-forward))
1291 (goto-char old-other-end))
1293 ;; Always resume isearching by restarting it.
1294 (isearch-mode isearch-forward
1295 isearch-regexp
1296 isearch-op-fun
1297 nil
1298 isearch-word)
1300 ;; Copy new local values to isearch globals
1301 (setq isearch-string isearch-new-string
1302 isearch-message isearch-new-message
1303 isearch-forward isearch-new-forward
1304 isearch-word isearch-new-word
1305 isearch-case-fold-search isearch-new-case-fold))
1307 ;; Empty isearch-string means use default.
1308 (when (= 0 (length isearch-string))
1309 (setq isearch-string (or (car (if isearch-regexp
1310 regexp-search-ring
1311 search-ring))
1312 "")
1314 isearch-message
1315 (mapconcat 'isearch-text-char-description
1316 isearch-string ""))
1317 ;; After taking the last element, adjust ring to previous one.
1318 (isearch-ring-adjust1 nil)))
1320 ;; This used to push the state as of before this C-s, but it adds
1321 ;; an inconsistent state where part of variables are from the
1322 ;; previous search (e.g. `isearch-success'), and part of variables
1323 ;; are just entered from the minibuffer (e.g. `isearch-string').
1324 ;; (isearch-push-state)
1326 ;; Reinvoke the pending search.
1327 (isearch-search)
1328 (isearch-push-state) ; this pushes the correct state
1329 (isearch-update)
1330 (if isearch-nonincremental
1331 (progn
1332 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1333 (isearch-done)
1334 ;; The search done message is confusing when the string
1335 ;; is empty, so erase it.
1336 (if (equal isearch-string "")
1337 (message "")))))
1339 (quit ; handle abort-recursive-edit
1340 (isearch-abort) ;; outside of let to restore outside global values
1341 )))
1343 (defvar minibuffer-history-symbol) ;; from external package gmhist.el
1345 (defun isearch-edit-string ()
1346 "Edit the search string in the minibuffer.
1347 The following additional command keys are active while editing.
1353 (interactive)
1354 (with-isearch-suspended
1355 (let* ((message-log-max nil)
1356 ;; Don't add a new search string to the search ring here
1357 ;; in `read-from-minibuffer'. It should be added only
1358 ;; by `isearch-update-ring' called from `isearch-done'.
1359 (history-add-new-input nil)
1360 ;; Binding minibuffer-history-symbol to nil is a work-around
1361 ;; for some incompatibility with gmhist.
1362 (minibuffer-history-symbol))
1363 (setq isearch-new-string
1364 (read-from-minibuffer
1365 (isearch-message-prefix nil isearch-nonincremental)
1366 (cons isearch-string (1+ (or (isearch-fail-pos)
1367 (length isearch-string))))
1368 minibuffer-local-isearch-map nil
1369 (if isearch-regexp
1370 (cons 'regexp-search-ring
1371 (1+ (or regexp-search-ring-yank-pointer -1)))
1372 (cons 'search-ring
1373 (1+ (or search-ring-yank-pointer -1))))
1374 nil t)
1375 isearch-new-message
1376 (mapconcat 'isearch-text-char-description
1377 isearch-new-string "")))))
1379 (defun isearch-nonincremental-exit-minibuffer ()
1380 (interactive)
1381 (setq isearch-nonincremental t)
1382 (exit-minibuffer))
1383 ;; Changing the value of `isearch-nonincremental' has no effect here,
1384 ;; because `isearch-edit-string' ignores this change. Thus marked as obsolete.
1385 (make-obsolete 'isearch-nonincremental-exit-minibuffer 'exit-minibuffer "24.4")
1387 (defun isearch-forward-exit-minibuffer ()
1388 "Resume isearching forward from the minibuffer that edits the search string."
1389 (interactive)
1390 (setq isearch-new-forward t)
1391 (exit-minibuffer))
1393 (defun isearch-reverse-exit-minibuffer ()
1394 "Resume isearching backward from the minibuffer that edits the search string."
1395 (interactive)
1396 (setq isearch-new-forward nil)
1397 (exit-minibuffer))
1399 (defun isearch-cancel ()
1400 "Terminate the search and go back to the starting point."
1401 (interactive)
1402 (if (and isearch-push-state-function isearch-cmds)
1403 ;; For defined push-state function, restore the first state.
1404 ;; This calls pop-state function and restores original point.
1405 (let ((isearch-cmds (last isearch-cmds)))
1406 (isearch--set-state (car isearch-cmds)))
1407 (goto-char isearch-opoint))
1408 (isearch-done t) ; Exit isearch..
1409 (isearch-clean-overlays)
1410 (signal 'quit nil)) ; ..and pass on quit signal.
1412 (defun isearch-abort ()
1413 "Abort incremental search mode if searching is successful, signaling quit.
1414 Otherwise, revert to previous successful search and continue searching.
1415 Use `isearch-exit' to quit without signaling."
1416 (interactive)
1417 ;; (ding) signal instead below, if quitting
1418 (discard-input)
1419 (if (and isearch-success (not isearch-error))
1420 ;; If search is successful and has no incomplete regexp,
1421 ;; move back to starting point and really do quit.
1422 (progn
1423 (setq isearch-success nil)
1424 (isearch-cancel))
1425 ;; If search is failing, or has an incomplete regexp,
1426 ;; rub out until it is once more successful.
1427 (while (or (not isearch-success) isearch-error)
1428 (isearch-pop-state))
1429 (isearch-update)))
1431 (defun isearch-repeat (direction)
1432 ;; Utility for isearch-repeat-forward and -backward.
1433 (if (eq isearch-forward (eq direction 'forward))
1434 ;; C-s in forward or C-r in reverse.
1435 (if (equal isearch-string "")
1436 ;; If search string is empty, use last one.
1437 (if (null (if isearch-regexp regexp-search-ring search-ring))
1438 (setq isearch-error "No previous search string")
1439 (setq isearch-string
1440 (car (if isearch-regexp regexp-search-ring search-ring))
1441 isearch-message
1442 (mapconcat 'isearch-text-char-description
1443 isearch-string "")
1444 isearch-case-fold-search isearch-last-case-fold-search)
1445 ;; After taking the last element, adjust ring to previous one.
1446 (isearch-ring-adjust1 nil))
1447 ;; If already have what to search for, repeat it.
1448 (or isearch-success
1449 (progn
1450 ;; Set isearch-wrapped before calling isearch-wrap-function
1451 (setq isearch-wrapped t)
1452 (if isearch-wrap-function
1453 (funcall isearch-wrap-function)
1454 (goto-char (if isearch-forward (point-min) (point-max)))))))
1455 ;; C-s in reverse or C-r in forward, change direction.
1456 (setq isearch-forward (not isearch-forward)
1457 isearch-success t))
1459 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1461 (if (equal isearch-string "")
1462 (setq isearch-success t)
1463 (if (and isearch-success
1464 (equal (point) isearch-other-end)
1465 (not isearch-just-started))
1466 ;; If repeating a search that found
1467 ;; an empty string, ensure we advance.
1468 (if (if isearch-forward (eobp) (bobp))
1469 ;; If there's nowhere to advance to, fail (and wrap next time).
1470 (progn
1471 (setq isearch-success nil)
1472 (ding))
1473 (forward-char (if isearch-forward 1 -1))
1474 (isearch-search))
1475 (isearch-search)))
1477 (isearch-push-state)
1478 (isearch-update))
1480 (defun isearch-repeat-forward ()
1481 "Repeat incremental search forwards."
1482 (interactive)
1483 (isearch-repeat 'forward))
1485 (defun isearch-repeat-backward ()
1486 "Repeat incremental search backwards."
1487 (interactive)
1488 (isearch-repeat 'backward))
1490 (defun isearch-toggle-regexp ()
1491 "Toggle regexp searching on or off."
1492 ;; The status stack is left unchanged.
1493 (interactive)
1494 (setq isearch-regexp (not isearch-regexp))
1495 (if isearch-regexp (setq isearch-word nil))
1496 (setq isearch-success t isearch-adjusted t)
1497 (isearch-update))
1499 (defun isearch-toggle-word ()
1500 "Toggle word searching on or off."
1501 ;; The status stack is left unchanged.
1502 (interactive)
1503 (setq isearch-word (if (eq isearch-word t) nil t))
1504 (if isearch-word (setq isearch-regexp nil))
1505 (setq isearch-success t isearch-adjusted t)
1506 (isearch-update))
1508 (defun isearch-toggle-symbol ()
1509 "Toggle symbol searching on or off."
1510 (interactive)
1511 (setq isearch-word (unless (eq isearch-word 'isearch-symbol-regexp)
1512 'isearch-symbol-regexp))
1513 (if isearch-word (setq isearch-regexp nil))
1514 (setq isearch-success t isearch-adjusted t)
1515 (isearch-update))
1517 (defun isearch-toggle-character-fold ()
1518 "Toggle character folding in searching on or off."
1519 (interactive)
1520 (setq isearch-word (unless (eq isearch-word #'character-fold-to-regexp)
1521 #'character-fold-to-regexp))
1522 (if isearch-word (setq isearch-regexp nil))
1523 (setq isearch-success t isearch-adjusted t)
1524 (isearch-update))
1526 (defun isearch-toggle-lax-whitespace ()
1527 "Toggle whitespace matching in searching on or off.
1528 In ordinary search, toggles the value of the variable
1529 `isearch-lax-whitespace'. In regexp search, toggles the
1530 value of the variable `isearch-regexp-lax-whitespace'."
1531 (interactive)
1532 (if isearch-regexp
1533 (setq isearch-regexp-lax-whitespace (not isearch-regexp-lax-whitespace))
1534 (setq isearch-lax-whitespace (not isearch-lax-whitespace)))
1535 (let ((message-log-max nil))
1536 (message "%s%s [%s]"
1537 (isearch-message-prefix nil isearch-nonincremental)
1538 isearch-message
1539 (if (if isearch-regexp
1540 isearch-regexp-lax-whitespace
1541 isearch-lax-whitespace)
1542 "match spaces loosely"
1543 "match spaces literally")))
1544 (setq isearch-success t isearch-adjusted t)
1545 (sit-for 1)
1546 (isearch-update))
1548 (defun isearch-toggle-case-fold ()
1549 "Toggle case folding in searching on or off.
1550 Toggles the value of the variable `isearch-case-fold-search'."
1551 (interactive)
1552 (setq isearch-case-fold-search
1553 (if isearch-case-fold-search nil 'yes))
1554 (let ((message-log-max nil))
1555 (message "%s%s [case %ssensitive]"
1556 (isearch-message-prefix nil isearch-nonincremental)
1557 isearch-message
1558 (if isearch-case-fold-search "in" "")))
1559 (setq isearch-success t isearch-adjusted t)
1560 (sit-for 1)
1561 (isearch-update))
1563 (defun isearch-toggle-invisible ()
1564 "Toggle searching in invisible text on or off.
1565 Toggles the variable `isearch-invisible' between values
1566 nil and a non-nil value of the option `search-invisible'
1567 \(or `open' if `search-invisible' is nil)."
1568 (interactive)
1569 (setq isearch-invisible
1570 (if isearch-invisible nil (or search-invisible 'open)))
1571 (let ((message-log-max nil))
1572 (message "%s%s [match %svisible text]"
1573 (isearch-message-prefix nil isearch-nonincremental)
1574 isearch-message
1575 (if isearch-invisible "in" "")))
1576 (setq isearch-success t isearch-adjusted t)
1577 (sit-for 1)
1578 (isearch-update))
1580 \f
1581 ;; Word search
1583 (defun word-search-regexp (string &optional lax)
1584 "Return a regexp which matches words, ignoring punctuation.
1585 Given STRING, a string of words separated by word delimiters,
1586 compute a regexp that matches those exact words separated by
1587 arbitrary punctuation. If the string begins or ends in whitespace,
1588 the beginning or the end of the string matches arbitrary whitespace.
1589 Otherwise if LAX is non-nil, the beginning or the end of the string
1590 need not match a word boundary.
1592 Used in `word-search-forward', `word-search-backward',
1593 `word-search-forward-lax', `word-search-backward-lax'."
1594 (cond
1595 ((equal string "") "")
1597 (t (concat
1604 (defun word-search-backward (string &optional bound noerror count)
1605 "Search backward from point for STRING, ignoring differences in punctuation.
1606 Set point to the beginning of the occurrence found, and return point.
1607 An optional second argument bounds the search; it is a buffer position.
1608 The match found must not extend before that position.
1609 Optional third argument, if t, means if fail just return nil (no error).
1610 If not nil and not t, move to limit of search and return nil.
1611 Optional fourth argument is repeat count--search for successive occurrences.
1613 Relies on the function `word-search-regexp' to convert a sequence
1614 of words in STRING to a regexp used to search words without regard
1615 to punctuation."
1616 (interactive "sWord search backward: ")
1617 (re-search-backward (word-search-regexp string nil) bound noerror count))
1619 (defun word-search-forward (string &optional bound noerror count)
1620 "Search forward from point for STRING, ignoring differences in punctuation.
1621 Set point to the end of the occurrence found, and return point.
1622 An optional second argument bounds the search; it is a buffer position.
1623 The match found must not extend after that position.
1624 Optional third argument, if t, means if fail just return nil (no error).
1625 If not nil and not t, move to limit of search and return nil.
1626 Optional fourth argument is repeat count--search for successive occurrences.
1628 Relies on the function `word-search-regexp' to convert a sequence
1629 of words in STRING to a regexp used to search words without regard
1630 to punctuation."
1631 (interactive "sWord search: ")
1632 (re-search-forward (word-search-regexp string nil) bound noerror count))
1634 (defun word-search-backward-lax (string &optional bound noerror count)
1635 "Search backward from point for STRING, ignoring differences in punctuation.
1636 Set point to the beginning of the occurrence found, and return point.
1638 Unlike `word-search-backward', the end of STRING need not match a word
1639 boundary, unless STRING ends in whitespace.
1641 An optional second argument bounds the search; it is a buffer position.
1642 The match found must not extend before that position.
1643 Optional third argument, if t, means if fail just return nil (no error).
1644 If not nil and not t, move to limit of search and return nil.
1645 Optional fourth argument is repeat count--search for successive occurrences.
1647 Relies on the function `word-search-regexp' to convert a sequence
1648 of words in STRING to a regexp used to search words without regard
1649 to punctuation."
1650 (interactive "sWord search backward: ")
1651 (re-search-backward (word-search-regexp string t) bound noerror count))
1653 (defun word-search-forward-lax (string &optional bound noerror count)
1654 "Search forward from point for STRING, ignoring differences in punctuation.
1655 Set point to the end of the occurrence found, and return point.
1657 Unlike `word-search-forward', the end of STRING need not match a word
1658 boundary, unless STRING ends in whitespace.
1660 An optional second argument bounds the search; it is a buffer position.
1661 The match found must not extend after that position.
1662 Optional third argument, if t, means if fail just return nil (no error).
1663 If not nil and not t, move to limit of search and return nil.
1664 Optional fourth argument is repeat count--search for successive occurrences.
1666 Relies on the function `word-search-regexp' to convert a sequence
1667 of words in STRING to a regexp used to search words without regard
1668 to punctuation."
1669 (interactive "sWord search: ")
1670 (re-search-forward (word-search-regexp string t) bound noerror count))
1672 ;; Symbol search
1674 (defun isearch-symbol-regexp (string &optional lax)
1675 "Return a regexp which matches STRING as a symbol.
1677 If there are more than one symbol, then compute a regexp that matches
1678 those exact symbols separated by non-symbol characters. If the string
1679 begins or ends in whitespace, the beginning or the end of the string
1680 matches arbitrary non-symbol whitespace. Otherwise if LAX is non-nil,
1681 the beginning or the end of the string need not match a symbol boundary."
1682 (let ((not-word-symbol-re
1683 ;; This regexp matches all syntaxes except word and symbol syntax.
1684 ;; FIXME: Replace it with something shorter if possible (bug#14602).
1685 "\\(?:\\s-\\|\\s.\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s/\\|\\s$\\|\\s'\\|\\s<\\|\\s>\\|\\s@\\|\\s!\\|\\s|\\)+"))
1686 (cond
1687 ((equal string "") "")
1689 (t (concat
1692 (mapconcat 'regexp-quote (split-string string not-word-symbol-re t) not-word-symbol-re)
1696 (put 'isearch-symbol-regexp 'isearch-message-prefix "symbol ")
1698 ;; Search with lax whitespace
1700 (defun search-forward-lax-whitespace (string &optional bound noerror count)
1701 "Search forward for STRING, matching a sequence of whitespace chars."
1702 (let ((search-spaces-regexp search-whitespace-regexp))
1703 (re-search-forward (regexp-quote string) bound noerror count)))
1705 (defun search-backward-lax-whitespace (string &optional bound noerror count)
1706 "Search backward for STRING, matching a sequence of whitespace chars."
1707 (let ((search-spaces-regexp search-whitespace-regexp))
1708 (re-search-backward (regexp-quote string) bound noerror count)))
1710 (defun re-search-forward-lax-whitespace (regexp &optional bound noerror count)
1711 "Search forward for REGEXP, matching a sequence of whitespace chars."
1712 (let ((search-spaces-regexp search-whitespace-regexp))
1713 (re-search-forward regexp bound noerror count)))
1715 (defun re-search-backward-lax-whitespace (regexp &optional bound noerror count)
1716 "Search backward for REGEXP, matching a sequence of whitespace chars."
1717 (let ((search-spaces-regexp search-whitespace-regexp))
1718 (re-search-backward regexp bound noerror count)))
1720 \f
1721 (defun isearch-query-replace (&optional arg regexp-flag)
1722 "Start `query-replace' with string to replace from last search string.
1723 The ARG (prefix arg if interactive), if non-nil, means replace
1724 only matches surrounded by word boundaries. A negative prefix
1725 arg means replace backward. Note that using the prefix arg
1726 is possible only when `isearch-allow-scroll' is non-nil or
1727 `isearch-allow-prefix' is non-nil, and it doesn't always provide the
1728 correct matches for `query-replace', so the preferred way to run word
1729 replacements from Isearch is `M-s w ... M-%'."
1730 (interactive
1731 (list current-prefix-arg))
1732 (barf-if-buffer-read-only)
1733 (if regexp-flag (setq isearch-regexp t))
1734 (let ((case-fold-search isearch-case-fold-search)
1735 ;; set `search-upper-case' to nil to not call
1736 ;; `isearch-no-upper-case-p' in `perform-replace'
1737 (search-upper-case nil)
1738 (search-invisible isearch-invisible)
1739 (replace-lax-whitespace
1740 isearch-lax-whitespace)
1741 (replace-regexp-lax-whitespace
1742 isearch-regexp-lax-whitespace)
1743 (delimited (and arg (not (eq arg '-))))
1744 (backward (and arg (eq arg '-)))
1745 ;; Set `isearch-recursive-edit' to nil to prevent calling
1746 ;; `exit-recursive-edit' in `isearch-done' that terminates
1747 ;; the execution of this command when it is non-nil.
1748 ;; We call `exit-recursive-edit' explicitly at the end below.
1749 (isearch-recursive-edit nil))
1750 (isearch-done nil t)
1751 (isearch-clean-overlays)
1752 (if (and isearch-other-end
1753 (if backward
1754 (> isearch-other-end (point))
1755 (< isearch-other-end (point)))
1756 (not (and transient-mark-mode mark-active
1757 (if backward
1758 (> (mark) (point))
1759 (< (mark) (point))))))
1760 (goto-char isearch-other-end))
1761 (set query-replace-from-history-variable
1762 (cons isearch-string
1763 (symbol-value query-replace-from-history-variable)))
1764 (perform-replace
1765 isearch-string
1766 (query-replace-read-to
1767 isearch-string
1768 (concat "Query replace"
1769 (isearch--describe-word-mode (or delimited isearch-word) t)
1770 (if isearch-regexp " regexp" "")
1771 (if backward " backward" "")
1772 (if (and transient-mark-mode mark-active) " in region" ""))
1773 isearch-regexp)
1774 t isearch-regexp (or delimited isearch-word) nil nil
1775 (if (and transient-mark-mode mark-active) (region-beginning))
1776 (if (and transient-mark-mode mark-active) (region-end))
1777 backward))
1778 (and isearch-recursive-edit (exit-recursive-edit)))
1780 (defun isearch-query-replace-regexp (&optional arg)
1781 "Start `query-replace-regexp' with string to replace from last search string.
1782 See `isearch-query-replace' for more information."
1783 (interactive
1784 (list current-prefix-arg))
1785 (isearch-query-replace arg t))
1787 (defun isearch-occur (regexp &optional nlines)
1788 "Run `occur' using the last search string as the regexp.
1789 Interactively, REGEXP is constructed using the search string from the
1790 last search command. NLINES has the same meaning as in `occur'.
1792 If the last search command was a word search, REGEXP is computed from
1793 the search words, ignoring punctuation. If the last search
1794 command was a regular expression search, REGEXP is the regular
1795 expression used in that search. If the last search command searched
1796 for a literal string, REGEXP is constructed by quoting all the special
1797 characters in that string."
1798 (interactive
1799 (let* ((perform-collect (consp current-prefix-arg))
1800 (regexp (cond
1801 ((functionp isearch-word)
1802 (funcall isearch-word isearch-string))
1803 (isearch-word (word-search-regexp isearch-string))
1804 (isearch-regexp isearch-string)
1805 (t (regexp-quote isearch-string)))))
1806 (list regexp
1807 (if perform-collect
1808 ;; Perform collect operation
1809 (if (zerop (regexp-opt-depth regexp))
1810 ;; No subexpression so collect the entire match.
1812 ;; Get the regexp for collection pattern.
1813 (let ((default (car occur-collect-regexp-history))
1814 regexp-collect)
1815 (with-isearch-suspended
1816 (setq regexp-collect
1817 (read-regexp
1818 (format "Regexp to collect (default %s): " default)
1819 default 'occur-collect-regexp-history)))
1820 regexp-collect))
1821 ;; Otherwise normal occur takes numerical prefix argument.
1822 (when current-prefix-arg
1823 (prefix-numeric-value current-prefix-arg))))))
1824 (let ((case-fold-search isearch-case-fold-search)
1825 ;; Set `search-upper-case' to nil to not call
1826 ;; `isearch-no-upper-case-p' in `occur-1'.
1827 (search-upper-case nil)
1828 (search-spaces-regexp
1829 (if (if isearch-regexp
1830 isearch-regexp-lax-whitespace
1831 isearch-lax-whitespace)
1832 search-whitespace-regexp)))
1833 (occur regexp nlines)))
1835 (declare-function hi-lock-read-face-name "hi-lock" ())
1837 (defun isearch-highlight-regexp ()
1838 "Run `highlight-regexp' with regexp from the current search string.
1839 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1840 argument from the last search regexp or a quoted search string,
1841 and reads its face argument using `hi-lock-read-face-name'."
1842 (interactive)
1843 (let (
1844 ;; Set `isearch-recursive-edit' to nil to prevent calling
1845 ;; `exit-recursive-edit' in `isearch-done' that terminates
1846 ;; the execution of this command when it is non-nil.
1847 ;; We call `exit-recursive-edit' explicitly at the end below.
1848 (isearch-recursive-edit nil))
1849 (isearch-done nil t)
1850 (isearch-clean-overlays))
1851 (require 'hi-lock nil t)
1852 (let ((regexp (cond ((functionp isearch-word)
1853 (funcall isearch-word isearch-string))
1854 (isearch-word (word-search-regexp isearch-string))
1855 (isearch-regexp isearch-string)
1856 ((if (and (eq isearch-case-fold-search t)
1857 search-upper-case)
1858 (isearch-no-upper-case-p
1859 isearch-string isearch-regexp)
1860 isearch-case-fold-search)
1861 ;; Turn isearch-string into a case-insensitive
1862 ;; regexp.
1863 (mapconcat
1864 (lambda (c)
1865 (let ((s (string c)))
1866 (if (string-match "[[:alpha:]]" s)
1867 (format "[%s%s]" (upcase s) (downcase s))
1868 (regexp-quote s))))
1869 isearch-string ""))
1870 (t (regexp-quote isearch-string)))))
1871 (hi-lock-face-buffer regexp (hi-lock-read-face-name)))
1872 (and isearch-recursive-edit (exit-recursive-edit)))
1874 \f
1875 (defun isearch-delete-char ()
1876 "Discard last input item and move point back.
1877 Last input means the last character or the last isearch command
1878 that added or deleted characters from the search string,
1879 moved point, toggled regexp mode or case-sensitivity, etc.
1880 If no previous match was done, just beep."
1881 (interactive)
1882 (if (null (cdr isearch-cmds))
1883 (ding)
1884 (isearch-pop-state))
1885 (isearch-update))
1887 (defun isearch-del-char (&optional arg)
1888 "Delete character from end of search string and search again.
1889 Unlike `isearch-delete-char', it only deletes the last character,
1890 but doesn't cancel the effect of other isearch command.
1891 If search string is empty, just beep."
1892 (interactive "p")
1893 (if (= 0 (length isearch-string))
1894 (ding)
1895 (setq isearch-string (substring isearch-string 0
1896 (- (min (or arg 1)
1897 (length isearch-string))))
1898 isearch-message (mapconcat 'isearch-text-char-description
1899 isearch-string "")))
1900 ;; Use the isearch-other-end as new starting point to be able
1901 ;; to find the remaining part of the search string again.
1902 ;; This is like what `isearch-search-and-update' does,
1903 ;; but currently it doesn't support deletion of characters
1904 ;; for the case where unsuccessful search may become successful
1905 ;; by deletion of characters.
1906 (if isearch-other-end (goto-char isearch-other-end))
1907 (isearch-search)
1908 (isearch-push-state)
1909 (isearch-update))
1911 (defun isearch-yank-string (string)
1912 "Pull STRING into search string."
1913 ;; Downcase the string if not supposed to case-fold yanked strings.
1914 (if (and isearch-case-fold-search
1915 (eq 'not-yanks search-upper-case))
1916 (setq string (downcase string)))
1917 (if isearch-regexp (setq string (regexp-quote string)))
1918 ;; Don't move cursor in reverse search.
1919 (setq isearch-yank-flag t)
1920 (isearch-process-search-string
1921 string (mapconcat 'isearch-text-char-description string "")))
1923 (defun isearch-yank-kill ()
1924 "Pull string from kill ring into search string."
1925 (interactive)
1926 (isearch-yank-string (current-kill 0)))
1928 (defun isearch-yank-pop ()
1929 "Replace just-yanked search string with previously killed string."
1930 (interactive)
1931 (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop)))
1932 ;; Fall back on `isearch-yank-kill' for the benefits of people
1933 ;; who are used to the old behavior of `M-y' in isearch mode. In
1934 ;; future, this fallback may be changed if we ever change
1935 ;; `yank-pop' to do something like the kill-ring-browser.
1936 (isearch-yank-kill)
1937 (isearch-pop-state)
1938 (isearch-yank-string (current-kill 1))))
1940 (defun isearch-yank-x-selection ()
1941 "Pull current X selection into search string."
1942 (interactive)
1943 (isearch-yank-string (gui-get-selection))
1944 ;; If `gui-get-selection' returned the text from the active region,
1945 ;; then it "used" the mark which we should hence deactivate.
1946 (when select-active-regions (deactivate-mark)))
1949 (defun isearch-mouse-2 (click)
1950 "Handle mouse-2 in Isearch mode.
1951 For a click in the echo area, invoke `isearch-yank-x-selection'.
1952 Otherwise invoke whatever the calling mouse-2 command sequence
1953 is bound to outside of Isearch."
1954 (interactive "e")
1955 (let* ((w (posn-window (event-start click)))
1956 (overriding-terminal-local-map nil)
1957 (binding (key-binding (this-command-keys-vector) t)))
1958 (if (and (window-minibuffer-p w)
1959 (not (minibuffer-window-active-p w))) ; in echo area
1960 (isearch-yank-x-selection)
1961 (when (functionp binding)
1962 (call-interactively binding)))))
1964 (defun isearch-yank-internal (jumpform)
1965 "Pull the text from point to the point reached by JUMPFORM.
1966 JUMPFORM is a lambda expression that takes no arguments and returns
1967 a buffer position, possibly having moved point to that position.
1968 For example, it might move point forward by a word and return point,
1969 or it might return the position of the end of the line."
1970 (isearch-yank-string
1971 (save-excursion
1972 (and (not isearch-forward) isearch-other-end
1973 (goto-char isearch-other-end))
1974 (buffer-substring-no-properties (point) (funcall jumpform)))))
1976 (defun isearch-yank-char-in-minibuffer (&optional arg)
1977 "Pull next character from buffer into end of search string in minibuffer."
1978 (interactive "p")
1979 (if (eobp)
1980 (insert
1981 (with-current-buffer (cadr (buffer-list))
1982 (buffer-substring-no-properties
1983 (point) (progn (forward-char arg) (point)))))
1984 (forward-char arg)))
1986 (defun isearch-yank-char (&optional arg)
1987 "Pull next character from buffer into search string.
1988 If optional ARG is non-nil, pull in the next ARG characters."
1989 (interactive "p")
1990 (isearch-yank-internal (lambda () (forward-char arg) (point))))
1992 (declare-function subword-forward "subword" (&optional arg))
1993 (defun isearch-yank-word-or-char ()
1994 "Pull next character, subword or word from buffer into search string.
1995 Subword is used when `subword-mode' is activated. "
1996 (interactive)
1997 (isearch-yank-internal
1998 (lambda ()
1999 (if (or (= (char-syntax (or (char-after) 0)) ?w)
2000 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
2001 (if (or (and (boundp 'subword-mode) subword-mode)
2002 (and (boundp 'superword-mode) superword-mode))
2003 (subword-forward 1)
2004 (forward-word 1))
2005 (forward-char 1))
2006 (point))))
2008 (defun isearch-yank-word (&optional arg)
2009 "Pull next word from buffer into search string.
2010 If optional ARG is non-nil, pull in the next ARG words."
2011 (interactive "p")
2012 (isearch-yank-internal (lambda () (forward-word arg) (point))))
2014 (defun isearch-yank-line (&optional arg)
2015 "Pull rest of line from buffer into search string.
2016 If optional ARG is non-nil, yank the next ARG lines."
2017 (interactive "p")
2018 (isearch-yank-internal
2019 (lambda () (let ((inhibit-field-text-motion t))
2020 (line-end-position (if (eolp) (1+ arg) arg))))))
2022 (defun isearch-char-by-name (&optional count)
2023 "Read a character by its Unicode name and add it to the search string.
2024 Completion is available like in `read-char-by-name' used by `insert-char'.
2025 With argument, add COUNT copies of the character."
2026 (interactive "p")
2027 (with-isearch-suspended
2028 (let ((char (read-char-by-name "Add character to search (Unicode name or hex): ")))
2029 (when char
2030 (let ((string (if (and (integerp count) (> count 1))
2031 (make-string count char)
2032 (char-to-string char))))
2033 (setq isearch-new-string (concat isearch-string string)
2034 isearch-new-message (concat isearch-message
2035 (mapconcat 'isearch-text-char-description
2036 string ""))))))))
2038 (defun isearch-search-and-update ()
2039 ;; Do the search and update the display.
2040 (when (or isearch-success
2041 ;; Unsuccessful regexp search may become successful by
2042 ;; addition of characters which make isearch-string valid
2043 isearch-regexp
2044 ;; If the string was found but was completely invisible,
2045 ;; it might now be partly visible, so try again.
2046 (prog1 isearch-hidden (setq isearch-hidden nil)))
2047 ;; In reverse search, adding stuff at
2048 ;; the end may cause zero or many more chars to be
2049 ;; matched, in the string following point.
2050 ;; Allow all those possibilities without moving point as
2051 ;; long as the match does not extend past search origin.
2052 (if (and (not isearch-forward) (not isearch-adjusted)
2053 (condition-case ()
2054 (let ((case-fold-search isearch-case-fold-search))
2055 (if (and (eq case-fold-search t) search-upper-case)
2056 (setq case-fold-search
2057 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2058 (looking-at (cond
2059 ((functionp isearch-word)
2060 (funcall isearch-word isearch-string t))
2061 (isearch-word (word-search-regexp isearch-string t))
2062 (isearch-regexp isearch-string)
2063 (t (regexp-quote isearch-string)))))
2064 (error nil))
2065 (or isearch-yank-flag
2066 (<= (match-end 0)
2067 (min isearch-opoint isearch-barrier))))
2068 (progn
2069 (setq isearch-success t
2070 isearch-error nil
2071 isearch-other-end (match-end 0))
2072 (if (and (eq isearch-case-fold-search t) search-upper-case)
2073 (setq isearch-case-fold-search
2074 (isearch-no-upper-case-p isearch-string isearch-regexp))))
2075 ;; Not regexp, not reverse, or no match at point.
2076 (if (and isearch-other-end (not isearch-adjusted))
2077 (goto-char (if isearch-forward isearch-other-end
2078 (min isearch-opoint
2079 isearch-barrier
2080 (1+ isearch-other-end)))))
2081 (isearch-search)
2082 ))
2083 (isearch-push-state)
2084 (if isearch-op-fun (funcall isearch-op-fun))
2085 (isearch-update))
2088 ;; *, ?, }, and | chars can make a regexp more liberal.
2089 ;; They can make a regexp match sooner or make it succeed instead of failing.
2090 ;; So go back to place last successful search started
2091 ;; or to the last ^S/^R (barrier), whichever is nearer.
2092 ;; + needs no special handling because the string must match at least once.
2094 (defun isearch-backslash (str)
2095 "Return t if STR ends in an odd number of backslashes."
2098 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
2099 "Return point to previous successful match to allow regexp liberalization.
2102 stopping at `isearch-barrier' as needed.
2104 Do nothing if a backslash is escaping the liberalizing character.
2107 Do nothing if regexp has recently been invalid unless optional
2108 ALLOW-INVALID non-nil.
2110 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
2111 to the barrier."
2112 ;; (eq (not a) (not b)) makes all non-nil values equivalent
2113 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
2114 (not want-backslash))
2115 ;; We have to check 2 stack frames because the last might be
2116 ;; invalid just because of a backslash.
2117 (or (not isearch-error)
2118 (not (isearch--state-error (cadr isearch-cmds)))
2119 allow-invalid))
2120 (if to-barrier
2121 (progn (goto-char isearch-barrier)
2122 (setq isearch-adjusted t))
2123 (let* ((stack isearch-cmds)
2124 (previous (cdr stack)) ; lookbelow in the stack
2125 (frame (car stack)))
2126 ;; Walk down the stack looking for a valid regexp (as of course only
2127 ;; they can be the previous successful match); this conveniently
2128 ;; removes all bracket-sets and groups that might be in the way, as
2129 ;; well as partial \{\} constructs that the code below leaves behind.
2130 ;; Also skip over postfix operators -- though horrid,
2131 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
2132 (while (and previous
2133 (or (isearch--state-error frame)
2134 (let* ((string (isearch--state-string frame))
2135 (lchar (aref string (1- (length string)))))
2136 ;; The operators aren't always operators; check
2137 ;; backslashes. This doesn't handle the case of
2138 ;; operators at the beginning of the regexp not
2139 ;; being special, but then we should fall back to
2140 ;; the barrier anyway because it's all optional.
2141 (if (isearch-backslash
2142 (isearch--state-string (car previous)))
2143 (eq lchar ?\})
2144 (memq lchar '(?* ?? ?+))))))
2145 (setq stack previous previous (cdr previous) frame (car stack)))
2146 (when stack
2147 ;; `stack' now refers the most recent valid regexp that is not at
2148 ;; all optional in its last term. Now dig one level deeper and find
2149 ;; what matched before that.
2150 (let ((last-other-end
2151 (or (and (car previous)
2152 (isearch--state-other-end (car previous)))
2153 isearch-barrier)))
2154 (goto-char (if isearch-forward
2155 (max last-other-end isearch-barrier)
2156 (min last-other-end isearch-barrier)))
2157 (setq isearch-adjusted t)))))))
2159 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2160 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
2161 ;;
2162 ;; The idea here is that certain vertical scrolling commands (like C-l
2163 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
2164 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
2165 ;; tamper with isearch's state, or move point. It is unacceptable for the
2166 ;; search string to be scrolled out of the current window. If a command
2167 ;; attempts this, we scroll the text back again.
2168 ;;
2169 ;; We implement this feature with a property called `isearch-scroll'.
2170 ;; If a command's symbol has the value t for this property or for the
2171 ;; `scroll-command' property, it is a scrolling command. The feature
2172 ;; needs to be enabled by setting the customizable variable
2173 ;; `isearch-allow-scroll' to a non-nil value.
2174 ;;
2175 ;; The universal argument commands (e.g. C-u) in simple.el are marked
2176 ;; as scrolling commands, and isearch.el has been amended to allow
2177 ;; prefix arguments to be passed through to scrolling commands. Thus
2178 ;; M-0 C-l will scroll point to the top of the window.
2179 ;;
2180 ;; Horizontal scrolling commands are currently not catered for.
2181 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2183 ;; Set the isearch-scroll property on some standard functions:
2184 ;; Scroll-bar functions:
2185 (if (fboundp 'scroll-bar-toolkit-scroll)
2186 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
2187 (if (fboundp 'w32-handle-scroll-bar-event)
2188 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
2190 ;; Commands which scroll the window (some scroll commands
2191 ;; already have the `scroll-command' property on them):
2192 (put 'recenter 'isearch-scroll t)
2193 (put 'recenter-top-bottom 'isearch-scroll t)
2194 (put 'reposition-window 'isearch-scroll t)
2196 ;; Commands which act on the other window
2197 (put 'list-buffers 'isearch-scroll t)
2198 (put 'scroll-other-window 'isearch-scroll t)
2199 (put 'scroll-other-window-down 'isearch-scroll t)
2200 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
2201 (put 'end-of-buffer-other-window 'isearch-scroll t)
2203 ;; Commands which change the window layout
2204 (put 'delete-other-windows 'isearch-scroll t)
2205 (put 'balance-windows 'isearch-scroll t)
2206 (put 'split-window-right 'isearch-scroll t)
2207 (put 'split-window-below 'isearch-scroll t)
2208 (put 'enlarge-window 'isearch-scroll t)
2210 ;; Aliases for split-window-*
2211 (put 'split-window-vertically 'isearch-scroll t)
2212 (put 'split-window-horizontally 'isearch-scroll t)
2214 ;; Universal argument commands
2215 (put 'universal-argument 'isearch-scroll t)
2216 (put 'negative-argument 'isearch-scroll t)
2217 (put 'digit-argument 'isearch-scroll t)
2219 (defcustom isearch-allow-scroll nil
2220 "Whether scrolling is allowed during incremental search.
2221 If non-nil, scrolling commands can be used in Isearch mode.
2222 However, the current match will never scroll offscreen.
2223 If nil, scrolling commands will first cancel Isearch mode."
2224 :type 'boolean
2225 :group 'isearch)
2227 (defcustom isearch-allow-prefix t
2228 "Whether prefix arguments are allowed during incremental search.
2229 If non-nil, entering a prefix argument will not terminate the
2230 search. This option is ignored \(presumed t) when
2231 `isearch-allow-scroll' is set."
2232 :version "24.4"
2233 :type 'boolean
2234 :group 'isearch)
2236 (defun isearch-string-out-of-window (isearch-point)
2237 "Test whether the search string is currently outside of the window.
2238 Return nil if it's completely visible, or if point is visible,
2239 together with as much of the search string as will fit; the symbol
2240 `above' if we need to scroll the text downwards; the symbol `below',
2241 if upwards."
2242 (let ((w-start (window-start))
2243 (w-end (window-end nil t))
2244 (w-L1 (save-excursion (move-to-window-line 1) (point)))
2245 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
2246 start end) ; start and end of search string in buffer
2247 (if isearch-forward
2248 (setq end isearch-point start (or isearch-other-end isearch-point))
2249 (setq start isearch-point end (or isearch-other-end isearch-point)))
2250 (cond ((or (and (>= start w-start) (<= end w-end))
2251 (if isearch-forward
2252 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
2253 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
2254 nil)
2255 ((and (< start w-start)
2256 (< isearch-point w-L-1))
2257 'above)
2258 (t 'below))))
2260 (defun isearch-back-into-window (above isearch-point)
2261 "Scroll the window to bring the search string back into view.
2262 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
2263 search string is above the top of the window, nil when it is beneath
2264 the bottom."
2265 (let (start end)
2266 (if isearch-forward
2267 (setq end isearch-point start (or isearch-other-end isearch-point))
2268 (setq start isearch-point end (or isearch-other-end isearch-point)))
2269 (if above
2270 (progn
2271 (goto-char start)
2272 (recenter 0)
2273 (when (>= isearch-point (window-end nil t))
2274 (goto-char isearch-point)
2275 (recenter -1)))
2276 (goto-char end)
2277 (recenter -1)
2278 (when (< isearch-point (window-start))
2279 (goto-char isearch-point)
2280 (recenter 0))))
2281 (goto-char isearch-point))
2283 (defvar isearch-pre-scroll-point nil)
2285 (defun isearch-pre-command-hook ()
2286 "Decide whether to exit Isearch mode before executing the command.
2287 Don't exit Isearch if the key sequence that invoked this command
2288 is bound in `isearch-mode-map', or if the invoked command is
2289 a prefix argument command (when `isearch-allow-prefix' is non-nil),
2290 or it is a scrolling command (when `isearch-allow-scroll' is non-nil).
2291 Otherwise, exit Isearch (when `search-exit-option' is non-nil)
2292 before the command is executed globally with terminated Isearch."
2293 (let* ((key (this-single-command-keys))
2294 (main-event (aref key 0)))
2295 (cond
2296 ;; Don't exit Isearch if we're in the middle of some
2297 ;; `set-transient-map' thingy like `universal-argument--mode'.
2298 ((not (eq overriding-terminal-local-map isearch--saved-overriding-local-map)))
2299 ;; Don't exit Isearch for isearch key bindings.
2300 ((commandp (lookup-key isearch-mode-map key nil)))
2301 ;; Optionally edit the search string instead of exiting.
2302 ((eq search-exit-option 'edit)
2303 (setq this-command 'isearch-edit-string))
2304 ;; Handle a scrolling function or prefix argument.
2305 ((or (and isearch-allow-prefix
2306 (memq this-command '(universal-argument
2307 digit-argument negative-argument)))
2308 (and isearch-allow-scroll
2309 (symbolp this-command)
2310 (or (eq (get this-command 'isearch-scroll) t)
2311 (eq (get this-command 'scroll-command) t))))
2312 (when isearch-allow-scroll
2313 (setq isearch-pre-scroll-point (point))))
2314 ;; A mouse click on the isearch message starts editing the search string.
2315 ((and (eq (car-safe main-event) 'down-mouse-1)
2316 (window-minibuffer-p (posn-window (event-start main-event))))
2317 ;; Swallow the up-event.
2318 (read-event)
2319 (setq this-command 'isearch-edit-string))
2320 ;; Other characters terminate the search and are then executed normally.
2321 (search-exit-option
2322 (isearch-done)
2323 (isearch-clean-overlays))
2324 ;; If search-exit-option is nil, run the command without exiting Isearch.
2325 (t
2326 (isearch-process-search-string key key)))))
2328 (defun isearch-post-command-hook ()
2329 (when isearch-pre-scroll-point
2330 (let ((ab-bel (isearch-string-out-of-window isearch-pre-scroll-point)))
2331 (if ab-bel
2332 (isearch-back-into-window (eq ab-bel 'above) isearch-pre-scroll-point)
2333 (goto-char isearch-pre-scroll-point)))
2334 (setq isearch-pre-scroll-point nil)
2335 (isearch-update)))
2337 (defun isearch-quote-char (&optional count)
2338 "Quote special characters for incremental search.
2339 With argument, add COUNT copies of the character."
2340 (interactive "p")
2341 (let ((char (read-quoted-char (isearch-message t))))
2342 (unless (characterp char)
2343 (user-error "%s is not a valid character"
2344 (key-description (vector char))))
2345 ;; Assume character codes 0200 - 0377 stand for characters in some
2346 ;; single-byte character set, and convert them to Emacs
2347 ;; characters.
2348 (if (and isearch-regexp isearch-regexp-lax-whitespace (= char ?\s))
2349 (if (subregexp-context-p isearch-string (length isearch-string))
2350 (isearch-process-search-string "[ ]" " ")
2351 (isearch-process-search-char char count))
2352 ;; This used to assume character codes 0240 - 0377 stand for
2353 ;; characters in some single-byte character set, and converted them
2354 ;; to Emacs characters. But in 23.1 this feature is deprecated
2355 ;; in favor of inserting the corresponding Unicode characters.
2356 ;; (and enable-multibyte-characters
2359 ;; (setq char (unibyte-char-to-multibyte char)))
2360 (isearch-process-search-char char count))))
2362 (defun isearch-printing-char (&optional char count)
2363 "Add this ordinary printing CHAR to the search string and search.
2364 With argument, add COUNT copies of the character."
2365 (interactive (list last-command-event
2366 (prefix-numeric-value current-prefix-arg)))
2367 (let ((char (or char last-command-event)))
2368 (if (= char ?\S-\ )
2369 (setq char ?\s))
2370 (if current-input-method
2371 (isearch-process-search-multibyte-characters char count)
2372 (isearch-process-search-char char count))))
2374 (defun isearch-process-search-char (char &optional count)
2375 "Add CHAR to the search string, COUNT times.
2376 Search is updated accordingly."
2377 ;; * and ? are special in regexps when not preceded by \.
2378 ;; } and | are special in regexps when preceded by \.
2379 ;; Nothing special for + because it matches at least once.
2380 (cond
2381 ((memq char '(?* ??)) (isearch-fallback nil))
2382 ((eq char ?\}) (isearch-fallback t t))
2383 ((eq char ?|) (isearch-fallback t nil t)))
2385 ;; Append the char(s) to the search string,
2386 ;; update the message and re-search.
2387 (let* ((string (if (and (integerp count) (> count 1))
2388 (make-string count char)
2389 (char-to-string char)))
2391 string
2392 (mapconcat 'isearch-text-char-description string ""))))
2393 (isearch-process-search-string string message)))
2395 (defun isearch-process-search-string (string message)
2396 (setq isearch-string (concat isearch-string string)
2397 isearch-message (concat isearch-message message))
2398 (isearch-search-and-update))
2400 \f
2401 ;; Search Ring
2403 (defun isearch-ring-adjust1 (advance)
2404 ;; Helper for isearch-ring-adjust
2405 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2406 (length (length ring))
2407 (yank-pointer-name (if isearch-regexp
2408 'regexp-search-ring-yank-pointer
2409 'search-ring-yank-pointer))
2410 (yank-pointer (eval yank-pointer-name)))
2411 (if (zerop length)
2412 ()
2413 (set yank-pointer-name
2414 (setq yank-pointer
2415 (mod (+ (or yank-pointer (if advance 0 -1))
2416 (if advance -1 1))
2417 length)))
2418 (setq isearch-string (nth yank-pointer ring)
2419 isearch-message (mapconcat 'isearch-text-char-description
2420 isearch-string "")))))
2422 (defun isearch-ring-adjust (advance)
2423 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2424 (isearch-ring-adjust1 advance)
2425 (if search-ring-update
2426 (progn
2427 (isearch-search)
2428 (isearch-push-state)
2429 (isearch-update))
2430 ;; Otherwise, edit the search string instead. Note that there is
2431 ;; no need to push the search state after isearch-edit-string here
2432 ;; since isearch-edit-string already pushes its state
2433 (isearch-edit-string)))
2435 (defun isearch-ring-advance ()
2436 "Advance to the next search string in the ring."
2437 ;; This could be more general to handle a prefix arg, but who would use it.
2438 (interactive)
2439 (isearch-ring-adjust 'advance))
2441 (defun isearch-ring-retreat ()
2442 "Retreat to the previous search string in the ring."
2443 (interactive)
2444 (isearch-ring-adjust nil))
2446 (defun isearch-complete1 ()
2447 ;; Helper for isearch-complete and isearch-complete-edit
2448 ;; Return t if completion OK, nil if no completion exists.
2449 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2450 (completion-ignore-case case-fold-search)
2451 (completion (try-completion isearch-string ring)))
2452 (cond
2453 ((eq completion t)
2454 ;; isearch-string stays the same
2455 t)
2456 ((or completion ; not nil, must be a string
2457 (= 0 (length isearch-string))) ; shouldn't have to say this
2458 (if (equal completion isearch-string) ;; no extension?
2459 (progn
2460 (if completion-auto-help
2461 (with-output-to-temp-buffer "*Isearch completions*"
2462 (display-completion-list
2463 (all-completions isearch-string ring))))
2464 t)
2465 (and completion
2466 (setq isearch-string completion))))
2467 (t
2468 (message "No completion") ; waits a second if in minibuffer
2469 nil))))
2471 (defun isearch-complete ()
2472 "Complete the search string from the strings on the search ring.
2473 The completed string is then editable in the minibuffer.
2474 If there is no completion possible, say so and continue searching."
2475 (interactive)
2476 (if (isearch-complete1)
2477 (progn (setq isearch-message
2478 (mapconcat 'isearch-text-char-description
2479 isearch-string ""))
2480 (isearch-edit-string))
2481 ;; else
2482 (sit-for 1)
2483 (isearch-update)))
2485 (defun isearch-complete-edit ()
2486 "Same as `isearch-complete' except in the minibuffer."
2487 (interactive)
2488 (setq isearch-string (field-string))
2489 (if (isearch-complete1)
2490 (progn
2491 (delete-field)
2492 (insert isearch-string))))
2494 \f
2495 ;; Message string
2497 (defun isearch-message (&optional c-q-hack ellipsis)
2498 ;; Generate and print the message string.
2499 (let ((cursor-in-echo-area ellipsis)
2500 (m isearch-message)
2501 (fail-pos (isearch-fail-pos t)))
2502 ;; Highlight failed part
2503 (when fail-pos
2504 (setq m (copy-sequence m))
2505 (add-text-properties fail-pos (length m) '(face isearch-fail) m)
2506 ;; Highlight failed trailing whitespace
2507 (when (string-match " +$" m)
2508 (add-text-properties (match-beginning 0) (match-end 0)
2509 '(face trailing-whitespace) m)))
2510 (setq m (concat
2511 (isearch-message-prefix ellipsis isearch-nonincremental)
2512 m
2513 (isearch-message-suffix c-q-hack)))
2514 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2516 (defun isearch--describe-word-mode (word-mode &optional space-before)
2517 "Make a string for describing WORD-MODE.
2518 If SPACE-BEFORE is non-nil, put a space before, instead of after,
2519 the word mode."
2520 (let ((description
2521 (cond ((and (symbolp word-mode)
2522 (get word-mode 'isearch-message-prefix))
2523 (get word-mode 'isearch-message-prefix))
2524 (word-mode "word ")
2525 (t ""))))
2526 (if space-before
2527 ;; Move space from the end to the beginning.
2529 description)))
2531 (defun isearch-message-prefix (&optional ellipsis nonincremental)
2532 ;; If about to search, and previous search regexp was invalid,
2533 ;; check that it still is. If it is valid now,
2534 ;; let the message we display while searching say that it is valid.
2535 (and isearch-error ellipsis
2536 (condition-case ()
2537 (progn (re-search-forward isearch-string (point) t)
2538 (setq isearch-error nil))
2539 (error nil)))
2540 ;; If currently failing, display no ellipsis.
2541 (or isearch-success (setq ellipsis nil))
2542 (let ((m (concat (if isearch-success "" "failing ")
2543 (if isearch-adjusted "pending " "")
2544 (if (and isearch-wrapped
2545 (not isearch-wrap-function)
2546 (if isearch-forward
2547 (> (point) isearch-opoint)
2548 (< (point) isearch-opoint)))
2549 "over")
2550 (if isearch-wrapped "wrapped ")
2551 (let ((prefix ""))
2552 (advice-function-mapc
2553 (lambda (_ props)
2554 (let ((np (cdr (assq 'isearch-message-prefix props))))
2555 (if np (setq prefix (concat np prefix)))))
2556 isearch-filter-predicate)
2557 prefix)
2558 (isearch--describe-word-mode isearch-word)
2559 (if isearch-regexp "regexp " "")
2560 (cond
2561 (multi-isearch-file-list "multi-file ")
2562 (multi-isearch-buffer-list "multi-buffer ")
2563 (t ""))
2564 (or isearch-message-prefix-add "")
2565 (if nonincremental "search" "I-search")
2566 (if isearch-forward "" " backward")
2567 (if current-input-method
2568 ;; Input methods for RTL languages use RTL
2569 ;; characters for their title, and that messes
2570 ;; up the display of search text after the prompt.
2571 (bidi-string-mark-left-to-right
2572 (concat " [" current-input-method-title "]: "))
2573 ": ")
2574 )))
2575 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2576 'face 'minibuffer-prompt)))
2578 (defun isearch-message-suffix (&optional c-q-hack)
2579 (concat (if c-q-hack "^Q" "")
2580 (if isearch-error
2581 (concat " [" isearch-error "]")
2582 "")
2583 (or isearch-message-suffix-add "")))
2585 \f
2586 ;; Searching
2588 (defvar isearch-search-fun-function 'isearch-search-fun-default
2589 "Non-default value overrides the behavior of `isearch-search-fun-default'.
2590 This variable's value should be a function, which will be called
2591 with no arguments, and should return a function that takes three
2592 arguments: STRING, BOUND, and NOERROR.
2594 This returned function will be used by `isearch-search-string' to
2595 search for the first occurrence of STRING or its translation.")
2597 (defun isearch-search-fun ()
2598 "Return the function to use for the search.
2599 Can be changed via `isearch-search-fun-function' for special needs."
2600 (funcall (or isearch-search-fun-function 'isearch-search-fun-default)))
2602 (defun isearch-search-fun-default ()
2603 "Return default functions to use for the search."
2604 (cond
2605 (isearch-word
2606 (lambda (string &optional bound noerror count)
2607 ;; Use lax versions to not fail at the end of the word while
2608 ;; the user adds and removes characters in the search string
2609 ;; (or when using nonincremental word isearch)
2610 (let ((lax (not (or isearch-nonincremental
2611 (null (car isearch-cmds))
2612 (eq (length isearch-string)
2613 (length (isearch--state-string
2614 (car isearch-cmds))))))))
2615 (funcall
2616 (if isearch-forward #'re-search-forward #'re-search-backward)
2617 (if (functionp isearch-word)
2618 (funcall isearch-word string lax)
2619 (word-search-regexp string lax))
2620 bound noerror count))))
2621 ((and isearch-regexp isearch-regexp-lax-whitespace
2622 search-whitespace-regexp)
2623 (if isearch-forward
2624 're-search-forward-lax-whitespace
2625 're-search-backward-lax-whitespace))
2626 (isearch-regexp
2627 (if isearch-forward 're-search-forward 're-search-backward))
2628 ((and isearch-lax-whitespace search-whitespace-regexp)
2629 (if isearch-forward
2630 'search-forward-lax-whitespace
2631 'search-backward-lax-whitespace))
2632 (t
2633 (if isearch-forward 'search-forward 'search-backward))))
2635 (defun isearch-search-string (string bound noerror)
2636 "Search for the first occurrence of STRING or its translation.
2637 If found, move point to the end of the occurrence,
2638 update the match data, and return point."
2639 (let* ((func (isearch-search-fun))
2640 (pos1 (save-excursion (funcall func string bound noerror)))
2641 pos2)
2642 (when (and
2643 ;; Avoid "obsolete" warnings for translation-table-for-input.
2644 (with-no-warnings
2645 (char-table-p translation-table-for-input))
2646 (multibyte-string-p string)
2647 ;; Minor optimization.
2648 (string-match-p "[^[:ascii:]]" string))
2649 (let ((translated
2650 (apply 'string
2651 (mapcar (lambda (c)
2652 (or
2653 ;; Avoid "obsolete" warnings for
2654 ;; translation-table-for-input.
2655 (with-no-warnings
2656 (aref translation-table-for-input c))
2657 c))
2658 string)))
2659 match-data)
2660 (when translated
2661 (save-match-data
2662 (save-excursion
2663 (if (setq pos2 (funcall func translated bound noerror))
2664 (setq match-data (match-data t)))))
2665 (when (and pos2
2666 (or (not pos1)
2667 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2668 (setq pos1 pos2)
2669 (set-match-data match-data)))))
2670 (when pos1
2671 ;; When using multiple buffers isearch, switch to the new buffer here,
2672 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2673 (if (and multi-isearch-next-buffer-current-function
2674 (buffer-live-p multi-isearch-current-buffer))
2675 (switch-to-buffer multi-isearch-current-buffer))
2676 (goto-char pos1)
2677 pos1)))
2679 (defun isearch-search ()
2680 ;; Do the search with the current search string.
2681 (if isearch-message-function
2682 (funcall isearch-message-function nil t)
2683 (isearch-message nil t))
2684 (if (and (eq isearch-case-fold-search t) search-upper-case)
2685 (setq isearch-case-fold-search
2686 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2687 (condition-case lossage
2688 (let ((inhibit-point-motion-hooks isearch-invisible)
2689 (inhibit-quit nil)
2690 (case-fold-search isearch-case-fold-search)
2691 (search-invisible isearch-invisible)
2692 (retry t))
2693 (setq isearch-error nil)
2694 (while retry
2695 (setq isearch-success
2696 (isearch-search-string isearch-string nil t))
2697 ;; Clear RETRY unless the search predicate says
2698 ;; to skip this search hit.
2699 (if (or (not isearch-success)
2700 (bobp) (eobp)
2701 (= (match-beginning 0) (match-end 0))
2702 (funcall isearch-filter-predicate
2703 (match-beginning 0) (match-end 0)))
2704 (setq retry nil)))
2705 (setq isearch-just-started nil)
2706 (if isearch-success
2707 (setq isearch-other-end
2708 (if isearch-forward (match-beginning 0) (match-end 0)))))
2710 (quit (isearch-unread ?\C-g)
2711 (setq isearch-success nil))
2713 (invalid-regexp
2714 (setq isearch-error (car (cdr lossage)))
2715 (cond
2716 ((string-match
2718 isearch-error)
2719 (setq isearch-error "incomplete input"))
2720 ((and (not isearch-regexp)
2722 (cond
2723 (isearch-word
2724 (setq isearch-error "Too many words"))
2725 ((and isearch-lax-whitespace search-whitespace-regexp)
2726 (setq isearch-error "Too many spaces for whitespace matching"))))))
2728 (search-failed
2729 (setq isearch-success nil)
2730 (setq isearch-error (nth 2 lossage)))
2732 (error
2733 ;; stack overflow in regexp search.
2734 (setq isearch-error (format "%s" lossage))))
2736 (if isearch-success
2737 nil
2738 ;; Ding if failed this time after succeeding last time.
2739 (and (isearch--state-success (car isearch-cmds))
2740 (ding))
2741 (if (functionp (isearch--state-pop-fun (car isearch-cmds)))
2742 (funcall (isearch--state-pop-fun (car isearch-cmds))
2743 (car isearch-cmds)))
2744 (goto-char (isearch--state-point (car isearch-cmds)))))
2747 ;; Called when opening an overlay, and we are still in isearch.
2748 (defun isearch-open-overlay-temporary (ov)
2749 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2750 ;; Some modes would want to open the overlays temporary during
2751 ;; isearch in their own way, they should set the
2752 ;; `isearch-open-invisible-temporary' to a function doing this.
2753 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2754 ;; Store the values for the `invisible' property, and then set it to nil.
2755 ;; This way the text hidden by this overlay becomes visible.
2757 ;; In 19.34 this does not exist so I cannot test it.
2758 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2759 (overlay-put ov 'invisible nil)))
2762 ;; This is called at the end of isearch. It will open the overlays
2763 ;; that contain the latest match. Obviously in case of a C-g the
2764 ;; point returns to the original location which surely is not contain
2765 ;; in any of these overlays, se we are safe in this case too.
2766 (defun isearch-open-necessary-overlays (ov)
2767 (let ((inside-overlay (and (> (point) (overlay-start ov))
2768 (<= (point) (overlay-end ov))))
2769 ;; If this exists it means that the overlay was opened using
2770 ;; this function, not by us tweaking the overlay properties.
2771 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2772 (when (or inside-overlay (not fct-temp))
2773 ;; restore the values for the `invisible' properties.
2774 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2775 (overlay-put ov 'isearch-invisible nil))
2776 (if inside-overlay
2777 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2778 (if fct-temp
2779 (funcall fct-temp ov t)))))
2781 ;; This is called when exiting isearch. It closes the temporary
2782 ;; opened overlays, except the ones that contain the latest match.
2783 (defun isearch-clean-overlays ()
2784 (when isearch-opened-overlays
2785 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2786 (setq isearch-opened-overlays nil)))
2789 (defun isearch-intersects-p (start0 end0 start1 end1)
2790 "Return t if regions START0..END0 and START1..END1 intersect."
2791 (or (and (>= start0 start1) (< start0 end1))
2792 (and (> end0 start1) (<= end0 end1))
2793 (and (>= start1 start0) (< start1 end0))
2794 (and (> end1 start0) (<= end1 end0))))
2797 ;; Verify if the current match is outside of each element of
2798 ;; `isearch-opened-overlays', if so close that overlay.
2800 (defun isearch-close-unnecessary-overlays (begin end)
2801 (let ((overlays isearch-opened-overlays))
2802 (setq isearch-opened-overlays nil)
2803 (dolist (ov overlays)
2804 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2805 (push ov isearch-opened-overlays)
2806 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2807 (if fct-temp
2808 ;; If this exists it means that the overlay was opened
2809 ;; using this function, not by us tweaking the overlay
2810 ;; properties.
2811 (funcall fct-temp ov t)
2812 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2813 (overlay-put ov 'isearch-invisible nil)))))))
2816 (defun isearch-range-invisible (beg end)
2817 "Return t if all the text from BEG to END is invisible."
2818 (when (/= beg end)
2819 ;; Check that invisibility runs up to END.
2820 (save-excursion
2821 (goto-char beg)
2822 (let (;; can-be-opened keeps track if we can open some overlays.
2823 (can-be-opened (eq search-invisible 'open))
2824 ;; the list of overlays that could be opened
2825 (crt-overlays nil))
2826 (when (and can-be-opened isearch-hide-immediately)
2827 (isearch-close-unnecessary-overlays beg end))
2828 ;; If the following character is currently invisible,
2829 ;; skip all characters with that same `invisible' property value.
2830 ;; Do that over and over.
2831 (while (and (< (point) end) (invisible-p (point)))
2832 (if (invisible-p (get-text-property (point) 'invisible))
2833 (progn
2834 (goto-char (next-single-property-change (point) 'invisible
2835 nil end))
2836 ;; if text is hidden by an `invisible' text property
2837 ;; we cannot open it at all.
2838 (setq can-be-opened nil))
2839 (when can-be-opened
2840 (let ((overlays (overlays-at (point)))
2841 ov-list
2842 o
2843 invis-prop)
2844 (while overlays
2845 (setq o (car overlays)
2846 invis-prop (overlay-get o 'invisible))
2847 (if (invisible-p invis-prop)
2848 (if (overlay-get o 'isearch-open-invisible)
2849 (setq ov-list (cons o ov-list))
2850 ;; We found one overlay that cannot be
2851 ;; opened, that means the whole chunk
2852 ;; cannot be opened.
2853 (setq can-be-opened nil)))
2854 (setq overlays (cdr overlays)))
2855 (if can-be-opened
2856 ;; It makes sense to append to the open
2857 ;; overlays list only if we know that this is
2858 ;; t.
2859 (setq crt-overlays (append ov-list crt-overlays)))))
2860 (goto-char (next-overlay-change (point)))))
2861 ;; See if invisibility reaches up thru END.
2862 (if (>= (point) end)
2863 (if (and can-be-opened (consp crt-overlays))
2864 (progn
2865 (setq isearch-opened-overlays
2866 (append isearch-opened-overlays crt-overlays))
2867 (mapc 'isearch-open-overlay-temporary crt-overlays)
2868 nil)
2869 (setq isearch-hidden t)))))))
2871 (defun isearch-filter-visible (beg end)
2872 "Test whether the current search hit is visible at least partially.
2873 Return non-nil if the text from BEG to END is visible to Isearch as
2874 determined by `isearch-range-invisible' unless invisible text can be
2875 searched too when `search-invisible' is t."
2876 (or (eq search-invisible t)
2877 (not (isearch-range-invisible beg end))))
2879 \f
2880 ;; General utilities
2882 (defun isearch-no-upper-case-p (string regexp-flag)
2883 "Return t if there are no upper case chars in STRING.
2885 since they have special meaning in a regexp."
2886 (let (quote-flag (i 0) (len (length string)) found)
2887 (while (and (not found) (< i len))
2888 (let ((char (aref string i)))
2890 (setq quote-flag (not quote-flag))
2891 (if (and (not quote-flag) (not (eq char (downcase char))))
2892 (setq found t))
2893 (setq quote-flag nil)))
2894 (setq i (1+ i)))
2895 (not (or found
2896 ;; Even if there's no uppercase char, we want to detect the use
2897 ;; of [:upper:] or [:lower:] char-class, which indicates
2898 ;; clearly that the user cares about case distinction.
2900 (condition-case err
2901 (progn
2902 (string-match (substring string 0 (match-beginning 0))
2903 "")
2904 nil)
2905 (invalid-regexp
2906 (equal "Unmatched [ or [^" (cadr err)))))))))
2908 ;; Portability functions to support various Emacs versions.
2910 (defun isearch-text-char-description (c)
2911 (cond
2912 ((< c ?\s) (propertize
2913 (char-to-string c)
2914 'display (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph)))
2915 ((= c ?\^?) (propertize
2916 (char-to-string c)
2917 'display (propertize "^?" 'face 'escape-glyph)))
2918 (t (char-to-string c))))
2920 ;; General function to unread characters or events.
2921 ;; Also insert them in a keyboard macro being defined.
2922 (defun isearch-unread (&rest char-or-events)
2923 (mapc 'store-kbd-macro-event char-or-events)
2924 (setq unread-command-events
2925 (append char-or-events unread-command-events)))
2927 \f
2928 ;; Highlighting
2930 (defvar isearch-overlay nil)
2932 (defun isearch-highlight (beg end)
2933 (if search-highlight
2934 (if isearch-overlay
2935 ;; Overlay already exists, just move it.
2936 (move-overlay isearch-overlay beg end (current-buffer))
2937 ;; Overlay doesn't exist, create it.
2938 (setq isearch-overlay (make-overlay beg end))
2939 ;; 1001 is higher than lazy's 1000 and ediff's 100+
2940 (overlay-put isearch-overlay 'priority 1001)
2941 (overlay-put isearch-overlay 'face isearch-face))))
2943 (defun isearch-dehighlight ()
2944 (when isearch-overlay
2945 (delete-overlay isearch-overlay)))
2946 \f
2947 ;; isearch-lazy-highlight feature
2948 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
2950 ;; When active, *every* match for the current search string is
2951 ;; highlighted: the current one using the normal isearch match color
2952 ;; and all the others using `isearch-lazy-highlight'. The extra
2953 ;; highlighting makes it easier to anticipate where the cursor will
2954 ;; land each time you press C-s or C-r to repeat a pending search.
2955 ;; Highlighting of these additional matches happens in a deferred
2956 ;; fashion using "idle timers," so the cycles needed do not rob
2957 ;; isearch of its usual snappy response.
2959 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
2960 ;; Specifically:
2961 ;; - `isearch-update' is expected to be called (at least) every time
2962 ;; the search string or window-start changes;
2963 ;; - `isearch-string' is expected to contain the current search
2964 ;; string as entered by the user;
2965 ;; - the type of the current search is expected to be given by
2966 ;; `isearch-word' and `isearch-regexp';
2967 ;; - the direction of the current search is expected to be given by
2968 ;; `isearch-forward';
2969 ;; - the variable `isearch-error' is expected to be true
2970 ;; only if `isearch-string' is an invalid regexp.
2972 (defvar isearch-lazy-highlight-overlays nil)
2973 (defvar isearch-lazy-highlight-wrapped nil)
2974 (defvar isearch-lazy-highlight-start-limit nil)
2975 (defvar isearch-lazy-highlight-end-limit nil)
2976 (defvar isearch-lazy-highlight-start nil)
2977 (defvar isearch-lazy-highlight-end nil)
2978 (defvar isearch-lazy-highlight-timer nil)
2979 (defvar isearch-lazy-highlight-last-string nil)
2980 (defvar isearch-lazy-highlight-window nil)
2981 (defvar isearch-lazy-highlight-window-start nil)
2982 (defvar isearch-lazy-highlight-window-end nil)
2983 (defvar isearch-lazy-highlight-case-fold-search nil)
2984 (defvar isearch-lazy-highlight-regexp nil)
2985 (defvar isearch-lazy-highlight-lax-whitespace nil)
2986 (defvar isearch-lazy-highlight-regexp-lax-whitespace nil)
2987 (defvar isearch-lazy-highlight-word nil)
2988 (defvar isearch-lazy-highlight-forward nil)
2989 (defvar isearch-lazy-highlight-error nil)
2991 (defun lazy-highlight-cleanup (&optional force)
2992 "Stop lazy highlighting and remove extra highlighting from current buffer.
2993 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
2994 is nil. This function is called when exiting an incremental search if
2995 `lazy-highlight-cleanup' is non-nil."
2996 (interactive '(t))
2997 (if (or force lazy-highlight-cleanup)
2998 (while isearch-lazy-highlight-overlays
2999 (delete-overlay (car isearch-lazy-highlight-overlays))
3000 (setq isearch-lazy-highlight-overlays
3001 (cdr isearch-lazy-highlight-overlays))))
3002 (when isearch-lazy-highlight-timer
3003 (cancel-timer isearch-lazy-highlight-timer)
3004 (setq isearch-lazy-highlight-timer nil)))
3006 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
3007 'lazy-highlight-cleanup
3008 "22.1")
3010 (defun isearch-lazy-highlight-new-loop (&optional beg end)
3011 "Cleanup any previous `lazy-highlight' loop and begin a new one.
3012 BEG and END specify the bounds within which highlighting should occur.
3013 This is called when `isearch-update' is invoked (which can cause the
3014 search string to change or the window to scroll). It is also used
3015 by other Emacs features."
3016 (when (and (null executing-kbd-macro)
3017 (sit-for 0) ;make sure (window-start) is credible
3018 (or (not (equal isearch-string
3019 isearch-lazy-highlight-last-string))
3020 (not (eq (selected-window)
3021 isearch-lazy-highlight-window))
3022 (not (eq isearch-lazy-highlight-case-fold-search
3023 isearch-case-fold-search))
3024 (not (eq isearch-lazy-highlight-regexp
3025 isearch-regexp))
3026 (not (eq isearch-lazy-highlight-word
3027 isearch-word))
3028 (not (eq isearch-lazy-highlight-lax-whitespace
3029 isearch-lax-whitespace))
3030 (not (eq isearch-lazy-highlight-regexp-lax-whitespace
3031 isearch-regexp-lax-whitespace))
3032 (not (= (window-start)
3033 isearch-lazy-highlight-window-start))
3034 (not (= (window-end) ; Window may have been split/joined.
3035 isearch-lazy-highlight-window-end))
3036 (not (eq isearch-forward
3037 isearch-lazy-highlight-forward))
3038 ;; In case we are recovering from an error.
3039 (not (equal isearch-error
3040 isearch-lazy-highlight-error))))
3041 ;; something important did indeed change
3042 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
3043 (setq isearch-lazy-highlight-error isearch-error)
3044 ;; It used to check for `(not isearch-error)' here, but actually
3045 ;; lazy-highlighting might find matches to highlight even when
3046 ;; `isearch-error' is non-nil. (Bug#9918)
3047 (setq isearch-lazy-highlight-start-limit beg
3048 isearch-lazy-highlight-end-limit end)
3049 (setq isearch-lazy-highlight-window (selected-window)
3050 isearch-lazy-highlight-window-start (window-start)
3051 isearch-lazy-highlight-window-end (window-end)
3052 ;; Start lazy-highlighting at the beginning of the found
3053 ;; match (`isearch-other-end'). If no match, use point.
3054 ;; One of the next two variables (depending on search direction)
3055 ;; is used to define the starting position of lazy-highlighting
3056 ;; and also to remember the current position of point between
3057 ;; calls of `isearch-lazy-highlight-update', and another variable
3058 ;; is used to define where the wrapped search must stop.
3059 isearch-lazy-highlight-start (or isearch-other-end (point))
3060 isearch-lazy-highlight-end (or isearch-other-end (point))
3061 isearch-lazy-highlight-wrapped nil
3062 isearch-lazy-highlight-last-string isearch-string
3063 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
3064 isearch-lazy-highlight-regexp isearch-regexp
3065 isearch-lazy-highlight-lax-whitespace isearch-lax-whitespace
3066 isearch-lazy-highlight-regexp-lax-whitespace isearch-regexp-lax-whitespace
3067 isearch-lazy-highlight-word isearch-word
3068 isearch-lazy-highlight-forward isearch-forward)
3069 (unless (equal isearch-string "")
3070 (setq isearch-lazy-highlight-timer
3071 (run-with-idle-timer lazy-highlight-initial-delay nil
3072 'isearch-lazy-highlight-update)))))
3074 (defun isearch-lazy-highlight-search ()
3075 "Search ahead for the next or previous match, for lazy highlighting.
3076 Attempt to do the search exactly the way the pending Isearch would."
3077 (condition-case nil
3078 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
3079 (isearch-regexp isearch-lazy-highlight-regexp)
3080 (isearch-word isearch-lazy-highlight-word)
3081 (isearch-lax-whitespace
3082 isearch-lazy-highlight-lax-whitespace)
3083 (isearch-regexp-lax-whitespace
3084 isearch-lazy-highlight-regexp-lax-whitespace)
3085 (isearch-forward isearch-lazy-highlight-forward)
3086 (search-invisible nil) ; don't match invisible text
3087 (retry t)
3088 (success nil)
3089 (bound (if isearch-lazy-highlight-forward
3090 (min (or isearch-lazy-highlight-end-limit (point-max))
3091 (if isearch-lazy-highlight-wrapped
3092 (+ isearch-lazy-highlight-start
3093 ;; Extend bound to match whole string at point
3094 (1- (length isearch-lazy-highlight-last-string)))
3095 (window-end)))
3096 (max (or isearch-lazy-highlight-start-limit (point-min))
3097 (if isearch-lazy-highlight-wrapped
3098 (- isearch-lazy-highlight-end
3099 ;; Extend bound to match whole string at point
3100 (1- (length isearch-lazy-highlight-last-string)))
3101 (window-start))))))
3102 ;; Use a loop like in `isearch-search'.
3103 (while retry
3104 (setq success (isearch-search-string
3105 isearch-lazy-highlight-last-string bound t))
3106 ;; Clear RETRY unless the search predicate says
3107 ;; to skip this search hit.
3108 (if (or (not success)
3109 (= (point) bound) ; like (bobp) (eobp) in `isearch-search'.
3110 (= (match-beginning 0) (match-end 0))
3111 (funcall isearch-filter-predicate
3112 (match-beginning 0) (match-end 0)))
3113 (setq retry nil)))
3114 success)
3115 (error nil)))
3117 (defun isearch-lazy-highlight-update ()
3118 "Update highlighting of other matches for current search."
3119 (let ((max lazy-highlight-max-at-a-time)
3120 (looping t)
3121 nomore)
3122 (with-local-quit
3123 (save-selected-window
3124 (if (and (window-live-p isearch-lazy-highlight-window)
3125 (not (eq (selected-window) isearch-lazy-highlight-window)))
3126 (select-window isearch-lazy-highlight-window))
3127 (save-excursion
3128 (save-match-data
3129 (goto-char (if isearch-lazy-highlight-forward
3130 isearch-lazy-highlight-end
3131 isearch-lazy-highlight-start))
3132 (while looping
3133 (let ((found (isearch-lazy-highlight-search)))
3134 (when max
3135 (setq max (1- max))
3136 (if (<= max 0)
3137 (setq looping nil)))
3138 (if found
3139 (let ((mb (match-beginning 0))
3140 (me (match-end 0)))
3141 (if (= mb me) ;zero-length match
3142 (if isearch-lazy-highlight-forward
3143 (if (= mb (if isearch-lazy-highlight-wrapped
3144 isearch-lazy-highlight-start
3145 (window-end)))
3146 (setq found nil)
3147 (forward-char 1))
3148 (if (= mb (if isearch-lazy-highlight-wrapped
3149 isearch-lazy-highlight-end
3150 (window-start)))
3151 (setq found nil)
3152 (forward-char -1)))
3154 ;; non-zero-length match
3155 (let ((ov (make-overlay mb me)))
3156 (push ov isearch-lazy-highlight-overlays)
3157 ;; 1000 is higher than ediff's 100+,
3158 ;; but lower than isearch main overlay's 1001
3159 (overlay-put ov 'priority 1000)
3160 (overlay-put ov 'face lazy-highlight-face)
3161 (overlay-put ov 'window (selected-window))))
3162 ;; Remember the current position of point for
3163 ;; the next call of `isearch-lazy-highlight-update'
3164 ;; when `lazy-highlight-max-at-a-time' is too small.
3165 (if isearch-lazy-highlight-forward
3166 (setq isearch-lazy-highlight-end (point))
3167 (setq isearch-lazy-highlight-start (point)))))
3169 ;; not found or zero-length match at the search bound
3170 (if (not found)
3171 (if isearch-lazy-highlight-wrapped
3172 (setq looping nil
3173 nomore t)
3174 (setq isearch-lazy-highlight-wrapped t)
3175 (if isearch-lazy-highlight-forward
3176 (progn
3177 (setq isearch-lazy-highlight-end (window-start))
3178 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
3179 (window-start))))
3180 (setq isearch-lazy-highlight-start (window-end))
3181 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
3182 (window-end))))))))
3183 (unless nomore
3184 (setq isearch-lazy-highlight-timer
3185 (run-at-time lazy-highlight-interval nil
3186 'isearch-lazy-highlight-update)))))))))
3188 (defun isearch-resume (string regexp word forward message case-fold)
3189 "Resume an incremental search.
3190 STRING is the string or regexp searched for.
3191 REGEXP non-nil means the resumed search was a regexp search.
3192 WORD non-nil means resume a word search.
3193 FORWARD non-nil means resume a forward search.
3194 MESSAGE is the echo-area message recorded for the search resumed.
3195 CASE-FOLD non-nil means the search was case-insensitive."
3196 (isearch-mode forward regexp nil nil word)
3197 (setq isearch-string string
3198 isearch-message message
3199 isearch-case-fold-search case-fold)
3200 (isearch-search)
3201 (isearch-update))
3203 ;;; isearch.el ends here