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