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