1 ;;; isearch.el --- incremental search minor mode
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1999,
4 ;; 2000, 2001, 2003, 2004 Free Software Foundation, Inc.
6 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
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 2, or (at your option)
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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
31 ;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
32 ;; isearch-mode behaves modally and does not return until the search
33 ;; is completed. It uses a recursive-edit to behave this way.
35 ;; The key bindings active within isearch-mode are defined below in
36 ;; `isearch-mode-map' which is given bindings close to the default
37 ;; characters of the original isearch.el. With `isearch-mode',
38 ;; however, you can bind multi-character keys and it should be easier
39 ;; to add new commands. One bug though: keys with meta-prefix cannot
40 ;; be longer than two chars. Also see minibuffer-local-isearch-map
41 ;; for bindings active during `isearch-edit-string'.
43 ;; isearch-mode should work even if you switch windows with the mouse,
44 ;; in which case isearch-mode is terminated automatically before the
47 ;; The search ring and completion commands automatically put you in
48 ;; the minibuffer to edit the string. This gives you a chance to
49 ;; modify the search string before executing the search. There are
50 ;; three commands to terminate the editing: C-s and C-r exit the
51 ;; minibuffer and search forward and reverse respectively, while C-m
52 ;; exits and does a nonincremental search.
54 ;; Exiting immediately from isearch uses isearch-edit-string instead
55 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
56 ;; The name of this option should probably be changed if we decide to
57 ;; keep the behavior. No point in forcing nonincremental search until
58 ;; the last possible moment.
63 ;; Some additional options and constants.
66 "Incremental search minor mode."
67 :link '(emacs-commentary-link "isearch")
68 :link '(custom-manual "(emacs)Incremental Search")
74 (defcustom search-exit-option t
75 "*Non-nil means random control characters terminate incremental search."
79 (defcustom search-slow-window-lines 1
80 "*Number of lines in slow search display windows.
81 These are the short windows used during incremental search on slow terminals.
82 Negative means put the slow search window at the top (normally it's at bottom)
83 and the value is minus the number of lines."
87 (defcustom search-slow-speed 1200
88 "*Highest terminal speed at which to use \"slow\" style incremental search.
89 This is the style where a one-line window is created to show the line
90 that the search has reached."
94 (defcustom search-upper-case 'not-yanks
95 "*If non-nil, upper case chars disable case fold searching.
96 That is, upper and lower case chars must match exactly.
97 This applies no matter where the chars come from, but does not
98 apply to chars in regexps that are prefixed with `\\'.
99 If this value is `not-yanks', yanked text is always downcased."
100 :type '(choice (const :tag "off" nil)
105 (defcustom search-nonincremental-instead t
106 "*If non-nil, do a nonincremental search instead if exiting immediately.
107 Actually, `isearch-edit-string' is called to let you enter the search
108 string, and RET terminates editing and does a nonincremental search."
112 (defcustom search-whitespace-regexp "\\s-+"
113 "*If non-nil, regular expression to match a sequence of whitespace chars.
114 This applies to regular expression incremental search.
115 When you put a space or spaces in the incremental regexp, it stands for
116 this, unless it is inside of a regexp construct such as [...] or *, + or ?.
117 You might want to use something like \"[ \\t\\r\\n]+\" instead.
118 In the Customization buffer, that is `[' followed by a space,
119 a tab, a carriage return (control-M), a newline, and `]+'."
123 (defcustom search-highlight t
124 "*Non-nil means incremental search highlights the current match."
128 (defcustom search-invisible 'open
129 "If t incremental search can match hidden text.
130 nil means don't match invisible text.
131 If the value is `open', if the text matched is made invisible by
132 an overlay having an `invisible' property and that overlay has a property
133 `isearch-open-invisible', then incremental search will show the contents.
134 \(This applies when using `outline.el' and `hideshow.el'.)
135 See also `reveal-mode' if you want overlays to automatically be opened
136 whenever point is in one of them."
137 :type '(choice (const :tag "Match hidden text" t)
138 (const :tag "Open overlays" open)
139 (const :tag "Don't match hidden text" nil))
142 (defcustom isearch-hide-immediately t
143 "If non-nil, re-hide an invisible match right away.
144 This variable makes a difference when `search-invisible' is set to `open'.
145 It means that after search makes some invisible text visible
146 to show the match, it makes the text invisible again when the match moves.
147 Ordinarily the text becomes invisible again at the end of the search."
151 (defcustom isearch-resume-in-command-history nil
152 "*If non-nil, `isearch-resume' commands are added to the command history.
153 This allows you to resume earlier isearch sessions through the
158 (defvar isearch-mode-hook nil
159 "Function(s) to call after starting up an incremental search.")
161 (defvar isearch-mode-end-hook nil
162 "Function(s) to call after terminating an incremental search.")
164 (defvar isearch-wrap-function nil
165 "Function to call to wrap the search when search is failed.
166 If nil, move point to the beginning of the buffer for a forward search,
167 or to the end of the buffer for a backward search.")
169 (defvar isearch-push-state-function nil
170 "Function to save a function restoring the mode-specific isearch state
171 to the search status stack.")
175 (defvar search-ring nil
176 "List of search string sequences.")
177 (defvar regexp-search-ring nil
178 "List of regular expression search string sequences.")
180 (defcustom search-ring-max 16
181 "*Maximum length of search ring before oldest elements are thrown away."
184 (defcustom regexp-search-ring-max 16
185 "*Maximum length of regexp search ring before oldest elements are thrown away."
189 (defvar search-ring-yank-pointer nil
190 "Index in `search-ring' of last string reused.
192 (defvar regexp-search-ring-yank-pointer nil
193 "Index in `regexp-search-ring' of last string reused.
196 (defcustom search-ring-update nil
197 "*Non-nil if advancing or retreating in the search ring should cause search.
198 Default value, nil, means edit the string instead."
202 ;; Define isearch-mode keymap.
204 (defvar isearch-mode-map
207 (or (vectorp (nth 1 map))
208 (char-table-p (nth 1 map))
209 (error "The initialization of isearch-mode-map must be updated"))
210 ;; Make all multibyte characters search for themselves.
211 (let ((l (generic-character-list))
214 (set-char-table-default table (car l) 'isearch-printing-char)
216 ;; Make function keys, etc, which aren't bound to a scrolling-function
218 (define-key map [t] 'isearch-other-control-char)
219 ;; Control chars, by default, end isearch mode transparently.
220 ;; We need these explicit definitions because, in a dense keymap,
221 ;; the binding for t does not affect characters.
222 ;; We use a dense keymap to save space.
224 (define-key map (make-string 1 i) 'isearch-other-control-char)
227 ;; Single-byte printing chars extend the search string by default.
230 (define-key map (vector i) 'isearch-printing-char)
233 ;; To handle local bindings with meta char prefix keys, define
234 ;; another full keymap. This must be done for any other prefix
235 ;; keys as well, one full keymap per char of the prefix key. It
236 ;; would be simpler to disable the global keymap, and/or have a
237 ;; default local key binding for any key not otherwise bound.
238 (let ((meta-map (make-sparse-keymap)))
239 (define-key map (char-to-string meta-prefix-char) meta-map)
240 (define-key map [escape] meta-map))
241 (define-key map (vector meta-prefix-char t) 'isearch-other-meta-char)
243 ;; Several non-printing chars change the searching behavior.
244 (define-key map "\C-s" 'isearch-repeat-forward)
245 (define-key map "\C-r" 'isearch-repeat-backward)
246 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
247 ;; combinations can be used to repeat regexp isearches that can
248 ;; be used to start these searches.
249 (define-key map "\M-\C-s" 'isearch-repeat-forward)
250 (define-key map "\M-\C-r" 'isearch-repeat-backward)
251 (define-key map "\177" 'isearch-delete-char)
252 (define-key map "\C-g" 'isearch-abort)
254 ;; This assumes \e is the meta-prefix-char.
255 (or (= ?\e meta-prefix-char)
256 (error "Inconsistency in isearch.el"))
257 (define-key map "\e\e\e" 'isearch-cancel)
258 (define-key map [escape escape escape] 'isearch-cancel)
260 (define-key map "\C-q" 'isearch-quote-char)
262 (define-key map "\r" 'isearch-exit)
263 (define-key map "\C-j" 'isearch-printing-char)
264 (define-key map "\t" 'isearch-printing-char)
266 (define-key map "\C-w" 'isearch-yank-word-or-char)
267 (define-key map "\M-\C-w" 'isearch-del-char)
268 (define-key map "\M-\C-y" 'isearch-yank-char)
269 (define-key map "\C-y" 'isearch-yank-line)
271 ;; Define keys for regexp chars * ? } |.
272 ;; Nothing special for + because it matches at least once.
273 (define-key map "*" 'isearch-*-char)
274 (define-key map "?" 'isearch-*-char)
275 (define-key map "}" 'isearch-}-char)
276 (define-key map "|" 'isearch-|-char)
278 ;; Turned off because I find I expect to get the global definition--rms.
279 ;; ;; Instead bind C-h to special help command for isearch-mode.
280 ;; (define-key map "\C-h" 'isearch-mode-help)
282 (define-key map "\M-n" 'isearch-ring-advance)
283 (define-key map "\M-p" 'isearch-ring-retreat)
284 (define-key map "\M-y" 'isearch-yank-kill)
286 (define-key map "\M-\t" 'isearch-complete)
288 ;; Pass frame events transparently so they won't exit the search.
289 ;; In particular, if we have more than one display open, then a
290 ;; switch-frame might be generated by someone typing at another keyboard.
291 (define-key map [switch-frame] nil)
292 (define-key map [delete-frame] nil)
293 (define-key map [iconify-frame] nil)
294 (define-key map [make-frame-visible] nil)
295 (define-key map [mouse-movement] nil)
296 ;; For searching multilingual text.
297 (define-key map "\C-\\" 'isearch-toggle-input-method)
298 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
300 ;; People expect to be able to paste with the mouse.
301 (define-key map [mouse-2] #'isearch-mouse-2)
302 (define-key map [down-mouse-2] nil)
304 ;; Some bindings you may want to put in your isearch-mode-hook.
305 ;; Suggest some alternates...
306 (define-key map "\M-c" 'isearch-toggle-case-fold)
307 (define-key map "\M-r" 'isearch-toggle-regexp)
308 (define-key map "\M-e" 'isearch-edit-string)
310 (define-key map [?\M-%] 'isearch-query-replace)
311 (define-key map [?\C-\M-%] 'isearch-query-replace-regexp)
314 "Keymap for `isearch-mode'.")
316 (defvar minibuffer-local-isearch-map
317 (let ((map (make-sparse-keymap)))
318 (set-keymap-parent map minibuffer-local-map)
319 (define-key map "\r" 'isearch-nonincremental-exit-minibuffer)
320 (define-key map "\M-n" 'isearch-ring-advance-edit)
321 (define-key map [next] 'isearch-ring-advance-edit)
322 (define-key map [down] 'isearch-ring-advance-edit)
323 (define-key map "\M-p" 'isearch-ring-retreat-edit)
324 (define-key map [prior] 'isearch-ring-retreat-edit)
325 (define-key map [up] 'isearch-ring-retreat-edit)
326 (define-key map "\M-\t" 'isearch-complete-edit)
327 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
328 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
329 (define-key map "\C-f" 'isearch-yank-char-in-minibuffer)
330 (define-key map [right] 'isearch-yank-char-in-minibuffer)
332 "Keymap for editing isearch strings in the minibuffer.")
334 ;; Internal variables declared globally for byte-compiler.
335 ;; These are all set with setq while isearching
336 ;; and bound locally while editing the search string.
338 (defvar isearch-forward nil) ; Searching in the forward direction.
339 (defvar isearch-regexp nil) ; Searching for a regexp.
340 (defvar isearch-word nil) ; Searching for words.
341 (defvar isearch-hidden nil) ; Non-nil if the string exists but is invisible.
343 (defvar isearch-cmds nil
344 "Stack of search status sets.
345 Each set is a vector of the form:
346 [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
347 INVALID-REGEXP WRAPPED BARRIER WITHIN-BRACKETS CASE-FOLD-SEARCH]")
349 (defvar isearch-string "") ; The current search string.
350 (defvar isearch-message "") ; text-char-description version of isearch-string
352 (defvar isearch-success t) ; Searching is currently successful.
353 (defvar isearch-invalid-regexp nil) ; Regexp not well formed.
354 (defvar isearch-within-brackets nil) ; Regexp has unclosed [.
355 (defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
356 (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
357 (defvar isearch-barrier 0)
358 (defvar isearch-just-started nil)
359 (defvar isearch-start-hscroll 0) ; hscroll when starting the search.
361 ; case-fold-search while searching.
362 ; either nil, t, or 'yes. 'yes means the same as t except that mixed
363 ; case in the search string is ignored.
364 (defvar isearch-case-fold-search nil)
366 (defvar isearch-last-case-fold-search nil)
368 ;; Used to save default value while isearch is active
369 (defvar isearch-original-minibuffer-message-timeout nil)
371 (defvar isearch-adjusted nil)
372 (defvar isearch-slow-terminal-mode nil)
373 ;; If t, using a small window.
374 (defvar isearch-small-window nil)
375 (defvar isearch-opoint 0)
376 ;; The window configuration active at the beginning of the search.
377 (defvar isearch-window-configuration nil)
379 ;; Flag to indicate a yank occurred, so don't move the cursor.
380 (defvar isearch-yank-flag nil)
382 ;; A function to be called after each input character is processed.
383 ;; (It is not called after characters that exit the search.)
384 ;; It is only set from an optional argument to `isearch-mode'.
385 (defvar isearch-op-fun nil)
387 ;; Is isearch-mode in a recursive edit for modal searching.
388 (defvar isearch-recursive-edit nil)
390 ;; Should isearch be terminated after doing one search?
391 (defvar isearch-nonincremental nil)
393 ;; New value of isearch-forward after isearch-edit-string.
394 (defvar isearch-new-forward nil)
396 ;; Accumulate here the overlays opened during searching.
397 (defvar isearch-opened-overlays nil)
399 ;; The value of input-method-function when isearch is invoked.
400 (defvar isearch-input-method-function nil)
402 ;; A flag to tell if input-method-function is locally bound when
403 ;; isearch is invoked.
404 (defvar isearch-input-method-local-p nil)
406 ;; Minor-mode-alist changes - kind of redundant with the
407 ;; echo area, but if isearching in multiple windows, it can be useful.
409 (or (assq 'isearch-mode minor-mode-alist)
410 (nconc minor-mode-alist
411 (list '(isearch-mode isearch-mode))))
413 (defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
414 (make-variable-buffer-local 'isearch-mode)
416 (define-key global-map "\C-s" 'isearch-forward)
417 (define-key esc-map "\C-s" 'isearch-forward-regexp)
418 (define-key global-map "\C-r" 'isearch-backward)
419 (define-key esc-map "\C-r" 'isearch-backward-regexp)
421 ;; Entry points to isearch-mode.
423 (defun isearch-forward (&optional regexp-p no-recursive-edit)
425 Do incremental search forward.
426 With a prefix argument, do an incremental regular expression search instead.
428 As you type characters, they add to the search string and are found.
429 The following non-printing keys are bound in `isearch-mode-map'.
431 Type \\[isearch-delete-char] to cancel last input item from end of search string.
432 Type \\[isearch-exit] to exit, leaving point at location found.
433 Type LFD (C-j) to match end of line.
434 Type \\[isearch-repeat-forward] to search again forward,\
435 \\[isearch-repeat-backward] to search again backward.
436 Type \\[isearch-yank-word-or-char] to yank word from buffer onto end of search\
437 string and search for it.
438 Type \\[isearch-del-char] to delete character from end of search string.
439 Type \\[isearch-yank-char] to yank char from buffer onto end of search\
440 string and search for it.
441 Type \\[isearch-yank-line] to yank rest of line onto end of search string\
443 Type \\[isearch-yank-kill] to yank last killed text onto end of search string\
445 Type \\[isearch-quote-char] to quote control character to search for it.
446 \\[isearch-abort] while searching or when search has failed cancels input\
448 been found successfully.
449 \\[isearch-abort] when search is successful aborts and moves point to\
452 Type \\[isearch-toggle-case-fold] to toggle search case-sensitivity.
453 Type \\[isearch-toggle-regexp] to toggle regular-expression mode.
454 Type \\[isearch-edit-string] to edit the search string in the minibuffer.
456 Also supported is a search ring of the previous 16 search strings.
457 Type \\[isearch-ring-advance] to search for the next item in the search ring.
458 Type \\[isearch-ring-retreat] to search for the previous item in the search\
460 Type \\[isearch-complete] to complete the search string using the search ring.
462 If an input method is turned on in the current buffer, that input
463 method is also active while you are typing characters to search. To
464 toggle the input method, type \\[isearch-toggle-input-method]. It
465 also toggles the input method in the current buffer.
467 To use a different input method for searching, type
468 \\[isearch-toggle-specified-input-method], and specify an input method
471 The above keys, bound in `isearch-mode-map', are often controlled by
472 options; do \\[apropos] on search-.* to find them.
473 Other control and meta characters terminate the search
474 and are then executed normally (depending on `search-exit-option').
475 Likewise for function keys and mouse button events.
477 If this function is called non-interactively, it does not return to
478 the calling function until the search is done."
481 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
483 (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
485 Do incremental search forward for regular expression.
486 With a prefix argument, do a regular string search instead.
487 Like ordinary incremental search except that your input
488 is treated as a regexp. See \\[isearch-forward] for more info.
490 In regexp incremental searches, a space or spaces normally matches
491 any whitespace (the variable `search-whitespace-regexp' controls
492 precisely what that means). If you want to search for a literal space
493 and nothing else, enter `[ ]'."
495 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
497 (defun isearch-backward (&optional regexp-p no-recursive-edit)
499 Do incremental search backward.
500 With a prefix argument, do a regular expression search instead.
501 See \\[isearch-forward] for more information."
503 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
505 (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
507 Do incremental search backward for regular expression.
508 With a prefix argument, do a regular string search instead.
509 Like ordinary incremental search except that your input
510 is treated as a regexp. See \\[isearch-forward] for more info."
512 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
515 (defun isearch-mode-help ()
517 (describe-function 'isearch-forward)
521 ;; isearch-mode only sets up incremental search for the minor mode.
522 ;; All the work is done by the isearch-mode commands.
525 ;;(defvar isearch-commands '(isearch-forward isearch-backward
526 ;; isearch-forward-regexp isearch-backward-regexp)
527 ;; "List of commands for which isearch-mode does not recursive-edit.")
530 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p)
531 "Start isearch minor mode. Called by `isearch-forward', etc.
533 \\{isearch-mode-map}"
535 ;; Initialize global vars.
536 (setq isearch-forward forward
537 isearch-regexp regexp
539 isearch-op-fun op-fun
540 isearch-last-case-fold-search isearch-case-fold-search
541 isearch-case-fold-search case-fold-search
547 isearch-barrier (point)
549 isearch-yank-flag nil
550 isearch-invalid-regexp nil
551 isearch-within-brackets nil
552 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
555 (abs search-slow-window-lines))))
556 isearch-other-end nil
557 isearch-small-window nil
558 isearch-just-started t
559 isearch-start-hscroll (window-hscroll)
561 isearch-opoint (point)
562 search-ring-yank-pointer nil
563 isearch-opened-overlays nil
564 isearch-input-method-function input-method-function
565 isearch-input-method-local-p (local-variable-p 'input-method-function)
566 regexp-search-ring-yank-pointer nil
568 ;; Save the original value of `minibuffer-message-timeout', and
569 ;; set it to nil so that isearch's messages don't get timed out.
570 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
571 minibuffer-message-timeout nil)
573 ;; We must bypass input method while reading key. When a user type
574 ;; printable character, appropriate input method is turned on in
575 ;; minibuffer to read multibyte characters.
576 (or isearch-input-method-local-p
577 (make-local-variable 'input-method-function))
578 (setq input-method-function nil)
581 (setq isearch-window-configuration
582 (if isearch-slow-terminal-mode (current-window-configuration) nil))
584 ;; Maybe make minibuffer frame visible and/or raise it.
585 (let ((frame (window-frame (minibuffer-window))))
586 (unless (memq (frame-live-p frame) '(nil t))
587 (unless (frame-visible-p frame)
588 (make-frame-visible frame))
589 (if minibuffer-auto-raise
590 (raise-frame frame))))
592 (setq isearch-mode " Isearch") ;; forward? regexp?
593 (force-mode-line-update)
597 (setq overriding-terminal-local-map isearch-mode-map)
599 (run-hooks 'isearch-mode-hook)
601 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
602 (add-hook 'kbd-macro-termination-hook 'isearch-done)
604 ;; isearch-mode can be made modal (in the sense of not returning to
605 ;; the calling function until searching is completed) by entering
606 ;; a recursive-edit and exiting it when done isearching.
608 (let ((isearch-recursive-edit t))
613 ;; Some high level utilities. Others below.
615 (defun isearch-update ()
616 ;; Called after each command to update the display.
617 (if (and (null unread-command-events)
618 (null executing-kbd-macro))
620 (if (not (input-pending-p))
622 (if (and isearch-slow-terminal-mode
623 (not (or isearch-small-window
624 (pos-visible-in-window-p))))
625 (let ((found-point (point)))
626 (setq isearch-small-window t)
627 (move-to-window-line 0)
628 (let ((window-min-height 1))
629 (split-window nil (if (< search-slow-window-lines 0)
630 (1+ (- search-slow-window-lines))
632 (1+ search-slow-window-lines)))))
633 (if (< search-slow-window-lines 0)
634 (progn (vertical-motion (- 1 search-slow-window-lines))
635 (set-window-start (next-window) (point))
636 (set-window-hscroll (next-window)
638 (set-window-hscroll (selected-window) 0))
640 (goto-char found-point))
641 ;; Keep same hscrolling as at the start of the search when possible
642 (let ((current-scroll (window-hscroll)))
643 (set-window-hscroll (selected-window) isearch-start-hscroll)
644 (unless (pos-visible-in-window-p)
645 (set-window-hscroll (selected-window) current-scroll))))
646 (if isearch-other-end
647 (if (< isearch-other-end (point)) ; isearch-forward?
648 (isearch-highlight isearch-other-end (point))
649 (isearch-highlight (point) isearch-other-end))
650 (isearch-dehighlight nil))
652 (setq ;; quit-flag nil not for isearch-mode
654 isearch-yank-flag nil)
655 (isearch-lazy-highlight-new-loop)
656 ;; We must prevent the point moving to the end of composition when a
657 ;; part of the composition has just been searched.
658 (setq disable-point-adjustment t))
660 (defun isearch-done (&optional nopush edit)
661 (if isearch-resume-in-command-history
662 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
663 ,isearch-word ,isearch-forward
665 ',isearch-case-fold-search)))
666 (unless (equal (car command-history) command)
667 (setq command-history (cons command command-history)))))
669 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
670 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
671 (setq isearch-lazy-highlight-start nil)
673 ;; Called by all commands that terminate isearch-mode.
674 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
675 (setq overriding-terminal-local-map nil)
676 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
677 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
678 (isearch-dehighlight t)
679 (isearch-lazy-highlight-cleanup isearch-lazy-highlight-cleanup)
680 (let ((found-start (window-start (selected-window)))
681 (found-point (point)))
682 (if isearch-window-configuration
683 (set-window-configuration isearch-window-configuration))
685 (if isearch-small-window
686 (goto-char found-point)
687 ;; Exiting the save-window-excursion clobbers window-start; restore it.
688 (set-window-start (selected-window) found-start t)))
690 (setq isearch-mode nil)
691 (if isearch-input-method-local-p
692 (setq input-method-function isearch-input-method-function)
693 (kill-local-variable 'input-method-function))
695 (force-mode-line-update)
697 ;; If we ended in the middle of some intangible text,
698 ;; move to the further end of that intangible text.
699 (let ((after (if (eobp) nil
700 (get-text-property (point) 'intangible)))
701 (before (if (bobp) nil
702 (get-text-property (1- (point)) 'intangible))))
703 (when (and before after (eq before after))
705 (goto-char (next-single-property-change (point) 'intangible))
706 (goto-char (previous-single-property-change (point) 'intangible)))))
708 (if (and (> (length isearch-string) 0) (not nopush))
709 ;; Update the ring data.
710 (isearch-update-ring isearch-string isearch-regexp))
712 (run-hooks 'isearch-mode-end-hook)
714 ;; If there was movement, mark the starting position.
715 ;; Maybe should test difference between and set mark iff > threshold.
716 (if (/= (point) isearch-opoint)
717 (or (and transient-mark-mode mark-active)
719 (push-mark isearch-opoint t)
720 (or executing-kbd-macro (> (minibuffer-depth) 0)
721 (message "Mark saved where search started")))))
723 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
725 (defun isearch-update-ring (string &optional regexp)
726 "Add STRING to the beginning of the search ring.
727 REGEXP says which ring to use."
729 (if (or (null regexp-search-ring)
730 (not (string= string (car regexp-search-ring))))
732 (push string regexp-search-ring)
733 (if (> (length regexp-search-ring) regexp-search-ring-max)
734 (setcdr (nthcdr (1- search-ring-max) regexp-search-ring)
736 (if (or (null search-ring)
737 (not (string= string (car search-ring))))
739 (push string search-ring)
740 (if (> (length search-ring) search-ring-max)
741 (setcdr (nthcdr (1- search-ring-max) search-ring) nil))))))
743 ;; Switching buffers should first terminate isearch-mode.
744 ;; ;; For Emacs 19, the frame switch event is handled.
745 ;; (defun isearch-switch-frame-handler ()
746 ;; (interactive) ;; Is this necessary?
747 ;; ;; First terminate isearch-mode.
749 ;; (isearch-clean-overlays)
750 ;; (handle-switch-frame (car (cdr last-command-char))))
753 ;; The search status structure and stack.
755 (defsubst isearch-string-state (frame)
756 "Return the search string in FRAME."
758 (defsubst isearch-message-state (frame)
759 "Return the search string to display to the user in FRAME."
761 (defsubst isearch-point-state (frame)
762 "Return the point in FRAME."
764 (defsubst isearch-success-state (frame)
765 "Return the success flag in FRAME."
767 (defsubst isearch-forward-state (frame)
768 "Return the searching-forward flag in FRAME."
770 (defsubst isearch-other-end-state (frame)
771 "Return the other end of the match in FRAME."
773 (defsubst isearch-word-state (frame)
774 "Return the search-by-word flag in FRAME."
776 (defsubst isearch-invalid-regexp-state (frame)
777 "Return the regexp error message in FRAME, or nil if its regexp is valid."
779 (defsubst isearch-wrapped-state (frame)
780 "Return the search-wrapped flag in FRAME."
782 (defsubst isearch-barrier-state (frame)
783 "Return the barrier value in FRAME."
785 (defsubst isearch-within-brackets-state (frame)
786 "Return the in-character-class flag in FRAME."
788 (defsubst isearch-case-fold-search-state (frame)
789 "Return the case-folding flag in FRAME."
791 (defsubst isearch-pop-fun-state (frame)
792 "Return the function restoring the mode-specific isearch state in FRAME."
795 (defun isearch-top-state ()
796 (let ((cmd (car isearch-cmds)))
797 (setq isearch-string (isearch-string-state cmd)
798 isearch-message (isearch-message-state cmd)
799 isearch-success (isearch-success-state cmd)
800 isearch-forward (isearch-forward-state cmd)
801 isearch-other-end (isearch-other-end-state cmd)
802 isearch-word (isearch-word-state cmd)
803 isearch-invalid-regexp (isearch-invalid-regexp-state cmd)
804 isearch-wrapped (isearch-wrapped-state cmd)
805 isearch-barrier (isearch-barrier-state cmd)
806 isearch-within-brackets (isearch-within-brackets-state cmd)
807 isearch-case-fold-search (isearch-case-fold-search-state cmd))
808 (if (functionp (isearch-pop-fun-state cmd))
809 (funcall (isearch-pop-fun-state cmd) cmd))
810 (goto-char (isearch-point-state cmd))))
812 (defun isearch-pop-state ()
813 (setq isearch-cmds (cdr isearch-cmds))
816 (defun isearch-push-state ()
818 (cons (vector isearch-string isearch-message (point)
819 isearch-success isearch-forward isearch-other-end
821 isearch-invalid-regexp isearch-wrapped isearch-barrier
822 isearch-within-brackets isearch-case-fold-search
823 (if isearch-push-state-function
824 (funcall isearch-push-state-function)))
828 ;; Commands active while inside of the isearch minor mode.
830 (defun isearch-exit ()
831 "Exit search normally.
832 However, if this is the first command after starting incremental
833 search and `search-nonincremental-instead' is non-nil, do a
834 nonincremental search instead via `isearch-edit-string'."
836 (if (and search-nonincremental-instead
837 (= 0 (length isearch-string)))
838 (let ((isearch-nonincremental t))
839 (isearch-edit-string)))
841 (isearch-clean-overlays))
844 (defun isearch-edit-string ()
845 "Edit the search string in the minibuffer.
846 The following additional command keys are active while editing.
847 \\<minibuffer-local-isearch-map>
848 \\[exit-minibuffer] to resume incremental searching with the edited string.
849 \\[isearch-nonincremental-exit-minibuffer] to do one nonincremental search.
850 \\[isearch-forward-exit-minibuffer] to resume isearching forward.
851 \\[isearch-reverse-exit-minibuffer] to resume isearching backward.
852 \\[isearch-ring-advance-edit] to replace the search string with the next item in the search ring.
853 \\[isearch-ring-retreat-edit] to replace the search string with the previous item in the search ring.
854 \\[isearch-complete-edit] to complete the search string using the search ring.
856 If first char entered is \\[isearch-yank-word-or-char], then do word search instead."
858 ;; This code is very hairy for several reasons, explained in the code.
859 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
860 ;; If there were a way to catch any change of buffer from the minibuffer,
861 ;; this could be simplified greatly.
862 ;; Editing doesn't back up the search point. Should it?
866 (let ((isearch-nonincremental isearch-nonincremental)
868 ;; Locally bind all isearch global variables to protect them
869 ;; from recursive isearching.
870 ;; isearch-string -message and -forward are not bound
871 ;; so they may be changed. Instead, save the values.
872 (isearch-new-string isearch-string)
873 (isearch-new-message isearch-message)
874 (isearch-new-forward isearch-forward)
875 (isearch-new-word isearch-word)
877 (isearch-regexp isearch-regexp)
878 (isearch-op-fun isearch-op-fun)
879 (isearch-cmds isearch-cmds)
880 (isearch-success isearch-success)
881 (isearch-wrapped isearch-wrapped)
882 (isearch-barrier isearch-barrier)
883 (isearch-adjusted isearch-adjusted)
884 (isearch-yank-flag isearch-yank-flag)
885 (isearch-invalid-regexp isearch-invalid-regexp)
886 (isearch-within-brackets isearch-within-brackets)
887 ;;; Don't bind this. We want isearch-search, below, to set it.
888 ;;; And the old value won't matter after that.
889 ;;; (isearch-other-end isearch-other-end)
890 ;;; Perhaps some of these other variables should be bound for a
891 ;;; shorter period, ending before the next isearch-search.
892 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
893 (isearch-opoint isearch-opoint)
894 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
895 (isearch-small-window isearch-small-window)
896 (isearch-recursive-edit isearch-recursive-edit)
897 ;; Save current configuration so we can restore it here.
898 (isearch-window-configuration (current-window-configuration))
900 ;; Temporarily restore `minibuffer-message-timeout'.
901 (minibuffer-message-timeout
902 isearch-original-minibuffer-message-timeout)
903 (isearch-original-minibuffer-message-timeout
904 isearch-original-minibuffer-message-timeout)
907 ;; Actually terminate isearching until editing is done.
908 ;; This is so that the user can do anything without failure,
909 ;; like switch buffers and start another isearch, and return.
912 (exit nil)) ; was recursive editing
914 (isearch-message) ;; for read-char
916 (let* (;; Why does following read-char echo?
917 ;;(echo-keystrokes 0) ;; not needed with above message
918 (e (let ((cursor-in-echo-area t))
920 ;; Binding minibuffer-history-symbol to nil is a work-around
921 ;; for some incompatibility with gmhist.
922 (minibuffer-history-symbol)
923 (message-log-max nil))
924 ;; If the first character the user types when we prompt them
925 ;; for a string is the yank-word character, then go into
926 ;; word-search mode. Otherwise unread that character and
927 ;; read a key the normal way.
928 ;; Word search does not apply (yet) to regexp searches,
929 ;; no check is made here.
930 (message (isearch-message-prefix nil nil t))
931 (if (memq (lookup-key isearch-mode-map (vector e))
933 isearch-yank-word-or-char))
934 (setq isearch-word t;; so message-prefix is right
936 (cancel-kbd-macro-events)
938 (setq cursor-in-echo-area nil)
939 (setq isearch-new-string
941 (read-from-minibuffer
942 (isearch-message-prefix nil nil isearch-nonincremental)
944 minibuffer-local-isearch-map nil
947 (mapconcat 'isearch-text-char-description
948 isearch-new-string "")))
949 ;; Always resume isearching by restarting it.
950 (isearch-mode isearch-forward
956 ;; Copy new local values to isearch globals
957 (setq isearch-string isearch-new-string
958 isearch-message isearch-new-message
959 isearch-forward isearch-new-forward
960 isearch-word isearch-new-word))
962 ;; Empty isearch-string means use default.
963 (if (= 0 (length isearch-string))
964 (setq isearch-string (or (car (if isearch-regexp
970 (mapconcat 'isearch-text-char-description
972 ;; This used to set the last search string,
973 ;; but I think it is not right to do that here.
974 ;; Only the string actually used should be saved.
977 ;; Push the state as of before this C-s.
980 ;; Reinvoke the pending search.
983 (if isearch-nonincremental
985 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
988 (quit ; handle abort-recursive-edit
989 (isearch-abort) ;; outside of let to restore outside global values
992 (defun isearch-nonincremental-exit-minibuffer ()
994 (setq isearch-nonincremental t)
997 (defun isearch-forward-exit-minibuffer ()
999 (setq isearch-new-forward t)
1002 (defun isearch-reverse-exit-minibuffer ()
1004 (setq isearch-new-forward nil)
1007 (defun isearch-cancel ()
1008 "Terminate the search and go back to the starting point."
1010 (if (functionp (isearch-pop-fun-state (car (last isearch-cmds))))
1011 (funcall (isearch-pop-fun-state (car (last isearch-cmds)))
1012 (car (last isearch-cmds))))
1013 (goto-char isearch-opoint)
1014 (isearch-done t) ; exit isearch
1015 (isearch-clean-overlays)
1016 (signal 'quit nil)) ; and pass on quit signal
1018 (defun isearch-abort ()
1019 "Abort incremental search mode if searching is successful, signaling quit.
1020 Otherwise, revert to previous successful search and continue searching.
1021 Use `isearch-exit' to quit without signaling."
1023 ;; (ding) signal instead below, if quitting
1026 ;; If search is successful, move back to starting point
1027 ;; and really do quit.
1029 (setq isearch-success nil)
1031 ;; If search is failing, or has an incomplete regexp,
1032 ;; rub out until it is once more successful.
1033 (while (or (not isearch-success) isearch-invalid-regexp)
1034 (isearch-pop-state))
1037 (defun isearch-repeat (direction)
1038 ;; Utility for isearch-repeat-forward and -backward.
1039 (if (eq isearch-forward (eq direction 'forward))
1040 ;; C-s in forward or C-r in reverse.
1041 (if (equal isearch-string "")
1042 ;; If search string is empty, use last one.
1043 (setq isearch-string
1044 (or (if isearch-regexp
1045 (car regexp-search-ring)
1047 (error "No previous search string"))
1049 (mapconcat 'isearch-text-char-description
1051 isearch-case-fold-search isearch-last-case-fold-search)
1052 ;; If already have what to search for, repeat it.
1055 (if isearch-wrap-function
1056 (funcall isearch-wrap-function)
1057 (goto-char (if isearch-forward (point-min) (point-max))))
1058 (setq isearch-wrapped t))))
1059 ;; C-s in reverse or C-r in forward, change direction.
1060 (setq isearch-forward (not isearch-forward)))
1062 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
1064 (if (equal isearch-string "")
1065 (setq isearch-success t)
1066 (if (and isearch-success
1067 (equal (point) isearch-other-end)
1068 (not isearch-just-started))
1069 ;; If repeating a search that found
1070 ;; an empty string, ensure we advance.
1071 (if (if isearch-forward (eobp) (bobp))
1072 ;; If there's nowhere to advance to, fail (and wrap next time).
1074 (setq isearch-success nil)
1076 (forward-char (if isearch-forward 1 -1))
1080 (isearch-push-state)
1083 (defun isearch-repeat-forward ()
1084 "Repeat incremental search forwards."
1086 (isearch-repeat 'forward))
1088 (defun isearch-repeat-backward ()
1089 "Repeat incremental search backwards."
1091 (isearch-repeat 'backward))
1093 (defun isearch-toggle-regexp ()
1094 "Toggle regexp searching on or off."
1095 ;; The status stack is left unchanged.
1097 (setq isearch-regexp (not isearch-regexp))
1098 (if isearch-regexp (setq isearch-word nil))
1099 (setq isearch-success t isearch-adjusted t)
1102 (defun isearch-toggle-case-fold ()
1103 "Toggle case folding in searching on or off."
1105 (setq isearch-case-fold-search
1106 (if isearch-case-fold-search nil 'yes))
1107 (let ((message-log-max nil))
1108 (message "%s%s [case %ssensitive]"
1109 (isearch-message-prefix nil nil isearch-nonincremental)
1111 (if isearch-case-fold-search "in" "")))
1112 (setq isearch-success t isearch-adjusted t)
1116 (defun isearch-query-replace (&optional regexp-flag)
1117 "Start query-replace with string to replace from last search string."
1119 (barf-if-buffer-read-only)
1120 (if regexp-flag (setq isearch-regexp t))
1121 (let ((case-fold-search isearch-case-fold-search))
1123 (isearch-clean-overlays)
1124 (if (and (< isearch-other-end (point))
1125 (not (and transient-mark-mode mark-active
1126 (< isearch-opoint (point)))))
1127 (goto-char isearch-other-end))
1128 (set query-replace-from-history-variable
1129 (cons isearch-string
1130 (symbol-value query-replace-from-history-variable)))
1133 (query-replace-read-to
1135 (if isearch-regexp "Query replace regexp" "Query replace")
1137 t isearch-regexp isearch-word nil nil
1138 (if (and transient-mark-mode mark-active) (region-beginning))
1139 (if (and transient-mark-mode mark-active) (region-end)))))
1141 (defun isearch-query-replace-regexp ()
1142 "Start query-replace-regexp with string to replace from last search string."
1144 (isearch-query-replace t))
1147 (defun isearch-delete-char ()
1148 "Discard last input item and move point back.
1149 If no previous match was done, just beep."
1151 (if (null (cdr isearch-cmds))
1153 (isearch-pop-state))
1156 (defun isearch-del-char (&optional arg)
1157 "Delete character from end of search string and search again.
1158 If search string is empty, just beep."
1160 (if (= 0 (length isearch-string))
1162 (setq isearch-string (substring isearch-string 0 (- (or arg 1)))
1163 isearch-message (mapconcat 'isearch-text-char-description
1165 ;; Don't move cursor in reverse search.
1166 isearch-yank-flag t))
1167 (isearch-search-and-update))
1169 (defun isearch-yank-string (string)
1170 "Pull STRING into search string."
1171 ;; Downcase the string if not supposed to case-fold yanked strings.
1172 (if (and isearch-case-fold-search
1173 (eq 'not-yanks search-upper-case))
1174 (setq string (downcase string)))
1175 (if isearch-regexp (setq string (regexp-quote string)))
1176 (setq isearch-string (concat isearch-string string)
1178 (concat isearch-message
1179 (mapconcat 'isearch-text-char-description
1181 ;; Don't move cursor in reverse search.
1182 isearch-yank-flag t)
1183 (isearch-search-and-update))
1185 (defun isearch-yank-kill ()
1186 "Pull string from kill ring into search string."
1188 (isearch-yank-string (current-kill 0)))
1190 (defun isearch-yank-x-selection ()
1191 "Pull current X selection into search string."
1193 (isearch-yank-string (x-get-selection)))
1196 (defun isearch-mouse-2 (click)
1197 "Handle mouse-2 in Isearch mode.
1198 For a click in the echo area, invoke `isearch-yank-x-selection'.
1199 Otherwise invoke whatever mouse-2 is bound to outside of Isearch."
1201 (let* ((w (posn-window (event-start click)))
1202 (overriding-terminal-local-map nil)
1203 (key (vector (event-basic-type click)))
1204 ;; FIXME: `key-binding' should accept an event as argument
1205 ;; and do all the overlay/text-properties lookup etc...
1206 (binding (with-current-buffer
1207 (if (window-live-p w) (window-buffer w) (current-buffer))
1208 (key-binding key))))
1209 (if (and (window-minibuffer-p w)
1210 (not (minibuffer-window-active-p w))) ; in echo area
1211 (isearch-yank-x-selection)
1212 (when (functionp binding)
1213 (call-interactively binding)))))
1216 (defun isearch-yank-internal (jumpform)
1217 "Pull the text from point to the point reached by JUMPFORM.
1218 JUMPFORM is a lambda expression that takes no arguments and returns a
1219 buffer position, possibly having moved point to that position. For
1220 example, it might move point forward by a word and return point, or it
1221 might return the position of the end of the line."
1222 (isearch-yank-string
1224 (and (not isearch-forward) isearch-other-end
1225 (goto-char isearch-other-end))
1226 (buffer-substring-no-properties (point) (funcall jumpform)))))
1228 (defun isearch-yank-char-in-minibuffer (&optional arg)
1229 "Pull next character from buffer into end of search string in minibuffer."
1234 (set-buffer (cadr (buffer-list)))
1235 (buffer-substring-no-properties
1236 (point) (progn (forward-char arg) (point)))))
1237 (forward-char arg)))
1239 (defun isearch-yank-char (&optional arg)
1240 "Pull next character from buffer into search string."
1242 (isearch-yank-internal (lambda () (forward-char arg) (point))))
1244 (defun isearch-yank-word-or-char ()
1245 "Pull next character or word from buffer into search string."
1247 (isearch-yank-internal
1249 (if (or (= (char-syntax (or (char-after) 0)) ?w)
1250 (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
1252 (forward-char 1)) (point))))
1254 (defun isearch-yank-word ()
1255 "Pull next word from buffer into search string."
1257 (isearch-yank-internal (lambda () (forward-word 1) (point))))
1259 (defun isearch-yank-line ()
1260 "Pull rest of line from buffer into search string."
1262 (isearch-yank-internal
1263 (lambda () (line-end-position (if (eolp) 2 1)))))
1265 (defun isearch-search-and-update ()
1266 ;; Do the search and update the display.
1267 (when (or isearch-success
1268 ;; Unsuccessful regexp search may become successful by
1269 ;; addition of characters which make isearch-string valid
1271 ;; If the string was found but was completely invisible,
1272 ;; it might now be partly visible, so try again.
1273 (prog1 isearch-hidden (setq isearch-hidden nil)))
1274 ;; In reverse search, adding stuff at
1275 ;; the end may cause zero or many more chars to be
1276 ;; matched, in the string following point.
1277 ;; Allow all those possibilities without moving point as
1278 ;; long as the match does not extend past search origin.
1279 (if (and (not isearch-forward) (not isearch-adjusted)
1281 (let ((case-fold-search isearch-case-fold-search))
1282 (if (and (eq case-fold-search t) search-upper-case)
1283 (setq case-fold-search
1284 (isearch-no-upper-case-p isearch-string isearch-regexp)))
1285 (looking-at (if isearch-regexp isearch-string
1286 (regexp-quote isearch-string))))
1288 (or isearch-yank-flag
1290 (min isearch-opoint isearch-barrier))))
1292 (setq isearch-success t
1293 isearch-invalid-regexp nil
1294 isearch-within-brackets nil
1295 isearch-other-end (match-end 0))
1296 (if (and (eq isearch-case-fold-search t) search-upper-case)
1297 (setq isearch-case-fold-search
1298 (isearch-no-upper-case-p isearch-string isearch-regexp))))
1299 ;; Not regexp, not reverse, or no match at point.
1300 (if (and isearch-other-end (not isearch-adjusted))
1301 (goto-char (if isearch-forward isearch-other-end
1304 (1+ isearch-other-end)))))
1307 (isearch-push-state)
1308 (if isearch-op-fun (funcall isearch-op-fun))
1312 ;; *, ?, }, and | chars can make a regexp more liberal.
1313 ;; They can make a regexp match sooner or make it succeed instead of failing.
1314 ;; So go back to place last successful search started
1315 ;; or to the last ^S/^R (barrier), whichever is nearer.
1316 ;; + needs no special handling because the string must match at least once.
1318 (defun isearch-backslash (str)
1319 "Return t if STR ends in an odd number of backslashes."
1320 (= (mod (- (length str) (string-match "\\\\*\\'" str)) 2) 1))
1322 (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier)
1323 "Return point to previous successful match to allow regexp liberalization.
1324 \\<isearch-mode-map>
1325 Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by
1326 stopping at `isearch-barrier' as needed.
1328 Do nothing if a backslash is escaping the liberalizing character. If
1329 WANT-BACKSLASH is non-nil, invert this behavior (for \\} and \\|).
1331 Do nothing if regexp has recently been invalid unless optional ALLOW-INVALID
1334 If optional TO-BARRIER non-nil, ignore previous matches and go exactly to the
1336 ;; (eq (not a) (not b)) makes all non-nil values equivalent
1337 (when (and isearch-regexp (eq (not (isearch-backslash isearch-string))
1338 (not want-backslash))
1339 ;; We have to check 2 stack frames because the last might be
1340 ;; invalid just because of a backslash.
1341 (or (not isearch-invalid-regexp)
1342 (not (isearch-invalid-regexp-state (cadr isearch-cmds)))
1345 (progn (goto-char isearch-barrier)
1346 (setq isearch-adjusted t))
1347 (let* ((stack isearch-cmds)
1348 (previous (cdr stack)) ; lookbelow in the stack
1349 (frame (car stack)))
1350 ;; Walk down the stack looking for a valid regexp (as of course only
1351 ;; they can be the previous successful match); this conveniently
1352 ;; removes all bracket-sets and groups that might be in the way, as
1353 ;; well as partial \{\} constructs that the code below leaves behind.
1354 ;; Also skip over postfix operators -- though horrid,
1355 ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly legal.
1356 (while (and previous
1357 (or (isearch-invalid-regexp-state frame)
1358 (let* ((string (isearch-string-state frame))
1359 (lchar (aref string (1- (length string)))))
1360 ;; The operators aren't always operators; check
1361 ;; backslashes. This doesn't handle the case of
1362 ;; operators at the beginning of the regexp not
1363 ;; being special, but then we should fall back to
1364 ;; the barrier anyway because it's all optional.
1365 (if (isearch-backslash
1366 (isearch-string-state (car previous)))
1368 (memq lchar '(?* ?? ?+))))))
1369 (setq stack previous previous (cdr previous) frame (car stack)))
1371 ;; `stack' now refers the most recent valid regexp that is not at
1372 ;; all optional in its last term. Now dig one level deeper and find
1373 ;; what matched before that.
1374 (let ((last-other-end (or (isearch-other-end-state (car previous))
1376 (goto-char (if isearch-forward
1377 (max last-other-end isearch-barrier)
1378 (min last-other-end isearch-barrier)))
1379 (setq isearch-adjusted t))))))
1380 (isearch-process-search-char last-command-char))
1382 ;; * and ? are special when not preceded by \.
1383 (defun isearch-*-char ()
1384 "Maybe back up to handle * and ? specially in regexps."
1386 (isearch-fallback nil))
1388 ;; } is special when it is preceded by \.
1389 (defun isearch-}-char ()
1390 "Handle \\} specially in regexps."
1392 (isearch-fallback t t))
1394 ;; | is special when it is preceded by \.
1395 (defun isearch-|-char ()
1396 "If in regexp search, jump to the barrier unless in a group."
1398 (isearch-fallback t nil t))
1400 (defun isearch-unread-key-sequence (keylist)
1401 "Unread the given key-sequence KEYLIST.
1402 Scroll-bar or mode-line events are processed appropriately."
1403 (cancel-kbd-macro-events)
1404 (apply 'isearch-unread keylist)
1405 ;; If the event was a scroll-bar or mode-line click, the event will have
1406 ;; been prefixed by a symbol such as vertical-scroll-bar. We must remove
1407 ;; it here, because this symbol will be attached to the event again next
1408 ;; time it gets read by read-key-sequence.
1410 ;; (Old comment from isearch-other-meta-char: "Note that we don't have to
1411 ;; modify the event anymore in 21 because read_key_sequence no longer
1412 ;; modifies events to produce fake prefix keys.")
1413 (if (and (> (length keylist) 1)
1414 (symbolp (car keylist))
1415 (listp (cadr keylist))
1416 (not (numberp (posn-point
1417 (event-start (cadr keylist) )))))
1418 (pop unread-command-events)))
1420 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1421 ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24
1423 ;; The idea here is that certain vertical scrolling commands (like C-l
1424 ;; `recenter') should be usable WITHIN Isearch mode. For a command to be
1425 ;; suitable, it must NOT alter the buffer, swap to another buffer or frame,
1426 ;; tamper with isearch's state, or move point. It is unacceptable for the
1427 ;; search string to be scrolled out of the current window. If a command
1428 ;; attempts this, we scroll the text back again.
1430 ;; We implement this feature with a property called `isearch-scroll'.
1431 ;; If a command's symbol has the value t for this property it is a
1432 ;; scrolling command. The feature needs to be enabled by setting the
1433 ;; customizable variable `isearch-allow-scroll' to a non-nil value.
1435 ;; The universal argument commands (e.g. C-u) in simple.el are marked
1436 ;; as scrolling commands, and isearch.el has been amended to allow
1437 ;; prefix arguments to be passed through to scrolling commands. Thus
1438 ;; M-0 C-l will scroll point to the top of the window.
1440 ;; Horizontal scrolling commands are currently not catered for.
1441 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1443 ;; Set the isearch-scroll property on some standard functions:
1444 ;; Scroll-bar functions:
1445 (if (fboundp 'scroll-bar-toolkit-scroll)
1446 (put 'scroll-bar-toolkit-scroll 'isearch-scroll t))
1447 (if (fboundp 'mac-handle-scroll-bar-event)
1448 (put 'mac-handle-scroll-bar-event 'isearch-scroll t))
1449 (if (fboundp 'w32-handle-scroll-bar-event)
1450 (put 'w32-handle-scroll-bar-event 'isearch-scroll t))
1452 ;; Commands which scroll the window:
1453 (put 'recenter 'isearch-scroll t)
1454 (put 'reposition-window 'isearch-scroll t)
1455 (put 'scroll-up 'isearch-scroll t)
1456 (put 'scroll-down 'isearch-scroll t)
1458 ;; Commands which act on the other window
1459 (put 'list-buffers 'isearch-scroll t)
1460 (put 'scroll-other-window 'isearch-scroll t)
1461 (put 'scroll-other-window-down 'isearch-scroll t)
1462 (put 'beginning-of-buffer-other-window 'isearch-scroll t)
1463 (put 'end-of-buffer-other-window 'isearch-scroll t)
1465 ;; Commands which change the window layout
1466 (put 'delete-other-windows 'isearch-scroll t)
1467 (put 'balance-windows 'isearch-scroll t)
1468 (put 'split-window-vertically 'isearch-scroll t)
1469 (put 'enlarge-window 'isearch-scroll t)
1471 ;; Universal argument commands
1472 (put 'universal-argument 'isearch-scroll t)
1473 (put 'negative-argument 'isearch-scroll t)
1474 (put 'digit-argument 'isearch-scroll t)
1476 (defcustom isearch-allow-scroll nil
1477 "If non-nil, scrolling commands are allowed during incremental search."
1481 (defun isearch-string-out-of-window (isearch-point)
1482 "Test whether the search string is currently outside of the window.
1483 Return nil if it's completely visible, or if point is visible,
1484 together with as much of the search string as will fit; the symbol
1485 `above' if we need to scroll the text downwards; the symbol `below',
1487 (let ((w-start (window-start))
1488 (w-end (window-end nil t))
1489 (w-L1 (save-excursion (move-to-window-line 1) (point)))
1490 (w-L-1 (save-excursion (move-to-window-line -1) (point)))
1491 start end) ; start and end of search string in buffer
1493 (setq end isearch-point start (or isearch-other-end isearch-point))
1494 (setq start isearch-point end (or isearch-other-end isearch-point)))
1495 (cond ((or (and (>= start w-start) (<= end w-end))
1497 (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1
1498 (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0
1500 ((and (< start w-start)
1501 (< isearch-point w-L-1))
1505 (defun isearch-back-into-window (above isearch-point)
1506 "Scroll the window to bring the search string back into view.
1507 Restore point to ISEARCH-POINT in the process. ABOVE is t when the
1508 search string is above the top of the window, nil when it is beneath
1512 (setq end isearch-point start (or isearch-other-end isearch-point))
1513 (setq start isearch-point end (or isearch-other-end isearch-point)))
1518 (when (>= isearch-point (window-end nil t))
1519 (goto-char isearch-point)
1523 (when (< isearch-point (window-start))
1524 (goto-char isearch-point)
1526 (goto-char isearch-point))
1528 (defun isearch-reread-key-sequence-naturally (keylist)
1529 "Reread key sequence KEYLIST with Isearch mode's keymap deactivated.
1530 Return the key sequence as a string/vector."
1531 (isearch-unread-key-sequence keylist)
1532 (let (overriding-terminal-local-map)
1533 (read-key-sequence nil))) ; This will go through function-key-map, if nec.
1535 (defun isearch-lookup-scroll-key (key-seq)
1536 "If KEY-SEQ is bound to a scrolling command, return it as a symbol.
1537 Otherwise return nil."
1538 (let* ((overriding-terminal-local-map nil)
1539 (binding (key-binding key-seq)))
1540 (and binding (symbolp binding) (commandp binding)
1541 (eq (get binding 'isearch-scroll) t)
1544 (defalias 'isearch-other-control-char 'isearch-other-meta-char)
1546 (defun isearch-other-meta-char (&optional arg)
1547 "Process a miscellaneous key sequence in Isearch mode.
1549 Try to convert the current key-sequence to something usable in Isearch
1550 mode, either by converting it with `function-key-map', downcasing a
1551 key with C-<upper case>, or finding a \"scrolling command\" bound to
1552 it. \(In the last case, we may have to read more events.) If so,
1553 either unread the converted sequence or execute the command.
1555 Otherwise, if `search-exit-option' is non-nil (the default) unread the
1556 key-sequence and exit the search normally. If it is the symbol
1557 `edit', the search string is edited in the minibuffer and the meta
1558 character is unread so that it applies to editing the string.
1560 ARG is the prefix argument. It will be transmitted through to the
1561 scrolling command or to the command whose key-sequence exits
1564 (let* ((key (if current-prefix-arg ; not nec the same as ARG
1565 (substring (this-command-keys) universal-argument-num-events)
1566 (this-command-keys)))
1567 (main-event (aref key 0))
1568 (keylist (listify-key-sequence key))
1569 scroll-command isearch-point)
1570 (cond ((and (= (length key) 1)
1571 (let ((lookup (lookup-key function-key-map key)))
1572 (not (or (null lookup) (integerp lookup)
1573 (keymapp lookup)))))
1574 ;; Handle a function key that translates into something else.
1575 ;; If the key has a global definition too,
1576 ;; exit and unread the key itself, so its global definition runs.
1577 ;; Otherwise, unread the translation,
1578 ;; so that the translated key takes effect within isearch.
1579 (cancel-kbd-macro-events)
1580 (if (lookup-key global-map key)
1583 (apply 'isearch-unread keylist))
1585 (listify-key-sequence (lookup-key function-key-map key)))
1587 (setq key (car keylist))
1588 ;; If KEY is a printing char, we handle it here
1589 ;; directly to avoid the input method and keyboard
1590 ;; coding system translating it.
1591 (if (and (integerp key)
1592 (>= key ?\ ) (/= key 127) (< key 256))
1594 (isearch-process-search-char key)
1595 (setq keylist (cdr keylist)))
1596 ;; As the remaining keys in KEYLIST can't be handled
1597 ;; here, we must reread them.
1598 (apply 'isearch-unread keylist)
1599 (setq keylist nil)))))
1601 ;; Handle an undefined shifted control character
1602 ;; by downshifting it if that makes it defined.
1603 ;; (As read-key-sequence would normally do,
1604 ;; if we didn't have a default definition.)
1605 (let ((mods (event-modifiers main-event)))
1606 (and (integerp main-event)
1608 (memq 'control mods)
1609 (lookup-key isearch-mode-map
1610 (let ((copy (copy-sequence key)))
1612 (- main-event (- ?\C-\S-a ?\C-a)))
1615 (setcar keylist (- main-event (- ?\C-\S-a ?\C-a)))
1616 (cancel-kbd-macro-events)
1617 (apply 'isearch-unread keylist))
1618 ((eq search-exit-option 'edit)
1619 (apply 'isearch-unread keylist)
1620 (isearch-edit-string))
1621 ;; Handle a scrolling function.
1622 ((and isearch-allow-scroll
1623 (progn (setq key (isearch-reread-key-sequence-naturally keylist))
1624 (setq keylist (listify-key-sequence key))
1625 (setq main-event (aref key 0))
1626 (setq scroll-command (isearch-lookup-scroll-key key))))
1627 ;; From this point onwards, KEY, KEYLIST and MAIN-EVENT hold a
1628 ;; complete key sequence, possibly as modified by function-key-map,
1629 ;; not merely the one or two event fragment which invoked
1630 ;; isearch-other-meta-char in the first place.
1631 (setq isearch-point (point))
1632 (setq prefix-arg arg)
1633 (command-execute scroll-command)
1634 (let ((ab-bel (isearch-string-out-of-window isearch-point)))
1636 (isearch-back-into-window (eq ab-bel 'above) isearch-point)
1637 (goto-char isearch-point)))
1641 (isearch-unread-key-sequence keylist)
1642 (setq main-event (car unread-command-events))
1644 ;; If we got a mouse click event, that event contains the
1645 ;; window clicked on. maybe it was read with the buffer
1646 ;; it was clicked on. If so, that buffer, not the current one,
1647 ;; is in isearch mode. So end the search in that buffer.
1649 ;; ??? I have no idea what this if checks for, but it's
1650 ;; obviously wrong for the case that a down-mouse event
1651 ;; on another window invokes this function. The event
1652 ;; will contain the window clicked on and that window's
1653 ;; buffer is certainly not always in Isearch mode.
1655 ;; Leave the code in, but check for current buffer not
1656 ;; being in Isearch mode for now, until someone tells
1657 ;; what it's really supposed to do.
1659 ;; --gerd 2001-08-10.
1661 (if (and (not isearch-mode)
1663 (setq window (posn-window (event-start main-event)))
1665 (or (> (minibuffer-depth) 0)
1666 (not (window-minibuffer-p window))))
1668 (set-buffer (window-buffer window))
1670 (isearch-clean-overlays))
1672 (isearch-clean-overlays)
1673 (setq prefix-arg arg))))
1675 (isearch-process-search-string key key)))))
1677 (defun isearch-quote-char ()
1678 "Quote special characters for incremental search."
1680 (let ((char (read-quoted-char (isearch-message t))))
1681 ;; Assume character codes 0200 - 0377 stand for characters in some
1682 ;; single-byte character set, and convert them to Emacs
1684 (if (and isearch-regexp (= char ?\ ))
1685 (if (subregexp-context-p isearch-string (length isearch-string))
1686 (isearch-process-search-string "[ ]" " ")
1687 (isearch-process-search-char char))
1688 (and enable-multibyte-characters
1691 (setq char (unibyte-char-to-multibyte char)))
1692 (isearch-process-search-char char))))
1694 (defun isearch-return-char ()
1695 "Convert return into newline for incremental search.
1698 (isearch-process-search-char ?\n))
1700 (defun isearch-printing-char ()
1701 "Add this ordinary printing character to the search string and search."
1703 (let ((char last-command-char))
1706 (if (and enable-multibyte-characters
1709 (if (keyboard-coding-system)
1710 (isearch-process-search-multibyte-characters char)
1711 (isearch-process-search-char (unibyte-char-to-multibyte char)))
1712 (if current-input-method
1713 (isearch-process-search-multibyte-characters char)
1714 (isearch-process-search-char char)))))
1716 (defun isearch-process-search-char (char)
1717 ;; Append the char to the search string, update the message and re-search.
1718 (isearch-process-search-string
1719 (char-to-string char)
1721 (char-to-string char)
1722 (isearch-text-char-description char))))
1724 (defun isearch-process-search-string (string message)
1725 (setq isearch-string (concat isearch-string string)
1726 isearch-message (concat isearch-message message))
1727 (isearch-search-and-update))
1732 (defun isearch-ring-adjust1 (advance)
1733 ;; Helper for isearch-ring-adjust
1734 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
1735 (length (length ring))
1736 (yank-pointer-name (if isearch-regexp
1737 'regexp-search-ring-yank-pointer
1738 'search-ring-yank-pointer))
1739 (yank-pointer (eval yank-pointer-name)))
1742 (set yank-pointer-name
1744 (mod (+ (or yank-pointer 0)
1747 (setq isearch-string (nth yank-pointer ring)
1748 isearch-message (mapconcat 'isearch-text-char-description
1749 isearch-string "")))))
1751 (defun isearch-ring-adjust (advance)
1752 ;; Helper for isearch-ring-advance and isearch-ring-retreat
1753 (isearch-ring-adjust1 advance)
1754 (if search-ring-update
1758 (isearch-edit-string)
1760 (isearch-push-state))
1762 (defun isearch-ring-advance ()
1763 "Advance to the next search string in the ring."
1764 ;; This could be more general to handle a prefix arg, but who would use it.
1766 (isearch-ring-adjust 'advance))
1768 (defun isearch-ring-retreat ()
1769 "Retreat to the previous search string in the ring."
1771 (isearch-ring-adjust nil))
1773 (defun isearch-ring-advance-edit (n)
1774 "Insert the next element of the search history into the minibuffer.
1775 With prefix arg N, insert the Nth element."
1777 (let* ((yank-pointer-name (if isearch-regexp
1778 'regexp-search-ring-yank-pointer
1779 'search-ring-yank-pointer))
1780 (yank-pointer (eval yank-pointer-name))
1781 (ring (if isearch-regexp regexp-search-ring search-ring))
1782 (length (length ring)))
1785 (set yank-pointer-name
1787 (mod (- (or yank-pointer 0) n)
1791 (insert (nth yank-pointer ring))
1792 (goto-char (point-max)))))
1794 (defun isearch-ring-retreat-edit (n)
1795 "Insert the previous element of the search history into the minibuffer.
1796 With prefix arg N, insert the Nth element."
1798 (isearch-ring-advance-edit (- n)))
1800 ;;(defun isearch-ring-adjust-edit (advance)
1801 ;; "Use the next or previous search string in the ring while in minibuffer."
1802 ;; (isearch-ring-adjust1 advance)
1804 ;; (insert isearch-string))
1806 ;;(defun isearch-ring-advance-edit ()
1808 ;; (isearch-ring-adjust-edit 'advance))
1810 ;;(defun isearch-ring-retreat-edit ()
1811 ;; "Retreat to the previous search string in the ring while in the minibuffer."
1813 ;; (isearch-ring-adjust-edit nil))
1816 (defun isearch-complete1 ()
1817 ;; Helper for isearch-complete and isearch-complete-edit
1818 ;; Return t if completion OK, nil if no completion exists.
1819 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
1820 (completion-ignore-case case-fold-search)
1821 (completion (try-completion isearch-string ring)))
1824 ;; isearch-string stays the same
1826 ((or completion ; not nil, must be a string
1827 (= 0 (length isearch-string))) ; shouldn't have to say this
1828 (if (equal completion isearch-string) ;; no extension?
1830 (if completion-auto-help
1831 (with-output-to-temp-buffer "*Isearch completions*"
1832 (display-completion-list
1833 (all-completions isearch-string ring))))
1836 (setq isearch-string completion))))
1838 (message "No completion") ; waits a second if in minibuffer
1841 (defun isearch-complete ()
1842 "Complete the search string from the strings on the search ring.
1843 The completed string is then editable in the minibuffer.
1844 If there is no completion possible, say so and continue searching."
1846 (if (isearch-complete1)
1847 (progn (setq isearch-message
1848 (mapconcat 'isearch-text-char-description
1850 (isearch-edit-string))
1855 (defun isearch-complete-edit ()
1856 "Same as `isearch-complete' except in the minibuffer."
1858 (setq isearch-string (field-string))
1859 (if (isearch-complete1)
1862 (insert isearch-string))))
1867 (defun isearch-message (&optional c-q-hack ellipsis)
1868 ;; Generate and print the message string.
1869 (let ((cursor-in-echo-area ellipsis)
1871 (isearch-message-prefix c-q-hack ellipsis isearch-nonincremental)
1872 (if (and (not isearch-success)
1873 (string-match " +$" isearch-message))
1875 (substring isearch-message 0 (match-beginning 0))
1876 (propertize (substring isearch-message (match-beginning 0))
1877 'face 'trailing-whitespace))
1879 (isearch-message-suffix c-q-hack ellipsis)
1883 (let ((message-log-max nil))
1884 (message "%s" m)))))
1886 (defun isearch-message-prefix (&optional c-q-hack ellipsis nonincremental)
1887 ;; If about to search, and previous search regexp was invalid,
1888 ;; check that it still is. If it is valid now,
1889 ;; let the message we display while searching say that it is valid.
1890 (and isearch-invalid-regexp ellipsis
1892 (progn (re-search-forward isearch-string (point) t)
1893 (setq isearch-invalid-regexp nil
1894 isearch-within-brackets nil))
1896 ;; If currently failing, display no ellipsis.
1897 (or isearch-success (setq ellipsis nil))
1898 (let ((m (concat (if isearch-success "" "failing ")
1899 (if isearch-adjusted "pending " "")
1900 (if (and isearch-wrapped
1901 (not isearch-wrap-function)
1903 (> (point) isearch-opoint)
1904 (< (point) isearch-opoint)))
1906 (if isearch-wrapped "wrapped ")
1907 (if isearch-word "word " "")
1908 (if isearch-regexp "regexp " "")
1909 (if nonincremental "search" "I-search")
1910 (if isearch-forward "" " backward")
1911 (if current-input-method
1912 (concat " [" current-input-method-title "]: ")
1915 (propertize (concat (upcase (substring m 0 1)) (substring m 1))
1916 'face 'minibuffer-prompt)))
1918 (defun isearch-message-suffix (&optional c-q-hack ellipsis)
1919 (concat (if c-q-hack "^Q" "")
1920 (if isearch-invalid-regexp
1921 (concat " [" isearch-invalid-regexp "]")
1927 (defvar isearch-search-fun-function nil
1928 "Override `isearch-search-fun'.
1929 This function should return the search function for isearch to use.
1930 It will call this function with three arguments
1931 as if it were `search-forward'.")
1933 (defun isearch-search-fun ()
1934 "Return the function to use for the search.
1935 Can be changed via `isearch-search-fun-function' for special needs."
1936 (if isearch-search-fun-function
1937 (funcall isearch-search-fun-function)
1940 (if isearch-forward 'word-search-forward 'word-search-backward))
1942 (if isearch-forward 're-search-forward 're-search-backward))
1944 (if isearch-forward 'search-forward 'search-backward)))))
1946 (defun isearch-search ()
1947 ;; Do the search with the current search string.
1948 (isearch-message nil t)
1949 (if (and (eq isearch-case-fold-search t) search-upper-case)
1950 (setq isearch-case-fold-search
1951 (isearch-no-upper-case-p isearch-string isearch-regexp)))
1952 (condition-case lossage
1953 (let ((inhibit-point-motion-hooks search-invisible)
1955 (case-fold-search isearch-case-fold-search)
1956 (search-spaces-regexp search-whitespace-regexp)
1958 (if isearch-regexp (setq isearch-invalid-regexp nil))
1959 (setq isearch-within-brackets nil)
1961 (setq isearch-success
1963 (isearch-search-fun)
1964 isearch-string nil t))
1965 ;; Clear RETRY unless we matched some invisible text
1966 ;; and we aren't supposed to do that.
1967 (if (or (eq search-invisible t)
1968 (not isearch-success)
1970 (= (match-beginning 0) (match-end 0))
1971 (not (isearch-range-invisible
1972 (match-beginning 0) (match-end 0))))
1974 (setq isearch-just-started nil)
1976 (setq isearch-other-end
1977 (if isearch-forward (match-beginning 0) (match-end 0)))))
1979 (quit (isearch-unread ?\C-g)
1980 (setq isearch-success nil))
1983 (setq isearch-invalid-regexp (car (cdr lossage)))
1984 (setq isearch-within-brackets (string-match "\\`Unmatched \\["
1985 isearch-invalid-regexp))
1987 "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
1988 isearch-invalid-regexp)
1989 (setq isearch-invalid-regexp "incomplete input")))
1991 ;; stack overflow in regexp search.
1992 (setq isearch-invalid-regexp (format "%s" lossage))))
1996 ;; Ding if failed this time after succeeding last time.
1997 (and (isearch-success-state (car isearch-cmds))
1999 (if (functionp (isearch-pop-fun-state (car isearch-cmds)))
2000 (funcall (isearch-pop-fun-state (car isearch-cmds)) (car isearch-cmds)))
2001 (goto-char (isearch-point-state (car isearch-cmds)))))
2004 ;; Called when opening an overlay, and we are still in isearch.
2005 (defun isearch-open-overlay-temporary (ov)
2006 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
2007 ;; Some modes would want to open the overlays temporary during
2008 ;; isearch in their own way, they should set the
2009 ;; `isearch-open-invisible-temporary' to a function doing this.
2010 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
2011 ;; Store the values for the `invisible' and `intangible'
2012 ;; properties, and then set them to nil. This way the text hidden
2013 ;; by this overlay becomes visible.
2015 ;; Do we really need to set the `intangible' property to t? Can we
2016 ;; have the point inside an overlay with an `intangible' property?
2017 ;; In 19.34 this does not exist so I cannot test it.
2018 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
2019 (overlay-put ov 'isearch-intangible (overlay-get ov 'intangible))
2020 (overlay-put ov 'invisible nil)
2021 (overlay-put ov 'intangible nil)))
2024 ;; This is called at the end of isearch. It will open the overlays
2025 ;; that contain the latest match. Obviously in case of a C-g the
2026 ;; point returns to the original location which surely is not contain
2027 ;; in any of these overlays, se we are safe in this case too.
2028 (defun isearch-open-necessary-overlays (ov)
2029 (let ((inside-overlay (and (> (point) (overlay-start ov))
2030 (< (point) (overlay-end ov))))
2031 ;; If this exists it means that the overlay was opened using
2032 ;; this function, not by us tweaking the overlay properties.
2033 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2034 (when (or inside-overlay (not fct-temp))
2035 ;; restore the values for the `invisible' and `intangible'
2037 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2038 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2039 (overlay-put ov 'isearch-invisible nil)
2040 (overlay-put ov 'isearch-intangible nil))
2042 (funcall (overlay-get ov 'isearch-open-invisible) ov)
2044 (funcall fct-temp ov t)))))
2046 ;; This is called when exiting isearch. It closes the temporary
2047 ;; opened overlays, except the ones that contain the latest match.
2048 (defun isearch-clean-overlays ()
2049 (when isearch-opened-overlays
2050 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
2051 (setq isearch-opened-overlays nil)))
2054 (defun isearch-intersects-p (start0 end0 start1 end1)
2055 "Return t if regions START0..END0 and START1..END1 intersect."
2056 (or (and (>= start0 start1) (< start0 end1))
2057 (and (> end0 start1) (<= end0 end1))
2058 (and (>= start1 start0) (< start1 end0))
2059 (and (> end1 start0) (<= end1 end0))))
2062 ;; Verify if the current match is outside of each element of
2063 ;; `isearch-opened-overlays', if so close that overlay.
2065 (defun isearch-close-unnecessary-overlays (begin end)
2066 (let ((overlays isearch-opened-overlays))
2067 (setq isearch-opened-overlays nil)
2068 (dolist (ov overlays)
2069 (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
2070 (push ov isearch-opened-overlays)
2071 (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
2073 ;; If this exists it means that the overlay was opened
2074 ;; using this function, not by us tweaking the overlay
2076 (funcall fct-temp ov t)
2077 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
2078 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
2079 (overlay-put ov 'isearch-invisible nil)
2080 (overlay-put ov 'isearch-intangible nil)))))))
2083 (defun isearch-range-invisible (beg end)
2084 "Return t if all the text from BEG to END is invisible."
2086 ;; Check that invisibility runs up to END.
2089 (let (;; can-be-opened keeps track if we can open some overlays.
2090 (can-be-opened (eq search-invisible 'open))
2091 ;; the list of overlays that could be opened
2093 (when (and can-be-opened isearch-hide-immediately)
2094 (isearch-close-unnecessary-overlays beg end))
2095 ;; If the following character is currently invisible,
2096 ;; skip all characters with that same `invisible' property value.
2097 ;; Do that over and over.
2098 (while (and (< (point) end)
2100 (get-char-property (point) 'invisible)))
2101 (if (eq buffer-invisibility-spec t)
2103 (or (memq prop buffer-invisibility-spec)
2104 (assq prop buffer-invisibility-spec)))))
2105 (if (get-text-property (point) 'invisible)
2107 (goto-char (next-single-property-change (point) 'invisible
2109 ;; if text is hidden by an `invisible' text property
2110 ;; we cannot open it at all.
2111 (setq can-be-opened nil))
2113 (let ((overlays (overlays-at (point)))
2118 (setq o (car overlays)
2119 invis-prop (overlay-get o 'invisible))
2120 (if (if (eq buffer-invisibility-spec t)
2122 (or (memq invis-prop buffer-invisibility-spec)
2123 (assq invis-prop buffer-invisibility-spec)))
2124 (if (overlay-get o 'isearch-open-invisible)
2125 (setq ov-list (cons o ov-list))
2126 ;; We found one overlay that cannot be
2127 ;; opened, that means the whole chunk
2128 ;; cannot be opened.
2129 (setq can-be-opened nil)))
2130 (setq overlays (cdr overlays)))
2132 ;; It makes sense to append to the open
2133 ;; overlays list only if we know that this is
2135 (setq crt-overlays (append ov-list crt-overlays)))))
2136 (goto-char (next-overlay-change (point)))))
2137 ;; See if invisibility reaches up thru END.
2138 (if (>= (point) end)
2139 (if (and can-be-opened (consp crt-overlays))
2141 (setq isearch-opened-overlays
2142 (append isearch-opened-overlays crt-overlays))
2143 (mapc 'isearch-open-overlay-temporary crt-overlays)
2145 (setq isearch-hidden t)))))))
2150 (defvar isearch-overlay nil)
2152 (defun isearch-highlight (beg end)
2153 (unless (null search-highlight)
2154 (cond (isearch-overlay
2155 ;; Overlay already exists, just move it.
2156 (move-overlay isearch-overlay beg end (current-buffer)))
2159 ;; Overlay doesn't exist, create it.
2160 (setq isearch-overlay (make-overlay beg end))
2161 (overlay-put isearch-overlay 'face isearch)
2162 (overlay-put isearch-overlay 'priority 1) ;higher than lazy overlays
2165 (defun isearch-dehighlight (totally)
2166 (when isearch-overlay
2167 (delete-overlay isearch-overlay)))
2170 ;; General utilities
2173 (defun isearch-no-upper-case-p (string regexp-flag)
2174 "Return t if there are no upper case chars in STRING.
2175 If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
2176 since they have special meaning in a regexp."
2177 (let (quote-flag (i 0) (len (length string)) found)
2178 (while (and (not found) (< i len))
2179 (let ((char (aref string i)))
2180 (if (and regexp-flag (eq char ?\\))
2181 (setq quote-flag (not quote-flag))
2182 (if (and (not quote-flag) (not (eq char (downcase char))))
2184 (setq quote-flag nil)))
2188 ;; Portability functions to support various Emacs versions.
2190 (defun isearch-text-char-description (c)
2192 ((< c ?\ ) (format "^%c" (+ c 64)))
2194 (t (char-to-string c))))
2196 ;; General function to unread characters or events.
2197 ;; Also insert them in a keyboard macro being defined.
2198 (defun isearch-unread (&rest char-or-events)
2199 (mapc 'store-kbd-macro-event char-or-events)
2200 (setq unread-command-events
2201 (append char-or-events unread-command-events)))
2204 ;; isearch-lazy-highlight feature
2205 ;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
2207 ;; When active, *every* match for the current search string is
2208 ;; highlighted: the current one using the normal isearch match color
2209 ;; and all the others using `isearch-lazy-highlight-face'. The extra
2210 ;; highlighting makes it easier to anticipate where the cursor will
2211 ;; land each time you press C-s or C-r to repeat a pending search.
2212 ;; Highlighting of these additional matches happens in a deferred
2213 ;; fashion using "idle timers," so the cycles needed do not rob
2214 ;; isearch of its usual snappy response.
2216 ;; IMPLEMENTATION NOTE: This depends on some isearch internals.
2218 ;; - `isearch-update' is expected to be called (at least) every time
2219 ;; the search string or window-start changes;
2220 ;; - `isearch-string' is expected to contain the current search
2221 ;; string as entered by the user;
2222 ;; - the type of the current search is expected to be given by
2223 ;; `isearch-word' and `isearch-regexp';
2224 ;; - the direction of the current search is expected to be given by
2225 ;; `isearch-forward';
2226 ;; - the variable `isearch-invalid-regexp' is expected to be true
2227 ;; iff `isearch-string' is an invalid regexp.
2229 (defgroup isearch-lazy-highlight nil
2230 "Lazy highlighting feature for incremental search."
2231 :prefix "isearch-lazy-highlight-"
2235 (defcustom isearch-lazy-highlight t
2236 "*Controls the lazy-highlighting during incremental searches.
2237 When non-nil, all text in the buffer matching the current search
2238 string is highlighted lazily (see `isearch-lazy-highlight-initial-delay'
2239 and `isearch-lazy-highlight-interval')."
2241 :group 'isearch-lazy-highlight)
2243 (defcustom isearch-lazy-highlight-cleanup t
2244 "*Controls whether to remove extra highlighting after a search.
2245 If this is nil, extra highlighting can be \"manually\" removed with
2246 \\[isearch-lazy-highlight-cleanup]."
2248 :group 'isearch-lazy-highlight)
2250 (defcustom isearch-lazy-highlight-initial-delay 0.25
2251 "*Seconds to wait before beginning to lazily highlight all matches."
2253 :group 'isearch-lazy-highlight)
2255 (defcustom isearch-lazy-highlight-interval 0 ; 0.0625
2256 "*Seconds between lazily highlighting successive matches."
2258 :group 'isearch-lazy-highlight)
2260 (defcustom isearch-lazy-highlight-max-at-a-time 20
2261 "*Maximum matches to highlight at a time (for `isearch-lazy-highlight').
2262 Larger values may reduce isearch's responsiveness to user input;
2263 smaller values make matches highlight slowly.
2264 A value of nil means highlight all matches."
2265 :type '(choice (const :tag "All" nil)
2266 (integer :tag "Some"))
2267 :group 'isearch-lazy-highlight)
2269 (defgroup isearch-faces nil
2270 "Lazy highlighting feature for incremental search."
2275 '((((class color) (min-colors 88) (background light))
2276 ;; The background must not be too dark, for that means
2277 ;; the character is hard to see when the cursor is there.
2278 (:background "magenta2" :foreground "lightskyblue1"))
2279 (((class color) (min-colors 88) (background dark))
2280 (:background "palevioletred2" :foreground "brown4"))
2281 (((class color) (min-colors 16))
2282 (:background "magenta4" :foreground "cyan1"))
2283 (((class color) (min-colors 8))
2284 (:background "magenta4" :foreground "cyan1"))
2285 (t (:inverse-video t)))
2286 "Face for highlighting Isearch matches."
2287 :group 'isearch-faces)
2288 (defvar isearch 'isearch)
2290 (defface isearch-lazy-highlight-face
2291 '((((class color) (min-colors 88) (background light))
2292 (:background "paleturquoise"))
2293 (((class color) (min-colors 88) (background dark))
2294 (:background "paleturquoise4"))
2295 (((class color) (min-colors 16))
2296 (:background "turquoise3"))
2297 (((class color) (min-colors 8))
2298 (:background "turquoise3"))
2300 "Face for lazy highlighting of Isearch matches other than the current one."
2301 :group 'isearch-faces)
2302 (defvar isearch-lazy-highlight-face 'isearch-lazy-highlight-face)
2304 (defvar isearch-lazy-highlight-overlays nil)
2305 (defvar isearch-lazy-highlight-wrapped nil)
2306 (defvar isearch-lazy-highlight-start nil)
2307 (defvar isearch-lazy-highlight-end nil)
2308 (defvar isearch-lazy-highlight-timer nil)
2309 (defvar isearch-lazy-highlight-last-string nil)
2310 (defvar isearch-lazy-highlight-window nil)
2311 (defvar isearch-lazy-highlight-window-start nil)
2312 (defvar isearch-lazy-highlight-window-end nil)
2313 (defvar isearch-lazy-highlight-case-fold-search nil)
2314 (defvar isearch-lazy-highlight-regexp nil)
2316 (defun isearch-lazy-highlight-cleanup (&optional force)
2317 "Stop lazy highlighting and remove extra highlighting from current buffer.
2318 FORCE non-nil means do it whether or not `isearch-lazy-highlight-cleanup'
2319 is nil. This function is called when exiting an incremental search if
2320 `isearch-lazy-highlight-cleanup' is non-nil."
2322 (if (or force isearch-lazy-highlight-cleanup)
2323 (while isearch-lazy-highlight-overlays
2324 (delete-overlay (car isearch-lazy-highlight-overlays))
2325 (setq isearch-lazy-highlight-overlays
2326 (cdr isearch-lazy-highlight-overlays))))
2327 (when isearch-lazy-highlight-timer
2328 (cancel-timer isearch-lazy-highlight-timer)
2329 (setq isearch-lazy-highlight-timer nil)))
2331 (defun isearch-lazy-highlight-new-loop ()
2332 "Cleanup any previous `isearch-lazy-highlight' loop and begin a new one.
2333 This happens when `isearch-update' is invoked (which can cause the
2334 search string to change or the window to scroll)."
2335 (when (and isearch-lazy-highlight
2336 (null executing-kbd-macro)
2337 (sit-for 0) ;make sure (window-start) is credible
2338 (or (not (equal isearch-string
2339 isearch-lazy-highlight-last-string))
2340 (not (eq (selected-window)
2341 isearch-lazy-highlight-window))
2342 (not (eq isearch-lazy-highlight-case-fold-search
2343 isearch-case-fold-search))
2344 (not (eq isearch-lazy-highlight-regexp
2346 (not (= (window-start)
2347 isearch-lazy-highlight-window-start))
2348 (not (= (window-end) ; Window may have been split/joined.
2349 isearch-lazy-highlight-window-end))))
2350 ;; something important did indeed change
2351 (isearch-lazy-highlight-cleanup t) ;kill old loop & remove overlays
2352 (when (not isearch-invalid-regexp)
2353 (setq isearch-lazy-highlight-window (selected-window)
2354 isearch-lazy-highlight-window-start (window-start)
2355 isearch-lazy-highlight-window-end (window-end)
2356 isearch-lazy-highlight-start (point)
2357 isearch-lazy-highlight-end (point)
2358 isearch-lazy-highlight-last-string isearch-string
2359 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
2360 isearch-lazy-highlight-regexp isearch-regexp
2361 isearch-lazy-highlight-wrapped nil)
2362 (unless (equal isearch-string "")
2363 (setq isearch-lazy-highlight-timer
2364 (run-with-idle-timer isearch-lazy-highlight-initial-delay nil
2365 'isearch-lazy-highlight-update))))))
2367 (defun isearch-lazy-highlight-search ()
2368 "Search ahead for the next or previous match, for lazy highlighting.
2369 Attempt to do the search exactly the way the pending isearch would."
2370 (let ((case-fold-search isearch-case-fold-search)
2371 (search-spaces-regexp search-whitespace-regexp))
2372 (funcall (isearch-search-fun)
2375 (if isearch-lazy-highlight-wrapped
2376 isearch-lazy-highlight-start
2378 (if isearch-lazy-highlight-wrapped
2379 isearch-lazy-highlight-end
2383 (defun isearch-lazy-highlight-update ()
2384 "Update highlighting of other matches for current search."
2385 (let ((max isearch-lazy-highlight-max-at-a-time)
2390 (goto-char (if isearch-forward
2391 isearch-lazy-highlight-end
2392 isearch-lazy-highlight-start))
2394 (let ((found (isearch-lazy-highlight-search)))
2398 (setq looping nil)))
2400 (let ((mb (match-beginning 0))
2402 (if (= mb me) ;zero-length match
2404 (if (= mb (if isearch-lazy-highlight-wrapped
2405 isearch-lazy-highlight-start
2409 (if (= mb (if isearch-lazy-highlight-wrapped
2410 isearch-lazy-highlight-end
2415 ;; non-zero-length match
2416 (let ((ov (make-overlay mb me)))
2417 (overlay-put ov 'face isearch-lazy-highlight-face)
2418 (overlay-put ov 'priority 0) ;lower than main overlay
2419 (overlay-put ov 'window (selected-window))
2420 (push ov isearch-lazy-highlight-overlays)))
2422 (setq isearch-lazy-highlight-end (point))
2423 (setq isearch-lazy-highlight-start (point)))))
2425 ;; not found or zero-length match at the search bound
2427 (if isearch-lazy-highlight-wrapped
2430 (setq isearch-lazy-highlight-wrapped t)
2433 (setq isearch-lazy-highlight-end (window-start))
2434 (goto-char (window-start)))
2435 (setq isearch-lazy-highlight-start (window-end))
2436 (goto-char (window-end)))))))
2438 (setq isearch-lazy-highlight-timer
2439 (run-at-time isearch-lazy-highlight-interval nil
2440 'isearch-lazy-highlight-update)))))))
2442 (defun isearch-resume (search regexp word forward message case-fold)
2443 "Resume an incremental search.
2444 SEARCH is the string or regexp searched for.
2445 REGEXP non-nil means the resumed search was a regexp search.
2446 WORD non-nil means resume a word search.
2447 FORWARD non-nil means resume a forward search.
2448 MESSAGE is the echo-area message recorded for the search resumed.
2449 CASE-FOLD non-nil means the search was case-insensitive."
2450 (isearch-mode forward regexp nil nil word)
2451 (setq isearch-string search
2452 isearch-message message
2453 isearch-case-fold-search case-fold)
2456 ;; arch-tag: 74850515-f7d8-43a6-8a2c-ca90a4c1e675
2457 ;;; isearch.el ends here