* sun-mouse.el (suspend-emacstool): Run suspend-hook, not
[bpt/emacs.git] / lisp / isearch.el
CommitLineData
76550a57 1;;; isearch.el --- incremental search minor mode.
3b1e4dd1 2
3a801d0c
ER
3;; Copyright (C) 1992 Free Software Foundation, Inc.
4
3b1e4dd1
ER
5;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
6
b457cc3b 7;; |$Date: 1993/04/14 19:40:53 $|$Revision: 1.30 $
8e1cae6d 8
08200510
RS
9;; This file is not yet part of GNU Emacs, but it is based almost
10;; entirely on isearch.el which is part of GNU Emacs.
8e1cae6d
JB
11
12;; GNU Emacs is distributed in the hope that it will be useful,
13;; but WITHOUT ANY WARRANTY. No author or distributor
14;; accepts responsibility to anyone for the consequences of using it
15;; or for whether it serves any particular purpose or works at all,
16;; unless he says so in writing. Refer to the GNU Emacs General Public
17;; License for full details.
18
19;; Everyone is granted permission to copy, modify and redistribute
20;; GNU Emacs, but only under the conditions described in the
21;; GNU Emacs General Public License. A copy of this license is
22;; supposed to have been given to you along with GNU Emacs so you
23;; can know your rights and responsibilities. It should be in a
24;; file named COPYING. Among other things, the copyright notice
25;; and this notice must be preserved on all copies.
26
3b1e4dd1
ER
27;;; Commentary:
28
8e1cae6d
JB
29;;;====================================================================
30;; Instructions
31
32;; Searching with isearch-mode.el should work just like isearch.el,
33;; except it is done in a temporary minor mode that terminates when
34;; you finish searching.
35
36;; To use isearch-mode instead of the standard isearch.el, add the
37;; following to your .emacs file. The standard key bindings to
38;; isearch-forward, etc, will then use isearch-mode instead of
39;; isearch.
40
b457cc3b 41;; (defalias 'isearch 'isearch-mode)
8e1cae6d
JB
42;; (autoload 'isearch-mode "isearch-mode")
43
08200510
RS
44;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
45;; isearch-mode behaves modally and does not return until the search
46;; is completed. It uses a recursive-edit to behave this way. Note:
47;; gnus does it wrong: (call-interactively 'isearch-forward).
48
49;; If any package you use invokes isearching non-interactively to get
50;; the modal behavior described above, you must use the redefinitions
51;; of isearch-forward, etc. found in this file instead of those in
52;; loaddefs.el. The simplest way to ensure this is to just load
53;; isearch-mode explicitly in your .emacs instead of using the above
b457cc3b 54;; defalias and autoload.
08200510
RS
55
56;; (load "isearch-mode")
57
8e1cae6d 58;; The key bindings active within isearch-mode are defined below in
08200510
RS
59;; `isearch-mode-map' which is given bindings close to the default
60;; characters of the original isearch.el. With `isearch-mode',
61;; however, you can bind multi-character keys and it should be easier
62;; to add new commands. One bug though: keys with meta-prefix cannot
63;; be longer than two chars. Also see minibuffer-local-isearch-map
64;; for bindings active during `isearch-edit-string'.
65
66;; Note to emacs version 19 users: isearch-mode should work even if
67;; you switch windows with the mouse, in which case isearch-mode is
68;; terminated automatically before the switch. This is true of lemacs
69;; too, with a few more cleanups I've neglected in this release.
70;; No one has supplied patches for epoch yet.
71
72;; The search ring and completion commands automatically put you in
73;; the minibuffer to edit the string. This gives you a chance to
74;; modify the search string before executing the search. There are
75;; three commands to terminate the editing: C-s and C-r exit the
76;; minibuffer and search forward and reverse respectively, while C-m
77;; exits and does a nonincremental search.
78
79;; Exiting immediately from isearch uses isearch-edit-string instead
80;; of nonincremental-search, if search-nonincremental-instead is non-nil.
81;; The name of this option should probably be changed if we decide to
82;; keep the behavior. No point in forcing nonincremental search until
83;; the last possible moment.
84
85;; TODO
86;; - Integrate the emacs 19 generalized commmand history.
87;; - Think about incorporating query-replace.
88;; - Hooks and options for failed search.
282d89c0 89
3b1e4dd1
ER
90;;; Change Log:
91
282d89c0 92;;;====================================================================
08200510
RS
93;;; Change History
94
b457cc3b 95;;; $Header: /gd/gnu/emacs/19.0/lisp/RCS/isearch.el,v 1.30 1993/04/14 19:40:53 rms Exp eric $
3b1e4dd1 96;;; $Log: isearch.el,v $
b457cc3b
ER
97; Revision 1.30 1993/04/14 19:40:53 rms
98; Doc fixes.
99;
b68c164d
RS
100; Revision 1.29 1993/03/30 19:42:10 rms
101; (isearch-done): Customize the message about mark.
102;
7872ee4d
RS
103; Revision 1.28 1993/03/30 19:38:34 rms
104; (isearch-mode-map): Delete the binding for C-h.
105;
58f1634a
RS
106; Revision 1.27 1993/03/21 05:50:17 jimb
107; * isearch.el (isearch-switch-frame-handler): Call
108; handle-switch-frame instead of select-frame; it has been renamed.
109;
dba1ec55
JB
110; Revision 1.26 1993/03/17 17:17:05 eric
111; Add standard library headers.
112;
76550a57
ER
113; Revision 1.25 1993/03/17 16:44:50 eric
114; Add standard library headers.
115;
aae56ea7
ER
116; Revision 1.24 1993/03/17 15:58:09 eric
117; Add standard library headers.
118;
3b1e4dd1
ER
119; Revision 1.23 1993/03/07 20:17:27 rms
120; (isearch-other-meta-char): Call listify-key-sequence.
121; (isearch-unread): Don't call it here.
122; (isearch-mode-map): Bind the ASCII-equivalent function keys.
123;
e7cb0106
RS
124; Revision 1.22 1993/03/07 08:43:57 rms
125; (isearch-mode): Don't make a pre-command-hook.
126;
2ed45c8b
RS
127; Revision 1.21 1993/03/07 04:22:00 rms
128; (isearch-unread): Find last list element by hand.
129;
75e86b2e
RS
130; Revision 1.20 1993/03/06 06:15:05 rms
131; (isearch-unread): Handle multiple args.
132; For Emacs 19, use listify-key-sequence.
133; If not Emacs 19, assume they are a meta sequence.
134; (isearch-other-meta-char): Pass the whole key sequence.
135; (isearch-other-control-char): Make this alias for ...-meta-char.
136;
8f90f594
RS
137; Revision 1.19 1993/02/17 21:30:25 rms
138; Fix minor bugs in previous change.
139;
4ae7d00a
RS
140; Revision 1.18 1993/02/17 20:34:20 rms
141; (isearch-backward-regexp):
142; New arg no-recursive-edit, always non-nil for interactive call.
143; Rename first arg, and set it right in interactive call.
144; (isearch-forward-regexp): Likewise.
145; (isearch-forward, isearch-backward): Likewise no-recursive-edit.
146;
eceee2c0
RS
147; Revision 1.17 1993/01/26 01:48:27 jimb
148; JimB's changes since January 18th
149;
dbc4e1c1
JB
150; Revision 1.16 1992/11/16 01:37:06 jimb
151; * bytecomp.el: Declare unread-command-char an obsolete variable.
152; * vip.el (vip-escape-to-emacs, vip-prefix-arg-value,
153; vip-prefix-arg-com): Use unread-command-event instead of
154; unread-command-char; respect its new semantics.
155; * isearch-mode.el (isearch-update, isearch-unread): Same.
156;
797a37c7
JB
157; Revision 1.15 1992/11/07 06:17:04 jimb
158; * isearch.el (isearch-frames-exist): This isn't what we want -
159; replaced by...
160; (isearch-gnu-emacs-events): non-nil if should expect events in the
161; style generated by GNU Emacs 19. Set if set-frame-height is
162; fboundp; this is true on any GNU Emacs 19, whether or not it was
163; compiled with multiple frame support.
164; (isearch-mode-map): Test isearch-gnu-emacs-events instead of
165; isearch-frames-exist to see if we should bind switch-frame events.
166; (isearch-update): Test isearch-gnu-emacs-events instead of
167; isearch-frames-exist to see if unread-command-char's quiescent
168; value is nil or -1.
169;
1a3a6707
JB
170; Revision 1.14 1992/11/01 22:10:59 rms
171; (isearch-search): Handle all sorts of errors from regexp search.
172;
f1c03125
RS
173; Revision 1.13 1992/10/27 04:11:46 rms
174; (isearch-edit-string):
175; Bind cursor-in-echo-area only around read-char/allocate-event.
176;
d94307ee
RS
177; Revision 1.12 1992/10/20 21:21:47 rms
178; (isearch-mode-map): Make the top-level keymap dense.
179; Explicitly bind control characters at that level.
180;
ac689515
RS
181; Revision 1.11 1992/10/11 05:25:11 rms
182; (isearch-ring-advance-edit): Delete spurious `)'.
183;
49c13105
RS
184; Revision 1.10 1992/09/21 08:28:43 rms
185; entered into RCS
186;
08200510
RS
187;;; Revision 1.4 92/09/14 16:26:02 liberte
188;;; Added prefix args to isearch-forward, etc. to switch between
189;;; string and regular expression searching.
190;;; Added some support for lemacs.
191;;; Added general isearch-highlight option - but only for lemacs so far.
192;;; Added support for frame switching in emacs 19.
193;;; Added word search option to isearch-edit-string.
194;;; Renamed isearch-quit to isearch-abort.
195;;; Numerous changes to comments and doc strings.
282d89c0 196;;;
08200510
RS
197;;; Revision 1.3 92/06/29 13:10:08 liberte
198;;; Moved modal isearch-mode handling into isearch-mode.
199;;; Got rid of buffer-local isearch variables.
200;;; isearch-edit-string used by ring adjustments, completion, and
201;;; nonincremental searching. C-s and C-r are additional exit commands.
202;;; Renamed all regex to regexp.
203;;; Got rid of found-start and found-point globals.
204;;; Generalized handling of upper-case chars.
205
206;;; Revision 1.2 92/05/27 11:33:57 liberte
207;;; Emacs version 19 has a search ring, which is supported here.
208;;; Other fixes found in the version 19 isearch are included here.
209;;;
210;;; Also see variables search-caps-disable-folding,
211;;; search-nonincremental-instead, search-whitespace-regexp, and
212;;; commands isearch-toggle-regexp, isearch-edit-string.
213;;;
214;;; semi-modal isearching is supported.
282d89c0
ER
215
216;;; Changes for 1.1
217;;; 3/18/92 Fixed invalid-regexp.
218;;; 3/18/92 Fixed yanking in regexps.
219
3b1e4dd1 220;;; Code:
08200510
RS
221
222\f
223;;;=========================================================================
224;;; Emacs features
225
226;; isearch-mode takes advantage of the features provided by several
227;; different versions of emacs. Rather than testing the version of
228;; emacs, several constants are defined, one for each of the features.
229;; Each of the tests below must work on any version of emacs.
230;; (Perhaps provide and featurep could be used for this purpose.)
231
1a3a6707 232(defconst isearch-gnu-emacs-events (fboundp 'set-frame-height)) ;; emacs 19
08200510 233(defconst isearch-pre-command-hook-exists (boundp 'pre-command-hook)) ;; lemacs
a5dcf63f 234(defconst isearch-event-data-type nil) ;; lemacs
08200510 235
fdf5afa4 236(defconst search-exit-option t
a8f783b2 237 "*Non-nil means random control characters terminate incremental search.")
fdf5afa4
RS
238
239(defvar search-slow-window-lines 1
240 "*Number of lines in slow search display windows.
241These are the short windows used during incremental search on slow terminals.
242Negative means put the slow search window at the top (normally it's at bottom)
243and the value is minus the number of lines.")
244
245(defvar search-slow-speed 1200
246 "*Highest terminal speed at which to use \"slow\" style incremental search.
247This is the style where a one-line window is created to show the line
248that the search has reached.")
8e1cae6d
JB
249
250;;;========================================================================
251;;; Some additional options and constants.
252
fdf5afa4 253(defvar search-upper-case t
8e1cae6d 254 "*If non-nil, upper case chars disable case fold searching.
08200510
RS
255That is, upper and lower case chars must match exactly.
256This applies no matter where the chars come from, but does not
fdf5afa4
RS
257apply to chars in regexps that are prefixed with `\\'.
258If this value is `not-yanks', yanked text is always downcased.")
8e1cae6d
JB
259
260(defvar search-nonincremental-instead t
261 "*If non-nil, do a nonincremental search instead if exiting immediately.
08200510
RS
262Actually, `isearch-edit-string' is called to let you enter the search
263string, and RET terminates editing and does a nonincremental search.")
8e1cae6d
JB
264
265(defconst search-whitespace-regexp "\\s-+"
266 "*If non-nil, regular expression to match a sequence of whitespace chars.
267You might want to use something like \"[ \\t\\r\\n]+\" instead.")
268
a8f783b2
RS
269;; I removed the * from the doc string because highlighting is not
270;; currently a clean thing to do. Once highlighting is made clean,
271;; this feature can be re-enabled and advertised.
08200510 272(defvar search-highlight nil
a8f783b2 273 "Whether isearch and query-replace should highlight the text which
08200510
RS
274currently matches the search-string.")
275
276
277(defvar isearch-mode-hook nil
278 "Function(s) to call after starting up an incremental search.")
279
280(defvar isearch-mode-end-hook nil
281 "Function(s) to call after terminating an incremental search.")
282
8e1cae6d
JB
283;;;==================================================================
284;;; Search ring.
8e1cae6d
JB
285
286(defvar search-ring nil
287 "List of search string sequences.")
08200510 288(defvar regexp-search-ring nil
8e1cae6d
JB
289 "List of regular expression search string sequences.")
290
291(defconst search-ring-max 16
292 "*Maximum length of search ring before oldest elements are thrown away.")
08200510
RS
293(defconst regexp-search-ring-max 16
294 "*Maximum length of regexp search ring before oldest elements are thrown away.")
8e1cae6d
JB
295
296(defvar search-ring-yank-pointer nil
a5dcf63f
RS
297 "Index in `search-ring' of last string reused.
298nil if none yet.")
08200510 299(defvar regexp-search-ring-yank-pointer nil
a5dcf63f
RS
300 "Index in `regexp-search-ring' of last string reused.
301nil if none yet.")
8e1cae6d 302
08200510
RS
303(defvar search-ring-update nil
304 "*Non-nil if advancing or retreating in the search ring should cause search.
305Default value, nil, means edit the string instead.")
306
8e1cae6d
JB
307;;;====================================================
308;;; Define isearch-mode keymap.
309
310(defvar isearch-mode-map nil
311 "Keymap for isearch-mode.")
312
08200510
RS
313(or isearch-mode-map
314 (let* ((i 0)
fdf5afa4 315 (map (make-keymap)))
08200510 316
ac689515
RS
317 ;; Make function keys, etc, exit the search.
318 (define-key map [t] 'isearch-other-control-char)
08200510 319 ;; Control chars, by default, end isearch mode transparently.
ac689515
RS
320 ;; We need these explicit definitions because, in a dense keymap,
321 ;; the binding for t does not affect characters.
322 ;; We use a dense keymap to save space.
08200510
RS
323 (while (< i ?\ )
324 (define-key map (make-string 1 i) 'isearch-other-control-char)
325 (setq i (1+ i)))
326
327 ;; Printing chars extend the selection by default.
ac689515 328 (setq i ?\ )
fdf5afa4 329 (while (< i 128)
08200510
RS
330 (define-key map (make-string 1 i) 'isearch-printing-char)
331 (setq i (1+ i)))
332
333 ;; Several non-printing chars change the searching behavior.
334 (define-key map "\C-s" 'isearch-repeat-forward)
335 (define-key map "\C-r" 'isearch-repeat-backward)
336 (define-key map "\177" 'isearch-delete-char)
337 (define-key map "\C-g" 'isearch-abort)
8e1cae6d 338
08200510
RS
339 (define-key map "\C-q" 'isearch-quote-char)
340
08200510
RS
341 (define-key map "\r" 'isearch-exit)
342 (define-key map "\C-j" 'isearch-printing-char)
343 (define-key map "\t" 'isearch-printing-char)
344 (define-key map " " 'isearch-whitespace-chars)
8e1cae6d 345
08200510
RS
346 (define-key map "\C-w" 'isearch-yank-word)
347 (define-key map "\C-y" 'isearch-yank-line)
348
e7cb0106
RS
349 ;; Bind the ASCII-equivalent "function keys" explicitly
350 ;; if we bind their equivalents,
351 ;; since otherwise the default binding would override.
352 ;; We bind [escape] below.
353 (define-key map [tab] 'isearch-printing-char)
354 (define-key map [delete] 'isearch-delete-char)
355 (define-key map [backspace] 'isearch-delete-char)
356 (define-key map [return] 'isearch-exit)
357 (define-key map [newline] 'isearch-printing-char)
358
08200510
RS
359 ;; Define keys for regexp chars * ? |.
360 ;; Nothing special for + because it matches at least once.
361 (define-key map "*" 'isearch-*-char)
362 (define-key map "?" 'isearch-*-char)
363 (define-key map "|" 'isearch-|-char)
364
58f1634a
RS
365;;; Turned off because I find I expect to get the global definition--rms.
366;;; ;; Instead bind C-h to special help command for isearch-mode.
367;;; (define-key map "\C-h" 'isearch-mode-help)
08200510
RS
368
369 ;; To handle local bindings with meta char prefix keys, define
370 ;; another full keymap. This must be done for any other prefix
371 ;; keys as well, one full keymap per char of the prefix key. It
372 ;; would be simpler to disable the global keymap, and/or have a
373 ;; default local key binding for any key not otherwise bound.
e7cb0106
RS
374 (let ((meta-map (make-sparse-keymap)))
375 (define-key map (char-to-string meta-prefix-char) meta-map)
376 (define-key map [escape] meta-map))
ac689515 377 (define-key map (vector meta-prefix-char t) 'isearch-other-meta-char)
08200510
RS
378
379 (define-key map "\M-n" 'isearch-ring-advance)
380 (define-key map "\M-p" 'isearch-ring-retreat)
1a3a6707 381
08200510
RS
382 (define-key map "\M-\t" 'isearch-complete)
383
384 ;; For emacs 19, switching frames should terminate isearch-mode
1a3a6707 385 (if isearch-gnu-emacs-events
08200510
RS
386 (define-key map [switch-frame] 'isearch-switch-frame-handler))
387
388 (setq isearch-mode-map map)
389 ))
8e1cae6d 390
08200510
RS
391;; Some bindings you may want to put in your isearch-mode-hook.
392;; Suggest some alternates...
393;; (define-key isearch-mode-map "\C-t" 'isearch-toggle-regexp)
394;; (define-key isearch-mode-map "\C-^" 'isearch-edit-string)
8e1cae6d 395
8e1cae6d 396
08200510
RS
397(defvar minibuffer-local-isearch-map nil
398 "Keymap for editing isearch strings in the minibuffer.")
8e1cae6d 399
08200510
RS
400(or minibuffer-local-isearch-map
401 (let ((map (copy-keymap minibuffer-local-map)))
402 (define-key map "\r" 'isearch-nonincremental-exit-minibuffer)
35a4d143
RS
403 (define-key map "\M-n" 'isearch-ring-advance-edit)
404 (define-key map "\M-p" 'isearch-ring-retreat-edit)
08200510
RS
405 (define-key map "\M-\t" 'isearch-complete-edit)
406 (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
407 (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
408 (setq minibuffer-local-isearch-map map)
409 ))
8e1cae6d
JB
410
411;;;========================================================
412;; Internal variables declared globally for byte-compiler.
08200510
RS
413;; These are all set with setq while isearching
414;; and bound locally while editing the search string.
415
416(defvar isearch-forward nil) ; Searching in the forward direction.
417(defvar isearch-regexp nil) ; Searching for a regexp.
418(defvar isearch-word nil) ; Searching for words.
419
420(defvar isearch-cmds nil) ; Stack of search status sets.
421(defvar isearch-string "") ; The current search string.
422(defvar isearch-message "") ; text-char-description version of isearch-string
423
424(defvar isearch-success t) ; Searching is currently successful.
425(defvar isearch-invalid-regexp nil) ; Regexp not well formed.
426(defvar isearch-other-end nil) ; Start (end) of match if forward (backward).
427(defvar isearch-wrapped nil) ; Searching restarted from the top (bottom).
8e1cae6d
JB
428(defvar isearch-barrier 0)
429
08200510 430(defvar isearch-case-fold-search nil) ; case-fold-search while searching.
8e1cae6d
JB
431
432(defvar isearch-adjusted nil)
433(defvar isearch-slow-terminal-mode nil)
08200510
RS
434;;; If t, using a small window.
435(defvar isearch-small-window nil)
8e1cae6d 436(defvar isearch-opoint 0)
08200510
RS
437;;; The window configuration active at the beginning of the search.
438(defvar isearch-window-configuration nil)
439(defvar isearch-old-local-map nil)
8e1cae6d 440
08200510
RS
441;; Flag to indicate a yank occurred, so don't move the cursor.
442(defvar isearch-yank-flag nil)
8e1cae6d 443
08200510
RS
444;;; A function to be called after each input character is processed.
445;;; (It is not called after characters that exit the search.)
446;;; It is only set from an optional argument to `isearch-mode'.
447(defvar isearch-op-fun nil)
8e1cae6d 448
08200510
RS
449;;; Is isearch-mode in a recursive edit for modal searching.
450(defvar isearch-recursive-edit nil)
8e1cae6d 451
08200510
RS
452;;; Should isearch be terminated after doing one search?
453(defvar isearch-nonincremental nil)
454
455;; New value of isearch-forward after isearch-edit-string.
456(defvar isearch-new-forward nil)
8e1cae6d 457
8e1cae6d
JB
458
459;;;==============================================================
460;; Minor-mode-alist changes - kind of redundant with the
461;; echo area, but if isearching in multiple windows, it can be useful.
462
463(or (assq 'isearch-mode minor-mode-alist)
464 (nconc minor-mode-alist
465 (list '(isearch-mode isearch-mode))))
466
08200510 467(defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
8e1cae6d
JB
468(make-variable-buffer-local 'isearch-mode)
469
fdf5afa4
RS
470(define-key global-map "\C-s" 'isearch-forward)
471(define-key esc-map "\C-s" 'isearch-forward-regexp)
472(define-key global-map "\C-r" 'isearch-backward)
473(define-key esc-map "\C-r" 'isearch-backward-regexp)
474
8e1cae6d
JB
475;;;===============================================================
476;;; Entry points to isearch-mode.
08200510 477;;; These four functions should replace those in loaddefs.el
b457cc3b 478;;; An alternative is to defalias isearch-forward etc to isearch-mode,
08200510 479;;; and look at this-command to set the options accordingly.
8e1cae6d 480
eceee2c0 481(defun isearch-forward (&optional regexp-p no-recursive-edit)
8e1cae6d
JB
482 "\
483Do incremental search forward.
08200510
RS
484With a prefix argument, do an incremental regular expression search instead.
485\\<isearch-mode-map>
8e1cae6d 486As you type characters, they add to the search string and are found.
08200510 487The following non-printing keys are bound in `isearch-mode-map'.
8e1cae6d 488
08200510 489Type \\[isearch-delete-char] to cancel characters from end of search string.
8e1cae6d 490Type \\[isearch-exit] to exit, leaving point at location found.
08200510
RS
491Type LFD (C-j) to match end of line.
492Type \\[isearch-repeat-forward] to search again forward,\
493 \\[isearch-repeat-backward] to search again backward.
494Type \\[isearch-yank-word] to yank word from buffer onto end of search\
495 string and search for it.
496Type \\[isearch-yank-line] to yank rest of line onto end of search string\
497 and search for it.
8e1cae6d 498Type \\[isearch-quote-char] to quote control character to search for it.
08200510
RS
499Type \\[isearch-whitespace-chars] to match all whitespace chars in regexp.
500\\[isearch-abort] while searching or when search has failed cancels input\
501 back to what has
502 been found successfully.
503\\[isearch-abort] when search is successful aborts and moves point to\
504 starting point.
8e1cae6d
JB
505
506Also supported is a search ring of the previous 16 search strings.
507Type \\[isearch-ring-advance] to search for the next item in the search ring.
08200510
RS
508Type \\[isearch-ring-retreat] to search for the previous item in the search\
509 ring.
510Type \\[isearch-complete] to complete the search string using the search ring.
8e1cae6d 511
08200510
RS
512The above keys, bound in `isearch-mode-map', are often controlled by
513 options; do M-x apropos on search-.* to find them.
8e1cae6d 514Other control and meta characters terminate the search
08200510 515 and are then executed normally (depending on `search-exit-option').
8e1cae6d 516
08200510
RS
517If this function is called non-interactively, it does not return to
518the calling function until the search is done."
8e1cae6d 519
eceee2c0 520 (interactive "P\np")
4ae7d00a 521 (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
8e1cae6d 522
eceee2c0 523(defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
8e1cae6d
JB
524 "\
525Do incremental search forward for regular expression.
08200510 526With a prefix argument, do a regular string search instead.
8e1cae6d
JB
527Like ordinary incremental search except that your input
528is treated as a regexp. See \\[isearch-forward] for more info."
eceee2c0 529 (interactive "P\np")
4ae7d00a 530 (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
8e1cae6d 531
eceee2c0 532(defun isearch-backward (&optional regexp-p no-recursive-edit)
8e1cae6d
JB
533 "\
534Do incremental search backward.
08200510 535With a prefix argument, do a regular expression search instead.
8e1cae6d 536See \\[isearch-forward] for more information."
eceee2c0 537 (interactive "P\np")
4ae7d00a 538 (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
8e1cae6d 539
eceee2c0 540(defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
8e1cae6d
JB
541 "\
542Do incremental search backward for regular expression.
08200510 543With a prefix argument, do a regular string search instead.
8e1cae6d
JB
544Like ordinary incremental search except that your input
545is treated as a regexp. See \\[isearch-forward] for more info."
eceee2c0 546 (interactive "P\np")
4ae7d00a 547 (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
08200510
RS
548
549
550(defun isearch-mode-help ()
551 (interactive)
552 (describe-function 'isearch-forward)
553 (isearch-update))
8e1cae6d
JB
554
555\f
556;;;==================================================================
557;; isearch-mode only sets up incremental search for the minor mode.
558;; All the work is done by the isearch-mode commands.
559
08200510
RS
560;; Not used yet:
561;;(defconst isearch-commands '(isearch-forward isearch-backward
562;; isearch-forward-regexp isearch-backward-regexp)
563;; "List of commands for which isearch-mode does not recursive-edit.")
564
565
566(defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p)
8e1cae6d 567 "Start isearch minor mode. Called by isearch-forward, etc."
8e1cae6d
JB
568
569 ;; Initialize global vars.
570 (setq isearch-forward forward
571 isearch-regexp regexp
08200510 572 isearch-word word-p
8e1cae6d
JB
573 isearch-op-fun op-fun
574 isearch-case-fold-search case-fold-search
575 isearch-string ""
576 isearch-message ""
577 isearch-cmds nil
578 isearch-success t
579 isearch-wrapped nil
580 isearch-barrier (point)
581 isearch-adjusted nil
582 isearch-yank-flag nil
583 isearch-invalid-regexp nil
dd492f04
JA
584 ;; Use (baud-rate) for now, for sake of other versions.
585 isearch-slow-terminal-mode (and (<= (baud-rate) search-slow-speed)
8e1cae6d
JB
586 (> (window-height)
587 (* 4 search-slow-window-lines)))
588 isearch-other-end nil
589 isearch-small-window nil
8e1cae6d 590
8e1cae6d
JB
591 isearch-opoint (point)
592 isearch-window-configuration (current-window-configuration)
a5dcf63f
RS
593 isearch-old-local-map (current-local-map)
594 search-ring-yank-pointer nil
595 regexp-search-ring-yank-pointer nil)
2ed45c8b
RS
596;; This was for Lucid Emacs. But now that we have pre-command-hook,
597;; it causes trouble.
598;; (if isearch-pre-command-hook-exists
599;; (add-hook 'pre-command-hook 'isearch-pre-command-hook))
8e1cae6d
JB
600 (setq isearch-mode " Isearch") ;; forward? regexp?
601 (set-buffer-modified-p (buffer-modified-p)) ; update modeline
602
603 (isearch-push-state)
604
605 (use-local-map isearch-mode-map)
606 (isearch-update)
607 (run-hooks 'isearch-mode-hook)
08200510
RS
608
609 ;; isearch-mode can be made modal (in the sense of not returning to
610 ;; the calling function until searching is completed) by entering
611 ;; a recursive-edit and exiting it when done isearching.
612 (if recursive-edit (recursive-edit))
8e1cae6d
JB
613 )
614
615
616;;;====================================================
617;; Some high level utilities. Others below.
618
619(defun isearch-update ()
620 ;; Called after each command to update the display.
a5dcf63f 621 (if (if isearch-event-data-type
08200510 622 (null unread-command-event)
1a3a6707 623 (if isearch-gnu-emacs-events
dbc4e1c1 624 (null unread-command-events)
08200510 625 (< unread-command-char 0)))
8e1cae6d
JB
626 (progn
627 (if (not (input-pending-p))
628 (isearch-message))
629 (if (and isearch-slow-terminal-mode
630 (not (or isearch-small-window
631 (pos-visible-in-window-p))))
08200510 632 (let ((found-point (point)))
8e1cae6d 633 (setq isearch-small-window t)
8e1cae6d
JB
634 (move-to-window-line 0)
635 (let ((window-min-height 1))
636 (split-window nil (if (< search-slow-window-lines 0)
637 (1+ (- search-slow-window-lines))
638 (- (window-height)
639 (1+ search-slow-window-lines)))))
640 (if (< search-slow-window-lines 0)
641 (progn (vertical-motion (- 1 search-slow-window-lines))
642 (set-window-start (next-window) (point))
643 (set-window-hscroll (next-window)
644 (window-hscroll))
645 (set-window-hscroll (selected-window) 0))
646 (other-window 1))
08200510
RS
647 (goto-char found-point)))
648 (if isearch-other-end
649 (if (< isearch-other-end (point)) ; isearch-forward?
650 (isearch-highlight isearch-other-end (point))
651 (isearch-highlight (point) isearch-other-end)))
652 ))
8e1cae6d
JB
653 (setq ;; quit-flag nil not for isearch-mode
654 isearch-adjusted nil
655 isearch-yank-flag nil)
656 )
657
658
35a4d143 659(defun isearch-done (&optional nopush)
8e1cae6d 660 ;; Called by all commands that terminate isearch-mode.
35a4d143 661 ;; If NOPUSH is non-nil, we don't push the string on the search ring.
8e1cae6d 662 (use-local-map isearch-old-local-map)
08200510
RS
663 ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
664 (isearch-dehighlight t)
665 (let ((found-start (window-start (selected-window)))
666 (found-point (point)))
667 (set-window-configuration isearch-window-configuration)
668
669 ;; If there was movement, mark the starting position.
670 ;; Maybe should test difference between and set mark iff > threshold.
671 (if (/= (point) isearch-opoint)
7872ee4d
RS
672 (progn
673 (push-mark isearch-opoint t)
674 (or executing-macro (> (minibuffer-depth) 0)
675 (message "Mark saved where search started")))
08200510
RS
676 ;; (message "") why is this needed?
677 )
678 (if isearch-small-window
679 (goto-char found-point)
680 ;; Exiting the save-window-excursion clobbers window-start; restore it.
681 (set-window-start (selected-window) found-start t)))
682
683 (setq isearch-mode nil)
684 (set-buffer-modified-p (buffer-modified-p)) ;; update modeline
8e1cae6d 685
35a4d143 686 (if (and (> (length isearch-string) 0) (not nopush))
8e1cae6d
JB
687 ;; Update the ring data.
688 (if isearch-regexp
a8f783b2
RS
689 (if (or (null regexp-search-ring)
690 (not (string= isearch-string (car regexp-search-ring))))
8e1cae6d 691 (progn
08200510 692 (setq regexp-search-ring
a5dcf63f 693 (cons isearch-string regexp-search-ring))
08200510
RS
694 (if (> (length regexp-search-ring) regexp-search-ring-max)
695 (setcdr (nthcdr (1- search-ring-max) regexp-search-ring)
8e1cae6d 696 nil))))
a8f783b2
RS
697 (if (or (null search-ring)
698 (not (string= isearch-string (car search-ring))))
8e1cae6d 699 (progn
a5dcf63f 700 (setq search-ring (cons isearch-string search-ring))
8e1cae6d
JB
701 (if (> (length search-ring) search-ring-max)
702 (setcdr (nthcdr (1- search-ring-max) search-ring) nil))))))
703
8e1cae6d 704 (run-hooks 'isearch-mode-end-hook)
08200510
RS
705 (if isearch-recursive-edit (exit-recursive-edit)))
706
707;;;=======================================================
708;;; Switching buffers should first terminate isearch-mode.
709;;; This is done quite differently for each varient of emacs.
710;;; For lemacs, see Exiting in lemacs below
711
712;; For Emacs 19, the frame switch event is handled.
713(defun isearch-switch-frame-handler ()
714 (interactive) ;; Is this necessary?
715 ;; First terminate isearch-mode.
716 (isearch-done)
dba1ec55 717 (handle-switch-frame (car (cdr (isearch-last-command-char)))))
08200510
RS
718
719;;;========================================================
8e1cae6d
JB
720
721\f
722;;;====================================================
723;; Commands active while inside of the isearch minor mode.
724
725(defun isearch-exit ()
726 "Exit search normally.
727However, if this is the first command after starting incremental
728search and `search-nonincremental-instead' is non-nil, do a
08200510 729nonincremental search instead via `isearch-edit-string'."
8e1cae6d
JB
730 (interactive)
731 (if (and search-nonincremental-instead
732 (= 0 (length isearch-string)))
08200510
RS
733 (let ((isearch-nonincremental t))
734 (isearch-edit-string)))
8e1cae6d
JB
735 (isearch-done))
736
737
738(defun isearch-edit-string ()
08200510
RS
739 "Edit the search string in the minibuffer.
740The following additional command keys are active while editing.
741\\<minibuffer-local-isearch-map>
742\\[exit-minibuffer] to resume incremental searching with the edited string.
743\\[isearch-nonincremental-exit-minibuffer] to do one nonincremental search.
744\\[isearch-forward-exit-minibuffer] to resume isearching forward.
745\\[isearch-backward-exit-minibuffer] to resume isearching backward.
746\\[isearch-ring-advance-edit] to replace the search string with the next item in the search ring.
747\\[isearch-ring-retreat-edit] to replace the search string with the previou item in the search ring.
748\\[isearch-complete-edit] to complete the search string using the search ring.
749
750If first char entered is \\[isearch-yank-word], then do word search instead."
751
752 ;; This code is very hairy for several reasons, explained in the code.
753 ;; Mainly, isearch-mode must be terminated while editing and then restarted.
754 ;; If there were a way to catch any change of buffer from the minibuffer,
755 ;; this could be simplified greatly.
756 ;; Editing doesnt back up the search point. Should it?
8e1cae6d 757 (interactive)
08200510 758 (condition-case err
a5dcf63f 759 (let (isearch-nonincremental ; should search nonincrementally?
08200510
RS
760
761 ;; Locally bind all isearch global variables to protect them
762 ;; from recursive isearching.
763 ;; isearch-string -message and -forward are not bound
764 ;; so they may be changed. Instead, save the values.
765 (isearch-new-string isearch-string)
766 (isearch-new-message isearch-message)
767 (isearch-new-forward isearch-forward)
768 (isearch-new-word isearch-word)
769
770 (isearch-regexp isearch-regexp)
771 (isearch-op-fun isearch-op-fun)
772 (isearch-cmds isearch-cmds)
773 (isearch-success isearch-success)
774 (isearch-wrapped isearch-wrapped)
775 (isearch-barrier isearch-barrier)
776 (isearch-adjusted isearch-adjusted)
777 (isearch-yank-flag isearch-yank-flag)
778 (isearch-invalid-regexp isearch-invalid-regexp)
779 (isearch-other-end isearch-other-end)
780 (isearch-opoint isearch-opoint)
781 (isearch-slow-terminal-mode isearch-slow-terminal-mode)
782 (isearch-small-window isearch-small-window)
783 (isearch-recursive-edit isearch-recursive-edit)
784 ;; Save current configuration so we can restore it here.
785 (isearch-window-configuration (current-window-configuration))
786 )
787
788 ;; Actually terminate isearching until editing is done.
789 ;; This is so that the user can do anything without failure,
790 ;; like switch buffers and start another isearch, and return.
791 (condition-case err
35a4d143 792 (isearch-done t)
08200510
RS
793 (exit nil)) ; was recursive editing
794
795 (isearch-message) ;; for read-char
796 (unwind-protect
797 (let* (;; Why does following read-char echo?
798 ;;(echo-keystrokes 0) ;; not needed with above message
d94307ee
RS
799 (e (let ((cursor-in-echo-area t))
800 (if isearch-event-data-type
801 (allocate-event) (read-char))))
08200510
RS
802 ;; Binding minibuffer-history-symbol to nil is a work-around
803 ;; for some incompatibility with gmhist.
804 (minibuffer-history-symbol))
805 ;; If the first character the user types when we prompt them
806 ;; for a string is the yank-word character, then go into
807 ;; word-search mode. Otherwise unread that character and
808 ;; read a key the normal way.
809 ;; Word search does not apply (yet) to regexp searches,
810 ;; no check is made here.
811 (message (isearch-message-prefix nil nil t))
812 (if (eq 'isearch-yank-word
813 (lookup-key
814 isearch-mode-map
815 (char-to-string
a5dcf63f 816 (if isearch-event-data-type
08200510
RS
817 (or (event-to-character (next-command-event e)) 0)
818 e))))
819 (setq isearch-word t ;; so message-prefix is right
820 isearch-new-word t)
821 (isearch-unread e))
a5dcf63f
RS
822 (setq cursor-in-echo-area nil)
823 (setq isearch-new-string
35a4d143 824 (let (junk-ring)
a5dcf63f
RS
825 (read-from-minibuffer (isearch-message-prefix)
826 isearch-string
827 minibuffer-local-isearch-map nil
35a4d143 828 'junk-ring))
08200510
RS
829 isearch-new-message (mapconcat 'text-char-description
830 isearch-new-string "")))
831 ;; Always resume isearching by restarting it.
832 (isearch-mode isearch-forward
833 isearch-regexp
834 isearch-op-fun
835 isearch-recursive-edit
836 isearch-word)
837
838 ;; Copy new local values to isearch globals
839 (setq isearch-string isearch-new-string
840 isearch-message isearch-new-message
841 isearch-forward isearch-new-forward
842 isearch-word isearch-new-word))
843
844 ;; Empty isearch-string means use default.
845 (if (= 0 (length isearch-string))
a8f783b2
RS
846 (setq isearch-string (car (if isearch-regexp regexp-search-ring
847 search-ring)))
848 ;; This used to set the last search string,
849 ;; but I think it is not right to do that here.
850 ;; Only the string actually used should be saved.
851 )
08200510
RS
852
853 ;; Reinvoke the pending search.
854 (isearch-push-state)
855 (isearch-search)
856 (isearch-update)
857 (if isearch-nonincremental
858 (progn
859 ;; (sit-for 1) ;; needed if isearch-done does: (message "")
860 (isearch-done))))
8e1cae6d 861
08200510
RS
862 (quit ; handle abort-recursive-edit
863 (isearch-abort) ;; outside of let to restore outside global values
864 )))
865
866(defun isearch-nonincremental-exit-minibuffer ()
867 (interactive)
868 (setq isearch-nonincremental t)
869 (exit-minibuffer))
870
871(defun isearch-forward-exit-minibuffer ()
872 (interactive)
873 (setq isearch-new-forward t)
874 (exit-minibuffer))
8e1cae6d 875
08200510 876(defun isearch-reverse-exit-minibuffer ()
8e1cae6d 877 (interactive)
08200510
RS
878 (setq isearch-new-forward nil)
879 (exit-minibuffer))
880
881
882(defun isearch-abort ()
883 "Abort incremental search mode if searching is successful, signalling quit.
884Otherwise, revert to previous successful search and continue searching.
885Use `isearch-exit' to quit without signalling."
886 (interactive)
887;; (ding) signal instead below, if quiting
8e1cae6d
JB
888 (discard-input)
889 (if isearch-success
890 ;; If search is successful, move back to starting point
891 ;; and really do quit.
892 (progn (goto-char isearch-opoint)
35a4d143 893 (isearch-done t) ; exit isearch
a5dcf63f 894 (signal 'quit nil)) ; and pass on quit signal
08200510 895 ;; If search is failing, rub out until it is once more successful.
8e1cae6d
JB
896 (while (not isearch-success) (isearch-pop-state))
897 (isearch-update)))
898
899
900(defun isearch-repeat (direction)
901 ;; Utility for isearch-repeat-forward and -backward.
902 (if (eq isearch-forward (eq direction 'forward))
903 ;; C-s in forward or C-r in reverse.
904 (if (equal isearch-string "")
905 ;; If search string is empty, use last one.
906 (setq isearch-string
8e1cae6d 907 (or (if isearch-regexp
a5dcf63f
RS
908 (car regexp-search-ring)
909 (car search-ring))
8e1cae6d
JB
910 "")
911 isearch-message
08200510 912 (mapconcat 'isearch-text-char-description
8e1cae6d
JB
913 isearch-string ""))
914 ;; If already have what to search for, repeat it.
915 (or isearch-success
916 (progn
917
918 (goto-char (if isearch-forward (point-min) (point-max)))
919 (setq isearch-wrapped t))))
920 ;; C-s in reverse or C-r in forward, change direction.
921 (setq isearch-forward (not isearch-forward)))
922
923 (setq isearch-barrier (point)) ; For subsequent \| if regexp.
924 (setq isearch-success t)
925 (or (equal isearch-string "")
926 (progn
927 ;; If repeating a search that found
928 ;; an empty string, ensure we advance.
929 (if (equal (match-end 0) (match-beginning 0))
930 (forward-char (if isearch-forward 1 -1)))
931 (isearch-search)))
932 (isearch-push-state)
933 (isearch-update))
934
935(defun isearch-repeat-forward ()
936 "Repeat incremental search forwards."
937 (interactive)
938 (isearch-repeat 'forward))
939
940(defun isearch-repeat-backward ()
941 "Repeat incremental search backwards."
942 (interactive)
943 (isearch-repeat 'backward))
944
945(defun isearch-toggle-regexp ()
946 "Toggle regexp searching on or off."
947 ;; The status stack is left unchanged.
948 (interactive)
949 (setq isearch-regexp (not isearch-regexp))
08200510 950 (if isearch-regexp (setq isearch-word nil))
8e1cae6d
JB
951 (isearch-update))
952
953(defun isearch-delete-char ()
954 "Discard last input item and move point back.
955If no previous match was done, just beep."
956 (interactive)
957 (if (null (cdr isearch-cmds))
958 (ding)
959 (isearch-pop-state))
960 (isearch-update))
961
962
963(defun isearch-yank (chunk)
964 ;; Helper for isearch-yank-word and isearch-yank-line
08200510
RS
965 (let ((string (save-excursion
966 (and (not isearch-forward) isearch-other-end
967 (goto-char isearch-other-end))
968 (buffer-substring
969 (point)
970 (save-excursion
971 (cond
972 ((eq chunk 'word)
973 (forward-word 1))
974 ((eq chunk 'line)
975 (end-of-line)))
976 (point))))))
977 ;; Downcase the string if not supposed to case-fold yanked strings.
978 (if (and isearch-case-fold-search
fdf5afa4 979 (eq 'not-yanks search-upper-case))
08200510
RS
980 (setq string (downcase string)))
981 (if isearch-regexp (setq string (regexp-quote string)))
982 (setq isearch-string (concat isearch-string string)
8e1cae6d
JB
983 isearch-message
984 (concat isearch-message
08200510
RS
985 (mapconcat 'isearch-text-char-description
986 string ""))
8e1cae6d
JB
987 ;; Don't move cursor in reverse search.
988 isearch-yank-flag t))
989 (isearch-search-and-update))
990
991
992(defun isearch-yank-word ()
993 "Pull next word from buffer into search string."
994 (interactive)
995 (isearch-yank 'word))
996
997(defun isearch-yank-line ()
998 "Pull rest of line from buffer into search string."
999 (interactive)
1000 (isearch-yank 'line))
1001
1002
1003(defun isearch-search-and-update ()
1004 ;; Do the search and update the display.
1005 (if (and (not isearch-success)
1006 ;; unsuccessful regexp search may become
1007 ;; successful by addition of characters which
1008 ;; make isearch-string valid
1009 (not isearch-regexp))
1010 nil
1011 ;; In reverse search, adding stuff at
1012 ;; the end may cause zero or many more chars to be
1013 ;; matched, in the string following point.
1014 ;; Allow all those possibilities without moving point as
1015 ;; long as the match does not extend past search origin.
1016 (if (and (not isearch-forward) (not isearch-adjusted)
1017 (condition-case ()
1018 (looking-at (if isearch-regexp isearch-string
1019 (regexp-quote isearch-string)))
1020 (error nil))
1021 (or isearch-yank-flag
1022 (<= (match-end 0)
1023 (min isearch-opoint isearch-barrier))))
1024 (setq isearch-success t
1025 isearch-invalid-regexp nil
1026 isearch-other-end (match-end 0))
1027 ;; Not regexp, not reverse, or no match at point.
1028 (if (and isearch-other-end (not isearch-adjusted))
1029 (goto-char (if isearch-forward isearch-other-end
1030 (min isearch-opoint
1031 isearch-barrier
1032 (1+ isearch-other-end)))))
1033 (isearch-search)
1034 ))
1035 (isearch-push-state)
1036 (if isearch-op-fun (funcall isearch-op-fun))
1037 (isearch-update))
1038
1039
1040;; *, ?, and | chars can make a regexp more liberal.
08200510 1041;; They can make a regexp match sooner or make it succeed instead of failing.
8e1cae6d
JB
1042;; So go back to place last successful search started
1043;; or to the last ^S/^R (barrier), whichever is nearer.
08200510 1044;; + needs no special handling because the string must match at least once.
8e1cae6d
JB
1045
1046(defun isearch-*-char ()
1047 "Handle * and ? specially in regexps."
1048 (interactive)
1049 (if isearch-regexp
1050
1051 (progn
1052 (setq isearch-adjusted t)
1053 (let ((cs (nth (if isearch-forward
1054 5 ; isearch-other-end
1055 2) ; saved (point)
1056 (car (cdr isearch-cmds)))))
1057 ;; (car isearch-cmds) is after last search;
1058 ;; (car (cdr isearch-cmds)) is from before it.
1059 (setq cs (or cs isearch-barrier))
1060 (goto-char
1061 (if isearch-forward
1062 (max cs isearch-barrier)
1063 (min cs isearch-barrier))))))
08200510 1064 (isearch-process-search-char (isearch-last-command-char)))
8e1cae6d
JB
1065
1066
8e1cae6d
JB
1067(defun isearch-|-char ()
1068 "If in regexp search, jump to the barrier."
1069 (interactive)
1070 (if isearch-regexp
1071 (progn
1072 (setq isearch-adjusted t)
1073 (goto-char isearch-barrier)))
08200510 1074 (isearch-process-search-char (isearch-last-command-char)))
8e1cae6d
JB
1075
1076
b457cc3b 1077(defalias 'isearch-other-control-char 'isearch-other-meta-char)
8e1cae6d
JB
1078
1079(defun isearch-other-meta-char ()
8f90f594 1080 "Exit the search normally and reread this key sequence.
35a4d143
RS
1081But only if `search-exit-option' is non-nil, the default.
1082If it is the symbol `edit', the search string is edited in the minibuffer
1083and the meta character is unread so that it applies to editing the string."
8e1cae6d 1084 (interactive)
35a4d143
RS
1085 (cond ((eq search-exit-option 'edit)
1086 (let ((key (this-command-keys)))
e7cb0106 1087 (apply 'isearch-unread (listify-key-sequence key)))
35a4d143
RS
1088 (isearch-edit-string))
1089 (search-exit-option
1090 (let ((key (this-command-keys)))
e7cb0106 1091 (apply 'isearch-unread (listify-key-sequence key)))
35a4d143
RS
1092 (isearch-done))
1093 (t;; otherwise nil
1094 (isearch-process-search-string (this-command-keys)
1095 (this-command-keys)))))
8e1cae6d
JB
1096
1097
1098(defun isearch-quote-char ()
1099 "Quote special characters for incremental search."
1100 (interactive)
1101 (isearch-process-search-char (read-quoted-char (isearch-message t))))
1102
8e1cae6d
JB
1103(defun isearch-return-char ()
1104 "Convert return into newline for incremental search.
1105Obsolete."
1106 (interactive)
1107 (isearch-process-search-char ?\n))
1108
8e1cae6d 1109(defun isearch-printing-char ()
b68c164d 1110 "Add this ordinary printing character to the search string and search."
8e1cae6d 1111 (interactive)
08200510 1112 (isearch-process-search-char (isearch-last-command-char)))
8e1cae6d
JB
1113
1114(defun isearch-whitespace-chars ()
08200510 1115 "Match all whitespace chars, if in regexp mode.
b68c164d 1116If you want to search for just a space, type C-q SPC."
8e1cae6d 1117 (interactive)
08200510
RS
1118 (if isearch-regexp
1119 (if search-whitespace-regexp
1120 (isearch-process-search-string search-whitespace-regexp " ")
1121 (isearch-printing-char))
1122 (progn
1123 ;; This way of doing word search doesnt correctly extend current search.
1124 ;; (setq isearch-word t)
1125 ;; (setq isearch-adjusted t)
1126 ;; (goto-char isearch-barrier)
1127 (isearch-printing-char))))
8e1cae6d
JB
1128
1129(defun isearch-process-search-char (char)
1130 ;; Append the char to the search string, update the message and re-search.
08200510
RS
1131 (isearch-process-search-string
1132 (isearch-char-to-string char)
1133 (isearch-text-char-description char)))
8e1cae6d
JB
1134
1135(defun isearch-process-search-string (string message)
1136 (setq isearch-string (concat isearch-string string)
1137 isearch-message (concat isearch-message message))
1138 (isearch-search-and-update))
1139
1140\f
1141;;===========================================================
1142;; Search Ring
1143
08200510
RS
1144(defun isearch-ring-adjust1 (advance)
1145 ;; Helper for isearch-ring-adjust
1146 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
8e1cae6d
JB
1147 (length (length ring))
1148 (yank-pointer-name (if isearch-regexp
08200510 1149 'regexp-search-ring-yank-pointer
8e1cae6d
JB
1150 'search-ring-yank-pointer))
1151 (yank-pointer (eval yank-pointer-name)))
1152 (if (zerop length)
1153 ()
1154 (set yank-pointer-name
1155 (setq yank-pointer
a5dcf63f
RS
1156 (% (+ (or yank-pointer 0)
1157 (if advance (1- length) 1))
1158 length)))
1159 (setq isearch-string (nth yank-pointer ring)
08200510
RS
1160 isearch-message (mapconcat 'isearch-text-char-description
1161 isearch-string "")))))
1162
1163(defun isearch-ring-adjust (advance)
1164 ;; Helper for isearch-ring-advance and isearch-ring-retreat
1165 (if (cdr isearch-cmds) ;; is there more than one thing on stack?
1166 (isearch-pop-state))
1167 (isearch-ring-adjust1 advance)
8e1cae6d 1168 (isearch-push-state)
08200510
RS
1169 (if search-ring-update
1170 (progn
1171 (isearch-search)
1172 (isearch-update))
1173 (isearch-edit-string)
1174 ))
8e1cae6d
JB
1175
1176(defun isearch-ring-advance ()
1177 "Advance to the next search string in the ring."
08200510 1178 ;; This could be more general to handle a prefix arg, but who would use it.
8e1cae6d
JB
1179 (interactive)
1180 (isearch-ring-adjust 'advance))
1181
1182(defun isearch-ring-retreat ()
1183 "Retreat to the previous search string in the ring."
1184 (interactive)
1185 (isearch-ring-adjust nil))
1186
a5dcf63f
RS
1187(defun isearch-ring-advance-edit (n)
1188 "Insert the next element of the search history into the minibuffer."
1189 (interactive "p")
1190 (let* ((yank-pointer-name (if isearch-regexp
1191 'regexp-search-ring-yank-pointer
1192 'search-ring-yank-pointer))
1193 (yank-pointer (eval yank-pointer-name))
1194 (ring (if isearch-regexp regexp-search-ring search-ring))
1195 (length (length ring)))
1196 (if (zerop length)
1197 ()
1198 (set yank-pointer-name
1199 (setq yank-pointer
1200 (% (+ (or yank-pointer 0)
35a4d143
RS
1201 ;; Add LENGTH here to ensure a positive result.
1202 length
1203 (% (- n) length))
a5dcf63f
RS
1204 length)))
1205
a5dcf63f 1206 (erase-buffer)
35a4d143 1207 (insert (nth yank-pointer ring))
49c13105 1208 (goto-char (point-max)))))
a5dcf63f
RS
1209
1210(defun isearch-ring-retreat-edit (n)
1211 "Inserts the previous element of the search history into the minibuffer."
1212 (interactive "p")
1213 (isearch-ring-advance-edit (- n)))
1214
1215;;(defun isearch-ring-adjust-edit (advance)
1216;; "Use the next or previous search string in the ring while in minibuffer."
1217;; (isearch-ring-adjust1 advance)
1218;; (erase-buffer)
1219;; (insert isearch-string))
1220
1221;;(defun isearch-ring-advance-edit ()
1222;; (interactive)
1223;; (isearch-ring-adjust-edit 'advance))
1224
1225;;(defun isearch-ring-retreat-edit ()
1226;; "Retreat to the previous search string in the ring while in the minibuffer."
1227;; (interactive)
1228;; (isearch-ring-adjust-edit nil))
08200510
RS
1229
1230
1231(defun isearch-complete1 ()
1232 ;; Helper for isearch-complete and isearch-complete-edit
1233 ;; Return t if completion OK, nil if no completion exists.
1234 (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
1235 (alist (mapcar (function (lambda (string) (list string))) ring))
1236 (completion-ignore-case case-fold-search)
1237 (completion (try-completion isearch-string alist)))
1238 (cond
1239 ((eq completion t)
1240 ;; isearch-string stays the same
1241 t)
1242 ((or completion ; not nil, must be a string
1243 (= 0 (length isearch-string))) ; shouldnt have to say this
1244 (if (equal completion isearch-string) ;; no extension?
1245 (if completion-auto-help
1246 (with-output-to-temp-buffer "*Isearch completions*"
1247 (display-completion-list
1248 (all-completions isearch-string alist))))
1249 (setq isearch-string completion))
1250 t)
1251 (t
1252 (message "No completion") ; waits a second if in minibuffer
1253 nil))))
1254
1255(defun isearch-complete ()
1256 "Complete the search string from the strings on the search ring.
1257The completed string is then editable in the minibuffer.
1258If there is no completion possible, say so and continue searching."
1259 (interactive)
1260 (if (isearch-complete1)
1261 (isearch-edit-string)
1262 ;; else
1263 (sit-for 1)
1264 (isearch-update)))
8e1cae6d 1265
08200510
RS
1266(defun isearch-complete-edit ()
1267 "Same as `isearch-complete' except in the minibuffer."
1268 (interactive)
1269 (setq isearch-string (buffer-string))
1270 (if (isearch-complete1)
8e1cae6d 1271 (progn
08200510
RS
1272 (erase-buffer)
1273 (insert isearch-string))))
8e1cae6d
JB
1274
1275\f
1276;;;==============================================================
1277;; The search status stack (and isearch window-local variables, not used).
08200510 1278;; Need a structure for this.
8e1cae6d
JB
1279
1280(defun isearch-top-state ()
8e1cae6d
JB
1281 (let ((cmd (car isearch-cmds)))
1282 (setq isearch-string (car cmd)
1283 isearch-message (car (cdr cmd))
1284 isearch-success (nth 3 cmd)
1285 isearch-forward (nth 4 cmd)
1286 isearch-other-end (nth 5 cmd)
08200510
RS
1287 isearch-word (nth 6 cmd)
1288 isearch-invalid-regexp (nth 7 cmd)
1289 isearch-wrapped (nth 8 cmd)
1290 isearch-barrier (nth 9 cmd))
8e1cae6d
JB
1291 (goto-char (car (cdr (cdr cmd))))))
1292
1293(defun isearch-pop-state ()
8e1cae6d
JB
1294 (setq isearch-cmds (cdr isearch-cmds))
1295 (isearch-top-state)
1296 )
1297
1298(defun isearch-push-state ()
1299 (setq isearch-cmds
1300 (cons (list isearch-string isearch-message (point)
1301 isearch-success isearch-forward isearch-other-end
08200510 1302 isearch-word
8e1cae6d
JB
1303 isearch-invalid-regexp isearch-wrapped isearch-barrier)
1304 isearch-cmds)))
1305
8e1cae6d
JB
1306\f
1307;;;==================================================================
1308;; Message string
1309
1310(defun isearch-message (&optional c-q-hack ellipsis)
1311 ;; Generate and print the message string.
1312 (let ((cursor-in-echo-area ellipsis)
1313 (m (concat
08200510 1314 (isearch-message-prefix c-q-hack ellipsis isearch-nonincremental)
8e1cae6d
JB
1315 isearch-message
1316 (isearch-message-suffix c-q-hack ellipsis)
1317 )))
1318 (if c-q-hack m (message "%s" m))))
1319
08200510 1320(defun isearch-message-prefix (&optional c-q-hack ellipsis nonincremental)
8e1cae6d
JB
1321 ;; If about to search, and previous search regexp was invalid,
1322 ;; check that it still is. If it is valid now,
1323 ;; let the message we display while searching say that it is valid.
1324 (and isearch-invalid-regexp ellipsis
1325 (condition-case ()
1326 (progn (re-search-forward isearch-string (point) t)
1327 (setq isearch-invalid-regexp nil))
1328 (error nil)))
1329 ;; If currently failing, display no ellipsis.
1330 (or isearch-success (setq ellipsis nil))
1331 (let ((m (concat (if isearch-success "" "failing ")
1332 (if isearch-wrapped "wrapped ")
08200510 1333 (if isearch-word "word " "")
8e1cae6d 1334 (if isearch-regexp "regexp " "")
08200510 1335 (if nonincremental "search" "I-search")
8e1cae6d
JB
1336 (if isearch-forward ": " " backward: ")
1337 )))
1338 (aset m 0 (upcase (aref m 0)))
1339 m))
1340
1341
1342(defun isearch-message-suffix (&optional c-q-hack ellipsis)
1343 (concat (if c-q-hack "^Q" "")
1344 (if isearch-invalid-regexp
1345 (concat " [" isearch-invalid-regexp "]")
1346 "")))
1347
1348\f
1349;;;========================================================
1350;;; Searching
1351
1352(defun isearch-search ()
1353 ;; Do the search with the current search string.
1354 (isearch-message nil t)
fdf5afa4 1355 (if search-upper-case
08200510 1356 (setq isearch-case-fold-search (isearch-no-upper-case-p isearch-string)))
8e1cae6d
JB
1357 (condition-case lossage
1358 (let ((inhibit-quit nil)
1359 (case-fold-search isearch-case-fold-search))
1360 (if isearch-regexp (setq isearch-invalid-regexp nil))
1361 (setq isearch-success
1362 (funcall
08200510
RS
1363 (cond (isearch-word
1364 (if isearch-forward
1365 'word-search-forward 'word-search-backward))
1366 (isearch-regexp
1367 (if isearch-forward
1368 're-search-forward 're-search-backward))
1369 (t
1370 (if isearch-forward 'search-forward 'search-backward)))
8e1cae6d
JB
1371 isearch-string nil t))
1372 (if isearch-success
1373 (setq isearch-other-end
1374 (if isearch-forward (match-beginning 0) (match-end 0)))))
1375
08200510 1376 (quit (isearch-unread ?\C-g)
8e1cae6d
JB
1377 (setq isearch-success nil))
1378
1379 (invalid-regexp
1380 (setq isearch-invalid-regexp (car (cdr lossage)))
1381 (if (string-match
1382 "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
1383 isearch-invalid-regexp)
f1c03125
RS
1384 (setq isearch-invalid-regexp "incomplete input")))
1385 (error
1386 ;; stack overflow in regexp search.
1387 (setq isearch-invalid-regexp (car (cdr lossage)))))
8e1cae6d
JB
1388
1389 (if isearch-success
1390 nil
1391 ;; Ding if failed this time after succeeding last time.
1392 (and (nth 3 (car isearch-cmds))
1393 (ding))
1394 (goto-char (nth 2 (car isearch-cmds)))))
1395
08200510
RS
1396
1397\f
1398;;;========================================================
1399;;; Highlighting
1400
1401(defun isearch-highlight (begin end))
1402(defun isearch-dehighlight (totally))
1403
1404;; lemacs uses faces
1405'(progn
1406(defvar isearch-extent nil)
1407
1408(or (find-face 'isearch) ;; this face is initialized by x-faces.el
1409 (make-face 'isearch)) ;; since isearch is preloaded
1410
1411(defun isearch-lemacs-highlight (begin end)
1412 (if (null isearch-highlight)
1413 nil
1414 (if (and (extentp isearch-extent)
1415 (eq (extent-buffer isearch-extent) (current-buffer)))
1416 (set-extent-endpoints isearch-extent begin end)
1417 (if (and (extentp isearch-extent)
1418 (bufferp (extent-buffer isearch-extent))
1419 (buffer-name (extent-buffer isearch-extent)))
1420 (delete-extent isearch-extent))
1421 (setq isearch-extent (make-extent begin end (current-buffer))))
1422 (set-extent-face isearch-extent 'isearch)))
1423
1424(defun isearch-lemacs-dehighlight (totally)
1425 (if (and isearch-highlight isearch-extent)
1426 (if totally
1427 (let ((inhibit-quit t))
1428 (if (and (extentp isearch-extent)
1429 (bufferp (extent-buffer isearch-extent))
1430 (buffer-name (extent-buffer isearch-extent)))
1431 (delete-extent isearch-extent))
1432 (setq isearch-extent nil))
1433 (if (and (extentp isearch-extent)
1434 (bufferp (extent-buffer isearch-extent))
1435 (buffer-name (extent-buffer isearch-extent)))
1436 (set-extent-face isearch-extent 'default)
1437 (isearch-dehighlight t)))))
1438
b457cc3b
ER
1439(defalias 'isearch-highlight (symbol-function 'isearch-lemacs-highlight))
1440(defalias 'isearch-dehighlight (symbol-function 'isearch-lemacs-dehighlight))
08200510
RS
1441)
1442
1443;;;===========================================================
1444;;; General utilities
1445
b457cc3b 1446;; (defalias 'isearch-member-equal (symbol-function 'member)) ; for emacs 19
08200510
RS
1447
1448(defun isearch-member-equal (item list)
1449 "Return non-nil if ITEM is `equal' to some item in LIST.
1450Actually return the list whose car is that item."
1451 (while (and list (not (equal item (car list))))
1452 (setq list (cdr list)))
1453 list)
1454
1455
1456(defun isearch-no-upper-case-p (string)
1457 "Return t if there are no upper case chars in string.
1458But upper case chars preceeded by \\ (but not \\\\) do not count since they
1459have special meaning in a regexp."
1460 (let ((case-fold-search nil))
1461 (not (string-match "\\(^\\|\\\\\\\\\\|[^\\]\\)[A-Z]" string))))
1462
1463
8e1cae6d 1464;;;=================================================
08200510 1465;;; Special functions for lemacs events.
8e1cae6d 1466
08200510
RS
1467;; To quiet the byte-compiler.
1468(defvar unread-command-event)
dbc4e1c1 1469(defvar unread-command-events)
08200510 1470(defvar last-command-event)
8e1cae6d 1471
08200510
RS
1472(defun isearch-char-to-string (c)
1473 (if (integerp c)
1474 (make-string 1 c)
1475 (make-string 1 (event-to-character c))))
1476
1477(defun isearch-text-char-description (c)
1478 (isearch-char-to-string c))
1479
8f90f594 1480(defun isearch-unread (&rest char-or-events)
8f90f594
RS
1481 ;; General function to unread characters or events.
1482 (if isearch-gnu-emacs-events
e7cb0106
RS
1483 (setq unread-command-events
1484 (append char-or-events unread-command-events))
8f90f594 1485 (let ((char (if (cdr char-or-events)
75e86b2e
RS
1486 (progn
1487 (while (cdr char-or-events)
1488 (setq char-or-events (cdr char-or-events)))
1489 (+ 128 (car char-or-events)))
8f90f594
RS
1490 (car char-or-events))))
1491 (if isearch-event-data-type
1492 (setq unread-command-event char)
1493 (setq unread-command-char char)))))
08200510
RS
1494
1495(defun isearch-last-command-char ()
1496 ;; General function to return the last command character.
a5dcf63f 1497 (if isearch-event-data-type
08200510
RS
1498 last-command-event
1499 last-command-char))
1500
1501
1502
1503\f
1504;;;========================================================
1505;;; Exiting in lemacs
1506
1507;; This is a large amount of code to support automatic termination of
1508;; isearch-mode when a command (however it is invoked) is not an
1509;; isearch command, or the buffer is switched out from under
1510;; isearch-mode. Only later versions of lemacs have the pre-command-hook.
1511
1512;;(if isearch-pre-command-hook-exists
1513;;(progn
1514
1515;;;; This list must be modified whenever the available commands are modified.
1516;;(mapcar (function (lambda (command)
1517;; (put command 'isearch-command t)))
1518;; '(isearch-printing-char
1519;; isearch-return-char
1520;; isearch-repeat-forward
1521;; isearch-repeat-backward
1522;; isearch-delete-char
1523;; isearch-abort
1524;; isearch-quote-char
1525;; isearch-exit
1526;; isearch-printing-char
1527;; isearch-printing-char
1528;; isearch-yank-word
1529;; isearch-yank-line
1530;; isearch-*-char
1531;; isearch-*-char
1532;; isearch-|-char
1533;; isearch-toggle-regexp
1534;; isearch-edit-string
1535;; isearch-mode-help
1536;; isearch-ring-advance
1537;; isearch-ring-retreat
1538;; isearch-ring-advance-edit
1539;; isearch-ring-retreat-edit
1540;; isearch-whitespace-chars
1541;; isearch-complete
1542;; isearch-complete-edit
1543;; isearch-edit-string
1544;; isearch-toggle-regexp
1545;; ;; The following may not be needed since isearch-mode is off already.
1546;; isearch-forward-exit-minibuffer
1547;; isearch-reverse-exit-minibuffer
1548;; isearch-nonincremental-exit-minibuffer))
1549
1550;;(defun isearch-pre-command-hook ()
1551;; ;;
1552;; ;; For use as the value of `pre-command-hook' when isearch-mode is active.
1553;; ;; If the command about to be executed is not one of the isearch commands,
1554;; ;; then isearch-mode is turned off before that command is executed.
1555;; ;;
1556;; ;; If the command about to be executed is self-insert-command, or is a
1557;; ;; keyboard macro of a single key sequence which is bound to self-insert-
1558;; ;; command, then we add those chars to the search ring instead of inserting
1559;; ;; them in the buffer. In this way, the set of self-searching characters
1560;; ;; need not be exhaustively enumerated, but is derived from other maps.
1561;; ;;
1562;; (isearch-maybe-frob-keyboard-macros)
1563;; (if (and (symbolp this-command)
1564;; (get this-command 'isearch-command))
1565;; nil
1566;; (isearch-done)))
1567
1568;;(defun isearch-maybe-frob-keyboard-macros ()
1569;; ;;
1570;; ;; If the command about to be executed is `self-insert-command' then change
1571;; ;; the command to `isearch-printing-char' instead, meaning add the last-
1572;; ;; typed character to the search string.
1573;; ;;
1574;; ;; If `this-command' is a string or a vector (that is, a keyboard macro)
1575;; ;; and it contains only one command, which is bound to self-insert-command,
1576;; ;; then do the same thing as for self-inserting commands: arrange for that
1577;; ;; character to be added to the search string. If we didn't do this, then
1578;; ;; typing a compose sequence (a la x-compose.el) would terminate the search
1579;; ;; and insert the character, instead of searching for that character.
1580;; ;;
1581;; (cond ((eq this-command 'self-insert-command)
1582;; (setq this-command 'isearch-printing-char))
1583;; ((and (stringp this-command)
1584;; (eq (key-binding this-command) 'self-insert-command))
1585;; (setq last-command-char (aref this-command 0)
1586;; last-command-event (character-to-event last-command-char)
1587;; this-command 'isearch-printing-char))
1588;; ((and (vectorp this-command)
1589;; (eq (key-binding this-command) 'self-insert-command))
1590;; (let* ((desc (aref this-command 0))
1591;; (code (cond ((integerp desc) desc)
1592;; ((symbolp desc) (get desc character-set-property))
1593;; ((consp desc)
1594;; (and (null (cdr desc))
1595;; (get (car desc) character-set-property)))
1596;; (t nil))))
1597;; (if code
1598;; (setq last-command-char code
1599;; last-command-event (character-to-event last-command-char)
1600;; this-command 'isearch-printing-char))))
1601;; ))
1602
1603;;))
4ae7d00a 1604
3b1e4dd1 1605;;; isearch.el ends here