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