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