Replace "Maintainer: FSF" with the emacs-devel mailing address
[emacs.git] / lisp / isearch.el
blobe4611c29f65737ff441efbd82d117d786e094abc
1 ;;; isearch.el --- incremental search minor mode
3 ;; Copyright (C) 1992-1997, 1999-2014 Free Software Foundation, Inc.
5 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Keywords: matching
8 ;; Package: emacs
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; Instructions
29 ;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
30 ;; isearch-mode behaves modally and does not return until the search
31 ;; is completed. It uses a recursive-edit to behave this way.
33 ;; The key bindings active within isearch-mode are defined below in
34 ;; `isearch-mode-map' which is given bindings close to the default
35 ;; characters of the original isearch.el. With `isearch-mode',
36 ;; however, you can bind multi-character keys and it should be easier
37 ;; to add new commands. One bug though: keys with meta-prefix cannot
38 ;; be longer than two chars. Also see minibuffer-local-isearch-map
39 ;; for bindings active during `isearch-edit-string'.
41 ;; isearch-mode should work even if you switch windows with the mouse,
42 ;; in which case isearch-mode is terminated automatically before the
43 ;; switch.
45 ;; The search ring and completion commands automatically put you in
46 ;; the minibuffer to edit the string. This gives you a chance to
47 ;; modify the search string before executing the search. There are
48 ;; three commands to terminate the editing: C-s and C-r exit the
49 ;; minibuffer and search forward and reverse respectively, while C-m
50 ;; exits and searches in the last search direction.
52 ;; Exiting immediately from isearch uses isearch-edit-string instead
53 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
54 ;; The name of this option should probably be changed if we decide to
55 ;; keep the behavior. No point in forcing nonincremental search until
56 ;; the last possible moment.
58 ;;; Code:
60 (eval-when-compile (require 'cl-lib))
62 ;; Some additional options and constants.
64 (defgroup isearch nil
65 "Incremental search minor mode."
66 :link '(emacs-commentary-link "isearch")
67 :link '(custom-manual "(emacs)Incremental Search")
68 :prefix "isearch-"
69 :prefix "search-"
70 :group 'matching)
73 (defcustom search-exit-option t
74 "Non-nil means random control characters terminate incremental search."
75 :type 'boolean
76 :group 'isearch)
78 (defcustom search-slow-window-lines 1
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."
83 :type 'integer
84 :group 'isearch)
86 (defcustom search-slow-speed 1200
87 "Highest terminal speed at which to use \"slow\" style incremental search.
88 This is the style where a one-line window is created to show the line
89 that the search has reached."
90 :type 'integer
91 :group 'isearch)
93 (defcustom search-upper-case 'not-yanks
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
97 apply to chars in regexps that are prefixed with `\\'.
98 If this value is `not-yanks', text yanked into the search string
99 in Isearch mode is always downcased."
100 :type '(choice (const :tag "off" nil)
101 (const not-yanks)
102 (other :tag "on" t))
103 :group 'isearch)
105 (defcustom search-nonincremental-instead t
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."
109 :type 'boolean
110 :group 'isearch)
112 (defcustom search-whitespace-regexp (purecopy "\\s-+")
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.
125 You might want to use something like \"[ \\t\\r\\n]+\" instead.
126 In the Customization buffer, that is `[' followed by a space,
127 a tab, a carriage return (control-M), a newline, and `]+'."
128 :type '(choice (const :tag "Match Spaces Literally" nil)
129 regexp)
130 :group 'isearch
131 :version "24.3")
133 (defcustom search-invisible 'open
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."
142 :type '(choice (const :tag "Match hidden text" t)
143 (const :tag "Open overlays" open)
144 (const :tag "Don't match hidden text" nil))
145 :group 'isearch)
147 (defcustom isearch-hide-immediately t
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 If nil then do not re-hide opened invisible text when the match moves.
151 Whatever the value, all opened invisible text is hidden again after exiting
152 the search."
153 :type 'boolean
154 :group 'isearch)
156 (defcustom isearch-resume-in-command-history nil
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."
160 :type 'boolean
161 :group 'isearch)
163 (defvar isearch-mode-hook nil
164 "Function(s) to call after starting up an incremental search.")
166 (defvar isearch-update-post-hook nil
167 "Function(s) to call after isearch has found matches in the buffer.")
169 (defvar isearch-mode-end-hook nil
170 "Function(s) to call after terminating an incremental search.
171 When these functions are called, `isearch-mode-end-hook-quit'
172 is non-nil if the user quits the search.")
174 (defvar isearch-mode-end-hook-quit nil
175 "Non-nil while running `isearch-mode-end-hook' if the user quits the search.")
177 (defvar isearch-message-function nil
178 "Function to call to display the search prompt.
179 If nil, use function `isearch-message'.")
181 (defvar isearch-wrap-function nil
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,
184 or to the end of the buffer for a backward search.")
186 (defvar isearch-push-state-function nil
187 "Function to save a function restoring the mode-specific Isearch state
188 to the search status stack.")
190 (defvar isearch-filter-predicate #'isearch-filter-visible
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
195 stopping at this match.
196 If you use `add-function' to modify this variable, you can use the
197 `isearch-message-prefix' advice property to specify the prefix string
198 displayed in the search message.")
200 ;; Search ring.
202 (defvar search-ring nil
203 "List of search string sequences.")
204 (defvar regexp-search-ring nil
205 "List of regular expression search string sequences.")
207 (defcustom search-ring-max 16
208 "Maximum length of search ring before oldest elements are thrown away."
209 :type 'integer
210 :group 'isearch)
211 (defcustom regexp-search-ring-max 16
212 "Maximum length of regexp search ring before oldest elements are thrown away."
213 :type 'integer
214 :group 'isearch)
216 (defvar search-ring-yank-pointer nil
217 "Index in `search-ring' of last string reused.
218 It is nil if none yet.")
219 (defvar regexp-search-ring-yank-pointer nil
220 "Index in `regexp-search-ring' of last string reused.
221 It is nil if none yet.")
223 (defcustom search-ring-update nil
224 "Non-nil if advancing or retreating in the search ring should cause search.
225 Default value, nil, means edit the string instead."
226 :type 'boolean
227 :group 'isearch)
229 ;;; isearch highlight customization.
231 (defcustom search-highlight t
232 "Non-nil means incremental search highlights the current match."
233 :type 'boolean
234 :group 'isearch)
236 (defface isearch
237 '((((class color) (min-colors 88) (background light))
238 ;; The background must not be too dark, for that means
239 ;; the character is hard to see when the cursor is there.
240 (:background "magenta3" :foreground "lightskyblue1"))
241 (((class color) (min-colors 88) (background dark))
242 (:background "palevioletred2" :foreground "brown4"))
243 (((class color) (min-colors 16))
244 (:background "magenta4" :foreground "cyan1"))
245 (((class color) (min-colors 8))
246 (:background "magenta4" :foreground "cyan1"))
247 (t (:inverse-video t)))
248 "Face for highlighting Isearch matches."
249 :group 'isearch
250 :group 'basic-faces)
251 (defvar isearch-face 'isearch)
253 (defface isearch-fail
254 '((((class color) (min-colors 88) (background light))
255 (:background "RosyBrown1"))
256 (((class color) (min-colors 88) (background dark))
257 (:background "red4"))
258 (((class color) (min-colors 16))
259 (:background "red"))
260 (((class color) (min-colors 8))
261 (:background "red"))
262 (((class color grayscale))
263 :foreground "grey")
264 (t (:inverse-video t)))
265 "Face for highlighting failed part in Isearch echo-area message."
266 :version "23.1"
267 :group 'isearch)
269 (defcustom isearch-lazy-highlight t
270 "Controls the lazy-highlighting during incremental search.
271 When non-nil, all text in the buffer matching the current search
272 string is highlighted lazily (see `lazy-highlight-initial-delay'
273 and `lazy-highlight-interval')."
274 :type 'boolean
275 :group 'lazy-highlight
276 :group 'isearch)
278 ;;; Lazy highlight customization.
280 (defgroup lazy-highlight nil
281 "Lazy highlighting feature for matching strings."
282 :prefix "lazy-highlight-"
283 :version "21.1"
284 :group 'isearch
285 :group 'matching)
287 (define-obsolete-variable-alias 'isearch-lazy-highlight-cleanup
288 'lazy-highlight-cleanup
289 "22.1")
291 (defcustom lazy-highlight-cleanup t
292 "Controls whether to remove extra highlighting after a search.
293 If this is nil, extra highlighting can be \"manually\" removed with
294 \\[lazy-highlight-cleanup]."
295 :type 'boolean
296 :group 'lazy-highlight)
298 (define-obsolete-variable-alias 'isearch-lazy-highlight-initial-delay
299 'lazy-highlight-initial-delay
300 "22.1")
302 (defcustom lazy-highlight-initial-delay 0.25
303 "Seconds to wait before beginning to lazily highlight all matches."
304 :type 'number
305 :group 'lazy-highlight)
307 (define-obsolete-variable-alias 'isearch-lazy-highlight-interval
308 'lazy-highlight-interval
309 "22.1")
311 (defcustom lazy-highlight-interval 0 ; 0.0625
312 "Seconds between lazily highlighting successive matches."
313 :type 'number
314 :group 'lazy-highlight)
316 (define-obsolete-variable-alias 'isearch-lazy-highlight-max-at-a-time
317 'lazy-highlight-max-at-a-time
318 "22.1")
320 (defcustom lazy-highlight-max-at-a-time 20
321 "Maximum matches to highlight at a time (for `lazy-highlight').
322 Larger values may reduce Isearch's responsiveness to user input;
323 smaller values make matches highlight slowly.
324 A value of nil means highlight all matches."
325 :type '(choice (const :tag "All" nil)
326 (integer :tag "Some"))
327 :group 'lazy-highlight)
329 (defface lazy-highlight
330 '((((class color) (min-colors 88) (background light))
331 (:background "paleturquoise"))
332 (((class color) (min-colors 88) (background dark))
333 (:background "paleturquoise4"))
334 (((class color) (min-colors 16))
335 (:background "turquoise3"))
336 (((class color) (min-colors 8))
337 (:background "turquoise3"))
338 (t (:underline t)))
339 "Face for lazy highlighting of matches other than the current one."
340 :group 'lazy-highlight
341 :group 'basic-faces)
342 (define-obsolete-face-alias 'isearch-lazy-highlight-face 'lazy-highlight "22.1")
343 (define-obsolete-variable-alias 'isearch-lazy-highlight-face
344 'lazy-highlight-face
345 "22.1")
346 (defvar lazy-highlight-face 'lazy-highlight)
348 ;; Define isearch help map.
350 (defvar isearch-help-map
351 (let ((map (make-sparse-keymap)))
352 (define-key map (char-to-string help-char) 'isearch-help-for-help)
353 (define-key map [help] 'isearch-help-for-help)
354 (define-key map [f1] 'isearch-help-for-help)
355 (define-key map "?" 'isearch-help-for-help)
356 (define-key map "b" 'isearch-describe-bindings)
357 (define-key map "k" 'isearch-describe-key)
358 (define-key map "m" 'isearch-describe-mode)
359 (define-key map "q" 'help-quit)
360 map)
361 "Keymap for characters following the Help key for Isearch mode.")
363 (eval-when-compile (require 'help-macro))
365 (make-help-screen isearch-help-for-help-internal
366 (purecopy "Type a help option: [bkm] or ?")
367 "You have typed %THIS-KEY%, the help character. Type a Help option:
368 \(Type \\<help-map>\\[help-quit] to exit the Help command.)
370 b Display all Isearch key bindings.
371 k KEYS Display full documentation of Isearch key sequence.
372 m Display documentation of Isearch mode.
374 You can't type here other help keys available in the global help map,
375 but outside of this help window when you type them in Isearch mode,
376 they exit Isearch mode before displaying global help."
377 isearch-help-map)
379 (defvar isearch--display-help-action '(nil (inhibit-same-window . t)))
381 (defun isearch-help-for-help ()
382 "Display Isearch help menu."
383 (interactive)
384 (let ((display-buffer-overriding-action isearch--display-help-action))
385 (isearch-help-for-help-internal))
386 (isearch-update))
388 (defun isearch-describe-bindings ()
389 "Show a list of all keys defined in Isearch mode, and their definitions.
390 This is like `describe-bindings', but displays only Isearch keys."
391 (interactive)
392 (let ((display-buffer-overriding-action isearch--display-help-action))
393 (with-help-window "*Help*"
394 (with-current-buffer standard-output
395 (princ "Isearch Mode Bindings:\n")
396 (princ (substitute-command-keys "\\{isearch-mode-map}"))))))
398 (defun isearch-describe-key ()
399 "Display documentation of the function invoked by isearch key."
400 (interactive)
401 (let ((display-buffer-overriding-action isearch--display-help-action))
402 (call-interactively 'describe-key))
403 (isearch-update))
405 (defun isearch-describe-mode ()
406 "Display documentation of Isearch mode."
407 (interactive)
408 (let ((display-buffer-overriding-action isearch--display-help-action))
409 (describe-function 'isearch-forward))
410 (isearch-update))
412 (defalias 'isearch-mode-help 'isearch-describe-mode)
415 ;; Define isearch-mode keymap.
417 (defvar isearch-mode-map
418 (let ((i 0)
419 (map (make-keymap)))
420 (or (char-table-p (nth 1 map))
421 (error "The initialization of isearch-mode-map must be updated"))
422 ;; Make all multibyte characters search for themselves.
423 (set-char-table-range (nth 1 map) (cons #x100 (max-char))
424 'isearch-printing-char)
426 ;; Single-byte printing chars extend the search string by default.
427 (setq i ?\s)
428 (while (< i 256)
429 (define-key map (vector i) 'isearch-printing-char)
430 (setq i (1+ i)))
432 ;; To handle local bindings with meta char prefix keys, define
433 ;; another full keymap. This must be done for any other prefix
434 ;; keys as well, one full keymap per char of the prefix key. It
435 ;; would be simpler to disable the global keymap, and/or have a
436 ;; default local key binding for any key not otherwise bound.
437 (let ((meta-map (make-sparse-keymap)))
438 (define-key map (char-to-string meta-prefix-char) meta-map))
440 ;; Several non-printing chars change the searching behavior.
441 (define-key map "\C-s" 'isearch-repeat-forward)
442 (define-key map "\C-r" 'isearch-repeat-backward)
443 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
444 ;; combinations can be used to repeat regexp isearches that can
445 ;; be used to start these searches.
446 (define-key map "\M-\C-s" 'isearch-repeat-forward)
447 (define-key map "\M-\C-r" 'isearch-repeat-backward)
448 (define-key map "\177" 'isearch-delete-char)
449 (define-key map [backspace] 'isearch-delete-char)
450 (define-key map "\C-g" 'isearch-abort)
452 ;; This assumes \e is the meta-prefix-char.
453 (or (= ?\e meta-prefix-char)
454 (error "Inconsistency in isearch.el"))
455 (define-key map "\e\e\e" 'isearch-cancel)
457 (define-key map "\C-q" 'isearch-quote-char)
459 (define-key map "\r" 'isearch-exit)
460 (define-key map [return] 'isearch-exit)
461 (define-key map "\C-j" 'isearch-printing-char)
462 (define-key map "\t" 'isearch-printing-char)
463 (define-key map [?\S-\ ] 'isearch-printing-char)
465 (define-key map "\C-w" 'isearch-yank-word-or-char)
466 (define-key map "\M-\C-w" 'isearch-del-char)
467 (define-key map "\M-\C-y" 'isearch-yank-char)
468 (define-key map "\C-y" 'isearch-yank-kill)
469 (define-key map "\M-s\C-e" 'isearch-yank-line)
471 (define-key map (char-to-string help-char) isearch-help-map)
472 (define-key map [help] isearch-help-map)
473 (define-key map [f1] isearch-help-map)
475 (define-key map "\M-n" 'isearch-ring-advance)
476 (define-key map "\M-p" 'isearch-ring-retreat)
477 (define-key map "\M-y" 'isearch-yank-pop)
479 (define-key map "\M-\t" 'isearch-complete)
481 ;; Pass frame events transparently so they won't exit the search.
482 ;; In particular, if we have more than one display open, then a
483 ;; switch-frame might be generated by someone typing at another keyboard.
484 (define-key map [switch-frame] nil)
485 (define-key map [delete-frame] nil)
486 (define-key map [iconify-frame] nil)
487 (define-key map [make-frame-visible] nil)
488 (define-key map [mouse-movement] nil)
489 (define-key map [language-change] nil)
491 ;; For searching multilingual text.
492 (define-key map "\C-\\" 'isearch-toggle-input-method)
493 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
495 ;; People expect to be able to paste with the mouse.
496 (define-key map [mouse-2] #'isearch-mouse-2)
497 (define-key map [down-mouse-2] nil)
499 ;; Some bindings you may want to put in your isearch-mode-hook.
500 ;; Suggest some alternates...
501 (define-key map "\M-c" 'isearch-toggle-case-fold)
502 (define-key map "\M-r" 'isearch-toggle-regexp)
503 (define-key map "\M-e" 'isearch-edit-string)
505 (put 'isearch-toggle-case-fold :advertised-binding "\M-sc")
506 (put 'isearch-toggle-regexp :advertised-binding "\M-sr")
507 (put 'isearch-edit-string :advertised-binding "\M-se")
509 (define-key map "\M-se" 'isearch-edit-string)
510 (define-key map "\M-sc" 'isearch-toggle-case-fold)
511 (define-key map "\M-si" 'isearch-toggle-invisible)
512 (define-key map "\M-sr" 'isearch-toggle-regexp)
513 (define-key map "\M-sw" 'isearch-toggle-word)
514 (define-key map "\M-s_" 'isearch-toggle-symbol)
515 (define-key map "\M-s " 'isearch-toggle-lax-whitespace)
517 (define-key map [?\M-%] 'isearch-query-replace)
518 (define-key map [?\C-\M-%] 'isearch-query-replace-regexp)
519 (define-key map "\M-so" 'isearch-occur)
520 (define-key map "\M-shr" 'isearch-highlight-regexp)
522 ;; The key translations defined in the C-x 8 prefix should add
523 ;; characters to the search string. See iso-transl.el.
524 (define-key map "\C-x8\r" 'isearch-char-by-name)
526 map)
527 "Keymap for `isearch-mode'.")
529 (defvar minibuffer-local-isearch-map
530 (let ((map (make-sparse-keymap)))
531 (set-keymap-parent map minibuffer-local-map)
532 (define-key map "\r" 'exit-minibuffer)
533 (define-key map "\M-\t" 'isearch-complete-edit)
534 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
535 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
536 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
537 (define-key map [right] 'isearch-yank-char-in-minibuffer)
538 map)
539 "Keymap for editing Isearch strings in the minibuffer.")
541 ;; Internal variables declared globally for byte-compiler.
542 ;; These are all set with setq while isearching
543 ;; and bound locally while editing the search string.
545 (defvar isearch-forward nil) ; Searching in the forward direction.
546 (defvar isearch-regexp nil) ; Searching for a regexp.
547 (defvar isearch-word nil
548 "Regexp-based search mode for words/symbols.
549 If t, do incremental search for a sequence of words, ignoring punctuation.
550 If the value is a function (e.g. `isearch-symbol-regexp'), it is called to
551 convert the search string to a regexp used by regexp search functions.
552 The property `isearch-message-prefix' put on this function specifies the
553 prefix string displayed in the search message.")
555 (defvar isearch-lax-whitespace t
556 "If non-nil, a space will match a sequence of whitespace chars.
557 When you enter a space or spaces in ordinary incremental search, it
558 will match any sequence matched by the regexp defined by the variable
559 `search-whitespace-regexp'. If the value is nil, each space you type
560 matches literally, against one space. You can toggle the value of this
561 variable by the command `isearch-toggle-lax-whitespace'.")
563 (defvar isearch-regexp-lax-whitespace nil
564 "If non-nil, a space will match a sequence of whitespace chars.
565 When you enter a space or spaces in regexp incremental search, it
566 will match any sequence matched by the regexp defined by the variable
567 `search-whitespace-regexp'. If the value is nil, each space you type
568 matches literally, against one space. You can toggle the value of this
569 variable by the command `isearch-toggle-lax-whitespace'.")
571 (defvar isearch-cmds nil
572 "Stack of search status elements.
573 Each element is an `isearch--state' struct where the slots are
574 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
575 INVALID-REGEXP WRAPPED BARRIER WITHIN-BRACKETS CASE-FOLD-SEARCH]")
577 (defvar isearch-string "") ; The current search string.
578 (defvar isearch-message "") ; text-char-description version of isearch-string
580 (defvar isearch-message-prefix-add nil) ; Additional text for the message prefix
581 (defvar isearch-message-suffix-add nil) ; Additional text for the message suffix
583 (defvar isearch-success t) ; Searching is currently successful.
584 (defvar isearch-error nil) ; Error message for failed search.
585 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
586 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
587 (defvar isearch-barrier 0
588 "Recorded minimum/maximal point for the current search.")
589 (defvar isearch-just-started nil)
590 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
592 ;; case-fold-search while searching.
593 ;; either nil, t, or 'yes. 'yes means the same as t except that mixed
594 ;; case in the search string is ignored.
595 (defvar isearch-case-fold-search nil)
597 ;; search-invisible while searching.
598 ;; either nil, t, or 'open. 'open means the same as t except that
599 ;; opens hidden overlays.
600 (defvar isearch-invisible search-invisible)
602 (defvar isearch-last-case-fold-search nil)
604 ;; Used to save default value while isearch is active
605 (defvar isearch-original-minibuffer-message-timeout nil)
607 (defvar isearch-adjusted nil)
608 (defvar isearch-slow-terminal-mode nil)
609 ;; If t, using a small window.
610 (defvar isearch-small-window nil)
611 (defvar isearch-opoint 0)
612 ;; The window configuration active at the beginning of the search.
613 (defvar isearch-window-configuration nil)
615 ;; Flag to indicate a yank occurred, so don't move the cursor.
616 (defvar isearch-yank-flag nil)
618 ;; A function to be called after each input character is processed.
619 ;; (It is not called after characters that exit the search.)
620 ;; It is only set from an optional argument to `isearch-mode'.
621 (defvar isearch-op-fun nil)
623 ;; Is isearch-mode in a recursive edit for modal searching.
624 (defvar isearch-recursive-edit nil)
626 ;; Should isearch be terminated after doing one search?
627 (defvar isearch-nonincremental nil)
629 ;; New value of isearch-forward after isearch-edit-string.
630 (defvar isearch-new-forward nil)
632 ;; Accumulate here the overlays opened during searching.
633 (defvar isearch-opened-overlays nil)
635 ;; Non-nil if the string exists but is invisible.
636 (defvar isearch-hidden nil)
638 ;; The value of input-method-function when isearch is invoked.
639 (defvar isearch-input-method-function nil)
641 ;; A flag to tell if input-method-function is locally bound when
642 ;; isearch is invoked.
643 (defvar isearch-input-method-local-p nil)
645 (defvar isearch--saved-overriding-local-map nil)
647 ;; Minor-mode-alist changes - kind of redundant with the
648 ;; echo area, but if isearching in multiple windows, it can be useful.
650 (or (assq 'isearch-mode minor-mode-alist)
651 (nconc minor-mode-alist
652 (list '(isearch-mode isearch-mode))))
654 (defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
655 (make-variable-buffer-local 'isearch-mode)
657 (define-key global-map "\C-s" 'isearch-forward)
658 (define-key esc-map "\C-s" 'isearch-forward-regexp)
659 (define-key global-map "\C-r" 'isearch-backward)
660 (define-key esc-map "\C-r" 'isearch-backward-regexp)
661 (define-key search-map "w" 'isearch-forward-word)
662 (define-key search-map "_" 'isearch-forward-symbol)
663 (define-key search-map "." 'isearch-forward-symbol-at-point)
665 ;; Entry points to isearch-mode.
667 (defun isearch-forward (&optional regexp-p no-recursive-edit)
669 Do incremental search forward.
670 With a prefix argument, do an incremental regular expression search instead.
671 \\<isearch-mode-map>
672 As you type characters, they add to the search string and are found.
673 The following non-printing keys are bound in `isearch-mode-map'.
675 Type \\[isearch-delete-char] to cancel last input item from end of search string.
676 Type \\[isearch-exit] to exit, leaving point at location found.
677 Type LFD (C-j) to match end of line.
678 Type \\[isearch-repeat-forward] to search again forward,\
679 \\[isearch-repeat-backward] to search again backward.
680 Type \\[isearch-yank-word-or-char] to yank next word or character in buffer
681 onto the end of the search string, and search for it.
682 Type \\[isearch-del-char] to delete character from end of search string.
683 Type \\[isearch-yank-char] to yank char from buffer onto end of search\
684 string and search for it.
685 Type \\[isearch-yank-line] to yank rest of line onto end of search string\
686 and search for it.
687 Type \\[isearch-yank-kill] to yank the last string of killed text.
688 Type \\[isearch-yank-pop] to replace string just yanked into search prompt
689 with string killed before it.
690 Type \\[isearch-quote-char] to quote control character to search for it.
691 Type \\[isearch-char-by-name] to add a character to search by Unicode name,\
692 with completion.
693 \\[isearch-abort] while searching or when search has failed cancels input\
694 back to what has
695 been found successfully.
696 \\[isearch-abort] when search is successful aborts and moves point to\
697 starting point.
699 If you try to exit with the search string still empty, it invokes
700 nonincremental search.
702 Type \\[isearch-toggle-case-fold] to toggle search case-sensitivity.
703 Type \\[isearch-toggle-invisible] to toggle search in invisible text.
704 Type \\[isearch-toggle-regexp] to toggle regular-expression mode.
705 Type \\[isearch-toggle-word] to toggle word mode.
706 Type \\[isearch-toggle-symbol] to toggle symbol mode.
708 Type \\[isearch-toggle-lax-whitespace] to toggle whitespace matching.
709 In incremental searches, a space or spaces normally matches any whitespace
710 defined by the variable `search-whitespace-regexp'; see also the variables
711 `isearch-lax-whitespace' and `isearch-regexp-lax-whitespace'.
713 Type \\[isearch-edit-string] to edit the search string in the minibuffer.
715 Also supported is a search ring of the previous 16 search strings.
716 Type \\[isearch-ring-advance] to search for the next item in the search ring.
717 Type \\[isearch-ring-retreat] to search for the previous item in the search\
718 ring.
719 Type \\[isearch-complete] to complete the search string using the search ring.
721 Type \\[isearch-query-replace] to run `query-replace' with string to\
722 replace from last search string.
723 Type \\[isearch-query-replace-regexp] to run `query-replace-regexp'\
724 with the last search string.
725 Type \\[isearch-occur] to run `occur' that shows\
726 the last search string.
727 Type \\[isearch-highlight-regexp] to run `highlight-regexp'\
728 that highlights the last search string.
730 Type \\[isearch-describe-bindings] to display all Isearch key bindings.
731 Type \\[isearch-describe-key] to display documentation of Isearch key.
732 Type \\[isearch-describe-mode] to display documentation of Isearch mode.
734 If an input method is turned on in the current buffer, that input
735 method is also active while you are typing characters to search.
736 To toggle the input method, type \\[isearch-toggle-input-method]. \
737 It also toggles the input
738 method in the current buffer.
740 To use a different input method for searching, type \
741 \\[isearch-toggle-specified-input-method],
742 and specify an input method you want to use.
744 The above keys, bound in `isearch-mode-map', are often controlled by
745 options; do \\[apropos] on search-.* to find them.
746 Other control and meta characters terminate the search
747 and are then executed normally (depending on `search-exit-option').
748 Likewise for function keys and mouse button events.
750 If this function is called non-interactively with a nil NO-RECURSIVE-EDIT,
751 it does not return to the calling function until the search is done.
752 See the function `isearch-mode' for more information."
754 (interactive "P\np")
755 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
757 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
758 "Do incremental search forward for regular expression.
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 regexp. See the command `isearch-forward' for more information.
763 In incremental searches, a space or spaces normally matches any
764 whitespace defined by the variable `search-whitespace-regexp'.
765 To search for a literal space and nothing else, enter C-q SPC.
766 To toggle whitespace matching, use `isearch-toggle-lax-whitespace'."
767 (interactive "P\np")
768 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
770 (defun isearch-forward-word (&optional not-word no-recursive-edit)
771 "Do incremental search forward for a sequence of words.
772 With a prefix argument, do a regular string search instead.
773 Like ordinary incremental search except that your input is treated
774 as a sequence of words without regard to how the words are separated.
775 See the command `isearch-forward' for more information."
776 (interactive "P\np")
777 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
779 (defun isearch-forward-symbol (&optional _not-symbol no-recursive-edit)
780 "Do incremental search forward for a symbol.
781 The prefix argument is currently unused.
782 Like ordinary incremental search except that your input is treated
783 as a symbol surrounded by symbol boundary constructs \\_< and \\_>.
784 See the command `isearch-forward' for more information."
785 (interactive "P\np")
786 (isearch-mode t nil nil (not no-recursive-edit) 'isearch-symbol-regexp))
788 (defun isearch-backward (&optional regexp-p no-recursive-edit)
789 "Do incremental search backward.
790 With a prefix argument, do a regular expression search instead.
791 See the command `isearch-forward' for more information."
792 (interactive "P\np")
793 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
795 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
796 "Do incremental search backward for regular expression.
797 With a prefix argument, do a regular string search instead.
798 Like ordinary incremental search except that your input is treated
799 as a regexp. See the command `isearch-forward' for more information."
800 (interactive "P\np")
801 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
803 (defun isearch-forward-symbol-at-point ()
804 "Do incremental search forward for a symbol found near point.
805 Like ordinary incremental search except that the symbol found at point
806 is added to the search string initially as a regexp surrounded
807 by symbol boundary constructs \\_< and \\_>.
808 See the command `isearch-forward-symbol' for more information."
809 (interactive)
810 (isearch-forward-symbol nil 1)
811 (let ((bounds (find-tag-default-bounds)))
812 (cond
813 (bounds
814 (when (< (car bounds) (point))
815 (goto-char (car bounds)))
816 (isearch-yank-string
817 (buffer-substring-no-properties (car bounds) (cdr bounds))))
819 (setq isearch-error "No symbol at point")
820 (isearch-update)))))
823 ;; isearch-mode only sets up incremental search for the minor mode.
824 ;; All the work is done by the isearch-mode commands.
826 ;; Not used yet:
827 ;;(defvar isearch-commands '(isearch-forward isearch-backward
828 ;; isearch-forward-regexp isearch-backward-regexp)
829 ;; "List of commands for which isearch-mode does not recursive-edit.")
832 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word)
833 "Start Isearch minor mode.
834 It is called by the function `isearch-forward' and other related functions.
836 The non-nil arg FORWARD means searching in the forward direction.
838 The non-nil arg REGEXP does an incremental regular expression search.
840 The arg OP-FUN is a function to be called after each input character
841 is processed. (It is not called after characters that exit the search.)
843 When the arg RECURSIVE-EDIT is non-nil, this function behaves modally and
844 does not return to the calling function until the search is completed.
845 To behave this way it enters a recursive-edit and exits it when done
846 isearching.
848 The arg WORD, if t, does incremental search for a sequence of words,
849 ignoring punctuation. If the value is a function, it is called to
850 convert the search string to a regexp used by regexp search functions."
852 ;; Initialize global vars.
853 (setq isearch-forward forward
854 isearch-regexp regexp
855 isearch-word word
856 isearch-op-fun op-fun
857 isearch-last-case-fold-search isearch-case-fold-search
858 isearch-case-fold-search case-fold-search
859 isearch-invisible search-invisible
860 isearch-string ""
861 isearch-message ""
862 isearch-cmds nil
863 isearch-success t
864 isearch-wrapped nil
865 isearch-barrier (point)
866 isearch-adjusted nil
867 isearch-yank-flag nil
868 isearch-error nil
869 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
870 (> (window-height)
871 (* 4
872 (abs search-slow-window-lines))))
873 isearch-other-end nil
874 isearch-small-window nil
875 isearch-just-started t
876 isearch-start-hscroll (window-hscroll)
878 isearch-opoint (point)
879 search-ring-yank-pointer nil
880 isearch-opened-overlays nil
881 isearch-input-method-function input-method-function
882 isearch-input-method-local-p (local-variable-p 'input-method-function)
883 regexp-search-ring-yank-pointer nil
885 ;; Save the original value of `minibuffer-message-timeout', and
886 ;; set it to nil so that isearch's messages don't get timed out.
887 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
888 minibuffer-message-timeout nil)
890 ;; We must bypass input method while reading key. When a user type
891 ;; printable character, appropriate input method is turned on in
892 ;; minibuffer to read multibyte characters.
893 (or isearch-input-method-local-p
894 (make-local-variable 'input-method-function))
895 (setq input-method-function nil)
897 (looking-at "")
898 (setq isearch-window-configuration
899 (if isearch-slow-terminal-mode (current-window-configuration) nil))
901 ;; Maybe make minibuffer frame visible and/or raise it.
902 (let ((frame (window-frame (minibuffer-window))))
903 (unless (memq (frame-live-p frame) '(nil t))
904 (unless (frame-visible-p frame)
905 (make-frame-visible frame))
906 (if minibuffer-auto-raise
907 (raise-frame frame))))
909 (setq isearch-mode " Isearch") ;; forward? regexp?
910 (force-mode-line-update)
912 (setq overriding-terminal-local-map isearch-mode-map)
913 (run-hooks 'isearch-mode-hook)
914 ;; Remember the initial map possibly modified
915 ;; by external packages in isearch-mode-hook. (Bug#16035)
916 (setq isearch--saved-overriding-local-map overriding-terminal-local-map)
918 ;; Pushing the initial state used to be before running isearch-mode-hook,
919 ;; but a hook might set `isearch-push-state-function' used in
920 ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994)
921 (isearch-push-state)
923 (isearch-update)
925 (add-hook 'pre-command-hook 'isearch-pre-command-hook)
926 (add-hook 'post-command-hook 'isearch-post-command-hook)
927 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
928 (add-hook 'kbd-macro-termination-hook 'isearch-done)
930 ;; isearch-mode can be made modal (in the sense of not returning to
931 ;; the calling function until searching is completed) by entering
932 ;; a recursive-edit and exiting it when done isearching.
933 (if recursive-edit
934 (let ((isearch-recursive-edit t))
935 (recursive-edit)))
936 isearch-success)
939 ;; Some high level utilities. Others below.
941 (defun isearch-update ()
942 "This is called after every isearch command to update the display.
943 The last thing it does is to run `isearch-update-post-hook'."
944 (if (and (null unread-command-events)
945 (null executing-kbd-macro))
946 (progn
947 (if (not (input-pending-p))
948 (if isearch-message-function
949 (funcall isearch-message-function)
950 (isearch-message)))
951 (if (and isearch-slow-terminal-mode
952 (not (or isearch-small-window
953 (pos-visible-in-window-p))))
954 (let ((found-point (point)))
955 (setq isearch-small-window t)
956 (move-to-window-line 0)
957 (let ((window-min-height 1))
958 (split-window nil (if (< search-slow-window-lines 0)
959 (1+ (- search-slow-window-lines))
960 (- (window-height)
961 (1+ search-slow-window-lines)))))
962 (if (< search-slow-window-lines 0)
963 (progn (vertical-motion (- 1 search-slow-window-lines))
964 (set-window-start (next-window) (point))
965 (set-window-hscroll (next-window)
966 (window-hscroll))
967 (set-window-hscroll (selected-window) 0))
968 (other-window 1))
969 (goto-char found-point))
970 ;; Keep same hscrolling as at the start of the search when possible
971 (let ((current-scroll (window-hscroll)))
972 (set-window-hscroll (selected-window) isearch-start-hscroll)
973 (unless (pos-visible-in-window-p)
974 (set-window-hscroll (selected-window) current-scroll))))
975 (if isearch-other-end
976 (if (< isearch-other-end (point)) ; isearch-forward?
977 (isearch-highlight isearch-other-end (point))
978 (isearch-highlight (point) isearch-other-end))
979 (isearch-dehighlight))))
980 (setq ;; quit-flag nil not for isearch-mode
981 isearch-adjusted nil
982 isearch-yank-flag nil)
983 (when isearch-lazy-highlight
984 (isearch-lazy-highlight-new-loop))
985 ;; We must prevent the point moving to the end of composition when a
986 ;; part of the composition has just been searched.
987 (setq disable-point-adjustment t)
988 (run-hooks 'isearch-update-post-hook))
990 (defun isearch-done (&optional nopush edit)
991 "Exit Isearch mode.
992 For successful search, pass no args.
993 For a failing search, NOPUSH is t.
994 For going to the minibuffer to edit the search string,
995 NOPUSH is t and EDIT is t."
997 (if isearch-resume-in-command-history
998 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
999 ,isearch-word ,isearch-forward
1000 ,isearch-message
1001 ',isearch-case-fold-search)))
1002 (unless (equal (car command-history) command)
1003 (setq command-history (cons command command-history)))))
1005 (remove-hook 'pre-command-hook 'isearch-pre-command-hook)
1006 (remove-hook 'post-command-hook 'isearch-post-command-hook)
1007 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
1008 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
1009 (setq isearch-lazy-highlight-start nil)
1011 ;; Called by all commands that terminate isearch-mode.
1012 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
1013 (setq overriding-terminal-local-map nil)
1014 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
1015 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
1016 (isearch-dehighlight)
1017 (lazy-highlight-cleanup lazy-highlight-cleanup)
1018 (let ((found-start (window-start))
1019 (found-point (point)))
1020 (when isearch-window-configuration
1021 (set-window-configuration isearch-window-configuration)
1022 (if isearch-small-window
1023 (goto-char found-point)
1024 ;; set-window-configuration clobbers window-start; restore it.
1025 ;; This has an annoying side effect of clearing the last_modiff
1026 ;; field of the window, which can cause unwanted scrolling,
1027 ;; so don't do it unless truly necessary.
1028 (set-window-start (selected-window) found-start t))))
1030 (setq isearch-mode nil)
1031 (if isearch-input-method-local-p
1032 (setq input-method-function isearch-input-method-function)
1033 (kill-local-variable 'input-method-function))
1035 (force-mode-line-update)
1037 ;; If we ended in the middle of some intangible text,
1038 ;; move to the further end of that intangible text.
1039 (let ((after (if (eobp) nil
1040 (get-text-property (point) 'intangible)))
1041 (before (if (bobp) nil
1042 (get-text-property (1- (point)) 'intangible))))
1043 (when (and before after (eq before after))
1044 (goto-char
1045 (if isearch-forward
1046 (next-single-property-change (point) 'intangible)
1047 (previous-single-property-change (point) 'intangible)))))
1049 (if (and (> (length isearch-string) 0) (not nopush))
1050 ;; Update the ring data.
1051 (isearch-update-ring isearch-string isearch-regexp))
1053 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
1054 (run-hooks 'isearch-mode-end-hook))
1056 ;; If there was movement, mark the starting position.
1057 ;; Maybe should test difference between and set mark only if > threshold.
1058 (if (/= (point) isearch-opoint)
1059 (or (and transient-mark-mode mark-active)
1060 (progn
1061 (push-mark isearch-opoint t)
1062 (or executing-kbd-macro (> (minibuffer-depth) 0) edit
1063 (message "Mark saved where search started")))))
1065 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
1067 (defun isearch-update-ring (string &optional regexp)
1068 "Add STRING to the beginning of the search ring.
1069 REGEXP if non-nil says use the regexp search ring."
1070 (add-to-history
1071 (if regexp 'regexp-search-ring 'search-ring)
1072 string
1073 (if regexp regexp-search-ring-max search-ring-max)))
1075 ;; Switching buffers should first terminate isearch-mode.
1076 ;; ;; For Emacs 19, the frame switch event is handled.
1077 ;; (defun isearch-switch-frame-handler ()
1078 ;; (interactive) ;; Is this necessary?
1079 ;; ;; First terminate isearch-mode.
1080 ;; (isearch-done)
1081 ;; (isearch-clean-overlays)
1082 ;; (handle-switch-frame (car (cdr last-command-event))))
1085 ;; The search status structure and stack.
1087 (cl-defstruct (isearch--state
1088 (:constructor nil)
1089 (:copier nil)
1090 (:constructor isearch--get-state
1091 (&aux
1092 (string isearch-string)
1093 (message isearch-message)
1094 (point (point))
1095 (success isearch-success)
1096 (forward isearch-forward)
1097 (other-end isearch-other-end)
1098 (word isearch-word)
1099 (error isearch-error)
1100 (wrapped isearch-wrapped)
1101 (barrier isearch-barrier)
1102 (case-fold-search isearch-case-fold-search)
1103 (pop-fun (if isearch-push-state-function
1104 (funcall isearch-push-state-function))))))
1105 (string :read-only t)
1106 (message :read-only t)
1107 (point :read-only t)
1108 (success :read-only t)
1109 (forward :read-only t)
1110 (other-end :read-only t)
1111 (word :read-only t)
1112 (error :read-only t)
1113 (wrapped :read-only t)
1114 (barrier :read-only t)
1115 (case-fold-search :read-only t)
1116 (pop-fun :read-only t))
1118 (defun isearch--set-state (cmd)
1119 (setq isearch-string (isearch--state-string cmd)
1120 isearch-message (isearch--state-message cmd)
1121 isearch-success (isearch--state-success cmd)
1122 isearch-forward (isearch--state-forward cmd)
1123 isearch-other-end (isearch--state-other-end cmd)
1124 isearch-word (isearch--state-word cmd)
1125 isearch-error (isearch--state-error cmd)
1126 isearch-wrapped (isearch--state-wrapped cmd)
1127 isearch-barrier (isearch--state-barrier cmd)
1128 isearch-case-fold-search (isearch--state-case-fold-search cmd))
1129 (if (functionp (isearch--state-pop-fun cmd))
1130 (funcall (isearch--state-pop-fun cmd) cmd))
1131 (goto-char (isearch--state-point cmd)))
1133 (defun isearch-pop-state ()
1134 (setq isearch-cmds (cdr isearch-cmds))
1135 (isearch--set-state (car isearch-cmds)))
1137 (defun isearch-push-state ()
1138 (push (isearch--get-state) isearch-cmds))
1141 ;; Commands active while inside of the isearch minor mode.
1143 (defun isearch-exit ()
1144 "Exit search normally.
1145 However, if this is the first command after starting incremental
1146 search and `search-nonincremental-instead' is non-nil, do a
1147 nonincremental search instead via `isearch-edit-string'."
1148 (interactive)
1149 (if (and search-nonincremental-instead
1150 (= 0 (length isearch-string)))
1151 (let ((isearch-nonincremental t))
1152 (isearch-edit-string)))
1153 (isearch-done)
1154 (isearch-clean-overlays))
1156 (defun isearch-fail-pos (&optional msg)
1157 "Return position of first mismatch in search string, or nil if none.
1158 If MSG is non-nil, use variable `isearch-message', otherwise `isearch-string'."
1159 (let ((cmds isearch-cmds)
1160 (curr-msg (if msg isearch-message isearch-string))
1161 succ-msg)
1162 (when (or (not isearch-success) isearch-error)
1163 (while (and cmds
1164 (or (not (isearch--state-success (car cmds)))
1165 (isearch--state-error (car cmds))))
1166 (pop cmds))
1167 (setq succ-msg (and cmds (if msg (isearch--state-message (car cmds))
1168 (isearch--state-string (car cmds)))))
1169 (if (and (stringp succ-msg)
1170 (< (length succ-msg) (length curr-msg))
1171 (equal succ-msg
1172 (substring curr-msg 0 (length succ-msg))))
1173 (length succ-msg)
1174 0))))
1176 (defmacro with-isearch-suspended (&rest body)
1177 "Exit Isearch mode, run BODY, and reinvoke the pending search.
1178 You can update the global isearch variables by setting new values to
1179 `isearch-new-string', `isearch-new-message', `isearch-new-forward',
1180 `isearch-new-word', `isearch-new-case-fold'."
1181 ;; This code is very hairy for several reasons, explained in the code.
1182 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1183 ;; If there were a way to catch any change of buffer from the minibuffer,
1184 ;; this could be simplified greatly.
1185 ;; Editing doesn't back up the search point. Should it?
1186 `(condition-case nil
1187 (progn
1188 (let ((isearch-nonincremental isearch-nonincremental)
1190 ;; Locally bind all isearch global variables to protect them
1191 ;; from recursive isearching.
1192 ;; isearch-string -message and -forward are not bound
1193 ;; so they may be changed. Instead, save the values.
1194 (isearch-new-string isearch-string)
1195 (isearch-new-message isearch-message)
1196 (isearch-new-forward isearch-forward)
1197 (isearch-new-word isearch-word)
1198 (isearch-new-case-fold isearch-case-fold-search)
1200 (isearch-regexp isearch-regexp)
1201 (isearch-op-fun isearch-op-fun)
1202 (isearch-cmds isearch-cmds)
1203 (isearch-success isearch-success)
1204 (isearch-wrapped isearch-wrapped)
1205 (isearch-barrier isearch-barrier)
1206 (isearch-adjusted isearch-adjusted)
1207 (isearch-yank-flag isearch-yank-flag)
1208 (isearch-error isearch-error)
1209 ;;; Don't bind this. We want isearch-search, below, to set it.
1210 ;;; And the old value won't matter after that.
1211 ;;; (isearch-other-end isearch-other-end)
1212 ;;; Perhaps some of these other variables should be bound for a
1213 ;;; shorter period, ending before the next isearch-search.
1214 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1215 (isearch-opoint isearch-opoint)
1216 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1217 (isearch-small-window isearch-small-window)
1218 (isearch-recursive-edit isearch-recursive-edit)
1219 ;; Save current configuration so we can restore it here.
1220 (isearch-window-configuration (current-window-configuration))
1222 ;; This could protect the index of the search rings,
1223 ;; but we can't reliably count the number of typed M-p
1224 ;; in `read-from-minibuffer' to adjust the index accordingly.
1225 ;; So when the following is commented out, `isearch-mode'
1226 ;; below resets the index to the predictable value nil.
1227 ;; (search-ring-yank-pointer search-ring-yank-pointer)
1228 ;; (regexp-search-ring-yank-pointer regexp-search-ring-yank-pointer)
1230 ;; Temporarily restore `minibuffer-message-timeout'.
1231 (minibuffer-message-timeout
1232 isearch-original-minibuffer-message-timeout)
1233 (isearch-original-minibuffer-message-timeout
1234 isearch-original-minibuffer-message-timeout)
1235 old-point old-other-end)
1237 ;; Actually terminate isearching until editing is done.
1238 ;; This is so that the user can do anything without failure,
1239 ;; like switch buffers and start another isearch, and return.
1240 (condition-case nil
1241 (isearch-done t t)
1242 (exit nil)) ; was recursive editing
1244 ;; Save old point and isearch-other-end before reading from minibuffer
1245 ;; that can change their values.
1246 (setq old-point (point) old-other-end isearch-other-end)
1248 (unwind-protect
1249 (progn ,@body)
1251 ;; Set point at the start (end) of old match if forward (backward),
1252 ;; so after exiting minibuffer isearch resumes at the start (end)
1253 ;; of this match and can find it again.
1254 (if (and old-other-end (eq old-point (point))
1255 (eq isearch-forward isearch-new-forward))
1256 (goto-char old-other-end))
1258 ;; Always resume isearching by restarting it.
1259 (isearch-mode isearch-forward
1260 isearch-regexp
1261 isearch-op-fun
1263 isearch-word)
1265 ;; Copy new local values to isearch globals
1266 (setq isearch-string isearch-new-string
1267 isearch-message isearch-new-message
1268 isearch-forward isearch-new-forward
1269 isearch-word isearch-new-word
1270 isearch-case-fold-search isearch-new-case-fold))
1272 ;; Empty isearch-string means use default.
1273 (when (= 0 (length isearch-string))
1274 (setq isearch-string (or (car (if isearch-regexp
1275 regexp-search-ring
1276 search-ring))
1279 isearch-message
1280 (mapconcat 'isearch-text-char-description
1281 isearch-string ""))
1282 ;; After taking the last element, adjust ring to previous one.
1283 (isearch-ring-adjust1 nil)))
1285 ;; This used to push the state as of before this C-s, but it adds
1286 ;; an inconsistent state where part of variables are from the
1287 ;; previous search (e.g. `isearch-success'), and part of variables
1288 ;; are just entered from the minibuffer (e.g. `isearch-string').
1289 ;; (isearch-push-state)
1291 ;; Reinvoke the pending search.
1292 (isearch-search)
1293 (isearch-push-state) ; this pushes the correct state
1294 (isearch-update)
1295 (if isearch-nonincremental
1296 (progn
1297 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1298 (isearch-done)
1299 ;; The search done message is confusing when the string
1300 ;; is empty, so erase it.
1301 (if (equal isearch-string "")
1302 (message "")))))
1304 (quit ; handle abort-recursive-edit
1305 (isearch-abort) ;; outside of let to restore outside global values
1308 (defvar minibuffer-history-symbol) ;; from external package gmhist.el
1310 (defun isearch-edit-string ()
1311 "Edit the search string in the minibuffer.
1312 The following additional command keys are active while editing.
1313 \\<minibuffer-local-isearch-map>
1314 \\[exit-minibuffer] to resume incremental searching with the edited string.
1315 \\[isearch-forward-exit-minibuffer] to resume isearching forward.
1316 \\[isearch-reverse-exit-minibuffer] to resume isearching backward.
1317 \\[isearch-complete-edit] to complete the search string using the search ring."
1318 (interactive)
1319 (with-isearch-suspended
1320 (let* ((message-log-max nil)
1321 ;; Don't add a new search string to the search ring here
1322 ;; in `read-from-minibuffer'. It should be added only
1323 ;; by `isearch-update-ring' called from `isearch-done'.
1324 (history-add-new-input nil)
1325 ;; Binding minibuffer-history-symbol to nil is a work-around
1326 ;; for some incompatibility with gmhist.
1327 (minibuffer-history-symbol))
1328 (setq isearch-new-string
1329 (read-from-minibuffer
1330 (isearch-message-prefix nil isearch-nonincremental)
1331 (cons isearch-string (1+ (or (isearch-fail-pos)
1332 (length isearch-string))))
1333 minibuffer-local-isearch-map nil
1334 (if isearch-regexp
1335 (cons 'regexp-search-ring
1336 (1+ (or regexp-search-ring-yank-pointer -1)))
1337 (cons 'search-ring
1338 (1+ (or search-ring-yank-pointer -1))))
1339 nil t)
1340 isearch-new-message
1341 (mapconcat 'isearch-text-char-description
1342 isearch-new-string "")))))
1344 (defun isearch-nonincremental-exit-minibuffer ()
1345 (interactive)
1346 (setq isearch-nonincremental t)
1347 (exit-minibuffer))
1348 ;; Changing the value of `isearch-nonincremental' has no effect here,
1349 ;; because `isearch-edit-string' ignores this change. Thus marked as obsolete.
1350 (make-obsolete 'isearch-nonincremental-exit-minibuffer 'exit-minibuffer "24.4")
1352 (defun isearch-forward-exit-minibuffer ()
1353 "Resume isearching forward from the minibuffer that edits the search string."
1354 (interactive)
1355 (setq isearch-new-forward t)
1356 (exit-minibuffer))
1358 (defun isearch-reverse-exit-minibuffer ()
1359 "Resume isearching backward from the minibuffer that edits the search string."
1360 (interactive)
1361 (setq isearch-new-forward nil)
1362 (exit-minibuffer))
1364 (defun isearch-cancel ()
1365 "Terminate the search and go back to the starting point."
1366 (interactive)
1367 (if (and isearch-push-state-function isearch-cmds)
1368 ;; For defined push-state function, restore the first state.
1369 ;; This calls pop-state function and restores original point.
1370 (let ((isearch-cmds (last isearch-cmds)))
1371 (isearch--set-state (car isearch-cmds)))
1372 (goto-char isearch-opoint))
1373 (isearch-done t) ; Exit isearch..
1374 (isearch-clean-overlays)
1375 (signal 'quit nil)) ; ..and pass on quit signal.
1377 (defun isearch-abort ()
1378 "Abort incremental search mode if searching is successful, signaling quit.
1379 Otherwise, revert to previous successful search and continue searching.
1380 Use `isearch-exit' to quit without signaling."
1381 (interactive)
1382 ;; (ding) signal instead below, if quitting
1383 (discard-input)
1384 (if (and isearch-success (not isearch-error))
1385 ;; If search is successful and has no incomplete regexp,
1386 ;; move back to starting point and really do quit.
1387 (progn
1388 (setq isearch-success nil)
1389 (isearch-cancel))
1390 ;; If search is failing, or has an incomplete regexp,
1391 ;; rub out until it is once more successful.
1392 (while (or (not isearch-success) isearch-error)
1393 (isearch-pop-state))
1394 (isearch-update)))
1396 (defun isearch-repeat (direction)
1397 ;; Utility for isearch-repeat-forward and -backward.
1398 (if (eq isearch-forward (eq direction 'forward))
1399 ;; C-s in forward or C-r in reverse.
1400 (if (equal isearch-string "")
1401 ;; If search string is empty, use last one.
1402 (if (null (if isearch-regexp regexp-search-ring search-ring))
1403 (setq isearch-error "No previous search string")
1404 (setq isearch-string
1405 (car (if isearch-regexp regexp-search-ring search-ring))
1406 isearch-message
1407 (mapconcat 'isearch-text-char-description
1408 isearch-string "")
1409 isearch-case-fold-search isearch-last-case-fold-search)
1410 ;; After taking the last element, adjust ring to previous one.
1411 (isearch-ring-adjust1 nil))
1412 ;; If already have what to search for, repeat it.
1413 (or isearch-success
1414 (progn
1415 ;; Set isearch-wrapped before calling isearch-wrap-function
1416 (setq isearch-wrapped t)
1417 (if isearch-wrap-function
1418 (funcall isearch-wrap-function)
1419 (goto-char (if isearch-forward (point-min) (point-max)))))))
1420 ;; C-s in reverse or C-r in forward, change direction.
1421 (setq isearch-forward (not isearch-forward)
1422 isearch-success t))
1424 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1426 (if (equal isearch-string "")
1427 (setq isearch-success t)
1428 (if (and isearch-success
1429 (equal (point) isearch-other-end)
1430 (not isearch-just-started))
1431 ;; If repeating a search that found
1432 ;; an empty string, ensure we advance.
1433 (if (if isearch-forward (eobp) (bobp))
1434 ;; If there's nowhere to advance to, fail (and wrap next time).
1435 (progn
1436 (setq isearch-success nil)
1437 (ding))
1438 (forward-char (if isearch-forward 1 -1))
1439 (isearch-search))
1440 (isearch-search)))
1442 (isearch-push-state)
1443 (isearch-update))
1445 (defun isearch-repeat-forward ()
1446 "Repeat incremental search forwards."
1447 (interactive)
1448 (isearch-repeat 'forward))
1450 (defun isearch-repeat-backward ()
1451 "Repeat incremental search backwards."
1452 (interactive)
1453 (isearch-repeat 'backward))
1455 (defun isearch-toggle-regexp ()
1456 "Toggle regexp searching on or off."
1457 ;; The status stack is left unchanged.
1458 (interactive)
1459 (setq isearch-regexp (not isearch-regexp))
1460 (if isearch-regexp (setq isearch-word nil))
1461 (setq isearch-success t isearch-adjusted t)
1462 (isearch-update))
1464 (defun isearch-toggle-word ()
1465 "Toggle word searching on or off."
1466 ;; The status stack is left unchanged.
1467 (interactive)
1468 (setq isearch-word (not isearch-word))
1469 (if isearch-word (setq isearch-regexp nil))
1470 (setq isearch-success t isearch-adjusted t)
1471 (isearch-update))
1473 (defun isearch-toggle-symbol ()
1474 "Toggle symbol searching on or off."
1475 (interactive)
1476 (setq isearch-word (unless (eq isearch-word 'isearch-symbol-regexp)
1477 'isearch-symbol-regexp))
1478 (if isearch-word (setq isearch-regexp nil))
1479 (setq isearch-success t isearch-adjusted t)
1480 (isearch-update))
1482 (defun isearch-toggle-lax-whitespace ()
1483 "Toggle whitespace matching in searching on or off.
1484 In ordinary search, toggles the value of the variable
1485 `isearch-lax-whitespace'. In regexp search, toggles the
1486 value of the variable `isearch-regexp-lax-whitespace'."
1487 (interactive)
1488 (if isearch-regexp
1489 (setq isearch-regexp-lax-whitespace (not isearch-regexp-lax-whitespace))
1490 (setq isearch-lax-whitespace (not isearch-lax-whitespace)))
1491 (let ((message-log-max nil))
1492 (message "%s%s [%s]"
1493 (isearch-message-prefix nil isearch-nonincremental)
1494 isearch-message
1495 (if (if isearch-regexp
1496 isearch-regexp-lax-whitespace
1497 isearch-lax-whitespace)
1498 "match spaces loosely"
1499 "match spaces literally")))
1500 (setq isearch-success t isearch-adjusted t)
1501 (sit-for 1)
1502 (isearch-update))
1504 (defun isearch-toggle-case-fold ()
1505 "Toggle case folding in searching on or off.
1506 Toggles the value of the variable `isearch-case-fold-search'."
1507 (interactive)
1508 (setq isearch-case-fold-search
1509 (if isearch-case-fold-search nil 'yes))
1510 (let ((message-log-max nil))
1511 (message "%s%s [case %ssensitive]"
1512 (isearch-message-prefix nil isearch-nonincremental)
1513 isearch-message
1514 (if isearch-case-fold-search "in" "")))
1515 (setq isearch-success t isearch-adjusted t)
1516 (sit-for 1)
1517 (isearch-update))
1519 (defun isearch-toggle-invisible ()
1520 "Toggle searching in invisible text on or off.
1521 Toggles the variable `isearch-invisible' between values
1522 nil and a non-nil value of the option `search-invisible'
1523 \(or `open' if `search-invisible' is nil)."
1524 (interactive)
1525 (setq isearch-invisible
1526 (if isearch-invisible nil (or search-invisible 'open)))
1527 (let ((message-log-max nil))
1528 (message "%s%s [match %svisible text]"
1529 (isearch-message-prefix nil isearch-nonincremental)
1530 isearch-message
1531 (if isearch-invisible "in" "")))
1532 (setq isearch-success t isearch-adjusted t)
1533 (sit-for 1)
1534 (isearch-update))
1537 ;; Word search
1539 (defun word-search-regexp (string &optional lax)
1540 "Return a regexp which matches words, ignoring punctuation.
1541 Given STRING, a string of words separated by word delimiters,
1542 compute a regexp that matches those exact words separated by
1543 arbitrary punctuation. If the string begins or ends in whitespace,
1544 the beginning or the end of the string matches arbitrary whitespace.
1545 Otherwise if LAX is non-nil, the beginning or the end of the string
1546 need not match a word boundary.
1548 Used in `word-search-forward', `word-search-backward',
1549 `word-search-forward-lax', `word-search-backward-lax'."
1550 (cond
1551 ((equal string "") "")
1552 ((string-match-p "\\`\\W+\\'" string) "\\W+")
1553 (t (concat
1554 (if (string-match-p "\\`\\W" string) "\\W+"
1555 (unless lax "\\<"))
1556 (mapconcat 'regexp-quote (split-string string "\\W+" t) "\\W+")
1557 (if (string-match-p "\\W\\'" string) "\\W+"
1558 (unless lax "\\>"))))))
1560 (defun word-search-backward (string &optional bound noerror count)
1561 "Search backward from point for STRING, ignoring differences in punctuation.
1562 Set point to the beginning of the occurrence found, and return point.
1563 An optional second argument bounds the search; it is a buffer position.
1564 The match found must not extend before that position.
1565 Optional third argument, if t, means if fail just return nil (no error).
1566 If not nil and not t, move to limit of search and return nil.
1567 Optional fourth argument is repeat count--search for successive occurrences.
1569 Relies on the function `word-search-regexp' to convert a sequence
1570 of words in STRING to a regexp used to search words without regard
1571 to punctuation."
1572 (interactive "sWord search backward: ")
1573 (re-search-backward (word-search-regexp string nil) bound noerror count))
1575 (defun word-search-forward (string &optional bound noerror count)
1576 "Search forward from point for STRING, ignoring differences in punctuation.
1577 Set point to the end of the occurrence found, and return point.
1578 An optional second argument bounds the search; it is a buffer position.
1579 The match found must not extend after that position.
1580 Optional third argument, if t, means if fail just return nil (no error).
1581 If not nil and not t, move to limit of search and return nil.
1582 Optional fourth argument is repeat count--search for successive occurrences.
1584 Relies on the function `word-search-regexp' to convert a sequence
1585 of words in STRING to a regexp used to search words without regard
1586 to punctuation."
1587 (interactive "sWord search: ")
1588 (re-search-forward (word-search-regexp string nil) bound noerror count))
1590 (defun word-search-backward-lax (string &optional bound noerror count)
1591 "Search backward from point for STRING, ignoring differences in punctuation.
1592 Set point to the beginning of the occurrence found, and return point.
1594 Unlike `word-search-backward', the end of STRING need not match a word
1595 boundary, unless STRING ends in whitespace.
1597 An optional second argument bounds the search; it is a buffer position.
1598 The match found must not extend before that position.
1599 Optional third argument, if t, means if fail just return nil (no error).
1600 If not nil and not t, move to limit of search and return nil.
1601 Optional fourth argument is repeat count--search for successive occurrences.
1603 Relies on the function `word-search-regexp' to convert a sequence
1604 of words in STRING to a regexp used to search words without regard
1605 to punctuation."
1606 (interactive "sWord search backward: ")
1607 (re-search-backward (word-search-regexp string t) bound noerror count))
1609 (defun word-search-forward-lax (string &optional bound noerror count)
1610 "Search forward from point for STRING, ignoring differences in punctuation.
1611 Set point to the end of the occurrence found, and return point.
1613 Unlike `word-search-forward', the end of STRING need not match a word
1614 boundary, unless STRING ends in whitespace.
1616 An optional second argument bounds the search; it is a buffer position.
1617 The match found must not extend after that position.
1618 Optional third argument, if t, means if fail just return nil (no error).
1619 If not nil and not t, move to limit of search and return nil.
1620 Optional fourth argument is repeat count--search for successive occurrences.
1622 Relies on the function `word-search-regexp' to convert a sequence
1623 of words in STRING to a regexp used to search words without regard
1624 to punctuation."
1625 (interactive "sWord search: ")
1626 (re-search-forward (word-search-regexp string t) bound noerror count))
1628 ;; Symbol search
1630 (defun isearch-symbol-regexp (string &optional lax)
1631 "Return a regexp which matches STRING as a symbol.
1632 Creates a regexp where STRING is surrounded by symbol delimiters \\_< and \\_>.
1633 If there are more than one symbol, then compute a regexp that matches
1634 those exact symbols separated by non-symbol characters. If the string
1635 begins or ends in whitespace, the beginning or the end of the string
1636 matches arbitrary non-symbol whitespace. Otherwise if LAX is non-nil,
1637 the beginning or the end of the string need not match a symbol boundary."
1638 (let ((not-word-symbol-re
1639 ;; This regexp matches all syntaxes except word and symbol syntax.
1640 ;; FIXME: Replace it with something shorter if possible (bug#14602).
1641 "\\(?:\\s-\\|\\s.\\|\\s(\\|\\s)\\|\\s\"\\|\\s\\\\|\\s/\\|\\s$\\|\\s'\\|\\s<\\|\\s>\\|\\s@\\|\\s!\\|\\s|\\)+"))
1642 (cond
1643 ((equal string "") "")
1644 ((string-match-p (format "\\`%s\\'" not-word-symbol-re) string) not-word-symbol-re)
1645 (t (concat
1646 (if (string-match-p (format "\\`%s" not-word-symbol-re) string) not-word-symbol-re
1647 (unless lax "\\_<"))
1648 (mapconcat 'regexp-quote (split-string string not-word-symbol-re t) not-word-symbol-re)
1649 (if (string-match-p (format "%s\\'" not-word-symbol-re) string) not-word-symbol-re
1650 (unless lax "\\_>")))))))
1652 (put 'isearch-symbol-regexp 'isearch-message-prefix "symbol ")
1654 ;; Search with lax whitespace
1656 (defun search-forward-lax-whitespace (string &optional bound noerror count)
1657 "Search forward for STRING, matching a sequence of whitespace chars."
1658 (let ((search-spaces-regexp search-whitespace-regexp))
1659 (re-search-forward (regexp-quote string) bound noerror count)))
1661 (defun search-backward-lax-whitespace (string &optional bound noerror count)
1662 "Search backward for STRING, matching a sequence of whitespace chars."
1663 (let ((search-spaces-regexp search-whitespace-regexp))
1664 (re-search-backward (regexp-quote string) bound noerror count)))
1666 (defun re-search-forward-lax-whitespace (regexp &optional bound noerror count)
1667 "Search forward for REGEXP, matching a sequence of whitespace chars."
1668 (let ((search-spaces-regexp search-whitespace-regexp))
1669 (re-search-forward regexp bound noerror count)))
1671 (defun re-search-backward-lax-whitespace (regexp &optional bound noerror count)
1672 "Search backward for REGEXP, matching a sequence of whitespace chars."
1673 (let ((search-spaces-regexp search-whitespace-regexp))
1674 (re-search-backward regexp bound noerror count)))
1677 (defun isearch-query-replace (&optional arg regexp-flag)
1678 "Start `query-replace' with string to replace from last search string.
1679 The ARG (prefix arg if interactive), if non-nil, means replace
1680 only matches surrounded by word boundaries. A negative prefix
1681 arg means replace backward. Note that using the prefix arg
1682 is possible only when `isearch-allow-scroll' is non-nil or
1683 `isearch-allow-prefix' is non-nil, and it doesn't always provide the
1684 correct matches for `query-replace', so the preferred way to run word
1685 replacements from Isearch is `M-s w ... M-%'."
1686 (interactive
1687 (list current-prefix-arg))
1688 (barf-if-buffer-read-only)
1689 (if regexp-flag (setq isearch-regexp t))
1690 (let ((case-fold-search isearch-case-fold-search)
1691 ;; set `search-upper-case' to nil to not call
1692 ;; `isearch-no-upper-case-p' in `perform-replace'
1693 (search-upper-case nil)
1694 (search-invisible isearch-invisible)
1695 (replace-lax-whitespace
1696 isearch-lax-whitespace)
1697 (replace-regexp-lax-whitespace
1698 isearch-regexp-lax-whitespace)
1699 (delimited (and arg (not (eq arg '-))))
1700 (backward (and arg (eq arg '-)))
1701 ;; Set `isearch-recursive-edit' to nil to prevent calling
1702 ;; `exit-recursive-edit' in `isearch-done' that terminates
1703 ;; the execution of this command when it is non-nil.
1704 ;; We call `exit-recursive-edit' explicitly at the end below.
1705 (isearch-recursive-edit nil))
1706 (isearch-done nil t)
1707 (isearch-clean-overlays)
1708 (if (and isearch-other-end
1709 (if backward
1710 (> isearch-other-end (point))
1711 (< isearch-other-end (point)))
1712 (not (and transient-mark-mode mark-active
1713 (if backward
1714 (> (mark) (point))
1715 (< (mark) (point))))))
1716 (goto-char isearch-other-end))
1717 (set query-replace-from-history-variable
1718 (cons isearch-string
1719 (symbol-value query-replace-from-history-variable)))
1720 (perform-replace
1721 isearch-string
1722 (query-replace-read-to
1723 isearch-string
1724 (concat "Query replace"
1725 (if (or delimited isearch-word)
1726 (let* ((symbol (or delimited isearch-word))
1727 (string (and symbol (symbolp symbol)
1728 (get symbol 'isearch-message-prefix))))
1729 (if (stringp string)
1730 ;; Move space from the end to the beginning.
1731 (replace-regexp-in-string "\\(.*\\) \\'" " \\1" string)
1732 " word"))
1734 (if isearch-regexp " regexp" "")
1735 (if backward " backward" "")
1736 (if (and transient-mark-mode mark-active) " in region" ""))
1737 isearch-regexp)
1738 t isearch-regexp (or delimited isearch-word) nil nil
1739 (if (and transient-mark-mode mark-active) (region-beginning))
1740 (if (and transient-mark-mode mark-active) (region-end))
1741 backward))
1742 (and isearch-recursive-edit (exit-recursive-edit)))
1744 (defun isearch-query-replace-regexp (&optional arg)
1745 "Start `query-replace-regexp' with string to replace from last search string.
1746 See `isearch-query-replace' for more information."
1747 (interactive
1748 (list current-prefix-arg))
1749 (isearch-query-replace arg t))
1751 (defun isearch-occur (regexp &optional nlines)
1752 "Run `occur' using the last search string as the regexp.
1753 Interactively, REGEXP is constructed using the search string from the
1754 last search command. NLINES has the same meaning as in `occur'.
1756 If the last search command was a word search, REGEXP is computed from
1757 the search words, ignoring punctuation. If the last search
1758 command was a regular expression search, REGEXP is the regular
1759 expression used in that search. If the last search command searched
1760 for a literal string, REGEXP is constructed by quoting all the special
1761 characters in that string."
1762 (interactive
1763 (let* ((perform-collect (consp current-prefix-arg))
1764 (regexp (cond
1765 ((functionp isearch-word)
1766 (funcall isearch-word isearch-string))
1767 (isearch-word (word-search-regexp isearch-string))
1768 (isearch-regexp isearch-string)
1769 (t (regexp-quote isearch-string)))))
1770 (list regexp
1771 (if perform-collect
1772 ;; Perform collect operation
1773 (if (zerop (regexp-opt-depth regexp))
1774 ;; No subexpression so collect the entire match.
1775 "\\&"
1776 ;; Get the regexp for collection pattern.
1777 (let ((default (car occur-collect-regexp-history))
1778 regexp-collect)
1779 (with-isearch-suspended
1780 (setq regexp-collect
1781 (read-regexp
1782 (format "Regexp to collect (default %s): " default)
1783 default 'occur-collect-regexp-history)))
1784 regexp-collect))
1785 ;; Otherwise normal occur takes numerical prefix argument.
1786 (when current-prefix-arg
1787 (prefix-numeric-value current-prefix-arg))))))
1788 (let ((case-fold-search isearch-case-fold-search)
1789 ;; Set `search-upper-case' to nil to not call
1790 ;; `isearch-no-upper-case-p' in `occur-1'.
1791 (search-upper-case nil)
1792 (search-spaces-regexp
1793 (if (if isearch-regexp
1794 isearch-regexp-lax-whitespace
1795 isearch-lax-whitespace)
1796 search-whitespace-regexp)))
1797 (occur regexp nlines)))
1799 (declare-function hi-lock-read-face-name "hi-lock" ())
1801 (defun isearch-highlight-regexp ()
1802 "Run `highlight-regexp' with regexp from the current search string.
1803 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1804 argument from the last search regexp or a quoted search string,
1805 and reads its face argument using `hi-lock-read-face-name'."
1806 (interactive)
1807 (let (
1808 ;; Set `isearch-recursive-edit' to nil to prevent calling
1809 ;; `exit-recursive-edit' in `isearch-done' that terminates
1810 ;; the execution of this command when it is non-nil.
1811 ;; We call `exit-recursive-edit' explicitly at the end below.
1812 (isearch-recursive-edit nil))
1813 (isearch-done nil t)
1814 (isearch-clean-overlays))
1815 (require 'hi-lock nil t)
1816 (let ((regexp (cond ((functionp isearch-word)
1817 (funcall isearch-word isearch-string))
1818 (isearch-word (word-search-regexp isearch-string))
1819 (isearch-regexp isearch-string)
1820 ((if (and (eq isearch-case-fold-search t)
1821 search-upper-case)
1822 (isearch-no-upper-case-p
1823 isearch-string isearch-regexp)
1824 isearch-case-fold-search)
1825 ;; Turn isearch-string into a case-insensitive
1826 ;; regexp.
1827 (mapconcat
1828 (lambda (c)
1829 (let ((s (string c)))
1830 (if (string-match "[[:alpha:]]" s)
1831 (format "[%s%s]" (upcase s) (downcase s))
1832 (regexp-quote s))))
1833 isearch-string ""))
1834 (t (regexp-quote isearch-string)))))
1835 (hi-lock-face-buffer regexp (hi-lock-read-face-name)))
1836 (and isearch-recursive-edit (exit-recursive-edit)))
1839 (defun isearch-delete-char ()
1840 "Discard last input item and move point back.
1841 Last input means the last character or the last isearch command
1842 that added or deleted characters from the search string,
1843 moved point, toggled regexp mode or case-sensitivity, etc.
1844 If no previous match was done, just beep."
1845 (interactive)
1846 (if (null (cdr isearch-cmds))
1847 (ding)
1848 (isearch-pop-state))
1849 (isearch-update))
1851 (defun isearch-del-char (&optional arg)
1852 "Delete character from end of search string and search again.
1853 Unlike `isearch-delete-char', it only deletes the last character,
1854 but doesn't cancel the effect of other isearch command.
1855 If search string is empty, just beep."
1856 (interactive "p")
1857 (if (= 0 (length isearch-string))
1858 (ding)
1859 (setq isearch-string (substring isearch-string 0
1860 (- (min (or arg 1)
1861 (length isearch-string))))
1862 isearch-message (mapconcat 'isearch-text-char-description
1863 isearch-string "")))
1864 ;; Use the isearch-other-end as new starting point to be able
1865 ;; to find the remaining part of the search string again.
1866 ;; This is like what `isearch-search-and-update' does,
1867 ;; but currently it doesn't support deletion of characters
1868 ;; for the case where unsuccessful search may become successful
1869 ;; by deletion of characters.
1870 (if isearch-other-end (goto-char isearch-other-end))
1871 (isearch-search)
1872 (isearch-push-state)
1873 (isearch-update))
1875 (defun isearch-yank-string (string)
1876 "Pull STRING into search string."
1877 ;; Downcase the string if not supposed to case-fold yanked strings.
1878 (if (and isearch-case-fold-search
1879 (eq 'not-yanks search-upper-case))
1880 (setq string (downcase string)))
1881 (if isearch-regexp (setq string (regexp-quote string)))
1882 ;; Don't move cursor in reverse search.
1883 (setq isearch-yank-flag t)
1884 (isearch-process-search-string
1885 string (mapconcat 'isearch-text-char-description string "")))
1887 (defun isearch-yank-kill ()
1888 "Pull string from kill ring into search string."
1889 (interactive)
1890 (isearch-yank-string (current-kill 0)))
1892 (defun isearch-yank-pop ()
1893 "Replace just-yanked search string with previously killed string."
1894 (interactive)
1895 (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop)))
1896 ;; Fall back on `isearch-yank-kill' for the benefits of people
1897 ;; who are used to the old behavior of `M-y' in isearch mode. In
1898 ;; future, this fallback may be changed if we ever change
1899 ;; `yank-pop' to do something like the kill-ring-browser.
1900 (isearch-yank-kill)
1901 (isearch-pop-state)
1902 (isearch-yank-string (current-kill 1))))
1904 (defun isearch-yank-x-selection ()
1905 "Pull current X selection into search string."
1906 (interactive)
1907 (isearch-yank-string (x-get-selection))
1908 ;; If `x-get-selection' returned the text from the active region,
1909 ;; then it "used" the mark which we should hence deactivate.
1910 (when select-active-regions (deactivate-mark)))
1913 (defun isearch-mouse-2 (click)
1914 "Handle mouse-2 in Isearch mode.
1915 For a click in the echo area, invoke `isearch-yank-x-selection'.
1916 Otherwise invoke whatever the calling mouse-2 command sequence
1917 is bound to outside of Isearch."
1918 (interactive "e")
1919 (let* ((w (posn-window (event-start click)))
1920 (overriding-terminal-local-map nil)
1921 (binding (key-binding (this-command-keys-vector) t)))
1922 (if (and (window-minibuffer-p w)
1923 (not (minibuffer-window-active-p w))) ; in echo area
1924 (isearch-yank-x-selection)
1925 (when (functionp binding)
1926 (call-interactively binding)))))
1928 (defun isearch-yank-internal (jumpform)
1929 "Pull the text from point to the point reached by JUMPFORM.
1930 JUMPFORM is a lambda expression that takes no arguments and returns
1931 a buffer position, possibly having moved point to that position.
1932 For example, it might move point forward by a word and return point,
1933 or it might return the position of the end of the line."
1934 (isearch-yank-string
1935 (save-excursion
1936 (and (not isearch-forward) isearch-other-end
1937 (goto-char isearch-other-end))
1938 (buffer-substring-no-properties (point) (funcall jumpform)))))
1940 (defun isearch-yank-char-in-minibuffer (&optional arg)
1941 "Pull next character from buffer into end of search string in minibuffer."
1942 (interactive "p")
1943 (if (eobp)
1944 (insert
1945 (with-current-buffer (cadr (buffer-list))
1946 (buffer-substring-no-properties
1947 (point) (progn (forward-char arg) (point)))))
1948 (forward-char arg)))
1950 (defun isearch-yank-char (&optional arg)
1951 "Pull next character from buffer into search string.
1952 If optional ARG is non-nil, pull in the next ARG characters."
1953 (interactive "p")
1954 (isearch-yank-internal (lambda () (forward-char arg) (point))))
1956 (declare-function subword-forward "subword" (&optional arg))
1957 (defun isearch-yank-word-or-char ()
1958 "Pull next character, subword or word from buffer into search string.
1959 Subword is used when `subword-mode' is activated. "
1960 (interactive)
1961 (isearch-yank-internal
1962 (lambda ()
1963 (if (or (= (char-syntax (or (char-after) 0)) ?w)
1964 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
1965 (if (and (boundp 'subword-mode) subword-mode)
1966 (subword-forward 1)
1967 (forward-word 1))
1968 (forward-char 1)) (point))))
1970 (defun isearch-yank-word (&optional arg)
1971 "Pull next word from buffer into search string.
1972 If optional ARG is non-nil, pull in the next ARG words."
1973 (interactive "p")
1974 (isearch-yank-internal (lambda () (forward-word arg) (point))))
1976 (defun isearch-yank-line (&optional arg)
1977 "Pull rest of line from buffer into search string.
1978 If optional ARG is non-nil, yank the next ARG lines."
1979 (interactive "p")
1980 (isearch-yank-internal
1981 (lambda () (let ((inhibit-field-text-motion t))
1982 (line-end-position (if (eolp) (1+ arg) arg))))))
1984 (defun isearch-char-by-name (&optional count)
1985 "Read a character by its Unicode name and add it to the search string.
1986 Completion is available like in `read-char-by-name' used by `insert-char'.
1987 With argument, add COUNT copies of the character."
1988 (interactive "p")
1989 (with-isearch-suspended
1990 (let ((char (read-char-by-name "Add character to search (Unicode name or hex): ")))
1991 (when char
1992 (let ((string (if (and (integerp count) (> count 1))
1993 (make-string count char)
1994 (char-to-string char))))
1995 (setq isearch-new-string (concat isearch-string string)
1996 isearch-new-message (concat isearch-message
1997 (mapconcat 'isearch-text-char-description
1998 string ""))))))))
2000 (defun isearch-search-and-update ()
2001 ;; Do the search and update the display.
2002 (when (or isearch-success
2003 ;; Unsuccessful regexp search may become successful by
2004 ;; addition of characters which make isearch-string valid
2005 isearch-regexp
2006 ;; If the string was found but was completely invisible,
2007 ;; it might now be partly visible, so try again.
2008 (prog1 isearch-hidden (setq isearch-hidden nil)))
2009 ;; In reverse search, adding stuff at
2010 ;; the end may cause zero or many more chars to be
2011 ;; matched, in the string following point.
2012 ;; Allow all those possibilities without moving point as
2013 ;; long as the match does not extend past search origin.
2014 (if (and (not isearch-forward) (not isearch-adjusted)
2015 (condition-case ()
2016 (let ((case-fold-search isearch-case-fold-search))
2017 (if (and (eq case-fold-search t) search-upper-case)
2018 (setq case-fold-search
2019 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2020 (looking-at (cond
2021 ((functionp isearch-word)
2022 (funcall isearch-word isearch-string t))
2023 (isearch-word (word-search-regexp isearch-string t))
2024 (isearch-regexp isearch-string)
2025 (t (regexp-quote isearch-string)))))
2026 (error nil))
2027 (or isearch-yank-flag
2028 (<= (match-end 0)
2029 (min isearch-opoint isearch-barrier))))
2030 (progn
2031 (setq isearch-success t
2032 isearch-error nil
2033 isearch-other-end (match-end 0))
2034 (if (and (eq isearch-case-fold-search t) search-upper-case)
2035 (setq isearch-case-fold-search
2036 (isearch-no-upper-case-p isearch-string isearch-regexp))))
2037 ;; Not regexp, not reverse, or no match at point.
2038 (if (and isearch-other-end (not isearch-adjusted))
2039 (goto-char (if isearch-forward isearch-other-end
2040 (min isearch-opoint
2041 isearch-barrier
2042 (1+ isearch-other-end)))))
2043 (isearch-search)
2045 (isearch-push-state)
2046 (if isearch-op-fun (funcall isearch-op-fun))
2047 (isearch-update))
2050 ;; *, ?, }, and | chars can make a regexp more liberal.
2051 ;; They can make a regexp match sooner or make it succeed instead of failing.
2052 ;; So go back to place last successful search started
2053 ;; or to the last ^S/^R (barrier), whichever is nearer.
2054 ;; + needs no special handling because the string must match at least once.
2056 (defun isearch-backslash (str)
2057 "Return t if STR ends in an odd number of backslashes."
2058 (= (mod (- (length str) (string-match "\\\\*\\'" str)) 2) 1))
2060 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
2061 "Return point to previous successful match to allow regexp liberalization.
2062 \\<isearch-mode-map>
2063 Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by \
2064 stopping at `isearch-barrier' as needed.
2066 Do nothing if a backslash is escaping the liberalizing character.
2067 If WANT-BACKSLASH is non-nil, invert this behavior (for \\} and \\|).
2069 Do nothing if regexp has recently been invalid unless optional
2070 ALLOW-INVALID non-nil.
2072 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
2073 to the barrier."
2074 ;; (eq (not a) (not b)) makes all non-nil values equivalent
2075 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
2076 (not want-backslash))
2077 ;; We have to check 2 stack frames because the last might be
2078 ;; invalid just because of a backslash.
2079 (or (not isearch-error)
2080 (not (isearch--state-error (cadr isearch-cmds)))
2081 allow-invalid))
2082 (if to-barrier
2083 (progn (goto-char isearch-barrier)
2084 (setq isearch-adjusted t))
2085 (let* ((stack isearch-cmds)
2086 (previous (cdr stack)) ; lookbelow in the stack
2087 (frame (car stack)))
2088 ;; Walk down the stack looking for a valid regexp (as of course only
2089 ;; they can be the previous successful match); this conveniently
2090 ;; removes all bracket-sets and groups that might be in the way, as
2091 ;; well as partial \{\} constructs that the code below leaves behind.
2092 ;; Also skip over postfix operators -- though horrid,
2093 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
2094 (while (and previous
2095 (or (isearch--state-error frame)
2096 (let* ((string (isearch--state-string frame))
2097 (lchar (aref string (1- (length string)))))
2098 ;; The operators aren't always operators; check
2099 ;; backslashes. This doesn't handle the case of
2100 ;; operators at the beginning of the regexp not
2101 ;; being special, but then we should fall back to
2102 ;; the barrier anyway because it's all optional.
2103 (if (isearch-backslash
2104 (isearch--state-string (car previous)))
2105 (eq lchar ?\})
2106 (memq lchar '(?* ?? ?+))))))
2107 (setq stack previous previous (cdr previous) frame (car stack)))
2108 (when stack
2109 ;; `stack' now refers the most recent valid regexp that is not at
2110 ;; all optional in its last term. Now dig one level deeper and find
2111 ;; what matched before that.
2112 (let ((last-other-end
2113 (or (and (car previous)
2114 (isearch--state-other-end (car previous)))
2115 isearch-barrier)))
2116 (goto-char (if isearch-forward
2117 (max last-other-end isearch-barrier)
2118 (min last-other-end isearch-barrier)))
2119 (setq isearch-adjusted t)))))))
2121 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2122 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
2124 ;; The idea here is that certain vertical scrolling commands (like C-l
2125 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
2126 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
2127 ;; tamper with isearch's state, or move point. It is unacceptable for the
2128 ;; search string to be scrolled out of the current window. If a command
2129 ;; attempts this, we scroll the text back again.
2131 ;; We implement this feature with a property called `isearch-scroll'.
2132 ;; If a command's symbol has the value t for this property or for the
2133 ;; `scroll-command' property, it is a scrolling command. The feature
2134 ;; needs to be enabled by setting the customizable variable
2135 ;; `isearch-allow-scroll' to a non-nil value.
2137 ;; The universal argument commands (e.g. C-u) in simple.el are marked
2138 ;; as scrolling commands, and isearch.el has been amended to allow
2139 ;; prefix arguments to be passed through to scrolling commands. Thus
2140 ;; M-0 C-l will scroll point to the top of the window.
2142 ;; Horizontal scrolling commands are currently not catered for.
2143 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2145 ;; Set the isearch-scroll property on some standard functions:
2146 ;; Scroll-bar functions:
2147 (if (fboundp 'scroll-bar-toolkit-scroll)
2148 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
2149 (if (fboundp 'w32-handle-scroll-bar-event)
2150 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
2152 ;; Commands which scroll the window (some scroll commands
2153 ;; already have the `scroll-command' property on them):
2154 (put 'recenter 'isearch-scroll t)
2155 (put 'recenter-top-bottom 'isearch-scroll t)
2156 (put 'reposition-window 'isearch-scroll t)
2158 ;; Commands which act on the other window
2159 (put 'list-buffers 'isearch-scroll t)
2160 (put 'scroll-other-window 'isearch-scroll t)
2161 (put 'scroll-other-window-down 'isearch-scroll t)
2162 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
2163 (put 'end-of-buffer-other-window 'isearch-scroll t)
2165 ;; Commands which change the window layout
2166 (put 'delete-other-windows 'isearch-scroll t)
2167 (put 'balance-windows 'isearch-scroll t)
2168 (put 'split-window-right 'isearch-scroll t)
2169 (put 'split-window-below 'isearch-scroll t)
2170 (put 'enlarge-window 'isearch-scroll t)
2172 ;; Aliases for split-window-*
2173 (put 'split-window-vertically 'isearch-scroll t)
2174 (put 'split-window-horizontally 'isearch-scroll t)
2176 ;; Universal argument commands
2177 (put 'universal-argument 'isearch-scroll t)
2178 (put 'negative-argument 'isearch-scroll t)
2179 (put 'digit-argument 'isearch-scroll t)
2181 (defcustom isearch-allow-scroll nil
2182 "Whether scrolling is allowed during incremental search.
2183 If non-nil, scrolling commands can be used in Isearch mode.
2184 However, the current match will never scroll offscreen.
2185 If nil, scrolling commands will first cancel Isearch mode."
2186 :type 'boolean
2187 :group 'isearch)
2189 (defcustom isearch-allow-prefix t
2190 "Whether prefix arguments are allowed during incremental search.
2191 If non-nil, entering a prefix argument will not terminate the
2192 search. This option is ignored \(presumed t) when
2193 `isearch-allow-scroll' is set."
2194 :version "24.4"
2195 :type 'boolean
2196 :group 'isearch)
2198 (defun isearch-string-out-of-window (isearch-point)
2199 "Test whether the search string is currently outside of the window.
2200 Return nil if it's completely visible, or if point is visible,
2201 together with as much of the search string as will fit; the symbol
2202 `above' if we need to scroll the text downwards; the symbol `below',
2203 if upwards."
2204 (let ((w-start (window-start))
2205 (w-end (window-end nil t))
2206 (w-L1 (save-excursion (move-to-window-line 1) (point)))
2207 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
2208 start end) ; start and end of search string in buffer
2209 (if isearch-forward
2210 (setq end isearch-point start (or isearch-other-end isearch-point))
2211 (setq start isearch-point end (or isearch-other-end isearch-point)))
2212 (cond ((or (and (>= start w-start) (<= end w-end))
2213 (if isearch-forward
2214 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
2215 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
2216 nil)
2217 ((and (< start w-start)
2218 (< isearch-point w-L-1))
2219 'above)
2220 (t 'below))))
2222 (defun isearch-back-into-window (above isearch-point)
2223 "Scroll the window to bring the search string back into view.
2224 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
2225 search string is above the top of the window, nil when it is beneath
2226 the bottom."
2227 (let (start end)
2228 (if isearch-forward
2229 (setq end isearch-point start (or isearch-other-end isearch-point))
2230 (setq start isearch-point end (or isearch-other-end isearch-point)))
2231 (if above
2232 (progn
2233 (goto-char start)
2234 (recenter 0)
2235 (when (>= isearch-point (window-end nil t))
2236 (goto-char isearch-point)
2237 (recenter -1)))
2238 (goto-char end)
2239 (recenter -1)
2240 (when (< isearch-point (window-start))
2241 (goto-char isearch-point)
2242 (recenter 0))))
2243 (goto-char isearch-point))
2245 (defvar isearch-pre-scroll-point nil)
2247 (defun isearch-pre-command-hook ()
2248 "Decide whether to exit Isearch mode before executing the command.
2249 Don't exit Isearch if the key sequence that invoked this command
2250 is bound in `isearch-mode-map', or if the invoked command is
2251 a prefix argument command (when `isearch-allow-prefix' is non-nil),
2252 or it is a scrolling command (when `isearch-allow-scroll' is non-nil).
2253 Otherwise, exit Isearch (when `search-exit-option' is non-nil)
2254 before the command is executed globally with terminated Isearch."
2255 (let* ((key (this-single-command-keys))
2256 (main-event (aref key 0)))
2257 (cond
2258 ;; Don't exit Isearch if we're in the middle of some
2259 ;; `set-transient-map' thingy like `universal-argument--mode'.
2260 ((not (eq overriding-terminal-local-map isearch--saved-overriding-local-map)))
2261 ;; Don't exit Isearch for isearch key bindings.
2262 ((commandp (lookup-key isearch-mode-map key nil)))
2263 ;; Optionally edit the search string instead of exiting.
2264 ((eq search-exit-option 'edit)
2265 (setq this-command 'isearch-edit-string))
2266 ;; Handle a scrolling function or prefix argument.
2267 ((or (and isearch-allow-prefix
2268 (memq this-command '(universal-argument
2269 digit-argument negative-argument)))
2270 (and isearch-allow-scroll
2271 (symbolp this-command)
2272 (or (eq (get this-command 'isearch-scroll) t)
2273 (eq (get this-command 'scroll-command) t))))
2274 (when isearch-allow-scroll
2275 (setq isearch-pre-scroll-point (point))))
2276 ;; A mouse click on the isearch message starts editing the search string.
2277 ((and (eq (car-safe main-event) 'down-mouse-1)
2278 (window-minibuffer-p (posn-window (event-start main-event))))
2279 ;; Swallow the up-event.
2280 (read-event)
2281 (setq this-command 'isearch-edit-string))
2282 ;; Other characters terminate the search and are then executed normally.
2283 (search-exit-option
2284 (isearch-done)
2285 (isearch-clean-overlays))
2286 ;; If search-exit-option is nil, run the command without exiting Isearch.
2288 (isearch-process-search-string key key)))))
2290 (defun isearch-post-command-hook ()
2291 (when isearch-pre-scroll-point
2292 (let ((ab-bel (isearch-string-out-of-window isearch-pre-scroll-point)))
2293 (if ab-bel
2294 (isearch-back-into-window (eq ab-bel 'above) isearch-pre-scroll-point)
2295 (goto-char isearch-pre-scroll-point)))
2296 (setq isearch-pre-scroll-point nil)
2297 (isearch-update)))
2299 (defun isearch-quote-char (&optional count)
2300 "Quote special characters for incremental search.
2301 With argument, add COUNT copies of the character."
2302 (interactive "p")
2303 (let ((char (read-quoted-char (isearch-message t))))
2304 (unless (characterp char)
2305 (user-error "%s is not a valid character"
2306 (key-description (vector char))))
2307 ;; Assume character codes 0200 - 0377 stand for characters in some
2308 ;; single-byte character set, and convert them to Emacs
2309 ;; characters.
2310 (if (and isearch-regexp isearch-regexp-lax-whitespace (= char ?\s))
2311 (if (subregexp-context-p isearch-string (length isearch-string))
2312 (isearch-process-search-string "[ ]" " ")
2313 (isearch-process-search-char char count))
2314 ;; This used to assume character codes 0240 - 0377 stand for
2315 ;; characters in some single-byte character set, and converted them
2316 ;; to Emacs characters. But in 23.1 this feature is deprecated
2317 ;; in favor of inserting the corresponding Unicode characters.
2318 ;; (and enable-multibyte-characters
2319 ;; (>= char ?\200)
2320 ;; (<= char ?\377)
2321 ;; (setq char (unibyte-char-to-multibyte char)))
2322 (isearch-process-search-char char count))))
2324 (defun isearch-printing-char (&optional char count)
2325 "Add this ordinary printing CHAR to the search string and search.
2326 With argument, add COUNT copies of the character."
2327 (interactive (list last-command-event
2328 (prefix-numeric-value current-prefix-arg)))
2329 (let ((char (or char last-command-event)))
2330 (if (= char ?\S-\ )
2331 (setq char ?\s))
2332 (if current-input-method
2333 (isearch-process-search-multibyte-characters char count)
2334 (isearch-process-search-char char count))))
2336 (defun isearch-process-search-char (char &optional count)
2337 ;; * and ? are special in regexps when not preceded by \.
2338 ;; } and | are special in regexps when preceded by \.
2339 ;; Nothing special for + because it matches at least once.
2340 (cond
2341 ((memq char '(?* ??)) (isearch-fallback nil))
2342 ((eq char ?\}) (isearch-fallback t t))
2343 ((eq char ?|) (isearch-fallback t nil t)))
2345 ;; Append the char(s) to the search string,
2346 ;; update the message and re-search.
2347 (let* ((string (if (and (integerp count) (> count 1))
2348 (make-string count char)
2349 (char-to-string char)))
2350 (message (if (>= char ?\200)
2351 string
2352 (mapconcat 'isearch-text-char-description string ""))))
2353 (isearch-process-search-string string message)))
2355 (defun isearch-process-search-string (string message)
2356 (setq isearch-string (concat isearch-string string)
2357 isearch-message (concat isearch-message message))
2358 (isearch-search-and-update))
2361 ;; Search Ring
2363 (defun isearch-ring-adjust1 (advance)
2364 ;; Helper for isearch-ring-adjust
2365 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2366 (length (length ring))
2367 (yank-pointer-name (if isearch-regexp
2368 'regexp-search-ring-yank-pointer
2369 'search-ring-yank-pointer))
2370 (yank-pointer (eval yank-pointer-name)))
2371 (if (zerop length)
2373 (set yank-pointer-name
2374 (setq yank-pointer
2375 (mod (+ (or yank-pointer (if advance 0 -1))
2376 (if advance -1 1))
2377 length)))
2378 (setq isearch-string (nth yank-pointer ring)
2379 isearch-message (mapconcat 'isearch-text-char-description
2380 isearch-string "")))))
2382 (defun isearch-ring-adjust (advance)
2383 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2384 (isearch-ring-adjust1 advance)
2385 (if search-ring-update
2386 (progn
2387 (isearch-search)
2388 (isearch-push-state)
2389 (isearch-update))
2390 ;; Otherwise, edit the search string instead. Note that there is
2391 ;; no need to push the search state after isearch-edit-string here
2392 ;; since isearch-edit-string already pushes its state
2393 (isearch-edit-string)))
2395 (defun isearch-ring-advance ()
2396 "Advance to the next search string in the ring."
2397 ;; This could be more general to handle a prefix arg, but who would use it.
2398 (interactive)
2399 (isearch-ring-adjust 'advance))
2401 (defun isearch-ring-retreat ()
2402 "Retreat to the previous search string in the ring."
2403 (interactive)
2404 (isearch-ring-adjust nil))
2406 (defun isearch-complete1 ()
2407 ;; Helper for isearch-complete and isearch-complete-edit
2408 ;; Return t if completion OK, nil if no completion exists.
2409 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2410 (completion-ignore-case case-fold-search)
2411 (completion (try-completion isearch-string ring)))
2412 (cond
2413 ((eq completion t)
2414 ;; isearch-string stays the same
2416 ((or completion ; not nil, must be a string
2417 (= 0 (length isearch-string))) ; shouldn't have to say this
2418 (if (equal completion isearch-string) ;; no extension?
2419 (progn
2420 (if completion-auto-help
2421 (with-output-to-temp-buffer "*Isearch completions*"
2422 (display-completion-list
2423 (all-completions isearch-string ring))))
2425 (and completion
2426 (setq isearch-string completion))))
2428 (message "No completion") ; waits a second if in minibuffer
2429 nil))))
2431 (defun isearch-complete ()
2432 "Complete the search string from the strings on the search ring.
2433 The completed string is then editable in the minibuffer.
2434 If there is no completion possible, say so and continue searching."
2435 (interactive)
2436 (if (isearch-complete1)
2437 (progn (setq isearch-message
2438 (mapconcat 'isearch-text-char-description
2439 isearch-string ""))
2440 (isearch-edit-string))
2441 ;; else
2442 (sit-for 1)
2443 (isearch-update)))
2445 (defun isearch-complete-edit ()
2446 "Same as `isearch-complete' except in the minibuffer."
2447 (interactive)
2448 (setq isearch-string (field-string))
2449 (if (isearch-complete1)
2450 (progn
2451 (delete-field)
2452 (insert isearch-string))))
2455 ;; Message string
2457 (defun isearch-message (&optional c-q-hack ellipsis)
2458 ;; Generate and print the message string.
2459 (let ((cursor-in-echo-area ellipsis)
2460 (m isearch-message)
2461 (fail-pos (isearch-fail-pos t)))
2462 ;; Highlight failed part
2463 (when fail-pos
2464 (setq m (copy-sequence m))
2465 (add-text-properties fail-pos (length m) '(face isearch-fail) m)
2466 ;; Highlight failed trailing whitespace
2467 (when (string-match " +$" m)
2468 (add-text-properties (match-beginning 0) (match-end 0)
2469 '(face trailing-whitespace) m)))
2470 (setq m (concat
2471 (isearch-message-prefix ellipsis isearch-nonincremental)
2473 (isearch-message-suffix c-q-hack)))
2474 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2476 (defun isearch-message-prefix (&optional ellipsis nonincremental)
2477 ;; If about to search, and previous search regexp was invalid,
2478 ;; check that it still is. If it is valid now,
2479 ;; let the message we display while searching say that it is valid.
2480 (and isearch-error ellipsis
2481 (condition-case ()
2482 (progn (re-search-forward isearch-string (point) t)
2483 (setq isearch-error nil))
2484 (error nil)))
2485 ;; If currently failing, display no ellipsis.
2486 (or isearch-success (setq ellipsis nil))
2487 (let ((m (concat (if isearch-success "" "failing ")
2488 (if isearch-adjusted "pending " "")
2489 (if (and isearch-wrapped
2490 (not isearch-wrap-function)
2491 (if isearch-forward
2492 (> (point) isearch-opoint)
2493 (< (point) isearch-opoint)))
2494 "over")
2495 (if isearch-wrapped "wrapped ")
2496 (let ((prefix ""))
2497 (advice-function-mapc
2498 (lambda (_ props)
2499 (let ((np (cdr (assq 'isearch-message-prefix props))))
2500 (if np (setq prefix (concat np prefix)))))
2501 isearch-filter-predicate)
2502 prefix)
2503 (if isearch-word
2504 (or (and (symbolp isearch-word)
2505 (get isearch-word 'isearch-message-prefix))
2506 "word ")
2508 (if isearch-regexp "regexp " "")
2509 (if multi-isearch-next-buffer-current-function "multi " "")
2510 (or isearch-message-prefix-add "")
2511 (if nonincremental "search" "I-search")
2512 (if isearch-forward "" " backward")
2513 (if current-input-method
2514 ;; Input methods for RTL languages use RTL
2515 ;; characters for their title, and that messes
2516 ;; up the display of search text after the prompt.
2517 (bidi-string-mark-left-to-right
2518 (concat " [" current-input-method-title "]: "))
2519 ": ")
2521 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2522 'face 'minibuffer-prompt)))
2524 (defun isearch-message-suffix (&optional c-q-hack)
2525 (concat (if c-q-hack "^Q" "")
2526 (if isearch-error
2527 (concat " [" isearch-error "]")
2529 (or isearch-message-suffix-add "")))
2532 ;; Searching
2534 (defvar isearch-search-fun-function 'isearch-search-fun-default
2535 "Non-default value overrides the behavior of `isearch-search-fun-default'.
2536 This variable's value should be a function, which will be called
2537 with no arguments, and should return a function that takes three
2538 arguments: STRING, BOUND, and NOERROR.
2540 This returned function will be used by `isearch-search-string' to
2541 search for the first occurrence of STRING or its translation.")
2543 (defun isearch-search-fun ()
2544 "Return the function to use for the search.
2545 Can be changed via `isearch-search-fun-function' for special needs."
2546 (funcall (or isearch-search-fun-function 'isearch-search-fun-default)))
2548 (defun isearch-search-fun-default ()
2549 "Return default functions to use for the search."
2550 (cond
2551 (isearch-word
2552 (lambda (string &optional bound noerror count)
2553 ;; Use lax versions to not fail at the end of the word while
2554 ;; the user adds and removes characters in the search string
2555 ;; (or when using nonincremental word isearch)
2556 (let ((lax (not (or isearch-nonincremental
2557 (null (car isearch-cmds))
2558 (eq (length isearch-string)
2559 (length (isearch--state-string
2560 (car isearch-cmds))))))))
2561 (funcall
2562 (if isearch-forward #'re-search-forward #'re-search-backward)
2563 (if (functionp isearch-word)
2564 (funcall isearch-word string lax)
2565 (word-search-regexp string lax))
2566 bound noerror count))))
2567 ((and isearch-regexp isearch-regexp-lax-whitespace
2568 search-whitespace-regexp)
2569 (if isearch-forward
2570 're-search-forward-lax-whitespace
2571 're-search-backward-lax-whitespace))
2572 (isearch-regexp
2573 (if isearch-forward 're-search-forward 're-search-backward))
2574 ((and isearch-lax-whitespace search-whitespace-regexp)
2575 (if isearch-forward
2576 'search-forward-lax-whitespace
2577 'search-backward-lax-whitespace))
2579 (if isearch-forward 'search-forward 'search-backward))))
2581 (defun isearch-search-string (string bound noerror)
2582 "Search for the first occurrence of STRING or its translation.
2583 If found, move point to the end of the occurrence,
2584 update the match data, and return point."
2585 (let* ((func (isearch-search-fun))
2586 (pos1 (save-excursion (funcall func string bound noerror)))
2587 pos2)
2588 (when (and
2589 ;; Avoid "obsolete" warnings for translation-table-for-input.
2590 (with-no-warnings
2591 (char-table-p translation-table-for-input))
2592 (multibyte-string-p string)
2593 ;; Minor optimization.
2594 (string-match-p "[^[:ascii:]]" string))
2595 (let ((translated
2596 (apply 'string
2597 (mapcar (lambda (c)
2599 ;; Avoid "obsolete" warnings for
2600 ;; translation-table-for-input.
2601 (with-no-warnings
2602 (aref translation-table-for-input c))
2604 string)))
2605 match-data)
2606 (when translated
2607 (save-match-data
2608 (save-excursion
2609 (if (setq pos2 (funcall func translated bound noerror))
2610 (setq match-data (match-data t)))))
2611 (when (and pos2
2612 (or (not pos1)
2613 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2614 (setq pos1 pos2)
2615 (set-match-data match-data)))))
2616 (when pos1
2617 ;; When using multiple buffers isearch, switch to the new buffer here,
2618 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2619 (if (and multi-isearch-next-buffer-current-function
2620 (buffer-live-p multi-isearch-current-buffer))
2621 (switch-to-buffer multi-isearch-current-buffer))
2622 (goto-char pos1)
2623 pos1)))
2625 (defun isearch-search ()
2626 ;; Do the search with the current search string.
2627 (if isearch-message-function
2628 (funcall isearch-message-function nil t)
2629 (isearch-message nil t))
2630 (if (and (eq isearch-case-fold-search t) search-upper-case)
2631 (setq isearch-case-fold-search
2632 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2633 (condition-case lossage
2634 (let ((inhibit-point-motion-hooks isearch-invisible)
2635 (inhibit-quit nil)
2636 (case-fold-search isearch-case-fold-search)
2637 (search-invisible isearch-invisible)
2638 (retry t))
2639 (setq isearch-error nil)
2640 (while retry
2641 (setq isearch-success
2642 (isearch-search-string isearch-string nil t))
2643 ;; Clear RETRY unless the search predicate says
2644 ;; to skip this search hit.
2645 (if (or (not isearch-success)
2646 (bobp) (eobp)
2647 (= (match-beginning 0) (match-end 0))
2648 (funcall isearch-filter-predicate
2649 (match-beginning 0) (match-end 0)))
2650 (setq retry nil)))
2651 (setq isearch-just-started nil)
2652 (if isearch-success
2653 (setq isearch-other-end
2654 (if isearch-forward (match-beginning 0) (match-end 0)))))
2656 (quit (isearch-unread ?\C-g)
2657 (setq isearch-success nil))
2659 (invalid-regexp
2660 (setq isearch-error (car (cdr lossage)))
2661 (cond
2662 ((string-match
2663 "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
2664 isearch-error)
2665 (setq isearch-error "incomplete input"))
2666 ((and (not isearch-regexp)
2667 (string-match "\\`Regular expression too big" isearch-error))
2668 (cond
2669 (isearch-word
2670 (setq isearch-error "Too many words"))
2671 ((and isearch-lax-whitespace search-whitespace-regexp)
2672 (setq isearch-error "Too many spaces for whitespace matching"))))))
2674 (search-failed
2675 (setq isearch-success nil)
2676 (setq isearch-error (nth 2 lossage)))
2678 (error
2679 ;; stack overflow in regexp search.
2680 (setq isearch-error (format "%s" lossage))))
2682 (if isearch-success
2684 ;; Ding if failed this time after succeeding last time.
2685 (and (isearch--state-success (car isearch-cmds))
2686 (ding))
2687 (if (functionp (isearch--state-pop-fun (car isearch-cmds)))
2688 (funcall (isearch--state-pop-fun (car isearch-cmds))
2689 (car isearch-cmds)))
2690 (goto-char (isearch--state-point (car isearch-cmds)))))
2693 ;; Called when opening an overlay, and we are still in isearch.
2694 (defun isearch-open-overlay-temporary (ov)
2695 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2696 ;; Some modes would want to open the overlays temporary during
2697 ;; isearch in their own way, they should set the
2698 ;; `isearch-open-invisible-temporary' to a function doing this.
2699 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2700 ;; Store the values for the `invisible' and `intangible'
2701 ;; properties, and then set them to nil. This way the text hidden
2702 ;; by this overlay becomes visible.
2704 ;; Do we really need to set the `intangible' property to t? Can we
2705 ;; have the point inside an overlay with an `intangible' property?
2706 ;; In 19.34 this does not exist so I cannot test it.
2707 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2708 (overlay-put ov 'isearch-intangible (overlay-get ov 'intangible))
2709 (overlay-put ov 'invisible nil)
2710 (overlay-put ov 'intangible nil)))
2713 ;; This is called at the end of isearch. It will open the overlays
2714 ;; that contain the latest match. Obviously in case of a C-g the
2715 ;; point returns to the original location which surely is not contain
2716 ;; in any of these overlays, se we are safe in this case too.
2717 (defun isearch-open-necessary-overlays (ov)
2718 (let ((inside-overlay (and (> (point) (overlay-start ov))
2719 (< (point) (overlay-end ov))))
2720 ;; If this exists it means that the overlay was opened using
2721 ;; this function, not by us tweaking the overlay properties.
2722 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2723 (when (or inside-overlay (not fct-temp))
2724 ;; restore the values for the `invisible' and `intangible'
2725 ;; properties
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))
2730 (if inside-overlay
2731 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2732 (if fct-temp
2733 (funcall fct-temp ov t)))))
2735 ;; This is called when exiting isearch. It closes the temporary
2736 ;; opened overlays, except the ones that contain the latest match.
2737 (defun isearch-clean-overlays ()
2738 (when isearch-opened-overlays
2739 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2740 (setq isearch-opened-overlays nil)))
2743 (defun isearch-intersects-p (start0 end0 start1 end1)
2744 "Return t if regions START0..END0 and START1..END1 intersect."
2745 (or (and (>= start0 start1) (< start0 end1))
2746 (and (> end0 start1) (<= end0 end1))
2747 (and (>= start1 start0) (< start1 end0))
2748 (and (> end1 start0) (<= end1 end0))))
2751 ;; Verify if the current match is outside of each element of
2752 ;; `isearch-opened-overlays', if so close that overlay.
2754 (defun isearch-close-unnecessary-overlays (begin end)
2755 (let ((overlays isearch-opened-overlays))
2756 (setq isearch-opened-overlays nil)
2757 (dolist (ov overlays)
2758 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2759 (push ov isearch-opened-overlays)
2760 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2761 (if fct-temp
2762 ;; If this exists it means that the overlay was opened
2763 ;; using this function, not by us tweaking the overlay
2764 ;; properties.
2765 (funcall fct-temp ov t)
2766 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2767 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2768 (overlay-put ov 'isearch-invisible nil)
2769 (overlay-put ov 'isearch-intangible nil)))))))
2772 (defun isearch-range-invisible (beg end)
2773 "Return t if all the text from BEG to END is invisible."
2774 (when (/= beg end)
2775 ;; Check that invisibility runs up to END.
2776 (save-excursion
2777 (goto-char beg)
2778 (let (;; can-be-opened keeps track if we can open some overlays.
2779 (can-be-opened (eq search-invisible 'open))
2780 ;; the list of overlays that could be opened
2781 (crt-overlays nil))
2782 (when (and can-be-opened isearch-hide-immediately)
2783 (isearch-close-unnecessary-overlays beg end))
2784 ;; If the following character is currently invisible,
2785 ;; skip all characters with that same `invisible' property value.
2786 ;; Do that over and over.
2787 (while (and (< (point) end) (invisible-p (point)))
2788 (if (invisible-p (get-text-property (point) 'invisible))
2789 (progn
2790 (goto-char (next-single-property-change (point) 'invisible
2791 nil end))
2792 ;; if text is hidden by an `invisible' text property
2793 ;; we cannot open it at all.
2794 (setq can-be-opened nil))
2795 (when can-be-opened
2796 (let ((overlays (overlays-at (point)))
2797 ov-list
2799 invis-prop)
2800 (while overlays
2801 (setq o (car overlays)
2802 invis-prop (overlay-get o 'invisible))
2803 (if (invisible-p invis-prop)
2804 (if (overlay-get o 'isearch-open-invisible)
2805 (setq ov-list (cons o ov-list))
2806 ;; We found one overlay that cannot be
2807 ;; opened, that means the whole chunk
2808 ;; cannot be opened.
2809 (setq can-be-opened nil)))
2810 (setq overlays (cdr overlays)))
2811 (if can-be-opened
2812 ;; It makes sense to append to the open
2813 ;; overlays list only if we know that this is
2814 ;; t.
2815 (setq crt-overlays (append ov-list crt-overlays)))))
2816 (goto-char (next-overlay-change (point)))))
2817 ;; See if invisibility reaches up thru END.
2818 (if (>= (point) end)
2819 (if (and can-be-opened (consp crt-overlays))
2820 (progn
2821 (setq isearch-opened-overlays
2822 (append isearch-opened-overlays crt-overlays))
2823 (mapc 'isearch-open-overlay-temporary crt-overlays)
2824 nil)
2825 (setq isearch-hidden t)))))))
2827 (defun isearch-filter-visible (beg end)
2828 "Test whether the current search hit is visible at least partially.
2829 Return non-nil if the text from BEG to END is visible to Isearch as
2830 determined by `isearch-range-invisible' unless invisible text can be
2831 searched too when `search-invisible' is t."
2832 (or (eq search-invisible t)
2833 (not (isearch-range-invisible beg end))))
2836 ;; General utilities
2838 (defun isearch-no-upper-case-p (string regexp-flag)
2839 "Return t if there are no upper case chars in STRING.
2840 If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
2841 since they have special meaning in a regexp."
2842 (let (quote-flag (i 0) (len (length string)) found)
2843 (while (and (not found) (< i len))
2844 (let ((char (aref string i)))
2845 (if (and regexp-flag (eq char ?\\))
2846 (setq quote-flag (not quote-flag))
2847 (if (and (not quote-flag) (not (eq char (downcase char))))
2848 (setq found t))
2849 (setq quote-flag nil)))
2850 (setq i (1+ i)))
2851 (not (or found
2852 ;; Even if there's no uppercase char, we want to detect the use
2853 ;; of [:upper:] or [:lower:] char-class, which indicates
2854 ;; clearly that the user cares about case distinction.
2855 (and regexp-flag (string-match "\\[:\\(upp\\|low\\)er:]" string)
2856 (condition-case err
2857 (progn
2858 (string-match (substring string 0 (match-beginning 0))
2860 nil)
2861 (invalid-regexp
2862 (equal "Unmatched [ or [^" (cadr err)))))))))
2864 ;; Portability functions to support various Emacs versions.
2866 (defun isearch-text-char-description (c)
2867 (cond
2868 ((< c ?\s) (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph))
2869 ((= c ?\^?) (propertize "^?" 'face 'escape-glyph))
2870 (t (char-to-string c))))
2872 ;; General function to unread characters or events.
2873 ;; Also insert them in a keyboard macro being defined.
2874 (defun isearch-unread (&rest char-or-events)
2875 (mapc 'store-kbd-macro-event char-or-events)
2876 (setq unread-command-events
2877 (append char-or-events unread-command-events)))
2880 ;; Highlighting
2882 (defvar isearch-overlay nil)
2884 (defun isearch-highlight (beg end)
2885 (if search-highlight
2886 (if isearch-overlay
2887 ;; Overlay already exists, just move it.
2888 (move-overlay isearch-overlay beg end (current-buffer))
2889 ;; Overlay doesn't exist, create it.
2890 (setq isearch-overlay (make-overlay beg end))
2891 ;; 1001 is higher than lazy's 1000 and ediff's 100+
2892 (overlay-put isearch-overlay 'priority 1001)
2893 (overlay-put isearch-overlay 'face isearch-face))))
2895 (defun isearch-dehighlight ()
2896 (when isearch-overlay
2897 (delete-overlay isearch-overlay)))
2899 ;; isearch-lazy-highlight feature
2900 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
2902 ;; When active, *every* match for the current search string is
2903 ;; highlighted: the current one using the normal isearch match color
2904 ;; and all the others using `isearch-lazy-highlight'. The extra
2905 ;; highlighting makes it easier to anticipate where the cursor will
2906 ;; land each time you press C-s or C-r to repeat a pending search.
2907 ;; Highlighting of these additional matches happens in a deferred
2908 ;; fashion using "idle timers," so the cycles needed do not rob
2909 ;; isearch of its usual snappy response.
2911 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
2912 ;; Specifically:
2913 ;; - `isearch-update' is expected to be called (at least) every time
2914 ;; the search string or window-start changes;
2915 ;; - `isearch-string' is expected to contain the current search
2916 ;; string as entered by the user;
2917 ;; - the type of the current search is expected to be given by
2918 ;; `isearch-word' and `isearch-regexp';
2919 ;; - the direction of the current search is expected to be given by
2920 ;; `isearch-forward';
2921 ;; - the variable `isearch-error' is expected to be true
2922 ;; only if `isearch-string' is an invalid regexp.
2924 (defvar isearch-lazy-highlight-overlays nil)
2925 (defvar isearch-lazy-highlight-wrapped nil)
2926 (defvar isearch-lazy-highlight-start-limit nil)
2927 (defvar isearch-lazy-highlight-end-limit nil)
2928 (defvar isearch-lazy-highlight-start nil)
2929 (defvar isearch-lazy-highlight-end nil)
2930 (defvar isearch-lazy-highlight-timer nil)
2931 (defvar isearch-lazy-highlight-last-string nil)
2932 (defvar isearch-lazy-highlight-window nil)
2933 (defvar isearch-lazy-highlight-window-start nil)
2934 (defvar isearch-lazy-highlight-window-end nil)
2935 (defvar isearch-lazy-highlight-case-fold-search nil)
2936 (defvar isearch-lazy-highlight-regexp nil)
2937 (defvar isearch-lazy-highlight-lax-whitespace nil)
2938 (defvar isearch-lazy-highlight-regexp-lax-whitespace nil)
2939 (defvar isearch-lazy-highlight-word nil)
2940 (defvar isearch-lazy-highlight-forward nil)
2941 (defvar isearch-lazy-highlight-error nil)
2943 (defun lazy-highlight-cleanup (&optional force)
2944 "Stop lazy highlighting and remove extra highlighting from current buffer.
2945 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
2946 is nil. This function is called when exiting an incremental search if
2947 `lazy-highlight-cleanup' is non-nil."
2948 (interactive '(t))
2949 (if (or force lazy-highlight-cleanup)
2950 (while isearch-lazy-highlight-overlays
2951 (delete-overlay (car isearch-lazy-highlight-overlays))
2952 (setq isearch-lazy-highlight-overlays
2953 (cdr isearch-lazy-highlight-overlays))))
2954 (when isearch-lazy-highlight-timer
2955 (cancel-timer isearch-lazy-highlight-timer)
2956 (setq isearch-lazy-highlight-timer nil)))
2958 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
2959 'lazy-highlight-cleanup
2960 "22.1")
2962 (defun isearch-lazy-highlight-new-loop (&optional beg end)
2963 "Cleanup any previous `lazy-highlight' loop and begin a new one.
2964 BEG and END specify the bounds within which highlighting should occur.
2965 This is called when `isearch-update' is invoked (which can cause the
2966 search string to change or the window to scroll). It is also used
2967 by other Emacs features."
2968 (when (and (null executing-kbd-macro)
2969 (sit-for 0) ;make sure (window-start) is credible
2970 (or (not (equal isearch-string
2971 isearch-lazy-highlight-last-string))
2972 (not (eq (selected-window)
2973 isearch-lazy-highlight-window))
2974 (not (eq isearch-lazy-highlight-case-fold-search
2975 isearch-case-fold-search))
2976 (not (eq isearch-lazy-highlight-regexp
2977 isearch-regexp))
2978 (not (eq isearch-lazy-highlight-word
2979 isearch-word))
2980 (not (eq isearch-lazy-highlight-lax-whitespace
2981 isearch-lax-whitespace))
2982 (not (eq isearch-lazy-highlight-regexp-lax-whitespace
2983 isearch-regexp-lax-whitespace))
2984 (not (= (window-start)
2985 isearch-lazy-highlight-window-start))
2986 (not (= (window-end) ; Window may have been split/joined.
2987 isearch-lazy-highlight-window-end))
2988 (not (eq isearch-forward
2989 isearch-lazy-highlight-forward))
2990 ;; In case we are recovering from an error.
2991 (not (equal isearch-error
2992 isearch-lazy-highlight-error))))
2993 ;; something important did indeed change
2994 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
2995 (setq isearch-lazy-highlight-error isearch-error)
2996 ;; It used to check for `(not isearch-error)' here, but actually
2997 ;; lazy-highlighting might find matches to highlight even when
2998 ;; `isearch-error' is non-nil. (Bug#9918)
2999 (setq isearch-lazy-highlight-start-limit beg
3000 isearch-lazy-highlight-end-limit end)
3001 (setq isearch-lazy-highlight-window (selected-window)
3002 isearch-lazy-highlight-window-start (window-start)
3003 isearch-lazy-highlight-window-end (window-end)
3004 ;; Start lazy-highlighting at the beginning of the found
3005 ;; match (`isearch-other-end'). If no match, use point.
3006 ;; One of the next two variables (depending on search direction)
3007 ;; is used to define the starting position of lazy-highlighting
3008 ;; and also to remember the current position of point between
3009 ;; calls of `isearch-lazy-highlight-update', and another variable
3010 ;; is used to define where the wrapped search must stop.
3011 isearch-lazy-highlight-start (or isearch-other-end (point))
3012 isearch-lazy-highlight-end (or isearch-other-end (point))
3013 isearch-lazy-highlight-wrapped nil
3014 isearch-lazy-highlight-last-string isearch-string
3015 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
3016 isearch-lazy-highlight-regexp isearch-regexp
3017 isearch-lazy-highlight-lax-whitespace isearch-lax-whitespace
3018 isearch-lazy-highlight-regexp-lax-whitespace isearch-regexp-lax-whitespace
3019 isearch-lazy-highlight-word isearch-word
3020 isearch-lazy-highlight-forward isearch-forward)
3021 (unless (equal isearch-string "")
3022 (setq isearch-lazy-highlight-timer
3023 (run-with-idle-timer lazy-highlight-initial-delay nil
3024 'isearch-lazy-highlight-update)))))
3026 (defun isearch-lazy-highlight-search ()
3027 "Search ahead for the next or previous match, for lazy highlighting.
3028 Attempt to do the search exactly the way the pending Isearch would."
3029 (condition-case nil
3030 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
3031 (isearch-regexp isearch-lazy-highlight-regexp)
3032 (isearch-word isearch-lazy-highlight-word)
3033 (isearch-lax-whitespace
3034 isearch-lazy-highlight-lax-whitespace)
3035 (isearch-regexp-lax-whitespace
3036 isearch-lazy-highlight-regexp-lax-whitespace)
3037 (isearch-forward isearch-lazy-highlight-forward)
3038 (search-invisible nil) ; don't match invisible text
3039 (retry t)
3040 (success nil)
3041 (bound (if isearch-lazy-highlight-forward
3042 (min (or isearch-lazy-highlight-end-limit (point-max))
3043 (if isearch-lazy-highlight-wrapped
3044 isearch-lazy-highlight-start
3045 (window-end)))
3046 (max (or isearch-lazy-highlight-start-limit (point-min))
3047 (if isearch-lazy-highlight-wrapped
3048 isearch-lazy-highlight-end
3049 (window-start))))))
3050 ;; Use a loop like in `isearch-search'.
3051 (while retry
3052 (setq success (isearch-search-string
3053 isearch-lazy-highlight-last-string bound t))
3054 ;; Clear RETRY unless the search predicate says
3055 ;; to skip this search hit.
3056 (if (or (not success)
3057 (= (point) bound) ; like (bobp) (eobp) in `isearch-search'.
3058 (= (match-beginning 0) (match-end 0))
3059 (funcall isearch-filter-predicate
3060 (match-beginning 0) (match-end 0)))
3061 (setq retry nil)))
3062 success)
3063 (error nil)))
3065 (defun isearch-lazy-highlight-update ()
3066 "Update highlighting of other matches for current search."
3067 (let ((max lazy-highlight-max-at-a-time)
3068 (looping t)
3069 nomore)
3070 (with-local-quit
3071 (save-selected-window
3072 (if (and (window-live-p isearch-lazy-highlight-window)
3073 (not (eq (selected-window) isearch-lazy-highlight-window)))
3074 (select-window isearch-lazy-highlight-window))
3075 (save-excursion
3076 (save-match-data
3077 (goto-char (if isearch-lazy-highlight-forward
3078 isearch-lazy-highlight-end
3079 isearch-lazy-highlight-start))
3080 (while looping
3081 (let ((found (isearch-lazy-highlight-search)))
3082 (when max
3083 (setq max (1- max))
3084 (if (<= max 0)
3085 (setq looping nil)))
3086 (if found
3087 (let ((mb (match-beginning 0))
3088 (me (match-end 0)))
3089 (if (= mb me) ;zero-length match
3090 (if isearch-lazy-highlight-forward
3091 (if (= mb (if isearch-lazy-highlight-wrapped
3092 isearch-lazy-highlight-start
3093 (window-end)))
3094 (setq found nil)
3095 (forward-char 1))
3096 (if (= mb (if isearch-lazy-highlight-wrapped
3097 isearch-lazy-highlight-end
3098 (window-start)))
3099 (setq found nil)
3100 (forward-char -1)))
3102 ;; non-zero-length match
3103 (let ((ov (make-overlay mb me)))
3104 (push ov isearch-lazy-highlight-overlays)
3105 ;; 1000 is higher than ediff's 100+,
3106 ;; but lower than isearch main overlay's 1001
3107 (overlay-put ov 'priority 1000)
3108 (overlay-put ov 'face lazy-highlight-face)
3109 (overlay-put ov 'window (selected-window))))
3110 ;; Remember the current position of point for
3111 ;; the next call of `isearch-lazy-highlight-update'
3112 ;; when `lazy-highlight-max-at-a-time' is too small.
3113 (if isearch-lazy-highlight-forward
3114 (setq isearch-lazy-highlight-end (point))
3115 (setq isearch-lazy-highlight-start (point)))))
3117 ;; not found or zero-length match at the search bound
3118 (if (not found)
3119 (if isearch-lazy-highlight-wrapped
3120 (setq looping nil
3121 nomore t)
3122 (setq isearch-lazy-highlight-wrapped t)
3123 (if isearch-lazy-highlight-forward
3124 (progn
3125 (setq isearch-lazy-highlight-end (window-start))
3126 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
3127 (window-start))))
3128 (setq isearch-lazy-highlight-start (window-end))
3129 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
3130 (window-end))))))))
3131 (unless nomore
3132 (setq isearch-lazy-highlight-timer
3133 (run-at-time lazy-highlight-interval nil
3134 'isearch-lazy-highlight-update)))))))))
3136 (defun isearch-resume (string regexp word forward message case-fold)
3137 "Resume an incremental search.
3138 STRING is the string or regexp searched for.
3139 REGEXP non-nil means the resumed search was a regexp search.
3140 WORD non-nil means resume a word search.
3141 FORWARD non-nil means resume a forward search.
3142 MESSAGE is the echo-area message recorded for the search resumed.
3143 CASE-FOLD non-nil means the search was case-insensitive."
3144 (isearch-mode forward regexp nil nil word)
3145 (setq isearch-string string
3146 isearch-message message
3147 isearch-case-fold-search case-fold)
3148 (isearch-search)
3149 (isearch-update))
3151 ;;; isearch.el ends here