(image-jpeg-p): Test for APPn markers in the range
[bpt/emacs.git] / lisp / isearch.el
CommitLineData
55535639 1;;; isearch.el --- incremental search minor mode
3b1e4dd1 2
1f4139d5 3;; Copyright (C) 1992, 93, 94, 95, 96, 97, 1999, 2000, 2001
1ea1fb7e 4;; Free Software Foundation, Inc.
3a801d0c 5
3b1e4dd1 6;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
0f09b616 7;; Maintainer: FSF
117132a6 8;; Keywords: matching
8e1cae6d 9
54d2ecd3 10;; This file is part of GNU Emacs.
8e1cae6d 11
59243403
RS
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
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
b578f267
EN
23;; along with GNU Emacs; see the file COPYING. If not, write to the
24;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25;; Boston, MA 02111-1307, USA.
8e1cae6d 26
3b1e4dd1
ER
27;;; Commentary:
28
8e1cae6d
JB
29;; Instructions
30
08200510
RS
31;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
32;; isearch-mode behaves modally and does not return until the search
117132a6 33;; is completed. It uses a recursive-edit to behave this way.
08200510 34
8e1cae6d 35;; The key bindings active within isearch-mode are defined below in
08200510
RS
36;; `isearch-mode-map' which is given bindings close to the default
37;; characters of the original isearch.el. With `isearch-mode',
38;; however, you can bind multi-character keys and it should be easier
39;; to add new commands. One bug though: keys with meta-prefix cannot
40;; be longer than two chars. Also see minibuffer-local-isearch-map
41;; for bindings active during `isearch-edit-string'.
42
117132a6
DL
43;; isearch-mode should work even if you switch windows with the mouse,
44;; in which case isearch-mode is terminated automatically before the
45;; switch.
08200510
RS
46
47;; The search ring and completion commands automatically put you in
48;; the minibuffer to edit the string. This gives you a chance to
49;; modify the search string before executing the search. There are
50;; three commands to terminate the editing: C-s and C-r exit the
51;; minibuffer and search forward and reverse respectively, while C-m
52;; exits and does a nonincremental search.
53
54;; Exiting immediately from isearch uses isearch-edit-string instead
55;; of nonincremental-search, if search-nonincremental-instead is non-nil.
56;; The name of this option should probably be changed if we decide to
57;; keep the behavior. No point in forcing nonincremental search until
58;; the last possible moment.
59
60;; TODO
eb8c3be9 61;; - Integrate the emacs 19 generalized command history.
08200510
RS
62;; - Think about incorporating query-replace.
63;; - Hooks and options for failed search.
282d89c0 64
3b1e4dd1
ER
65;;; Change Log:
66
b578f267
EN
67;; Changes before those recorded in ChangeLog:
68
69;; Revision 1.4 92/09/14 16:26:02 liberte
70;; Added prefix args to isearch-forward, etc. to switch between
71;; string and regular expression searching.
72;; Added some support for lemacs.
73;; Added general isearch-highlight option - but only for lemacs so far.
74;; Added support for frame switching in emacs 19.
75;; Added word search option to isearch-edit-string.
76;; Renamed isearch-quit to isearch-abort.
77;; Numerous changes to comments and doc strings.
78;;
79;; Revision 1.3 92/06/29 13:10:08 liberte
80;; Moved modal isearch-mode handling into isearch-mode.
81;; Got rid of buffer-local isearch variables.
82;; isearch-edit-string used by ring adjustments, completion, and
83;; nonincremental searching. C-s and C-r are additional exit commands.
84;; Renamed all regex to regexp.
85;; Got rid of found-start and found-point globals.
86;; Generalized handling of upper-case chars.
87
88;; Revision 1.2 92/05/27 11:33:57 liberte
89;; Emacs version 19 has a search ring, which is supported here.
90;; Other fixes found in the version 19 isearch are included here.
91;;
92;; Also see variables search-caps-disable-folding,
93;; search-nonincremental-instead, search-whitespace-regexp, and
94;; commands isearch-toggle-regexp, isearch-edit-string.
95;;
96;; semi-modal isearching is supported.
97
98;; Changes for 1.1
99;; 3/18/92 Fixed invalid-regexp.
100;; 3/18/92 Fixed yanking in regexps.
282d89c0 101
3b1e4dd1 102;;; Code:
08200510
RS
103
104\f
58451992 105;;; Some additional options and constants.
08200510 106
9c1db929
RS
107(defgroup isearch nil
108 "Incremental search minor mode."
117132a6
DL
109 :link '(emacs-commentary-link "isearch")
110 :link '(custom-manual "(emacs)Incremental Search")
9c1db929
RS
111 :prefix "isearch-"
112 :prefix "search-"
113 :group 'matching)
fdf5afa4 114
9c1db929
RS
115
116(defcustom search-exit-option t
117 "*Non-nil means random control characters terminate incremental search."
118 :type 'boolean
119 :group 'isearch)
120
121(defcustom search-slow-window-lines 1
fdf5afa4
RS
122 "*Number of lines in slow search display windows.
123These are the short windows used during incremental search on slow terminals.
124Negative means put the slow search window at the top (normally it's at bottom)
9c1db929
RS
125and the value is minus the number of lines."
126 :type 'integer
127 :group 'isearch)
fdf5afa4 128
9c1db929 129(defcustom search-slow-speed 1200
fdf5afa4
RS
130 "*Highest terminal speed at which to use \"slow\" style incremental search.
131This is the style where a one-line window is created to show the line
9c1db929
RS
132that the search has reached."
133 :type 'integer
134 :group 'isearch)
8e1cae6d 135
9c1db929 136(defcustom search-upper-case 'not-yanks
8e1cae6d 137 "*If non-nil, upper case chars disable case fold searching.
08200510
RS
138That is, upper and lower case chars must match exactly.
139This applies no matter where the chars come from, but does not
fdf5afa4 140apply to chars in regexps that are prefixed with `\\'.
9c1db929
RS
141If this value is `not-yanks', yanked text is always downcased."
142 :type '(choice (const :tag "off" nil)
143 (const not-yanks)
5786b3ed 144 (other :tag "on" t))
9c1db929 145 :group 'isearch)
8e1cae6d 146
9c1db929 147(defcustom search-nonincremental-instead t
8e1cae6d 148 "*If non-nil, do a nonincremental search instead if exiting immediately.
08200510 149Actually, `isearch-edit-string' is called to let you enter the search
9c1db929
RS
150string, and RET terminates editing and does a nonincremental search."
151 :type 'boolean
152 :group 'isearch)
8e1cae6d 153
9c1db929 154(defcustom search-whitespace-regexp "\\s-+"
8e1cae6d 155 "*If non-nil, regular expression to match a sequence of whitespace chars.
e2b992cb 156This applies to regular expression incremental search.
dcb6bf2b
RS
157You might want to use something like \"[ \\t\\r\\n]+\" instead.
158In the Customization buffer, that is `[' followed by a space,
159a tab, a carriage return (control-M), a newline, and `]+'."
9c1db929
RS
160 :type 'regexp
161 :group 'isearch)
8e1cae6d 162
30178dde 163(defcustom search-highlight t
9c1db929
RS
164 "*Non-nil means incremental search highlights the current match."
165 :type 'boolean
166 :group 'isearch)
08200510 167
0352b205
RS
168(defcustom search-invisible 'open
169 "If t incremental search can match hidden text.
170nil means don't match invisible text.
171If the value is `open', if the text matched is made invisible by
172an overlay having an `invisible' property and that overlay has a property
173`isearch-open-invisible', then incremental search will show the contents.
174\(This applies when using `outline.el' and `hideshow.el'.)"
175 :type '(choice (const :tag "Match hidden text" t)
176 (const :tag "Open overlays" open)
79c7a4fa 177 (const :tag "Don't match hidden text" nil))
0352b205
RS
178 :group 'isearch)
179
180(defcustom isearch-hide-immediately t
68c18d6d
RS
181 "If non-nil, re-hide an invisible match right away.
182This variable makes a difference when `search-invisible' is set to `open'.
183It means that after search makes some invisible text visible
184to show the match, it makes the text invisible again when the match moves.
185Ordinarily the text becomes invisible again at the end of the search."
0352b205
RS
186 :type 'boolean
187 :group 'isearch)
86bfaffe 188
08200510
RS
189(defvar isearch-mode-hook nil
190 "Function(s) to call after starting up an incremental search.")
191
192(defvar isearch-mode-end-hook nil
193 "Function(s) to call after terminating an incremental search.")
194
8e1cae6d 195;;; Search ring.
8e1cae6d
JB
196
197(defvar search-ring nil
198 "List of search string sequences.")
08200510 199(defvar regexp-search-ring nil
8e1cae6d
JB
200 "List of regular expression search string sequences.")
201
9c1db929
RS
202(defcustom search-ring-max 16
203 "*Maximum length of search ring before oldest elements are thrown away."
204 :type 'integer
205 :group 'isearch)
206(defcustom regexp-search-ring-max 16
207 "*Maximum length of regexp search ring before oldest elements are thrown away."
208 :type 'integer
209 :group 'isearch)
8e1cae6d
JB
210
211(defvar search-ring-yank-pointer nil
a5dcf63f
RS
212 "Index in `search-ring' of last string reused.
213nil if none yet.")
08200510 214(defvar regexp-search-ring-yank-pointer nil
a5dcf63f
RS
215 "Index in `regexp-search-ring' of last string reused.
216nil if none yet.")
8e1cae6d 217
9c1db929 218(defcustom search-ring-update nil
08200510 219 "*Non-nil if advancing or retreating in the search ring should cause search.
9c1db929
RS
220Default value, nil, means edit the string instead."
221 :type 'boolean
222 :group 'isearch)
08200510 223
8e1cae6d
JB
224;;; Define isearch-mode keymap.
225
02b2f510
SM
226(defvar isearch-mode-map
227 (let* ((i 0)
228 (map (make-keymap)))
229 (or (vectorp (nth 1 map))
230 (char-table-p (nth 1 map))
231 (error "The initialization of isearch-mode-map must be updated"))
232 ;; Make all multibyte characters search for themselves.
233 (let ((l (generic-character-list))
234 (table (nth 1 map)))
235 (while l
236 (set-char-table-default table (car l) 'isearch-printing-char)
237 (setq l (cdr l))))
238 ;; Make function keys, etc, exit the search.
239 (define-key map [t] 'isearch-other-control-char)
240 ;; Control chars, by default, end isearch mode transparently.
241 ;; We need these explicit definitions because, in a dense keymap,
242 ;; the binding for t does not affect characters.
243 ;; We use a dense keymap to save space.
244 (while (< i ?\ )
245 (define-key map (make-string 1 i) 'isearch-other-control-char)
246 (setq i (1+ i)))
247
248 ;; Single-byte printing chars extend the search string by default.
249 (setq i ?\ )
250 (while (< i 256)
251 (define-key map (vector i) 'isearch-printing-char)
252 (setq i (1+ i)))
253
254 ;; To handle local bindings with meta char prefix keys, define
255 ;; another full keymap. This must be done for any other prefix
256 ;; keys as well, one full keymap per char of the prefix key. It
257 ;; would be simpler to disable the global keymap, and/or have a
258 ;; default local key binding for any key not otherwise bound.
259 (let ((meta-map (make-sparse-keymap)))
260 (define-key map (char-to-string meta-prefix-char) meta-map)
261 (define-key map [escape] meta-map))
262 (define-key map (vector meta-prefix-char t) 'isearch-other-meta-char)
263
264 ;; Several non-printing chars change the searching behavior.
265 (define-key map "\C-s" 'isearch-repeat-forward)
266 (define-key map "\C-r" 'isearch-repeat-backward)
267 ;; Define M-C-s and M-C-r like C-s and C-r so that the same key
268 ;; combinations can be used to repeat regexp isearches that can
269 ;; be used to start these searches.
270 (define-key map "\M-\C-s" 'isearch-repeat-forward)
271 (define-key map "\M-\C-r" 'isearch-repeat-backward)
272 (define-key map "\177" 'isearch-delete-char)
273 (define-key map "\C-g" 'isearch-abort)
1f4139d5 274
02b2f510
SM
275 ;; This assumes \e is the meta-prefix-char.
276 (or (= ?\e meta-prefix-char)
277 (error "Inconsistency in isearch.el"))
278 (define-key map "\e\e\e" 'isearch-cancel)
279 (define-key map [escape escape escape] 'isearch-cancel)
8e1cae6d 280
02b2f510 281 (define-key map "\C-q" 'isearch-quote-char)
08200510 282
02b2f510
SM
283 (define-key map "\r" 'isearch-exit)
284 (define-key map "\C-j" 'isearch-printing-char)
285 (define-key map "\t" 'isearch-printing-char)
286 (define-key map " " 'isearch-whitespace-chars)
287 (define-key map [?\S-\ ] 'isearch-whitespace-chars)
8e1cae6d 288
02b2f510
SM
289 (define-key map "\C-w" 'isearch-yank-word)
290 (define-key map "\C-y" 'isearch-yank-line)
08200510 291
02b2f510
SM
292 ;; Define keys for regexp chars * ? |.
293 ;; Nothing special for + because it matches at least once.
294 (define-key map "*" 'isearch-*-char)
295 (define-key map "?" 'isearch-*-char)
296 (define-key map "|" 'isearch-|-char)
08200510 297
58f1634a
RS
298;;; Turned off because I find I expect to get the global definition--rms.
299;;; ;; Instead bind C-h to special help command for isearch-mode.
300;;; (define-key map "\C-h" 'isearch-mode-help)
08200510 301
02b2f510
SM
302 (define-key map "\M-n" 'isearch-ring-advance)
303 (define-key map "\M-p" 'isearch-ring-retreat)
304 (define-key map "\M-y" 'isearch-yank-kill)
305
306 (define-key map "\M-\t" 'isearch-complete)
307
308 ;; Pass frame events transparently so they won't exit the search.
309 ;; In particular, if we have more than one display open, then a
310 ;; switch-frame might be generated by someone typing at another keyboard.
311 (define-key map [switch-frame] nil)
312 (define-key map [delete-frame] nil)
313 (define-key map [iconify-frame] nil)
314 (define-key map [make-frame-visible] nil)
315 ;; For searching multilingual text.
316 (define-key map "\C-\\" 'isearch-toggle-input-method)
317 (define-key map "\C-^" 'isearch-toggle-specified-input-method)
318
319 ;; People expect to be able to paste with the mouse.
320 (define-key map [mouse-2] #'isearch-mouse-yank)
321 (define-key map [down-mouse-2] nil)
322
323 ;; Some bindings you may want to put in your isearch-mode-hook.
324 ;; Suggest some alternates...
325 (define-key map "\M-c" 'isearch-toggle-case-fold)
326 (define-key map "\M-r" 'isearch-toggle-regexp)
327 (define-key map "\M-e" 'isearch-edit-string)
328
329 map)
330 "Keymap for `isearch-mode'.")
331
332(defvar minibuffer-local-isearch-map
333 (let ((map (make-sparse-keymap)))
334 (set-keymap-parent map minibuffer-local-map)
335 (define-key map "\r" 'isearch-nonincremental-exit-minibuffer)
336 (define-key map "\M-n" 'isearch-ring-advance-edit)
337 (define-key map "\M-p" 'isearch-ring-retreat-edit)
338 (define-key map "\M-\t" 'isearch-complete-edit)
339 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
340 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
341 map)
08200510 342 "Keymap for editing isearch strings in the minibuffer.")
8e1cae6d 343
8e1cae6d 344;; Internal variables declared globally for byte-compiler.
08200510
RS
345;; These are all set with setq while isearching
346;; and bound locally while editing the search string.
347
348(defvar isearch-forward nil) ; Searching in the forward direction.
349(defvar isearch-regexp nil) ; Searching for a regexp.
350(defvar isearch-word nil) ; Searching for words.
351
352(defvar isearch-cmds nil) ; Stack of search status sets.
353(defvar isearch-string "") ; The current search string.
354(defvar isearch-message "") ; text-char-description version of isearch-string
355
356(defvar isearch-success t) ; Searching is currently successful.
357(defvar isearch-invalid-regexp nil) ; Regexp not well formed.
c5f6b356 358(defvar isearch-within-brackets nil) ; Regexp has unclosed [.
08200510
RS
359(defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
360(defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
8e1cae6d 361(defvar isearch-barrier 0)
99ae9e9f 362(defvar isearch-just-started nil)
8e1cae6d 363
4453091d
RS
364; case-fold-search while searching.
365; either nil, t, or 'yes. 'yes means the same as t except that mixed
366; case in the search string is ignored.
367(defvar isearch-case-fold-search nil)
8e1cae6d 368
ae1a21c6
MB
369;; Used to save default value while isearch is active
370(defvar isearch-original-minibuffer-message-timeout nil)
371
8e1cae6d
JB
372(defvar isearch-adjusted nil)
373(defvar isearch-slow-terminal-mode nil)
08200510
RS
374;;; If t, using a small window.
375(defvar isearch-small-window nil)
8e1cae6d 376(defvar isearch-opoint 0)
08200510
RS
377;;; The window configuration active at the beginning of the search.
378(defvar isearch-window-configuration nil)
8e1cae6d 379
08200510
RS
380;; Flag to indicate a yank occurred, so don't move the cursor.
381(defvar isearch-yank-flag nil)
8e1cae6d 382
08200510
RS
383;;; A function to be called after each input character is processed.
384;;; (It is not called after characters that exit the search.)
385;;; It is only set from an optional argument to `isearch-mode'.
386(defvar isearch-op-fun nil)
8e1cae6d 387
08200510
RS
388;;; Is isearch-mode in a recursive edit for modal searching.
389(defvar isearch-recursive-edit nil)
8e1cae6d 390
08200510
RS
391;;; Should isearch be terminated after doing one search?
392(defvar isearch-nonincremental nil)
393
394;; New value of isearch-forward after isearch-edit-string.
395(defvar isearch-new-forward nil)
8e1cae6d 396
0352b205
RS
397;; Accumulate here the overlays opened during searching.
398(defvar isearch-opened-overlays nil)
8e1cae6d 399
99848db0
KH
400;; The value of input-method-function when isearch is invoked.
401(defvar isearch-input-method-function nil)
402
403;; A flag to tell if input-method-function is locally bound when
404;; isearch is invoked.
405(defvar isearch-input-method-local-p nil)
406
8e1cae6d
JB
407;; Minor-mode-alist changes - kind of redundant with the
408;; echo area, but if isearching in multiple windows, it can be useful.
409
410(or (assq 'isearch-mode minor-mode-alist)
411 (nconc minor-mode-alist
412 (list '(isearch-mode isearch-mode))))
413
08200510 414(defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
8e1cae6d
JB
415(make-variable-buffer-local 'isearch-mode)
416
fdf5afa4
RS
417(define-key global-map "\C-s" 'isearch-forward)
418(define-key esc-map "\C-s" 'isearch-forward-regexp)
419(define-key global-map "\C-r" 'isearch-backward)
420(define-key esc-map "\C-r" 'isearch-backward-regexp)
421
8e1cae6d 422;;; Entry points to isearch-mode.
8e1cae6d 423
eceee2c0 424(defun isearch-forward (&optional regexp-p no-recursive-edit)
8e1cae6d
JB
425 "\
426Do incremental search forward.
08200510
RS
427With a prefix argument, do an incremental regular expression search instead.
428\\<isearch-mode-map>
8e1cae6d 429As you type characters, they add to the search string and are found.
08200510 430The following non-printing keys are bound in `isearch-mode-map'.
8e1cae6d 431
08200510 432Type \\[isearch-delete-char] to cancel characters from end of search string.
8e1cae6d 433Type \\[isearch-exit] to exit, leaving point at location found.
08200510
RS
434Type LFD (C-j) to match end of line.
435Type \\[isearch-repeat-forward] to search again forward,\
436 \\[isearch-repeat-backward] to search again backward.
437Type \\[isearch-yank-word] to yank word from buffer onto end of search\
438 string and search for it.
439Type \\[isearch-yank-line] to yank rest of line onto end of search string\
440 and search for it.
8617e346
KH
441Type \\[isearch-yank-kill] to yank last killed text onto end of search string\
442 and search for it.
8e1cae6d 443Type \\[isearch-quote-char] to quote control character to search for it.
08200510
RS
444\\[isearch-abort] while searching or when search has failed cancels input\
445 back to what has
446 been found successfully.
447\\[isearch-abort] when search is successful aborts and moves point to\
448 starting point.
8e1cae6d 449
6c551d4e
EZ
450Type \\[isearch-toggle-case-fold] to toggle search case-sensitivity.
451Type \\[isearch-toggle-regexp] to toggle regular-expression mode.
452Type \\[isearch-edit-string] to edit the search string in the minibuffer.
453
8e1cae6d
JB
454Also supported is a search ring of the previous 16 search strings.
455Type \\[isearch-ring-advance] to search for the next item in the search ring.
08200510
RS
456Type \\[isearch-ring-retreat] to search for the previous item in the search\
457 ring.
458Type \\[isearch-complete] to complete the search string using the search ring.
8e1cae6d 459
1e14b095 460If an input method is turned on in the current buffer, that input
37b20c9b
KH
461method is also active while you are typing a characters to search. To
462toggle the input method, type \\[isearch-toggle-input-method]. It
463also toggles the input method in the current buffer.
464
465To use a different input method for searching, type
1e14b095 466\\[isearch-toggle-specified-input-method], and specify an input method
37b20c9b
KH
467you want to use.
468
08200510
RS
469The above keys, bound in `isearch-mode-map', are often controlled by
470 options; do M-x apropos on search-.* to find them.
8e1cae6d 471Other control and meta characters terminate the search
08200510 472 and are then executed normally (depending on `search-exit-option').
fd49e05c 473Likewise for function keys and mouse button events.
8e1cae6d 474
08200510
RS
475If this function is called non-interactively, it does not return to
476the calling function until the search is done."
8e1cae6d 477
eceee2c0 478 (interactive "P\np")
4ae7d00a 479 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
8e1cae6d 480
eceee2c0 481(defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
8e1cae6d
JB
482 "\
483Do incremental search forward for regular expression.
08200510 484With a prefix argument, do a regular string search instead.
8e1cae6d
JB
485Like ordinary incremental search except that your input
486is treated as a regexp. See \\[isearch-forward] for more info."
eceee2c0 487 (interactive "P\np")
4ae7d00a 488 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
8e1cae6d 489
eceee2c0 490(defun isearch-backward (&optional regexp-p no-recursive-edit)
8e1cae6d
JB
491 "\
492Do incremental search backward.
08200510 493With a prefix argument, do a regular expression search instead.
8e1cae6d 494See \\[isearch-forward] for more information."
eceee2c0 495 (interactive "P\np")
4ae7d00a 496 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
8e1cae6d 497
eceee2c0 498(defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
8e1cae6d
JB
499 "\
500Do incremental search backward for regular expression.
08200510 501With a prefix argument, do a regular string search instead.
8e1cae6d
JB
502Like ordinary incremental search except that your input
503is treated as a regexp. See \\[isearch-forward] for more info."
eceee2c0 504 (interactive "P\np")
4ae7d00a 505 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
08200510
RS
506
507
508(defun isearch-mode-help ()
509 (interactive)
510 (describe-function 'isearch-forward)
511 (isearch-update))
8e1cae6d
JB
512
513\f
8e1cae6d
JB
514;; isearch-mode only sets up incremental search for the minor mode.
515;; All the work is done by the isearch-mode commands.
516
08200510 517;; Not used yet:
d7fa5aa2 518;;(defvar isearch-commands '(isearch-forward isearch-backward
08200510
RS
519;; isearch-forward-regexp isearch-backward-regexp)
520;; "List of commands for which isearch-mode does not recursive-edit.")
521
522
523(defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p)
79ce455d
RS
524 "Start isearch minor mode. Called by `isearch-forward', etc.
525
526\\{isearch-mode-map}"
8e1cae6d
JB
527
528 ;; Initialize global vars.
529 (setq isearch-forward forward
530 isearch-regexp regexp
08200510 531 isearch-word word-p
8e1cae6d
JB
532 isearch-op-fun op-fun
533 isearch-case-fold-search case-fold-search
534 isearch-string ""
535 isearch-message ""
536 isearch-cmds nil
537 isearch-success t
538 isearch-wrapped nil
539 isearch-barrier (point)
540 isearch-adjusted nil
541 isearch-yank-flag nil
542 isearch-invalid-regexp nil
c5f6b356 543 isearch-within-brackets nil
0cabad13 544 isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
8e1cae6d
JB
545 (> (window-height)
546 (* 4 search-slow-window-lines)))
547 isearch-other-end nil
548 isearch-small-window nil
99ae9e9f 549 isearch-just-started t
8e1cae6d 550
8e1cae6d 551 isearch-opoint (point)
a5dcf63f 552 search-ring-yank-pointer nil
0352b205 553 isearch-opened-overlays nil
99848db0
KH
554 isearch-input-method-function input-method-function
555 isearch-input-method-local-p (local-variable-p 'input-method-function)
ae1a21c6
MB
556 regexp-search-ring-yank-pointer nil
557
558 ;; Save the original value of `minibuffer-message-timeout', and
559 ;; set it to nil so that isearch's messages don't get timed out.
560 isearch-original-minibuffer-message-timeout minibuffer-message-timeout
561 minibuffer-message-timeout nil)
99848db0
KH
562
563 ;; We must bypass input method while reading key. When a user type
564 ;; printable character, appropriate input method is turned on in
380866a2 565 ;; minibuffer to read multibyte characters.
99848db0
KH
566 (or isearch-input-method-local-p
567 (make-local-variable 'input-method-function))
568 (setq input-method-function nil)
569
99ae9e9f 570 (looking-at "")
292a8dff
RS
571 (setq isearch-window-configuration
572 (if isearch-slow-terminal-mode (current-window-configuration) nil))
70418205 573
18ce7555
RS
574 ;; Maybe make minibuffer frame visible and/or raise it.
575 (let ((frame (window-frame (minibuffer-window))))
576 (if (not (memq (frame-live-p frame) '(nil t)))
577 (progn
578 (make-frame-visible frame)
579 (if minibuffer-auto-raise
580 (raise-frame frame)))))
581
8e1cae6d 582 (setq isearch-mode " Isearch") ;; forward? regexp?
1cd3732c 583 (force-mode-line-update)
8e1cae6d
JB
584
585 (isearch-push-state)
586
c7955222 587 (setq overriding-terminal-local-map isearch-mode-map)
8e1cae6d
JB
588 (isearch-update)
589 (run-hooks 'isearch-mode-hook)
08200510 590
bfe2d334 591 (add-hook 'mouse-leave-buffer-hook 'isearch-done)
7e56ea04 592 (add-hook 'kbd-macro-termination-hook 'isearch-done)
6e5cd0ae 593
08200510
RS
594 ;; isearch-mode can be made modal (in the sense of not returning to
595 ;; the calling function until searching is completed) by entering
596 ;; a recursive-edit and exiting it when done isearching.
130bf67c
RS
597 (if recursive-edit
598 (let ((isearch-recursive-edit t))
599 (recursive-edit)))
0daa17f3 600 isearch-success)
8e1cae6d
JB
601
602
8e1cae6d
JB
603;; Some high level utilities. Others below.
604
605(defun isearch-update ()
606 ;; Called after each command to update the display.
58451992 607 (if (null unread-command-events)
8e1cae6d 608 (progn
c982ab21
GM
609 (if (not (input-pending-p))
610 (isearch-message))
611 (if (and isearch-slow-terminal-mode
612 (not (or isearch-small-window
613 (pos-visible-in-window-p))))
614 (let ((found-point (point)))
615 (setq isearch-small-window t)
616 (move-to-window-line 0)
617 (let ((window-min-height 1))
618 (split-window nil (if (< search-slow-window-lines 0)
619 (1+ (- search-slow-window-lines))
620 (- (window-height)
621 (1+ search-slow-window-lines)))))
622 (if (< search-slow-window-lines 0)
623 (progn (vertical-motion (- 1 search-slow-window-lines))
624 (set-window-start (next-window) (point))
625 (set-window-hscroll (next-window)
626 (window-hscroll))
627 (set-window-hscroll (selected-window) 0))
628 (other-window 1))
629 (goto-char found-point)))
630 (if isearch-other-end
631 (if (< isearch-other-end (point)) ; isearch-forward?
632 (isearch-highlight isearch-other-end (point))
633 (isearch-highlight (point) isearch-other-end))
634 (isearch-dehighlight nil))
635 ))
8e1cae6d
JB
636 (setq ;; quit-flag nil not for isearch-mode
637 isearch-adjusted nil
638 isearch-yank-flag nil)
a5cc922e
KH
639 (isearch-lazy-highlight-new-loop)
640 ;; We must prevent the point moving to the end of composition when a
641 ;; part of the composition has just been searched.
642 (setq disable-point-adjustment t))
8e1cae6d 643
0daa17f3 644(defun isearch-done (&optional nopush edit)
c40a4de1
GM
645 (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
646 ,isearch-word ,isearch-forward
647 ,isearch-message
648 ,isearch-case-fold-search)))
649 (unless (equal (car command-history) command)
650 (setq command-history (cons command command-history))))
651
bfe2d334 652 (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
7e56ea04 653 (remove-hook 'kbd-macro-termination-hook 'isearch-done)
d196f58d
GM
654 (setq isearch-lazy-highlight-start nil)
655
8e1cae6d 656 ;; Called by all commands that terminate isearch-mode.
35a4d143 657 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
c7955222 658 (setq overriding-terminal-local-map nil)
08200510 659 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
ae1a21c6 660 (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout)
08200510 661 (isearch-dehighlight t)
67ecad4e 662 (isearch-lazy-highlight-cleanup isearch-lazy-highlight-cleanup)
08200510
RS
663 (let ((found-start (window-start (selected-window)))
664 (found-point (point)))
70418205
RS
665 (if isearch-window-configuration
666 (set-window-configuration isearch-window-configuration))
08200510 667
d49b6338
RS
668 (if isearch-small-window
669 (goto-char found-point)
670 ;; Exiting the save-window-excursion clobbers window-start; restore it.
9821535a 671 (set-window-start (selected-window) found-start t))
d49b6338 672
08200510
RS
673 ;; If there was movement, mark the starting position.
674 ;; Maybe should test difference between and set mark iff > threshold.
675 (if (/= (point) isearch-opoint)
9821535a
RS
676 (or (and transient-mark-mode mark-active)
677 (progn
678 (push-mark isearch-opoint t)
f3acf6f5 679 (or executing-kbd-macro (> (minibuffer-depth) 0)
9821535a 680 (message "Mark saved where search started"))))))
08200510
RS
681
682 (setq isearch-mode nil)
99848db0
KH
683 (if isearch-input-method-local-p
684 (setq input-method-function isearch-input-method-function)
685 (kill-local-variable 'input-method-function))
686
1cd3732c 687 (force-mode-line-update)
8e1cae6d 688
df01192b
RS
689 ;; If we ended in the middle of some intangible text,
690 ;; move to the further end of that intangible text.
691 (let ((after (if (eobp) nil
692 (get-text-property (point) 'intangible)))
693 (before (if (bobp) nil
694 (get-text-property (1- (point)) 'intangible))))
695 (when (and before after (eq before after))
696 (if isearch-forward
697 (goto-char (next-single-property-change (point) 'intangible))
698 (goto-char (previous-single-property-change (point) 'intangible)))))
699
35a4d143 700 (if (and (> (length isearch-string) 0) (not nopush))
8e1cae6d 701 ;; Update the ring data.
73d2bf95 702 (isearch-update-ring isearch-string isearch-regexp))
8e1cae6d 703
8e1cae6d 704 (run-hooks 'isearch-mode-end-hook)
0daa17f3 705 (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
08200510 706
73d2bf95
RS
707(defun isearch-update-ring (string &optional regexp)
708 "Add STRING to the beginning of the search ring.
709REGEXP says which ring to use."
710 (if regexp
711 (if (or (null regexp-search-ring)
fd89878d 712 (not (string= string (car regexp-search-ring))))
73d2bf95
RS
713 (progn
714 (setq regexp-search-ring
fd89878d 715 (cons string regexp-search-ring))
73d2bf95
RS
716 (if (> (length regexp-search-ring) regexp-search-ring-max)
717 (setcdr (nthcdr (1- search-ring-max) regexp-search-ring)
718 nil))))
719 (if (or (null search-ring)
fd89878d 720 (not (string= string (car search-ring))))
73d2bf95 721 (progn
fd89878d 722 (setq search-ring (cons string search-ring))
73d2bf95
RS
723 (if (> (length search-ring) search-ring-max)
724 (setcdr (nthcdr (1- search-ring-max) search-ring) nil))))))
725
08200510 726;;; Switching buffers should first terminate isearch-mode.
117132a6
DL
727;;; ;; For Emacs 19, the frame switch event is handled.
728;;; (defun isearch-switch-frame-handler ()
729;;; (interactive) ;; Is this necessary?
730;;; ;; First terminate isearch-mode.
731;;; (isearch-done)
732;;; (isearch-clean-overlays)
733;;; (handle-switch-frame (car (cdr last-command-char))))
08200510 734
8e1cae6d 735\f
8e1cae6d
JB
736;; Commands active while inside of the isearch minor mode.
737
738(defun isearch-exit ()
739 "Exit search normally.
740However, if this is the first command after starting incremental
741search and `search-nonincremental-instead' is non-nil, do a
08200510 742nonincremental search instead via `isearch-edit-string'."
8e1cae6d
JB
743 (interactive)
744 (if (and search-nonincremental-instead
745 (= 0 (length isearch-string)))
08200510
RS
746 (let ((isearch-nonincremental t))
747 (isearch-edit-string)))
0352b205
RS
748 (isearch-done)
749 (isearch-clean-overlays))
8e1cae6d
JB
750
751
752(defun isearch-edit-string ()
08200510
RS
753 "Edit the search string in the minibuffer.
754The following additional command keys are active while editing.
755\\<minibuffer-local-isearch-map>
756\\[exit-minibuffer] to resume incremental searching with the edited string.
757\\[isearch-nonincremental-exit-minibuffer] to do one nonincremental search.
758\\[isearch-forward-exit-minibuffer] to resume isearching forward.
8eb40e74 759\\[isearch-reverse-exit-minibuffer] to resume isearching backward.
08200510 760\\[isearch-ring-advance-edit] to replace the search string with the next item in the search ring.
eb8c3be9 761\\[isearch-ring-retreat-edit] to replace the search string with the previous item in the search ring.
08200510 762\\[isearch-complete-edit] to complete the search string using the search ring.
8eb40e74 763\\<isearch-mode-map>
08200510
RS
764If first char entered is \\[isearch-yank-word], then do word search instead."
765
766 ;; This code is very hairy for several reasons, explained in the code.
767 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
768 ;; If there were a way to catch any change of buffer from the minibuffer,
769 ;; this could be simplified greatly.
eb8c3be9 770 ;; Editing doesn't back up the search point. Should it?
8e1cae6d 771 (interactive)
08200510 772 (condition-case err
e900ced4
RS
773 (progn
774 (let ((isearch-nonincremental isearch-nonincremental)
775
776 ;; Locally bind all isearch global variables to protect them
777 ;; from recursive isearching.
778 ;; isearch-string -message and -forward are not bound
779 ;; so they may be changed. Instead, save the values.
780 (isearch-new-string isearch-string)
781 (isearch-new-message isearch-message)
782 (isearch-new-forward isearch-forward)
783 (isearch-new-word isearch-word)
784
785 (isearch-regexp isearch-regexp)
786 (isearch-op-fun isearch-op-fun)
787 (isearch-cmds isearch-cmds)
788 (isearch-success isearch-success)
789 (isearch-wrapped isearch-wrapped)
790 (isearch-barrier isearch-barrier)
791 (isearch-adjusted isearch-adjusted)
792 (isearch-yank-flag isearch-yank-flag)
793 (isearch-invalid-regexp isearch-invalid-regexp)
794 (isearch-within-brackets isearch-within-brackets)
795 ;;; Don't bind this. We want isearch-search, below, to set it.
796 ;;; And the old value won't matter after that.
797 ;;; (isearch-other-end isearch-other-end)
798 ;;; Perhaps some of these other variables should be bound for a
799 ;;; shorter period, ending before the next isearch-search.
800 ;;; But there doesn't seem to be a real bug, so let's not risk it now.
801 (isearch-opoint isearch-opoint)
802 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
803 (isearch-small-window isearch-small-window)
804 (isearch-recursive-edit isearch-recursive-edit)
805 ;; Save current configuration so we can restore it here.
806 (isearch-window-configuration (current-window-configuration))
ae1a21c6
MB
807
808 ;; Temporarily restore `minibuffer-message-timeout'.
809 (minibuffer-message-timeout
810 isearch-original-minibuffer-message-timeout)
811 (isearch-original-minibuffer-message-timeout
812 isearch-original-minibuffer-message-timeout)
e900ced4
RS
813 )
814
815 ;; Actually terminate isearching until editing is done.
816 ;; This is so that the user can do anything without failure,
817 ;; like switch buffers and start another isearch, and return.
818 (condition-case err
819 (isearch-done t t)
820 (exit nil)) ; was recursive editing
821
822 (isearch-message) ;; for read-char
823 (unwind-protect
824 (let* (;; Why does following read-char echo?
825 ;;(echo-keystrokes 0) ;; not needed with above message
826 (e (let ((cursor-in-echo-area t))
827 (read-event)))
828 ;; Binding minibuffer-history-symbol to nil is a work-around
829 ;; for some incompatibility with gmhist.
830 (minibuffer-history-symbol)
831 (message-log-max nil))
832 ;; If the first character the user types when we prompt them
833 ;; for a string is the yank-word character, then go into
834 ;; word-search mode. Otherwise unread that character and
835 ;; read a key the normal way.
836 ;; Word search does not apply (yet) to regexp searches,
837 ;; no check is made here.
838 (message (isearch-message-prefix nil nil t))
839 (if (eq 'isearch-yank-word
840 (lookup-key isearch-mode-map (vector e)))
841 (setq isearch-word t;; so message-prefix is right
842 isearch-new-word t)
843 (cancel-kbd-macro-events)
844 (isearch-unread e))
845 (setq cursor-in-echo-area nil)
846 (setq isearch-new-string
847 (let (junk-ring)
848 (read-from-minibuffer
849 (isearch-message-prefix nil nil isearch-nonincremental)
850 isearch-string
851 minibuffer-local-isearch-map nil
852 'junk-ring))
853 isearch-new-message
854 (mapconcat 'isearch-text-char-description
855 isearch-new-string "")))
856 ;; Always resume isearching by restarting it.
857 (isearch-mode isearch-forward
858 isearch-regexp
859 isearch-op-fun
860 nil
861 isearch-word)
862
863 ;; Copy new local values to isearch globals
864 (setq isearch-string isearch-new-string
865 isearch-message isearch-new-message
866 isearch-forward isearch-new-forward
867 isearch-word isearch-new-word))
868
869 ;; Empty isearch-string means use default.
870 (if (= 0 (length isearch-string))
871 (setq isearch-string (or (car (if isearch-regexp
872 regexp-search-ring
873 search-ring))
874 ""))
875 ;; This used to set the last search string,
876 ;; but I think it is not right to do that here.
877 ;; Only the string actually used should be saved.
878 ))
879
880 ;; Push the state as of before this C-s.
881 (isearch-push-state)
08200510
RS
882
883 ;; Reinvoke the pending search.
08200510
RS
884 (isearch-search)
885 (isearch-update)
886 (if isearch-nonincremental
887 (progn
888 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
889 (isearch-done))))
8e1cae6d 890
08200510
RS
891 (quit ; handle abort-recursive-edit
892 (isearch-abort) ;; outside of let to restore outside global values
893 )))
894
895(defun isearch-nonincremental-exit-minibuffer ()
896 (interactive)
897 (setq isearch-nonincremental t)
898 (exit-minibuffer))
899
900(defun isearch-forward-exit-minibuffer ()
901 (interactive)
902 (setq isearch-new-forward t)
903 (exit-minibuffer))
8e1cae6d 904
08200510 905(defun isearch-reverse-exit-minibuffer ()
8e1cae6d 906 (interactive)
08200510
RS
907 (setq isearch-new-forward nil)
908 (exit-minibuffer))
909
19993c54
RS
910(defun isearch-cancel ()
911 "Terminate the search and go back to the starting point."
912 (interactive)
913 (goto-char isearch-opoint)
914 (isearch-done t)
0352b205 915 (isearch-clean-overlays)
19993c54 916 (signal 'quit nil)) ; and pass on quit signal
08200510
RS
917
918(defun isearch-abort ()
b7852303 919 "Abort incremental search mode if searching is successful, signaling quit.
08200510 920Otherwise, revert to previous successful search and continue searching.
b7852303 921Use `isearch-exit' to quit without signaling."
08200510 922 (interactive)
eb8c3be9 923;; (ding) signal instead below, if quitting
8e1cae6d
JB
924 (discard-input)
925 (if isearch-success
926 ;; If search is successful, move back to starting point
927 ;; and really do quit.
928 (progn (goto-char isearch-opoint)
509ed182 929 (setq isearch-success nil)
35a4d143 930 (isearch-done t) ; exit isearch
0352b205 931 (isearch-clean-overlays)
a5dcf63f 932 (signal 'quit nil)) ; and pass on quit signal
925a67ca
RS
933 ;; If search is failing, or has an incomplete regexp,
934 ;; rub out until it is once more successful.
935 (while (or (not isearch-success) isearch-invalid-regexp)
936 (isearch-pop-state))
8e1cae6d
JB
937 (isearch-update)))
938
8e1cae6d
JB
939(defun isearch-repeat (direction)
940 ;; Utility for isearch-repeat-forward and -backward.
941 (if (eq isearch-forward (eq direction 'forward))
942 ;; C-s in forward or C-r in reverse.
943 (if (equal isearch-string "")
944 ;; If search string is empty, use last one.
945 (setq isearch-string
8e1cae6d 946 (or (if isearch-regexp
a5dcf63f
RS
947 (car regexp-search-ring)
948 (car search-ring))
8e1cae6d
JB
949 "")
950 isearch-message
08200510 951 (mapconcat 'isearch-text-char-description
8e1cae6d
JB
952 isearch-string ""))
953 ;; If already have what to search for, repeat it.
954 (or isearch-success
02b2f510 955 (progn
8e1cae6d
JB
956 (goto-char (if isearch-forward (point-min) (point-max)))
957 (setq isearch-wrapped t))))
958 ;; C-s in reverse or C-r in forward, change direction.
959 (setq isearch-forward (not isearch-forward)))
960
961 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
6fefdc4b
RS
962
963 (if (equal isearch-string "")
964 (setq isearch-success t)
99ae9e9f
KH
965 (if (and isearch-success (equal (match-end 0) (match-beginning 0))
966 (not isearch-just-started))
8e1cae6d
JB
967 ;; If repeating a search that found
968 ;; an empty string, ensure we advance.
6fefdc4b
RS
969 (if (if isearch-forward (eobp) (bobp))
970 ;; If there's nowhere to advance to, fail (and wrap next time).
971 (progn
972 (setq isearch-success nil)
973 (ding))
974 (forward-char (if isearch-forward 1 -1))
975 (isearch-search))
976 (isearch-search)))
977
8e1cae6d
JB
978 (isearch-push-state)
979 (isearch-update))
980
981(defun isearch-repeat-forward ()
982 "Repeat incremental search forwards."
983 (interactive)
984 (isearch-repeat 'forward))
985
986(defun isearch-repeat-backward ()
987 "Repeat incremental search backwards."
988 (interactive)
989 (isearch-repeat 'backward))
990
991(defun isearch-toggle-regexp ()
992 "Toggle regexp searching on or off."
993 ;; The status stack is left unchanged.
994 (interactive)
995 (setq isearch-regexp (not isearch-regexp))
08200510 996 (if isearch-regexp (setq isearch-word nil))
8e1cae6d
JB
997 (isearch-update))
998
4453091d
RS
999(defun isearch-toggle-case-fold ()
1000 "Toggle case folding in searching on or off."
1001 (interactive)
1002 (setq isearch-case-fold-search
1003 (if isearch-case-fold-search nil 'yes))
a56687f1
KH
1004 (let ((message-log-max nil))
1005 (message "%s%s [case %ssensitive]"
1006 (isearch-message-prefix nil nil isearch-nonincremental)
1007 isearch-message
1008 (if isearch-case-fold-search "in" "")))
4453091d
RS
1009 (setq isearch-adjusted t)
1010 (sit-for 1)
1011 (isearch-update))
1012
8e1cae6d
JB
1013(defun isearch-delete-char ()
1014 "Discard last input item and move point back.
1015If no previous match was done, just beep."
1016 (interactive)
1017 (if (null (cdr isearch-cmds))
1018 (ding)
1019 (isearch-pop-state))
1020 (isearch-update))
1021
1022
9cf081fa
KH
1023(defun isearch-yank-string (string)
1024 "Pull STRING into search string."
1025 ;; Downcase the string if not supposed to case-fold yanked strings.
1026 (if (and isearch-case-fold-search
1027 (eq 'not-yanks search-upper-case))
1028 (setq string (downcase string)))
1029 (if isearch-regexp (setq string (regexp-quote string)))
1030 (setq isearch-string (concat isearch-string string)
1031 isearch-message
1032 (concat isearch-message
1033 (mapconcat 'isearch-text-char-description
1034 string ""))
1035 ;; Don't move cursor in reverse search.
1036 isearch-yank-flag t)
8e1cae6d
JB
1037 (isearch-search-and-update))
1038
30d47262
RS
1039(defun isearch-yank-kill ()
1040 "Pull string from kill ring into search string."
1041 (interactive)
9cf081fa
KH
1042 (isearch-yank-string (current-kill 0)))
1043
1044(defun isearch-yank-x-selection ()
117132a6 1045 "Pull current X selection into search string."
9cf081fa
KH
1046 (interactive)
1047 (isearch-yank-string (x-get-selection)))
8e1cae6d 1048
117132a6
DL
1049(defun isearch-mouse-yank (click arg)
1050 "Yank with the mouse in Isearch mode.
1051For a click in the echo area, invoke `isearch-yank-x-selection'.
1052Otherwise invoke `mouse-yank-at-click'."
1053 (interactive "e\nP")
1054 (let ((w (posn-window (event-start click))))
1055 (if (and (window-minibuffer-p w)
1056 (not (minibuffer-window-active-p w))) ; in echo area
1057 (isearch-yank-x-selection)
1058 (mouse-yank-at-click click arg))))
1059
8e1cae6d
JB
1060(defun isearch-yank-word ()
1061 "Pull next word from buffer into search string."
1062 (interactive)
9cf081fa
KH
1063 (isearch-yank-string
1064 (save-excursion
1065 (and (not isearch-forward) isearch-other-end
1066 (goto-char isearch-other-end))
c40a4de1
GM
1067 (buffer-substring-no-properties
1068 (point) (progn (forward-word 1) (point))))))
8e1cae6d
JB
1069
1070(defun isearch-yank-line ()
1071 "Pull rest of line from buffer into search string."
1072 (interactive)
9cf081fa
KH
1073 (isearch-yank-string
1074 (save-excursion
1075 (and (not isearch-forward) isearch-other-end
1076 (goto-char isearch-other-end))
c40a4de1 1077 (buffer-substring-no-properties (point) (line-end-position)))))
8e1cae6d
JB
1078
1079
1080(defun isearch-search-and-update ()
1081 ;; Do the search and update the display.
1082 (if (and (not isearch-success)
1083 ;; unsuccessful regexp search may become
1084 ;; successful by addition of characters which
1085 ;; make isearch-string valid
1086 (not isearch-regexp))
1087 nil
1088 ;; In reverse search, adding stuff at
1089 ;; the end may cause zero or many more chars to be
1090 ;; matched, in the string following point.
1091 ;; Allow all those possibilities without moving point as
1092 ;; long as the match does not extend past search origin.
1093 (if (and (not isearch-forward) (not isearch-adjusted)
1094 (condition-case ()
99ae9e9f 1095 (let ((case-fold-search isearch-case-fold-search))
ec0a2f45
KH
1096 (if (and (eq case-fold-search t) search-upper-case)
1097 (setq case-fold-search
1098 (isearch-no-upper-case-p isearch-string isearch-regexp)))
99ae9e9f
KH
1099 (looking-at (if isearch-regexp isearch-string
1100 (regexp-quote isearch-string))))
8e1cae6d 1101 (error nil))
bd6a8414
RS
1102 (or isearch-yank-flag
1103 (<= (match-end 0)
1104 (min isearch-opoint isearch-barrier))))
d64b1d96
RS
1105 (progn
1106 (setq isearch-success t
1107 isearch-invalid-regexp nil
1108 isearch-within-brackets nil
1109 isearch-other-end (match-end 0))
1110 (if (and (eq isearch-case-fold-search t) search-upper-case)
1111 (setq isearch-case-fold-search
1112 (isearch-no-upper-case-p isearch-string isearch-regexp))))
8e1cae6d
JB
1113 ;; Not regexp, not reverse, or no match at point.
1114 (if (and isearch-other-end (not isearch-adjusted))
1115 (goto-char (if isearch-forward isearch-other-end
1116 (min isearch-opoint
1117 isearch-barrier
1118 (1+ isearch-other-end)))))
1119 (isearch-search)
1120 ))
1121 (isearch-push-state)
1122 (if isearch-op-fun (funcall isearch-op-fun))
1123 (isearch-update))
1124
1125
1126;; *, ?, and | chars can make a regexp more liberal.
08200510 1127;; They can make a regexp match sooner or make it succeed instead of failing.
8e1cae6d
JB
1128;; So go back to place last successful search started
1129;; or to the last ^S/^R (barrier), whichever is nearer.
08200510 1130;; + needs no special handling because the string must match at least once.
8e1cae6d
JB
1131
1132(defun isearch-*-char ()
1133 "Handle * and ? specially in regexps."
1134 (interactive)
1135 (if isearch-regexp
bd6a8414
RS
1136 (let ((idx (length isearch-string)))
1137 (while (and (> idx 0)
1138 (eq (aref isearch-string (1- idx)) ?\\))
1139 (setq idx (1- idx)))
1140 (when (= (mod (- (length isearch-string) idx) 2) 0)
1141 (setq isearch-adjusted t)
1142 ;; Get the isearch-other-end from before the last search.
1143 ;; We want to start from there,
1144 ;; so that we don't retreat farther than that.
1145 ;; (car isearch-cmds) is after last search;
1146 ;; (car (cdr isearch-cmds)) is from before it.
1147 (let ((cs (nth 5 (car (cdr isearch-cmds)))))
1148 (setq cs (or cs isearch-barrier))
1149 (goto-char
1150 (if isearch-forward
1151 (max cs isearch-barrier)
1152 (min cs isearch-barrier)))))))
117132a6 1153 (isearch-process-search-char last-command-char))
8e1cae6d
JB
1154
1155
8e1cae6d
JB
1156(defun isearch-|-char ()
1157 "If in regexp search, jump to the barrier."
1158 (interactive)
1159 (if isearch-regexp
1160 (progn
1161 (setq isearch-adjusted t)
1162 (goto-char isearch-barrier)))
117132a6 1163 (isearch-process-search-char last-command-char))
8e1cae6d
JB
1164
1165
b457cc3b 1166(defalias 'isearch-other-control-char 'isearch-other-meta-char)
8e1cae6d
JB
1167
1168(defun isearch-other-meta-char ()
8f90f594 1169 "Exit the search normally and reread this key sequence.
35a4d143
RS
1170But only if `search-exit-option' is non-nil, the default.
1171If it is the symbol `edit', the search string is edited in the minibuffer
1172and the meta character is unread so that it applies to editing the string."
8e1cae6d 1173 (interactive)
c6431f12
KH
1174 (let* ((key (this-command-keys))
1175 (main-event (aref key 0))
1176 (keylist (listify-key-sequence key)))
24b5caec 1177 (cond ((and (= (length key) 1)
d94eb6eb 1178 (let ((lookup (lookup-key function-key-map key)))
3f866b53
KH
1179 (not (or (null lookup) (integerp lookup)
1180 (keymapp lookup)))))
24b5caec
RS
1181 ;; Handle a function key that translates into something else.
1182 ;; If the key has a global definition too,
1183 ;; exit and unread the key itself, so its global definition runs.
1184 ;; Otherwise, unread the translation,
1185 ;; so that the translated key takes effect within isearch.
d94eb6eb 1186 (cancel-kbd-macro-events)
24b5caec 1187 (if (lookup-key global-map key)
02b2f510 1188 (progn
24b5caec
RS
1189 (isearch-done)
1190 (apply 'isearch-unread keylist))
a5cc922e
KH
1191 (setq keylist
1192 (listify-key-sequence (lookup-key function-key-map key)))
1193 (while keylist
1194 (setq key (car keylist))
1195 ;; If KEY is a printing char, we handle it here
1196 ;; directly to avoid the input method and keyboard
1197 ;; coding system translating it.
1198 (if (and (integerp key)
ed5c183b 1199 (>= key ?\ ) (/= key 127) (< key 256))
a5cc922e
KH
1200 (progn
1201 (isearch-process-search-char key)
1202 (setq keylist (cdr keylist)))
1203 ;; As the remaining keys in KEYLIST can't be handled
1204 ;; here, we must reread them.
1205 (apply 'isearch-unread keylist)
1206 (setq keylist nil)))))
24b5caec 1207 (
c6431f12
KH
1208 ;; Handle an undefined shifted control character
1209 ;; by downshifting it if that makes it defined.
1210 ;; (As read-key-sequence would normally do,
1211 ;; if we didn't have a default definition.)
1212 (let ((mods (event-modifiers main-event)))
1213 (and (integerp main-event)
1214 (memq 'shift mods)
1215 (memq 'control mods)
1216 (lookup-key isearch-mode-map
1217 (let ((copy (copy-sequence key)))
1218 (aset copy 0
1219 (- main-event (- ?\C-\S-a ?\C-a)))
1220 copy)
1221 nil)))
1222 (setcar keylist (- main-event (- ?\C-\S-a ?\C-a)))
d94eb6eb 1223 (cancel-kbd-macro-events)
c6431f12
KH
1224 (apply 'isearch-unread keylist))
1225 ((eq search-exit-option 'edit)
1226 (apply 'isearch-unread keylist)
1227 (isearch-edit-string))
1228 (search-exit-option
1229 (let (window)
d94eb6eb 1230 (cancel-kbd-macro-events)
c6431f12 1231 (apply 'isearch-unread keylist)
3fb01f36
GM
1232
1233 ;; Properly handle scroll-bar and mode-line clicks for
1234 ;; which a dummy prefix event was generated as (aref key
1235 ;; 0). Note that we don't have to modify the event
1236 ;; anymore in 21 because read_key_sequence no longer modifies
1237 ;; events to produce fake prefix keys.
1238 (when (and (> (length key) 1)
1239 (symbolp (aref key 0))
1240 (listp (aref key 1))
1241 (not (numberp (posn-point
1242 (event-start (aref key 1))))))
17635d50
GM
1243 (pop unread-command-events)
1244 (setq main-event (car unread-command-events)))
3fb01f36 1245
c6431f12
KH
1246 ;; If we got a mouse click, maybe it was read with the buffer
1247 ;; it was clicked on. If so, that buffer, not the current one,
1248 ;; is in isearch mode. So end the search in that buffer.
1249 (if (and (listp main-event)
1250 (setq window (posn-window (event-start main-event)))
4fd017e7
RS
1251 (windowp window)
1252 (or (> (minibuffer-depth) 0)
1253 (not (window-minibuffer-p window))))
c6431f12
KH
1254 (save-excursion
1255 (set-buffer (window-buffer window))
0352b205
RS
1256 (isearch-done)
1257 (isearch-clean-overlays))
1258 (isearch-done)
1259 (isearch-clean-overlays))))
c6431f12
KH
1260 (t;; otherwise nil
1261 (isearch-process-search-string key key)))))
8e1cae6d 1262
8e1cae6d
JB
1263(defun isearch-quote-char ()
1264 "Quote special characters for incremental search."
1265 (interactive)
8bc15fa8 1266 (let ((char (read-quoted-char (isearch-message t))))
3c75023f 1267 ;; Assume character codes 0200 - 0377 stand for characters in some
c20d35d5
KH
1268 ;; single-byte character set, and convert them to Emacs
1269 ;; characters.
8bc15fa8 1270 (and enable-multibyte-characters
3c75023f 1271 (>= char ?\200)
8bc15fa8 1272 (<= char ?\377)
c20d35d5 1273 (setq char (unibyte-char-to-multibyte char)))
8bc15fa8 1274 (isearch-process-search-char char)))
8e1cae6d 1275
8e1cae6d
JB
1276(defun isearch-return-char ()
1277 "Convert return into newline for incremental search.
1278Obsolete."
1279 (interactive)
1280 (isearch-process-search-char ?\n))
1281
8e1cae6d 1282(defun isearch-printing-char ()
b68c164d 1283 "Add this ordinary printing character to the search string and search."
8e1cae6d 1284 (interactive)
117132a6 1285 (let ((char last-command-char))
45b94eb2
KH
1286 (if (= char ?\S-\ )
1287 (setq char ?\ ))
af56433d
RS
1288 (if (and enable-multibyte-characters
1289 (>= char ?\200)
1290 (<= char ?\377))
3c487103
KH
1291 (if (keyboard-coding-system)
1292 (isearch-process-search-multibyte-characters char)
1293 (isearch-process-search-char (unibyte-char-to-multibyte char)))
af56433d
RS
1294 (if current-input-method
1295 (isearch-process-search-multibyte-characters char)
1296 (isearch-process-search-char char)))))
8e1cae6d
JB
1297
1298(defun isearch-whitespace-chars ()
08200510 1299 "Match all whitespace chars, if in regexp mode.
117132a6 1300If you want to search for just a space, type \\[quoted-insert] SPC."
8e1cae6d 1301 (interactive)
08200510 1302 (if isearch-regexp
9da6682f
RS
1303 (if (and search-whitespace-regexp (not isearch-within-brackets)
1304 (not isearch-invalid-regexp))
08200510
RS
1305 (isearch-process-search-string search-whitespace-regexp " ")
1306 (isearch-printing-char))
1307 (progn
eb8c3be9 1308 ;; This way of doing word search doesn't correctly extend current search.
08200510
RS
1309 ;; (setq isearch-word t)
1310 ;; (setq isearch-adjusted t)
1311 ;; (goto-char isearch-barrier)
1312 (isearch-printing-char))))
8e1cae6d
JB
1313
1314(defun isearch-process-search-char (char)
1315 ;; Append the char to the search string, update the message and re-search.
08200510 1316 (isearch-process-search-string
117132a6 1317 (char-to-string char)
8f3c1d76 1318 (if (>= char ?\200)
01a6ef79
RS
1319 (char-to-string char)
1320 (isearch-text-char-description char))))
8e1cae6d
JB
1321
1322(defun isearch-process-search-string (string message)
1323 (setq isearch-string (concat isearch-string string)
1324 isearch-message (concat isearch-message message))
1325 (isearch-search-and-update))
1326
1327\f
8e1cae6d
JB
1328;; Search Ring
1329
08200510
RS
1330(defun isearch-ring-adjust1 (advance)
1331 ;; Helper for isearch-ring-adjust
1332 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
8e1cae6d
JB
1333 (length (length ring))
1334 (yank-pointer-name (if isearch-regexp
08200510 1335 'regexp-search-ring-yank-pointer
8e1cae6d
JB
1336 'search-ring-yank-pointer))
1337 (yank-pointer (eval yank-pointer-name)))
1338 (if (zerop length)
1339 ()
1340 (set yank-pointer-name
1341 (setq yank-pointer
ffbc30b2
PE
1342 (mod (+ (or yank-pointer 0)
1343 (if advance -1 1))
1344 length)))
a5dcf63f 1345 (setq isearch-string (nth yank-pointer ring)
08200510
RS
1346 isearch-message (mapconcat 'isearch-text-char-description
1347 isearch-string "")))))
1348
1349(defun isearch-ring-adjust (advance)
1350 ;; Helper for isearch-ring-advance and isearch-ring-retreat
08200510 1351 (isearch-ring-adjust1 advance)
08200510
RS
1352 (if search-ring-update
1353 (progn
1354 (isearch-search)
1355 (isearch-update))
1356 (isearch-edit-string)
2ff20b7e
RS
1357 )
1358 (isearch-push-state))
8e1cae6d
JB
1359
1360(defun isearch-ring-advance ()
1361 "Advance to the next search string in the ring."
08200510 1362 ;; This could be more general to handle a prefix arg, but who would use it.
8e1cae6d
JB
1363 (interactive)
1364 (isearch-ring-adjust 'advance))
1365
1366(defun isearch-ring-retreat ()
1367 "Retreat to the previous search string in the ring."
1368 (interactive)
1369 (isearch-ring-adjust nil))
1370
a5dcf63f 1371(defun isearch-ring-advance-edit (n)
117132a6
DL
1372 "Insert the next element of the search history into the minibuffer.
1373With prefix arg N, insert the Nth element."
a5dcf63f
RS
1374 (interactive "p")
1375 (let* ((yank-pointer-name (if isearch-regexp
1376 'regexp-search-ring-yank-pointer
1377 'search-ring-yank-pointer))
1378 (yank-pointer (eval yank-pointer-name))
1379 (ring (if isearch-regexp regexp-search-ring search-ring))
1380 (length (length ring)))
1381 (if (zerop length)
1382 ()
1383 (set yank-pointer-name
1384 (setq yank-pointer
ffbc30b2
PE
1385 (mod (- (or yank-pointer 0) n)
1386 length)))
a5dcf63f 1387
b7b66466 1388 (delete-field)
35a4d143 1389 (insert (nth yank-pointer ring))
49c13105 1390 (goto-char (point-max)))))
a5dcf63f
RS
1391
1392(defun isearch-ring-retreat-edit (n)
117132a6
DL
1393 "Insert the previous element of the search history into the minibuffer.
1394With prefix arg N, insert the Nth element."
a5dcf63f
RS
1395 (interactive "p")
1396 (isearch-ring-advance-edit (- n)))
1397
1398;;(defun isearch-ring-adjust-edit (advance)
1399;; "Use the next or previous search string in the ring while in minibuffer."
1400;; (isearch-ring-adjust1 advance)
1401;; (erase-buffer)
1402;; (insert isearch-string))
1403
1404;;(defun isearch-ring-advance-edit ()
1405;; (interactive)
1406;; (isearch-ring-adjust-edit 'advance))
1407
1408;;(defun isearch-ring-retreat-edit ()
1409;; "Retreat to the previous search string in the ring while in the minibuffer."
1410;; (interactive)
1411;; (isearch-ring-adjust-edit nil))
08200510
RS
1412
1413
1414(defun isearch-complete1 ()
1415 ;; Helper for isearch-complete and isearch-complete-edit
1416 ;; Return t if completion OK, nil if no completion exists.
1417 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
1418 (alist (mapcar (function (lambda (string) (list string))) ring))
1419 (completion-ignore-case case-fold-search)
1420 (completion (try-completion isearch-string alist)))
1421 (cond
1422 ((eq completion t)
1423 ;; isearch-string stays the same
1424 t)
1425 ((or completion ; not nil, must be a string
b7852303 1426 (= 0 (length isearch-string))) ; shouldn't have to say this
08200510 1427 (if (equal completion isearch-string) ;; no extension?
36bcac3f
RS
1428 (progn
1429 (if completion-auto-help
1430 (with-output-to-temp-buffer "*Isearch completions*"
1431 (display-completion-list
1432 (all-completions isearch-string alist))))
1433 t)
1434 (and completion
1435 (setq isearch-string completion))))
08200510
RS
1436 (t
1437 (message "No completion") ; waits a second if in minibuffer
1438 nil))))
1439
1440(defun isearch-complete ()
1441 "Complete the search string from the strings on the search ring.
1442The completed string is then editable in the minibuffer.
1443If there is no completion possible, say so and continue searching."
1444 (interactive)
1445 (if (isearch-complete1)
1446 (isearch-edit-string)
1447 ;; else
1448 (sit-for 1)
1449 (isearch-update)))
8e1cae6d 1450
08200510
RS
1451(defun isearch-complete-edit ()
1452 "Same as `isearch-complete' except in the minibuffer."
1453 (interactive)
1454 (setq isearch-string (buffer-string))
1455 (if (isearch-complete1)
8e1cae6d 1456 (progn
b7b66466 1457 (delete-field)
08200510 1458 (insert isearch-string))))
8e1cae6d
JB
1459
1460\f
8e1cae6d 1461;; The search status stack (and isearch window-local variables, not used).
08200510 1462;; Need a structure for this.
8e1cae6d
JB
1463
1464(defun isearch-top-state ()
8e1cae6d
JB
1465 (let ((cmd (car isearch-cmds)))
1466 (setq isearch-string (car cmd)
1467 isearch-message (car (cdr cmd))
1468 isearch-success (nth 3 cmd)
1469 isearch-forward (nth 4 cmd)
1470 isearch-other-end (nth 5 cmd)
08200510
RS
1471 isearch-word (nth 6 cmd)
1472 isearch-invalid-regexp (nth 7 cmd)
1473 isearch-wrapped (nth 8 cmd)
c5f6b356 1474 isearch-barrier (nth 9 cmd)
f551b97d
RS
1475 isearch-within-brackets (nth 10 cmd)
1476 isearch-case-fold-search (nth 11 cmd))
8e1cae6d
JB
1477 (goto-char (car (cdr (cdr cmd))))))
1478
1479(defun isearch-pop-state ()
8e1cae6d 1480 (setq isearch-cmds (cdr isearch-cmds))
1f4139d5 1481 (isearch-top-state))
8e1cae6d
JB
1482
1483(defun isearch-push-state ()
1484 (setq isearch-cmds
1485 (cons (list isearch-string isearch-message (point)
1486 isearch-success isearch-forward isearch-other-end
08200510 1487 isearch-word
c5f6b356 1488 isearch-invalid-regexp isearch-wrapped isearch-barrier
f551b97d 1489 isearch-within-brackets isearch-case-fold-search)
8e1cae6d
JB
1490 isearch-cmds)))
1491
8e1cae6d 1492\f
8e1cae6d
JB
1493;; Message string
1494
1495(defun isearch-message (&optional c-q-hack ellipsis)
1496 ;; Generate and print the message string.
1497 (let ((cursor-in-echo-area ellipsis)
1498 (m (concat
08200510 1499 (isearch-message-prefix c-q-hack ellipsis isearch-nonincremental)
8e1cae6d
JB
1500 isearch-message
1501 (isearch-message-suffix c-q-hack ellipsis)
1502 )))
a56687f1
KH
1503 (if c-q-hack
1504 m
1505 (let ((message-log-max nil))
1506 (message "%s" m)))))
8e1cae6d 1507
08200510 1508(defun isearch-message-prefix (&optional c-q-hack ellipsis nonincremental)
8e1cae6d
JB
1509 ;; If about to search, and previous search regexp was invalid,
1510 ;; check that it still is. If it is valid now,
1511 ;; let the message we display while searching say that it is valid.
1512 (and isearch-invalid-regexp ellipsis
1513 (condition-case ()
1514 (progn (re-search-forward isearch-string (point) t)
8eb40e74
KH
1515 (setq isearch-invalid-regexp nil
1516 isearch-within-brackets nil))
8e1cae6d
JB
1517 (error nil)))
1518 ;; If currently failing, display no ellipsis.
1519 (or isearch-success (setq ellipsis nil))
1520 (let ((m (concat (if isearch-success "" "failing ")
7badea30
RS
1521 (if (and isearch-wrapped
1522 (if isearch-forward
1523 (> (point) isearch-opoint)
1524 (< (point) isearch-opoint)))
1525 "over")
8e1cae6d 1526 (if isearch-wrapped "wrapped ")
08200510 1527 (if isearch-word "word " "")
8e1cae6d 1528 (if isearch-regexp "regexp " "")
08200510 1529 (if nonincremental "search" "I-search")
f46d5091 1530 (if isearch-forward "" " backward")
5b56d4e4
KH
1531 (if current-input-method
1532 (concat " [" current-input-method-title "]: ")
f46d5091 1533 ": ")
8e1cae6d 1534 )))
c5def0db 1535 (concat (upcase (substring m 0 1)) (substring m 1))))
8e1cae6d
JB
1536
1537
1538(defun isearch-message-suffix (&optional c-q-hack ellipsis)
1539 (concat (if c-q-hack "^Q" "")
1540 (if isearch-invalid-regexp
1541 (concat " [" isearch-invalid-regexp "]")
1542 "")))
1543
1544\f
8e1cae6d
JB
1545;;; Searching
1546
1547(defun isearch-search ()
1548 ;; Do the search with the current search string.
1549 (isearch-message nil t)
4453091d 1550 (if (and (eq isearch-case-fold-search t) search-upper-case)
b78559b0
RS
1551 (setq isearch-case-fold-search
1552 (isearch-no-upper-case-p isearch-string isearch-regexp)))
8e1cae6d 1553 (condition-case lossage
79c7a4fa
RS
1554 (let ((inhibit-point-motion-hooks search-invisible)
1555 (inhibit-quit nil)
86bfaffe
RS
1556 (case-fold-search isearch-case-fold-search)
1557 (retry t))
8e1cae6d 1558 (if isearch-regexp (setq isearch-invalid-regexp nil))
c5f6b356 1559 (setq isearch-within-brackets nil)
86bfaffe
RS
1560 (while retry
1561 (setq isearch-success
1562 (funcall
1563 (cond (isearch-word
1564 (if isearch-forward
1565 'word-search-forward 'word-search-backward))
1566 (isearch-regexp
1567 (if isearch-forward
1568 're-search-forward 're-search-backward))
1569 (t
1570 (if isearch-forward 'search-forward 'search-backward)))
1571 isearch-string nil t))
1572 ;; Clear RETRY unless we matched some invisible text
1573 ;; and we aren't supposed to do that.
0352b205 1574 (if (or (eq search-invisible t)
86bfaffe
RS
1575 (not isearch-success)
1576 (bobp) (eobp)
1577 (= (match-beginning 0) (match-end 0))
1578 (not (isearch-range-invisible
1579 (match-beginning 0) (match-end 0))))
1580 (setq retry nil)))
99ae9e9f 1581 (setq isearch-just-started nil)
8e1cae6d
JB
1582 (if isearch-success
1583 (setq isearch-other-end
1584 (if isearch-forward (match-beginning 0) (match-end 0)))))
1585
d32696d4 1586 (quit (isearch-unread ?\C-g)
8e1cae6d
JB
1587 (setq isearch-success nil))
1588
1589 (invalid-regexp
1590 (setq isearch-invalid-regexp (car (cdr lossage)))
c5f6b356
RS
1591 (setq isearch-within-brackets (string-match "\\`Unmatched \\["
1592 isearch-invalid-regexp))
8e1cae6d
JB
1593 (if (string-match
1594 "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
1595 isearch-invalid-regexp)
f1c03125
RS
1596 (setq isearch-invalid-regexp "incomplete input")))
1597 (error
c982ab21 1598 ;; stack overflow in regexp search.
c5348233 1599 (setq isearch-invalid-regexp (format "%s" lossage))))
8e1cae6d
JB
1600
1601 (if isearch-success
1602 nil
1603 ;; Ding if failed this time after succeeding last time.
1604 (and (nth 3 (car isearch-cmds))
1605 (ding))
1606 (goto-char (nth 2 (car isearch-cmds)))))
1607
0352b205
RS
1608
1609;;; Called when opening an overlay, and we are still in isearch.
1610(defun isearch-open-overlay-temporary (ov)
0352b205
RS
1611 (if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
1612 ;; Some modes would want to open the overlays temporary during
1613 ;; isearch in their own way, they should set the
1614 ;; `isearch-open-invisible-temporary' to a function doing this.
1615 (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
1616 ;; Store the values for the `invisible' and `intangible'
1617 ;; properties, and then set them to nil. This way the text hidden
1618 ;; by this overlay becomes visible.
1619
380866a2 1620 ;; Do we really need to set the `intangible' property to t? Can we
0352b205
RS
1621 ;; have the point inside an overlay with an `intangible' property?
1622 ;; In 19.34 this does not exist so I cannot test it.
1623 (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible))
1624 (overlay-put ov 'isearch-intangible (overlay-get ov 'intangible))
1625 (overlay-put ov 'invisible nil)
1626 (overlay-put ov 'intangible nil)))
1627
1628
117132a6
DL
1629;;; This is called at the end of isearch. It will open the overlays
1630;;; that contain the latest match. Obviously in case of a C-g the
0352b205
RS
1631;;; point returns to the original location which surely is not contain
1632;;; in any of these overlays, se we are safe in this case too.
1633(defun isearch-open-necessary-overlays (ov)
1634 (let ((inside-overlay (and (> (point) (overlay-start ov))
1635 (< (point) (overlay-end ov))))
1636 ;; If this exists it means that the overlay was opened using
1637 ;; this function, not by us tweaking the overlay properties.
1638 (fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
1639 (when (or inside-overlay (not fct-temp))
1640 ;; restore the values for the `invisible' and `intangible'
1641 ;; properties
1642 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
1643 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
1644 (overlay-put ov 'isearch-invisible nil)
1645 (overlay-put ov 'isearch-intangible nil))
1646 (if inside-overlay
1647 (funcall (overlay-get ov 'isearch-open-invisible) ov)
1648 (if fct-temp
1649 (funcall fct-temp ov t)))))
1650
1651;;; This is called when exiting isearch. It closes the temporary
1652;;; opened overlays, except the ones that contain the latest match.
1653(defun isearch-clean-overlays ()
1654 (when isearch-opened-overlays
02b2f510 1655 (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
0352b205
RS
1656 (setq isearch-opened-overlays nil)))
1657
1658;;; Verify if the current match is outside of each element of
1659;;; `isearch-opened-overlays', if so close that overlay.
1660(defun isearch-close-unecessary-overlays (begin end)
1661 (let ((ov-list isearch-opened-overlays)
1662 ov
1663 inside-overlay
1664 fct-temp)
1665 (setq isearch-opened-overlays nil)
1666 (while ov-list
1667 (setq ov (car ov-list))
1668 (setq ov-list (cdr ov-list))
1669 (setq inside-overlay (or (and (> begin (overlay-start ov))
1670 (< begin (overlay-end ov)))
1671 (and (> end (overlay-start ov))
1672 (< end (overlay-end ov)))))
1673 ;; If this exists it means that the overlay was opened using
1674 ;; this function, not by us tweaking the overlay properties.
1675 (setq fct-temp (overlay-get ov 'isearch-open-invisible-temporary))
1676 (if inside-overlay
02b2f510 1677 (setq isearch-opened-overlays (cons ov isearch-opened-overlays))
0352b205
RS
1678 (if fct-temp
1679 (funcall fct-temp ov t)
1680 (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
1681 (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
1682 (overlay-put ov 'isearch-invisible nil)
1683 (overlay-put ov 'isearch-intangible nil))))))
1684
86bfaffe 1685(defun isearch-range-invisible (beg end)
79c7a4fa 1686 "Return t if all the text from BEG to END is invisible."
86bfaffe
RS
1687 (and (/= beg end)
1688 ;; Check that invisibility runs up to END.
1689 (save-excursion
1690 (goto-char beg)
df01192b
RS
1691 (let (
1692 ;; can-be-opened keeps track if we can open some overlays.
1693 (can-be-opened (eq search-invisible 'open))
1694 ;; the list of overlays that could be opened
1695 (crt-overlays nil))
0352b205 1696 (when (and can-be-opened isearch-hide-immediately)
df01192b 1697 (isearch-close-unecessary-overlays beg end))
0352b205
RS
1698 ;; If the following character is currently invisible,
1699 ;; skip all characters with that same `invisible' property value.
1700 ;; Do that over and over.
1701 (while (and (< (point) end)
1702 (let ((prop
1703 (get-char-property (point) 'invisible)))
1704 (if (eq buffer-invisibility-spec t)
1705 prop
1706 (or (memq prop buffer-invisibility-spec)
1707 (assq prop buffer-invisibility-spec)))))
1708 (if (get-text-property (point) 'invisible)
1709 (progn
1710 (goto-char (next-single-property-change (point) 'invisible
1711 nil end))
1712 ;; if text is hidden by an `invisible' text property
1713 ;; we cannot open it at all.
1714 (setq can-be-opened nil))
1715 (unless (null can-be-opened)
1716 (let ((overlays (overlays-at (point)))
1717 ov-list
1718 o
1719 invis-prop)
1720 (while overlays
1721 (setq o (car overlays)
1722 invis-prop (overlay-get o 'invisible))
de207f5a
KH
1723 (if (if (eq buffer-invisibility-spec t)
1724 invis-prop
1725 (or (memq invis-prop buffer-invisibility-spec)
1726 (assq invis-prop buffer-invisibility-spec)))
0352b205
RS
1727 (if (overlay-get o 'isearch-open-invisible)
1728 (setq ov-list (cons o ov-list))
1729 ;; We found one overlay that cannot be
1730 ;; opened, that means the whole chunk
1731 ;; cannot be opened.
1732 (setq can-be-opened nil)))
1733 (setq overlays (cdr overlays)))
1734 (if can-be-opened
1735 ;; It makes sense to append to the open
1736 ;; overlays list only if we know that this is
1737 ;; t.
7e97482b
RS
1738 (setq crt-overlays (append ov-list crt-overlays)))))
1739 (goto-char (next-overlay-change (point)))))
86bfaffe 1740 ;; See if invisibility reaches up thru END.
0352b205
RS
1741 (if (>= (point) end)
1742 (if (and (not (null can-be-opened)) (consp crt-overlays))
1743 (progn
1744 (setq isearch-opened-overlays
1745 (append isearch-opened-overlays crt-overlays))
02b2f510 1746 (mapc 'isearch-open-overlay-temporary crt-overlays)
0352b205
RS
1747 nil)
1748 t))))))
08200510
RS
1749
1750\f
08200510
RS
1751;;; Highlighting
1752
b78559b0 1753(defvar isearch-overlay nil)
08200510 1754
b78559b0 1755(defun isearch-highlight (beg end)
8005142f 1756 (unless (null search-highlight)
4fb2ad98
MB
1757 (cond (isearch-overlay
1758 ;; Overlay already exists, just move it.
4fb2ad98
MB
1759 (move-overlay isearch-overlay beg end (current-buffer)))
1760
1761 (t
1762 ;; Overlay doesn't exist, create it.
1763 (setq isearch-overlay (make-overlay beg end))
c982ab21
GM
1764 (overlay-put isearch-overlay 'face isearch)
1765 (overlay-put isearch-overlay 'priority 1) ;higher than lazy overlays
1766 ))))
b78559b0
RS
1767
1768(defun isearch-dehighlight (totally)
4fb2ad98 1769 (when isearch-overlay
4fb2ad98
MB
1770 (delete-overlay isearch-overlay)))
1771
08200510 1772
08200510
RS
1773;;; General utilities
1774
08200510 1775
b78559b0
RS
1776(defun isearch-no-upper-case-p (string regexp-flag)
1777 "Return t if there are no upper case chars in STRING.
b7852303 1778If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
b78559b0 1779since they have special meaning in a regexp."
59057198
RS
1780 (let (quote-flag (i 0) (len (length string)) found)
1781 (while (and (not found) (< i len))
1782 (let ((char (aref string i)))
1783 (if (and regexp-flag (eq char ?\\))
1784 (setq quote-flag (not quote-flag))
1785 (if (and (not quote-flag) (not (eq char (downcase char))))
1786 (setq found t))))
1787 (setq i (1+ i)))
1788 (not found)))
08200510 1789
b78559b0 1790;; Portability functions to support various Emacs versions.
8e1cae6d 1791
08200510 1792(defun isearch-text-char-description (c)
14373677
SM
1793 (cond
1794 ((< c ?\ ) (format "^%c" (+ c 64)))
1795 ((= c ?\^?) "^?")
1796 (t (char-to-string c))))
08200510 1797
bd1bd125 1798;; General function to unread characters or events.
99ae9e9f 1799;; Also insert them in a keyboard macro being defined.
8f90f594 1800(defun isearch-unread (&rest char-or-events)
02b2f510 1801 (mapc 'store-kbd-macro-event char-or-events)
bd1bd125
RS
1802 (setq unread-command-events
1803 (append char-or-events unread-command-events)))
08200510 1804
44336afb
GM
1805\f
1806;;; isearch-lazy-highlight feature
1807;;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
1808
1809;;; When active, *every* match for the current search string is
1810;;; highlighted: the current one using the normal isearch match color
c982ab21
GM
1811;;; and all the others using `isearch-lazy-highlight-face'. The extra
1812;;; highlighting makes it easier to anticipate where the cursor will
1813;;; land each time you press C-s or C-r to repeat a pending search.
1814;;; Highlighting of these additional matches happens in a deferred
1815;;; fashion using "idle timers," so the cycles needed do not rob
1816;;; isearch of its usual snappy response.
44336afb
GM
1817
1818;;; IMPLEMENTATION NOTE: This depends on some isearch internals.
1819;;; Specifically:
1820;;; - `isearch-update' is expected to be called (at least) every time
c982ab21 1821;;; the search string or window-start changes;
44336afb
GM
1822;;; - `isearch-string' is expected to contain the current search
1823;;; string as entered by the user;
44336afb
GM
1824;;; - the type of the current search is expected to be given by
1825;;; `isearch-word' and `isearch-regexp';
1826;;; - the direction of the current search is expected to be given by
1827;;; `isearch-forward';
1828;;; - the variable `isearch-invalid-regexp' is expected to be true
1829;;; iff `isearch-string' is an invalid regexp.
1830
1831(require 'timer)
1832
1833(defgroup isearch-lazy-highlight nil
1834 "Lazy highlighting feature for incremental search."
1835 :prefix "isearch-lazy-highlight-"
39f2174e 1836 :version "21.1"
44336afb
GM
1837 :group 'isearch)
1838
1839(defcustom isearch-lazy-highlight t
1840 "*Controls the lazy-highlighting during incremental searches.
1841When non-nil, all text in the buffer matching the current search
1842string is highlighted lazily (see `isearch-lazy-highlight-initial-delay'
1843and `isearch-lazy-highlight-interval')."
1844 :type 'boolean
1845 :group 'isearch-lazy-highlight)
1846
1847(defcustom isearch-lazy-highlight-cleanup t
1848 "*Controls whether to remove extra highlighting after a search.
1849If this is nil, extra highlighting can be \"manually\" removed with
1850\\[isearch-lazy-highlight-cleanup]."
1851 :type 'boolean
1852 :group 'isearch-lazy-highlight)
1853
871e0439 1854(defcustom isearch-lazy-highlight-initial-delay 0.25
44336afb
GM
1855 "*Seconds to wait before beginning to lazily highlight all matches."
1856 :type 'number
1857 :group 'isearch-lazy-highlight)
1858
b8fbd474 1859(defcustom isearch-lazy-highlight-interval 0 ; 0.0625
44336afb
GM
1860 "*Seconds between lazily highlighting successive matches."
1861 :type 'number
1862 :group 'isearch-lazy-highlight)
1863
c982ab21
GM
1864(defcustom isearch-lazy-highlight-max-at-a-time 20
1865 "*Maximum matches to highlight at a time (for `isearch-lazy-highlight').
1866Larger values may reduce isearch's responsiveness to user input;
1867smaller values make matches highlight slowly.
1868A value of nil means highlight all matches."
68ebbb95
GM
1869 :type '(choice (const :tag "All" nil)
1870 (integer :tag "Some"))
1871 :group 'isearch-lazy-highlight)
1872
18ca20aa
GM
1873(defgroup isearch-faces nil
1874 "Lazy highlighting feature for incremental search."
1875 :version "21.1"
1876 :group 'isearch)
1877
1878(defface isearch
29910493
EZ
1879 '((((type tty pc) (class color))
1880 (:background "magenta4" :foreground "cyan1"))
1881 (((class color) (background light))
1882 (:background "magenta4" :foreground "lightskyblue1"))
1883 (((class color) (background dark))
1884 (:background "palevioletred2" :foreground "brown4"))
1885 (t (:inverse-video t)))
1886 "Face for highlighting Isearch matches."
18ca20aa
GM
1887 :group 'isearch-faces)
1888(defvar isearch 'isearch)
1889
1890(defface isearch-lazy-highlight-face
29910493
EZ
1891 '((((type tty pc) (class color))
1892 (:background "turquoise3"))
1893 (((class color) (background light))
1894 (:background "paleturquoise"))
1895 (((class color) (background dark))
1896 (:background "paleturquoise4"))
1897 (t (:underline t)))
1898 "Face for lazy highlighting of Isearch matches other than the current one."
18ca20aa
GM
1899 :group 'isearch-faces)
1900(defvar isearch-lazy-highlight-face 'isearch-lazy-highlight-face)
44336afb
GM
1901
1902(defvar isearch-lazy-highlight-overlays nil)
c982ab21 1903(defvar isearch-lazy-highlight-wrapped nil)
44336afb
GM
1904(defvar isearch-lazy-highlight-start nil)
1905(defvar isearch-lazy-highlight-end nil)
1906(defvar isearch-lazy-highlight-timer nil)
1907(defvar isearch-lazy-highlight-last-string nil)
c982ab21
GM
1908(defvar isearch-lazy-highlight-window nil)
1909(defvar isearch-lazy-highlight-window-start nil)
46daf6c7
GM
1910(defvar isearch-lazy-highlight-case-fold-search nil)
1911(defvar isearch-lazy-highlight-regexp nil)
44336afb 1912
c982ab21
GM
1913(defun isearch-lazy-highlight-cleanup (&optional force)
1914 "Stop lazy highlighting and remove extra highlighting from current buffer.
1915FORCE non-nil means do it whether or not `isearch-lazy-highlight-cleanup'
1916is nil. This function is called when exiting an incremental search if
1917`isearch-lazy-highlight-cleanup' is non-nil."
44336afb 1918 (interactive '(t))
c982ab21
GM
1919 (if (or force isearch-lazy-highlight-cleanup)
1920 (while isearch-lazy-highlight-overlays
1921 (delete-overlay (car isearch-lazy-highlight-overlays))
1922 (setq isearch-lazy-highlight-overlays
1923 (cdr isearch-lazy-highlight-overlays))))
1924 (when isearch-lazy-highlight-timer
1925 (cancel-timer isearch-lazy-highlight-timer)
1926 (setq isearch-lazy-highlight-timer nil)))
44336afb
GM
1927
1928(defun isearch-lazy-highlight-new-loop ()
c982ab21 1929 "Cleanup any previous `isearch-lazy-highlight' loop and begin a new one.
44336afb 1930This happens when `isearch-update' is invoked (which can cause the
c982ab21 1931search string to change or the window to scroll)."
67ecad4e 1932 (when (and isearch-lazy-highlight
c982ab21
GM
1933 (sit-for 0) ;make sure (window-start) is credible
1934 (or (not (equal isearch-string
1935 isearch-lazy-highlight-last-string))
1936 (not (eq (selected-window)
1937 isearch-lazy-highlight-window))
46daf6c7
GM
1938 (not (eq isearch-lazy-highlight-case-fold-search
1939 isearch-case-fold-search))
1940 (not (eq isearch-lazy-highlight-regexp
1941 isearch-regexp))
c982ab21
GM
1942 (not (= (window-start)
1943 isearch-lazy-highlight-window-start))))
1944 ;; something important did indeed change
1945 (isearch-lazy-highlight-cleanup t) ;kill old loop & remove overlays
1946 (when (not isearch-invalid-regexp)
1947 (setq isearch-lazy-highlight-window (selected-window)
1948 isearch-lazy-highlight-window-start (window-start)
1949 isearch-lazy-highlight-start (point)
1950 isearch-lazy-highlight-end (point)
1951 isearch-lazy-highlight-last-string isearch-string
46daf6c7
GM
1952 isearch-lazy-highlight-case-fold-search isearch-case-fold-search
1953 isearch-lazy-highlight-regexp isearch-regexp
c982ab21
GM
1954 isearch-lazy-highlight-wrapped nil)
1955 (setq isearch-lazy-highlight-timer
1956 (run-with-idle-timer isearch-lazy-highlight-initial-delay nil
1957 'isearch-lazy-highlight-update)))))
1958
1959(defun isearch-lazy-highlight-search ()
1960 "Search ahead for the next or previous match, for lazy highlighting.
1961Attempt to do the search exactly the way the pending isearch would."
1962 (let ((case-fold-search isearch-case-fold-search)
1963 (choices (cond (isearch-word
1964 '(word-search-forward . word-search-backward))
1965 (isearch-regexp
1966 '(re-search-forward . re-search-backward))
1967 (t
1968 '(search-forward . search-backward)))))
1969 (funcall (if isearch-forward
1970 (car choices)
1971 (cdr choices))
1972 isearch-string
1973 (if isearch-forward
1974 (if isearch-lazy-highlight-wrapped
1975 isearch-lazy-highlight-start
1976 (window-end))
1977 (if isearch-lazy-highlight-wrapped
1978 isearch-lazy-highlight-end
1979 (window-start)))
1980 t)))
44336afb
GM
1981
1982(defun isearch-lazy-highlight-update ()
c982ab21
GM
1983 "Update highlighting of other matches for current search."
1984 (let ((max isearch-lazy-highlight-max-at-a-time)
1985 (looping t)
1986 nomore)
7742ee19
RS
1987 (save-excursion
1988 (save-match-data
c982ab21
GM
1989 (goto-char (if isearch-forward
1990 isearch-lazy-highlight-end
1991 isearch-lazy-highlight-start))
1992 (while looping
1993 (let ((found (isearch-lazy-highlight-search)))
1994 (when max
1995 (setq max (1- max))
1996 (if (<= max 0)
1997 (setq looping nil)))
1998 (if found
1999 (let ((mb (match-beginning 0))
2000 (me (match-end 0)))
2001 (if (= mb me) ;zero-length match
2002 (forward-char 1)
2003
2004 ;; non-zero-length match
2005 (let ((ov (make-overlay mb me)))
2006 (overlay-put ov 'face isearch-lazy-highlight-face)
2007 (overlay-put ov 'priority 0) ;lower than main overlay
2008 (overlay-put ov 'window (selected-window))
2009 (push ov isearch-lazy-highlight-overlays)))
2010 (if isearch-forward
2011 (setq isearch-lazy-highlight-end (point))
2012 (setq isearch-lazy-highlight-start (point))))
2013
2014 ;; not found
2015 (if isearch-lazy-highlight-wrapped
2016 (setq looping nil
2017 nomore t)
2018 (setq isearch-lazy-highlight-wrapped t)
2019 (if isearch-forward
2020 (progn
2021 (setq isearch-lazy-highlight-end (window-start))
2022 (goto-char (window-start)))
2023 (setq isearch-lazy-highlight-start (window-end))
2024 (goto-char (window-end)))))))
2025 (unless nomore
2026 (setq isearch-lazy-highlight-timer
2027 (run-at-time isearch-lazy-highlight-interval nil
2028 'isearch-lazy-highlight-update)))))))
44336afb 2029
c40a4de1
GM
2030(defun isearch-resume (search regexp word forward message case-fold)
2031 "Resume an incremental search.
2032SEARCH is the string or regexp searched for.
2033REGEXP non-nil means the resumed search was a regexp search.
2034WORD non-nil means resume a word search.
2035FORWARD non-nil means resume a forward search.
2036MESSAGE is the echo-area message recorded for the search resumed.
2037CASE-FOLD non-nil means the search was case-insensitive."
2038 (isearch-mode forward regexp nil nil word)
2039 (setq isearch-string search
2040 isearch-message message
2041 isearch-case-fold-search case-fold)
2042 (isearch-search))
2043
3b1e4dd1 2044;;; isearch.el ends here