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