| blob | 6ea8d86336a9f474148ea3e43c22f2a307479229 |
1 ;;; isearch.el --- incremental search minor mode
3 ;; Copyright (C) 1992-1997, 1999-2012 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 does a nonincremental search.
52 ;; Exiting immediately from isearch uses isearch-edit-string instead
53 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
54 ;; The name of this option should probably be changed if we decide to
55 ;; keep the behavior. No point in forcing nonincremental search until
56 ;; the last possible moment.
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 regexp
120 incremental search. If the value is nil, each space you type
121 matches literally, against one space.
123 The value can also be a cons cell (REGEXP-1 . REGEXP-2). In that
124 case, REGEXP-1 is used as the value for ordinary incremental
125 search, and REGEXP-2 is used for regexp incremental search.
128 In the Customization buffer, that is `[' followed by a space,
129 a tab, a carriage return (control-M), a newline, and `]+'."
132 regexp
135 regexp
137 regexp)
142 "If t incremental search can match hidden text.
143 A nil value means don't match invisible text.
144 When the value is `open', if the text matched is made invisible by
145 an overlay having an `invisible' property and that overlay has a property
146 `isearch-open-invisible', then incremental search will show the contents.
147 \(This applies when using `outline.el' and `hideshow.el'.)
148 See also `reveal-mode' if you want overlays to automatically be opened
149 whenever point is in one of them."
156 "If non-nil, re-hide an invisible match right away.
157 This variable makes a difference when `search-invisible' is set to `open'.
158 It means that after search makes some invisible text visible
159 to show the match, it makes the text invisible again when the match moves.
160 Ordinarily the text becomes invisible again at the end of the search."
165 "If non-nil, `isearch-resume' commands are added to the command history.
166 This allows you to resume earlier Isearch sessions through the
167 command history."
178 "Function(s) to call after terminating an incremental search.
179 When these functions are called, `isearch-mode-end-hook-quit'
186 "Function to call to display the search prompt.
190 "Function to call to wrap the search when search is failed.
191 If nil, move point to the beginning of the buffer for a forward search,
195 "Function to save a function restoring the mode-specific Isearch state
199 "Predicate that filters the search hits that would normally be available.
200 Search hits that dissatisfy the predicate are skipped. The function
201 has two arguments: the positions of start and end of text matched by
202 the search. If this function returns nil, continue searching without
205 ;; Search ring.
213 "Maximum length of search ring before oldest elements are thrown away."
217 "Maximum length of regexp search ring before oldest elements are thrown away."
222 "Index in `search-ring' of last string reused.
225 "Index in `regexp-search-ring' of last string reused.
229 "Non-nil if advancing or retreating in the search ring should cause search.
230 Default value, nil, means edit the string instead."
234 ;;; isearch highlight customization.
237 "Non-nil means incremental search highlights the current match."
243 ;; The background must not be too dark, for that means
244 ;; the character is hard to see when the cursor is there.
253 "Face for highlighting Isearch matches."
270 "Face for highlighting failed part in Isearch echo-area message."
275 "Controls the lazy-highlighting during incremental search.
276 When non-nil, all text in the buffer matching the current search
277 string is highlighted lazily (see `lazy-highlight-initial-delay'
278 and `lazy-highlight-interval')."
283 ;;; Lazy highlight customization.
286 "Lazy highlighting feature for matching strings."
293 'lazy-highlight-cleanup
297 "Controls whether to remove extra highlighting after a search.
304 'lazy-highlight-initial-delay
308 "Seconds to wait before beginning to lazily highlight all matches."
313 'lazy-highlight-interval
317 "Seconds between lazily highlighting successive matches."
322 'lazy-highlight-max-at-a-time
326 "Maximum matches to highlight at a time (for `lazy-highlight').
327 Larger values may reduce Isearch's responsiveness to user input;
328 smaller values make matches highlight slowly.
329 A value of nil means highlight all matches."
344 "Face for lazy highlighting of matches other than the current one."
349 'lazy-highlight-face
352 \f
353 ;; Define isearch help map.
358 (define-key map (char-to-string help-char) 'isearch-help-for-help)
359 (define-key map [help] 'isearch-help-for-help)
360 (define-key map [f1] 'isearch-help-for-help)
361 (define-key map "?" 'isearch-help-for-help)
362 (define-key map "b" 'isearch-describe-bindings)
363 (define-key map "k" 'isearch-describe-key)
364 (define-key map "m" 'isearch-describe-mode)
365 (define-key map "q" 'help-quit)
366 map)
367 "Keymap for characters following the Help key for Isearch mode.")
369 (eval-when-compile (require 'help-macro))
371 (make-help-screen isearch-help-for-help-internal
372 (purecopy "Type a help option: [bkm] or ?")
373 "You have typed %THIS-KEY%, the help character. Type a Help option:
376 b Display all Isearch key bindings.
377 k KEYS Display full documentation of Isearch key sequence.
378 m Display documentation of Isearch mode.
380 You can't type here other help keys available in the global help map,
381 but outside of this help window when you type them in Isearch mode,
382 they exit Isearch mode before displaying global help."
383 isearch-help-map)
385 (defun isearch-help-for-help ()
386 "Display Isearch help menu."
387 (interactive)
388 (let (same-window-buffer-names same-window-regexps)
389 (isearch-help-for-help-internal))
390 (isearch-update))
392 (defun isearch-describe-bindings ()
393 "Show a list of all keys defined in Isearch mode, and their definitions.
394 This is like `describe-bindings', but displays only Isearch keys."
395 (interactive)
396 (let (same-window-buffer-names same-window-regexps)
397 (with-help-window "*Help*"
398 (with-current-buffer standard-output
402 (defun isearch-describe-key ()
403 "Display documentation of the function invoked by isearch key."
404 (interactive)
405 (let (same-window-buffer-names same-window-regexps)
406 (call-interactively 'describe-key))
407 (isearch-update))
409 (defun isearch-describe-mode ()
410 "Display documentation of Isearch mode."
411 (interactive)
412 (let (same-window-buffer-names same-window-regexps)
413 (describe-function 'isearch-forward))
414 (isearch-update))
416 (defalias 'isearch-mode-help 'isearch-describe-mode)
418 \f
419 ;; Define isearch-mode keymap.
421 (defvar isearch-mode-map
422 (let ((i 0)
423 (map (make-keymap)))
424 (or (char-table-p (nth 1 map))
425 (error "The initialization of isearch-mode-map must be updated"))
426 ;; Make all multibyte characters search for themselves.
427 (set-char-table-range (nth 1 map) (cons #x100 (max-char))
428 'isearch-printing-char)
429 ;; Make function keys, etc, which aren't bound to a scrolling-function
430 ;; exit the search.
433 ;; Single-byte printing chars extend the search string by default.
439 ;; To handle local bindings with meta char prefix keys, define
440 ;; another full keymap. This must be done for any other prefix
441 ;; keys as well, one full keymap per char of the prefix key. It
442 ;; would be simpler to disable the global keymap, and/or have a
443 ;; default local key binding for any key not otherwise bound.
447 (define-key meta-map [t] 'isearch-other-meta-char))
449 ;; Several non-printing chars change the searching behavior.
450 (define-key map "\C-s" 'isearch-repeat-forward)
451 (define-key map "\C-r" 'isearch-repeat-backward)
452 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
453 ;; combinations can be used to repeat regexp isearches that can
454 ;; be used to start these searches.
455 (define-key map "\M-\C-s" 'isearch-repeat-forward)
456 (define-key map "\M-\C-r" 'isearch-repeat-backward)
458 (define-key map "\C-g" 'isearch-abort)
460 ;; This assumes \e is the meta-prefix-char.
461 (or (= ?\e meta-prefix-char)
462 (error "Inconsistency in isearch.el"))
463 (define-key map "\e\e\e" 'isearch-cancel)
464 (define-key map [escape escape escape] 'isearch-cancel)
466 (define-key map "\C-q" 'isearch-quote-char)
469 (define-key map "\C-j" 'isearch-printing-char)
471 (define-key map [?\S-\ ] 'isearch-printing-char)
473 (define-key map "\C-w" 'isearch-yank-word-or-char)
474 (define-key map "\M-\C-w" 'isearch-del-char)
475 (define-key map "\M-\C-y" 'isearch-yank-char)
476 (define-key map "\C-y" 'isearch-yank-kill)
477 (define-key map "\M-s\C-e" 'isearch-yank-line)
479 (define-key map (char-to-string help-char) isearch-help-map)
480 (define-key map [help] isearch-help-map)
481 (define-key map [f1] isearch-help-map)
483 (define-key map "\M-n" 'isearch-ring-advance)
484 (define-key map "\M-p" 'isearch-ring-retreat)
485 (define-key map "\M-y" 'isearch-yank-pop)
489 ;; Pass frame events transparently so they won't exit the search.
490 ;; In particular, if we have more than one display open, then a
491 ;; switch-frame might be generated by someone typing at another keyboard.
492 (define-key map [switch-frame] nil)
493 (define-key map [delete-frame] nil)
494 (define-key map [iconify-frame] nil)
495 (define-key map [make-frame-visible] nil)
496 (define-key map [mouse-movement] nil)
497 (define-key map [language-change] nil)
499 ;; For searching multilingual text.
501 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
503 ;; People expect to be able to paste with the mouse.
504 (define-key map [mouse-2] #'isearch-mouse-2)
505 (define-key map [down-mouse-2] nil)
507 ;; Some bindings you may want to put in your isearch-mode-hook.
508 ;; Suggest some alternates...
509 (define-key map "\M-c" 'isearch-toggle-case-fold)
510 (define-key map "\M-r" 'isearch-toggle-regexp)
511 (define-key map "\M-e" 'isearch-edit-string)
513 (define-key map "\M-sc" 'isearch-toggle-case-fold)
514 (define-key map "\M-sr" 'isearch-toggle-regexp)
515 (define-key map "\M-sw" 'isearch-toggle-word)
516 (define-key map "\M-s_" 'isearch-toggle-symbol)
518 (define-key map [?\M-%] 'isearch-query-replace)
519 (define-key map [?\C-\M-%] 'isearch-query-replace-regexp)
520 (define-key map "\M-so" 'isearch-occur)
521 (define-key map "\M-shr" 'isearch-highlight-regexp)
523 ;; The key translations defined in the C-x 8 prefix should insert
524 ;; characters into the search string. See iso-transl.el.
525 (define-key map "\C-x" nil)
526 (define-key map [?\C-x t] 'isearch-other-control-char)
527 (define-key map "\C-x8" nil)
530 map)
531 "Keymap for `isearch-mode'.")
533 (defvar minibuffer-local-isearch-map
534 (let ((map (make-sparse-keymap)))
535 (set-keymap-parent map minibuffer-local-map)
538 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
539 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
540 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
541 (define-key map [right] 'isearch-yank-char-in-minibuffer)
542 map)
543 "Keymap for editing Isearch strings in the minibuffer.")
545 ;; Internal variables declared globally for byte-compiler.
546 ;; These are all set with setq while isearching
547 ;; and bound locally while editing the search string.
549 (defvar isearch-forward nil) ; Searching in the forward direction.
550 (defvar isearch-regexp nil) ; Searching for a regexp.
551 (defvar isearch-word nil
552 "Regexp-based search mode for words/symbols.
553 If t, do incremental search for a sequence of words, ignoring punctuation.
554 If the value is a function (e.g. `isearch-symbol-regexp'), it is called to
555 convert the search string to a regexp used by regexp search functions.
556 The property `isearch-message-prefix' put on this function specifies the
557 prefix string displayed in the search message.")
559 (defvar isearch-cmds nil
560 "Stack of search status sets.
561 Each set is a vector of the form:
562 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
563 INVALID-REGEXP WRAPPED BARRIER WITHIN-BRACKETS CASE-FOLD-SEARCH]")
565 (defvar isearch-string "") ; The current search string.
566 (defvar isearch-message "") ; text-char-description version of isearch-string
568 (defvar isearch-message-prefix-add nil) ; Additional text for the message prefix
569 (defvar isearch-message-suffix-add nil) ; Additional text for the message suffix
571 (defvar isearch-success t) ; Searching is currently successful.
572 (defvar isearch-error nil) ; Error message for failed search.
573 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
574 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
575 (defvar isearch-barrier 0
576 "Recorded minimum/maximal point for the current search.")
577 (defvar isearch-just-started nil)
578 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
580 ;; case-fold-search while searching.
581 ;; either nil, t, or 'yes. 'yes means the same as t except that mixed
582 ;; case in the search string is ignored.
583 (defvar isearch-case-fold-search nil)
585 (defvar isearch-last-case-fold-search nil)
587 ;; Used to save default value while isearch is active
588 (defvar isearch-original-minibuffer-message-timeout nil)
590 (defvar isearch-adjusted nil)
591 (defvar isearch-slow-terminal-mode nil)
592 ;; If t, using a small window.
593 (defvar isearch-small-window nil)
594 (defvar isearch-opoint 0)
595 ;; The window configuration active at the beginning of the search.
596 (defvar isearch-window-configuration nil)
598 ;; Flag to indicate a yank occurred, so don't move the cursor.
599 (defvar isearch-yank-flag nil)
601 ;; A function to be called after each input character is processed.
602 ;; (It is not called after characters that exit the search.)
603 ;; It is only set from an optional argument to `isearch-mode'.
604 (defvar isearch-op-fun nil)
606 ;; Is isearch-mode in a recursive edit for modal searching.
607 (defvar isearch-recursive-edit nil)
609 ;; Should isearch be terminated after doing one search?
610 (defvar isearch-nonincremental nil)
612 ;; New value of isearch-forward after isearch-edit-string.
613 (defvar isearch-new-forward nil)
615 ;; Accumulate here the overlays opened during searching.
616 (defvar isearch-opened-overlays nil)
618 ;; Non-nil if the string exists but is invisible.
619 (defvar isearch-hidden nil)
621 ;; The value of input-method-function when isearch is invoked.
622 (defvar isearch-input-method-function nil)
624 ;; A flag to tell if input-method-function is locally bound when
625 ;; isearch is invoked.
626 (defvar isearch-input-method-local-p nil)
628 ;; Minor-mode-alist changes - kind of redundant with the
629 ;; echo area, but if isearching in multiple windows, it can be useful.
631 (or (assq 'isearch-mode minor-mode-alist)
632 (nconc minor-mode-alist
633 (list '(isearch-mode isearch-mode))))
635 (defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
636 (make-variable-buffer-local 'isearch-mode)
638 (define-key global-map "\C-s" 'isearch-forward)
639 (define-key esc-map "\C-s" 'isearch-forward-regexp)
640 (define-key global-map "\C-r" 'isearch-backward)
641 (define-key esc-map "\C-r" 'isearch-backward-regexp)
642 (define-key search-map "w" 'isearch-forward-word)
643 (define-key search-map "_" 'isearch-forward-symbol)
645 ;; Entry points to isearch-mode.
647 (defun isearch-forward (&optional regexp-p no-recursive-edit)
648 "\
649 Do incremental search forward.
650 With a prefix argument, do an incremental regular expression search instead.
652 As you type characters, they add to the search string and are found.
653 The following non-printing keys are bound in `isearch-mode-map'.
657 Type LFD (C-j) to match end of line.
661 onto the end of the search string, and search for it.
664 string and search for it.
666 and search for it.
669 with string killed before it.
672 back to what has
673 been found successfully.
675 starting point.
677 If you try to exit with the search string still empty, it invokes
678 nonincremental search.
686 Also supported is a search ring of the previous 16 search strings.
689 ring.
693 replace from last search string.
695 with the last search string.
697 the last search string.
699 that highlights the last search string.
705 In incremental searches, a space or spaces normally matches any
706 whitespace; see the variable `search-whitespace-regexp'.
708 If an input method is turned on in the current buffer, that input
709 method is also active while you are typing characters to search.
711 It also toggles the input
712 method in the current buffer.
714 To use a different input method for searching, type \
716 and specify an input method you want to use.
718 The above keys, bound in `isearch-mode-map', are often controlled by
720 Other control and meta characters terminate the search
721 and are then executed normally (depending on `search-exit-option').
722 Likewise for function keys and mouse button events.
724 If this function is called non-interactively, it does not return to
725 the calling function until the search is done."
728 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
730 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
731 "Do incremental search forward for regular expression.
732 With a prefix argument, do a regular string search instead.
733 Like ordinary incremental search except that your input is treated
734 as a regexp. See the command `isearch-forward' for more information.
736 In incremental searches, a space or spaces normally matches any
737 whitespace; see the variable `search-whitespace-regexp'. To
738 search for a literal space and nothing else, enter C-q SPC."
740 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
742 (defun isearch-forward-word (&optional not-word no-recursive-edit)
743 "Do incremental search forward for a sequence of words.
744 With a prefix argument, do a regular string search instead.
745 Like ordinary incremental search except that your input is treated
746 as a sequence of words without regard to how the words are separated.
747 See the command `isearch-forward' for more information."
749 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
751 (defun isearch-forward-symbol (&optional not-symbol no-recursive-edit)
752 "Do incremental search forward for a symbol.
753 The prefix argument is currently unused.
754 Like ordinary incremental search except that your input is treated
756 See the command `isearch-forward' for more information."
758 (isearch-mode t nil nil (not no-recursive-edit) 'isearch-symbol-regexp))
760 (defun isearch-backward (&optional regexp-p no-recursive-edit)
761 "Do incremental search backward.
762 With a prefix argument, do a regular expression search instead.
763 See the command `isearch-forward' for more information."
765 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
767 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
768 "Do incremental search backward for regular expression.
769 With a prefix argument, do a regular string search instead.
770 Like ordinary incremental search except that your input is treated
771 as a regexp. See the command `isearch-forward' for more information."
773 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
775 \f
776 ;; isearch-mode only sets up incremental search for the minor mode.
777 ;; All the work is done by the isearch-mode commands.
779 ;; Not used yet:
780 ;;(defvar isearch-commands '(isearch-forward isearch-backward
781 ;; isearch-forward-regexp isearch-backward-regexp)
782 ;; "List of commands for which isearch-mode does not recursive-edit.")
785 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word)
786 "Start Isearch minor mode.
787 It is called by the function `isearch-forward' and other related functions."
789 ;; Initialize global vars.
790 (setq isearch-forward forward
791 isearch-regexp regexp
792 isearch-word word
793 isearch-op-fun op-fun
794 isearch-last-case-fold-search isearch-case-fold-search
795 isearch-case-fold-search case-fold-search
796 isearch-string ""
797 isearch-message ""
798 isearch-cmds nil
799 isearch-success t
800 isearch-wrapped nil
801 isearch-barrier (point)
802 isearch-adjusted nil
803 isearch-yank-flag nil
804 isearch-error nil
805 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
806 (> (window-height)
807 (* 4
808 (abs search-slow-window-lines))))
809 isearch-other-end nil
810 isearch-small-window nil
811 isearch-just-started t
812 isearch-start-hscroll (window-hscroll)
814 isearch-opoint (point)
815 search-ring-yank-pointer nil
816 isearch-opened-overlays nil
817 isearch-input-method-function input-method-function
818 isearch-input-method-local-p (local-variable-p 'input-method-function)
819 regexp-search-ring-yank-pointer nil
821 ;; Save the original value of `minibuffer-message-timeout', and
822 ;; set it to nil so that isearch's messages don't get timed out.
823 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
824 minibuffer-message-timeout nil)
826 ;; We must bypass input method while reading key. When a user type
827 ;; printable character, appropriate input method is turned on in
828 ;; minibuffer to read multibyte characters.
829 (or isearch-input-method-local-p
830 (make-local-variable 'input-method-function))
831 (setq input-method-function nil)
833 (looking-at "")
834 (setq isearch-window-configuration
835 (if isearch-slow-terminal-mode (current-window-configuration) nil))
837 ;; Maybe make minibuffer frame visible and/or raise it.
838 (let ((frame (window-frame (minibuffer-window))))
839 (unless (memq (frame-live-p frame) '(nil t))
840 (unless (frame-visible-p frame)
841 (make-frame-visible frame))
842 (if minibuffer-auto-raise
843 (raise-frame frame))))
845 (setq isearch-mode " Isearch") ;; forward? regexp?
846 (force-mode-line-update)
848 (setq overriding-terminal-local-map isearch-mode-map)
849 (run-hooks 'isearch-mode-hook)
851 ;; Pushing the initial state used to be before running isearch-mode-hook,
852 ;; but a hook might set `isearch-push-state-function' used in
853 ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994)
854 (isearch-push-state)
856 (isearch-update)
858 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
859 (add-hook 'kbd-macro-termination-hook 'isearch-done)
861 ;; isearch-mode can be made modal (in the sense of not returning to
862 ;; the calling function until searching is completed) by entering
863 ;; a recursive-edit and exiting it when done isearching.
864 (if recursive-edit
865 (let ((isearch-recursive-edit t))
866 (recursive-edit)))
867 isearch-success)
870 ;; Some high level utilities. Others below.
872 (defun isearch-update ()
873 "This is called after every isearch command to update the display.
874 The last thing it does is to run `isearch-update-post-hook'."
875 (if (and (null unread-command-events)
876 (null executing-kbd-macro))
877 (progn
878 (if (not (input-pending-p))
879 (if isearch-message-function
880 (funcall isearch-message-function)
881 (isearch-message)))
882 (if (and isearch-slow-terminal-mode
883 (not (or isearch-small-window
884 (pos-visible-in-window-p))))
885 (let ((found-point (point)))
886 (setq isearch-small-window t)
887 (move-to-window-line 0)
888 (let ((window-min-height 1))
889 (split-window nil (if (< search-slow-window-lines 0)
890 (1+ (- search-slow-window-lines))
891 (- (window-height)
892 (1+ search-slow-window-lines)))))
893 (if (< search-slow-window-lines 0)
894 (progn (vertical-motion (- 1 search-slow-window-lines))
895 (set-window-start (next-window) (point))
896 (set-window-hscroll (next-window)
897 (window-hscroll))
898 (set-window-hscroll (selected-window) 0))
899 (other-window 1))
900 (goto-char found-point))
901 ;; Keep same hscrolling as at the start of the search when possible
902 (let ((current-scroll (window-hscroll)))
903 (set-window-hscroll (selected-window) isearch-start-hscroll)
904 (unless (pos-visible-in-window-p)
905 (set-window-hscroll (selected-window) current-scroll))))
906 (if isearch-other-end
907 (if (< isearch-other-end (point)) ; isearch-forward?
908 (isearch-highlight isearch-other-end (point))
909 (isearch-highlight (point) isearch-other-end))
910 (isearch-dehighlight))))
911 (setq ;; quit-flag nil not for isearch-mode
912 isearch-adjusted nil
913 isearch-yank-flag nil)
914 (when isearch-lazy-highlight
915 (isearch-lazy-highlight-new-loop))
916 ;; We must prevent the point moving to the end of composition when a
917 ;; part of the composition has just been searched.
918 (setq disable-point-adjustment t)
919 (run-hooks 'isearch-update-post-hook))
921 (defun isearch-done (&optional nopush edit)
922 "Exit Isearch mode.
923 For successful search, pass no args.
924 For a failing search, NOPUSH is t.
925 For going to the minibuffer to edit the search string,
926 NOPUSH is t and EDIT is t."
928 (if isearch-resume-in-command-history
929 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
930 ,isearch-word ,isearch-forward
931 ,isearch-message
932 ',isearch-case-fold-search)))
933 (unless (equal (car command-history) command)
934 (setq command-history (cons command command-history)))))
936 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
937 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
938 (setq isearch-lazy-highlight-start nil)
940 ;; Called by all commands that terminate isearch-mode.
941 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
942 (setq overriding-terminal-local-map nil)
943 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
944 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
945 (isearch-dehighlight)
946 (lazy-highlight-cleanup lazy-highlight-cleanup)
947 (let ((found-start (window-start (selected-window)))
948 (found-point (point)))
949 (when isearch-window-configuration
950 (set-window-configuration isearch-window-configuration)
951 (if isearch-small-window
952 (goto-char found-point)
953 ;; set-window-configuration clobbers window-start; restore it.
954 ;; This has an annoying side effect of clearing the last_modiff
955 ;; field of the window, which can cause unwanted scrolling,
956 ;; so don't do it unless truly necessary.
957 (set-window-start (selected-window) found-start t))))
959 (setq isearch-mode nil)
960 (if isearch-input-method-local-p
961 (setq input-method-function isearch-input-method-function)
962 (kill-local-variable 'input-method-function))
964 (force-mode-line-update)
966 ;; If we ended in the middle of some intangible text,
967 ;; move to the further end of that intangible text.
968 (let ((after (if (eobp) nil
969 (get-text-property (point) 'intangible)))
970 (before (if (bobp) nil
971 (get-text-property (1- (point)) 'intangible))))
972 (when (and before after (eq before after))
973 (goto-char
974 (if isearch-forward
975 (next-single-property-change (point) 'intangible)
976 (previous-single-property-change (point) 'intangible)))))
978 (if (and (> (length isearch-string) 0) (not nopush))
979 ;; Update the ring data.
980 (isearch-update-ring isearch-string isearch-regexp))
982 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
983 (run-hooks 'isearch-mode-end-hook))
985 ;; If there was movement, mark the starting position.
986 ;; Maybe should test difference between and set mark only if > threshold.
987 (if (/= (point) isearch-opoint)
988 (or (and transient-mark-mode mark-active)
989 (progn
990 (push-mark isearch-opoint t)
991 (or executing-kbd-macro (> (minibuffer-depth) 0) edit
992 (message "Mark saved where search started")))))
994 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
996 (defun isearch-update-ring (string &optional regexp)
997 "Add STRING to the beginning of the search ring.
998 REGEXP if non-nil says use the regexp search ring."
999 (add-to-history
1000 (if regexp 'regexp-search-ring 'search-ring)
1001 string
1002 (if regexp regexp-search-ring-max search-ring-max)))
1004 ;; Switching buffers should first terminate isearch-mode.
1005 ;; ;; For Emacs 19, the frame switch event is handled.
1006 ;; (defun isearch-switch-frame-handler ()
1007 ;; (interactive) ;; Is this necessary?
1008 ;; ;; First terminate isearch-mode.
1009 ;; (isearch-done)
1010 ;; (isearch-clean-overlays)
1011 ;; (handle-switch-frame (car (cdr last-command-event))))
1013 \f
1014 ;; The search status structure and stack.
1016 (cl-defstruct (isearch--state
1017 (:constructor nil)
1018 (:copier nil)
1019 (:constructor isearch--get-state
1020 (&aux
1021 (string isearch-string)
1022 (message isearch-message)
1023 (point (point))
1024 (success isearch-success)
1025 (forward isearch-forward)
1026 (other-end isearch-other-end)
1027 (word isearch-word)
1028 (error isearch-error)
1029 (wrapped isearch-wrapped)
1030 (barrier isearch-barrier)
1031 (case-fold-search isearch-case-fold-search)
1032 (pop-fun (if isearch-push-state-function
1033 (funcall isearch-push-state-function))))))
1034 (string :read-only t)
1035 (message :read-only t)
1036 (point :read-only t)
1037 (success :read-only t)
1038 (forward :read-only t)
1039 (other-end :read-only t)
1040 (word :read-only t)
1041 (error :read-only t)
1042 (wrapped :read-only t)
1043 (barrier :read-only t)
1044 (case-fold-search :read-only t)
1045 (pop-fun :read-only t))
1047 (defun isearch--set-state (cmd)
1048 (setq isearch-string (isearch--state-string cmd)
1049 isearch-message (isearch--state-message cmd)
1050 isearch-success (isearch--state-success cmd)
1051 isearch-forward (isearch--state-forward cmd)
1052 isearch-other-end (isearch--state-other-end cmd)
1053 isearch-word (isearch--state-word cmd)
1054 isearch-error (isearch--state-error cmd)
1055 isearch-wrapped (isearch--state-wrapped cmd)
1056 isearch-barrier (isearch--state-barrier cmd)
1057 isearch-case-fold-search (isearch--state-case-fold-search cmd))
1058 (if (functionp (isearch--state-pop-fun cmd))
1059 (funcall (isearch--state-pop-fun cmd) cmd))
1060 (goto-char (isearch--state-point cmd)))
1062 (defun isearch-pop-state ()
1063 (setq isearch-cmds (cdr isearch-cmds))
1064 (isearch--set-state (car isearch-cmds)))
1066 (defun isearch-push-state ()
1067 (push (isearch--get-state) isearch-cmds))
1069 \f
1070 ;; Commands active while inside of the isearch minor mode.
1072 (defun isearch-exit ()
1073 "Exit search normally.
1074 However, if this is the first command after starting incremental
1075 search and `search-nonincremental-instead' is non-nil, do a
1076 nonincremental search instead via `isearch-edit-string'."
1077 (interactive)
1078 (if (and search-nonincremental-instead
1079 (= 0 (length isearch-string)))
1080 (let ((isearch-nonincremental t))
1081 (isearch-edit-string)))
1082 (isearch-done)
1083 (isearch-clean-overlays))
1085 (defvar minibuffer-history-symbol) ;; from external package gmhist.el
1087 (defun isearch-fail-pos (&optional msg)
1088 "Return position of first mismatch in search string, or nil if none.
1089 If MSG is non-nil, use `isearch-message', otherwise `isearch-string'."
1090 (let ((cmds isearch-cmds)
1091 (curr-msg (if msg isearch-message isearch-string))
1092 succ-msg)
1093 (when (or (not isearch-success) isearch-error)
1094 (while (or (not (isearch--state-success (car cmds)))
1095 (isearch--state-error (car cmds)))
1096 (pop cmds))
1097 (setq succ-msg (and cmds (if msg (isearch--state-message (car cmds))
1098 (isearch--state-string (car cmds)))))
1099 (if (and (stringp succ-msg)
1100 (< (length succ-msg) (length curr-msg))
1101 (equal succ-msg
1102 (substring curr-msg 0 (length succ-msg))))
1103 (length succ-msg)
1104 0))))
1106 (defun isearch-edit-string ()
1107 "Edit the search string in the minibuffer.
1108 The following additional command keys are active while editing.
1116 ;; This code is very hairy for several reasons, explained in the code.
1117 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1118 ;; If there were a way to catch any change of buffer from the minibuffer,
1119 ;; this could be simplified greatly.
1120 ;; Editing doesn't back up the search point. Should it?
1121 (interactive)
1122 (condition-case nil
1123 (progn
1124 (let ((isearch-nonincremental isearch-nonincremental)
1126 ;; Locally bind all isearch global variables to protect them
1127 ;; from recursive isearching.
1128 ;; isearch-string -message and -forward are not bound
1129 ;; so they may be changed. Instead, save the values.
1130 (isearch-new-string isearch-string)
1131 (isearch-new-message isearch-message)
1132 (isearch-new-forward isearch-forward)
1133 (isearch-new-word isearch-word)
1134 (isearch-new-case-fold isearch-case-fold-search)
1136 (isearch-regexp isearch-regexp)
1137 (isearch-op-fun isearch-op-fun)
1138 (isearch-cmds isearch-cmds)
1139 (isearch-success isearch-success)
1140 (isearch-wrapped isearch-wrapped)
1141 (isearch-barrier isearch-barrier)
1142 (isearch-adjusted isearch-adjusted)
1143 (isearch-yank-flag isearch-yank-flag)
1144 (isearch-error isearch-error)
1145 ;;; Don't bind this. We want isearch-search, below, to set it.
1146 ;;; And the old value won't matter after that.
1147 ;;; (isearch-other-end isearch-other-end)
1148 ;;; Perhaps some of these other variables should be bound for a
1149 ;;; shorter period, ending before the next isearch-search.
1150 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1151 (isearch-opoint isearch-opoint)
1152 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1153 (isearch-small-window isearch-small-window)
1154 (isearch-recursive-edit isearch-recursive-edit)
1155 ;; Save current configuration so we can restore it here.
1156 (isearch-window-configuration (current-window-configuration))
1158 ;; This could protect the index of the search rings,
1159 ;; but we can't reliably count the number of typed M-p
1160 ;; in `read-from-minibuffer' to adjust the index accordingly.
1161 ;; So when the following is commented out, `isearch-mode'
1162 ;; below resets the index to the predictable value nil.
1163 ;; (search-ring-yank-pointer search-ring-yank-pointer)
1164 ;; (regexp-search-ring-yank-pointer regexp-search-ring-yank-pointer)
1166 ;; Temporarily restore `minibuffer-message-timeout'.
1167 (minibuffer-message-timeout
1168 isearch-original-minibuffer-message-timeout)
1169 (isearch-original-minibuffer-message-timeout
1170 isearch-original-minibuffer-message-timeout)
1171 old-point old-other-end)
1173 ;; Actually terminate isearching until editing is done.
1174 ;; This is so that the user can do anything without failure,
1175 ;; like switch buffers and start another isearch, and return.
1176 (condition-case nil
1177 (isearch-done t t)
1178 (exit nil)) ; was recursive editing
1180 ;; Save old point and isearch-other-end before reading from minibuffer
1181 ;; that can change their values.
1182 (setq old-point (point) old-other-end isearch-other-end)
1184 (unwind-protect
1185 (let* ((message-log-max nil)
1186 ;; Don't add a new search string to the search ring here
1187 ;; in `read-from-minibuffer'. It should be added only
1188 ;; by `isearch-update-ring' called from `isearch-done'.
1189 (history-add-new-input nil)
1190 ;; Binding minibuffer-history-symbol to nil is a work-around
1191 ;; for some incompatibility with gmhist.
1192 (minibuffer-history-symbol))
1193 (setq isearch-new-string
1194 (read-from-minibuffer
1195 (isearch-message-prefix nil isearch-nonincremental)
1196 (cons isearch-string (1+ (or (isearch-fail-pos)
1197 (length isearch-string))))
1198 minibuffer-local-isearch-map nil
1199 (if isearch-regexp
1200 (cons 'regexp-search-ring
1201 (1+ (or regexp-search-ring-yank-pointer -1)))
1202 (cons 'search-ring
1203 (1+ (or search-ring-yank-pointer -1))))
1204 nil t)
1205 isearch-new-message
1206 (mapconcat 'isearch-text-char-description
1207 isearch-new-string "")))
1209 ;; Set point at the start (end) of old match if forward (backward),
1210 ;; so after exiting minibuffer isearch resumes at the start (end)
1211 ;; of this match and can find it again.
1212 (if (and old-other-end (eq old-point (point))
1213 (eq isearch-forward isearch-new-forward))
1214 (goto-char old-other-end))
1216 ;; Always resume isearching by restarting it.
1217 (isearch-mode isearch-forward
1218 isearch-regexp
1219 isearch-op-fun
1220 nil
1221 isearch-word)
1223 ;; Copy new local values to isearch globals
1224 (setq isearch-string isearch-new-string
1225 isearch-message isearch-new-message
1226 isearch-forward isearch-new-forward
1227 isearch-word isearch-new-word
1228 isearch-case-fold-search isearch-new-case-fold))
1230 ;; Empty isearch-string means use default.
1231 (when (= 0 (length isearch-string))
1232 (setq isearch-string (or (car (if isearch-regexp
1233 regexp-search-ring
1234 search-ring))
1235 "")
1237 isearch-message
1238 (mapconcat 'isearch-text-char-description
1239 isearch-string ""))
1240 ;; After taking the last element, adjust ring to previous one.
1241 (isearch-ring-adjust1 nil)))
1243 ;; This used to push the state as of before this C-s, but it adds
1244 ;; an inconsistent state where part of variables are from the
1245 ;; previous search (e.g. `isearch-success'), and part of variables
1246 ;; are just entered from the minibuffer (e.g. `isearch-string').
1247 ;; (isearch-push-state)
1249 ;; Reinvoke the pending search.
1250 (isearch-search)
1251 (isearch-push-state) ; this pushes the correct state
1252 (isearch-update)
1253 (if isearch-nonincremental
1254 (progn
1255 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1256 (isearch-done)
1257 ;; The search done message is confusing when the string
1258 ;; is empty, so erase it.
1259 (if (equal isearch-string "")
1260 (message "")))))
1262 (quit ; handle abort-recursive-edit
1263 (isearch-abort) ;; outside of let to restore outside global values
1264 )))
1266 (defun isearch-nonincremental-exit-minibuffer ()
1267 (interactive)
1268 (setq isearch-nonincremental t)
1269 (exit-minibuffer))
1271 (defun isearch-forward-exit-minibuffer ()
1272 (interactive)
1273 (setq isearch-new-forward t)
1274 (exit-minibuffer))
1276 (defun isearch-reverse-exit-minibuffer ()
1277 (interactive)
1278 (setq isearch-new-forward nil)
1279 (exit-minibuffer))
1281 (defun isearch-cancel ()
1282 "Terminate the search and go back to the starting point."
1283 (interactive)
1284 (if (and isearch-push-state-function isearch-cmds)
1285 ;; For defined push-state function, restore the first state.
1286 ;; This calls pop-state function and restores original point.
1287 (let ((isearch-cmds (last isearch-cmds)))
1288 (isearch--set-state (car isearch-cmds)))
1289 (goto-char isearch-opoint))
1290 (isearch-done t) ; Exit isearch..
1291 (isearch-clean-overlays)
1292 (signal 'quit nil)) ; ..and pass on quit signal.
1294 (defun isearch-abort ()
1295 "Abort incremental search mode if searching is successful, signaling quit.
1296 Otherwise, revert to previous successful search and continue searching.
1297 Use `isearch-exit' to quit without signaling."
1298 (interactive)
1299 ;; (ding) signal instead below, if quitting
1300 (discard-input)
1301 (if (and isearch-success (not isearch-error))
1302 ;; If search is successful and has no incomplete regexp,
1303 ;; move back to starting point and really do quit.
1304 (progn
1305 (setq isearch-success nil)
1306 (isearch-cancel))
1307 ;; If search is failing, or has an incomplete regexp,
1308 ;; rub out until it is once more successful.
1309 (while (or (not isearch-success) isearch-error)
1310 (isearch-pop-state))
1311 (isearch-update)))
1313 (defun isearch-repeat (direction)
1314 ;; Utility for isearch-repeat-forward and -backward.
1315 (if (eq isearch-forward (eq direction 'forward))
1316 ;; C-s in forward or C-r in reverse.
1317 (if (equal isearch-string "")
1318 ;; If search string is empty, use last one.
1319 (if (null (if isearch-regexp regexp-search-ring search-ring))
1320 (setq isearch-error "No previous search string")
1321 (setq isearch-string
1322 (car (if isearch-regexp regexp-search-ring search-ring))
1323 isearch-message
1324 (mapconcat 'isearch-text-char-description
1325 isearch-string "")
1326 isearch-case-fold-search isearch-last-case-fold-search)
1327 ;; After taking the last element, adjust ring to previous one.
1328 (isearch-ring-adjust1 nil))
1329 ;; If already have what to search for, repeat it.
1330 (or isearch-success
1331 (progn
1332 ;; Set isearch-wrapped before calling isearch-wrap-function
1333 (setq isearch-wrapped t)
1334 (if isearch-wrap-function
1335 (funcall isearch-wrap-function)
1336 (goto-char (if isearch-forward (point-min) (point-max)))))))
1337 ;; C-s in reverse or C-r in forward, change direction.
1338 (setq isearch-forward (not isearch-forward)
1339 isearch-success t))
1341 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1343 (if (equal isearch-string "")
1344 (setq isearch-success t)
1345 (if (and isearch-success
1346 (equal (point) isearch-other-end)
1347 (not isearch-just-started))
1348 ;; If repeating a search that found
1349 ;; an empty string, ensure we advance.
1350 (if (if isearch-forward (eobp) (bobp))
1351 ;; If there's nowhere to advance to, fail (and wrap next time).
1352 (progn
1353 (setq isearch-success nil)
1354 (ding))
1355 (forward-char (if isearch-forward 1 -1))
1356 (isearch-search))
1357 (isearch-search)))
1359 (isearch-push-state)
1360 (isearch-update))
1362 (defun isearch-repeat-forward ()
1363 "Repeat incremental search forwards."
1364 (interactive)
1365 (isearch-repeat 'forward))
1367 (defun isearch-repeat-backward ()
1368 "Repeat incremental search backwards."
1369 (interactive)
1370 (isearch-repeat 'backward))
1372 (defun isearch-toggle-regexp ()
1373 "Toggle regexp searching on or off."
1374 ;; The status stack is left unchanged.
1375 (interactive)
1376 (setq isearch-regexp (not isearch-regexp))
1377 (if isearch-regexp (setq isearch-word nil))
1378 (setq isearch-success t isearch-adjusted t)
1379 (isearch-update))
1381 (defun isearch-toggle-word ()
1382 "Toggle word searching on or off."
1383 ;; The status stack is left unchanged.
1384 (interactive)
1385 (setq isearch-word (not isearch-word))
1386 (if isearch-word (setq isearch-regexp nil))
1387 (setq isearch-success t isearch-adjusted t)
1388 (isearch-update))
1390 (defun isearch-toggle-symbol ()
1391 "Toggle symbol searching on or off."
1392 (interactive)
1393 (setq isearch-word (unless (eq isearch-word 'isearch-symbol-regexp)
1394 'isearch-symbol-regexp))
1395 (setq isearch-success t isearch-adjusted t)
1396 (isearch-update))
1398 (defun isearch-toggle-case-fold ()
1399 "Toggle case folding in searching on or off."
1400 (interactive)
1401 (setq isearch-case-fold-search
1402 (if isearch-case-fold-search nil 'yes))
1403 (let ((message-log-max nil))
1404 (message "%s%s [case %ssensitive]"
1405 (isearch-message-prefix nil isearch-nonincremental)
1406 isearch-message
1407 (if isearch-case-fold-search "in" "")))
1408 (setq isearch-success t isearch-adjusted t)
1409 (sit-for 1)
1410 (isearch-update))
1412 \f
1413 ;; Word search
1415 (defun word-search-regexp (string &optional lax)
1416 "Return a regexp which matches words, ignoring punctuation.
1417 Given STRING, a string of words separated by word delimiters,
1418 compute a regexp that matches those exact words separated by
1419 arbitrary punctuation. If LAX is non-nil, the end of the string
1420 need not match a word boundary unless it ends in whitespace.
1422 Used in `word-search-forward', `word-search-backward',
1423 `word-search-forward-lax', `word-search-backward-lax'."
1425 ""
1426 (concat
1431 (defun word-search-backward (string &optional bound noerror count)
1432 "Search backward from point for STRING, ignoring differences in punctuation.
1433 Set point to the beginning of the occurrence found, and return point.
1434 An optional second argument bounds the search; it is a buffer position.
1435 The match found must not extend before that position.
1436 Optional third argument, if t, means if fail just return nil (no error).
1437 If not nil and not t, move to limit of search and return nil.
1438 Optional fourth argument is repeat count--search for successive occurrences.
1440 Relies on the function `word-search-regexp' to convert a sequence
1441 of words in STRING to a regexp used to search words without regard
1442 to punctuation."
1443 (interactive "sWord search backward: ")
1444 (re-search-backward (word-search-regexp string nil) bound noerror count))
1446 (defun word-search-forward (string &optional bound noerror count)
1447 "Search forward from point for STRING, ignoring differences in punctuation.
1448 Set point to the end of the occurrence found, and return point.
1449 An optional second argument bounds the search; it is a buffer position.
1450 The match found must not extend after that position.
1451 Optional third argument, if t, means if fail just return nil (no error).
1452 If not nil and not t, move to limit of search and return nil.
1453 Optional fourth argument is repeat count--search for successive occurrences.
1455 Relies on the function `word-search-regexp' to convert a sequence
1456 of words in STRING to a regexp used to search words without regard
1457 to punctuation."
1458 (interactive "sWord search: ")
1459 (re-search-forward (word-search-regexp string nil) bound noerror count))
1461 (defun word-search-backward-lax (string &optional bound noerror count)
1462 "Search backward from point for STRING, ignoring differences in punctuation.
1463 Set point to the beginning of the occurrence found, and return point.
1465 Unlike `word-search-backward', the end of STRING need not match a word
1466 boundary, unless STRING ends in whitespace.
1468 An optional second argument bounds the search; it is a buffer position.
1469 The match found must not extend before that position.
1470 Optional third argument, if t, means if fail just return nil (no error).
1471 If not nil and not t, move to limit of search and return nil.
1472 Optional fourth argument is repeat count--search for successive occurrences.
1474 Relies on the function `word-search-regexp' to convert a sequence
1475 of words in STRING to a regexp used to search words without regard
1476 to punctuation."
1477 (interactive "sWord search backward: ")
1478 (re-search-backward (word-search-regexp string t) bound noerror count))
1480 (defun word-search-forward-lax (string &optional bound noerror count)
1481 "Search forward from point for STRING, ignoring differences in punctuation.
1482 Set point to the end of the occurrence found, and return point.
1484 Unlike `word-search-forward', the end of STRING need not match a word
1485 boundary, unless STRING ends in whitespace.
1487 An optional second argument bounds the search; it is a buffer position.
1488 The match found must not extend after that position.
1489 Optional third argument, if t, means if fail just return nil (no error).
1490 If not nil and not t, move to limit of search and return nil.
1491 Optional fourth argument is repeat count--search for successive occurrences.
1493 Relies on the function `word-search-regexp' to convert a sequence
1494 of words in STRING to a regexp used to search words without regard
1495 to punctuation."
1496 (interactive "sWord search: ")
1497 (re-search-forward (word-search-regexp string t) bound noerror count))
1499 ;; Symbol search
1501 (defun isearch-symbol-regexp (string &optional lax)
1502 "Return a regexp which matches STRING as a symbol.
1504 If LAX is non-nil, the end of the string need not match a symbol boundary."
1507 (put 'isearch-symbol-regexp 'isearch-message-prefix "symbol ")
1509 \f
1510 (defun isearch-query-replace (&optional delimited regexp-flag)
1511 "Start `query-replace' with string to replace from last search string.
1512 The arg DELIMITED (prefix arg if interactive), if non-nil, means replace
1513 only matches surrounded by word boundaries. Note that using the prefix arg
1514 is possible only when `isearch-allow-scroll' is non-nil, and it doesn't
1515 always provide the correct matches for `query-replace', so the preferred
1516 way to run word replacements from Isearch is `M-s w ... M-%'."
1517 (interactive
1518 (list current-prefix-arg))
1519 (barf-if-buffer-read-only)
1520 (if regexp-flag (setq isearch-regexp t))
1521 (let ((case-fold-search isearch-case-fold-search)
1522 ;; set `search-upper-case' to nil to not call
1523 ;; `isearch-no-upper-case-p' in `perform-replace'
1524 (search-upper-case nil)
1525 ;; Set `isearch-recursive-edit' to nil to prevent calling
1526 ;; `exit-recursive-edit' in `isearch-done' that terminates
1527 ;; the execution of this command when it is non-nil.
1528 ;; We call `exit-recursive-edit' explicitly at the end below.
1529 (isearch-recursive-edit nil))
1530 (isearch-done nil t)
1531 (isearch-clean-overlays)
1532 (if (and isearch-other-end
1533 (< isearch-other-end (point))
1534 (not (and transient-mark-mode mark-active
1535 (< (mark) (point)))))
1536 (goto-char isearch-other-end))
1537 (set query-replace-from-history-variable
1538 (cons isearch-string
1539 (symbol-value query-replace-from-history-variable)))
1540 (perform-replace
1541 isearch-string
1542 (query-replace-read-to
1543 isearch-string
1544 (concat "Query replace"
1545 (if (or delimited isearch-word) " word" "")
1546 (if isearch-regexp " regexp" "")
1547 (if (and transient-mark-mode mark-active) " in region" ""))
1548 isearch-regexp)
1549 t isearch-regexp (or delimited isearch-word) nil nil
1550 (if (and transient-mark-mode mark-active) (region-beginning))
1551 (if (and transient-mark-mode mark-active) (region-end))))
1552 (and isearch-recursive-edit (exit-recursive-edit)))
1554 (defun isearch-query-replace-regexp (&optional delimited)
1555 "Start `query-replace-regexp' with string to replace from last search string.
1556 See `isearch-query-replace' for more information."
1557 (interactive
1558 (list current-prefix-arg))
1559 (isearch-query-replace delimited t))
1561 (defun isearch-whitespace-regexp ()
1562 "Return the value of `search-whitespace-regexp' for the current search."
1563 (cond ((not (consp search-whitespace-regexp))
1564 search-whitespace-regexp)
1565 (isearch-regexp
1566 (cdr search-whitespace-regexp))
1567 (t
1568 (car search-whitespace-regexp))))
1570 (defun isearch-occur (regexp &optional nlines)
1571 "Run `occur' using the last search string as the regexp.
1572 Interactively, REGEXP is constructed using the search string from the
1573 last search command. NLINES has the same meaning as in `occur'.
1575 If the last search command was a word search, REGEXP is computed from
1576 the search words, ignoring punctuation. If the last search
1577 command was a regular expression search, REGEXP is the regular
1578 expression used in that search. If the last search command searched
1579 for a literal string, REGEXP is constructed by quoting all the special
1580 characters in that string."
1581 (interactive
1582 (let* ((perform-collect (consp current-prefix-arg))
1583 (regexp (cond
1584 ((functionp isearch-word)
1585 (funcall isearch-word isearch-string))
1586 (isearch-word (word-search-regexp isearch-string))
1587 (isearch-regexp isearch-string)
1588 (t (regexp-quote isearch-string)))))
1589 (list regexp
1590 (if perform-collect
1591 ;; Perform collect operation
1592 (if (zerop (regexp-opt-depth regexp))
1593 ;; No subexpression so collect the entire match.
1595 ;; Get the regexp for collection pattern.
1596 (isearch-done nil t)
1597 (isearch-clean-overlays)
1598 (let ((default (car occur-collect-regexp-history)))
1599 (read-string
1600 (format "Regexp to collect (default %s): " default)
1601 nil 'occur-collect-regexp-history default)))
1602 ;; Otherwise normal occur takes numerical prefix argument.
1603 (when current-prefix-arg
1604 (prefix-numeric-value current-prefix-arg))))))
1605 (let ((case-fold-search isearch-case-fold-search)
1606 ;; Set `search-upper-case' to nil to not call
1607 ;; `isearch-no-upper-case-p' in `occur-1'.
1608 (search-upper-case nil)
1609 (search-spaces-regexp (isearch-whitespace-regexp)))
1610 (occur regexp nlines)))
1612 (declare-function hi-lock-read-face-name "hi-lock" ())
1614 (defun isearch-highlight-regexp ()
1615 "Run `highlight-regexp' with regexp from the current search string.
1616 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1617 argument from the last search regexp or a quoted search string,
1618 and reads its face argument using `hi-lock-read-face-name'."
1619 (interactive)
1620 (let (
1621 ;; Set `isearch-recursive-edit' to nil to prevent calling
1622 ;; `exit-recursive-edit' in `isearch-done' that terminates
1623 ;; the execution of this command when it is non-nil.
1624 ;; We call `exit-recursive-edit' explicitly at the end below.
1625 (isearch-recursive-edit nil))
1626 (isearch-done nil t)
1627 (isearch-clean-overlays))
1628 (require 'hi-lock nil t)
1629 (let ((string (cond (isearch-regexp isearch-string)
1630 ((if (and (eq isearch-case-fold-search t)
1631 search-upper-case)
1632 (isearch-no-upper-case-p
1633 isearch-string isearch-regexp)
1634 isearch-case-fold-search)
1635 ;; Turn isearch-string into a case-insensitive
1636 ;; regexp.
1637 (mapconcat
1638 (lambda (c)
1639 (let ((s (string c)))
1640 (if (string-match "[[:alpha:]]" s)
1641 (format "[%s%s]" (upcase s) (downcase s))
1642 (regexp-quote s))))
1643 isearch-string ""))
1644 (t (regexp-quote isearch-string)))))
1645 (hi-lock-face-buffer string (hi-lock-read-face-name)))
1646 (and isearch-recursive-edit (exit-recursive-edit)))
1648 \f
1649 (defun isearch-delete-char ()
1650 "Discard last input item and move point back.
1651 If no previous match was done, just beep."
1652 (interactive)
1653 (if (null (cdr isearch-cmds))
1654 (ding)
1655 (isearch-pop-state))
1656 (isearch-update))
1658 (defun isearch-del-char (&optional arg)
1659 "Delete character from end of search string and search again.
1660 If search string is empty, just beep."
1661 (interactive "p")
1662 (if (= 0 (length isearch-string))
1663 (ding)
1664 (setq isearch-string (substring isearch-string 0 (- (or arg 1)))
1665 isearch-message (mapconcat 'isearch-text-char-description
1666 isearch-string "")))
1667 ;; Use the isearch-other-end as new starting point to be able
1668 ;; to find the remaining part of the search string again.
1669 (if isearch-other-end (goto-char isearch-other-end))
1670 (isearch-search)
1671 (isearch-push-state)
1672 (isearch-update))
1674 (defun isearch-yank-string (string)
1675 "Pull STRING into search string."
1676 ;; Downcase the string if not supposed to case-fold yanked strings.
1677 (if (and isearch-case-fold-search
1678 (eq 'not-yanks search-upper-case))
1679 (setq string (downcase string)))
1680 (if isearch-regexp (setq string (regexp-quote string)))
1681 ;; Don't move cursor in reverse search.
1682 (setq isearch-yank-flag t)
1683 (isearch-process-search-string
1684 string (mapconcat 'isearch-text-char-description string "")))
1686 (defun isearch-yank-kill ()
1687 "Pull string from kill ring into search string."
1688 (interactive)
1689 (isearch-yank-string (current-kill 0)))
1691 (defun isearch-yank-pop ()
1692 "Replace just-yanked search string with previously killed string."
1693 (interactive)
1694 (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop)))
1695 ;; Fall back on `isearch-yank-kill' for the benefits of people
1696 ;; who are used to the old behavior of `M-y' in isearch mode. In
1697 ;; future, this fallback may be changed if we ever change
1698 ;; `yank-pop' to do something like the kill-ring-browser.
1699 (isearch-yank-kill)
1700 (isearch-pop-state)
1701 (isearch-yank-string (current-kill 1))))
1703 (defun isearch-yank-x-selection ()
1704 "Pull current X selection into search string."
1705 (interactive)
1706 (isearch-yank-string (x-get-selection))
1707 ;; If `x-get-selection' returned the text from the active region,
1708 ;; then it "used" the mark which we should hence deactivate.
1709 (when select-active-regions (deactivate-mark)))
1712 (defun isearch-mouse-2 (click)
1713 "Handle mouse-2 in Isearch mode.
1714 For a click in the echo area, invoke `isearch-yank-x-selection'.
1715 Otherwise invoke whatever the calling mouse-2 command sequence
1716 is bound to outside of Isearch."
1717 (interactive "e")
1718 (let* ((w (posn-window (event-start click)))
1719 (overriding-terminal-local-map nil)
1720 (binding (key-binding (this-command-keys-vector) t)))
1721 (if (and (window-minibuffer-p w)
1722 (not (minibuffer-window-active-p w))) ; in echo area
1723 (isearch-yank-x-selection)
1724 (when (functionp binding)
1725 (call-interactively binding)))))
1727 (defun isearch-yank-internal (jumpform)
1728 "Pull the text from point to the point reached by JUMPFORM.
1729 JUMPFORM is a lambda expression that takes no arguments and returns
1730 a buffer position, possibly having moved point to that position.
1731 For example, it might move point forward by a word and return point,
1732 or it might return the position of the end of the line."
1733 (isearch-yank-string
1734 (save-excursion
1735 (and (not isearch-forward) isearch-other-end
1736 (goto-char isearch-other-end))
1737 (buffer-substring-no-properties (point) (funcall jumpform)))))
1739 (defun isearch-yank-char-in-minibuffer (&optional arg)
1740 "Pull next character from buffer into end of search string in minibuffer."
1741 (interactive "p")
1742 (if (eobp)
1743 (insert
1744 (with-current-buffer (cadr (buffer-list))
1745 (buffer-substring-no-properties
1746 (point) (progn (forward-char arg) (point)))))
1747 (forward-char arg)))
1749 (defun isearch-yank-char (&optional arg)
1750 "Pull next character from buffer into search string."
1751 (interactive "p")
1752 (isearch-yank-internal (lambda () (forward-char arg) (point))))
1754 (declare-function subword-forward "subword" (&optional arg))
1755 (defun isearch-yank-word-or-char ()
1756 "Pull next character, subword or word from buffer into search string.
1757 Subword is used when `subword-mode' is activated. "
1758 (interactive)
1759 (isearch-yank-internal
1760 (lambda ()
1761 (if (or (= (char-syntax (or (char-after) 0)) ?w)
1762 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
1763 (if (and (boundp 'subword-mode) subword-mode)
1764 (subword-forward 1)
1765 (forward-word 1))
1766 (forward-char 1)) (point))))
1768 (defun isearch-yank-word ()
1769 "Pull next word from buffer into search string."
1770 (interactive)
1771 (isearch-yank-internal (lambda () (forward-word 1) (point))))
1773 (defun isearch-yank-line ()
1774 "Pull rest of line from buffer into search string."
1775 (interactive)
1776 (isearch-yank-internal
1777 (lambda () (let ((inhibit-field-text-motion t))
1778 (line-end-position (if (eolp) 2 1))))))
1780 (defun isearch-search-and-update ()
1781 ;; Do the search and update the display.
1782 (when (or isearch-success
1783 ;; Unsuccessful regexp search may become successful by
1784 ;; addition of characters which make isearch-string valid
1785 isearch-regexp
1786 ;; If the string was found but was completely invisible,
1787 ;; it might now be partly visible, so try again.
1788 (prog1 isearch-hidden (setq isearch-hidden nil)))
1789 ;; In reverse search, adding stuff at
1790 ;; the end may cause zero or many more chars to be
1791 ;; matched, in the string following point.
1792 ;; Allow all those possibilities without moving point as
1793 ;; long as the match does not extend past search origin.
1794 (if (and (not isearch-forward) (not isearch-adjusted)
1795 (condition-case ()
1796 (let ((case-fold-search isearch-case-fold-search))
1797 (if (and (eq case-fold-search t) search-upper-case)
1798 (setq case-fold-search
1799 (isearch-no-upper-case-p isearch-string isearch-regexp)))
1800 (looking-at (cond
1801 ((functionp isearch-word)
1802 (funcall isearch-word isearch-string t))
1803 (isearch-word (word-search-regexp isearch-string t))
1804 (isearch-regexp isearch-string)
1805 (t (regexp-quote isearch-string)))))
1806 (error nil))
1807 (or isearch-yank-flag
1808 (<= (match-end 0)
1809 (min isearch-opoint isearch-barrier))))
1810 (progn
1811 (setq isearch-success t
1812 isearch-error nil
1813 isearch-other-end (match-end 0))
1814 (if (and (eq isearch-case-fold-search t) search-upper-case)
1815 (setq isearch-case-fold-search
1816 (isearch-no-upper-case-p isearch-string isearch-regexp))))
1817 ;; Not regexp, not reverse, or no match at point.
1818 (if (and isearch-other-end (not isearch-adjusted))
1819 (goto-char (if isearch-forward isearch-other-end
1820 (min isearch-opoint
1821 isearch-barrier
1822 (1+ isearch-other-end)))))
1823 (isearch-search)
1824 ))
1825 (isearch-push-state)
1826 (if isearch-op-fun (funcall isearch-op-fun))
1827 (isearch-update))
1830 ;; *, ?, }, and | chars can make a regexp more liberal.
1831 ;; They can make a regexp match sooner or make it succeed instead of failing.
1832 ;; So go back to place last successful search started
1833 ;; or to the last ^S/^R (barrier), whichever is nearer.
1834 ;; + needs no special handling because the string must match at least once.
1836 (defun isearch-backslash (str)
1837 "Return t if STR ends in an odd number of backslashes."
1840 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
1841 "Return point to previous successful match to allow regexp liberalization.
1844 stopping at `isearch-barrier' as needed.
1846 Do nothing if a backslash is escaping the liberalizing character.
1849 Do nothing if regexp has recently been invalid unless optional
1850 ALLOW-INVALID non-nil.
1852 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
1853 to the barrier."
1854 ;; (eq (not a) (not b)) makes all non-nil values equivalent
1855 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
1856 (not want-backslash))
1857 ;; We have to check 2 stack frames because the last might be
1858 ;; invalid just because of a backslash.
1859 (or (not isearch-error)
1860 (not (isearch--state-error (cadr isearch-cmds)))
1861 allow-invalid))
1862 (if to-barrier
1863 (progn (goto-char isearch-barrier)
1864 (setq isearch-adjusted t))
1865 (let* ((stack isearch-cmds)
1866 (previous (cdr stack)) ; lookbelow in the stack
1867 (frame (car stack)))
1868 ;; Walk down the stack looking for a valid regexp (as of course only
1869 ;; they can be the previous successful match); this conveniently
1870 ;; removes all bracket-sets and groups that might be in the way, as
1871 ;; well as partial \{\} constructs that the code below leaves behind.
1872 ;; Also skip over postfix operators -- though horrid,
1873 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
1874 (while (and previous
1875 (or (isearch--state-error frame)
1876 (let* ((string (isearch--state-string frame))
1877 (lchar (aref string (1- (length string)))))
1878 ;; The operators aren't always operators; check
1879 ;; backslashes. This doesn't handle the case of
1880 ;; operators at the beginning of the regexp not
1881 ;; being special, but then we should fall back to
1882 ;; the barrier anyway because it's all optional.
1883 (if (isearch-backslash
1884 (isearch--state-string (car previous)))
1885 (eq lchar ?\})
1886 (memq lchar '(?* ?? ?+))))))
1887 (setq stack previous previous (cdr previous) frame (car stack)))
1888 (when stack
1889 ;; `stack' now refers the most recent valid regexp that is not at
1890 ;; all optional in its last term. Now dig one level deeper and find
1891 ;; what matched before that.
1892 (let ((last-other-end
1893 (or (and (car previous)
1894 (isearch--state-other-end (car previous)))
1895 isearch-barrier)))
1896 (goto-char (if isearch-forward
1897 (max last-other-end isearch-barrier)
1898 (min last-other-end isearch-barrier)))
1899 (setq isearch-adjusted t)))))))
1901 (defun isearch-unread-key-sequence (keylist)
1902 "Unread the given key-sequence KEYLIST.
1903 Scroll-bar or mode-line events are processed appropriately."
1904 (cancel-kbd-macro-events)
1905 (apply 'isearch-unread keylist)
1906 ;; If the event was a scroll-bar or mode-line click, the event will have
1907 ;; been prefixed by a symbol such as vertical-scroll-bar. We must remove
1908 ;; it here, because this symbol will be attached to the event again next
1909 ;; time it gets read by read-key-sequence.
1910 ;;
1911 ;; (Old comment from isearch-other-meta-char: "Note that we don't have to
1912 ;; modify the event anymore in 21 because read_key_sequence no longer
1913 ;; modifies events to produce fake prefix keys.")
1914 (if (and (> (length keylist) 1)
1915 (symbolp (car keylist))
1916 (listp (cadr keylist))
1917 (not (numberp (posn-point
1918 (event-start (cadr keylist) )))))
1919 (pop unread-command-events)))
1921 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1922 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
1923 ;;
1924 ;; The idea here is that certain vertical scrolling commands (like C-l
1925 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
1926 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
1927 ;; tamper with isearch's state, or move point. It is unacceptable for the
1928 ;; search string to be scrolled out of the current window. If a command
1929 ;; attempts this, we scroll the text back again.
1930 ;;
1931 ;; We implement this feature with a property called `isearch-scroll'.
1932 ;; If a command's symbol has the value t for this property or for the
1933 ;; `scroll-command' property, it is a scrolling command. The feature
1934 ;; needs to be enabled by setting the customizable variable
1935 ;; `isearch-allow-scroll' to a non-nil value.
1936 ;;
1937 ;; The universal argument commands (e.g. C-u) in simple.el are marked
1938 ;; as scrolling commands, and isearch.el has been amended to allow
1939 ;; prefix arguments to be passed through to scrolling commands. Thus
1940 ;; M-0 C-l will scroll point to the top of the window.
1941 ;;
1942 ;; Horizontal scrolling commands are currently not catered for.
1943 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1945 ;; Set the isearch-scroll property on some standard functions:
1946 ;; Scroll-bar functions:
1947 (if (fboundp 'scroll-bar-toolkit-scroll)
1948 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
1949 (if (fboundp 'w32-handle-scroll-bar-event)
1950 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
1952 ;; Commands which scroll the window (some scroll commands
1953 ;; already have the `scroll-command' property on them):
1954 (put 'recenter 'isearch-scroll t)
1955 (put 'recenter-top-bottom 'isearch-scroll t)
1956 (put 'reposition-window 'isearch-scroll t)
1958 ;; Commands which act on the other window
1959 (put 'list-buffers 'isearch-scroll t)
1960 (put 'scroll-other-window 'isearch-scroll t)
1961 (put 'scroll-other-window-down 'isearch-scroll t)
1962 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
1963 (put 'end-of-buffer-other-window 'isearch-scroll t)
1965 ;; Commands which change the window layout
1966 (put 'delete-other-windows 'isearch-scroll t)
1967 (put 'balance-windows 'isearch-scroll t)
1968 (put 'split-window-right 'isearch-scroll t)
1969 (put 'split-window-below 'isearch-scroll t)
1970 (put 'enlarge-window 'isearch-scroll t)
1972 ;; Aliases for split-window-*
1973 (put 'split-window-vertically 'isearch-scroll t)
1974 (put 'split-window-horizontally 'isearch-scroll t)
1976 ;; Universal argument commands
1977 (put 'universal-argument 'isearch-scroll t)
1978 (put 'negative-argument 'isearch-scroll t)
1979 (put 'digit-argument 'isearch-scroll t)
1981 (defcustom isearch-allow-scroll nil
1982 "Whether scrolling is allowed during incremental search.
1983 If non-nil, scrolling commands can be used in Isearch mode.
1984 However, the current match will never scroll offscreen.
1985 If nil, scrolling commands will first cancel Isearch mode."
1986 :type 'boolean
1987 :group 'isearch)
1989 (defun isearch-string-out-of-window (isearch-point)
1990 "Test whether the search string is currently outside of the window.
1991 Return nil if it's completely visible, or if point is visible,
1992 together with as much of the search string as will fit; the symbol
1993 `above' if we need to scroll the text downwards; the symbol `below',
1994 if upwards."
1995 (let ((w-start (window-start))
1996 (w-end (window-end nil t))
1997 (w-L1 (save-excursion (move-to-window-line 1) (point)))
1998 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
1999 start end) ; start and end of search string in buffer
2000 (if isearch-forward
2001 (setq end isearch-point start (or isearch-other-end isearch-point))
2002 (setq start isearch-point end (or isearch-other-end isearch-point)))
2003 (cond ((or (and (>= start w-start) (<= end w-end))
2004 (if isearch-forward
2005 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
2006 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
2007 nil)
2008 ((and (< start w-start)
2009 (< isearch-point w-L-1))
2010 'above)
2011 (t 'below))))
2013 (defun isearch-back-into-window (above isearch-point)
2014 "Scroll the window to bring the search string back into view.
2015 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
2016 search string is above the top of the window, nil when it is beneath
2017 the bottom."
2018 (let (start end)
2019 (if isearch-forward
2020 (setq end isearch-point start (or isearch-other-end isearch-point))
2021 (setq start isearch-point end (or isearch-other-end isearch-point)))
2022 (if above
2023 (progn
2024 (goto-char start)
2025 (recenter 0)
2026 (when (>= isearch-point (window-end nil t))
2027 (goto-char isearch-point)
2028 (recenter -1)))
2029 (goto-char end)
2030 (recenter -1)
2031 (when (< isearch-point (window-start))
2032 (goto-char isearch-point)
2033 (recenter 0))))
2034 (goto-char isearch-point))
2036 (defun isearch-reread-key-sequence-naturally (keylist)
2037 "Reread key sequence KEYLIST with an inactive Isearch-mode keymap.
2038 Return the key sequence as a string/vector."
2039 (isearch-unread-key-sequence keylist)
2040 (let (overriding-terminal-local-map)
2041 (read-key-sequence nil))) ; This will go through function-key-map, if nec.
2043 (defun isearch-lookup-scroll-key (key-seq)
2044 "If KEY-SEQ is bound to a scrolling command, return it as a symbol.
2045 Otherwise return nil."
2046 (let* ((overriding-terminal-local-map nil)
2047 (binding (key-binding key-seq)))
2048 (and binding (symbolp binding) (commandp binding)
2049 (or (eq (get binding 'isearch-scroll) t)
2050 (eq (get binding 'scroll-command) t))
2051 binding)))
2053 (defalias 'isearch-other-control-char 'isearch-other-meta-char)
2055 (defun isearch-other-meta-char (&optional arg)
2056 "Process a miscellaneous key sequence in Isearch mode.
2058 Try to convert the current key-sequence to something usable in Isearch
2059 mode, either by converting it with `function-key-map', downcasing a
2061 it. \(In the last case, we may have to read more events.) If so,
2062 either unread the converted sequence or execute the command.
2064 Otherwise, if `search-exit-option' is non-nil (the default) unread the
2065 key-sequence and exit the search normally. If it is the symbol
2066 `edit', the search string is edited in the minibuffer and the meta
2067 character is unread so that it applies to editing the string.
2069 ARG is the prefix argument. It will be transmitted through to the
2070 scrolling command or to the command whose key-sequence exits
2071 Isearch mode."
2072 (interactive "P")
2073 (let* ((key (if current-prefix-arg ; not nec the same as ARG
2074 (substring (this-command-keys) universal-argument-num-events)
2075 (this-command-keys)))
2076 (main-event (aref key 0))
2077 (keylist (listify-key-sequence key))
2078 scroll-command isearch-point)
2079 (cond ((and (= (length key) 1)
2080 (let ((lookup (lookup-key local-function-key-map key)))
2081 (not (or (null lookup) (integerp lookup)
2082 (keymapp lookup)))))
2083 ;; Handle a function key that translates into something else.
2084 ;; If the key has a global definition too,
2085 ;; exit and unread the key itself, so its global definition runs.
2086 ;; Otherwise, unread the translation,
2087 ;; so that the translated key takes effect within isearch.
2088 (cancel-kbd-macro-events)
2089 (if (lookup-key global-map key)
2090 (progn
2091 (isearch-done)
2092 (setq prefix-arg arg)
2093 (apply 'isearch-unread keylist))
2094 (setq keylist
2095 (listify-key-sequence (lookup-key local-function-key-map key)))
2096 (while keylist
2097 (setq key (car keylist))
2098 ;; If KEY is a printing char, we handle it here
2099 ;; directly to avoid the input method and keyboard
2100 ;; coding system translating it.
2101 (if (and (integerp key)
2102 (>= key ?\s) (/= key 127) (< key 256))
2103 (progn
2104 (isearch-process-search-char key)
2105 (setq keylist (cdr keylist)))
2106 ;; As the remaining keys in KEYLIST can't be handled
2107 ;; here, we must reread them.
2108 (setq prefix-arg arg)
2109 (apply 'isearch-unread keylist)
2110 (setq keylist nil)))))
2111 (
2112 ;; Handle an undefined shifted control character
2113 ;; by downshifting it if that makes it defined.
2114 ;; (As read-key-sequence would normally do,
2115 ;; if we didn't have a default definition.)
2116 (let ((mods (event-modifiers main-event)))
2117 (and (integerp main-event)
2118 (memq 'shift mods)
2119 (memq 'control mods)
2120 (not (memq (lookup-key isearch-mode-map
2121 (let ((copy (copy-sequence key)))
2122 (aset copy 0
2123 (- main-event
2124 (- ?\C-\S-a ?\C-a)))
2125 copy)
2126 nil)
2127 '(nil
2128 isearch-other-control-char)))))
2129 (setcar keylist (- main-event (- ?\C-\S-a ?\C-a)))
2130 (cancel-kbd-macro-events)
2131 (setq prefix-arg arg)
2132 (apply 'isearch-unread keylist))
2133 ((eq search-exit-option 'edit)
2134 (setq prefix-arg arg)
2135 (apply 'isearch-unread keylist)
2136 (isearch-edit-string))
2137 ;; Handle a scrolling function.
2138 ((and isearch-allow-scroll
2139 (progn (setq key (isearch-reread-key-sequence-naturally keylist))
2140 (setq keylist (listify-key-sequence key))
2141 (setq main-event (aref key 0))
2142 (setq scroll-command (isearch-lookup-scroll-key key))))
2143 ;; From this point onwards, KEY, KEYLIST and MAIN-EVENT hold a
2144 ;; complete key sequence, possibly as modified by function-key-map,
2145 ;; not merely the one or two event fragment which invoked
2146 ;; isearch-other-meta-char in the first place.
2147 (setq isearch-point (point))
2148 (setq prefix-arg arg)
2149 (command-execute scroll-command)
2150 (let ((ab-bel (isearch-string-out-of-window isearch-point)))
2151 (if ab-bel
2152 (isearch-back-into-window (eq ab-bel 'above) isearch-point)
2153 (goto-char isearch-point)))
2154 (isearch-update))
2155 ;; A mouse click on the isearch message starts editing the search string
2156 ((and (eq (car-safe main-event) 'down-mouse-1)
2157 (window-minibuffer-p (posn-window (event-start main-event))))
2158 ;; Swallow the up-event.
2159 (read-event)
2160 (isearch-edit-string))
2161 (search-exit-option
2162 (let (window)
2163 (setq prefix-arg arg)
2164 (isearch-unread-key-sequence keylist)
2165 (setq main-event (car unread-command-events))
2167 ;; If we got a mouse click event, that event contains the
2168 ;; window clicked on. maybe it was read with the buffer
2169 ;; it was clicked on. If so, that buffer, not the current one,
2170 ;; is in isearch mode. So end the search in that buffer.
2172 ;; ??? I have no idea what this if checks for, but it's
2173 ;; obviously wrong for the case that a down-mouse event
2174 ;; on another window invokes this function. The event
2175 ;; will contain the window clicked on and that window's
2176 ;; buffer is certainly not always in Isearch mode.
2177 ;;
2178 ;; Leave the code in, but check for current buffer not
2179 ;; being in Isearch mode for now, until someone tells
2180 ;; what it's really supposed to do.
2181 ;;
2182 ;; --gerd 2001-08-10.
2184 (if (and (not isearch-mode)
2185 (listp main-event)
2186 (setq window (posn-window (event-start main-event)))
2187 (windowp window)
2188 (or (> (minibuffer-depth) 0)
2189 (not (window-minibuffer-p window))))
2190 (with-current-buffer (window-buffer window)
2191 (isearch-done)
2192 (isearch-clean-overlays))
2193 (isearch-done)
2194 (isearch-clean-overlays)
2195 (setq prefix-arg arg))))
2196 (t;; otherwise nil
2197 (isearch-process-search-string key key)))))
2199 (defun isearch-quote-char ()
2200 "Quote special characters for incremental search."
2201 (interactive)
2202 (let ((char (read-quoted-char (isearch-message t))))
2203 ;; Assume character codes 0200 - 0377 stand for characters in some
2204 ;; single-byte character set, and convert them to Emacs
2205 ;; characters.
2206 (if (and isearch-regexp (= char ?\s))
2207 (if (subregexp-context-p isearch-string (length isearch-string))
2208 (isearch-process-search-string "[ ]" " ")
2209 (isearch-process-search-char char))
2210 (and enable-multibyte-characters
2213 (setq char (unibyte-char-to-multibyte char)))
2214 (isearch-process-search-char char))))
2216 (defun isearch-printing-char ()
2217 "Add this ordinary printing character to the search string and search."
2218 (interactive)
2219 (let ((char last-command-event))
2220 (if (= char ?\S-\ )
2221 (setq char ?\s))
2222 (if current-input-method
2223 (isearch-process-search-multibyte-characters char)
2224 (isearch-process-search-char char))))
2226 (defun isearch-process-search-char (char)
2227 ;; * and ? are special in regexps when not preceded by \.
2228 ;; } and | are special in regexps when preceded by \.
2229 ;; Nothing special for + because it matches at least once.
2230 (cond
2231 ((memq char '(?* ??)) (isearch-fallback nil))
2232 ((eq char ?\}) (isearch-fallback t t))
2233 ((eq char ?|) (isearch-fallback t nil t)))
2235 ;; Append the char to the search string, update the message and re-search.
2236 (isearch-process-search-string
2237 (char-to-string char)
2239 (char-to-string char)
2240 (isearch-text-char-description char))))
2242 (defun isearch-process-search-string (string message)
2243 (setq isearch-string (concat isearch-string string)
2244 isearch-message (concat isearch-message message))
2245 (isearch-search-and-update))
2247 \f
2248 ;; Search Ring
2250 (defun isearch-ring-adjust1 (advance)
2251 ;; Helper for isearch-ring-adjust
2252 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2253 (length (length ring))
2254 (yank-pointer-name (if isearch-regexp
2255 'regexp-search-ring-yank-pointer
2256 'search-ring-yank-pointer))
2257 (yank-pointer (eval yank-pointer-name)))
2258 (if (zerop length)
2259 ()
2260 (set yank-pointer-name
2261 (setq yank-pointer
2262 (mod (+ (or yank-pointer (if advance 0 -1))
2263 (if advance -1 1))
2264 length)))
2265 (setq isearch-string (nth yank-pointer ring)
2266 isearch-message (mapconcat 'isearch-text-char-description
2267 isearch-string "")))))
2269 (defun isearch-ring-adjust (advance)
2270 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2271 (isearch-ring-adjust1 advance)
2272 (if search-ring-update
2273 (progn
2274 (isearch-search)
2275 (isearch-push-state)
2276 (isearch-update))
2277 ;; Otherwise, edit the search string instead. Note that there is
2278 ;; no need to push the search state after isearch-edit-string here
2279 ;; since isearch-edit-string already pushes its state
2280 (isearch-edit-string)))
2282 (defun isearch-ring-advance ()
2283 "Advance to the next search string in the ring."
2284 ;; This could be more general to handle a prefix arg, but who would use it.
2285 (interactive)
2286 (isearch-ring-adjust 'advance))
2288 (defun isearch-ring-retreat ()
2289 "Retreat to the previous search string in the ring."
2290 (interactive)
2291 (isearch-ring-adjust nil))
2293 (defun isearch-complete1 ()
2294 ;; Helper for isearch-complete and isearch-complete-edit
2295 ;; Return t if completion OK, nil if no completion exists.
2296 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2297 (completion-ignore-case case-fold-search)
2298 (completion (try-completion isearch-string ring)))
2299 (cond
2300 ((eq completion t)
2301 ;; isearch-string stays the same
2302 t)
2303 ((or completion ; not nil, must be a string
2304 (= 0 (length isearch-string))) ; shouldn't have to say this
2305 (if (equal completion isearch-string) ;; no extension?
2306 (progn
2307 (if completion-auto-help
2308 (with-output-to-temp-buffer "*Isearch completions*"
2309 (display-completion-list
2310 (all-completions isearch-string ring))))
2311 t)
2312 (and completion
2313 (setq isearch-string completion))))
2314 (t
2315 (message "No completion") ; waits a second if in minibuffer
2316 nil))))
2318 (defun isearch-complete ()
2319 "Complete the search string from the strings on the search ring.
2320 The completed string is then editable in the minibuffer.
2321 If there is no completion possible, say so and continue searching."
2322 (interactive)
2323 (if (isearch-complete1)
2324 (progn (setq isearch-message
2325 (mapconcat 'isearch-text-char-description
2326 isearch-string ""))
2327 (isearch-edit-string))
2328 ;; else
2329 (sit-for 1)
2330 (isearch-update)))
2332 (defun isearch-complete-edit ()
2333 "Same as `isearch-complete' except in the minibuffer."
2334 (interactive)
2335 (setq isearch-string (field-string))
2336 (if (isearch-complete1)
2337 (progn
2338 (delete-field)
2339 (insert isearch-string))))
2341 \f
2342 ;; Message string
2344 (defun isearch-message (&optional c-q-hack ellipsis)
2345 ;; Generate and print the message string.
2346 (let ((cursor-in-echo-area ellipsis)
2347 (m isearch-message)
2348 (fail-pos (isearch-fail-pos t)))
2349 ;; Highlight failed part
2350 (when fail-pos
2351 (setq m (copy-sequence m))
2352 (add-text-properties fail-pos (length m) '(face isearch-fail) m)
2353 ;; Highlight failed trailing whitespace
2354 (when (string-match " +$" m)
2355 (add-text-properties (match-beginning 0) (match-end 0)
2356 '(face trailing-whitespace) m)))
2357 (setq m (concat
2358 (isearch-message-prefix ellipsis isearch-nonincremental)
2359 m
2360 (isearch-message-suffix c-q-hack)))
2361 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2363 (defun isearch-message-prefix (&optional ellipsis nonincremental)
2364 ;; If about to search, and previous search regexp was invalid,
2365 ;; check that it still is. If it is valid now,
2366 ;; let the message we display while searching say that it is valid.
2367 (and isearch-error ellipsis
2368 (condition-case ()
2369 (progn (re-search-forward isearch-string (point) t)
2370 (setq isearch-error nil))
2371 (error nil)))
2372 ;; If currently failing, display no ellipsis.
2373 (or isearch-success (setq ellipsis nil))
2374 (let ((m (concat (if isearch-success "" "failing ")
2375 (if isearch-adjusted "pending " "")
2376 (if (and isearch-wrapped
2377 (not isearch-wrap-function)
2378 (if isearch-forward
2379 (> (point) isearch-opoint)
2380 (< (point) isearch-opoint)))
2381 "over")
2382 (if isearch-wrapped "wrapped ")
2383 (if isearch-word
2384 (or (and (symbolp isearch-word)
2385 (get isearch-word 'isearch-message-prefix))
2386 "word ")
2387 "")
2388 (if isearch-regexp "regexp " "")
2389 (if multi-isearch-next-buffer-current-function "multi " "")
2390 (or isearch-message-prefix-add "")
2391 (if nonincremental "search" "I-search")
2392 (if isearch-forward "" " backward")
2393 (if current-input-method
2394 ;; Input methods for RTL languages use RTL
2395 ;; characters for their title, and that messes
2396 ;; up the display of search text after the prompt.
2397 (bidi-string-mark-left-to-right
2398 (concat " [" current-input-method-title "]: "))
2399 ": ")
2400 )))
2401 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2402 'face 'minibuffer-prompt)))
2404 (defun isearch-message-suffix (&optional c-q-hack)
2405 (concat (if c-q-hack "^Q" "")
2406 (if isearch-error
2407 (concat " [" isearch-error "]")
2408 "")
2409 (or isearch-message-suffix-add "")))
2411 \f
2412 ;; Searching
2414 (defvar isearch-search-fun-function 'isearch-search-fun-default
2415 "Non-default value overrides the behavior of `isearch-search-fun-default'.
2416 This variable's value should be a function, which will be called
2417 with no arguments, and should return a function that takes three
2418 arguments: STRING, BOUND, and NOERROR.
2420 This returned function will be used by `isearch-search-string' to
2421 search for the first occurrence of STRING or its translation.")
2423 (defun isearch-search-fun ()
2424 "Return the function to use for the search.
2425 Can be changed via `isearch-search-fun-function' for special needs."
2426 (funcall (or isearch-search-fun-function 'isearch-search-fun-default)))
2428 (defun isearch-search-fun-default ()
2429 "Return default functions to use for the search."
2430 (cond
2431 (isearch-word
2432 (lambda (string &optional bound noerror count)
2433 ;; Use lax versions to not fail at the end of the word while
2434 ;; the user adds and removes characters in the search string
2435 ;; (or when using nonincremental word isearch)
2436 (let ((lax (not (or isearch-nonincremental
2437 (eq (length isearch-string)
2438 (length (isearch--state-string
2439 (car isearch-cmds))))))))
2440 (funcall
2441 (if isearch-forward #'re-search-forward #'re-search-backward)
2442 (if (functionp isearch-word)
2443 (funcall isearch-word string lax)
2444 (word-search-regexp string lax))
2445 bound noerror count))))
2446 (isearch-regexp
2447 (if isearch-forward 're-search-forward 're-search-backward))
2448 (t
2449 (if isearch-forward 'isearch-search-forward 'isearch-search-backward))))
2451 (defun isearch-search-forward (string &optional bound noerror count)
2452 (re-search-forward (regexp-quote string) bound noerror count))
2454 (defun isearch-search-backward (string &optional bound noerror count)
2455 (re-search-backward (regexp-quote string) bound noerror count))
2457 (defun isearch-search-string (string bound noerror)
2458 "Search for the first occurrence of STRING or its translation.
2459 If found, move point to the end of the occurrence,
2460 update the match data, and return point."
2461 (let* ((func (isearch-search-fun))
2462 (pos1 (save-excursion (funcall func string bound noerror)))
2463 pos2)
2464 (when (and
2465 ;; Avoid "obsolete" warnings for translation-table-for-input.
2466 (with-no-warnings
2467 (char-table-p translation-table-for-input))
2468 (multibyte-string-p string)
2469 ;; Minor optimization.
2470 (string-match-p "[^[:ascii:]]" string))
2471 (let ((translated
2472 (apply 'string
2473 (mapcar (lambda (c)
2474 (or
2475 ;; Avoid "obsolete" warnings for
2476 ;; translation-table-for-input.
2477 (with-no-warnings
2478 (aref translation-table-for-input c))
2479 c))
2480 string)))
2481 match-data)
2482 (when translated
2483 (save-match-data
2484 (save-excursion
2485 (if (setq pos2 (funcall func translated bound noerror))
2486 (setq match-data (match-data t)))))
2487 (when (and pos2
2488 (or (not pos1)
2489 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2490 (setq pos1 pos2)
2491 (set-match-data match-data)))))
2492 (when pos1
2493 ;; When using multiple buffers isearch, switch to the new buffer here,
2494 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2495 (if (and multi-isearch-next-buffer-current-function
2496 (buffer-live-p multi-isearch-current-buffer))
2497 (switch-to-buffer multi-isearch-current-buffer))
2498 (goto-char pos1)
2499 pos1)))
2501 (defun isearch-search ()
2502 ;; Do the search with the current search string.
2503 (if isearch-message-function
2504 (funcall isearch-message-function nil t)
2505 (isearch-message nil t))
2506 (if (and (eq isearch-case-fold-search t) search-upper-case)
2507 (setq isearch-case-fold-search
2508 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2509 (condition-case lossage
2510 (let ((inhibit-point-motion-hooks
2511 ;; FIXME: equality comparisons on functions is asking for trouble.
2512 (and (eq isearch-filter-predicate 'isearch-filter-visible)
2513 search-invisible))
2514 (inhibit-quit nil)
2515 (case-fold-search isearch-case-fold-search)
2516 (search-spaces-regexp (isearch-whitespace-regexp))
2517 (retry t))
2518 (setq isearch-error nil)
2519 (while retry
2520 (setq isearch-success
2521 (isearch-search-string isearch-string nil t))
2522 ;; Clear RETRY unless the search predicate says
2523 ;; to skip this search hit.
2524 (if (or (not isearch-success)
2525 (bobp) (eobp)
2526 (= (match-beginning 0) (match-end 0))
2527 (funcall isearch-filter-predicate
2528 (match-beginning 0) (match-end 0)))
2529 (setq retry nil)))
2530 (setq isearch-just-started nil)
2531 (if isearch-success
2532 (setq isearch-other-end
2533 (if isearch-forward (match-beginning 0) (match-end 0)))))
2535 (quit (isearch-unread ?\C-g)
2536 (setq isearch-success nil))
2538 (invalid-regexp
2539 (setq isearch-error (car (cdr lossage)))
2540 (if (string-match
2542 isearch-error)
2543 (setq isearch-error "incomplete input")))
2545 (search-failed
2546 (setq isearch-success nil)
2547 (setq isearch-error (nth 2 lossage)))
2549 (error
2550 ;; stack overflow in regexp search.
2551 (setq isearch-error (format "%s" lossage))))
2553 (if isearch-success
2554 nil
2555 ;; Ding if failed this time after succeeding last time.
2556 (and (isearch--state-success (car isearch-cmds))
2557 (ding))
2558 (if (functionp (isearch--state-pop-fun (car isearch-cmds)))
2559 (funcall (isearch--state-pop-fun (car isearch-cmds))
2560 (car isearch-cmds)))
2561 (goto-char (isearch--state-point (car isearch-cmds)))))
2564 ;; Called when opening an overlay, and we are still in isearch.
2565 (defun isearch-open-overlay-temporary (ov)
2566 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2567 ;; Some modes would want to open the overlays temporary during
2568 ;; isearch in their own way, they should set the
2569 ;; `isearch-open-invisible-temporary' to a function doing this.
2570 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2571 ;; Store the values for the `invisible' and `intangible'
2572 ;; properties, and then set them to nil. This way the text hidden
2573 ;; by this overlay becomes visible.
2575 ;; Do we really need to set the `intangible' property to t? Can we
2576 ;; have the point inside an overlay with an `intangible' property?
2577 ;; In 19.34 this does not exist so I cannot test it.
2578 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2579 (overlay-put ov 'isearch-intangible (overlay-get ov 'intangible))
2580 (overlay-put ov 'invisible nil)
2581 (overlay-put ov 'intangible nil)))
2584 ;; This is called at the end of isearch. It will open the overlays
2585 ;; that contain the latest match. Obviously in case of a C-g the
2586 ;; point returns to the original location which surely is not contain
2587 ;; in any of these overlays, se we are safe in this case too.
2588 (defun isearch-open-necessary-overlays (ov)
2589 (let ((inside-overlay (and (> (point) (overlay-start ov))
2590 (< (point) (overlay-end ov))))
2591 ;; If this exists it means that the overlay was opened using
2592 ;; this function, not by us tweaking the overlay properties.
2593 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2594 (when (or inside-overlay (not fct-temp))
2595 ;; restore the values for the `invisible' and `intangible'
2596 ;; properties
2597 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2598 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2599 (overlay-put ov 'isearch-invisible nil)
2600 (overlay-put ov 'isearch-intangible nil))
2601 (if inside-overlay
2602 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2603 (if fct-temp
2604 (funcall fct-temp ov t)))))
2606 ;; This is called when exiting isearch. It closes the temporary
2607 ;; opened overlays, except the ones that contain the latest match.
2608 (defun isearch-clean-overlays ()
2609 (when isearch-opened-overlays
2610 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2611 (setq isearch-opened-overlays nil)))
2614 (defun isearch-intersects-p (start0 end0 start1 end1)
2615 "Return t if regions START0..END0 and START1..END1 intersect."
2616 (or (and (>= start0 start1) (< start0 end1))
2617 (and (> end0 start1) (<= end0 end1))
2618 (and (>= start1 start0) (< start1 end0))
2619 (and (> end1 start0) (<= end1 end0))))
2622 ;; Verify if the current match is outside of each element of
2623 ;; `isearch-opened-overlays', if so close that overlay.
2625 (defun isearch-close-unnecessary-overlays (begin end)
2626 (let ((overlays isearch-opened-overlays))
2627 (setq isearch-opened-overlays nil)
2628 (dolist (ov overlays)
2629 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2630 (push ov isearch-opened-overlays)
2631 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2632 (if fct-temp
2633 ;; If this exists it means that the overlay was opened
2634 ;; using this function, not by us tweaking the overlay
2635 ;; properties.
2636 (funcall fct-temp ov t)
2637 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2638 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2639 (overlay-put ov 'isearch-invisible nil)
2640 (overlay-put ov 'isearch-intangible nil)))))))
2643 (defun isearch-range-invisible (beg end)
2644 "Return t if all the text from BEG to END is invisible."
2645 (when (/= beg end)
2646 ;; Check that invisibility runs up to END.
2647 (save-excursion
2648 (goto-char beg)
2649 (let (;; can-be-opened keeps track if we can open some overlays.
2650 (can-be-opened (eq search-invisible 'open))
2651 ;; the list of overlays that could be opened
2652 (crt-overlays nil))
2653 (when (and can-be-opened isearch-hide-immediately)
2654 (isearch-close-unnecessary-overlays beg end))
2655 ;; If the following character is currently invisible,
2656 ;; skip all characters with that same `invisible' property value.
2657 ;; Do that over and over.
2658 (while (and (< (point) end) (invisible-p (point)))
2659 (if (invisible-p (get-text-property (point) 'invisible))
2660 (progn
2661 (goto-char (next-single-property-change (point) 'invisible
2662 nil end))
2663 ;; if text is hidden by an `invisible' text property
2664 ;; we cannot open it at all.
2665 (setq can-be-opened nil))
2666 (when can-be-opened
2667 (let ((overlays (overlays-at (point)))
2668 ov-list
2669 o
2670 invis-prop)
2671 (while overlays
2672 (setq o (car overlays)
2673 invis-prop (overlay-get o 'invisible))
2674 (if (invisible-p invis-prop)
2675 (if (overlay-get o 'isearch-open-invisible)
2676 (setq ov-list (cons o ov-list))
2677 ;; We found one overlay that cannot be
2678 ;; opened, that means the whole chunk
2679 ;; cannot be opened.
2680 (setq can-be-opened nil)))
2681 (setq overlays (cdr overlays)))
2682 (if can-be-opened
2683 ;; It makes sense to append to the open
2684 ;; overlays list only if we know that this is
2685 ;; t.
2686 (setq crt-overlays (append ov-list crt-overlays)))))
2687 (goto-char (next-overlay-change (point)))))
2688 ;; See if invisibility reaches up thru END.
2689 (if (>= (point) end)
2690 (if (and can-be-opened (consp crt-overlays))
2691 (progn
2692 (setq isearch-opened-overlays
2693 (append isearch-opened-overlays crt-overlays))
2694 (mapc 'isearch-open-overlay-temporary crt-overlays)
2695 nil)
2696 (setq isearch-hidden t)))))))
2698 (defun isearch-filter-visible (beg end)
2699 "Test whether the current search hit is visible at least partially.
2700 Return non-nil if the text from BEG to END is visible to Isearch as
2701 determined by `isearch-range-invisible' unless invisible text can be
2702 searched too when `search-invisible' is t."
2703 (or (eq search-invisible t)
2704 (not (isearch-range-invisible beg end))))
2706 \f
2707 ;; General utilities
2709 (defun isearch-no-upper-case-p (string regexp-flag)
2710 "Return t if there are no upper case chars in STRING.
2712 since they have special meaning in a regexp."
2713 (let (quote-flag (i 0) (len (length string)) found)
2714 (while (and (not found) (< i len))
2715 (let ((char (aref string i)))
2717 (setq quote-flag (not quote-flag))
2718 (if (and (not quote-flag) (not (eq char (downcase char))))
2719 (setq found t))
2720 (setq quote-flag nil)))
2721 (setq i (1+ i)))
2722 (not (or found
2723 ;; Even if there's no uppercase char, we want to detect the use
2724 ;; of [:upper:] or [:lower:] char-class, which indicates
2725 ;; clearly that the user cares about case distinction.
2727 (condition-case err
2728 (progn
2729 (string-match (substring string 0 (match-beginning 0))
2730 "")
2731 nil)
2732 (invalid-regexp
2733 (equal "Unmatched [ or [^" (cadr err)))))))))
2735 ;; Portability functions to support various Emacs versions.
2737 (defun isearch-text-char-description (c)
2738 (cond
2739 ((< c ?\s) (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph))
2740 ((= c ?\^?) (propertize "^?" 'face 'escape-glyph))
2741 (t (char-to-string c))))
2743 ;; General function to unread characters or events.
2744 ;; Also insert them in a keyboard macro being defined.
2745 (defun isearch-unread (&rest char-or-events)
2746 (mapc 'store-kbd-macro-event char-or-events)
2747 (setq unread-command-events
2748 (append char-or-events unread-command-events)))
2750 \f
2751 ;; Highlighting
2753 (defvar isearch-overlay nil)
2755 (defun isearch-highlight (beg end)
2756 (if search-highlight
2757 (if isearch-overlay
2758 ;; Overlay already exists, just move it.
2759 (move-overlay isearch-overlay beg end (current-buffer))
2760 ;; Overlay doesn't exist, create it.
2761 (setq isearch-overlay (make-overlay beg end))
2762 ;; 1001 is higher than lazy's 1000 and ediff's 100+
2763 (overlay-put isearch-overlay 'priority 1001)
2764 (overlay-put isearch-overlay 'face isearch-face))))
2766 (defun isearch-dehighlight ()
2767 (when isearch-overlay
2768 (delete-overlay isearch-overlay)))
2769 \f
2770 ;; isearch-lazy-highlight feature
2771 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
2773 ;; When active, *every* match for the current search string is
2774 ;; highlighted: the current one using the normal isearch match color
2775 ;; and all the others using `isearch-lazy-highlight'. The extra
2776 ;; highlighting makes it easier to anticipate where the cursor will
2777 ;; land each time you press C-s or C-r to repeat a pending search.
2778 ;; Highlighting of these additional matches happens in a deferred
2779 ;; fashion using "idle timers," so the cycles needed do not rob
2780 ;; isearch of its usual snappy response.
2782 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
2783 ;; Specifically:
2784 ;; - `isearch-update' is expected to be called (at least) every time
2785 ;; the search string or window-start changes;
2786 ;; - `isearch-string' is expected to contain the current search
2787 ;; string as entered by the user;
2788 ;; - the type of the current search is expected to be given by
2789 ;; `isearch-word' and `isearch-regexp';
2790 ;; - the direction of the current search is expected to be given by
2791 ;; `isearch-forward';
2792 ;; - the variable `isearch-error' is expected to be true
2793 ;; only if `isearch-string' is an invalid regexp.
2795 (defvar isearch-lazy-highlight-overlays nil)
2796 (defvar isearch-lazy-highlight-wrapped nil)
2797 (defvar isearch-lazy-highlight-start-limit nil)
2798 (defvar isearch-lazy-highlight-end-limit nil)
2799 (defvar isearch-lazy-highlight-start nil)
2800 (defvar isearch-lazy-highlight-end nil)
2801 (defvar isearch-lazy-highlight-timer nil)
2802 (defvar isearch-lazy-highlight-last-string nil)
2803 (defvar isearch-lazy-highlight-window nil)
2804 (defvar isearch-lazy-highlight-window-start nil)
2805 (defvar isearch-lazy-highlight-window-end nil)
2806 (defvar isearch-lazy-highlight-case-fold-search nil)
2807 (defvar isearch-lazy-highlight-regexp nil)
2808 (defvar isearch-lazy-highlight-space-regexp nil)
2809 (defvar isearch-lazy-highlight-word nil)
2810 (defvar isearch-lazy-highlight-forward nil)
2811 (defvar isearch-lazy-highlight-error nil)
2813 (defun lazy-highlight-cleanup (&optional force)
2814 "Stop lazy highlighting and remove extra highlighting from current buffer.
2815 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
2816 is nil. This function is called when exiting an incremental search if
2817 `lazy-highlight-cleanup' is non-nil."
2818 (interactive '(t))
2819 (if (or force lazy-highlight-cleanup)
2820 (while isearch-lazy-highlight-overlays
2821 (delete-overlay (car isearch-lazy-highlight-overlays))
2822 (setq isearch-lazy-highlight-overlays
2823 (cdr isearch-lazy-highlight-overlays))))
2824 (when isearch-lazy-highlight-timer
2825 (cancel-timer isearch-lazy-highlight-timer)
2826 (setq isearch-lazy-highlight-timer nil)))
2828 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
2829 'lazy-highlight-cleanup
2830 "22.1")
2832 (defun isearch-lazy-highlight-new-loop (&optional beg end)
2833 "Cleanup any previous `lazy-highlight' loop and begin a new one.
2834 BEG and END specify the bounds within which highlighting should occur.
2835 This is called when `isearch-update' is invoked (which can cause the
2836 search string to change or the window to scroll). It is also used
2837 by other Emacs features."
2838 (when (and (null executing-kbd-macro)
2839 (sit-for 0) ;make sure (window-start) is credible
2840 (or (not (equal isearch-string
2841 isearch-lazy-highlight-last-string))
2842 (not (eq (selected-window)
2843 isearch-lazy-highlight-window))
2844 (not (eq isearch-lazy-highlight-case-fold-search
2845 isearch-case-fold-search))
2846 (not (eq isearch-lazy-highlight-regexp
2847 isearch-regexp))
2848 (not (eq isearch-lazy-highlight-word
2849 isearch-word))
2850 (not (= (window-start)
2851 isearch-lazy-highlight-window-start))
2852 (not (= (window-end) ; Window may have been split/joined.
2853 isearch-lazy-highlight-window-end))
2854 (not (eq isearch-forward
2855 isearch-lazy-highlight-forward))
2856 ;; In case we are recovering from an error.
2857 (not (equal isearch-error
2858 isearch-lazy-highlight-error))))
2859 ;; something important did indeed change
2860 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
2861 (setq isearch-lazy-highlight-error isearch-error)
2862 ;; It used to check for `(not isearch-error)' here, but actually
2863 ;; lazy-highlighting might find matches to highlight even when
2864 ;; `isearch-error' is non-nil. (Bug#9918)
2865 (setq isearch-lazy-highlight-start-limit beg
2866 isearch-lazy-highlight-end-limit end)
2867 (setq isearch-lazy-highlight-window (selected-window)
2868 isearch-lazy-highlight-window-start (window-start)
2869 isearch-lazy-highlight-window-end (window-end)
2870 isearch-lazy-highlight-start (point)
2871 isearch-lazy-highlight-end (point)
2872 isearch-lazy-highlight-wrapped nil
2873 isearch-lazy-highlight-last-string isearch-string
2874 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
2875 isearch-lazy-highlight-regexp isearch-regexp
2876 isearch-lazy-highlight-space-regexp (isearch-whitespace-regexp)
2877 isearch-lazy-highlight-word isearch-word
2878 isearch-lazy-highlight-forward isearch-forward)
2879 (unless (equal isearch-string "")
2880 (setq isearch-lazy-highlight-timer
2881 (run-with-idle-timer lazy-highlight-initial-delay nil
2882 'isearch-lazy-highlight-update)))))
2884 (defun isearch-lazy-highlight-search ()
2885 "Search ahead for the next or previous match, for lazy highlighting.
2886 Attempt to do the search exactly the way the pending Isearch would."
2887 (condition-case nil
2888 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
2889 (isearch-regexp isearch-lazy-highlight-regexp)
2890 (search-spaces-regexp isearch-lazy-highlight-space-regexp)
2891 (isearch-word isearch-lazy-highlight-word)
2892 (search-invisible nil) ; don't match invisible text
2893 (retry t)
2894 (success nil)
2895 (isearch-forward isearch-lazy-highlight-forward)
2896 (bound (if isearch-lazy-highlight-forward
2897 (min (or isearch-lazy-highlight-end-limit (point-max))
2898 (if isearch-lazy-highlight-wrapped
2899 isearch-lazy-highlight-start
2900 (window-end)))
2901 (max (or isearch-lazy-highlight-start-limit (point-min))
2902 (if isearch-lazy-highlight-wrapped
2903 isearch-lazy-highlight-end
2904 (window-start))))))
2905 ;; Use a loop like in `isearch-search'.
2906 (while retry
2907 (setq success (isearch-search-string
2908 isearch-lazy-highlight-last-string bound t))
2909 ;; Clear RETRY unless the search predicate says
2910 ;; to skip this search hit.
2911 (if (or (not success)
2912 (= (point) bound) ; like (bobp) (eobp) in `isearch-search'.
2913 (= (match-beginning 0) (match-end 0))
2914 (funcall isearch-filter-predicate
2915 (match-beginning 0) (match-end 0)))
2916 (setq retry nil)))
2917 success)
2918 (error nil)))
2920 (defun isearch-lazy-highlight-update ()
2921 "Update highlighting of other matches for current search."
2922 (let ((max lazy-highlight-max-at-a-time)
2923 (looping t)
2924 nomore)
2925 (with-local-quit
2926 (save-selected-window
2927 (if (and (window-live-p isearch-lazy-highlight-window)
2928 (not (eq (selected-window) isearch-lazy-highlight-window)))
2929 (select-window isearch-lazy-highlight-window))
2930 (save-excursion
2931 (save-match-data
2932 (goto-char (if isearch-lazy-highlight-forward
2933 isearch-lazy-highlight-end
2934 isearch-lazy-highlight-start))
2935 (while looping
2936 (let ((found (isearch-lazy-highlight-search)))
2937 (when max
2938 (setq max (1- max))
2939 (if (<= max 0)
2940 (setq looping nil)))
2941 (if found
2942 (let ((mb (match-beginning 0))
2943 (me (match-end 0)))
2944 (if (= mb me) ;zero-length match
2945 (if isearch-lazy-highlight-forward
2946 (if (= mb (if isearch-lazy-highlight-wrapped
2947 isearch-lazy-highlight-start
2948 (window-end)))
2949 (setq found nil)
2950 (forward-char 1))
2951 (if (= mb (if isearch-lazy-highlight-wrapped
2952 isearch-lazy-highlight-end
2953 (window-start)))
2954 (setq found nil)
2955 (forward-char -1)))
2957 ;; non-zero-length match
2958 (let ((ov (make-overlay mb me)))
2959 (push ov isearch-lazy-highlight-overlays)
2960 ;; 1000 is higher than ediff's 100+,
2961 ;; but lower than isearch main overlay's 1001
2962 (overlay-put ov 'priority 1000)
2963 (overlay-put ov 'face lazy-highlight-face)
2964 (overlay-put ov 'window (selected-window))))
2965 (if isearch-lazy-highlight-forward
2966 (setq isearch-lazy-highlight-end (point))
2967 (setq isearch-lazy-highlight-start (point)))))
2969 ;; not found or zero-length match at the search bound
2970 (if (not found)
2971 (if isearch-lazy-highlight-wrapped
2972 (setq looping nil
2973 nomore t)
2974 (setq isearch-lazy-highlight-wrapped t)
2975 (if isearch-lazy-highlight-forward
2976 (progn
2977 (setq isearch-lazy-highlight-end (window-start))
2978 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
2979 (window-start))))
2980 (setq isearch-lazy-highlight-start (window-end))
2981 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
2982 (window-end))))))))
2983 (unless nomore
2984 (setq isearch-lazy-highlight-timer
2985 (run-at-time lazy-highlight-interval nil
2986 'isearch-lazy-highlight-update)))))))))
2988 (defun isearch-resume (string regexp word forward message case-fold)
2989 "Resume an incremental search.
2990 STRING is the string or regexp searched for.
2991 REGEXP non-nil means the resumed search was a regexp search.
2992 WORD non-nil means resume a word search.
2993 FORWARD non-nil means resume a forward search.
2994 MESSAGE is the echo-area message recorded for the search resumed.
2995 CASE-FOLD non-nil means the search was case-insensitive."
2996 (isearch-mode forward regexp nil nil word)
2997 (setq isearch-string string
2998 isearch-message message
2999 isearch-case-fold-search case-fold)
3000 (isearch-search)
3001 (isearch-update))
3003 ;;; isearch.el ends here