* progmodes/meta-mode.el (meta-complete-symbol):
[emacs.git] / lisp / isearch.el
blob7505d3e4d320d96ebffdf2e93b38dfce3051136f
1 ;;; isearch.el --- incremental search minor mode
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
5 ;; Free Software Foundation, Inc.
7 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
8 ;; Maintainer: FSF
9 ;; Keywords: matching
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; Instructions
30 ;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
31 ;; isearch-mode behaves modally and does not return until the search
32 ;; is completed. It uses a recursive-edit to behave this way.
34 ;; The key bindings active within isearch-mode are defined below in
35 ;; `isearch-mode-map' which is given bindings close to the default
36 ;; characters of the original isearch.el. With `isearch-mode',
37 ;; however, you can bind multi-character keys and it should be easier
38 ;; to add new commands. One bug though: keys with meta-prefix cannot
39 ;; be longer than two chars. Also see minibuffer-local-isearch-map
40 ;; for bindings active during `isearch-edit-string'.
42 ;; isearch-mode should work even if you switch windows with the mouse,
43 ;; in which case isearch-mode is terminated automatically before the
44 ;; switch.
46 ;; The search ring and completion commands automatically put you in
47 ;; the minibuffer to edit the string. This gives you a chance to
48 ;; modify the search string before executing the search. There are
49 ;; three commands to terminate the editing: C-s and C-r exit the
50 ;; minibuffer and search forward and reverse respectively, while C-m
51 ;; exits and does a nonincremental search.
53 ;; Exiting immediately from isearch uses isearch-edit-string instead
54 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
55 ;; The name of this option should probably be changed if we decide to
56 ;; keep the behavior. No point in forcing nonincremental search until
57 ;; the last possible moment.
59 ;;; Code:
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 if 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 This applies to regular expression incremental search.
115 When you put a space or spaces in the incremental regexp, it stands for
116 this, unless it is inside of a regexp construct such as [...] or *, + or ?.
117 You might want to use something like \"[ \\t\\r\\n]+\" instead.
118 In the Customization buffer, that is `[' followed by a space,
119 a tab, a carriage return (control-M), a newline, and `]+'.
121 When this is nil, each space you type matches literally, against one space."
122 :type '(choice (const :tag "Find Spaces Literally" nil)
123 regexp)
124 :group 'isearch)
126 (defcustom search-invisible 'open
127 "If t incremental search can match hidden text.
128 A nil value means don't match invisible text.
129 When the value is `open', if the text matched is made invisible by
130 an overlay having an `invisible' property and that overlay has a property
131 `isearch-open-invisible', then incremental search will show the contents.
132 \(This applies when using `outline.el' and `hideshow.el'.)
133 See also `reveal-mode' if you want overlays to automatically be opened
134 whenever point is in one of them."
135 :type '(choice (const :tag "Match hidden text" t)
136 (const :tag "Open overlays" open)
137 (const :tag "Don't match hidden text" nil))
138 :group 'isearch)
140 (defcustom isearch-hide-immediately t
141 "If non-nil, re-hide an invisible match right away.
142 This variable makes a difference when `search-invisible' is set to `open'.
143 It means that after search makes some invisible text visible
144 to show the match, it makes the text invisible again when the match moves.
145 Ordinarily the text becomes invisible again at the end of the search."
146 :type 'boolean
147 :group 'isearch)
149 (defcustom isearch-resume-in-command-history nil
150 "If non-nil, `isearch-resume' commands are added to the command history.
151 This allows you to resume earlier Isearch sessions through the
152 command history."
153 :type 'boolean
154 :group 'isearch)
156 (defvar isearch-mode-hook nil
157 "Function(s) to call after starting up an incremental search.")
159 (defvar isearch-mode-end-hook nil
160 "Function(s) to call after terminating an incremental search.
161 When these functions are called, `isearch-mode-end-hook-quit'
162 is non-nil if the user quits the search.")
164 (defvar isearch-mode-end-hook-quit nil
165 "Non-nil while running `isearch-mode-end-hook' if the user quits the search.")
167 (defvar isearch-message-function nil
168 "Function to call to display the search prompt.
169 If nil, use `isearch-message'.")
171 (defvar isearch-wrap-function nil
172 "Function to call to wrap the search when search is failed.
173 If nil, move point to the beginning of the buffer for a forward search,
174 or to the end of the buffer for a backward search.")
176 (defvar isearch-push-state-function nil
177 "Function to save a function restoring the mode-specific Isearch state
178 to the search status stack.")
180 (defvar isearch-filter-predicate 'isearch-filter-visible
181 "Predicate that filters the search hits that would normally be available.
182 Search hits that dissatisfy the predicate are skipped. The function
183 has two arguments: the positions of start and end of text matched by
184 the search. If this function returns nil, continue searching without
185 stopping at this match.")
187 ;; Search ring.
189 (defvar search-ring nil
190 "List of search string sequences.")
191 (defvar regexp-search-ring nil
192 "List of regular expression search string sequences.")
194 (defcustom search-ring-max 16
195 "Maximum length of search ring before oldest elements are thrown away."
196 :type 'integer
197 :group 'isearch)
198 (defcustom regexp-search-ring-max 16
199 "Maximum length of regexp search ring before oldest elements are thrown away."
200 :type 'integer
201 :group 'isearch)
203 (defvar search-ring-yank-pointer nil
204 "Index in `search-ring' of last string reused.
205 It is nil if none yet.")
206 (defvar regexp-search-ring-yank-pointer nil
207 "Index in `regexp-search-ring' of last string reused.
208 It is nil if none yet.")
210 (defcustom search-ring-update nil
211 "Non-nil if advancing or retreating in the search ring should cause search.
212 Default value, nil, means edit the string instead."
213 :type 'boolean
214 :group 'isearch)
216 ;;; isearch highlight customization.
218 (defcustom search-highlight t
219 "Non-nil means incremental search highlights the current match."
220 :type 'boolean
221 :group 'isearch)
223 (defface isearch
224 '((((class color) (min-colors 88) (background light))
225 ;; The background must not be too dark, for that means
226 ;; the character is hard to see when the cursor is there.
227 (:background "magenta3" :foreground "lightskyblue1"))
228 (((class color) (min-colors 88) (background dark))
229 (:background "palevioletred2" :foreground "brown4"))
230 (((class color) (min-colors 16))
231 (:background "magenta4" :foreground "cyan1"))
232 (((class color) (min-colors 8))
233 (:background "magenta4" :foreground "cyan1"))
234 (t (:inverse-video t)))
235 "Face for highlighting Isearch matches."
236 :group 'isearch
237 :group 'basic-faces)
238 (defvar isearch 'isearch)
240 (defface isearch-fail
241 '((((class color) (min-colors 88) (background light))
242 (:background "RosyBrown1"))
243 (((class color) (min-colors 88) (background dark))
244 (:background "red4"))
245 (((class color) (min-colors 16))
246 (:background "red"))
247 (((class color) (min-colors 8))
248 (:background "red"))
249 (((class color grayscale))
250 :foreground "grey")
251 (t (:inverse-video t)))
252 "Face for highlighting failed part in Isearch echo-area message."
253 :version "23.1"
254 :group 'isearch)
256 (defcustom isearch-lazy-highlight t
257 "Controls the lazy-highlighting during incremental search.
258 When non-nil, all text in the buffer matching the current search
259 string is highlighted lazily (see `lazy-highlight-initial-delay'
260 and `lazy-highlight-interval')."
261 :type 'boolean
262 :group 'lazy-highlight
263 :group 'isearch)
265 ;;; Lazy highlight customization.
267 (defgroup lazy-highlight nil
268 "Lazy highlighting feature for matching strings."
269 :prefix "lazy-highlight-"
270 :version "21.1"
271 :group 'isearch
272 :group 'matching)
274 (defcustom lazy-highlight-cleanup t
275 "Controls whether to remove extra highlighting after a search.
276 If this is nil, extra highlighting can be \"manually\" removed with
277 \\[lazy-highlight-cleanup]."
278 :type 'boolean
279 :group 'lazy-highlight)
280 (define-obsolete-variable-alias 'isearch-lazy-highlight-cleanup
281 'lazy-highlight-cleanup
282 "22.1")
284 (defcustom lazy-highlight-initial-delay 0.25
285 "Seconds to wait before beginning to lazily highlight all matches."
286 :type 'number
287 :group 'lazy-highlight)
288 (define-obsolete-variable-alias 'isearch-lazy-highlight-initial-delay
289 'lazy-highlight-initial-delay
290 "22.1")
292 (defcustom lazy-highlight-interval 0 ; 0.0625
293 "Seconds between lazily highlighting successive matches."
294 :type 'number
295 :group 'lazy-highlight)
296 (define-obsolete-variable-alias 'isearch-lazy-highlight-interval
297 'lazy-highlight-interval
298 "22.1")
300 (defcustom lazy-highlight-max-at-a-time 20
301 "Maximum matches to highlight at a time (for `lazy-highlight').
302 Larger values may reduce Isearch's responsiveness to user input;
303 smaller values make matches highlight slowly.
304 A value of nil means highlight all matches."
305 :type '(choice (const :tag "All" nil)
306 (integer :tag "Some"))
307 :group 'lazy-highlight)
308 (define-obsolete-variable-alias 'isearch-lazy-highlight-max-at-a-time
309 'lazy-highlight-max-at-a-time
310 "22.1")
312 (defface lazy-highlight
313 '((((class color) (min-colors 88) (background light))
314 (:background "paleturquoise"))
315 (((class color) (min-colors 88) (background dark))
316 (:background "paleturquoise4"))
317 (((class color) (min-colors 16))
318 (:background "turquoise3"))
319 (((class color) (min-colors 8))
320 (:background "turquoise3"))
321 (t (:underline t)))
322 "Face for lazy highlighting of matches other than the current one."
323 :group 'lazy-highlight
324 :group 'basic-faces)
325 (define-obsolete-face-alias 'isearch-lazy-highlight-face 'lazy-highlight "22.1")
326 (defvar lazy-highlight-face 'lazy-highlight)
327 (define-obsolete-variable-alias 'isearch-lazy-highlight-face
328 'lazy-highlight-face
329 "22.1")
331 ;; Define isearch help map.
333 (defvar isearch-help-map
334 (let ((map (make-sparse-keymap)))
335 (define-key map [t] 'isearch-other-control-char)
336 (define-key map (char-to-string help-char) 'isearch-help-for-help)
337 (define-key map [help] 'isearch-help-for-help)
338 (define-key map [f1] 'isearch-help-for-help)
339 (define-key map "?" 'isearch-help-for-help)
340 (define-key map "b" 'isearch-describe-bindings)
341 (define-key map "k" 'isearch-describe-key)
342 (define-key map "m" 'isearch-describe-mode)
343 (define-key map "q" 'help-quit)
344 map)
345 "Keymap for characters following the Help key for Isearch mode.")
347 (eval-when-compile (require 'help-macro))
349 (make-help-screen isearch-help-for-help-internal
350 (purecopy "Type a help option: [bkm] or ?")
351 "You have typed %THIS-KEY%, the help character. Type a Help option:
352 \(Type \\<help-map>\\[help-quit] to exit the Help command.)
354 b Display all Isearch key bindings.
355 k KEYS Display full documentation of Isearch key sequence.
356 m Display documentation of Isearch mode.
358 You can't type here other help keys available in the global help map,
359 but outside of this help window when you type them in Isearch mode,
360 they exit Isearch mode before displaying global help."
361 isearch-help-map)
363 (defun isearch-help-for-help ()
364 "Display Isearch help menu."
365 (interactive)
366 (let (same-window-buffer-names same-window-regexps)
367 (isearch-help-for-help-internal))
368 (isearch-update))
370 (defun isearch-describe-bindings ()
371 "Show a list of all keys defined in Isearch mode, and their definitions.
372 This is like `describe-bindings', but displays only Isearch keys."
373 (interactive)
374 (let (same-window-buffer-names same-window-regexps)
375 (with-help-window "*Help*"
376 (with-current-buffer standard-output
377 (princ "Isearch Mode Bindings:\n")
378 (princ (substitute-command-keys "\\{isearch-mode-map}"))))))
380 (defun isearch-describe-key ()
381 "Display documentation of the function invoked by isearch key."
382 (interactive)
383 (let (same-window-buffer-names same-window-regexps)
384 (call-interactively 'describe-key))
385 (isearch-update))
387 (defun isearch-describe-mode ()
388 "Display documentation of Isearch mode."
389 (interactive)
390 (let (same-window-buffer-names same-window-regexps)
391 (describe-function 'isearch-forward))
392 (isearch-update))
394 (defalias 'isearch-mode-help 'isearch-describe-mode)
397 ;; Define isearch-mode keymap.
399 (defvar isearch-mode-map
400 (let ((i 0)
401 (map (make-keymap)))
402 (or (char-table-p (nth 1 map))
403 (error "The initialization of isearch-mode-map must be updated"))
404 ;; Make all multibyte characters search for themselves.
405 (set-char-table-range (nth 1 map) (cons #x100 (max-char))
406 'isearch-printing-char)
407 ;; Make function keys, etc, which aren't bound to a scrolling-function
408 ;; exit the search.
409 (define-key map [t] 'isearch-other-control-char)
410 ;; Control chars, by default, end isearch mode transparently.
411 ;; We need these explicit definitions because, in a dense keymap,
412 ;; the binding for t does not affect characters.
413 ;; We use a dense keymap to save space.
414 (while (< i ?\s)
415 (define-key map (make-string 1 i) 'isearch-other-control-char)
416 (setq i (1+ i)))
418 ;; Single-byte printing chars extend the search string by default.
419 (setq i ?\s)
420 (while (< i 256)
421 (define-key map (vector i) 'isearch-printing-char)
422 (setq i (1+ i)))
424 ;; To handle local bindings with meta char prefix keys, define
425 ;; another full keymap. This must be done for any other prefix
426 ;; keys as well, one full keymap per char of the prefix key. It
427 ;; would be simpler to disable the global keymap, and/or have a
428 ;; default local key binding for any key not otherwise bound.
429 (let ((meta-map (make-sparse-keymap)))
430 (define-key map (char-to-string meta-prefix-char) meta-map)
431 (define-key map [escape] meta-map))
432 (define-key map (vector meta-prefix-char t) 'isearch-other-meta-char)
434 ;; Several non-printing chars change the searching behavior.
435 (define-key map "\C-s" 'isearch-repeat-forward)
436 (define-key map "\C-r" 'isearch-repeat-backward)
437 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
438 ;; combinations can be used to repeat regexp isearches that can
439 ;; be used to start these searches.
440 (define-key map "\M-\C-s" 'isearch-repeat-forward)
441 (define-key map "\M-\C-r" 'isearch-repeat-backward)
442 (define-key map "\177" 'isearch-delete-char)
443 (define-key map "\C-g" 'isearch-abort)
445 ;; This assumes \e is the meta-prefix-char.
446 (or (= ?\e meta-prefix-char)
447 (error "Inconsistency in isearch.el"))
448 (define-key map "\e\e\e" 'isearch-cancel)
449 (define-key map [escape escape escape] 'isearch-cancel)
451 (define-key map "\C-q" 'isearch-quote-char)
453 (define-key map "\r" 'isearch-exit)
454 (define-key map "\C-j" 'isearch-printing-char)
455 (define-key map "\t" 'isearch-printing-char)
456 (define-key map [?\S-\ ] 'isearch-printing-char)
458 (define-key map "\C-w" 'isearch-yank-word-or-char)
459 (define-key map "\M-\C-w" 'isearch-del-char)
460 (define-key map "\M-\C-y" 'isearch-yank-char)
461 (define-key map "\C-y" 'isearch-yank-line)
463 (define-key map "\C-h" isearch-help-map)
465 (define-key map "\M-n" 'isearch-ring-advance)
466 (define-key map "\M-p" 'isearch-ring-retreat)
467 (define-key map "\M-y" 'isearch-yank-kill)
469 (define-key map "\M-\t" 'isearch-complete)
471 ;; Pass frame events transparently so they won't exit the search.
472 ;; In particular, if we have more than one display open, then a
473 ;; switch-frame might be generated by someone typing at another keyboard.
474 (define-key map [switch-frame] nil)
475 (define-key map [delete-frame] nil)
476 (define-key map [iconify-frame] nil)
477 (define-key map [make-frame-visible] nil)
478 (define-key map [mouse-movement] nil)
479 (define-key map [language-change] nil)
481 ;; For searching multilingual text.
482 (define-key map "\C-\\" 'isearch-toggle-input-method)
483 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
485 ;; People expect to be able to paste with the mouse.
486 (define-key map [mouse-2] #'isearch-mouse-2)
487 (define-key map [down-mouse-2] nil)
489 ;; Some bindings you may want to put in your isearch-mode-hook.
490 ;; Suggest some alternates...
491 (define-key map "\M-c" 'isearch-toggle-case-fold)
492 (define-key map "\M-r" 'isearch-toggle-regexp)
493 (define-key map "\M-e" 'isearch-edit-string)
495 (define-key map "\M-sr" 'isearch-toggle-regexp)
496 (define-key map "\M-sw" 'isearch-toggle-word)
498 (define-key map [?\M-%] 'isearch-query-replace)
499 (define-key map [?\C-\M-%] 'isearch-query-replace-regexp)
500 (define-key map "\M-so" 'isearch-occur)
501 (define-key map "\M-shr" 'isearch-highlight-regexp)
503 map)
504 "Keymap for `isearch-mode'.")
506 (defvar minibuffer-local-isearch-map
507 (let ((map (make-sparse-keymap)))
508 (set-keymap-parent map minibuffer-local-map)
509 (define-key map "\r" 'isearch-nonincremental-exit-minibuffer)
510 (define-key map "\M-\t" 'isearch-complete-edit)
511 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
512 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
513 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
514 (define-key map [right] 'isearch-yank-char-in-minibuffer)
515 map)
516 "Keymap for editing Isearch strings in the minibuffer.")
518 ;; Internal variables declared globally for byte-compiler.
519 ;; These are all set with setq while isearching
520 ;; and bound locally while editing the search string.
522 (defvar isearch-forward nil) ; Searching in the forward direction.
523 (defvar isearch-regexp nil) ; Searching for a regexp.
524 (defvar isearch-word nil) ; Searching for words.
525 (defvar isearch-hidden nil) ; Non-nil if the string exists but is invisible.
527 (defvar isearch-cmds nil
528 "Stack of search status sets.
529 Each set is a vector of the form:
530 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
531 INVALID-REGEXP WRAPPED BARRIER WITHIN-BRACKETS CASE-FOLD-SEARCH]")
533 (defvar isearch-string "") ; The current search string.
534 (defvar isearch-message "") ; text-char-description version of isearch-string
536 (defvar isearch-message-prefix-add nil) ; Additonal text for the message prefix
537 (defvar isearch-message-suffix-add nil) ; Additonal text for the message suffix
539 (defvar isearch-success t) ; Searching is currently successful.
540 (defvar isearch-error nil) ; Error message for failed search.
541 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
542 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
543 (defvar isearch-barrier 0)
544 (defvar isearch-just-started nil)
545 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
547 ;; case-fold-search while searching.
548 ;; either nil, t, or 'yes. 'yes means the same as t except that mixed
549 ;; case in the search string is ignored.
550 (defvar isearch-case-fold-search nil)
552 (defvar isearch-last-case-fold-search nil)
554 ;; Used to save default value while isearch is active
555 (defvar isearch-original-minibuffer-message-timeout nil)
557 (defvar isearch-adjusted nil)
558 (defvar isearch-slow-terminal-mode nil)
559 ;; If t, using a small window.
560 (defvar isearch-small-window nil)
561 (defvar isearch-opoint 0)
562 ;; The window configuration active at the beginning of the search.
563 (defvar isearch-window-configuration nil)
565 ;; Flag to indicate a yank occurred, so don't move the cursor.
566 (defvar isearch-yank-flag nil)
568 ;; A function to be called after each input character is processed.
569 ;; (It is not called after characters that exit the search.)
570 ;; It is only set from an optional argument to `isearch-mode'.
571 (defvar isearch-op-fun nil)
573 ;; Is isearch-mode in a recursive edit for modal searching.
574 (defvar isearch-recursive-edit nil)
576 ;; Should isearch be terminated after doing one search?
577 (defvar isearch-nonincremental nil)
579 ;; New value of isearch-forward after isearch-edit-string.
580 (defvar isearch-new-forward nil)
582 ;; Accumulate here the overlays opened during searching.
583 (defvar isearch-opened-overlays nil)
585 ;; The value of input-method-function when isearch is invoked.
586 (defvar isearch-input-method-function nil)
588 ;; A flag to tell if input-method-function is locally bound when
589 ;; isearch is invoked.
590 (defvar isearch-input-method-local-p nil)
592 ;; Minor-mode-alist changes - kind of redundant with the
593 ;; echo area, but if isearching in multiple windows, it can be useful.
595 (or (assq 'isearch-mode minor-mode-alist)
596 (nconc minor-mode-alist
597 (list '(isearch-mode isearch-mode))))
599 (defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
600 (make-variable-buffer-local 'isearch-mode)
602 (define-key global-map "\C-s" 'isearch-forward)
603 (define-key esc-map "\C-s" 'isearch-forward-regexp)
604 (define-key global-map "\C-r" 'isearch-backward)
605 (define-key esc-map "\C-r" 'isearch-backward-regexp)
606 (define-key search-map "w" 'isearch-forward-word)
608 ;; Entry points to isearch-mode.
610 (defun isearch-forward (&optional regexp-p no-recursive-edit)
612 Do incremental search forward.
613 With a prefix argument, do an incremental regular expression search instead.
614 \\<isearch-mode-map>
615 As you type characters, they add to the search string and are found.
616 The following non-printing keys are bound in `isearch-mode-map'.
618 Type \\[isearch-delete-char] to cancel last input item from end of search string.
619 Type \\[isearch-exit] to exit, leaving point at location found.
620 Type LFD (C-j) to match end of line.
621 Type \\[isearch-repeat-forward] to search again forward,\
622 \\[isearch-repeat-backward] to search again backward.
623 Type \\[isearch-yank-word-or-char] to yank next word or character in buffer
624 onto the end of the search string, and search for it.
625 Type \\[isearch-del-char] to delete character from end of search string.
626 Type \\[isearch-yank-char] to yank char from buffer onto end of search\
627 string and search for it.
628 Type \\[isearch-yank-line] to yank rest of line onto end of search string\
629 and search for it.
630 Type \\[isearch-yank-kill] to yank the last string of killed text.
631 Type \\[isearch-quote-char] to quote control character to search for it.
632 \\[isearch-abort] while searching or when search has failed cancels input\
633 back to what has
634 been found successfully.
635 \\[isearch-abort] when search is successful aborts and moves point to\
636 starting point.
638 If you try to exit with the search string still empty, it invokes
639 nonincremental search.
641 Type \\[isearch-toggle-case-fold] to toggle search case-sensitivity.
642 Type \\[isearch-toggle-regexp] to toggle regular-expression mode.
643 Type \\[isearch-toggle-word] to toggle word mode.
644 Type \\[isearch-edit-string] to edit the search string in the minibuffer.
646 Also supported is a search ring of the previous 16 search strings.
647 Type \\[isearch-ring-advance] to search for the next item in the search ring.
648 Type \\[isearch-ring-retreat] to search for the previous item in the search\
649 ring.
650 Type \\[isearch-complete] to complete the search string using the search ring.
652 Type \\[isearch-query-replace] to run `query-replace' with string to\
653 replace from last search string.
654 Type \\[isearch-query-replace-regexp] to run `query-replace-regexp'\
655 with the last search string.
656 Type \\[isearch-occur] to run `occur' that shows\
657 the last search string.
658 Type \\[isearch-highlight-regexp] to run `highlight-regexp'\
659 that highlights the last search string.
661 Type \\[isearch-describe-bindings] to display all Isearch key bindings.
662 Type \\[isearch-describe-key] to display documentation of Isearch key.
663 Type \\[isearch-describe-mode] to display documentation of Isearch mode.
665 If an input method is turned on in the current buffer, that input
666 method is also active while you are typing characters to search.
667 To toggle the input method, type \\[isearch-toggle-input-method]. \
668 It also toggles the input
669 method in the current buffer.
671 To use a different input method for searching, type \
672 \\[isearch-toggle-specified-input-method],
673 and specify an input method you want to use.
675 The above keys, bound in `isearch-mode-map', are often controlled by
676 options; do \\[apropos] on search-.* to find them.
677 Other control and meta characters terminate the search
678 and are then executed normally (depending on `search-exit-option').
679 Likewise for function keys and mouse button events.
681 If this function is called non-interactively, it does not return to
682 the calling function until the search is done."
684 (interactive "P\np")
685 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
687 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
689 Do incremental search forward for regular expression.
690 With a prefix argument, do a regular string search instead.
691 Like ordinary incremental search except that your input is treated
692 as a regexp. See the command `isearch-forward' for more information.
694 In regexp incremental searches, a space or spaces normally matches
695 any whitespace (the variable `search-whitespace-regexp' controls
696 precisely what that means). If you want to search for a literal space
697 and nothing else, enter C-q SPC."
698 (interactive "P\np")
699 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
701 (defun isearch-forward-word (&optional not-word no-recursive-edit)
703 Do incremental search forward for a sequence of words.
704 With a prefix argument, do a regular string search instead.
705 Like ordinary incremental search except that your input is treated
706 as a sequence of words without regard to how the words are separated.
707 See the command `isearch-forward' for more information."
708 (interactive "P\np")
709 (isearch-mode t nil nil (not no-recursive-edit) (null not-word)))
711 (defun isearch-backward (&optional regexp-p no-recursive-edit)
713 Do incremental search backward.
714 With a prefix argument, do a regular expression search instead.
715 See the command `isearch-forward' for more information."
716 (interactive "P\np")
717 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
719 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
721 Do incremental search backward for regular expression.
722 With a prefix argument, do a regular string search instead.
723 Like ordinary incremental search except that your input is treated
724 as a regexp. See the command `isearch-forward' for more information."
725 (interactive "P\np")
726 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
729 ;; isearch-mode only sets up incremental search for the minor mode.
730 ;; All the work is done by the isearch-mode commands.
732 ;; Not used yet:
733 ;;(defvar isearch-commands '(isearch-forward isearch-backward
734 ;; isearch-forward-regexp isearch-backward-regexp)
735 ;; "List of commands for which isearch-mode does not recursive-edit.")
738 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p)
739 "Start Isearch minor mode.
740 It is called by the function `isearch-forward' and other related functions."
742 ;; Initialize global vars.
743 (setq isearch-forward forward
744 isearch-regexp regexp
745 isearch-word word-p
746 isearch-op-fun op-fun
747 isearch-last-case-fold-search isearch-case-fold-search
748 isearch-case-fold-search case-fold-search
749 isearch-string ""
750 isearch-message ""
751 isearch-cmds nil
752 isearch-success t
753 isearch-wrapped nil
754 isearch-barrier (point)
755 isearch-adjusted nil
756 isearch-yank-flag nil
757 isearch-error nil
758 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
759 (> (window-height)
760 (* 4
761 (abs search-slow-window-lines))))
762 isearch-other-end nil
763 isearch-small-window nil
764 isearch-just-started t
765 isearch-start-hscroll (window-hscroll)
767 isearch-opoint (point)
768 search-ring-yank-pointer nil
769 isearch-opened-overlays nil
770 isearch-input-method-function input-method-function
771 isearch-input-method-local-p (local-variable-p 'input-method-function)
772 regexp-search-ring-yank-pointer nil
774 ;; Save the original value of `minibuffer-message-timeout', and
775 ;; set it to nil so that isearch's messages don't get timed out.
776 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
777 minibuffer-message-timeout nil)
779 ;; We must bypass input method while reading key. When a user type
780 ;; printable character, appropriate input method is turned on in
781 ;; minibuffer to read multibyte characters.
782 (or isearch-input-method-local-p
783 (make-local-variable 'input-method-function))
784 (setq input-method-function nil)
786 (looking-at "")
787 (setq isearch-window-configuration
788 (if isearch-slow-terminal-mode (current-window-configuration) nil))
790 ;; Maybe make minibuffer frame visible and/or raise it.
791 (let ((frame (window-frame (minibuffer-window))))
792 (unless (memq (frame-live-p frame) '(nil t))
793 (unless (frame-visible-p frame)
794 (make-frame-visible frame))
795 (if minibuffer-auto-raise
796 (raise-frame frame))))
798 (setq isearch-mode " Isearch") ;; forward? regexp?
799 (force-mode-line-update)
801 (isearch-push-state)
803 (setq overriding-terminal-local-map isearch-mode-map)
804 (run-hooks 'isearch-mode-hook)
805 (isearch-update)
807 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
808 (add-hook 'kbd-macro-termination-hook 'isearch-done)
810 ;; isearch-mode can be made modal (in the sense of not returning to
811 ;; the calling function until searching is completed) by entering
812 ;; a recursive-edit and exiting it when done isearching.
813 (if recursive-edit
814 (let ((isearch-recursive-edit t))
815 (recursive-edit)))
816 isearch-success)
819 ;; Some high level utilities. Others below.
821 (defun isearch-update ()
822 ;; Called after each command to update the display.
823 (if (and (null unread-command-events)
824 (null executing-kbd-macro))
825 (progn
826 (if (not (input-pending-p))
827 (if isearch-message-function
828 (funcall isearch-message-function)
829 (isearch-message)))
830 (if (and isearch-slow-terminal-mode
831 (not (or isearch-small-window
832 (pos-visible-in-window-p))))
833 (let ((found-point (point)))
834 (setq isearch-small-window t)
835 (move-to-window-line 0)
836 (let ((window-min-height 1))
837 (split-window nil (if (< search-slow-window-lines 0)
838 (1+ (- search-slow-window-lines))
839 (- (window-height)
840 (1+ search-slow-window-lines)))))
841 (if (< search-slow-window-lines 0)
842 (progn (vertical-motion (- 1 search-slow-window-lines))
843 (set-window-start (next-window) (point))
844 (set-window-hscroll (next-window)
845 (window-hscroll))
846 (set-window-hscroll (selected-window) 0))
847 (other-window 1))
848 (goto-char found-point))
849 ;; Keep same hscrolling as at the start of the search when possible
850 (let ((current-scroll (window-hscroll)))
851 (set-window-hscroll (selected-window) isearch-start-hscroll)
852 (unless (pos-visible-in-window-p)
853 (set-window-hscroll (selected-window) current-scroll))))
854 (if isearch-other-end
855 (if (< isearch-other-end (point)) ; isearch-forward?
856 (isearch-highlight isearch-other-end (point))
857 (isearch-highlight (point) isearch-other-end))
858 (isearch-dehighlight))
860 (setq ;; quit-flag nil not for isearch-mode
861 isearch-adjusted nil
862 isearch-yank-flag nil)
863 (when isearch-lazy-highlight
864 (isearch-lazy-highlight-new-loop))
865 ;; We must prevent the point moving to the end of composition when a
866 ;; part of the composition has just been searched.
867 (setq disable-point-adjustment t))
869 (defun isearch-done (&optional nopush edit)
870 "Exit Isearch mode.
871 For successful search, pass no args.
872 For a failing search, NOPUSH is t.
873 For going to the minibuffer to edit the search string,
874 NOPUSH is t and EDIT is t."
876 (if isearch-resume-in-command-history
877 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
878 ,isearch-word ,isearch-forward
879 ,isearch-message
880 ',isearch-case-fold-search)))
881 (unless (equal (car command-history) command)
882 (setq command-history (cons command command-history)))))
884 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
885 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
886 (setq isearch-lazy-highlight-start nil)
888 ;; Called by all commands that terminate isearch-mode.
889 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
890 (setq overriding-terminal-local-map nil)
891 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
892 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
893 (isearch-dehighlight)
894 (lazy-highlight-cleanup lazy-highlight-cleanup)
895 (let ((found-start (window-start (selected-window)))
896 (found-point (point)))
897 (when isearch-window-configuration
898 (set-window-configuration isearch-window-configuration)
899 (if isearch-small-window
900 (goto-char found-point)
901 ;; set-window-configuration clobbers window-start; restore it.
902 ;; This has an annoying side effect of clearing the last_modiff
903 ;; field of the window, which can cause unwanted scrolling,
904 ;; so don't do it unless truly necessary.
905 (set-window-start (selected-window) found-start t))))
907 (setq isearch-mode nil)
908 (if isearch-input-method-local-p
909 (setq input-method-function isearch-input-method-function)
910 (kill-local-variable 'input-method-function))
912 (force-mode-line-update)
914 ;; If we ended in the middle of some intangible text,
915 ;; move to the further end of that intangible text.
916 (let ((after (if (eobp) nil
917 (get-text-property (point) 'intangible)))
918 (before (if (bobp) nil
919 (get-text-property (1- (point)) 'intangible))))
920 (when (and before after (eq before after))
921 (if isearch-forward
922 (goto-char (next-single-property-change (point) 'intangible))
923 (goto-char (previous-single-property-change (point) 'intangible)))))
925 (if (and (> (length isearch-string) 0) (not nopush))
926 ;; Update the ring data.
927 (isearch-update-ring isearch-string isearch-regexp))
929 (let ((isearch-mode-end-hook-quit (and nopush (not edit))))
930 (run-hooks 'isearch-mode-end-hook))
932 ;; If there was movement, mark the starting position.
933 ;; Maybe should test difference between and set mark only if > threshold.
934 (if (/= (point) isearch-opoint)
935 (or (and transient-mark-mode mark-active)
936 (progn
937 (push-mark isearch-opoint t)
938 (or executing-kbd-macro (> (minibuffer-depth) 0)
939 (message "Mark saved where search started")))))
941 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
943 (defun isearch-update-ring (string &optional regexp)
944 "Add STRING to the beginning of the search ring.
945 REGEXP if non-nil says use the regexp search ring."
946 (add-to-history
947 (if regexp 'regexp-search-ring 'search-ring)
948 string
949 (if regexp regexp-search-ring-max search-ring-max)))
951 ;; Switching buffers should first terminate isearch-mode.
952 ;; ;; For Emacs 19, the frame switch event is handled.
953 ;; (defun isearch-switch-frame-handler ()
954 ;; (interactive) ;; Is this necessary?
955 ;; ;; First terminate isearch-mode.
956 ;; (isearch-done)
957 ;; (isearch-clean-overlays)
958 ;; (handle-switch-frame (car (cdr last-command-event))))
961 ;; The search status structure and stack.
963 (defsubst isearch-string-state (frame)
964 "Return the search string in FRAME."
965 (aref frame 0))
966 (defsubst isearch-message-state (frame)
967 "Return the search string to display to the user in FRAME."
968 (aref frame 1))
969 (defsubst isearch-point-state (frame)
970 "Return the point in FRAME."
971 (aref frame 2))
972 (defsubst isearch-success-state (frame)
973 "Return the success flag in FRAME."
974 (aref frame 3))
975 (defsubst isearch-forward-state (frame)
976 "Return the searching-forward flag in FRAME."
977 (aref frame 4))
978 (defsubst isearch-other-end-state (frame)
979 "Return the other end of the match in FRAME."
980 (aref frame 5))
981 (defsubst isearch-word-state (frame)
982 "Return the search-by-word flag in FRAME."
983 (aref frame 6))
984 (defsubst isearch-error-state (frame)
985 "Return the regexp error message in FRAME, or nil if its regexp is valid."
986 (aref frame 7))
987 (defsubst isearch-wrapped-state (frame)
988 "Return the search-wrapped flag in FRAME."
989 (aref frame 8))
990 (defsubst isearch-barrier-state (frame)
991 "Return the barrier value in FRAME."
992 (aref frame 9))
993 (defsubst isearch-case-fold-search-state (frame)
994 "Return the case-folding flag in FRAME."
995 (aref frame 10))
996 (defsubst isearch-pop-fun-state (frame)
997 "Return the function restoring the mode-specific Isearch state in FRAME."
998 (aref frame 11))
1000 (defun isearch-top-state ()
1001 (let ((cmd (car isearch-cmds)))
1002 (setq isearch-string (isearch-string-state cmd)
1003 isearch-message (isearch-message-state cmd)
1004 isearch-success (isearch-success-state cmd)
1005 isearch-forward (isearch-forward-state cmd)
1006 isearch-other-end (isearch-other-end-state cmd)
1007 isearch-word (isearch-word-state cmd)
1008 isearch-error (isearch-error-state cmd)
1009 isearch-wrapped (isearch-wrapped-state cmd)
1010 isearch-barrier (isearch-barrier-state cmd)
1011 isearch-case-fold-search (isearch-case-fold-search-state cmd))
1012 (if (functionp (isearch-pop-fun-state cmd))
1013 (funcall (isearch-pop-fun-state cmd) cmd))
1014 (goto-char (isearch-point-state cmd))))
1016 (defun isearch-pop-state ()
1017 (setq isearch-cmds (cdr isearch-cmds))
1018 (isearch-top-state))
1020 (defun isearch-push-state ()
1021 (setq isearch-cmds
1022 (cons (vector isearch-string isearch-message (point)
1023 isearch-success isearch-forward isearch-other-end
1024 isearch-word
1025 isearch-error isearch-wrapped isearch-barrier
1026 isearch-case-fold-search
1027 (if isearch-push-state-function
1028 (funcall isearch-push-state-function)))
1029 isearch-cmds)))
1032 ;; Commands active while inside of the isearch minor mode.
1034 (defun isearch-exit ()
1035 "Exit search normally.
1036 However, if this is the first command after starting incremental
1037 search and `search-nonincremental-instead' is non-nil, do a
1038 nonincremental search instead via `isearch-edit-string'."
1039 (interactive)
1040 (if (and search-nonincremental-instead
1041 (= 0 (length isearch-string)))
1042 (let ((isearch-nonincremental t))
1043 (isearch-edit-string)))
1044 (isearch-done)
1045 (isearch-clean-overlays))
1048 (defun isearch-edit-string ()
1049 "Edit the search string in the minibuffer.
1050 The following additional command keys are active while editing.
1051 \\<minibuffer-local-isearch-map>
1052 \\[exit-minibuffer] to resume incremental searching with the edited string.
1053 \\[isearch-nonincremental-exit-minibuffer] to do one nonincremental search.
1054 \\[isearch-forward-exit-minibuffer] to resume isearching forward.
1055 \\[isearch-reverse-exit-minibuffer] to resume isearching backward.
1056 \\[isearch-complete-edit] to complete the search string using the search ring.
1057 \\<isearch-mode-map>
1058 If first char entered is \\[isearch-yank-word-or-char], then do word search instead."
1060 ;; This code is very hairy for several reasons, explained in the code.
1061 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
1062 ;; If there were a way to catch any change of buffer from the minibuffer,
1063 ;; this could be simplified greatly.
1064 ;; Editing doesn't back up the search point. Should it?
1065 (interactive)
1066 (condition-case err
1067 (progn
1068 (let ((isearch-nonincremental isearch-nonincremental)
1070 ;; Locally bind all isearch global variables to protect them
1071 ;; from recursive isearching.
1072 ;; isearch-string -message and -forward are not bound
1073 ;; so they may be changed. Instead, save the values.
1074 (isearch-new-string isearch-string)
1075 (isearch-new-message isearch-message)
1076 (isearch-new-forward isearch-forward)
1077 (isearch-new-word isearch-word)
1079 (isearch-regexp isearch-regexp)
1080 (isearch-op-fun isearch-op-fun)
1081 (isearch-cmds isearch-cmds)
1082 (isearch-success isearch-success)
1083 (isearch-wrapped isearch-wrapped)
1084 (isearch-barrier isearch-barrier)
1085 (isearch-adjusted isearch-adjusted)
1086 (isearch-yank-flag isearch-yank-flag)
1087 (isearch-error isearch-error)
1088 ;;; Don't bind this. We want isearch-search, below, to set it.
1089 ;;; And the old value won't matter after that.
1090 ;;; (isearch-other-end isearch-other-end)
1091 ;;; Perhaps some of these other variables should be bound for a
1092 ;;; shorter period, ending before the next isearch-search.
1093 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
1094 (isearch-opoint isearch-opoint)
1095 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
1096 (isearch-small-window isearch-small-window)
1097 (isearch-recursive-edit isearch-recursive-edit)
1098 ;; Save current configuration so we can restore it here.
1099 (isearch-window-configuration (current-window-configuration))
1101 ;; Temporarily restore `minibuffer-message-timeout'.
1102 (minibuffer-message-timeout
1103 isearch-original-minibuffer-message-timeout)
1104 (isearch-original-minibuffer-message-timeout
1105 isearch-original-minibuffer-message-timeout)
1106 old-point old-other-end)
1108 ;; Actually terminate isearching until editing is done.
1109 ;; This is so that the user can do anything without failure,
1110 ;; like switch buffers and start another isearch, and return.
1111 (condition-case err
1112 (isearch-done t t)
1113 (exit nil)) ; was recursive editing
1115 ;; Save old point and isearch-other-end before reading from minibuffer
1116 ;; that can change their values.
1117 (setq old-point (point) old-other-end isearch-other-end)
1119 (unwind-protect
1120 (let* ((message-log-max nil)
1121 ;; Binding minibuffer-history-symbol to nil is a work-around
1122 ;; for some incompatibility with gmhist.
1123 (minibuffer-history-symbol))
1124 (setq isearch-new-string
1125 (read-from-minibuffer
1126 (isearch-message-prefix nil nil isearch-nonincremental)
1127 isearch-string
1128 minibuffer-local-isearch-map nil
1129 (if isearch-regexp
1130 (cons 'regexp-search-ring
1131 (1+ (or regexp-search-ring-yank-pointer -1)))
1132 (cons 'search-ring
1133 (1+ (or search-ring-yank-pointer -1))))
1134 nil t)
1135 isearch-new-message
1136 (mapconcat 'isearch-text-char-description
1137 isearch-new-string "")))
1139 ;; Set point at the start (end) of old match if forward (backward),
1140 ;; so after exiting minibuffer isearch resumes at the start (end)
1141 ;; of this match and can find it again.
1142 (if (and old-other-end (eq old-point (point))
1143 (eq isearch-forward isearch-new-forward))
1144 (goto-char old-other-end))
1146 ;; Always resume isearching by restarting it.
1147 (isearch-mode isearch-forward
1148 isearch-regexp
1149 isearch-op-fun
1151 isearch-word)
1153 ;; Copy new local values to isearch globals
1154 (setq isearch-string isearch-new-string
1155 isearch-message isearch-new-message
1156 isearch-forward isearch-new-forward
1157 isearch-word isearch-new-word))
1159 ;; Empty isearch-string means use default.
1160 (if (= 0 (length isearch-string))
1161 (setq isearch-string (or (car (if isearch-regexp
1162 regexp-search-ring
1163 search-ring))
1166 isearch-message
1167 (mapconcat 'isearch-text-char-description
1168 isearch-string ""))
1169 ;; This used to set the last search string,
1170 ;; but I think it is not right to do that here.
1171 ;; Only the string actually used should be saved.
1174 ;; This used to push the state as of before this C-s, but it adds
1175 ;; an inconsistent state where part of variables are from the
1176 ;; previous search (e.g. `isearch-success'), and part of variables
1177 ;; are just entered from the minibuffer (e.g. `isearch-string').
1178 ;; (isearch-push-state)
1180 ;; Reinvoke the pending search.
1181 (isearch-search)
1182 (isearch-push-state) ; this pushes the correct state
1183 (isearch-update)
1184 (if isearch-nonincremental
1185 (progn
1186 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
1187 (isearch-done)
1188 ;; The search done message is confusing when the string
1189 ;; is empty, so erase it.
1190 (if (equal isearch-string "")
1191 (message "")))))
1193 (quit ; handle abort-recursive-edit
1194 (isearch-abort) ;; outside of let to restore outside global values
1197 (defun isearch-nonincremental-exit-minibuffer ()
1198 (interactive)
1199 (setq isearch-nonincremental t)
1200 (exit-minibuffer))
1202 (defun isearch-forward-exit-minibuffer ()
1203 (interactive)
1204 (setq isearch-new-forward t)
1205 (exit-minibuffer))
1207 (defun isearch-reverse-exit-minibuffer ()
1208 (interactive)
1209 (setq isearch-new-forward nil)
1210 (exit-minibuffer))
1212 (defun isearch-cancel ()
1213 "Terminate the search and go back to the starting point."
1214 (interactive)
1215 (if (functionp (isearch-pop-fun-state (car (last isearch-cmds))))
1216 (funcall (isearch-pop-fun-state (car (last isearch-cmds)))
1217 (car (last isearch-cmds))))
1218 (goto-char isearch-opoint)
1219 (isearch-done t) ; exit isearch
1220 (isearch-clean-overlays)
1221 (signal 'quit nil)) ; and pass on quit signal
1223 (defun isearch-abort ()
1224 "Abort incremental search mode if searching is successful, signaling quit.
1225 Otherwise, revert to previous successful search and continue searching.
1226 Use `isearch-exit' to quit without signaling."
1227 (interactive)
1228 ;; (ding) signal instead below, if quitting
1229 (discard-input)
1230 (if isearch-success
1231 ;; If search is successful, move back to starting point
1232 ;; and really do quit.
1233 (progn
1234 (setq isearch-success nil)
1235 (isearch-cancel))
1236 ;; If search is failing, or has an incomplete regexp,
1237 ;; rub out until it is once more successful.
1238 (while (or (not isearch-success) isearch-error)
1239 (isearch-pop-state))
1240 (isearch-update)))
1242 (defun isearch-repeat (direction)
1243 ;; Utility for isearch-repeat-forward and -backward.
1244 (if (eq isearch-forward (eq direction 'forward))
1245 ;; C-s in forward or C-r in reverse.
1246 (if (equal isearch-string "")
1247 ;; If search string is empty, use last one.
1248 (if (null (if isearch-regexp regexp-search-ring search-ring))
1249 (setq isearch-error "No previous search string")
1250 (setq isearch-string
1251 (if isearch-regexp
1252 (car regexp-search-ring)
1253 (car search-ring))
1254 isearch-message
1255 (mapconcat 'isearch-text-char-description
1256 isearch-string "")
1257 isearch-case-fold-search isearch-last-case-fold-search))
1258 ;; If already have what to search for, repeat it.
1259 (or isearch-success
1260 (progn
1261 ;; Set isearch-wrapped before calling isearch-wrap-function
1262 (setq isearch-wrapped t)
1263 (if isearch-wrap-function
1264 (funcall isearch-wrap-function)
1265 (goto-char (if isearch-forward (point-min) (point-max)))))))
1266 ;; C-s in reverse or C-r in forward, change direction.
1267 (setq isearch-forward (not isearch-forward)
1268 isearch-success t))
1270 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1272 (if (equal isearch-string "")
1273 (setq isearch-success t)
1274 (if (and isearch-success
1275 (equal (point) isearch-other-end)
1276 (not isearch-just-started))
1277 ;; If repeating a search that found
1278 ;; an empty string, ensure we advance.
1279 (if (if isearch-forward (eobp) (bobp))
1280 ;; If there's nowhere to advance to, fail (and wrap next time).
1281 (progn
1282 (setq isearch-success nil)
1283 (ding))
1284 (forward-char (if isearch-forward 1 -1))
1285 (isearch-search))
1286 (isearch-search)))
1288 (isearch-push-state)
1289 (isearch-update))
1291 (defun isearch-repeat-forward ()
1292 "Repeat incremental search forwards."
1293 (interactive)
1294 (isearch-repeat 'forward))
1296 (defun isearch-repeat-backward ()
1297 "Repeat incremental search backwards."
1298 (interactive)
1299 (isearch-repeat 'backward))
1301 (defun isearch-toggle-regexp ()
1302 "Toggle regexp searching on or off."
1303 ;; The status stack is left unchanged.
1304 (interactive)
1305 (setq isearch-regexp (not isearch-regexp))
1306 (if isearch-regexp (setq isearch-word nil))
1307 (setq isearch-success t isearch-adjusted t)
1308 (isearch-update))
1310 (defun isearch-toggle-word ()
1311 "Toggle word searching on or off."
1312 (interactive)
1313 (setq isearch-word (not isearch-word))
1314 (setq isearch-success t isearch-adjusted t)
1315 (isearch-update))
1317 (defun isearch-toggle-case-fold ()
1318 "Toggle case folding in searching on or off."
1319 (interactive)
1320 (setq isearch-case-fold-search
1321 (if isearch-case-fold-search nil 'yes))
1322 (let ((message-log-max nil))
1323 (message "%s%s [case %ssensitive]"
1324 (isearch-message-prefix nil nil isearch-nonincremental)
1325 isearch-message
1326 (if isearch-case-fold-search "in" "")))
1327 (setq isearch-success t isearch-adjusted t)
1328 (sit-for 1)
1329 (isearch-update))
1331 (defun isearch-query-replace (&optional delimited regexp-flag)
1332 "Start `query-replace' with string to replace from last search string.
1333 The arg DELIMITED (prefix arg if interactive), if non-nil, means replace
1334 only matches surrounded by word boundaries. Note that using the prefix arg
1335 is possible only when `isearch-allow-scroll' is non-nil, and it don't
1336 always provides the correct matches for `query-replace', so the preferred
1337 way to run word replacements from Isearch is `M-s w ... M-%'."
1338 (interactive
1339 (list current-prefix-arg))
1340 (barf-if-buffer-read-only)
1341 (if regexp-flag (setq isearch-regexp t))
1342 (let ((case-fold-search isearch-case-fold-search)
1343 ;; set `search-upper-case' to nil to not call
1344 ;; `isearch-no-upper-case-p' in `perform-replace'
1345 (search-upper-case nil)
1346 ;; Set `isearch-recursive-edit' to nil to prevent calling
1347 ;; `exit-recursive-edit' in `isearch-done' that terminates
1348 ;; the execution of this command when it is non-nil.
1349 ;; We call `exit-recursive-edit' explicitly at the end below.
1350 (isearch-recursive-edit nil))
1351 (isearch-done nil t)
1352 (isearch-clean-overlays)
1353 (if (and isearch-other-end
1354 (< isearch-other-end (point))
1355 (not (and transient-mark-mode mark-active
1356 (< (mark) (point)))))
1357 (goto-char isearch-other-end))
1358 (set query-replace-from-history-variable
1359 (cons isearch-string
1360 (symbol-value query-replace-from-history-variable)))
1361 (perform-replace
1362 isearch-string
1363 (query-replace-read-to
1364 isearch-string
1365 (concat "Query replace"
1366 (if (or delimited isearch-word) " word" "")
1367 (if isearch-regexp " regexp" "")
1368 (if (and transient-mark-mode mark-active) " in region" ""))
1369 isearch-regexp)
1370 t isearch-regexp (or delimited isearch-word) nil nil
1371 (if (and transient-mark-mode mark-active) (region-beginning))
1372 (if (and transient-mark-mode mark-active) (region-end))))
1373 (and isearch-recursive-edit (exit-recursive-edit)))
1375 (defun isearch-query-replace-regexp (&optional delimited)
1376 "Start `query-replace-regexp' with string to replace from last search string.
1377 See `isearch-query-replace' for more information."
1378 (interactive
1379 (list current-prefix-arg))
1380 (isearch-query-replace delimited t))
1382 (defun isearch-occur (regexp &optional nlines)
1383 "Run `occur' with regexp to search from the current search string.
1384 Interactively, REGEXP is the current search regexp or a quoted search
1385 string. NLINES has the same meaning as in `occur'."
1386 (interactive
1387 (list
1388 (cond
1389 (isearch-word (concat "\\b" (replace-regexp-in-string
1390 "\\W+" "\\W+"
1391 (replace-regexp-in-string
1392 "^\\W+\\|\\W+$" "" isearch-string)
1393 nil t)
1394 "\\b"))
1395 (isearch-regexp isearch-string)
1396 (t (regexp-quote isearch-string)))
1397 (if current-prefix-arg (prefix-numeric-value current-prefix-arg))))
1398 (let ((case-fold-search isearch-case-fold-search)
1399 ;; set `search-upper-case' to nil to not call
1400 ;; `isearch-no-upper-case-p' in `occur-1'
1401 (search-upper-case nil))
1402 (occur regexp nlines)))
1404 (declare-function hi-lock-read-face-name "hi-lock" ())
1406 (defun isearch-highlight-regexp ()
1407 "Run `highlight-regexp' with regexp from the current search string.
1408 It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp
1409 argument from the last search regexp or a quoted search string,
1410 and reads its face argument using `hi-lock-read-face-name'."
1411 (interactive)
1412 (let (
1413 ;; Set `isearch-recursive-edit' to nil to prevent calling
1414 ;; `exit-recursive-edit' in `isearch-done' that terminates
1415 ;; the execution of this command when it is non-nil.
1416 ;; We call `exit-recursive-edit' explicitly at the end below.
1417 (isearch-recursive-edit nil))
1418 (isearch-done nil t)
1419 (isearch-clean-overlays))
1420 (require 'hi-lock nil t)
1421 (let ((string (cond (isearch-regexp isearch-string)
1422 ((if (and (eq isearch-case-fold-search t)
1423 search-upper-case)
1424 (isearch-no-upper-case-p
1425 isearch-string isearch-regexp)
1426 isearch-case-fold-search)
1427 ;; Turn isearch-string into a case-insensitive
1428 ;; regexp.
1429 (mapconcat
1430 (lambda (c)
1431 (let ((s (string c)))
1432 (if (string-match "[[:alpha:]]" s)
1433 (format "[%s%s]" (upcase s) (downcase s))
1434 (regexp-quote s))))
1435 isearch-string ""))
1436 (t (regexp-quote isearch-string)))))
1437 (hi-lock-face-buffer string (hi-lock-read-face-name)))
1438 (and isearch-recursive-edit (exit-recursive-edit)))
1441 (defun isearch-delete-char ()
1442 "Discard last input item and move point back.
1443 If no previous match was done, just beep."
1444 (interactive)
1445 (if (null (cdr isearch-cmds))
1446 (ding)
1447 (isearch-pop-state))
1448 (isearch-update))
1450 (defun isearch-del-char (&optional arg)
1451 "Delete character from end of search string and search again.
1452 If search string is empty, just beep."
1453 (interactive "p")
1454 (if (= 0 (length isearch-string))
1455 (ding)
1456 (setq isearch-string (substring isearch-string 0 (- (or arg 1)))
1457 isearch-message (mapconcat 'isearch-text-char-description
1458 isearch-string "")))
1459 ;; Use the isearch-other-end as new starting point to be able
1460 ;; to find the remaining part of the search string again.
1461 (if isearch-other-end (goto-char isearch-other-end))
1462 (isearch-search)
1463 (isearch-push-state)
1464 (isearch-update))
1466 (defun isearch-yank-string (string)
1467 "Pull STRING into search string."
1468 ;; Downcase the string if not supposed to case-fold yanked strings.
1469 (if (and isearch-case-fold-search
1470 (eq 'not-yanks search-upper-case))
1471 (setq string (downcase string)))
1472 (if isearch-regexp (setq string (regexp-quote string)))
1473 (setq isearch-string (concat isearch-string string)
1474 isearch-message
1475 (concat isearch-message
1476 (mapconcat 'isearch-text-char-description
1477 string ""))
1478 ;; Don't move cursor in reverse search.
1479 isearch-yank-flag t)
1480 (isearch-search-and-update))
1482 (defun isearch-yank-kill ()
1483 "Pull string from kill ring into search string."
1484 (interactive)
1485 (isearch-yank-string (current-kill 0)))
1487 (defun isearch-yank-x-selection ()
1488 "Pull current X selection into search string."
1489 (interactive)
1490 (isearch-yank-string (x-get-selection)))
1493 (defun isearch-mouse-2 (click)
1494 "Handle mouse-2 in Isearch mode.
1495 For a click in the echo area, invoke `isearch-yank-x-selection'.
1496 Otherwise invoke whatever the calling mouse-2 command sequence
1497 is bound to outside of Isearch."
1498 (interactive "e")
1499 (let* ((w (posn-window (event-start click)))
1500 (overriding-terminal-local-map nil)
1501 (binding (key-binding (this-command-keys-vector) t)))
1502 (if (and (window-minibuffer-p w)
1503 (not (minibuffer-window-active-p w))) ; in echo area
1504 (isearch-yank-x-selection)
1505 (when (functionp binding)
1506 (call-interactively binding)))))
1508 (defun isearch-yank-internal (jumpform)
1509 "Pull the text from point to the point reached by JUMPFORM.
1510 JUMPFORM is a lambda expression that takes no arguments and returns
1511 a buffer position, possibly having moved point to that position.
1512 For example, it might move point forward by a word and return point,
1513 or it might return the position of the end of the line."
1514 (isearch-yank-string
1515 (save-excursion
1516 (and (not isearch-forward) isearch-other-end
1517 (goto-char isearch-other-end))
1518 (buffer-substring-no-properties (point) (funcall jumpform)))))
1520 (defun isearch-yank-char-in-minibuffer (&optional arg)
1521 "Pull next character from buffer into end of search string in minibuffer."
1522 (interactive "p")
1523 (if (eobp)
1524 (insert
1525 (with-current-buffer (cadr (buffer-list))
1526 (buffer-substring-no-properties
1527 (point) (progn (forward-char arg) (point)))))
1528 (forward-char arg)))
1530 (defun isearch-yank-char (&optional arg)
1531 "Pull next character from buffer into search string."
1532 (interactive "p")
1533 (isearch-yank-internal (lambda () (forward-char arg) (point))))
1535 (defun isearch-yank-word-or-char ()
1536 "Pull next character or word from buffer into search string."
1537 (interactive)
1538 (isearch-yank-internal
1539 (lambda ()
1540 (if (or (= (char-syntax (or (char-after) 0)) ?w)
1541 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
1542 (forward-word 1)
1543 (forward-char 1)) (point))))
1545 (defun isearch-yank-word ()
1546 "Pull next word from buffer into search string."
1547 (interactive)
1548 (isearch-yank-internal (lambda () (forward-word 1) (point))))
1550 (defun isearch-yank-line ()
1551 "Pull rest of line from buffer into search string."
1552 (interactive)
1553 (isearch-yank-internal
1554 (lambda () (let ((inhibit-field-text-motion t))
1555 (line-end-position (if (eolp) 2 1))))))
1557 (defun isearch-search-and-update ()
1558 ;; Do the search and update the display.
1559 (when (or isearch-success
1560 ;; Unsuccessful regexp search may become successful by
1561 ;; addition of characters which make isearch-string valid
1562 isearch-regexp
1563 ;; If the string was found but was completely invisible,
1564 ;; it might now be partly visible, so try again.
1565 (prog1 isearch-hidden (setq isearch-hidden nil)))
1566 ;; In reverse search, adding stuff at
1567 ;; the end may cause zero or many more chars to be
1568 ;; matched, in the string following point.
1569 ;; Allow all those possibilities without moving point as
1570 ;; long as the match does not extend past search origin.
1571 (if (and (not isearch-forward) (not isearch-adjusted)
1572 (condition-case ()
1573 (let ((case-fold-search isearch-case-fold-search))
1574 (if (and (eq case-fold-search t) search-upper-case)
1575 (setq case-fold-search
1576 (isearch-no-upper-case-p isearch-string isearch-regexp)))
1577 (looking-at (if isearch-regexp isearch-string
1578 (regexp-quote isearch-string))))
1579 (error nil))
1580 (or isearch-yank-flag
1581 (<= (match-end 0)
1582 (min isearch-opoint isearch-barrier))))
1583 (progn
1584 (setq isearch-success t
1585 isearch-error nil
1586 isearch-other-end (match-end 0))
1587 (if (and (eq isearch-case-fold-search t) search-upper-case)
1588 (setq isearch-case-fold-search
1589 (isearch-no-upper-case-p isearch-string isearch-regexp))))
1590 ;; Not regexp, not reverse, or no match at point.
1591 (if (and isearch-other-end (not isearch-adjusted))
1592 (goto-char (if isearch-forward isearch-other-end
1593 (min isearch-opoint
1594 isearch-barrier
1595 (1+ isearch-other-end)))))
1596 (isearch-search)
1598 (isearch-push-state)
1599 (if isearch-op-fun (funcall isearch-op-fun))
1600 (isearch-update))
1603 ;; *, ?, }, and | chars can make a regexp more liberal.
1604 ;; They can make a regexp match sooner or make it succeed instead of failing.
1605 ;; So go back to place last successful search started
1606 ;; or to the last ^S/^R (barrier), whichever is nearer.
1607 ;; + needs no special handling because the string must match at least once.
1609 (defun isearch-backslash (str)
1610 "Return t if STR ends in an odd number of backslashes."
1611 (= (mod (- (length str) (string-match "\\\\*\\'" str)) 2) 1))
1613 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
1614 "Return point to previous successful match to allow regexp liberalization.
1615 \\<isearch-mode-map>
1616 Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by \
1617 stopping at `isearch-barrier' as needed.
1619 Do nothing if a backslash is escaping the liberalizing character.
1620 If WANT-BACKSLASH is non-nil, invert this behavior (for \\} and \\|).
1622 Do nothing if regexp has recently been invalid unless optional
1623 ALLOW-INVALID non-nil.
1625 If optional TO-BARRIER non-nil, ignore previous matches and go exactly
1626 to the barrier."
1627 ;; (eq (not a) (not b)) makes all non-nil values equivalent
1628 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
1629 (not want-backslash))
1630 ;; We have to check 2 stack frames because the last might be
1631 ;; invalid just because of a backslash.
1632 (or (not isearch-error)
1633 (not (isearch-error-state (cadr isearch-cmds)))
1634 allow-invalid))
1635 (if to-barrier
1636 (progn (goto-char isearch-barrier)
1637 (setq isearch-adjusted t))
1638 (let* ((stack isearch-cmds)
1639 (previous (cdr stack)) ; lookbelow in the stack
1640 (frame (car stack)))
1641 ;; Walk down the stack looking for a valid regexp (as of course only
1642 ;; they can be the previous successful match); this conveniently
1643 ;; removes all bracket-sets and groups that might be in the way, as
1644 ;; well as partial \{\} constructs that the code below leaves behind.
1645 ;; Also skip over postfix operators -- though horrid,
1646 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid.
1647 (while (and previous
1648 (or (isearch-error-state frame)
1649 (let* ((string (isearch-string-state frame))
1650 (lchar (aref string (1- (length string)))))
1651 ;; The operators aren't always operators; check
1652 ;; backslashes. This doesn't handle the case of
1653 ;; operators at the beginning of the regexp not
1654 ;; being special, but then we should fall back to
1655 ;; the barrier anyway because it's all optional.
1656 (if (isearch-backslash
1657 (isearch-string-state (car previous)))
1658 (eq lchar ?\})
1659 (memq lchar '(?* ?? ?+))))))
1660 (setq stack previous previous (cdr previous) frame (car stack)))
1661 (when stack
1662 ;; `stack' now refers the most recent valid regexp that is not at
1663 ;; all optional in its last term. Now dig one level deeper and find
1664 ;; what matched before that.
1665 (let ((last-other-end
1666 (or (and (car previous)
1667 (isearch-other-end-state (car previous)))
1668 isearch-barrier)))
1669 (goto-char (if isearch-forward
1670 (max last-other-end isearch-barrier)
1671 (min last-other-end isearch-barrier)))
1672 (setq isearch-adjusted t)))))))
1674 (defun isearch-unread-key-sequence (keylist)
1675 "Unread the given key-sequence KEYLIST.
1676 Scroll-bar or mode-line events are processed appropriately."
1677 (cancel-kbd-macro-events)
1678 (apply 'isearch-unread keylist)
1679 ;; If the event was a scroll-bar or mode-line click, the event will have
1680 ;; been prefixed by a symbol such as vertical-scroll-bar. We must remove
1681 ;; it here, because this symbol will be attached to the event again next
1682 ;; time it gets read by read-key-sequence.
1684 ;; (Old comment from isearch-other-meta-char: "Note that we don't have to
1685 ;; modify the event anymore in 21 because read_key_sequence no longer
1686 ;; modifies events to produce fake prefix keys.")
1687 (if (and (> (length keylist) 1)
1688 (symbolp (car keylist))
1689 (listp (cadr keylist))
1690 (not (numberp (posn-point
1691 (event-start (cadr keylist) )))))
1692 (pop unread-command-events)))
1694 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1695 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
1697 ;; The idea here is that certain vertical scrolling commands (like C-l
1698 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
1699 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
1700 ;; tamper with isearch's state, or move point. It is unacceptable for the
1701 ;; search string to be scrolled out of the current window. If a command
1702 ;; attempts this, we scroll the text back again.
1704 ;; We implement this feature with a property called `isearch-scroll'.
1705 ;; If a command's symbol has the value t for this property it is a
1706 ;; scrolling command. The feature needs to be enabled by setting the
1707 ;; customizable variable `isearch-allow-scroll' to a non-nil value.
1709 ;; The universal argument commands (e.g. C-u) in simple.el are marked
1710 ;; as scrolling commands, and isearch.el has been amended to allow
1711 ;; prefix arguments to be passed through to scrolling commands. Thus
1712 ;; M-0 C-l will scroll point to the top of the window.
1714 ;; Horizontal scrolling commands are currently not catered for.
1715 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1717 ;; Set the isearch-scroll property on some standard functions:
1718 ;; Scroll-bar functions:
1719 (if (fboundp 'scroll-bar-toolkit-scroll)
1720 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
1721 (if (fboundp 'w32-handle-scroll-bar-event)
1722 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
1724 ;; Commands which scroll the window:
1725 (put 'recenter 'isearch-scroll t)
1726 (put 'recenter-top-bottom 'isearch-scroll t)
1727 (put 'reposition-window 'isearch-scroll t)
1728 (put 'scroll-up 'isearch-scroll t)
1729 (put 'scroll-down 'isearch-scroll t)
1731 ;; Commands which act on the other window
1732 (put 'list-buffers 'isearch-scroll t)
1733 (put 'scroll-other-window 'isearch-scroll t)
1734 (put 'scroll-other-window-down 'isearch-scroll t)
1735 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
1736 (put 'end-of-buffer-other-window 'isearch-scroll t)
1738 ;; Commands which change the window layout
1739 (put 'delete-other-windows 'isearch-scroll t)
1740 (put 'balance-windows 'isearch-scroll t)
1741 (put 'split-window-vertically 'isearch-scroll t)
1742 (put 'split-window-horizontally 'isearch-scroll t)
1743 (put 'enlarge-window 'isearch-scroll t)
1745 ;; Universal argument commands
1746 (put 'universal-argument 'isearch-scroll t)
1747 (put 'negative-argument 'isearch-scroll t)
1748 (put 'digit-argument 'isearch-scroll t)
1750 (defcustom isearch-allow-scroll nil
1751 "If non-nil, scrolling commands are allowed during incremental search."
1752 :type 'boolean
1753 :group 'isearch)
1755 (defun isearch-string-out-of-window (isearch-point)
1756 "Test whether the search string is currently outside of the window.
1757 Return nil if it's completely visible, or if point is visible,
1758 together with as much of the search string as will fit; the symbol
1759 `above' if we need to scroll the text downwards; the symbol `below',
1760 if upwards."
1761 (let ((w-start (window-start))
1762 (w-end (window-end nil t))
1763 (w-L1 (save-excursion (move-to-window-line 1) (point)))
1764 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
1765 start end) ; start and end of search string in buffer
1766 (if isearch-forward
1767 (setq end isearch-point start (or isearch-other-end isearch-point))
1768 (setq start isearch-point end (or isearch-other-end isearch-point)))
1769 (cond ((or (and (>= start w-start) (<= end w-end))
1770 (if isearch-forward
1771 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
1772 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
1773 nil)
1774 ((and (< start w-start)
1775 (< isearch-point w-L-1))
1776 'above)
1777 (t 'below))))
1779 (defun isearch-back-into-window (above isearch-point)
1780 "Scroll the window to bring the search string back into view.
1781 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
1782 search string is above the top of the window, nil when it is beneath
1783 the bottom."
1784 (let (start end)
1785 (if isearch-forward
1786 (setq end isearch-point start (or isearch-other-end isearch-point))
1787 (setq start isearch-point end (or isearch-other-end isearch-point)))
1788 (if above
1789 (progn
1790 (goto-char start)
1791 (recenter 0)
1792 (when (>= isearch-point (window-end nil t))
1793 (goto-char isearch-point)
1794 (recenter -1)))
1795 (goto-char end)
1796 (recenter -1)
1797 (when (< isearch-point (window-start))
1798 (goto-char isearch-point)
1799 (recenter 0))))
1800 (goto-char isearch-point))
1802 (defun isearch-reread-key-sequence-naturally (keylist)
1803 "Reread key sequence KEYLIST with Isearch mode's keymap deactivated.
1804 Return the key sequence as a string/vector."
1805 (isearch-unread-key-sequence keylist)
1806 (let (overriding-terminal-local-map)
1807 (read-key-sequence nil))) ; This will go through function-key-map, if nec.
1809 (defun isearch-lookup-scroll-key (key-seq)
1810 "If KEY-SEQ is bound to a scrolling command, return it as a symbol.
1811 Otherwise return nil."
1812 (let* ((overriding-terminal-local-map nil)
1813 (binding (key-binding key-seq)))
1814 (and binding (symbolp binding) (commandp binding)
1815 (eq (get binding 'isearch-scroll) t)
1816 binding)))
1818 (defalias 'isearch-other-control-char 'isearch-other-meta-char)
1820 (defun isearch-other-meta-char (&optional arg)
1821 "Process a miscellaneous key sequence in Isearch mode.
1823 Try to convert the current key-sequence to something usable in Isearch
1824 mode, either by converting it with `function-key-map', downcasing a
1825 key with C-<upper case>, or finding a \"scrolling command\" bound to
1826 it. \(In the last case, we may have to read more events.) If so,
1827 either unread the converted sequence or execute the command.
1829 Otherwise, if `search-exit-option' is non-nil (the default) unread the
1830 key-sequence and exit the search normally. If it is the symbol
1831 `edit', the search string is edited in the minibuffer and the meta
1832 character is unread so that it applies to editing the string.
1834 ARG is the prefix argument. It will be transmitted through to the
1835 scrolling command or to the command whose key-sequence exits
1836 Isearch mode."
1837 (interactive "P")
1838 (let* ((key (if current-prefix-arg ; not nec the same as ARG
1839 (substring (this-command-keys) universal-argument-num-events)
1840 (this-command-keys)))
1841 (main-event (aref key 0))
1842 (keylist (listify-key-sequence key))
1843 scroll-command isearch-point)
1844 (cond ((and (= (length key) 1)
1845 (let ((lookup (lookup-key local-function-key-map key)))
1846 (not (or (null lookup) (integerp lookup)
1847 (keymapp lookup)))))
1848 ;; Handle a function key that translates into something else.
1849 ;; If the key has a global definition too,
1850 ;; exit and unread the key itself, so its global definition runs.
1851 ;; Otherwise, unread the translation,
1852 ;; so that the translated key takes effect within isearch.
1853 (cancel-kbd-macro-events)
1854 (if (lookup-key global-map key)
1855 (progn
1856 (isearch-done)
1857 (apply 'isearch-unread keylist))
1858 (setq keylist
1859 (listify-key-sequence (lookup-key local-function-key-map key)))
1860 (while keylist
1861 (setq key (car keylist))
1862 ;; If KEY is a printing char, we handle it here
1863 ;; directly to avoid the input method and keyboard
1864 ;; coding system translating it.
1865 (if (and (integerp key)
1866 (>= key ?\s) (/= key 127) (< key 256))
1867 (progn
1868 (isearch-process-search-char key)
1869 (setq keylist (cdr keylist)))
1870 ;; As the remaining keys in KEYLIST can't be handled
1871 ;; here, we must reread them.
1872 (apply 'isearch-unread keylist)
1873 (setq keylist nil)))))
1875 ;; Handle an undefined shifted control character
1876 ;; by downshifting it if that makes it defined.
1877 ;; (As read-key-sequence would normally do,
1878 ;; if we didn't have a default definition.)
1879 (let ((mods (event-modifiers main-event)))
1880 (and (integerp main-event)
1881 (memq 'shift mods)
1882 (memq 'control mods)
1883 (not (memq (lookup-key isearch-mode-map
1884 (let ((copy (copy-sequence key)))
1885 (aset copy 0
1886 (- main-event
1887 (- ?\C-\S-a ?\C-a)))
1888 copy)
1889 nil)
1890 '(nil
1891 isearch-other-control-char)))))
1892 (setcar keylist (- main-event (- ?\C-\S-a ?\C-a)))
1893 (cancel-kbd-macro-events)
1894 (apply 'isearch-unread keylist))
1895 ((eq search-exit-option 'edit)
1896 (apply 'isearch-unread keylist)
1897 (isearch-edit-string))
1898 ;; Handle a scrolling function.
1899 ((and isearch-allow-scroll
1900 (progn (setq key (isearch-reread-key-sequence-naturally keylist))
1901 (setq keylist (listify-key-sequence key))
1902 (setq main-event (aref key 0))
1903 (setq scroll-command (isearch-lookup-scroll-key key))))
1904 ;; From this point onwards, KEY, KEYLIST and MAIN-EVENT hold a
1905 ;; complete key sequence, possibly as modified by function-key-map,
1906 ;; not merely the one or two event fragment which invoked
1907 ;; isearch-other-meta-char in the first place.
1908 (setq isearch-point (point))
1909 (setq prefix-arg arg)
1910 (command-execute scroll-command)
1911 (let ((ab-bel (isearch-string-out-of-window isearch-point)))
1912 (if ab-bel
1913 (isearch-back-into-window (eq ab-bel 'above) isearch-point)
1914 (goto-char isearch-point)))
1915 (isearch-update))
1916 ;; A mouse click on the isearch message starts editing the search string
1917 ((and (eq (car-safe main-event) 'down-mouse-1)
1918 (window-minibuffer-p (posn-window (event-start main-event))))
1919 ;; Swallow the up-event.
1920 (read-event)
1921 (isearch-edit-string))
1922 (search-exit-option
1923 (let (window)
1924 (isearch-unread-key-sequence keylist)
1925 (setq main-event (car unread-command-events))
1927 ;; If we got a mouse click event, that event contains the
1928 ;; window clicked on. maybe it was read with the buffer
1929 ;; it was clicked on. If so, that buffer, not the current one,
1930 ;; is in isearch mode. So end the search in that buffer.
1932 ;; ??? I have no idea what this if checks for, but it's
1933 ;; obviously wrong for the case that a down-mouse event
1934 ;; on another window invokes this function. The event
1935 ;; will contain the window clicked on and that window's
1936 ;; buffer is certainly not always in Isearch mode.
1938 ;; Leave the code in, but check for current buffer not
1939 ;; being in Isearch mode for now, until someone tells
1940 ;; what it's really supposed to do.
1942 ;; --gerd 2001-08-10.
1944 (if (and (not isearch-mode)
1945 (listp main-event)
1946 (setq window (posn-window (event-start main-event)))
1947 (windowp window)
1948 (or (> (minibuffer-depth) 0)
1949 (not (window-minibuffer-p window))))
1950 (with-current-buffer (window-buffer window)
1951 (isearch-done)
1952 (isearch-clean-overlays))
1953 (isearch-done)
1954 (isearch-clean-overlays)
1955 (setq prefix-arg arg))))
1956 (t;; otherwise nil
1957 (isearch-process-search-string key key)))))
1959 (defun isearch-quote-char ()
1960 "Quote special characters for incremental search."
1961 (interactive)
1962 (let ((char (read-quoted-char (isearch-message t))))
1963 ;; Assume character codes 0200 - 0377 stand for characters in some
1964 ;; single-byte character set, and convert them to Emacs
1965 ;; characters.
1966 (if (and isearch-regexp (= char ?\s))
1967 (if (subregexp-context-p isearch-string (length isearch-string))
1968 (isearch-process-search-string "[ ]" " ")
1969 (isearch-process-search-char char))
1970 (and enable-multibyte-characters
1971 (>= char ?\200)
1972 (<= char ?\377)
1973 (setq char (unibyte-char-to-multibyte char)))
1974 (isearch-process-search-char char))))
1976 (defun isearch-return-char ()
1977 "Convert return into newline for incremental search."
1978 (interactive)
1979 (isearch-process-search-char ?\n))
1980 (make-obsolete 'isearch-return-char 'isearch-printing-char "19.7")
1982 (defun isearch-printing-char ()
1983 "Add this ordinary printing character to the search string and search."
1984 (interactive)
1985 (let ((char last-command-event))
1986 (if (= char ?\S-\ )
1987 (setq char ?\s))
1988 (if current-input-method
1989 (isearch-process-search-multibyte-characters char)
1990 (isearch-process-search-char char))))
1992 (defun isearch-process-search-char (char)
1993 ;; * and ? are special in regexps when not preceded by \.
1994 ;; } and | are special in regexps when preceded by \.
1995 ;; Nothing special for + because it matches at least once.
1996 (cond
1997 ((memq char '(?* ??)) (isearch-fallback nil))
1998 ((eq char ?\}) (isearch-fallback t t))
1999 ((eq char ?|) (isearch-fallback t nil t)))
2001 ;; Append the char to the search string, update the message and re-search.
2002 (isearch-process-search-string
2003 (char-to-string char)
2004 (if (>= char ?\200)
2005 (char-to-string char)
2006 (isearch-text-char-description char))))
2008 (defun isearch-process-search-string (string message)
2009 (setq isearch-string (concat isearch-string string)
2010 isearch-message (concat isearch-message message))
2011 (isearch-search-and-update))
2014 ;; Search Ring
2016 (defun isearch-ring-adjust1 (advance)
2017 ;; Helper for isearch-ring-adjust
2018 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2019 (length (length ring))
2020 (yank-pointer-name (if isearch-regexp
2021 'regexp-search-ring-yank-pointer
2022 'search-ring-yank-pointer))
2023 (yank-pointer (eval yank-pointer-name)))
2024 (if (zerop length)
2026 (set yank-pointer-name
2027 (setq yank-pointer
2028 (mod (+ (or yank-pointer 0)
2029 (if advance -1 1))
2030 length)))
2031 (setq isearch-string (nth yank-pointer ring)
2032 isearch-message (mapconcat 'isearch-text-char-description
2033 isearch-string "")))))
2035 (defun isearch-ring-adjust (advance)
2036 ;; Helper for isearch-ring-advance and isearch-ring-retreat
2037 (isearch-ring-adjust1 advance)
2038 (if search-ring-update
2039 (progn
2040 (isearch-search)
2041 (isearch-push-state)
2042 (isearch-update))
2043 ;; Otherwise, edit the search string instead. Note that there is
2044 ;; no need to push the search state after isearch-edit-string here
2045 ;; since isearch-edit-string already pushes its state
2046 (isearch-edit-string)))
2048 (defun isearch-ring-advance ()
2049 "Advance to the next search string in the ring."
2050 ;; This could be more general to handle a prefix arg, but who would use it.
2051 (interactive)
2052 (isearch-ring-adjust 'advance))
2054 (defun isearch-ring-retreat ()
2055 "Retreat to the previous search string in the ring."
2056 (interactive)
2057 (isearch-ring-adjust nil))
2059 (defun isearch-complete1 ()
2060 ;; Helper for isearch-complete and isearch-complete-edit
2061 ;; Return t if completion OK, nil if no completion exists.
2062 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
2063 (completion-ignore-case case-fold-search)
2064 (completion (try-completion isearch-string ring)))
2065 (cond
2066 ((eq completion t)
2067 ;; isearch-string stays the same
2069 ((or completion ; not nil, must be a string
2070 (= 0 (length isearch-string))) ; shouldn't have to say this
2071 (if (equal completion isearch-string) ;; no extension?
2072 (progn
2073 (if completion-auto-help
2074 (with-output-to-temp-buffer "*Isearch completions*"
2075 (display-completion-list
2076 (all-completions isearch-string ring))))
2078 (and completion
2079 (setq isearch-string completion))))
2081 (message "No completion") ; waits a second if in minibuffer
2082 nil))))
2084 (defun isearch-complete ()
2085 "Complete the search string from the strings on the search ring.
2086 The completed string is then editable in the minibuffer.
2087 If there is no completion possible, say so and continue searching."
2088 (interactive)
2089 (if (isearch-complete1)
2090 (progn (setq isearch-message
2091 (mapconcat 'isearch-text-char-description
2092 isearch-string ""))
2093 (isearch-edit-string))
2094 ;; else
2095 (sit-for 1)
2096 (isearch-update)))
2098 (defun isearch-complete-edit ()
2099 "Same as `isearch-complete' except in the minibuffer."
2100 (interactive)
2101 (setq isearch-string (field-string))
2102 (if (isearch-complete1)
2103 (progn
2104 (delete-field)
2105 (insert isearch-string))))
2108 ;; Message string
2110 (defun isearch-message (&optional c-q-hack ellipsis)
2111 ;; Generate and print the message string.
2112 (let ((cursor-in-echo-area ellipsis)
2113 (m isearch-message)
2114 (cmds isearch-cmds)
2115 succ-msg)
2116 (when (or (not isearch-success) isearch-error)
2117 ;; Highlight failed part
2118 (while (or (not (isearch-success-state (car cmds)))
2119 (isearch-error-state (car cmds)))
2120 (pop cmds))
2121 (setq succ-msg (and cmds (isearch-message-state (car cmds)))
2122 m (copy-sequence m))
2123 (add-text-properties
2124 (if (and (stringp succ-msg)
2125 (< (length succ-msg) (length m))
2126 (equal succ-msg (substring m 0 (length succ-msg))))
2127 (length succ-msg)
2129 (length m) '(face isearch-fail) m)
2130 ;; Highlight failed trailing whitespace
2131 (when (string-match " +$" m)
2132 (add-text-properties (match-beginning 0) (match-end 0)
2133 '(face trailing-whitespace) m)))
2134 (setq m (concat
2135 (isearch-message-prefix c-q-hack ellipsis isearch-nonincremental)
2137 (isearch-message-suffix c-q-hack ellipsis)))
2138 (if c-q-hack m (let ((message-log-max nil)) (message "%s" m)))))
2140 (defun isearch-message-prefix (&optional c-q-hack ellipsis nonincremental)
2141 ;; If about to search, and previous search regexp was invalid,
2142 ;; check that it still is. If it is valid now,
2143 ;; let the message we display while searching say that it is valid.
2144 (and isearch-error ellipsis
2145 (condition-case ()
2146 (progn (re-search-forward isearch-string (point) t)
2147 (setq isearch-error nil))
2148 (error nil)))
2149 ;; If currently failing, display no ellipsis.
2150 (or isearch-success (setq ellipsis nil))
2151 (let ((m (concat (if isearch-success "" "failing ")
2152 (if isearch-adjusted "pending " "")
2153 (if (and isearch-wrapped
2154 (not isearch-wrap-function)
2155 (if isearch-forward
2156 (> (point) isearch-opoint)
2157 (< (point) isearch-opoint)))
2158 "over")
2159 (if isearch-wrapped "wrapped ")
2160 (if isearch-word "word " "")
2161 (if isearch-regexp "regexp " "")
2162 (if multi-isearch-next-buffer-current-function "multi " "")
2163 (or isearch-message-prefix-add "")
2164 (if nonincremental "search" "I-search")
2165 (if isearch-forward "" " backward")
2166 (if current-input-method
2167 (concat " [" current-input-method-title "]: ")
2168 ": ")
2170 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
2171 'face 'minibuffer-prompt)))
2173 (defun isearch-message-suffix (&optional c-q-hack ellipsis)
2174 (concat (if c-q-hack "^Q" "")
2175 (if isearch-error
2176 (concat " [" isearch-error "]")
2178 (or isearch-message-suffix-add "")))
2181 ;; Searching
2183 (defvar isearch-search-fun-function nil
2184 "Override `isearch-search-fun'.
2185 This function should return the search function for Isearch to use.
2186 It will call this function with three arguments
2187 as if it were `search-forward'.")
2189 (defun isearch-search-fun ()
2190 "Return the function to use for the search.
2191 Can be changed via `isearch-search-fun-function' for special needs."
2192 (if isearch-search-fun-function
2193 (funcall isearch-search-fun-function)
2194 (cond
2195 (isearch-word
2196 ;; Use lax versions to not fail at the end of the word while
2197 ;; the user adds and removes characters in the search string
2198 ;; (or when using nonincremental word isearch)
2199 (if (or isearch-nonincremental
2200 (eq (length isearch-string)
2201 (length (isearch-string-state (car isearch-cmds)))))
2202 (if isearch-forward 'word-search-forward 'word-search-backward)
2203 (if isearch-forward 'word-search-forward-lax 'word-search-backward-lax)))
2204 (isearch-regexp
2205 (if isearch-forward 're-search-forward 're-search-backward))
2207 (if isearch-forward 'search-forward 'search-backward)))))
2209 (defun isearch-search-string (string bound noerror)
2210 "Search for the first occurrence of STRING or its translation.
2211 If found, move point to the end of the occurrence,
2212 update the match data, and return point."
2213 (let* ((func (isearch-search-fun))
2214 (pos1 (save-excursion (funcall func string bound noerror)))
2215 pos2)
2216 (when (and
2217 ;; Avoid "obsolete" warnings for translation-table-for-input.
2218 (with-no-warnings
2219 (char-table-p translation-table-for-input))
2220 (multibyte-string-p string)
2221 ;; Minor optimization.
2222 (string-match-p "[^[:ascii:]]" string))
2223 (let ((translated
2224 (apply 'string
2225 (mapcar (lambda (c)
2227 ;; Avoid "obsolete" warnings for
2228 ;; translation-table-for-input.
2229 (with-no-warnings
2230 (aref translation-table-for-input c))
2232 string)))
2233 match-data)
2234 (when translated
2235 (save-match-data
2236 (save-excursion
2237 (if (setq pos2 (funcall func translated bound noerror))
2238 (setq match-data (match-data t)))))
2239 (when (and pos2
2240 (or (not pos1)
2241 (if isearch-forward (< pos2 pos1) (> pos2 pos1))))
2242 (setq pos1 pos2)
2243 (set-match-data match-data)))))
2244 (when pos1
2245 ;; When using multiple buffers isearch, switch to the new buffer here,
2246 ;; because `save-excursion' above doesn't allow doing it inside funcall.
2247 (if (and multi-isearch-next-buffer-current-function
2248 (buffer-live-p multi-isearch-current-buffer))
2249 (switch-to-buffer multi-isearch-current-buffer))
2250 (goto-char pos1)
2251 pos1)))
2253 (defun isearch-search ()
2254 ;; Do the search with the current search string.
2255 (if isearch-message-function
2256 (funcall isearch-message-function nil t)
2257 (isearch-message nil t))
2258 (if (and (eq isearch-case-fold-search t) search-upper-case)
2259 (setq isearch-case-fold-search
2260 (isearch-no-upper-case-p isearch-string isearch-regexp)))
2261 (condition-case lossage
2262 (let ((inhibit-point-motion-hooks
2263 (and (eq isearch-filter-predicate 'isearch-filter-visible)
2264 search-invisible))
2265 (inhibit-quit nil)
2266 (case-fold-search isearch-case-fold-search)
2267 (search-spaces-regexp search-whitespace-regexp)
2268 (retry t))
2269 (setq isearch-error nil)
2270 (while retry
2271 (setq isearch-success
2272 (isearch-search-string isearch-string nil t))
2273 ;; Clear RETRY unless the search predicate says
2274 ;; to skip this search hit.
2275 (if (or (not isearch-success)
2276 (bobp) (eobp)
2277 (= (match-beginning 0) (match-end 0))
2278 (funcall isearch-filter-predicate
2279 (match-beginning 0) (match-end 0)))
2280 (setq retry nil)))
2281 (setq isearch-just-started nil)
2282 (if isearch-success
2283 (setq isearch-other-end
2284 (if isearch-forward (match-beginning 0) (match-end 0)))))
2286 (quit (isearch-unread ?\C-g)
2287 (setq isearch-success nil))
2289 (invalid-regexp
2290 (setq isearch-error (car (cdr lossage)))
2291 (if (string-match
2292 "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
2293 isearch-error)
2294 (setq isearch-error "incomplete input")))
2296 (search-failed
2297 (setq isearch-success nil)
2298 (setq isearch-error (nth 2 lossage)))
2300 (error
2301 ;; stack overflow in regexp search.
2302 (setq isearch-error (format "%s" lossage))))
2304 (if isearch-success
2306 ;; Ding if failed this time after succeeding last time.
2307 (and (isearch-success-state (car isearch-cmds))
2308 (ding))
2309 (if (functionp (isearch-pop-fun-state (car isearch-cmds)))
2310 (funcall (isearch-pop-fun-state (car isearch-cmds)) (car isearch-cmds)))
2311 (goto-char (isearch-point-state (car isearch-cmds)))))
2314 ;; Called when opening an overlay, and we are still in isearch.
2315 (defun isearch-open-overlay-temporary (ov)
2316 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2317 ;; Some modes would want to open the overlays temporary during
2318 ;; isearch in their own way, they should set the
2319 ;; `isearch-open-invisible-temporary' to a function doing this.
2320 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2321 ;; Store the values for the `invisible' and `intangible'
2322 ;; properties, and then set them to nil. This way the text hidden
2323 ;; by this overlay becomes visible.
2325 ;; Do we really need to set the `intangible' property to t? Can we
2326 ;; have the point inside an overlay with an `intangible' property?
2327 ;; In 19.34 this does not exist so I cannot test it.
2328 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2329 (overlay-put ov 'isearch-intangible (overlay-get ov 'intangible))
2330 (overlay-put ov 'invisible nil)
2331 (overlay-put ov 'intangible nil)))
2334 ;; This is called at the end of isearch. It will open the overlays
2335 ;; that contain the latest match. Obviously in case of a C-g the
2336 ;; point returns to the original location which surely is not contain
2337 ;; in any of these overlays, se we are safe in this case too.
2338 (defun isearch-open-necessary-overlays (ov)
2339 (let ((inside-overlay (and (> (point) (overlay-start ov))
2340 (< (point) (overlay-end ov))))
2341 ;; If this exists it means that the overlay was opened using
2342 ;; this function, not by us tweaking the overlay properties.
2343 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2344 (when (or inside-overlay (not fct-temp))
2345 ;; restore the values for the `invisible' and `intangible'
2346 ;; properties
2347 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2348 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2349 (overlay-put ov 'isearch-invisible nil)
2350 (overlay-put ov 'isearch-intangible nil))
2351 (if inside-overlay
2352 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2353 (if fct-temp
2354 (funcall fct-temp ov t)))))
2356 ;; This is called when exiting isearch. It closes the temporary
2357 ;; opened overlays, except the ones that contain the latest match.
2358 (defun isearch-clean-overlays ()
2359 (when isearch-opened-overlays
2360 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2361 (setq isearch-opened-overlays nil)))
2364 (defun isearch-intersects-p (start0 end0 start1 end1)
2365 "Return t if regions START0..END0 and START1..END1 intersect."
2366 (or (and (>= start0 start1) (< start0 end1))
2367 (and (> end0 start1) (<= end0 end1))
2368 (and (>= start1 start0) (< start1 end0))
2369 (and (> end1 start0) (<= end1 end0))))
2372 ;; Verify if the current match is outside of each element of
2373 ;; `isearch-opened-overlays', if so close that overlay.
2375 (defun isearch-close-unnecessary-overlays (begin end)
2376 (let ((overlays isearch-opened-overlays))
2377 (setq isearch-opened-overlays nil)
2378 (dolist (ov overlays)
2379 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2380 (push ov isearch-opened-overlays)
2381 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2382 (if fct-temp
2383 ;; If this exists it means that the overlay was opened
2384 ;; using this function, not by us tweaking the overlay
2385 ;; properties.
2386 (funcall fct-temp ov t)
2387 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2388 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2389 (overlay-put ov 'isearch-invisible nil)
2390 (overlay-put ov 'isearch-intangible nil)))))))
2393 (defun isearch-range-invisible (beg end)
2394 "Return t if all the text from BEG to END is invisible."
2395 (when (/= beg end)
2396 ;; Check that invisibility runs up to END.
2397 (save-excursion
2398 (goto-char beg)
2399 (let (;; can-be-opened keeps track if we can open some overlays.
2400 (can-be-opened (eq search-invisible 'open))
2401 ;; the list of overlays that could be opened
2402 (crt-overlays nil))
2403 (when (and can-be-opened isearch-hide-immediately)
2404 (isearch-close-unnecessary-overlays beg end))
2405 ;; If the following character is currently invisible,
2406 ;; skip all characters with that same `invisible' property value.
2407 ;; Do that over and over.
2408 (while (and (< (point) end)
2409 (let ((prop
2410 (get-char-property (point) 'invisible)))
2411 (if (eq buffer-invisibility-spec t)
2412 prop
2413 (or (memq prop buffer-invisibility-spec)
2414 (assq prop buffer-invisibility-spec)))))
2415 (if (get-text-property (point) 'invisible)
2416 (progn
2417 (goto-char (next-single-property-change (point) 'invisible
2418 nil end))
2419 ;; if text is hidden by an `invisible' text property
2420 ;; we cannot open it at all.
2421 (setq can-be-opened nil))
2422 (when can-be-opened
2423 (let ((overlays (overlays-at (point)))
2424 ov-list
2426 invis-prop)
2427 (while overlays
2428 (setq o (car overlays)
2429 invis-prop (overlay-get o 'invisible))
2430 (if (if (eq buffer-invisibility-spec t)
2431 invis-prop
2432 (or (memq invis-prop buffer-invisibility-spec)
2433 (assq invis-prop buffer-invisibility-spec)))
2434 (if (overlay-get o 'isearch-open-invisible)
2435 (setq ov-list (cons o ov-list))
2436 ;; We found one overlay that cannot be
2437 ;; opened, that means the whole chunk
2438 ;; cannot be opened.
2439 (setq can-be-opened nil)))
2440 (setq overlays (cdr overlays)))
2441 (if can-be-opened
2442 ;; It makes sense to append to the open
2443 ;; overlays list only if we know that this is
2444 ;; t.
2445 (setq crt-overlays (append ov-list crt-overlays)))))
2446 (goto-char (next-overlay-change (point)))))
2447 ;; See if invisibility reaches up thru END.
2448 (if (>= (point) end)
2449 (if (and can-be-opened (consp crt-overlays))
2450 (progn
2451 (setq isearch-opened-overlays
2452 (append isearch-opened-overlays crt-overlays))
2453 (mapc 'isearch-open-overlay-temporary crt-overlays)
2454 nil)
2455 (setq isearch-hidden t)))))))
2457 (defun isearch-filter-visible (beg end)
2458 "Test whether the current search hit is visible at least partially.
2459 Return non-nil if the text from BEG to END is visible to Isearch as
2460 determined by `isearch-range-invisible' unless invisible text can be
2461 searched too when `search-invisible' is t."
2462 (or (eq search-invisible t)
2463 (not (isearch-range-invisible beg end))))
2466 ;; General utilities
2468 (defun isearch-no-upper-case-p (string regexp-flag)
2469 "Return t if there are no upper case chars in STRING.
2470 If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
2471 since they have special meaning in a regexp."
2472 (let (quote-flag (i 0) (len (length string)) found)
2473 (while (and (not found) (< i len))
2474 (let ((char (aref string i)))
2475 (if (and regexp-flag (eq char ?\\))
2476 (setq quote-flag (not quote-flag))
2477 (if (and (not quote-flag) (not (eq char (downcase char))))
2478 (setq found t))
2479 (setq quote-flag nil)))
2480 (setq i (1+ i)))
2481 (not (or found
2482 ;; Even if there's no uppercase char, we want to detect the use
2483 ;; of [:upper:] or [:lower:] char-class, which indicates
2484 ;; clearly that the user cares about case distinction.
2485 (and regexp-flag (string-match "\\[:\\(upp\\|low\\)er:]" string)
2486 (condition-case err
2487 (progn
2488 (string-match (substring string 0 (match-beginning 0))
2490 nil)
2491 (invalid-regexp
2492 (equal "Unmatched [ or [^" (cadr err)))))))))
2494 ;; Portability functions to support various Emacs versions.
2496 (defun isearch-text-char-description (c)
2497 (cond
2498 ((< c ?\s) (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph))
2499 ((= c ?\^?) (propertize "^?" 'face 'escape-glyph))
2500 (t (char-to-string c))))
2502 ;; General function to unread characters or events.
2503 ;; Also insert them in a keyboard macro being defined.
2504 (defun isearch-unread (&rest char-or-events)
2505 (mapc 'store-kbd-macro-event char-or-events)
2506 (setq unread-command-events
2507 (append char-or-events unread-command-events)))
2510 ;; Highlighting
2512 (defvar isearch-overlay nil)
2514 (defun isearch-highlight (beg end)
2515 (if search-highlight
2516 (if isearch-overlay
2517 ;; Overlay already exists, just move it.
2518 (move-overlay isearch-overlay beg end (current-buffer))
2519 ;; Overlay doesn't exist, create it.
2520 (setq isearch-overlay (make-overlay beg end))
2521 ;; 1001 is higher than lazy's 1000 and ediff's 100+
2522 (overlay-put isearch-overlay 'priority 1001)
2523 (overlay-put isearch-overlay 'face isearch))))
2525 (defun isearch-dehighlight ()
2526 (when isearch-overlay
2527 (delete-overlay isearch-overlay)))
2529 ;; isearch-lazy-highlight feature
2530 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
2532 ;; When active, *every* match for the current search string is
2533 ;; highlighted: the current one using the normal isearch match color
2534 ;; and all the others using `isearch-lazy-highlight'. The extra
2535 ;; highlighting makes it easier to anticipate where the cursor will
2536 ;; land each time you press C-s or C-r to repeat a pending search.
2537 ;; Highlighting of these additional matches happens in a deferred
2538 ;; fashion using "idle timers," so the cycles needed do not rob
2539 ;; isearch of its usual snappy response.
2541 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
2542 ;; Specifically:
2543 ;; - `isearch-update' is expected to be called (at least) every time
2544 ;; the search string or window-start changes;
2545 ;; - `isearch-string' is expected to contain the current search
2546 ;; string as entered by the user;
2547 ;; - the type of the current search is expected to be given by
2548 ;; `isearch-word' and `isearch-regexp';
2549 ;; - the direction of the current search is expected to be given by
2550 ;; `isearch-forward';
2551 ;; - the variable `isearch-error' is expected to be true
2552 ;; only if `isearch-string' is an invalid regexp.
2554 (defvar isearch-lazy-highlight-overlays nil)
2555 (defvar isearch-lazy-highlight-wrapped nil)
2556 (defvar isearch-lazy-highlight-start-limit nil)
2557 (defvar isearch-lazy-highlight-end-limit nil)
2558 (defvar isearch-lazy-highlight-start nil)
2559 (defvar isearch-lazy-highlight-end nil)
2560 (defvar isearch-lazy-highlight-timer nil)
2561 (defvar isearch-lazy-highlight-last-string nil)
2562 (defvar isearch-lazy-highlight-window nil)
2563 (defvar isearch-lazy-highlight-window-start nil)
2564 (defvar isearch-lazy-highlight-window-end nil)
2565 (defvar isearch-lazy-highlight-case-fold-search nil)
2566 (defvar isearch-lazy-highlight-regexp nil)
2567 (defvar isearch-lazy-highlight-space-regexp nil)
2569 (defun lazy-highlight-cleanup (&optional force)
2570 "Stop lazy highlighting and remove extra highlighting from current buffer.
2571 FORCE non-nil means do it whether or not `lazy-highlight-cleanup'
2572 is nil. This function is called when exiting an incremental search if
2573 `lazy-highlight-cleanup' is non-nil."
2574 (interactive '(t))
2575 (if (or force lazy-highlight-cleanup)
2576 (while isearch-lazy-highlight-overlays
2577 (delete-overlay (car isearch-lazy-highlight-overlays))
2578 (setq isearch-lazy-highlight-overlays
2579 (cdr isearch-lazy-highlight-overlays))))
2580 (when isearch-lazy-highlight-timer
2581 (cancel-timer isearch-lazy-highlight-timer)
2582 (setq isearch-lazy-highlight-timer nil)))
2584 (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup
2585 'lazy-highlight-cleanup
2586 "22.1")
2588 (defun isearch-lazy-highlight-new-loop (&optional beg end)
2589 "Cleanup any previous `lazy-highlight' loop and begin a new one.
2590 BEG and END specify the bounds within which highlighting should occur.
2591 This is called when `isearch-update' is invoked (which can cause the
2592 search string to change or the window to scroll). It is also used
2593 by other Emacs features."
2594 (when (and (null executing-kbd-macro)
2595 (sit-for 0) ;make sure (window-start) is credible
2596 (or (not (equal isearch-string
2597 isearch-lazy-highlight-last-string))
2598 (not (eq (selected-window)
2599 isearch-lazy-highlight-window))
2600 (not (eq isearch-lazy-highlight-case-fold-search
2601 isearch-case-fold-search))
2602 (not (eq isearch-lazy-highlight-regexp
2603 isearch-regexp))
2604 (not (= (window-start)
2605 isearch-lazy-highlight-window-start))
2606 (not (= (window-end) ; Window may have been split/joined.
2607 isearch-lazy-highlight-window-end))))
2608 ;; something important did indeed change
2609 (lazy-highlight-cleanup t) ;kill old loop & remove overlays
2610 (when (not isearch-error)
2611 (setq isearch-lazy-highlight-start-limit beg
2612 isearch-lazy-highlight-end-limit end)
2613 (setq isearch-lazy-highlight-window (selected-window)
2614 isearch-lazy-highlight-window-start (window-start)
2615 isearch-lazy-highlight-window-end (window-end)
2616 isearch-lazy-highlight-start (point)
2617 isearch-lazy-highlight-end (point)
2618 isearch-lazy-highlight-last-string isearch-string
2619 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
2620 isearch-lazy-highlight-regexp isearch-regexp
2621 isearch-lazy-highlight-wrapped nil
2622 isearch-lazy-highlight-space-regexp search-whitespace-regexp)
2623 (unless (equal isearch-string "")
2624 (setq isearch-lazy-highlight-timer
2625 (run-with-idle-timer lazy-highlight-initial-delay nil
2626 'isearch-lazy-highlight-update))))))
2628 (defun isearch-lazy-highlight-search ()
2629 "Search ahead for the next or previous match, for lazy highlighting.
2630 Attempt to do the search exactly the way the pending Isearch would."
2631 (condition-case nil
2632 (let ((case-fold-search isearch-lazy-highlight-case-fold-search)
2633 (isearch-regexp isearch-lazy-highlight-regexp)
2634 (search-spaces-regexp isearch-lazy-highlight-space-regexp)
2635 (search-invisible nil) ; don't match invisible text
2636 (retry t)
2637 (success nil)
2638 (bound (if isearch-forward
2639 (min (or isearch-lazy-highlight-end-limit (point-max))
2640 (if isearch-lazy-highlight-wrapped
2641 isearch-lazy-highlight-start
2642 (window-end)))
2643 (max (or isearch-lazy-highlight-start-limit (point-min))
2644 (if isearch-lazy-highlight-wrapped
2645 isearch-lazy-highlight-end
2646 (window-start))))))
2647 ;; Use a loop like in `isearch-search'.
2648 (while retry
2649 (setq success (isearch-search-string
2650 isearch-lazy-highlight-last-string bound t))
2651 ;; Clear RETRY unless the search predicate says
2652 ;; to skip this search hit.
2653 (if (or (not success)
2654 (funcall isearch-filter-predicate
2655 (match-beginning 0) (match-end 0)))
2656 (setq retry nil)))
2657 success)
2658 (error nil)))
2660 (defun isearch-lazy-highlight-update ()
2661 "Update highlighting of other matches for current search."
2662 (let ((max lazy-highlight-max-at-a-time)
2663 (looping t)
2664 nomore)
2665 (with-local-quit
2666 (save-selected-window
2667 (if (and (window-live-p isearch-lazy-highlight-window)
2668 (not (eq (selected-window) isearch-lazy-highlight-window)))
2669 (select-window isearch-lazy-highlight-window))
2670 (save-excursion
2671 (save-match-data
2672 (goto-char (if isearch-forward
2673 isearch-lazy-highlight-end
2674 isearch-lazy-highlight-start))
2675 (while looping
2676 (let ((found (isearch-lazy-highlight-search)))
2677 (when max
2678 (setq max (1- max))
2679 (if (<= max 0)
2680 (setq looping nil)))
2681 (if found
2682 (let ((mb (match-beginning 0))
2683 (me (match-end 0)))
2684 (if (= mb me) ;zero-length match
2685 (if isearch-forward
2686 (if (= mb (if isearch-lazy-highlight-wrapped
2687 isearch-lazy-highlight-start
2688 (window-end)))
2689 (setq found nil)
2690 (forward-char 1))
2691 (if (= mb (if isearch-lazy-highlight-wrapped
2692 isearch-lazy-highlight-end
2693 (window-start)))
2694 (setq found nil)
2695 (forward-char -1)))
2697 ;; non-zero-length match
2698 (let ((ov (make-overlay mb me)))
2699 (push ov isearch-lazy-highlight-overlays)
2700 ;; 1000 is higher than ediff's 100+,
2701 ;; but lower than isearch main overlay's 1001
2702 (overlay-put ov 'priority 1000)
2703 (overlay-put ov 'face lazy-highlight-face)
2704 (overlay-put ov 'window (selected-window))))
2705 (if isearch-forward
2706 (setq isearch-lazy-highlight-end (point))
2707 (setq isearch-lazy-highlight-start (point)))))
2709 ;; not found or zero-length match at the search bound
2710 (if (not found)
2711 (if isearch-lazy-highlight-wrapped
2712 (setq looping nil
2713 nomore t)
2714 (setq isearch-lazy-highlight-wrapped t)
2715 (if isearch-forward
2716 (progn
2717 (setq isearch-lazy-highlight-end (window-start))
2718 (goto-char (max (or isearch-lazy-highlight-start-limit (point-min))
2719 (window-start))))
2720 (setq isearch-lazy-highlight-start (window-end))
2721 (goto-char (min (or isearch-lazy-highlight-end-limit (point-max))
2722 (window-end))))))))
2723 (unless nomore
2724 (setq isearch-lazy-highlight-timer
2725 (run-at-time lazy-highlight-interval nil
2726 'isearch-lazy-highlight-update)))))))))
2728 (defun isearch-resume (string regexp word forward message case-fold)
2729 "Resume an incremental search.
2730 STRING is the string or regexp searched for.
2731 REGEXP non-nil means the resumed search was a regexp search.
2732 WORD non-nil means resume a word search.
2733 FORWARD non-nil means resume a forward search.
2734 MESSAGE is the echo-area message recorded for the search resumed.
2735 CASE-FOLD non-nil means the search was case-insensitive."
2736 (isearch-mode forward regexp nil nil word)
2737 (setq isearch-string string
2738 isearch-message message
2739 isearch-case-fold-search case-fold)
2740 (isearch-search)
2741 (isearch-update))
2743 ;; arch-tag: 74850515-f7d8-43a6-8a2c-ca90a4c1e675
2744 ;;; isearch.el ends here