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