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