| blob | ec4f32aeccaee9ba1437521f8bcf2ef55e2c11ec |
1 ;;; isearch.el --- incremental search minor mode
3 ;; Copyright (C) 1992-1997, 1999-2013 Free Software Foundation, Inc.
5 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
6 ;; Maintainer: FSF
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 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'.)
140 See also `reveal-mode' if you want overlays to automatically be opened
141 whenever point is in one of them."
148 "If non-nil, re-hide an invisible match right away.
149 This variable makes a difference when `search-invisible' is set to `open'.
150 It means that after search makes some invisible text visible
151 to show the match, it makes the text invisible again when the match moves.
152 Ordinarily the text becomes invisible again at the end of the search."
157 "If non-nil, `isearch-resume' commands are added to the command history.
158 This allows you to resume earlier Isearch sessions through the
159 command history."
170 "Function(s) to call after terminating an incremental search.
171 When these functions are called, `isearch-mode-end-hook-quit'
178 "Function to call to display the search prompt.
182 "Function to call to wrap the search when search is failed.
183 If nil, move point to the beginning of the buffer for a forward search,
187 "Function to save a function restoring the mode-specific Isearch state
191 "Predicates that filter the search hits that would normally be available.
192 Search hits that dissatisfy the list of predicates are skipped.
193 Each function in this list has two arguments: the positions of
194 start and end of text matched by the search.
195 The search loop uses `run-hook-with-args-until-failure' to call
196 each predicate in order, and when one of the predicates returns nil,
197 skips this match and continues searching for the next match.
198 When the list of predicates is empty, `run-hook-with-args-until-failure'
199 returns non-nil that means that the found match is accepted.
200 The property `isearch-message-prefix' put on the predicate's symbol
203 'isearch-filter-predicates
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.
359 (define-key map (char-to-string help-char) 'isearch-help-for-help)
360 (define-key map [help] 'isearch-help-for-help)
361 (define-key map [f1] 'isearch-help-for-help)
362 (define-key map "?" 'isearch-help-for-help)
363 (define-key map "b" 'isearch-describe-bindings)
364 (define-key map "k" 'isearch-describe-key)
365 (define-key map "m" 'isearch-describe-mode)
366 (define-key map "q" 'help-quit)
367 map)
368 "Keymap for characters following the Help key for Isearch mode.")
370 (eval-when-compile (require 'help-macro))
372 (make-help-screen isearch-help-for-help-internal
373 (purecopy "Type a help option: [bkm] or ?")
374 "You have typed %THIS-KEY%, the help character. Type a Help option:
377 b Display all Isearch key bindings.
378 k KEYS Display full documentation of Isearch key sequence.
379 m Display documentation of Isearch mode.
381 You can't type here other help keys available in the global help map,
382 but outside of this help window when you type them in Isearch mode,
383 they exit Isearch mode before displaying global help."
384 isearch-help-map)
386 (defvar isearch--display-help-action '(nil (inhibit-same-window . t)))
388 (defun isearch-help-for-help ()
389 "Display Isearch help menu."
390 (interactive)
391 (let ((display-buffer-overriding-action isearch--display-help-action))
392 (isearch-help-for-help-internal))
393 (isearch-update))
395 (defun isearch-describe-bindings ()
396 "Show a list of all keys defined in Isearch mode, and their definitions.
397 This is like `describe-bindings', but displays only Isearch keys."
398 (interactive)
399 (let ((display-buffer-overriding-action isearch--display-help-action))
400 (with-help-window "*Help*"
401 (with-current-buffer standard-output
405 (defun isearch-describe-key ()
406 "Display documentation of the function invoked by isearch key."
407 (interactive)
408 (let ((display-buffer-overriding-action isearch--display-help-action))
409 (call-interactively 'describe-key))
410 (isearch-update))
412 (defun isearch-describe-mode ()
413 "Display documentation of Isearch mode."
414 (interactive)
415 (let ((display-buffer-overriding-action isearch--display-help-action))
416 (describe-function 'isearch-forward))
417 (isearch-update))
419 (defalias 'isearch-mode-help 'isearch-describe-mode)
421 \f
422 ;; Define isearch-mode keymap.
424 (defvar isearch-mode-map
425 (let ((i 0)
426 (map (make-keymap)))
427 (or (char-table-p (nth 1 map))
428 (error "The initialization of isearch-mode-map must be updated"))
429 ;; Make all multibyte characters search for themselves.
430 (set-char-table-range (nth 1 map) (cons #x100 (max-char))
431 'isearch-printing-char)
432 ;; Make function keys, etc, which aren't bound to a scrolling-function
433 ;; exit the search.
436 ;; Single-byte printing chars extend the search string by default.
442 ;; To handle local bindings with meta char prefix keys, define
443 ;; another full keymap. This must be done for any other prefix
444 ;; keys as well, one full keymap per char of the prefix key. It
445 ;; would be simpler to disable the global keymap, and/or have a
446 ;; default local key binding for any key not otherwise bound.
450 (define-key meta-map [t] 'isearch-other-meta-char))
452 ;; Several non-printing chars change the searching behavior.
453 (define-key map "\C-s" 'isearch-repeat-forward)
454 (define-key map "\C-r" 'isearch-repeat-backward)
455 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
456 ;; combinations can be used to repeat regexp isearches that can
457 ;; be used to start these searches.
458 (define-key map "\M-\C-s" 'isearch-repeat-forward)
459 (define-key map "\M-\C-r" 'isearch-repeat-backward)
461 (define-key map "\C-g" 'isearch-abort)
463 ;; This assumes \e is the meta-prefix-char.
464 (or (= ?\e meta-prefix-char)
465 (error "Inconsistency in isearch.el"))
466 (define-key map "\e\e\e" 'isearch-cancel)
467 (define-key map [escape escape escape] 'isearch-cancel)
469 (define-key map "\C-q" 'isearch-quote-char)
472 (define-key map "\C-j" 'isearch-printing-char)
474 (define-key map [?\S-\ ] 'isearch-printing-char)
476 (define-key map "\C-w" 'isearch-yank-word-or-char)
477 (define-key map "\M-\C-w" 'isearch-del-char)
478 (define-key map "\M-\C-y" 'isearch-yank-char)
479 (define-key map "\C-y" 'isearch-yank-kill)
480 (define-key map "\M-s\C-e" 'isearch-yank-line)
482 (define-key map (char-to-string help-char) isearch-help-map)
483 (define-key map [help] isearch-help-map)
484 (define-key map [f1] isearch-help-map)
486 (define-key map "\M-n" 'isearch-ring-advance)
487 (define-key map "\M-p" 'isearch-ring-retreat)
488 (define-key map "\M-y" 'isearch-yank-pop)
492 ;; Pass frame events transparently so they won't exit the search.
493 ;; In particular, if we have more than one display open, then a
494 ;; switch-frame might be generated by someone typing at another keyboard.
495 (define-key map [switch-frame] nil)
496 (define-key map [delete-frame] nil)
497 (define-key map [iconify-frame] nil)
498 (define-key map [make-frame-visible] nil)
499 (define-key map [mouse-movement] nil)
500 (define-key map [language-change] nil)
502 ;; For searching multilingual text.
504 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
506 ;; People expect to be able to paste with the mouse.
507 (define-key map [mouse-2] #'isearch-mouse-2)
508 (define-key map [down-mouse-2] nil)
510 ;; Some bindings you may want to put in your isearch-mode-hook.
511 ;; Suggest some alternates...
512 (define-key map "\M-c" 'isearch-toggle-case-fold)
513 (define-key map "\M-r" 'isearch-toggle-regexp)
514 (define-key map "\M-e" '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.
530 (define-key map "\C-x" nil)
531 (define-key map [?\C-x t] 'isearch-other-control-char)
532 (define-key map "\C-x8" nil)
535 map)
536 "Keymap for `isearch-mode'.")
538 (defvar minibuffer-local-isearch-map
539 (let ((map (make-sparse-keymap)))
540 (set-keymap-parent map minibuffer-local-map)
543 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
544 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
545 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
546 (define-key map [right] 'isearch-yank-char-in-minibuffer)
547 map)
548 "Keymap for editing Isearch strings in the minibuffer.")
550 ;; Internal variables declared globally for byte-compiler.
551 ;; These are all set with setq while isearching
552 ;; and bound locally while editing the search string.
554 (defvar isearch-forward nil) ; Searching in the forward direction.
555 (defvar isearch-regexp nil) ; Searching for a regexp.
556 (defvar isearch-word nil
557 "Regexp-based search mode for words/symbols.
558 If t, do incremental search for a sequence of words, ignoring punctuation.
559 If the value is a function (e.g. `isearch-symbol-regexp'), it is called to
560 convert the search string to a regexp used by regexp search functions.
561 The property `isearch-message-prefix' put on this function specifies the
562 prefix string displayed in the search message.")
564 (defvar isearch-lax-whitespace t
565 "If non-nil, a space will match a sequence of whitespace chars.
566 When you enter a space or spaces in ordinary incremental search, it
567 will match any sequence matched by the regexp defined by the variable
568 `search-whitespace-regexp'. If the value is nil, each space you type
569 matches literally, against one space. You can toggle the value of this
570 variable by the command `isearch-toggle-lax-whitespace'.")
572 (defvar isearch-regexp-lax-whitespace nil
573 "If non-nil, a space will match a sequence of whitespace chars.
574 When you enter a space or spaces in regexp incremental search, it
575 will match any sequence matched by the regexp defined by the variable
576 `search-whitespace-regexp'. If the value is nil, each space you type
577 matches literally, against one space. You can toggle the value of this
578 variable by the command `isearch-toggle-lax-whitespace'.")
580 (defvar isearch-cmds nil
581 "Stack of search status sets.
582 Each set is a vector of the form:
583 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
584 INVALID-REGEXP WRAPPED BARRIER WITHIN-BRACKETS CASE-FOLD-SEARCH]")
586 (defvar isearch-string "") ; The current search string.
587 (defvar isearch-message "") ; text-char-description version of isearch-string
589 (defvar isearch-message-prefix-add nil) ; Additional text for the message prefix
590 (defvar isearch-message-suffix-add nil) ; Additional text for the message suffix
592 (defvar isearch-success t) ; Searching is currently successful.
593 (defvar isearch-error nil) ; Error message for failed search.
594 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
595 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
596 (defvar isearch-barrier 0
597 "Recorded minimum/maximal point for the current search.")
598 (defvar isearch-just-started nil)
599 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
601 ;; case-fold-search while searching.
602 ;; either nil, t, or 'yes. 'yes means the same as t except that mixed
603 ;; case in the search string is ignored.
604 (defvar isearch-case-fold-search nil)
606 ;; search-invisible while searching.
607 ;; either nil, t, or 'open. 'open means the same as t except that
608 ;; opens hidden overlays.
609 (defvar isearch-invisible search-invisible)
611 (defvar isearch-last-case-fold-search nil)
613 ;; Used to save default value while isearch is active
614 (defvar isearch-original-minibuffer-message-timeout nil)
616 (defvar isearch-adjusted nil)
617 (defvar isearch-slow-terminal-mode nil)
618 ;; If t, using a small window.
619 (defvar isearch-small-window nil)
620 (defvar isearch-opoint 0)
621 ;; The window configuration active at the beginning of the search.
622 (defvar isearch-window-configuration nil)
624 ;; Flag to indicate a yank occurred, so don't move the cursor.
625 (defvar isearch-yank-flag nil)
627 ;; A function to be called after each input character is processed.
628 ;; (It is not called after characters that exit the search.)
629 ;; It is only set from an optional argument to `isearch-mode'.
630 (defvar isearch-op-fun nil)
632 ;; Is isearch-mode in a recursive edit for modal searching.
633 (defvar isearch-recursive-edit nil)
635 ;; Should isearch be terminated after doing one search?
636 (defvar isearch-nonincremental nil)
638 ;; New value of isearch-forward after isearch-edit-string.
639 (defvar isearch-new-forward nil)
641 ;; Accumulate here the overlays opened during searching.
642 (defvar isearch-opened-overlays nil)
644 ;; Non-nil if the string exists but is invisible.
645 (defvar isearch-hidden nil)
647 ;; The value of input-method-function when isearch is invoked.
648 (defvar isearch-input-method-function nil)
650 ;; A flag to tell if input-method-function is locally bound when
651 ;; isearch is invoked.
652 (defvar isearch-input-method-local-p nil)
654 ;; Minor-mode-alist changes - kind of redundant with the
655 ;; echo area, but if isearching in multiple windows, it can be useful.
657 (or (assq 'isearch-mode minor-mode-alist)
658 (nconc minor-mode-alist
659 (list '(isearch-mode isearch-mode))))
661 (defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
662 (make-variable-buffer-local 'isearch-mode)
664 (define-key global-map "\C-s" 'isearch-forward)
665 (define-key esc-map "\C-s" 'isearch-forward-regexp)
666 (define-key global-map "\C-r" 'isearch-backward)
667 (define-key esc-map "\C-r" 'isearch-backward-regexp)
668 (define-key search-map "w" 'isearch-forward-word)
669 (define-key search-map "_" 'isearch-forward-symbol)
670 (define-key search-map "." 'isearch-forward-symbol-at-point)
672 ;; Entry points to isearch-mode.
674 (defun isearch-forward (&optional regexp-p no-recursive-edit)
675 "\
676 Do incremental search forward.
677 With a prefix argument, do an incremental regular expression search instead.
679 As you type characters, they add to the search string and are found.
680 The following non-printing keys are bound in `isearch-mode-map'.
684 Type LFD (C-j) to match end of line.
688 onto the end of the search string, and search for it.
691 string and search for it.
693 and search for it.
696 with string killed before it.
699 with completion.
701 back to what has
702 been found successfully.
704 starting point.
706 If you try to exit with the search string still empty, it invokes
707 nonincremental search.
716 In incremental searches, a space or spaces normally matches any whitespace
717 defined by the variable `search-whitespace-regexp'; see also the variables
718 `isearch-lax-whitespace' and `isearch-regexp-lax-whitespace'.
722 Also supported is a search ring of the previous 16 search strings.
725 ring.
729 replace from last search string.
731 with the last search string.
733 the last search string.
735 that highlights the last search string.
741 If an input method is turned on in the current buffer, that input
742 method is also active while you are typing characters to search.
744 It also toggles the input
745 method in the current buffer.
747 To use a different input method for searching, type \
749 and specify an input method you want to use.
751 The above keys, bound in `isearch-mode-map', are often controlled by
753 Other control and meta characters terminate the search
754 and are then executed normally (depending on `search-exit-option').
755 Likewise for function keys and mouse button events.
757 If this function is called non-interactively with a nil NO-RECURSIVE-EDIT,
758 it does not return to the calling function until the search is done.
759 See the function `isearch-mode' for more information."
762 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
764 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
765 "Do incremental search forward for regular expression.
766 With a prefix argument, do a regular string search instead.
767 Like ordinary incremental search except that your input is treated
768 as a regexp. See the command `isearch-forward' for more information.
770 In incremental searches, a space or spaces normally matches any
771 whitespace defined by the variable `search-whitespace-regexp'.
772 To search for a literal space and nothing else, enter C-q SPC.
773 To toggle whitespace matching, use `isearch-toggle-lax-whitespace'."
775 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
777 (defun isearch-forward-word (&optional not-word no-recursive-edit)
778 "Do incremental search forward for a sequence of words.
779 With a prefix argument, do a regular string search instead.
780 Like ordinary incremental search except that your input is treated
781 as a sequence of words without regard to how the words are separated.
782 See the command `isearch-forward' for more information."
784 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
786 (defun isearch-forward-symbol (&optional not-symbol no-recursive-edit)
787 "Do incremental search forward for a symbol.
788 The prefix argument is currently unused.
789 Like ordinary incremental search except that your input is treated
791 See the command `isearch-forward' for more information."
793 (isearch-mode t nil nil (not no-recursive-edit) 'isearch-symbol-regexp))
795 (defun isearch-backward (&optional regexp-p no-recursive-edit)
796 "Do incremental search backward.
797 With a prefix argument, do a regular expression search instead.
798 See the command `isearch-forward' for more information."
800 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
802 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
803 "Do incremental search backward for regular expression.
804 With a prefix argument, do a regular string search instead.
805 Like ordinary incremental search except that your input is treated
806 as a regexp. See the command `isearch-forward' for more information."
808 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
810 (defun isearch-forward-symbol-at-point ()
811 "Do incremental search forward for a symbol found near point.
812 Like ordinary incremental search except that the symbol found at point
813 is added to the search string initially as a regexp surrounded
815 See the command `isearch-forward-symbol' for more information."
816 (interactive)
817 (isearch-forward-symbol nil 1)
818 (let ((bounds (find-tag-default-bounds)))
819 (cond
820 (bounds
821 (when (< (car bounds) (point))
822 (goto-char (car bounds)))
823 (isearch-yank-string
824 (buffer-substring-no-properties (car bounds) (cdr bounds))))
825 (t
826 (setq isearch-error "No symbol at point")
827 (isearch-update)))))
829 \f
830 ;; isearch-mode only sets up incremental search for the minor mode.
831 ;; All the work is done by the isearch-mode commands.
833 ;; Not used yet:
834 ;;(defvar isearch-commands '(isearch-forward isearch-backward
835 ;; isearch-forward-regexp isearch-backward-regexp)
836 ;; "List of commands for which isearch-mode does not recursive-edit.")
839 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word)
840 "Start Isearch minor mode.
841 It is called by the function `isearch-forward' and other related functions.
843 The non-nil arg FORWARD means searching in the forward direction.
845 The non-nil arg REGEXP does an incremental regular expression search.
847 The arg OP-FUN is a function to be called after each input character
848 is processed. (It is not called after characters that exit the search.)
850 When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and
851 does not return to the calling function until the search is completed.
852 To behave this way it enters a recursive-edit and exits it when done
853 isearching.
855 The arg WORD, if t, does incremental search for a sequence of words,
856 ignoring punctuation. If the value is a function, it is called to
857 convert the search string to a regexp used by regexp search functions."
859 ;; Initialize global vars.
860 (setq isearch-forward forward
861 isearch-regexp regexp
862 isearch-word word
863 isearch-op-fun op-fun
864 isearch-last-case-fold-search isearch-case-fold-search
865 isearch-case-fold-search case-fold-search
866 isearch-invisible search-invisible
867 isearch-string ""
868 isearch-message ""
869 isearch-cmds nil
870 isearch-success t
871 isearch-wrapped nil
872 isearch-barrier (point)
873 isearch-adjusted nil
874 isearch-yank-flag nil
875 isearch-error nil
876 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
877 (> (window-height)
878 (* 4
879 (abs search-slow-window-lines))))
880 isearch-other-end nil
881 isearch-small-window nil
882 isearch-just-started t
883 isearch-start-hscroll (window-hscroll)
885 isearch-opoint (point)
886 search-ring-yank-pointer nil
887 isearch-opened-overlays nil
888 isearch-input-method-function input-method-function
889 isearch-input-method-local-p (local-variable-p 'input-method-function)
890 regexp-search-ring-yank-pointer nil
892 ;; Save the original value of `minibuffer-message-timeout', and
893 ;; set it to nil so that isearch's messages don't get timed out.
894 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
895 minibuffer-message-timeout nil)
897 ;; We must bypass input method while reading key. When a user type
898 ;; printable character, appropriate input method is turned on in
899 ;; minibuffer to read multibyte characters.
900 (or isearch-input-method-local-p
901 (make-local-variable 'input-method-function))
902 (setq input-method-function nil)
904 (looking-at "")
905 (setq isearch-window-configuration
906 (if isearch-slow-terminal-mode (current-window-configuration) nil))
908 ;; Maybe make minibuffer frame visible and/or raise it.
909 (let ((frame (window-frame (minibuffer-window))))
910 (unless (memq (frame-live-p frame) '(nil t))
911 (unless (frame-visible-p frame)
912 (make-frame-visible frame))
913 (if minibuffer-auto-raise
914 (raise-frame frame))))
916 (setq isearch-mode " Isearch") ;; forward? regexp?
917 (force-mode-line-update)
919 (setq overriding-terminal-local-map isearch-mode-map)
920 (run-hooks 'isearch-mode-hook)
922 ;; Pushing the initial state used to be before running isearch-mode-hook,
923 ;; but a hook might set `isearch-push-state-function' used in
924 ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994)
925 (isearch-push-state)
927 (isearch-update)
929 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
930 (add-hook 'kbd-macro-termination-hook 'isearch-done)
932 ;; isearch-mode can be made modal (in the sense of not returning to
933 ;; the calling function until searching is completed) by entering
934 ;; a recursive-edit and exiting it when done isearching.
935 (if recursive-edit
936 (let ((isearch-recursive-edit t))
937 (recursive-edit)))
938 isearch-success)
941 ;; Some high level utilities. Others below.
943 (defun isearch-update ()
944 "This is called after every isearch command to update the display.
945 The last thing it does is to run `isearch-update-post-hook'."
946 (if (and (null unread-command-events)
947 (null executing-kbd-macro))
948 (progn
949 (if (not (input-pending-p))
950 (if isearch-message-function
951 (funcall isearch-message-function)
952 (isearch-message)))
953 (if (and isearch-slow-terminal-mode
954 (not (or isearch-small-window
955 (pos-visible-in-window-p))))
956 (let ((found-point (point)))
957 (setq isearch-small-window t)
958 (move-to-window-line 0)
959 (let ((window-min-height 1))
960 (split-window nil (if (< search-slow-window-lines 0)
961 (1+ (- search-slow-window-lines))
962 (- (window-height)
963 (1+ search-slow-window-lines)))))
964 (if (< search-slow-window-lines 0)
965 (progn (vertical-motion (- 1 search-slow-window-lines))
966 (set-window-start (next-window) (point))
967 (set-window-hscroll (next-window)
968 (window-hscroll))
969 (set-window-hscroll (selected-window) 0))
970 (other-window 1))
971 (goto-char found-point))
972 ;; Keep same hscrolling as at the start of the search when possible
973 (let ((current-scroll (window-hscroll)))
974 (set-window-hscroll (selected-window) isearch-start-hscroll)
975 (unless (pos-visible-in-window-p)
976 (set-window-hscroll (selected-window) current-scroll))))
977 (if isearch-other-end
978 (if (< isearch-other-end (point)) ; isearch-forward?
979 (isearch-highlight isearch-other-end (point))
980 (isearch-highlight (point) isearch-other-end))
981 (isearch-dehighlight))))
982 (setq ;; quit-flag nil not for isearch-mode
983 isearch-adjusted nil
984 isearch-yank-flag nil)
985 (when isearch-lazy-highlight
986 (isearch-lazy-highlight-new-loop))
987 ;; We must prevent the point moving to the end of composition when a
988 ;; part of the composition has just been searched.
989 (setq disable-point-adjustment t)
990 (run-hooks 'isearch-update-post-hook))
992 (defun isearch-done (&optional nopush edit)
993 "Exit Isearch mode.
994 For successful search, pass no args.
995 For a failing search, NOPUSH is t.
996 For going to the minibuffer to edit the search string,
997 NOPUSH is t and EDIT is t."
999 (if isearch-resume-in-command-history
1000 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
1001 ,isearch-word ,isearch-forward
1002 ,isearch-message
1003 ',isearch-case-fold-search)))
1004 (unless (equal (car command-history) command)
1005 (setq command-history (cons command command-history)))))
1007 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
1008 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
1009 (setq isearch-lazy-highlight-start nil)
1011 ;; Called by all commands that terminate isearch-mode.
1012 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
1013 (setq overriding-terminal-local-map nil)
1014 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
1015 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
1016 (isearch-dehighlight)
1017 (lazy-highlight-cleanup lazy-highlight-cleanup)
1018 (let ((found-start (window-start (selected-window)))
1019 (found-point (point)))
1020 (when isearch-window-configuration
1021 (set-window-configuration isearch-window-configuration)
1022 (if isearch-small-window
1023 (goto-char found-point)
1024 ;; set-window-configuration clobbers window-start; restore it.
1025 ;; This has an annoying side effect of clearing the last_modiff
1026 ;; field of the window, which can cause unwanted scrolling,
1027 ;; so don't do it unless truly necessary.
1028 (set-window-start (selected-window) found-start t))))
1030 (setq isearch-mode nil)
1031 (if isearch-input-method-local-p
1032 (setq input-method-function isearch-input-method-function)
1033 (kill-local-variable 'input-method-function))
1035 (force-mode-line-update)
1037 ;; If we ended in the middle of some intangible text,
1038 ;; move to the further end of that intangible text.
1039 (let ((after (if (eobp) nil
1040 (get-text-property (point) 'intangible)))
1041 (before (if (bobp) nil
1042 (get-text-property (1- (point)) 'intangible))))
1043 (when (and before after (eq before after))
1044 (goto-char
1045 (if isearch-forward
1046 (next-single-property-change (point) 'intangible)
1047 (previous-single-property-change (point) 'intangible)))))
1049 (if (and (> (length isearch-string) 0) (not nopush))
1050 ;; Update the ring data.
1051 (isearch-update-ring isearch-string isearch-regexp))
1053 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
1054 (run-hooks 'isearch-mode-end-hook))
1056 ;; If there was movement, mark the starting position.
1057 ;; Maybe should test difference between and set mark only if > threshold.
1058 (if (/= (point) isearch-opoint)
1059 (or (and transient-mark-mode mark-active)
1060 (progn
1061 (push-mark isearch-opoint t)
1062 (or executing-kbd-macro (> (minibuffer-depth) 0) edit
1063 (message "Mark saved where search started")))))
1065 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
1067 (defun isearch-update-ring (string &optional regexp)
1068 "Add STRING to the beginning of the search ring.
1069 REGEXP if non-nil says use the regexp search ring."
1070 (add-to-history
1071 (if regexp 'regexp-search-ring 'search-ring)
1072 string
1073 (if regexp regexp-search-ring-max search-ring-max)))
1075 ;; Switching buffers should first terminate isearch-mode.
1076 ;; ;; For Emacs 19, the frame switch event is handled.
1077 ;; (defun isearch-switch-frame-handler ()
1078 ;; (interactive) ;; Is this necessary?
1079 ;; ;; First terminate isearch-mode.
1080 ;; (isearch-done)
1081 ;; (isearch-clean-overlays)
1082 ;; (handle-switch-frame (car (cdr last-command-event))))
1084 \f
1085 ;; The search status structure and stack.
1087 (cl-defstruct (isearch--state
1088 (:constructor nil)
1089 (:copier nil)
1090 (:constructor isearch--get-state
1091 (&aux
1092 (string isearch-string)
1093 (message isearch-message)
1094 (point (point))
1095 (success isearch-success)
1096 (forward isearch-forward)
1097 (other-end isearch-other-end)
1098 (word isearch-word)
1099 (error isearch-error)
1100 (wrapped isearch-wrapped)
1101 (barrier isearch-barrier)
1102 (case-fold-search isearch-case-fold-search)
1103 (pop-fun (if isearch-push-state-function
1104 (funcall isearch-push-state-function))))))
1105 (string :read-only t)
1106 (message :read-only t)
1107 (point :read-only t)
1108 (success :read-only t)
1109 (forward :read-only t)
1110 (other-end :read-only t)
1111 (word :read-only t)
1112 (error :read-only t)
1113 (wrapped :read-only t)
1114 (barrier :read-only t)
1115 (case-fold-search :read-only t)
1116 (pop-fun :read-only t))
1118 (defun isearch--set-state (cmd)
1119 (setq isearch-string (isearch--state-string cmd)
1120 isearch-message (isearch--state-message cmd)
1121 isearch-success (isearch--state-success cmd)
1122 isearch-forward (isearch--state-forward cmd)
1123 isearch-other-end (isearch--state-other-end cmd)
1124 isearch-word (isearch--state-word cmd)
1125 isearch-error (isearch--state-error cmd)
1126 isearch-wrapped (isearch--state-wrapped cmd)
1127 isearch-barrier (isearch--state-barrier cmd)
1128 isearch-case-fold-search (isearch--state-case-fold-search cmd))
1129 (if (functionp (isearch--state-pop-fun cmd))
1130 (funcall (isearch--state-pop-fun cmd) cmd))
1131 (goto-char (isearch--state-point cmd)))
1133 (defun isearch-pop-state ()
1134 (setq isearch-cmds (cdr isearch-cmds))
1135 (isearch--set-state (car isearch-cmds)))
1137 (defun isearch-push-state ()
1138 (push (isearch--get-state) isearch-cmds))
1140 \f
1141 ;; Commands active while inside of the isearch minor mode.
1143 (defun isearch-exit ()
1144 "Exit search normally.
1145 However, if this is the first command after starting incremental
1146 search and `search-nonincremental-instead' is non-nil, do a
1147 nonincremental search instead via `isearch-edit-string'."
1148 (interactive)
1149 (if (and search-nonincremental-instead
1150 (= 0 (length isearch-string)))
1151 (let ((isearch-nonincremental t))
1152 (isearch-edit-string)))
1153 (isearch-done)
1154 (isearch-clean-overlays))
1156 (defvar minibuffer-history-symbol) ;; from external package gmhist.el
1158 (defun isearch-fail-pos (&optional msg)
1159 "Return position of first mismatch in search string, or nil if none.
1160 If MSG is non-nil, use variable `isearch-message', otherwise `isearch-string'."
1161 (let ((cmds isearch-cmds)
1162 (curr-msg (if msg isearch-message isearch-string))
1163 succ-msg)
1164 (when (or (not isearch-success) isearch-error)
1165 (while (and cmds
1166 (or (not (isearch--state-success (car cmds)))
1167 (isearch--state-error (car cmds))))
1168 (pop cmds))
1169 (setq succ-msg (and cmds (if msg (isearch--state-message (car cmds))
1170 (isearch--state-string (car cmds)))))
1171 (if (and (stringp succ-msg)
1172 (< (length succ-msg) (length curr-msg))
1173 (equal succ-msg
1174 (substring curr-msg 0 (length succ-msg))))
1175 (length succ-msg)
1176 0))))
1178 (defmacro with-isearch-suspended (&rest body)
1179 "Exit Isearch mode, run BODY, and reinvoke the pending search.
1180 You can update the global isearch variables by setting new values to
1181 `isearch-new-string', `isearch-new-message', `isearch-new-forward',
1182 `isearch-new-word', `isearch-new-case-fold'."
1183 ;; This code is very hairy for several reasons, explained in the code.
1184 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1185 ;; If there were a way to catch any change of buffer from the minibuffer,
1186 ;; this could be simplified greatly.
1187 ;; Editing doesn't back up the search point. Should it?
1188 `(condition-case nil
1189 (progn
1190 (let ((isearch-nonincremental isearch-nonincremental)
1192 ;; Locally bind all isearch global variables to protect them
1193 ;; from recursive isearching.
1194 ;; isearch-string -message and -forward are not bound
1195 ;; so they may be changed. Instead, save the values.
1196 (isearch-new-string isearch-string)
1197 (isearch-new-message isearch-message)
1198 (isearch-new-forward isearch-forward)
1199 (isearch-new-word isearch-word)
1200 (isearch-new-case-fold isearch-case-fold-search)
1202 (isearch-regexp isearch-regexp)
1203 (isearch-op-fun isearch-op-fun)
1204 (isearch-cmds isearch-cmds)
1205 (isearch-success isearch-success)
1206 (isearch-wrapped isearch-wrapped)
1207 (isearch-barrier isearch-barrier)
1208 (isearch-adjusted isearch-adjusted)
1209 (isearch-yank-flag isearch-yank-flag)
1210 (isearch-error isearch-error)
1211 ;;; Don't bind this. We want isearch-search, below, to set it.
1212 ;;; And the old value won't matter after that.
1213 ;;; (isearch-other-end isearch-other-end)
1214 ;;; Perhaps some of these other variables should be bound for a
1215 ;;; shorter period, ending before the next isearch-search.
1216 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1217 (isearch-opoint isearch-opoint)
1218 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1219 (isearch-small-window isearch-small-window)
1220 (isearch-recursive-edit isearch-recursive-edit)
1221 ;; Save current configuration so we can restore it here.
1222 (isearch-window-configuration (current-window-configuration))
1224 ;; This could protect the index of the search rings,
1225 ;; but we can't reliably count the number of typed M-p
1226 ;; in `read-from-minibuffer' to adjust the index accordingly.
1227 ;; So when the following is commented out, `isearch-mode'
1228 ;; below resets the index to the predictable value nil.
1229 ;; (search-ring-yank-pointer search-ring-yank-pointer)
1230 ;; (regexp-search-ring-yank-pointer regexp-search-ring-yank-pointer)
1232 ;; Temporarily restore `minibuffer-message-timeout'.
1233 (minibuffer-message-timeout
1234 isearch-original-minibuffer-message-timeout)
1235 (isearch-original-minibuffer-message-timeout
1236 isearch-original-minibuffer-message-timeout)
1237 old-point old-other-end)
1239 ;; Actually terminate isearching until editing is done.
1240 ;; This is so that the user can do anything without failure,
1241 ;; like switch buffers and start another isearch, and return.
1242 (condition-case nil
1243 (isearch-done t t)
1244 (exit nil)) ; was recursive editing
1246 ;; Save old point and isearch-other-end before reading from minibuffer
1247 ;; that can change their values.
1248 (setq old-point (point) old-other-end isearch-other-end)
1250 (unwind-protect
1251 (progn ,@body)
1253 ;; Set point at the start (end) of old match if forward (backward),
1254 ;; so after exiting minibuffer isearch resumes at the start (end)
1255 ;; of this match and can find it again.
1256 (if (and old-other-end (eq old-point (point))
1257 (eq isearch-forward isearch-new-forward))
1258 (goto-char old-other-end))
1260 ;; Always resume isearching by restarting it.
1261 (isearch-mode isearch-forward
1262 isearch-regexp
1263 isearch-op-fun
1264 nil
1265 isearch-word)
1267 ;; Copy new local values to isearch globals
1268 (setq isearch-string isearch-new-string
1269 isearch-message isearch-new-message
1270 isearch-forward isearch-new-forward
1271 isearch-word isearch-new-word
1272 isearch-case-fold-search isearch-new-case-fold))
1274 ;; Empty isearch-string means use default.
1275 (when (= 0 (length isearch-string))
1276 (setq isearch-string (or (car (if isearch-regexp
1277 regexp-search-ring
1278 search-ring))
1279 "")
1281 isearch-message
1282 (mapconcat 'isearch-text-char-description
1283 isearch-string ""))
1284 ;; After taking the last element, adjust ring to previous one.
1285 (isearch-ring-adjust1 nil)))
1287 ;; This used to push the state as of before this C-s, but it adds
1288 ;; an inconsistent state where part of variables are from the
1289 ;; previous search (e.g. `isearch-success'), and part of variables
1290 ;; are just entered from the minibuffer (e.g. `isearch-string').
1291 ;; (isearch-push-state)
1293 ;; Reinvoke the pending search.
1294 (isearch-search)
1295 (isearch-push-state) ; this pushes the correct state
1296 (isearch-update)
1297 (if isearch-nonincremental
1298 (progn
1299 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1300 (isearch-done)
1301 ;; The search done message is confusing when the string
1302 ;; is empty, so erase it.
1303 (if (equal isearch-string "")
1304 (message "")))))
1306 (quit ; handle abort-recursive-edit
1307 (isearch-abort) ;; outside of let to restore outside global values
1308 )))
1310 (defun isearch-edit-string ()
1311 "Edit the search string in the minibuffer.
1312 The following additional command keys are active while editing.
1318 (interactive)
1319 (with-isearch-suspended
1320 (let* ((message-log-max nil)
1321 ;; Don't add a new search string to the search ring here
1322 ;; in `read-from-minibuffer'. It should be added only
1323 ;; by `isearch-update-ring' called from `isearch-done'.
1324 (history-add-new-input nil)
1325 ;; Binding minibuffer-history-symbol to nil is a work-around
1326 ;; for some incompatibility with gmhist.
1327 (minibuffer-history-symbol))
1328 (setq isearch-new-string
1329 (read-from-minibuffer
1330 (isearch-message-prefix nil isearch-nonincremental)
1331 (cons isearch-string (1+ (or (isearch-fail-pos)
1332 (length isearch-string))))
1333 minibuffer-local-isearch-map nil
1334 (if isearch-regexp
1335 (cons 'regexp-search-ring
1336 (1+ (or regexp-search-ring-yank-pointer -1)))
1337 (cons 'search-ring
1338 (1+ (or search-ring-yank-pointer -1))))
1339 nil t)
1340 isearch-new-message
1341 (mapconcat 'isearch-text-char-description
1342 isearch-new-string "")))))
1344 (defun isearch-nonincremental-exit-minibuffer ()
1345 (interactive)
1346 (setq isearch-nonincremental t)
1347 (exit-minibuffer))
1348 ;; Changing the value of `isearch-nonincremental' has no effect here,
1349 ;; because `isearch-edit-string' ignores this change. Thus marked as obsolete.
1350 (make-obsolete 'isearch-nonincremental-exit-minibuffer 'exit-minibuffer "24.4")
1352 (defun isearch-forward-exit-minibuffer ()
1353 "Resume isearching forward from the minibuffer that edits the search string."
1354 (interactive)
1355 (setq isearch-new-forward t)
1356 (exit-minibuffer))
1358 (defun isearch-reverse-exit-minibuffer ()
1359 "Resume isearching backward from the minibuffer that edits the search string."
1360 (interactive)
1361 (setq isearch-new-forward nil)
1362 (exit-minibuffer))
1364 (defun isearch-cancel ()
1365 "Terminate the search and go back to the starting point."
1366 (interactive)
1367 (if (and isearch-push-state-function isearch-cmds)
1368 ;; For defined push-state function, restore the first state.
1369 ;; This calls pop-state function and restores original point.
1370 (let ((isearch-cmds (last isearch-cmds)))
1371 (isearch--set-state (car isearch-cmds)))
1372 (goto-char isearch-opoint))
1373 (isearch-done t) ; Exit isearch..
1374 (isearch-clean-overlays)
1375 (signal 'quit nil)) ; ..and pass on quit signal.
1377 (defun isearch-abort ()
1378 "Abort incremental search mode if searching is successful, signaling quit.
1379 Otherwise, revert to previous successful search and continue searching.
1380 Use `isearch-exit' to quit without signaling."
1381 (interactive)
1382 ;; (ding) signal instead below, if quitting
1383 (discard-input)
1384 (if (and isearch-success (not isearch-error))
1385 ;; If search is successful and has no incomplete regexp,
1386 ;; move back to starting point and really do quit.
1387 (progn
1388 (setq isearch-success nil)
1389 (isearch-cancel))
1390 ;; If search is failing, or has an incomplete regexp,
1391 ;; rub out until it is once more successful.
1392 (while (or (not isearch-success) isearch-error)
1393 (isearch-pop-state))
1394 (isearch-update)))
1396 (defun isearch-repeat (direction)
1397 ;; Utility for isearch-repeat-forward and -backward.
1398 (if (eq isearch-forward (eq direction 'forward))
1399 ;; C-s in forward or C-r in reverse.
1400 (if (equal isearch-string "")
1401 ;; If search string is empty, use last one.
1402 (if (null (if isearch-regexp regexp-search-ring search-ring))
1403 (setq isearch-error "No previous search string")
1404 (setq isearch-string
1405 (car (if isearch-regexp regexp-search-ring search-ring))
1406 isearch-message
1407 (mapconcat 'isearch-text-char-description
1408 isearch-string "")
1409 isearch-case-fold-search isearch-last-case-fold-search)
1410 ;; After taking the last element, adjust ring to previous one.
1411 (isearch-ring-adjust1 nil))
1412 ;; If already have what to search for, repeat it.
1413 (or isearch-success
1414 (progn
1415 ;; Set isearch-wrapped before calling isearch-wrap-function
1416 (setq isearch-wrapped t)
1417 (if isearch-wrap-function
1418 (funcall isearch-wrap-function)
1419 (goto-char (if isearch-forward (point-min) (point-max)))))))
1420 ;; C-s in reverse or C-r in forward, change direction.
1421 (setq isearch-forward (not isearch-forward)
1422 isearch-success t))
1424 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1426 (if (equal isearch-string "")
1427 (setq isearch-success t)
1428 (if (and isearch-success
1429 (equal (point) isearch-other-end)
1430 (not isearch-just-started))
1431 ;; If repeating a search that found
1432 ;; an empty string, ensure we advance.
1433 (if (if isearch-forward (eobp) (bobp))
1434 ;; If there's nowhere to advance to, fail (and wrap next time).
1435 (progn
1436 (setq isearch-success nil)
1437 (ding))
1438 (forward-char (if isearch-forward 1 -1))
1439 (isearch-search))
1440 (isearch-search)))
1442 (isearch-push-state)
1443 (isearch-update))
1445 (defun isearch-repeat-forward ()
1446 "Repeat incremental search forwards."
1447 (interactive)
1448 (isearch-repeat 'forward))
1450 (defun isearch-repeat-backward ()
1451 "Repeat incremental search backwards."
1452 (interactive)
1453 (isearch-repeat 'backward))
1455 (defun isearch-toggle-regexp ()
1456 "Toggle regexp searching on or off."
1457 ;; The status stack is left unchanged.
1458 (interactive)
1459 (setq isearch-regexp (not isearch-regexp))
1460 (if isearch-regexp (setq isearch-word nil))
1461 (setq isearch-success t isearch-adjusted t)
1462 (isearch-update))
1464 (defun isearch-toggle-word ()
1465 "Toggle word searching on or off."
1466 ;; The status stack is left unchanged.
1467 (interactive)
1468 (setq isearch-word (not isearch-word))
1469 (if isearch-word (setq isearch-regexp nil))
1470 (setq isearch-success t isearch-adjusted t)
1471 (isearch-update))
1473 (defun isearch-toggle-symbol ()
1474 "Toggle symbol searching on or off."
1475 (interactive)
1476 (setq isearch-word (unless (eq isearch-word 'isearch-symbol-regexp)
1477 'isearch-symbol-regexp))
1478 (if isearch-word (setq isearch-regexp nil))
1479 (setq isearch-success t isearch-adjusted t)
1480 (isearch-update))
1482 (defun isearch-toggle-lax-whitespace ()
1483 "Toggle whitespace matching in searching on or off.
1484 In ordinary search, toggles the value of the variable
1485 `isearch-lax-whitespace'. In regexp search, toggles the
1486 value of the variable `isearch-regexp-lax-whitespace'."
1487 (interactive)
1488 (if isearch-regexp
1489 (setq isearch-regexp-lax-whitespace (not isearch-regexp-lax-whitespace))
1490 (setq isearch-lax-whitespace (not isearch-lax-whitespace)))
1491 (let ((message-log-max nil))
1492 (message "%s%s [%s]"
1493 (isearch-message-prefix nil isearch-nonincremental)
1494 isearch-message
1495 (if (if isearch-regexp
1496 isearch-regexp-lax-whitespace
1497 isearch-lax-whitespace)
1498 "match spaces loosely"
1499 "match spaces literally")))
1500 (setq isearch-success t isearch-adjusted t)
1501 (sit-for 1)
1502 (isearch-update))
1504 (defun isearch-toggle-case-fold ()
1505 "Toggle case folding in searching on or off.
1506 Toggles the value of the variable `isearch-case-fold-search'."
1507 (interactive)
1508 (setq isearch-case-fold-search
1509 (if isearch-case-fold-search nil 'yes))
1510 (let ((message-log-max nil))
1511 (message "%s%s [case %ssensitive]"
1512 (isearch-message-prefix nil isearch-nonincremental)
1513 isearch-message
1514 (if isearch-case-fold-search "in" "")))
1515 (setq isearch-success t isearch-adjusted t)
1516 (sit-for 1)
1517 (isearch-update))
1519 (defun isearch-toggle-invisible ()
1520 "Toggle searching in invisible text on or off.
1521 Toggles the variable `isearch-invisible' between values
1522 nil and a non-nil value of the option `search-invisible'
1523 \(or `open' if `search-invisible' is nil)."
1524 (interactive)
1525 (setq isearch-invisible
1526 (if isearch-invisible nil (or search-invisible 'open)))
1527 (let ((message-log-max nil))
1528 (message "%s%s [match %svisible text]"
1529 (isearch-message-prefix nil isearch-nonincremental)
1530 isearch-message
1531 (if isearch-invisible "in" "")))
1532 (setq isearch-success t isearch-adjusted t)
1533 (sit-for 1)
1534 (isearch-update))
1536 \f
1537 ;; Word search
1539 (defun word-search-regexp (string &optional lax)
1540 "Return a regexp which matches words, ignoring punctuation.
1541 Given STRING, a string of words separated by word delimiters,
1542 compute a regexp that matches those exact words separated by
1543 arbitrary punctuation. If the string begins or ends in whitespace,
1544 the beginning or the end of the string matches arbitrary whitespace.
1545 Otherwise if LAX is non-nil, the beginning or the end of the string
1546 need not match a word boundary.
1548 Used in `word-search-forward', `word-search-backward',
1549 `word-search-forward-lax', `word-search-backward-lax'."
1550 (cond
1551 ((equal string "") "")
1553 (t (concat
1560 (defun word-search-backward (string &optional bound noerror count)
1561 "Search backward from point for STRING, ignoring differences in punctuation.
1562 Set point to the beginning of the occurrence found, and return point.
1563 An optional second argument bounds the search; it is a buffer position.
1564 The match found must not extend before that position.
1565 Optional third argument, if t, means if fail just return nil (no error).
1566 If not nil and not t, move to limit of search and return nil.
1567 Optional fourth argument is repeat count--search for successive occurrences.
1569 Relies on the function `word-search-regexp' to convert a sequence
1570 of words in STRING to a regexp used to search words without regard
1571 to punctuation."
1572 (interactive "sWord search backward: ")
1573 (re-search-backward (word-search-regexp string nil) bound noerror count))
1575 (defun word-search-forward (string &optional bound noerror count)
1576 "Search forward from point for STRING, ignoring differences in punctuation.
1577 Set point to the end of the occurrence found, and return point.
1578 An optional second argument bounds the search; it is a buffer position.
1579 The match found must not extend after that position.
1580 Optional third argument, if t, means if fail just return nil (no error).
1581 If not nil and not t, move to limit of search and return nil.
1582 Optional fourth argument is repeat count--search for successive occurrences.
1584 Relies on the function `word-search-regexp' to convert a sequence
1585 of words in STRING to a regexp used to search words without regard
1586 to punctuation."
1587 (interactive "sWord search: ")
1588 (re-search-forward (word-search-regexp string nil) bound noerror count))
1590 (defun word-search-backward-lax (string &optional bound noerror count)
1591 "Search backward from point for STRING, ignoring differences in punctuation.
1592 Set point to the beginning of the occurrence found, and return point.
1594 Unlike `word-search-backward', the end of STRING need not match a word
1595 boundary, unless STRING ends in whitespace.
1597 An optional second argument bounds the search; it is a buffer position.
1598 The match found must not extend before that position.
1599 Optional third argument, if t, means if fail just return nil (no error).
1600 If not nil and not t, move to limit of search and return nil.
1601 Optional fourth argument is repeat count--search for successive occurrences.
1603 Relies on the function `word-search-regexp' to convert a sequence
1604 of words in STRING to a regexp used to search words without regard
1605 to punctuation."
1606 (interactive "sWord search backward: ")
1607 (re-search-backward (word-search-regexp string t) bound noerror count))
1609 (defun word-search-forward-lax (string &optional bound noerror count)
1610 "Search forward from point for STRING, ignoring differences in punctuation.
1611 Set point to the end of the occurrence found, and return point.
1613 Unlike `word-search-forward', the end of STRING need not match a word
1614 boundary, unless STRING ends in whitespace.
1616 An optional second argument bounds the search; it is a buffer position.
1617 The match found must not extend after that position.
1618 Optional third argument, if t, means if fail just return nil (no error).
1619 If not nil and not t, move to limit of search and return nil.
1620 Optional fourth argument is repeat count--search for successive occurrences.
1622 Relies on the function `word-search-regexp' to convert a sequence
1623 of words in STRING to a regexp used to search words without regard
1624 to punctuation."
1625 (interactive "sWord search: ")
1626 (re-search-forward (word-search-regexp string t) bound noerror count))
1628 ;; Symbol search
1630 (defun isearch-symbol-regexp (string &optional lax)
1631 "Return a regexp which matches STRING as a symbol.
1633 If there are more than one symbol, then compute a regexp that matches
1634 those exact symbols separated by non-symbol characters. If the string
1635 begins or ends in whitespace, the beginning or the end of the string
1636 matches arbitrary non-symbol whitespace. Otherwise if LAX is non-nil,
1637 the beginning or the end of the string need not match a symbol boundary."
1638 (let ((not-word-symbol-re
1639 ;; This regexp matches all syntaxes except word and symbol syntax.
1640 ;; FIXME: Replace it with something shorter if possible (bug#14602).
1641 "\\(?:\\s-\\|\\s.\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s/\\|\\s$\\|\\s'\\|\\s<\\|\\s>\\|\\s@\\|\\s!\\|\\s|\\)+"))
1642 (cond
1643 ((equal string "") "")
1645 (t (concat
1648 (mapconcat 'regexp-quote (split-string string not-word-symbol-re t) not-word-symbol-re)
1652 (put 'isearch-symbol-regexp 'isearch-message-prefix "symbol ")
1654 ;; Search with lax whitespace
1656 (defun search-forward-lax-whitespace (string &optional bound noerror count)
1657 "Search forward for STRING, matching a sequence of whitespace chars."
1658 (let ((search-spaces-regexp search-whitespace-regexp))
1659 (re-search-forward (regexp-quote string) bound noerror count)))
1661 (defun search-backward-lax-whitespace (string &optional bound noerror count)
1662 "Search backward for STRING, matching a sequence of whitespace chars."
1663 (let ((search-spaces-regexp search-whitespace-regexp))
1664 (re-search-backward (regexp-quote string) bound noerror count)))
1666 (defun re-search-forward-lax-whitespace (regexp &optional bound noerror count)
1667 "Search forward for REGEXP, matching a sequence of whitespace chars."
1668 (let ((search-spaces-regexp search-whitespace-regexp))
1669 (re-search-forward regexp bound noerror count)))
1671 (defun re-search-backward-lax-whitespace (regexp &optional bound noerror count)
1672 "Search backward for REGEXP, matching a sequence of whitespace chars."
1673 (let ((search-spaces-regexp search-whitespace-regexp))
1674 (re-search-backward regexp bound noerror count)))
1676 \f
1677 (defun isearch-query-replace (&optional delimited regexp-flag)
1678 "Start `query-replace' with string to replace from last search string.
1679 The arg DELIMITED (prefix arg if interactive), if non-nil, means replace
1680 only matches surrounded by word boundaries. Note that using the prefix arg
1681 is possible only when `isearch-allow-scroll' is non-nil or
1682 `isearch-allow-prefix' is non-nil, and it doesn't always provide the
1683 correct matches for `query-replace', so the preferred way to run word
1684 replacements from Isearch is `M-s w ... M-%'."
1685 (interactive
1686 (list current-prefix-arg))
1687 (barf-if-buffer-read-only)
1688 (if regexp-flag (setq isearch-regexp t))
1689 (let ((case-fold-search isearch-case-fold-search)
1690 ;; set `search-upper-case' to nil to not call
1691 ;; `isearch-no-upper-case-p' in `perform-replace'
1692 (search-upper-case nil)
1693 (search-invisible isearch-invisible)
1694 (replace-lax-whitespace
1695 isearch-lax-whitespace)
1696 (replace-regexp-lax-whitespace
1697 isearch-regexp-lax-whitespace)
1698 ;; Set `isearch-recursive-edit' to nil to prevent calling
1699 ;; `exit-recursive-edit' in `isearch-done' that terminates
1700 ;; the execution of this command when it is non-nil.
1701 ;; We call `exit-recursive-edit' explicitly at the end below.
1702 (isearch-recursive-edit nil))
1703 (isearch-done nil t)
1704 (isearch-clean-overlays)
1705 (if (and isearch-other-end
1706 (< isearch-other-end (point))
1707 (not (and transient-mark-mode mark-active
1708 (< (mark) (point)))))
1709 (goto-char isearch-other-end))
1710 (set query-replace-from-history-variable
1711 (cons isearch-string
1712 (symbol-value query-replace-from-history-variable)))
1713 (perform-replace
1714 isearch-string
1715 (query-replace-read-to
1716 isearch-string
1717 (concat "Query replace"
1718 (if (or delimited isearch-word)
1719 (let* ((symbol (or delimited isearch-word))
1720 (string (and symbol (symbolp symbol)
1721 (get symbol 'isearch-message-prefix))))
1722 (if (stringp string)
1723 ;; Move space from the end to the beginning.
1725 " word"))
1726 "")
1727 (if isearch-regexp " regexp" "")
1728 (if (and transient-mark-mode mark-active) " in region" ""))
1729 isearch-regexp)
1730 t isearch-regexp (or delimited isearch-word) nil nil
1731 (if (and transient-mark-mode mark-active) (region-beginning))
1732 (if (and transient-mark-mode mark-active) (region-end))))
1733 (and isearch-recursive-edit (exit-recursive-edit)))
1735 (defun isearch-query-replace-regexp (&optional delimited)
1736 "Start `query-replace-regexp' with string to replace from last search string.
1737 See `isearch-query-replace' for more information."
1738 (interactive
1739 (list current-prefix-arg))
1740 (isearch-query-replace delimited t))
1742 (defun isearch-occur (regexp &optional nlines)
1743 "Run `occur' using the last search string as the regexp.
1744 Interactively, REGEXP is constructed using the search string from the
1745 last search command. NLINES has the same meaning as in `occur'.
1747 If the last search command was a word search, REGEXP is computed from
1748 the search words, ignoring punctuation. If the last search
1749 command was a regular expression search, REGEXP is the regular
1750 expression used in that search. If the last search command searched
1751 for a literal string, REGEXP is constructed by quoting all the special
1752 characters in that string."
1753 (interactive
1754 (let* ((perform-collect (consp current-prefix-arg))
1755 (regexp (cond
1756 ((functionp isearch-word)
1757 (funcall isearch-word isearch-string))
1758 (isearch-word (word-search-regexp isearch-string))
1759 (isearch-regexp isearch-string)
1760 (t (regexp-quote isearch-string)))))
1761 (list regexp
1762 (if perform-collect
1763 ;; Perform collect operation
1764 (if (zerop (regexp-opt-depth regexp))
1765 ;; No subexpression so collect the entire match.
1767 ;; Get the regexp for collection pattern.
1768 (let ((default (car occur-collect-regexp-history))
1769 regexp-collect)
1770 (with-isearch-suspended
1771 (setq regexp-collect
1772 (read-regexp
1773 (format "Regexp to collect (default %s): " default)
1774 default 'occur-collect-regexp-history)))
1775 regexp-collect))
1776 ;; Otherwise normal occur takes numerical prefix argument.
1777 (when current-prefix-arg
1778 (prefix-numeric-value current-prefix-arg))))))
1779 (let ((case-fold-search isearch-case-fold-search)
1780 ;; Set `search-upper-case' to nil to not call
1781 ;; `isearch-no-upper-case-p' in `occur-1'.
1782 (search-upper-case nil)
1783 (search-spaces-regexp
1784 (if (if isearch-regexp
1785 isearch-regexp-lax-whitespace
1786 isearch-lax-whitespace)
1787 search-whitespace-regexp)))
1788 (occur regexp nlines)))
1790 (declare-function hi-lock-read-face-name "hi-lock" ())
1792 (defun isearch-highlight-regexp ()
1793 "Run `highlight-regexp' with regexp from the current search string.
1794 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1795 argument from the last search regexp or a quoted search string,
1796 and reads its face argument using `hi-lock-read-face-name'."
1797 (interactive)
1798 (let (
1799 ;; Set `isearch-recursive-edit' to nil to prevent calling
1800 ;; `exit-recursive-edit' in `isearch-done' that terminates
1801 ;; the execution of this command when it is non-nil.
1802 ;; We call `exit-recursive-edit' explicitly at the end below.
1803 (isearch-recursive-edit nil))
1804 (isearch-done nil t)
1805 (isearch-clean-overlays))
1806 (require 'hi-lock nil t)
1807 (let ((regexp (cond ((functionp isearch-word)
1808 (funcall isearch-word isearch-string))
1809 (isearch-word (word-search-regexp isearch-string))
1810 (isearch-regexp isearch-string)
1811 ((if (and (eq isearch-case-fold-search t)
1812 search-upper-case)
1813 (isearch-no-upper-case-p
1814 isearch-string isearch-regexp)
1815 isearch-case-fold-search)
1816 ;; Turn isearch-string into a case-insensitive
1817 ;; regexp.
1818 (mapconcat
1819 (lambda (c)
1820 (let ((s (string c)))
1821 (if (string-match "[[:alpha:]]" s)
1822 (format "[%s%s]" (upcase s) (downcase s))
1823 (regexp-quote s))))
1824 isearch-string ""))
1825 (t (regexp-quote isearch-string)))))
1826 (hi-lock-face-buffer regexp (hi-lock-read-face-name)))
1827 (and isearch-recursive-edit (exit-recursive-edit)))
1829 \f
1830 (defun isearch-delete-char ()
1831 "Discard last input item and move point back.
1832 Last input means the last character or the last isearch command
1833 that added or deleted characters from the search string,
1834 moved point, toggled regexp mode or case-sensitivity, etc.
1835 If no previous match was done, just beep."
1836 (interactive)
1837 (if (null (cdr isearch-cmds))
1838 (ding)
1839 (isearch-pop-state))
1840 (isearch-update))
1842 (defun isearch-del-char (&optional arg)
1843 "Delete character from end of search string and search again.
1844 Unlike `isearch-delete-char', it only deletes the last character,
1845 but doesn't cancel the effect of other isearch command.
1846 If search string is empty, just beep."
1847 (interactive "p")
1848 (if (= 0 (length isearch-string))
1849 (ding)
1850 (setq isearch-string (substring isearch-string 0
1851 (- (min (or arg 1)
1852 (length isearch-string))))
1853 isearch-message (mapconcat 'isearch-text-char-description
1854 isearch-string "")))
1855 ;; Use the isearch-other-end as new starting point to be able
1856 ;; to find the remaining part of the search string again.
1857 ;; This is like what `isearch-search-and-update' does,
1858 ;; but currently it doesn't support deletion of characters
1859 ;; for the case where unsuccessful search may become successful
1860 ;; by deletion of characters.
1861 (if isearch-other-end (goto-char isearch-other-end))
1862 (isearch-search)
1863 (isearch-push-state)
1864 (isearch-update))
1866 (defun isearch-yank-string (string)
1867 "Pull STRING into search string."
1868 ;; Downcase the string if not supposed to case-fold yanked strings.
1869 (if (and isearch-case-fold-search
1870 (eq 'not-yanks search-upper-case))
1871 (setq string (downcase string)))
1872 (if isearch-regexp (setq string (regexp-quote string)))
1873 ;; Don't move cursor in reverse search.
1874 (setq isearch-yank-flag t)
1875 (isearch-process-search-string
1876 string (mapconcat 'isearch-text-char-description string "")))
1878 (defun isearch-yank-kill ()
1879 "Pull string from kill ring into search string."
1880 (interactive)
1881 (isearch-yank-string (current-kill 0)))
1883 (defun isearch-yank-pop ()
1884 "Replace just-yanked search string with previously killed string."
1885 (interactive)
1886 (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop)))
1887 ;; Fall back on `isearch-yank-kill' for the benefits of people
1888 ;; who are used to the old behavior of `M-y' in isearch mode. In
1889 ;; future, this fallback may be changed if we ever change
1890 ;; `yank-pop' to do something like the kill-ring-browser.
1891 (isearch-yank-kill)
1892 (isearch-pop-state)
1893 (isearch-yank-string (current-kill 1))))
1895 (defun isearch-yank-x-selection ()
1896 "Pull current X selection into search string."
1897 (interactive)
1898 (isearch-yank-string (x-get-selection))
1899 ;; If `x-get-selection' returned the text from the active region,
1900 ;; then it "used" the mark which we should hence deactivate.
1901 (when select-active-regions (deactivate-mark)))
1904 (defun isearch-mouse-2 (click)
1905 "Handle mouse-2 in Isearch mode.
1906 For a click in the echo area, invoke `isearch-yank-x-selection'.
1907 Otherwise invoke whatever the calling mouse-2 command sequence
1908 is bound to outside of Isearch."
1909 (interactive "e")
1910 (let* ((w (posn-window (event-start click)))
1911 (overriding-terminal-local-map nil)
1912 (binding (key-binding (this-command-keys-vector) t)))
1913 (if (and (window-minibuffer-p w)
1914 (not (minibuffer-window-active-p w))) ; in echo area
1915 (isearch-yank-x-selection)
1916 (when (functionp binding)
1917 (call-interactively binding)))))
1919 (defun isearch-yank-internal (jumpform)
1920 "Pull the text from point to the point reached by JUMPFORM.
1921 JUMPFORM is a lambda expression that takes no arguments and returns
1922 a buffer position, possibly having moved point to that position.
1923 For example, it might move point forward by a word and return point,
1924 or it might return the position of the end of the line."
1925 (isearch-yank-string
1926 (save-excursion
1927 (and (not isearch-forward) isearch-other-end
1928 (goto-char isearch-other-end))
1929 (buffer-substring-no-properties (point) (funcall jumpform)))))
1931 (defun isearch-yank-char-in-minibuffer (&optional arg)
1932 "Pull next character from buffer into end of search string in minibuffer."
1933 (interactive "p")
1934 (if (eobp)
1935 (insert
1936 (with-current-buffer (cadr (buffer-list))
1937 (buffer-substring-no-properties
1938 (point) (progn (forward-char arg) (point)))))
1939 (forward-char arg)))
1941 (defun isearch-yank-char (&optional arg)
1942 "Pull next character from buffer into search string."
1943 (interactive "p")
1944 (isearch-yank-internal (lambda () (forward-char arg) (point))))
1946 (declare-function subword-forward "subword" (&optional arg))
1947 (defun isearch-yank-word-or-char ()
1948 "Pull next character, subword or word from buffer into search string.
1949 Subword is used when `subword-mode' is activated. "
1950 (interactive)
1951 (isearch-yank-internal
1952 (lambda ()
1953 (if (or (= (char-syntax (or (char-after) 0)) ?w)
1954 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
1955 (if (and (boundp 'subword-mode) subword-mode)
1956 (subword-forward 1)
1957 (forward-word 1))
1958 (forward-char 1)) (point))))
1960 (defun isearch-yank-word (&optional arg)
1961 "Pull next word from buffer into search string."
1962 (interactive "p")
1963 (isearch-yank-internal (lambda () (forward-word arg) (point))))
1965 (defun isearch-yank-line (&optional arg)
1966 "Pull rest of line from buffer into search string."
1967 (interactive "p")
1968 (isearch-yank-internal
1969 (lambda () (let ((inhibit-field-text-motion t))
1970 (line-end-position (if (eolp) (1+ arg) arg))))))
1972 (defun isearch-char-by-name (&optional count)
1973 "Read a character by its Unicode name and add it to the search string.
1974 Completion is available like in `read-char-by-name' used by `insert-char'.
1975 With argument, add COUNT copies of the character."
1976 (interactive "p")
1977 (with-isearch-suspended
1978 (let ((char (read-char-by-name "Add character to search (Unicode name or hex): ")))
1979 (when char
1980 (let ((string (if (and (integerp count) (> count 1))
1981 (make-string count char)
1982 (char-to-string char))))
1983 (setq isearch-new-string (concat isearch-string string)
1984 isearch-new-message (concat isearch-message
1985 (mapconcat 'isearch-text-char-description
1986 string ""))))))))
1988 (defun isearch-search-and-update ()
1989 ;; Do the search and update the display.
1990 (when (or isearch-success
1991 ;; Unsuccessful regexp search may become successful by
1992 ;; addition of characters which make isearch-string valid
1993 isearch-regexp
1994 ;; If the string was found but was completely invisible,
1995 ;; it might now be partly visible, so try again.
1996 (prog1 isearch-hidden (setq isearch-hidden nil)))
1997 ;; In reverse search, adding stuff at
1998 ;; the end may cause zero or many more chars to be
1999 ;; matched, in the string following point.
2000 ;; Allow all those possibilities without moving point as
2001 ;; long as the match does not extend past search origin.
2002 (if (and (not isearch-forward) (not isearch-adjusted)
2003 (condition-case ()
2004 (let ((case-fold-search isearch-case-fold-search))
2005 (if (and (eq case-fold-search t) search-upper-case)
2006 (setq case-fold-search
2007 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2008 (looking-at (cond
2009 ((functionp isearch-word)
2010 (funcall isearch-word isearch-string t))
2011 (isearch-word (word-search-regexp isearch-string t))
2012 (isearch-regexp isearch-string)
2013 (t (regexp-quote isearch-string)))))
2014 (error nil))
2015 (or isearch-yank-flag
2016 (<= (match-end 0)
2017 (min isearch-opoint isearch-barrier))))
2018 (progn
2019 (setq isearch-success t
2020 isearch-error nil
2021 isearch-other-end (match-end 0))
2022 (if (and (eq isearch-case-fold-search t) search-upper-case)
2023 (setq isearch-case-fold-search
2024 (isearch-no-upper-case-p isearch-string isearch-regexp))))
2025 ;; Not regexp, not reverse, or no match at point.
2026 (if (and isearch-other-end (not isearch-adjusted))
2027 (goto-char (if isearch-forward isearch-other-end
2028 (min isearch-opoint
2029 isearch-barrier
2030 (1+ isearch-other-end)))))
2031 (isearch-search)
2032 ))
2033 (isearch-push-state)
2034 (if isearch-op-fun (funcall isearch-op-fun))
2035 (isearch-update))
2038 ;; *, ?, }, and | chars can make a regexp more liberal.
2039 ;; They can make a regexp match sooner or make it succeed instead of failing.
2040 ;; So go back to place last successful search started
2041 ;; or to the last ^S/^R (barrier), whichever is nearer.
2042 ;; + needs no special handling because the string must match at least once.
2044 (defun isearch-backslash (str)
2045 "Return t if STR ends in an odd number of backslashes."
2048 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
2049 "Return point to previous successful match to allow regexp liberalization.
2052 stopping at `isearch-barrier' as needed.
2054 Do nothing if a backslash is escaping the liberalizing character.
2057 Do nothing if regexp has recently been invalid unless optional
2058 ALLOW-INVALID non-nil.
2060 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
2061 to the barrier."
2062 ;; (eq (not a) (not b)) makes all non-nil values equivalent
2063 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
2064 (not want-backslash))
2065 ;; We have to check 2 stack frames because the last might be
2066 ;; invalid just because of a backslash.
2067 (or (not isearch-error)
2068 (not (isearch--state-error (cadr isearch-cmds)))
2069 allow-invalid))
2070 (if to-barrier
2071 (progn (goto-char isearch-barrier)
2072 (setq isearch-adjusted t))
2073 (let* ((stack isearch-cmds)
2074 (previous (cdr stack)) ; lookbelow in the stack
2075 (frame (car stack)))
2076 ;; Walk down the stack looking for a valid regexp (as of course only
2077 ;; they can be the previous successful match); this conveniently
2078 ;; removes all bracket-sets and groups that might be in the way, as
2079 ;; well as partial \{\} constructs that the code below leaves behind.
2080 ;; Also skip over postfix operators -- though horrid,
2081 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
2082 (while (and previous
2083 (or (isearch--state-error frame)
2084 (let* ((string (isearch--state-string frame))
2085 (lchar (aref string (1- (length string)))))
2086 ;; The operators aren't always operators; check
2087 ;; backslashes. This doesn't handle the case of
2088 ;; operators at the beginning of the regexp not
2089 ;; being special, but then we should fall back to
2090 ;; the barrier anyway because it's all optional.
2091 (if (isearch-backslash
2092 (isearch--state-string (car previous)))
2093 (eq lchar ?\})
2094 (memq lchar '(?* ?? ?+))))))
2095 (setq stack previous previous (cdr previous) frame (car stack)))
2096 (when stack
2097 ;; `stack' now refers the most recent valid regexp that is not at
2098 ;; all optional in its last term. Now dig one level deeper and find
2099 ;; what matched before that.
2100 (let ((last-other-end
2101 (or (and (car previous)
2102 (isearch--state-other-end (car previous)))
2103 isearch-barrier)))
2104 (goto-char (if isearch-forward
2105 (max last-other-end isearch-barrier)
2106 (min last-other-end isearch-barrier)))
2107 (setq isearch-adjusted t)))))))
2109 (defun isearch-unread-key-sequence (keylist)
2110 "Unread the given key-sequence KEYLIST.
2111 Scroll-bar or mode-line events are processed appropriately."
2112 (cancel-kbd-macro-events)
2113 (apply 'isearch-unread keylist)
2114 ;; If the event was a scroll-bar or mode-line click, the event will have
2115 ;; been prefixed by a symbol such as vertical-scroll-bar. We must remove
2116 ;; it here, because this symbol will be attached to the event again next
2117 ;; time it gets read by read-key-sequence.
2118 ;;
2119 ;; (Old comment from isearch-other-meta-char: "Note that we don't have to
2120 ;; modify the event anymore in 21 because read_key_sequence no longer
2121 ;; modifies events to produce fake prefix keys.")
2122 (if (and (> (length keylist) 1)
2123 (symbolp (car keylist))
2124 (listp (cadr keylist))
2125 (not (numberp (posn-point
2126 (event-start (cadr keylist) )))))
2127 (pop unread-command-events)))
2129 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2130 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
2131 ;;
2132 ;; The idea here is that certain vertical scrolling commands (like C-l
2133 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
2134 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
2135 ;; tamper with isearch's state, or move point. It is unacceptable for the
2136 ;; search string to be scrolled out of the current window. If a command
2137 ;; attempts this, we scroll the text back again.
2138 ;;
2139 ;; We implement this feature with a property called `isearch-scroll'.
2140 ;; If a command's symbol has the value t for this property or for the
2141 ;; `scroll-command' property, it is a scrolling command. The feature
2142 ;; needs to be enabled by setting the customizable variable
2143 ;; `isearch-allow-scroll' to a non-nil value.
2144 ;;
2145 ;; The universal argument commands (e.g. C-u) in simple.el are marked
2146 ;; as scrolling commands, and isearch.el has been amended to allow
2147 ;; prefix arguments to be passed through to scrolling commands. Thus
2148 ;; M-0 C-l will scroll point to the top of the window.
2149 ;;
2150 ;; Horizontal scrolling commands are currently not catered for.
2151 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2153 ;; Set the isearch-scroll property on some standard functions:
2154 ;; Scroll-bar functions:
2155 (if (fboundp 'scroll-bar-toolkit-scroll)
2156 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
2157 (if (fboundp 'w32-handle-scroll-bar-event)
2158 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
2160 ;; Commands which scroll the window (some scroll commands
2161 ;; already have the `scroll-command' property on them):
2162 (put 'recenter 'isearch-scroll t)
2163 (put 'recenter-top-bottom 'isearch-scroll t)
2164 (put 'reposition-window 'isearch-scroll t)
2166 ;; Commands which act on the other window
2167 (put 'list-buffers 'isearch-scroll t)
2168 (put 'scroll-other-window 'isearch-scroll t)
2169 (put 'scroll-other-window-down 'isearch-scroll t)
2170 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
2171 (put 'end-of-buffer-other-window 'isearch-scroll t)
2173 ;; Commands which change the window layout
2174 (put 'delete-other-windows 'isearch-scroll t)
2175 (put 'balance-windows 'isearch-scroll t)
2176 (put 'split-window-right 'isearch-scroll t)
2177 (put 'split-window-below 'isearch-scroll t)
2178 (put 'enlarge-window 'isearch-scroll t)
2180 ;; Aliases for split-window-*
2181 (put 'split-window-vertically 'isearch-scroll t)
2182 (put 'split-window-horizontally 'isearch-scroll t)
2184 ;; Universal argument commands
2185 (put 'universal-argument 'isearch-scroll t)
2186 (put 'negative-argument 'isearch-scroll t)
2187 (put 'digit-argument 'isearch-scroll t)
2189 (defcustom isearch-allow-scroll nil
2190 "Whether scrolling is allowed during incremental search.
2191 If non-nil, scrolling commands can be used in Isearch mode.
2192 However, the current match will never scroll offscreen.
2193 If nil, scrolling commands will first cancel Isearch mode."
2194 :type 'boolean
2195 :group 'isearch)
2197 (defcustom isearch-allow-prefix t
2198 "Whether prefix arguments are allowed during incremental search.
2199 If non-nil, entering a prefix argument will not terminate the
2200 search. This option is ignored \(presumed t) when
2201 `isearch-allow-scroll' is set."
2202 :version "24.4"
2203 :type 'boolean
2204 :group 'isearch)
2206 (defun isearch-string-out-of-window (isearch-point)
2207 "Test whether the search string is currently outside of the window.
2208 Return nil if it's completely visible, or if point is visible,
2209 together with as much of the search string as will fit; the symbol
2210 `above' if we need to scroll the text downwards; the symbol `below',
2211 if upwards."
2212 (let ((w-start (window-start))
2213 (w-end (window-end nil t))
2214 (w-L1 (save-excursion (move-to-window-line 1) (point)))
2215 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
2216 start end) ; start and end of search string in buffer
2217 (if isearch-forward
2218 (setq end isearch-point start (or isearch-other-end isearch-point))
2219 (setq start isearch-point end (or isearch-other-end isearch-point)))
2220 (cond ((or (and (>= start w-start) (<= end w-end))
2221 (if isearch-forward
2222 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
2223 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
2224 nil)
2225 ((and (< start w-start)
2226 (< isearch-point w-L-1))
2227 'above)
2228 (t 'below))))
2230 (defun isearch-back-into-window (above isearch-point)
2231 "Scroll the window to bring the search string back into view.
2232 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
2233 search string is above the top of the window, nil when it is beneath
2234 the bottom."
2235 (let (start end)
2236 (if isearch-forward
2237 (setq end isearch-point start (or isearch-other-end isearch-point))
2238 (setq start isearch-point end (or isearch-other-end isearch-point)))
2239 (if above
2240 (progn
2241 (goto-char start)
2242 (recenter 0)
2243 (when (>= isearch-point (window-end nil t))
2244 (goto-char isearch-point)
2245 (recenter -1)))
2246 (goto-char end)
2247 (recenter -1)
2248 (when (< isearch-point (window-start))
2249 (goto-char isearch-point)
2250 (recenter 0))))
2251 (goto-char isearch-point))
2253 (defun isearch-reread-key-sequence-naturally (keylist)
2254 "Reread key sequence KEYLIST with an inactive Isearch-mode keymap.
2255 Return the key sequence as a string/vector."
2256 (isearch-unread-key-sequence keylist)
2257 (let (overriding-terminal-local-map)
2258 (read-key-sequence nil))) ; This will go through function-key-map, if nec.
2260 (defun isearch-lookup-scroll-key (key-seq)
2261 "If KEY-SEQ is bound to a scrolling command, return it as a symbol.
2262 Otherwise return nil."
2263 (let* ((overriding-terminal-local-map nil)
2264 (binding (key-binding key-seq)))
2265 (and binding (symbolp binding) (commandp binding)
2266 (or (eq (get binding 'isearch-scroll) t)
2267 (eq (get binding 'scroll-command) t))
2268 binding)))
2270 (defalias 'isearch-other-control-char 'isearch-other-meta-char)
2272 (defun isearch-other-meta-char (&optional arg)
2273 "Process a miscellaneous key sequence in Isearch mode.
2275 Try to convert the current key-sequence to something usable in Isearch
2276 mode, either by converting it with `function-key-map', downcasing a
2278 it. \(In the last case, we may have to read more events.) If so,
2279 either unread the converted sequence or execute the command.
2281 Otherwise, if `search-exit-option' is non-nil (the default) unread the
2282 key-sequence and exit the search normally. If it is the symbol
2283 `edit', the search string is edited in the minibuffer and the meta
2284 character is unread so that it applies to editing the string.
2286 ARG is the prefix argument. It will be transmitted through to the
2287 scrolling command or to the command whose key-sequence exits
2288 Isearch mode."
2289 (interactive "P")
2290 (let* ((key (if current-prefix-arg ; not nec the same as ARG
2291 (substring (this-command-keys) universal-argument-num-events)
2292 (this-command-keys)))
2293 (main-event (aref key 0))
2294 (keylist (listify-key-sequence key))
2295 scroll-command isearch-point)
2296 (cond ((and (= (length key) 1)
2297 (let ((lookup (lookup-key local-function-key-map key)))
2298 (not (or (null lookup) (integerp lookup)
2299 (keymapp lookup)))))
2300 ;; Handle a function key that translates into something else.
2301 ;; If the key has a global definition too,
2302 ;; exit and unread the key itself, so its global definition runs.
2303 ;; Otherwise, unread the translation,
2304 ;; so that the translated key takes effect within isearch.
2305 (cancel-kbd-macro-events)
2306 (if (lookup-key global-map key)
2307 (progn
2308 (isearch-done)
2309 (setq prefix-arg arg)
2310 (apply 'isearch-unread keylist))
2311 (setq keylist
2312 (listify-key-sequence
2313 (lookup-key local-function-key-map key)))
2314 (while keylist
2315 (setq key (car keylist))
2316 ;; If KEY is a printing char, we handle it here
2317 ;; directly to avoid the input method and keyboard
2318 ;; coding system translating it.
2319 (if (and (integerp key)
2320 (>= key ?\s) (/= key 127) (< key 256))
2321 (progn
2322 ;; Ensure that the processed char is recorded in
2323 ;; the keyboard macro, if any (Bug#4894)
2324 (store-kbd-macro-event key)
2325 (isearch-process-search-char key)
2326 (setq keylist (cdr keylist)))
2327 ;; As the remaining keys in KEYLIST can't be handled
2328 ;; here, we must reread them.
2329 (setq prefix-arg arg)
2330 (apply 'isearch-unread keylist)
2331 (setq keylist nil)))))
2332 (
2333 ;; Handle an undefined shifted control character
2334 ;; by downshifting it if that makes it defined.
2335 ;; (As read-key-sequence would normally do,
2336 ;; if we didn't have a default definition.)
2337 (let ((mods (event-modifiers main-event)))
2338 (and (integerp main-event)
2339 (memq 'shift mods)
2340 (memq 'control mods)
2341 (not (memq (lookup-key isearch-mode-map
2342 (let ((copy (copy-sequence key)))
2343 (aset copy 0
2344 (- main-event
2345 (- ?\C-\S-a ?\C-a)))
2346 copy)
2347 nil)
2348 '(nil
2349 isearch-other-control-char)))))
2350 (setcar keylist (- main-event (- ?\C-\S-a ?\C-a)))
2351 (cancel-kbd-macro-events)
2352 (setq prefix-arg arg)
2353 (apply 'isearch-unread keylist))
2354 ((eq search-exit-option 'edit)
2355 (setq prefix-arg arg)
2356 (apply 'isearch-unread keylist)
2357 (isearch-edit-string))
2358 ;; Handle a scrolling function or prefix argument.
2359 ((progn
2360 (setq key (isearch-reread-key-sequence-naturally keylist)
2361 keylist (listify-key-sequence key)
2362 main-event (aref key 0))
2363 (or (and isearch-allow-scroll
2364 (setq scroll-command (isearch-lookup-scroll-key key)))
2365 (and isearch-allow-prefix
2366 (let (overriding-terminal-local-map)
2367 (setq scroll-command (key-binding key))
2368 (memq scroll-command
2369 '(universal-argument
2370 negative-argument digit-argument))))))
2371 ;; From this point onwards, KEY, KEYLIST and MAIN-EVENT hold a
2372 ;; complete key sequence, possibly as modified by function-key-map,
2373 ;; not merely the one or two event fragment which invoked
2374 ;; isearch-other-meta-char in the first place.
2375 (setq isearch-point (point))
2376 (setq prefix-arg arg)
2377 (command-execute scroll-command)
2378 (let ((ab-bel (isearch-string-out-of-window isearch-point)))
2379 (if ab-bel
2380 (isearch-back-into-window (eq ab-bel 'above) isearch-point)
2381 (goto-char isearch-point)))
2382 (isearch-update))
2383 ;; A mouse click on the isearch message starts editing the search string
2384 ((and (eq (car-safe main-event) 'down-mouse-1)
2385 (window-minibuffer-p (posn-window (event-start main-event))))
2386 ;; Swallow the up-event.
2387 (read-event)
2388 (isearch-edit-string))
2389 (search-exit-option
2390 (let (window)
2391 (setq prefix-arg arg)
2392 (isearch-unread-key-sequence keylist)
2393 (setq main-event (car unread-command-events))
2395 ;; If we got a mouse click event, that event contains the
2396 ;; window clicked on. maybe it was read with the buffer
2397 ;; it was clicked on. If so, that buffer, not the current one,
2398 ;; is in isearch mode. So end the search in that buffer.
2400 ;; ??? I have no idea what this if checks for, but it's
2401 ;; obviously wrong for the case that a down-mouse event
2402 ;; on another window invokes this function. The event
2403 ;; will contain the window clicked on and that window's
2404 ;; buffer is certainly not always in Isearch mode.
2405 ;;
2406 ;; Leave the code in, but check for current buffer not
2407 ;; being in Isearch mode for now, until someone tells
2408 ;; what it's really supposed to do.
2409 ;;
2410 ;; --gerd 2001-08-10.
2412 (if (and (not isearch-mode)
2413 (listp main-event)
2414 (setq window (posn-window (event-start main-event)))
2415 (windowp window)
2416 (or (> (minibuffer-depth) 0)
2417 (not (window-minibuffer-p window))))
2418 (with-current-buffer (window-buffer window)
2419 (isearch-done)
2420 (isearch-clean-overlays))
2421 (isearch-done)
2422 (isearch-clean-overlays)
2423 (setq prefix-arg arg))))
2424 (t;; otherwise nil
2425 (isearch-process-search-string key key)))))
2427 (defun isearch-quote-char (&optional count)
2428 "Quote special characters for incremental search.
2429 With argument, add COUNT copies of the character."
2430 (interactive "p")
2431 (let ((char (read-quoted-char (isearch-message t))))
2432 ;; Assume character codes 0200 - 0377 stand for characters in some
2433 ;; single-byte character set, and convert them to Emacs
2434 ;; characters.
2435 (if (and isearch-regexp isearch-regexp-lax-whitespace (= char ?\s))
2436 (if (subregexp-context-p isearch-string (length isearch-string))
2437 (isearch-process-search-string "[ ]" " ")
2438 (isearch-process-search-char char count))
2439 (and enable-multibyte-characters
2442 (setq char (unibyte-char-to-multibyte char)))
2443 (isearch-process-search-char char count))))
2445 (defun isearch-printing-char (&optional char count)
2446 "Add this ordinary printing CHAR to the search string and search.
2447 With argument, add COUNT copies of the character."
2448 (interactive (list last-command-event
2449 (prefix-numeric-value current-prefix-arg)))
2450 (let ((char (or char last-command-event)))
2451 (if (= char ?\S-\ )
2452 (setq char ?\s))
2453 (if current-input-method
2454 (isearch-process-search-multibyte-characters char count)
2455 (isearch-process-search-char char count))))
2457 (defun isearch-process-search-char (char &optional count)
2458 ;; * and ? are special in regexps when not preceded by \.
2459 ;; } and | are special in regexps when preceded by \.
2460 ;; Nothing special for + because it matches at least once.
2461 (cond
2462 ((memq char '(?* ??)) (isearch-fallback nil))
2463 ((eq char ?\}) (isearch-fallback t t))
2464 ((eq char ?|) (isearch-fallback t nil t)))
2466 ;; Append the char(s) to the search string,
2467 ;; update the message and re-search.
2468 (let* ((string (if (and (integerp count) (> count 1))
2469 (make-string count char)
2470 (char-to-string char)))
2472 string
2473 (mapconcat 'isearch-text-char-description string ""))))
2474 (isearch-process-search-string string message)))
2476 (defun isearch-process-search-string (string message)
2477 (setq isearch-string (concat isearch-string string)
2478 isearch-message (concat isearch-message message))
2479 (isearch-search-and-update))
2481 \f
2482 ;; Search Ring
2484 (defun isearch-ring-adjust1 (advance)
2485 ;; Helper for isearch-ring-adjust
2486 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2487 (length (length ring))
2488 (yank-pointer-name (if isearch-regexp
2489 'regexp-search-ring-yank-pointer
2490 'search-ring-yank-pointer))
2491 (yank-pointer (eval yank-pointer-name)))
2492 (if (zerop length)
2493 ()
2494 (set yank-pointer-name
2495 (setq yank-pointer
2496 (mod (+ (or yank-pointer (if advance 0 -1))
2497 (if advance -1 1))
2498 length)))
2499 (setq isearch-string (nth yank-pointer ring)
2500 isearch-message (mapconcat 'isearch-text-char-description
2501 isearch-string "")))))
2503 (defun isearch-ring-adjust (advance)
2504 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2505 (isearch-ring-adjust1 advance)
2506 (if search-ring-update
2507 (progn
2508 (isearch-search)
2509 (isearch-push-state)
2510 (isearch-update))
2511 ;; Otherwise, edit the search string instead. Note that there is
2512 ;; no need to push the search state after isearch-edit-string here
2513 ;; since isearch-edit-string already pushes its state
2514 (isearch-edit-string)))
2516 (defun isearch-ring-advance ()
2517 "Advance to the next search string in the ring."
2518 ;; This could be more general to handle a prefix arg, but who would use it.
2519 (interactive)
2520 (isearch-ring-adjust 'advance))
2522 (defun isearch-ring-retreat ()
2523 "Retreat to the previous search string in the ring."
2524 (interactive)
2525 (isearch-ring-adjust nil))
2527 (defun isearch-complete1 ()
2528 ;; Helper for isearch-complete and isearch-complete-edit
2529 ;; Return t if completion OK, nil if no completion exists.
2530 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2531 (completion-ignore-case case-fold-search)
2532 (completion (try-completion isearch-string ring)))
2533 (cond
2534 ((eq completion t)
2535 ;; isearch-string stays the same
2536 t)
2537 ((or completion ; not nil, must be a string
2538 (= 0 (length isearch-string))) ; shouldn't have to say this
2539 (if (equal completion isearch-string) ;; no extension?
2540 (progn
2541 (if completion-auto-help
2542 (with-output-to-temp-buffer "*Isearch completions*"
2543 (display-completion-list
2544 (all-completions isearch-string ring))))
2545 t)
2546 (and completion
2547 (setq isearch-string completion))))
2548 (t
2549 (message "No completion") ; waits a second if in minibuffer
2550 nil))))
2552 (defun isearch-complete ()
2553 "Complete the search string from the strings on the search ring.
2554 The completed string is then editable in the minibuffer.
2555 If there is no completion possible, say so and continue searching."
2556 (interactive)
2557 (if (isearch-complete1)
2558 (progn (setq isearch-message
2559 (mapconcat 'isearch-text-char-description
2560 isearch-string ""))
2561 (isearch-edit-string))
2562 ;; else
2563 (sit-for 1)
2564 (isearch-update)))
2566 (defun isearch-complete-edit ()
2567 "Same as `isearch-complete' except in the minibuffer."
2568 (interactive)
2569 (setq isearch-string (field-string))
2570 (if (isearch-complete1)
2571 (progn
2572 (delete-field)
2573 (insert isearch-string))))
2575 \f
2576 ;; Message string
2578 (defun isearch-message (&optional c-q-hack ellipsis)
2579 ;; Generate and print the message string.
2580 (let ((cursor-in-echo-area ellipsis)
2581 (m isearch-message)
2582 (fail-pos (isearch-fail-pos t)))
2583 ;; Highlight failed part
2584 (when fail-pos
2585 (setq m (copy-sequence m))
2586 (add-text-properties fail-pos (length m) '(face isearch-fail) m)
2587 ;; Highlight failed trailing whitespace
2588 (when (string-match " +$" m)
2589 (add-text-properties (match-beginning 0) (match-end 0)
2590 '(face trailing-whitespace) m)))
2591 (setq m (concat
2592 (isearch-message-prefix ellipsis isearch-nonincremental)
2593 m
2594 (isearch-message-suffix c-q-hack)))
2595 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2597 (defun isearch-message-prefix (&optional ellipsis nonincremental)
2598 ;; If about to search, and previous search regexp was invalid,
2599 ;; check that it still is. If it is valid now,
2600 ;; let the message we display while searching say that it is valid.
2601 (and isearch-error ellipsis
2602 (condition-case ()
2603 (progn (re-search-forward isearch-string (point) t)
2604 (setq isearch-error nil))
2605 (error nil)))
2606 ;; If currently failing, display no ellipsis.
2607 (or isearch-success (setq ellipsis nil))
2608 (let ((m (concat (if isearch-success "" "failing ")
2609 (if isearch-adjusted "pending " "")
2610 (if (and isearch-wrapped
2611 (not isearch-wrap-function)
2612 (if isearch-forward
2613 (> (point) isearch-opoint)
2614 (< (point) isearch-opoint)))
2615 "over")
2616 (if isearch-wrapped "wrapped ")
2617 (mapconcat (lambda (s)
2618 (and (symbolp s)
2619 (get s 'isearch-message-prefix)))
2620 (if (consp isearch-filter-predicates)
2621 isearch-filter-predicates
2622 (list isearch-filter-predicates))
2623 "")
2624 (if isearch-word
2625 (or (and (symbolp isearch-word)
2626 (get isearch-word 'isearch-message-prefix))
2627 "word ")
2628 "")
2629 (if isearch-regexp "regexp " "")
2630 (if multi-isearch-next-buffer-current-function "multi " "")
2631 (or isearch-message-prefix-add "")
2632 (if nonincremental "search" "I-search")
2633 (if isearch-forward "" " backward")
2634 (if current-input-method
2635 ;; Input methods for RTL languages use RTL
2636 ;; characters for their title, and that messes
2637 ;; up the display of search text after the prompt.
2638 (bidi-string-mark-left-to-right
2639 (concat " [" current-input-method-title "]: "))
2640 ": ")
2641 )))
2642 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2643 'face 'minibuffer-prompt)))
2645 (defun isearch-message-suffix (&optional c-q-hack)
2646 (concat (if c-q-hack "^Q" "")
2647 (if isearch-error
2648 (concat " [" isearch-error "]")
2649 "")
2650 (or isearch-message-suffix-add "")))
2652 \f
2653 ;; Searching
2655 (defvar isearch-search-fun-function 'isearch-search-fun-default
2656 "Non-default value overrides the behavior of `isearch-search-fun-default'.
2657 This variable's value should be a function, which will be called
2658 with no arguments, and should return a function that takes three
2659 arguments: STRING, BOUND, and NOERROR.
2661 This returned function will be used by `isearch-search-string' to
2662 search for the first occurrence of STRING or its translation.")
2664 (defun isearch-search-fun ()
2665 "Return the function to use for the search.
2666 Can be changed via `isearch-search-fun-function' for special needs."
2667 (funcall (or isearch-search-fun-function 'isearch-search-fun-default)))
2669 (defun isearch-search-fun-default ()
2670 "Return default functions to use for the search."
2671 (cond
2672 (isearch-word
2673 (lambda (string &optional bound noerror count)
2674 ;; Use lax versions to not fail at the end of the word while
2675 ;; the user adds and removes characters in the search string
2676 ;; (or when using nonincremental word isearch)
2677 (let ((lax (not (or isearch-nonincremental
2678 (null (car isearch-cmds))
2679 (eq (length isearch-string)
2680 (length (isearch--state-string
2681 (car isearch-cmds))))))))
2682 (funcall
2683 (if isearch-forward #'re-search-forward #'re-search-backward)
2684 (if (functionp isearch-word)
2685 (funcall isearch-word string lax)
2686 (word-search-regexp string lax))
2687 bound noerror count))))
2688 ((and isearch-regexp isearch-regexp-lax-whitespace
2689 search-whitespace-regexp)
2690 (if isearch-forward
2691 're-search-forward-lax-whitespace
2692 're-search-backward-lax-whitespace))
2693 (isearch-regexp
2694 (if isearch-forward 're-search-forward 're-search-backward))
2695 ((and isearch-lax-whitespace search-whitespace-regexp)
2696 (if isearch-forward
2697 'search-forward-lax-whitespace
2698 'search-backward-lax-whitespace))
2699 (t
2700 (if isearch-forward 'search-forward 'search-backward))))
2702 (defun isearch-search-string (string bound noerror)
2703 "Search for the first occurrence of STRING or its translation.
2704 If found, move point to the end of the occurrence,
2705 update the match data, and return point."
2706 (let* ((func (isearch-search-fun))
2707 (pos1 (save-excursion (funcall func string bound noerror)))
2708 pos2)
2709 (when (and
2710 ;; Avoid "obsolete" warnings for translation-table-for-input.
2711 (with-no-warnings
2712 (char-table-p translation-table-for-input))
2713 (multibyte-string-p string)
2714 ;; Minor optimization.
2715 (string-match-p "[^[:ascii:]]" string))
2716 (let ((translated
2717 (apply 'string
2718 (mapcar (lambda (c)
2719 (or
2720 ;; Avoid "obsolete" warnings for
2721 ;; translation-table-for-input.
2722 (with-no-warnings
2723 (aref translation-table-for-input c))
2724 c))
2725 string)))
2726 match-data)
2727 (when translated
2728 (save-match-data
2729 (save-excursion
2730 (if (setq pos2 (funcall func translated bound noerror))
2731 (setq match-data (match-data t)))))
2732 (when (and pos2
2733 (or (not pos1)
2734 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2735 (setq pos1 pos2)
2736 (set-match-data match-data)))))
2737 (when pos1
2738 ;; When using multiple buffers isearch, switch to the new buffer here,
2739 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2740 (if (and multi-isearch-next-buffer-current-function
2741 (buffer-live-p multi-isearch-current-buffer))
2742 (switch-to-buffer multi-isearch-current-buffer))
2743 (goto-char pos1)
2744 pos1)))
2746 (defun isearch-search ()
2747 ;; Do the search with the current search string.
2748 (if isearch-message-function
2749 (funcall isearch-message-function nil t)
2750 (isearch-message nil t))
2751 (if (and (eq isearch-case-fold-search t) search-upper-case)
2752 (setq isearch-case-fold-search
2753 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2754 (condition-case lossage
2755 (let ((inhibit-point-motion-hooks isearch-invisible)
2756 (inhibit-quit nil)
2757 (case-fold-search isearch-case-fold-search)
2758 (search-invisible isearch-invisible)
2759 (retry t))
2760 (setq isearch-error nil)
2761 (while retry
2762 (setq isearch-success
2763 (isearch-search-string isearch-string nil t))
2764 ;; Clear RETRY unless the search predicate says
2765 ;; to skip this search hit.
2766 (if (or (not isearch-success)
2767 (bobp) (eobp)
2768 (= (match-beginning 0) (match-end 0))
2769 ;; When one of filter predicates returns nil,
2770 ;; retry the search. Otherwise, act according
2771 ;; to search-invisible (open overlays, etc.)
2772 (and (run-hook-with-args-until-failure
2773 'isearch-filter-predicates
2774 (match-beginning 0) (match-end 0))
2775 (or (eq search-invisible t)
2776 (not (isearch-range-invisible
2777 (match-beginning 0) (match-end 0))))))
2778 (setq retry nil)))
2779 (setq isearch-just-started nil)
2780 (if isearch-success
2781 (setq isearch-other-end
2782 (if isearch-forward (match-beginning 0) (match-end 0)))))
2784 (quit (isearch-unread ?\C-g)
2785 (setq isearch-success nil))
2787 (invalid-regexp
2788 (setq isearch-error (car (cdr lossage)))
2789 (if (string-match
2791 isearch-error)
2792 (setq isearch-error "incomplete input")))
2794 (search-failed
2795 (setq isearch-success nil)
2796 (setq isearch-error (nth 2 lossage)))
2798 (error
2799 ;; stack overflow in regexp search.
2800 (setq isearch-error (format "%s" lossage))))
2802 (if isearch-success
2803 nil
2804 ;; Ding if failed this time after succeeding last time.
2805 (and (isearch--state-success (car isearch-cmds))
2806 (ding))
2807 (if (functionp (isearch--state-pop-fun (car isearch-cmds)))
2808 (funcall (isearch--state-pop-fun (car isearch-cmds))
2809 (car isearch-cmds)))
2810 (goto-char (isearch--state-point (car isearch-cmds)))))
2813 ;; Called when opening an overlay, and we are still in isearch.
2814 (defun isearch-open-overlay-temporary (ov)
2815 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2816 ;; Some modes would want to open the overlays temporary during
2817 ;; isearch in their own way, they should set the
2818 ;; `isearch-open-invisible-temporary' to a function doing this.
2819 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2820 ;; Store the values for the `invisible' and `intangible'
2821 ;; properties, and then set them to nil. This way the text hidden
2822 ;; by this overlay becomes visible.
2824 ;; Do we really need to set the `intangible' property to t? Can we
2825 ;; have the point inside an overlay with an `intangible' property?
2826 ;; In 19.34 this does not exist so I cannot test it.
2827 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2828 (overlay-put ov 'isearch-intangible (overlay-get ov 'intangible))
2829 (overlay-put ov 'invisible nil)
2830 (overlay-put ov 'intangible nil)))
2833 ;; This is called at the end of isearch. It will open the overlays
2834 ;; that contain the latest match. Obviously in case of a C-g the
2835 ;; point returns to the original location which surely is not contain
2836 ;; in any of these overlays, se we are safe in this case too.
2837 (defun isearch-open-necessary-overlays (ov)
2838 (let ((inside-overlay (and (> (point) (overlay-start ov))
2839 (< (point) (overlay-end ov))))
2840 ;; If this exists it means that the overlay was opened using
2841 ;; this function, not by us tweaking the overlay properties.
2842 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2843 (when (or inside-overlay (not fct-temp))
2844 ;; restore the values for the `invisible' and `intangible'
2845 ;; properties
2846 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2847 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2848 (overlay-put ov 'isearch-invisible nil)
2849 (overlay-put ov 'isearch-intangible nil))
2850 (if inside-overlay
2851 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2852 (if fct-temp
2853 (funcall fct-temp ov t)))))
2855 ;; This is called when exiting isearch. It closes the temporary
2856 ;; opened overlays, except the ones that contain the latest match.
2857 (defun isearch-clean-overlays ()
2858 (when isearch-opened-overlays
2859 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2860 (setq isearch-opened-overlays nil)))
2863 (defun isearch-intersects-p (start0 end0 start1 end1)
2864 "Return t if regions START0..END0 and START1..END1 intersect."
2865 (or (and (>= start0 start1) (< start0 end1))
2866 (and (> end0 start1) (<= end0 end1))
2867 (and (>= start1 start0) (< start1 end0))
2868 (and (> end1 start0) (<= end1 end0))))
2871 ;; Verify if the current match is outside of each element of
2872 ;; `isearch-opened-overlays', if so close that overlay.
2874 (defun isearch-close-unnecessary-overlays (begin end)
2875 (let ((overlays isearch-opened-overlays))
2876 (setq isearch-opened-overlays nil)
2877 (dolist (ov overlays)
2878 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2879 (push ov isearch-opened-overlays)
2880 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2881 (if fct-temp
2882 ;; If this exists it means that the overlay was opened
2883 ;; using this function, not by us tweaking the overlay
2884 ;; properties.
2885 (funcall fct-temp ov t)
2886 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2887 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2888 (overlay-put ov 'isearch-invisible nil)
2889 (overlay-put ov 'isearch-intangible nil)))))))
2892 (defun isearch-range-invisible (beg end)
2893 "Return t if all the text from BEG to END is invisible."
2894 (when (/= beg end)
2895 ;; Check that invisibility runs up to END.
2896 (save-excursion
2897 (goto-char beg)
2898 (let (;; can-be-opened keeps track if we can open some overlays.
2899 (can-be-opened (eq search-invisible 'open))
2900 ;; the list of overlays that could be opened
2901 (crt-overlays nil))
2902 (when (and can-be-opened isearch-hide-immediately)
2903 (isearch-close-unnecessary-overlays beg end))
2904 ;; If the following character is currently invisible,
2905 ;; skip all characters with that same `invisible' property value.
2906 ;; Do that over and over.
2907 (while (and (< (point) end) (invisible-p (point)))
2908 (if (invisible-p (get-text-property (point) 'invisible))
2909 (progn
2910 (goto-char (next-single-property-change (point) 'invisible
2911 nil end))
2912 ;; if text is hidden by an `invisible' text property
2913 ;; we cannot open it at all.
2914 (setq can-be-opened nil))
2915 (when can-be-opened
2916 (let ((overlays (overlays-at (point)))
2917 ov-list
2918 o
2919 invis-prop)
2920 (while overlays
2921 (setq o (car overlays)
2922 invis-prop (overlay-get o 'invisible))
2923 (if (invisible-p invis-prop)
2924 (if (overlay-get o 'isearch-open-invisible)
2925 (setq ov-list (cons o ov-list))
2926 ;; We found one overlay that cannot be
2927 ;; opened, that means the whole chunk
2928 ;; cannot be opened.
2929 (setq can-be-opened nil)))
2930 (setq overlays (cdr overlays)))
2931 (if can-be-opened
2932 ;; It makes sense to append to the open
2933 ;; overlays list only if we know that this is
2934 ;; t.
2935 (setq crt-overlays (append ov-list crt-overlays)))))
2936 (goto-char (next-overlay-change (point)))))
2937 ;; See if invisibility reaches up thru END.
2938 (if (>= (point) end)
2939 (if (and can-be-opened (consp crt-overlays))
2940 (progn
2941 (setq isearch-opened-overlays
2942 (append isearch-opened-overlays crt-overlays))
2943 (mapc 'isearch-open-overlay-temporary crt-overlays)
2944 nil)
2945 (setq isearch-hidden t)))))))
2947 (defun isearch-filter-visible (beg end)
2948 "Test whether the current search hit is visible at least partially.
2949 Return non-nil if the text from BEG to END is visible to Isearch as
2950 determined by `isearch-range-invisible' unless invisible text can be
2951 searched too when `search-invisible' is t."
2952 (or (eq search-invisible t)
2953 (not (isearch-range-invisible beg end))))
2954 (make-obsolete 'isearch-filter-visible 'isearch-invisible "24.4")
2956 \f
2957 ;; General utilities
2959 (defun isearch-no-upper-case-p (string regexp-flag)
2960 "Return t if there are no upper case chars in STRING.
2962 since they have special meaning in a regexp."
2963 (let (quote-flag (i 0) (len (length string)) found)
2964 (while (and (not found) (< i len))
2965 (let ((char (aref string i)))
2967 (setq quote-flag (not quote-flag))
2968 (if (and (not quote-flag) (not (eq char (downcase char))))
2969 (setq found t))
2970 (setq quote-flag nil)))
2971 (setq i (1+ i)))
2972 (not (or found
2973 ;; Even if there's no uppercase char, we want to detect the use
2974 ;; of [:upper:] or [:lower:] char-class, which indicates
2975 ;; clearly that the user cares about case distinction.
2977 (condition-case err
2978 (progn
2979 (string-match (substring string 0 (match-beginning 0))
2980 "")
2981 nil)
2982 (invalid-regexp
2983 (equal "Unmatched [ or [^" (cadr err)))))))))
2985 ;; Portability functions to support various Emacs versions.
2987 (defun isearch-text-char-description (c)
2988 (cond
2989 ((< c ?\s) (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph))
2990 ((= c ?\^?) (propertize "^?" 'face 'escape-glyph))
2991 (t (char-to-string c))))
2993 ;; General function to unread characters or events.
2994 ;; Also insert them in a keyboard macro being defined.
2995 (defun isearch-unread (&rest char-or-events)
2996 (mapc 'store-kbd-macro-event char-or-events)
2997 (setq unread-command-events
2998 (append char-or-events unread-command-events)))
3000 \f
3001 ;; Highlighting
3003 (defvar isearch-overlay nil)
3005 (defun isearch-highlight (beg end)
3006 (if search-highlight
3007 (if isearch-overlay
3008 ;; Overlay already exists, just move it.
3009 (move-overlay isearch-overlay beg end (current-buffer))
3010 ;; Overlay doesn't exist, create it.
3011 (setq isearch-overlay (make-overlay beg end))
3012 ;; 1001 is higher than lazy's 1000 and ediff's 100+
3013 (overlay-put isearch-overlay 'priority 1001)
3014 (overlay-put isearch-overlay 'face isearch-face))))
3016 (defun isearch-dehighlight ()
3017 (when isearch-overlay
3018 (delete-overlay isearch-overlay)))
3019 \f
3020 ;; isearch-lazy-highlight feature
3021 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
3023 ;; When active, *every* match for the current search string is
3024 ;; highlighted: the current one using the normal isearch match color
3025 ;; and all the others using `isearch-lazy-highlight'. The extra
3026 ;; highlighting makes it easier to anticipate where the cursor will
3027 ;; land each time you press C-s or C-r to repeat a pending search.
3028 ;; Highlighting of these additional matches happens in a deferred
3029 ;; fashion using "idle timers," so the cycles needed do not rob
3030 ;; isearch of its usual snappy response.
3032 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
3033 ;; Specifically:
3034 ;; - `isearch-update' is expected to be called (at least) every time
3035 ;; the search string or window-start changes;
3036 ;; - `isearch-string' is expected to contain the current search
3037 ;; string as entered by the user;
3038 ;; - the type of the current search is expected to be given by
3039 ;; `isearch-word' and `isearch-regexp';
3040 ;; - the direction of the current search is expected to be given by
3041 ;; `isearch-forward';
3042 ;; - the variable `isearch-error' is expected to be true
3043 ;; only if `isearch-string' is an invalid regexp.
3045 (defvar isearch-lazy-highlight-overlays nil)
3046 (defvar isearch-lazy-highlight-wrapped nil)
3047 (defvar isearch-lazy-highlight-start-limit nil)
3048 (defvar isearch-lazy-highlight-end-limit nil)
3049 (defvar isearch-lazy-highlight-start nil)
3050 (defvar isearch-lazy-highlight-end nil)
3051 (defvar isearch-lazy-highlight-timer nil)
3052 (defvar isearch-lazy-highlight-last-string nil)
3053 (defvar isearch-lazy-highlight-window nil)
3054 (defvar isearch-lazy-highlight-window-start nil)
3055 (defvar isearch-lazy-highlight-window-end nil)
3056 (defvar isearch-lazy-highlight-case-fold-search nil)
3057 (defvar isearch-lazy-highlight-regexp nil)
3058 (defvar isearch-lazy-highlight-lax-whitespace nil)
3059 (defvar isearch-lazy-highlight-regexp-lax-whitespace nil)
3060 (defvar isearch-lazy-highlight-word nil)
3061 (defvar isearch-lazy-highlight-forward nil)
3062 (defvar isearch-lazy-highlight-error nil)
3064 (defun lazy-highlight-cleanup (&optional force)
3065 "Stop lazy highlighting and remove extra highlighting from current buffer.
3066 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
3067 is nil. This function is called when exiting an incremental search if
3068 `lazy-highlight-cleanup' is non-nil."
3069 (interactive '(t))
3070 (if (or force lazy-highlight-cleanup)
3071 (while isearch-lazy-highlight-overlays
3072 (delete-overlay (car isearch-lazy-highlight-overlays))
3073 (setq isearch-lazy-highlight-overlays
3074 (cdr isearch-lazy-highlight-overlays))))
3075 (when isearch-lazy-highlight-timer
3076 (cancel-timer isearch-lazy-highlight-timer)
3077 (setq isearch-lazy-highlight-timer nil)))
3079 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
3080 'lazy-highlight-cleanup
3081 "22.1")
3083 (defun isearch-lazy-highlight-new-loop (&optional beg end)
3084 "Cleanup any previous `lazy-highlight' loop and begin a new one.
3085 BEG and END specify the bounds within which highlighting should occur.
3086 This is called when `isearch-update' is invoked (which can cause the
3087 search string to change or the window to scroll). It is also used
3088 by other Emacs features."
3089 (when (and (null executing-kbd-macro)
3090 (sit-for 0) ;make sure (window-start) is credible
3091 (or (not (equal isearch-string
3092 isearch-lazy-highlight-last-string))
3093 (not (eq (selected-window)
3094 isearch-lazy-highlight-window))
3095 (not (eq isearch-lazy-highlight-case-fold-search
3096 isearch-case-fold-search))
3097 (not (eq isearch-lazy-highlight-regexp
3098 isearch-regexp))
3099 (not (eq isearch-lazy-highlight-word
3100 isearch-word))
3101 (not (eq isearch-lazy-highlight-lax-whitespace
3102 isearch-lax-whitespace))
3103 (not (eq isearch-lazy-highlight-regexp-lax-whitespace
3104 isearch-regexp-lax-whitespace))
3105 (not (= (window-start)
3106 isearch-lazy-highlight-window-start))
3107 (not (= (window-end) ; Window may have been split/joined.
3108 isearch-lazy-highlight-window-end))
3109 (not (eq isearch-forward
3110 isearch-lazy-highlight-forward))
3111 ;; In case we are recovering from an error.
3112 (not (equal isearch-error
3113 isearch-lazy-highlight-error))))
3114 ;; something important did indeed change
3115 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
3116 (setq isearch-lazy-highlight-error isearch-error)
3117 ;; It used to check for `(not isearch-error)' here, but actually
3118 ;; lazy-highlighting might find matches to highlight even when
3119 ;; `isearch-error' is non-nil. (Bug#9918)
3120 (setq isearch-lazy-highlight-start-limit beg
3121 isearch-lazy-highlight-end-limit end)
3122 (setq isearch-lazy-highlight-window (selected-window)
3123 isearch-lazy-highlight-window-start (window-start)
3124 isearch-lazy-highlight-window-end (window-end)
3125 ;; Start lazy-highlighting at the beginning of the found
3126 ;; match (`isearch-other-end'). If no match, use point.
3127 ;; One of the next two variables (depending on search direction)
3128 ;; is used to define the starting position of lazy-highlighting
3129 ;; and also to remember the current position of point between
3130 ;; calls of `isearch-lazy-highlight-update', and another variable
3131 ;; is used to define where the wrapped search must stop.
3132 isearch-lazy-highlight-start (or isearch-other-end (point))
3133 isearch-lazy-highlight-end (or isearch-other-end (point))
3134 isearch-lazy-highlight-wrapped nil
3135 isearch-lazy-highlight-last-string isearch-string
3136 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
3137 isearch-lazy-highlight-regexp isearch-regexp
3138 isearch-lazy-highlight-lax-whitespace isearch-lax-whitespace
3139 isearch-lazy-highlight-regexp-lax-whitespace isearch-regexp-lax-whitespace
3140 isearch-lazy-highlight-word isearch-word
3141 isearch-lazy-highlight-forward isearch-forward)
3142 (unless (equal isearch-string "")
3143 (setq isearch-lazy-highlight-timer
3144 (run-with-idle-timer lazy-highlight-initial-delay nil
3145 'isearch-lazy-highlight-update)))))
3147 (defun isearch-lazy-highlight-search ()
3148 "Search ahead for the next or previous match, for lazy highlighting.
3149 Attempt to do the search exactly the way the pending Isearch would."
3150 (condition-case nil
3151 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
3152 (isearch-regexp isearch-lazy-highlight-regexp)
3153 (isearch-word isearch-lazy-highlight-word)
3154 (isearch-lax-whitespace
3155 isearch-lazy-highlight-lax-whitespace)
3156 (isearch-regexp-lax-whitespace
3157 isearch-lazy-highlight-regexp-lax-whitespace)
3158 (isearch-forward isearch-lazy-highlight-forward)
3159 (search-invisible nil) ; don't match invisible text
3160 (retry t)
3161 (success nil)
3162 (bound (if isearch-lazy-highlight-forward
3163 (min (or isearch-lazy-highlight-end-limit (point-max))
3164 (if isearch-lazy-highlight-wrapped
3165 isearch-lazy-highlight-start
3166 (window-end)))
3167 (max (or isearch-lazy-highlight-start-limit (point-min))
3168 (if isearch-lazy-highlight-wrapped
3169 isearch-lazy-highlight-end
3170 (window-start))))))
3171 ;; Use a loop like in `isearch-search'.
3172 (while retry
3173 (setq success (isearch-search-string
3174 isearch-lazy-highlight-last-string bound t))
3175 ;; Clear RETRY unless the search predicate says
3176 ;; to skip this search hit.
3177 (if (or (not success)
3178 (= (point) bound) ; like (bobp) (eobp) in `isearch-search'.
3179 (= (match-beginning 0) (match-end 0))
3180 (and (run-hook-with-args-until-failure
3181 'isearch-filter-predicates
3182 (match-beginning 0) (match-end 0))
3183 (not (isearch-range-invisible
3184 (match-beginning 0) (match-end 0)))))
3185 (setq retry nil)))
3186 success)
3187 (error nil)))
3189 (defun isearch-lazy-highlight-update ()
3190 "Update highlighting of other matches for current search."
3191 (let ((max lazy-highlight-max-at-a-time)
3192 (looping t)
3193 nomore)
3194 (with-local-quit
3195 (save-selected-window
3196 (if (and (window-live-p isearch-lazy-highlight-window)
3197 (not (eq (selected-window) isearch-lazy-highlight-window)))
3198 (select-window isearch-lazy-highlight-window))
3199 (save-excursion
3200 (save-match-data
3201 (goto-char (if isearch-lazy-highlight-forward
3202 isearch-lazy-highlight-end
3203 isearch-lazy-highlight-start))
3204 (while looping
3205 (let ((found (isearch-lazy-highlight-search)))
3206 (when max
3207 (setq max (1- max))
3208 (if (<= max 0)
3209 (setq looping nil)))
3210 (if found
3211 (let ((mb (match-beginning 0))
3212 (me (match-end 0)))
3213 (if (= mb me) ;zero-length match
3214 (if isearch-lazy-highlight-forward
3215 (if (= mb (if isearch-lazy-highlight-wrapped
3216 isearch-lazy-highlight-start
3217 (window-end)))
3218 (setq found nil)
3219 (forward-char 1))
3220 (if (= mb (if isearch-lazy-highlight-wrapped
3221 isearch-lazy-highlight-end
3222 (window-start)))
3223 (setq found nil)
3224 (forward-char -1)))
3226 ;; non-zero-length match
3227 (let ((ov (make-overlay mb me)))
3228 (push ov isearch-lazy-highlight-overlays)
3229 ;; 1000 is higher than ediff's 100+,
3230 ;; but lower than isearch main overlay's 1001
3231 (overlay-put ov 'priority 1000)
3232 (overlay-put ov 'face lazy-highlight-face)
3233 (overlay-put ov 'window (selected-window))))
3234 ;; Remember the current position of point for
3235 ;; the next call of `isearch-lazy-highlight-update'
3236 ;; when `lazy-highlight-max-at-a-time' is too small.
3237 (if isearch-lazy-highlight-forward
3238 (setq isearch-lazy-highlight-end (point))
3239 (setq isearch-lazy-highlight-start (point)))))
3241 ;; not found or zero-length match at the search bound
3242 (if (not found)
3243 (if isearch-lazy-highlight-wrapped
3244 (setq looping nil
3245 nomore t)
3246 (setq isearch-lazy-highlight-wrapped t)
3247 (if isearch-lazy-highlight-forward
3248 (progn
3249 (setq isearch-lazy-highlight-end (window-start))
3250 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
3251 (window-start))))
3252 (setq isearch-lazy-highlight-start (window-end))
3253 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
3254 (window-end))))))))
3255 (unless nomore
3256 (setq isearch-lazy-highlight-timer
3257 (run-at-time lazy-highlight-interval nil
3258 'isearch-lazy-highlight-update)))))))))
3260 (defun isearch-resume (string regexp word forward message case-fold)
3261 "Resume an incremental search.
3262 STRING is the string or regexp searched for.
3263 REGEXP non-nil means the resumed search was a regexp search.
3264 WORD non-nil means resume a word search.
3265 FORWARD non-nil means resume a forward search.
3266 MESSAGE is the echo-area message recorded for the search resumed.
3267 CASE-FOLD non-nil means the search was case-insensitive."
3268 (isearch-mode forward regexp nil nil word)
3269 (setq isearch-string string
3270 isearch-message message
3271 isearch-case-fold-search case-fold)
3272 (isearch-search)
3273 (isearch-update))
3275 ;;; isearch.el ends here