XEmacs 21.2.4
[chise/xemacs-chise.git.1] / lisp / isearch-mode.el
1 ;;; isearch-mode.el --- Incremental search minor mode.
2
3 ;; Copyright (C) 1992, 1993, 1997 Free Software Foundation, Inc.
4
5 ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
6 ;; Maintainer: XEmacs Development Team
7 ;; Keywords: extensions, dumped
8
9 ;; This file is part of XEmacs.
10
11 ;; XEmacs is free software; you can redistribute it and/or modify it
12 ;; under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; XEmacs is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 ;; General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with XEmacs; see the file COPYING.  If not, write to the 
23 ;; Free Software Foundation, 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Synched up with: Not synched with FSF.
27
28 ;;; Commentary:
29
30 ;; LCD Archive Entry:
31 ;; isearch-mode|Daniel LaLiberte|liberte@cs.uiuc.edu
32 ;; |A minor mode replacement for isearch.el.
33
34 ;;====================================================================
35 ;; Instructions
36
37 ;; Searching with isearch-mode.el should work just like isearch.el,
38 ;; except it is done in a temporary minor mode that terminates when
39 ;; you finish searching.
40
41 ;; Semi-modal searching is supported, using a recursive edit. If
42 ;; isearching is started non-interactively by calling one of the
43 ;; isearch commands (e.g. (isearch-forward), but not like gnus does
44 ;; it: (call-interactively 'isearch-forward)), isearch-mode does not
45 ;; return until the search is completed.  You should still be able
46 ;; switch buffers, so be careful not to get things confused.
47
48 ;; The key bindings active within isearch-mode are defined below in
49 ;; `isearch-mode-map' which is given bindings close to the default
50 ;; characters of isearch.el for version 19.  With `isearch-mode',
51 ;; however, you can bind multi-character keys and it should be easier
52 ;; to add new commands.  One bug though: keys with meta-prefix cannot
53 ;; be longer than two chars.  Also see minibuffer-local-isearch-map
54 ;; for bindings active during `isearch-edit-string'.
55
56 ;; The search ring and completion commands automatically put you in
57 ;; the minibuffer to edit the string.  This gives you a chance to
58 ;; modify the search string before executing the search.  There are
59 ;; three commands to terminate the editing: C-s and C-r exit the
60 ;; minibuffer and search forward and reverse respectively, while C-m
61 ;; exits and does a nonincremental search.
62
63 ;; Exiting immediately from isearch uses isearch-edit-string instead
64 ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
65 ;; The name of this option should probably be changed if we decide to
66 ;; keep the behavior.  One difference is that isearch-edit-string does
67 ;; not support word search yet; perhaps isearch-mode should support it
68 ;; even for incremental searches, but how?
69
70 ;;====================================================================
71 ;;; Change History:
72
73 ;; Header: /import/kaplan/kaplan/liberte/Isearch/RCS/isearch-mode.el,v 1.3 92/06/29 13:10:08 liberte Exp Locker: liberte 
74 ;; Log: isearch-mode.el,v 
75 ;;
76 ;; 20-aug-92  Hacked by jwz for Lucid Emacs 19.3.
77 ;;
78 ;; Revision 1.3  92/06/29  13:10:08  liberte
79 ;; Moved modal isearch-mode handling into isearch-mode.
80 ;; Got rid of buffer-local isearch variables.
81 ;; isearch-edit-string used by ring adjustments, completion, and
82 ;; nonincremental searching.  C-s and C-r are additional exit commands.
83 ;; Renamed all regex to regexp.
84 ;; Got rid of found-start and found-point globals.
85 ;; Generalized handling of upper-case chars.
86  
87 ;; Revision 1.2  92/05/27  11:33:57  liberte
88 ;; Emacs version 19 has a search ring, which is supported here.
89 ;; Other fixes found in the version 19 isearch are included here.
90 ;;
91 ;; Also see variables search-caps-disable-folding,
92 ;; search-nonincremental-instead, search-whitespace-regexp, and
93 ;; commands isearch-toggle-regexp, isearch-edit-string.
94 ;;
95 ;; semi-modal isearching is supported.
96
97 ;; Changes for 1.1
98 ;; 3/18/92 Fixed invalid-regexp.
99 ;; 3/18/92 Fixed yanking in regexps.
100
101 ;;; Code:
102
103 (defgroup isearch nil
104   "Incremental search"
105   :prefix "search-"
106   :group 'matching)
107
108
109 (defun isearch-char-to-string (c)
110   (if (eventp c) 
111       (make-string 1 (event-to-character c nil nil t))
112     (make-string 1 c)))
113
114 ;(defun isearch-text-char-description (c)
115 ;  (isearch-char-to-string c))
116
117 (define-function 'isearch-text-char-description 'text-char-description)
118
119 \f
120 ;;;=========================================================================
121 ;;; User-accessible variables
122
123 (defvar search-last-string ""
124   "Last string search for by a search command.
125 This does not include direct calls to the primitive search functions,
126 and does not include searches that are aborted.")
127
128 (defvar search-last-regexp ""
129   "Last string searched for by a regexp search command.
130 This does not include direct calls to the primitive search functions,
131 and does not include searches that are aborted.")
132
133 (defconst search-exit-option t
134   "Non-nil means random control characters terminate incremental search.")
135
136 (defcustom search-slow-window-lines 1
137   "*Number of lines in slow search display windows.
138 These are the short windows used during incremental search on slow terminals.
139 Negative means put the slow search window at the top (normally it's at bottom)
140 and the value is minus the number of lines."
141   :type 'integer
142   :group 'isearch)
143
144 (defcustom search-slow-speed 1200
145   "*Highest terminal speed at which to use \"slow\" style incremental search.
146 This is the style where a one-line window is created to show the line
147 that the search has reached."
148   :type 'integer
149   :group 'isearch)
150
151 (defcustom search-nonincremental-instead t
152   "*If non-nil, do a nonincremental search instead if exiting immediately."
153   :type 'boolean
154   :group 'isearch)
155   
156 (defcustom search-whitespace-regexp "\\(\\s \\|[\n\r]\\)+"
157   "*If non-nil, regular expression to match a sequence of whitespace chars."
158   :type 'regexp
159   :group 'isearch)
160
161 ;;;==================================================================
162 ;;; Search ring.
163
164 (defvar search-ring nil
165   "List of search string sequences.")
166 (defvar regexp-search-ring nil
167   "List of regular expression search string sequences.")
168
169 (defcustom search-ring-max 16
170   "*Maximum length of search ring before oldest elements are thrown away."
171   :type 'integer
172   :group 'isearch)
173 (defcustom regexp-search-ring-max 16
174   "*Maximum length of regexp search ring before oldest elements are thrown away."
175   :type 'integer
176   :group 'isearch)
177
178 (defvar search-ring-yank-pointer nil
179   "The tail of the search ring whose car is the last thing searched for.")
180 (defvar regexp-search-ring-yank-pointer nil
181   "The tail of the regular expression search ring whose car is the last
182 thing searched for.")
183
184 ;;;====================================================
185 ;;; Define isearch-mode keymap.
186
187 (defvar isearch-mode-map 
188   (let ((map (make-keymap)))
189     (set-keymap-name map 'isearch-mode-map)
190
191     ;; Bind all printing characters to `isearch-printing-char'.
192     ;; This isn't normally necessary, but if a printing character were 
193     ;; bound to something other than self-insert-command in global-map, 
194     ;; then it would terminate the search and be executed without this.
195     (let ((i 32)
196           (str (make-string 1 0)))
197       (while (< i 127)
198         (aset str 0 i)
199         (define-key map str 'isearch-printing-char)
200         (setq i (1+ i))))
201     (define-key map "\t" 'isearch-printing-char)
202
203     ;; Several non-printing chars change the searching behavior.
204     ;;
205     (define-key map "\C-s" 'isearch-repeat-forward)
206     (define-key map "\M-\C-s" 'isearch-repeat-forward)
207     (define-key map "\C-r" 'isearch-repeat-backward)
208     (define-key map "\C-g" 'isearch-abort)
209
210     (define-key map "\C-q" 'isearch-quote-char)
211
212     (define-key map "\C-m" 'isearch-exit)
213     (define-key map "\C-j" 'isearch-printing-char)
214     (define-key map "\t" 'isearch-printing-char)
215
216     (define-key map "\C-w" 'isearch-yank-word)
217     (define-key map "\C-y" 'isearch-yank-line)
218     (define-key map "\M-y" 'isearch-yank-kill)
219
220     ;; Define keys for regexp chars * ? |
221     (define-key map "*" 'isearch-*-char)
222     (define-key map "?" 'isearch-*-char)
223     (define-key map "|" 'isearch-|-char)
224
225     ;; Some bindings you may want to put in your isearch-mode-hook.
226     ;; Suggest some alternates...
227     ;; (define-key map "\C-t" 'isearch-toggle-regexp)
228     ;; (define-key map "\C-^" 'isearch-edit-string)
229
230     ;; delete and backspace delete backward, f1 is help, and C-h can be either
231     (define-key map 'delete 'isearch-delete-char)
232     (define-key map 'backspace 'isearch-delete-char)
233     (define-key map '(control h) 'isearch-help-or-delete-char)
234     (define-key map 'f1 'isearch-mode-help)
235     (define-key map 'help 'isearch-mode-help)
236
237     (define-key map "\M-n" 'isearch-ring-advance)
238     (define-key map "\M-p" 'isearch-ring-retreat)
239     (define-key map "\M- " 'isearch-whitespace-chars)
240     (define-key map "\M-\t" 'isearch-complete)
241
242     (define-key map 'button2 'isearch-yank-x-selection)
243
244     map)
245   "Keymap for isearch-mode.")
246
247 (defvar minibuffer-local-isearch-map 
248   (let ((map (make-sparse-keymap)))
249     ;; #### - this should also be minor-mode-ified
250     (set-keymap-parents map (list minibuffer-local-map))
251     (set-keymap-name map 'minibuffer-local-isearch-map)
252
253     ;;#### This should just arrange to use the usual Emacs minibuffer histories
254     (define-key map "\r" 'isearch-nonincremental-exit-minibuffer)
255     (define-key map "\M-n" 'isearch-ring-advance-edit)
256     (define-key map "\M-p" 'isearch-ring-retreat-edit)
257     (define-key map "\M-\t" 'isearch-complete-edit)
258     (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
259     (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
260     map)
261   "Keymap for editing isearch strings in the minibuffer.")
262
263 ;;;========================================================
264 ;; Internal variables declared globally for byte-compiler.
265 ;; These are all bound locally while editing the search string.
266
267 (defvar isearch-forward nil)    ; Searching in the forward direction.
268 (defvar isearch-regexp nil)     ; Searching for a regexp.
269 (defvar isearch-word nil)       ; Searching for words.
270
271 (defvar isearch-cmds nil)   ; Stack of search status sets.
272 (defvar isearch-string "")  ; The current search string.
273 (defvar isearch-message "") ; text-char-description version of isearch-string
274
275 (defvar isearch-success t)              ; Searching is currently successful.
276 (defvar isearch-invalid-regexp nil)     ; Regexp not well formed.
277 (defvar isearch-other-end nil)  ; Start (end) of match if forward (backward).
278 (defvar isearch-wrapped nil)    ; Searching restarted from the top (bottom).
279 (defvar isearch-barrier 0)
280 (defvar isearch-just-started nil)
281 (defvar isearch-buffer nil)     ; the buffer we've frobbed the keymap of
282
283 (defvar isearch-case-fold-search nil)
284
285 (defvar isearch-adjusted nil)
286 (defvar isearch-slow-terminal-mode nil)
287 ;;; If t, using a small window.
288 (defvar isearch-small-window nil)
289 (defvar isearch-opoint 0)
290 ;;; The window configuration active at the beginning of the search.
291 (defvar isearch-window-configuration nil)
292 (defvar isearch-selected-frame nil)
293
294 ;; Flag to indicate a yank occurred, so don't move the cursor.
295 (defvar isearch-yank-flag nil)
296
297 ;;; A function to be called after each input character is processed.
298 ;;; (It is not called after characters that exit the search.)
299 ;;; It is only set from an optional argument to `isearch-mode'.
300 (defvar isearch-op-fun nil)
301
302 ;;;  Is isearch-mode in a recursive edit for modal searching.
303 (defvar isearch-recursive-edit nil)
304
305 ;;; Should isearch be terminated after doing one search?
306 (defvar isearch-nonincremental nil)
307
308 ;; New value of isearch-forward after isearch-edit-string.
309 (defvar isearch-new-forward nil)
310
311
312 (defvar isearch-mode-hook nil
313   "Function(s) to call after starting up an incremental search.")
314
315 (defvar isearch-mode-end-hook nil
316   "Function(s) to call after terminating an incremental search.")
317
318 ;;;==============================================================
319 ;; Minor-mode-alist changes - kind of redundant with the
320 ;; echo area, but if isearching in multiple windows, it can be useful.
321
322 (add-minor-mode 'isearch-mode 'isearch-mode)
323
324 (defvar isearch-mode nil)
325 (make-variable-buffer-local 'isearch-mode)
326
327 ;;;===============================================================
328 ;;; Entry points to isearch-mode.
329 ;;; These four functions should replace those in loaddefs.el
330 ;;; An alternative is to fset isearch-forward etc to isearch-mode,
331 ;;; and look at the last command to set the options accordingly.
332
333 (defun isearch-forward (&optional regexp-p)
334   "Do incremental search forward.
335 With a prefix argument, do an incremental regular expression search instead.
336 \\<isearch-mode-map>
337 As you type characters, they add to the search string and are found.
338 The following non-printing keys are bound in `isearch-mode-map'.  
339
340 Type \\[isearch-delete-char] to cancel characters from end of search string.
341 Type \\[isearch-exit] to exit, leaving point at location found.
342 Type LFD (C-j) to match end of line.
343 Type \\[isearch-repeat-forward] to search again forward,\
344  \\[isearch-repeat-backward] to search again backward.
345 Type \\[isearch-yank-word] to yank word from buffer onto end of search\
346  string and search for it.
347 Type \\[isearch-yank-line] to yank rest of line onto end of search string\
348  and search for it.
349 Type \\[isearch-quote-char] to quote control character to search for it.
350 Type \\[isearch-whitespace-chars] to match all whitespace chars in regexp.
351 \\[isearch-abort] while searching or when search has failed cancels input\
352  back to what has
353  been found successfully.
354 \\[isearch-abort] when search is successful aborts and moves point to\
355  starting point.
356
357 Also supported is a search ring of the previous 16 search strings.
358 Type \\[isearch-ring-advance] to search for the next item in the search ring.
359 Type \\[isearch-ring-retreat] to search for the previous item in the search\
360  ring.
361 Type \\[isearch-complete] to complete the search string using the search ring.
362
363 The above keys are bound in the isearch-mode-map.  To change the keys which
364  are special to isearch-mode, simply change the bindings in that map.
365
366 Other control and meta characters terminate the search
367  and are then executed normally (depending on `search-exit-option').
368
369 If this function is called non-interactively, it does not return to
370 the calling function until the search is done.
371
372 The bindings, more precisely:
373 \\{isearch-mode-map}"
374
375 ;; Non-standard bindings
376 ;; Type \\[isearch-toggle-regexp] to toggle regular expression with normal searching.
377 ;; Type \\[isearch-edit-string] to edit the search string in the minibuffer.
378 ;;  Terminate editing and return to incremental searching with CR.
379
380   (interactive "_P")
381   (isearch-mode t (not (null regexp-p)) nil (not (interactive-p))))
382
383 (defun isearch-forward-regexp ()
384   "\
385 Do incremental search forward for regular expression.
386 Like ordinary incremental search except that your input
387 is treated as a regexp.  See \\[isearch-forward] for more info."
388   (interactive "_")
389   (isearch-mode t t nil (not (interactive-p))))
390
391 (defun isearch-backward (&optional regexp-p)
392   "\
393 Do incremental search backward.
394 With a prefix argument, do an incremental regular expression search instead.
395 See \\[isearch-forward] for more information."
396   (interactive "_P")
397   (isearch-mode nil (not (null regexp-p)) nil (not (interactive-p))))
398
399 (defun isearch-backward-regexp ()
400   "\
401 Do incremental search backward for regular expression.
402 Like ordinary incremental search except that your input
403 is treated as a regexp.  See \\[isearch-forward] for more info."
404   (interactive "_")
405   (isearch-mode nil t nil (not (interactive-p))))
406
407 ;; This function is way wrong, because you can't scroll the help
408 ;; screen; as soon as you press a key, it's gone.  I don't know of a
409 ;; good way to fix it, though.  -hniksic
410 (defun isearch-mode-help ()
411   (interactive "_")
412   (let ((w (selected-window)))
413     (describe-function 'isearch-forward)
414     (select-window w))
415   (isearch-update))
416
417 \f
418 ;;;==================================================================
419 ;; isearch-mode only sets up incremental search for the minor mode.
420 ;; All the work is done by the isearch-mode commands.
421
422 (defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p)
423   "Start isearch minor mode.  Called by isearch-forward, etc."
424
425   (if executing-kbd-macro (setq recursive-edit nil))
426
427   (let ((inhibit-quit t)) ; don't leave things in an inconsistent state...
428
429     ;; Initialize global vars.
430     (setq isearch-buffer (current-buffer)
431           isearch-forward forward
432           isearch-regexp regexp
433           isearch-word word-p
434           isearch-op-fun op-fun
435           isearch-case-fold-search case-fold-search
436           isearch-string ""
437           isearch-message ""
438           isearch-cmds nil
439           isearch-success t
440           isearch-wrapped nil
441           isearch-barrier (point)
442           isearch-adjusted nil
443           isearch-yank-flag nil
444           isearch-invalid-regexp nil
445           isearch-slow-terminal-mode (and (<= (device-baud-rate)
446                                               search-slow-speed)
447                                           (> (window-height)
448                                              (* 4 search-slow-window-lines)))
449           isearch-other-end nil
450           isearch-small-window nil
451           isearch-just-started t
452
453           isearch-opoint (point)
454           isearch-window-configuration (current-window-configuration)
455
456           ;; #### Should we remember the old value of
457           ;; overriding-local-map?
458           overriding-local-map isearch-mode-map
459           isearch-selected-frame (selected-frame)
460
461           isearch-mode (gettext " Isearch")
462           )
463     (let ((map (append (current-minor-mode-maps)
464                        (list (current-local-map)))))
465       (if (keymapp map)
466           (set-keymap-parents isearch-mode-map map)))
467
468     ;; XEmacs change: without clearing the match data, sometimes old values
469     ;; of isearch-other-end get used.  Don't ask me why...
470     (store-match-data nil)
471
472     (add-hook 'pre-command-hook 'isearch-pre-command-hook)
473     (set-buffer-modified-p (buffer-modified-p)) ; update modeline
474     (isearch-push-state)
475
476     ) ; inhibit-quit is t before here
477
478   (isearch-update)
479   (run-hooks 'isearch-mode-hook)
480
481   ;; isearch-mode can be made modal (in the sense of not returning to 
482   ;; the calling function until searching is completed) by entering 
483   ;; a recursive-edit and exiting it when done isearching.
484   (if recursive-edit
485       (let ((isearch-recursive-edit t))
486         (recursive-edit)))
487   )
488
489
490 ;;;====================================================
491 ;; Some high level utilities.  Others below.
492
493 (defun isearch-update ()
494   ;; Called after each command to update the display.  
495   (if (null unread-command-event)
496       (progn
497         (if (not (input-pending-p))
498             (isearch-message))
499         (if (and isearch-slow-terminal-mode
500                  (not (or isearch-small-window 
501                           (pos-visible-in-window-p))))
502             (let ((found-point (point)))
503               (setq isearch-small-window t)
504               (move-to-window-line 0)
505               (let ((window-min-height 1))
506                 (split-window nil (if (< search-slow-window-lines 0)
507                                       (1+ (- search-slow-window-lines))
508                                     (- (window-height)
509                                        (1+ search-slow-window-lines)))))
510               (if (< search-slow-window-lines 0)
511                   (progn (vertical-motion (- 1 search-slow-window-lines))
512                          (set-window-start (next-window) (point))
513                          (set-window-hscroll (next-window)
514                                              (window-hscroll))
515                          (set-window-hscroll (selected-window) 0))
516                 (other-window 1))
517               (goto-char found-point)))
518         (if isearch-other-end
519             (if (< isearch-other-end (point))
520                 (isearch-highlight isearch-other-end (point))
521               (isearch-highlight (point) isearch-other-end))
522           (if (extentp isearch-extent)
523               (isearch-dehighlight nil)))
524         ))
525   (setq ;; quit-flag nil  not for isearch-mode
526    isearch-adjusted nil
527    isearch-yank-flag nil)
528   )
529
530
531 (defun isearch-done ()
532   ;; Called by all commands that terminate isearch-mode.
533   (let ((inhibit-quit t)) ; danger danger!
534     (if (and isearch-buffer (buffer-live-p isearch-buffer))
535         (save-excursion
536           ;; Some loser process filter might have switched the
537           ;; window's buffer, so be sure to set these variables back
538           ;; in the buffer we frobbed them in.  But only if the buffer
539           ;; is still alive.
540           (set-buffer isearch-buffer)
541           ;; #### Should we restore the old value of
542           ;; overriding-local-map?
543           (setq overriding-local-map nil)
544           ;; Use remove-hook instead of just setting it to our saved value
545           ;; in case some process filter has created a buffer and modified
546           ;; the pre-command-hook in that buffer...  yeah, this is obscure,
547           ;; and yeah, I was getting screwed by it. -jwz
548           (remove-hook 'pre-command-hook 'isearch-pre-command-hook)
549           (set-keymap-parents isearch-mode-map nil)
550           (setq isearch-mode nil)
551           (set-buffer-modified-p (buffer-modified-p));; update modeline
552           (isearch-dehighlight t)))
553
554     ;; it's not critical that this be inside inhibit-quit, but leaving
555     ;; things in small-window-mode would be bad.
556     (let ((found-start (window-start (selected-window)))
557           (found-point (point)))
558       (cond ((eq (selected-frame) isearch-selected-frame)
559              (set-window-configuration isearch-window-configuration)
560
561              (if isearch-small-window
562                  (goto-char found-point)
563                ;; Exiting the save-window-excursion clobbers
564                ;; window-start; restore it.
565                (set-window-start (selected-window) found-start t))))
566       ;; If there was movement, mark the starting position.
567       ;; Maybe should test difference between and set mark iff > threshold.
568       (if (and (buffer-live-p isearch-buffer)
569                (/= (point isearch-buffer) isearch-opoint))
570           (progn
571             (push-mark isearch-opoint t nil isearch-buffer)
572             (or executing-kbd-macro (> (minibuffer-depth) 0)
573                 (display-message 'command "Mark saved where search started"))))
574         )
575     (setq isearch-buffer nil)
576     ) ; inhibit-quit is t before here
577
578   (if (> (length isearch-string) 0)
579       ;; Update the ring data.
580       (if isearch-regexp 
581           (if (not (setq regexp-search-ring-yank-pointer
582                          (member isearch-string regexp-search-ring)))
583               (progn
584                 (setq regexp-search-ring
585                       (cons isearch-string regexp-search-ring)
586                       regexp-search-ring-yank-pointer regexp-search-ring)
587                 (if (> (length regexp-search-ring) regexp-search-ring-max)
588                     (setcdr (nthcdr (1- regexp-search-ring-max) regexp-search-ring)
589                             nil))))
590         (if (not (setq search-ring-yank-pointer
591                        ;; really need equal test instead of eq.
592                        (member isearch-string search-ring)))
593             (progn
594               (setq search-ring (cons isearch-string search-ring)
595                     search-ring-yank-pointer search-ring)
596               (if (> (length search-ring) search-ring-max)
597                   (setcdr (nthcdr (1- search-ring-max) search-ring) nil))))))
598
599   (run-hooks 'isearch-mode-end-hook)
600   (if isearch-recursive-edit (exit-recursive-edit)))
601
602 \f
603 ;;;====================================================
604 ;; Commands active while inside of the isearch minor mode.
605
606 (defun isearch-exit ()
607   "Exit search normally.
608 However, if this is the first command after starting incremental
609 search and `search-nonincremental-instead' is non-nil, do an
610 incremental search via `isearch-edit-string'."
611   (interactive)
612   (if (and search-nonincremental-instead 
613            (= 0 (length isearch-string)))
614       (let ((isearch-nonincremental t))
615         (isearch-edit-string))
616     (isearch-done)))
617
618
619 (defun isearch-edit-string ()
620   "Edit the search string in the minibuffer.
621 The following additional command keys are active while editing.
622 \\<minibuffer-local-isearch-map>
623 \\[exit-minibuffer] to exit editing and resume incremental searching.
624 \\[isearch-forward-exit-minibuffer] to resume isearching forward.
625 \\[isearch-backward-exit-minibuffer] to resume isearching backward.
626 \\[isearch-ring-advance-edit] to replace the search string with the next\
627  item in the search ring.
628 \\[isearch-ring-retreat-edit] to replace the search string with the next\
629  item in the search ring.
630 \\[isearch-complete-edit] to complete the search string from the search ring."
631
632   ;; Editing doesn't back up the search point.  Should it?
633   (interactive)
634
635   (condition-case nil
636       (let ((minibuffer-local-map minibuffer-local-isearch-map)
637             isearch-nonincremental      ; should search nonincrementally?
638             isearch-new-string
639             isearch-new-message
640             (isearch-new-forward isearch-forward)
641
642             ;; Locally bind all isearch global variables to protect them
643             ;; from recursive isearching.
644             (isearch-string isearch-string)
645             (isearch-message isearch-message)
646             (isearch-forward isearch-forward) ; set by commands below.
647
648             (isearch-forward isearch-forward)
649             (isearch-regexp isearch-regexp)
650             (isearch-word isearch-word)
651             (isearch-op-fun isearch-op-fun)
652             (isearch-cmds isearch-cmds)
653             (isearch-success isearch-success)
654             (isearch-wrapped isearch-wrapped)
655             (isearch-barrier isearch-barrier)
656             (isearch-adjusted isearch-adjusted)
657             (isearch-yank-flag isearch-yank-flag)
658             (isearch-invalid-regexp isearch-invalid-regexp)
659             (isearch-other-end isearch-other-end)
660             (isearch-opoint isearch-opoint)
661             (isearch-slow-terminal-mode isearch-slow-terminal-mode)
662             (isearch-small-window isearch-small-window)
663             (isearch-recursive-edit isearch-recursive-edit)
664             (isearch-window-configuration (current-window-configuration))
665             (isearch-selected-frame (selected-frame))
666             )
667         ;; Actually terminate isearching until editing is done.
668         ;; This is so that the user can do anything without failure, 
669         ;; like switch buffers and start another isearch, and return.
670 ;;      (condition-case nil
671             (isearch-done)
672           ;;#### What does this mean?  There is no such condition!
673 ;;        (exit nil))                   ; was recursive editing
674
675         (unwind-protect
676             (let ((prompt (isearch-message-prefix nil t))
677                   event)
678               ;; If the first character the user types when we prompt them
679               ;; for a string is the yank-word character, then go into
680               ;; word-search mode.  Otherwise unread that character and
681               ;; read a string the normal way.
682               (let ((cursor-in-echo-area t))
683                 (display-message 'prompt prompt)
684                 (setq event (next-command-event))
685                 (if (eq 'isearch-yank-word
686                         (lookup-key isearch-mode-map (vector event)))
687                     (setq isearch-word t)
688                   (setq unread-command-event event)))
689               (setq isearch-new-string
690 ;;                    (if (fboundp 'gmhist-old-read-from-minibuffer)
691 ;;                        ;; Eschew gmhist crockery
692 ;;                      (gmhist-old-read-from-minibuffer prompt isearch-string)
693                       (read-string
694                        prompt isearch-string
695                        't            ;does its own history (but shouldn't)
696 ;;                     (if isearch-regexp
697 ;;                         ;; The search-rings aren't exactly minibuffer
698 ;;                         ;;  histories, but they are close enough
699 ;;                         (cons 'regexp-search-ring
700 ;;                               (- (length regexp-search-ring-yank-pointer)
701 ;;                                  (length regexp-search-ring)))
702 ;;                         (cons 'search-ring
703 ;;                               (- (length search-ring-yank-pointer)
704 ;;                                  (length search-ring))))
705                        )
706 ;;                    )
707                     isearch-new-message (mapconcat
708                                          'isearch-text-char-description
709                                          isearch-new-string ""))
710               )
711           ;; Always resume isearching by restarting it.
712           (isearch-mode isearch-forward 
713                         isearch-regexp 
714                         isearch-op-fun 
715                         isearch-recursive-edit
716                         isearch-word)
717           )
718
719         ;; Copy new values in outer locals to isearch globals
720         (setq isearch-string isearch-new-string
721               isearch-message isearch-new-message
722               isearch-forward isearch-new-forward)
723
724         ;; Empty isearch-string means use default.
725         (if (= 0 (length isearch-string))
726             (setq isearch-string (if isearch-regexp search-last-regexp
727                                    search-last-string))
728           ;; Set last search string now so it is set even if we fail.
729           (if search-last-regexp
730               (setq search-last-regexp isearch-string)
731             (setq search-last-string isearch-string)))
732
733         ;; Reinvoke the pending search.
734         (isearch-push-state)
735         (isearch-search)
736         (isearch-update)
737         (if isearch-nonincremental (isearch-done)))
738
739     (quit  ; handle abort-recursive-edit
740      (isearch-abort)  ;; outside of let to restore outside global values
741      )))
742
743 (defun isearch-nonincremental-exit-minibuffer ()
744   (interactive)
745   (setq isearch-nonincremental t)
746   (exit-minibuffer))
747
748 (defun isearch-forward-exit-minibuffer ()
749   (interactive)
750   (setq isearch-new-forward t)
751   (exit-minibuffer))
752
753 (defun isearch-reverse-exit-minibuffer ()
754   (interactive)
755   (setq isearch-new-forward nil)
756   (exit-minibuffer))
757
758
759 (defun isearch-abort ()
760   "Quit incremental search mode if searching is successful, signalling quit.
761 Otherwise, revert to previous successful search and continue searching.
762 Use `isearch-exit' to quit without signalling."
763   (interactive)
764 ;;  (ding)  signal instead below, if quiting
765   (discard-input)
766   (if isearch-success
767       ;; If search is successful, move back to starting point
768       ;; and really do quit.
769       (progn (goto-char isearch-opoint)
770              (isearch-done)   ; exit isearch
771              (signal 'quit '(isearch)))  ; and pass on quit signal
772     ;; If search is failing, rub out until it is once more successful.
773     (while (not isearch-success) (isearch-pop-state))
774     (isearch-update)))
775
776
777 (defun isearch-repeat (direction)
778   ;; Utility for isearch-repeat-forward and -backward.
779   (if (eq isearch-forward (eq direction 'forward))
780       ;; C-s in forward or C-r in reverse.
781       (if (equal isearch-string "")
782           ;; If search string is empty, use last one.
783           (setq isearch-string
784                 (or (if isearch-regexp
785                         (if regexp-search-ring-yank-pointer
786                             (car regexp-search-ring-yank-pointer)
787                           (car regexp-search-ring))
788                       (if search-ring-yank-pointer
789                           (car search-ring-yank-pointer)
790                         (car search-ring)))
791                     "")
792                 isearch-message
793                 (mapconcat 'isearch-text-char-description
794                            isearch-string ""))
795         ;; If already have what to search for, repeat it.
796         (or isearch-success
797             (progn 
798
799               (goto-char (if isearch-forward (point-min) (point-max)))
800               (setq isearch-wrapped t))))
801     ;; C-s in reverse or C-r in forward, change direction.
802     (setq isearch-forward (not isearch-forward)))
803
804   (setq isearch-barrier (point)) ; For subsequent \| if regexp.
805   (if (equal isearch-string "")
806       (setq isearch-success t)
807     (if (and (equal (match-end 0) (match-beginning 0))
808              isearch-success
809              (not isearch-just-started))
810         ;; If repeating a search that found
811         ;; an empty string, ensure we advance.
812         (if (if isearch-forward (eobp) (bobp))
813             ;; nowhere to advance to, so fail (and wrap next time)
814             (progn
815               (setq isearch-success nil)
816               (and executing-kbd-macro
817                    (not defining-kbd-macro)
818                    (isearch-done))
819               (ding nil 'isearch-failed))
820           (forward-char (if isearch-forward 1 -1))
821           (isearch-search))
822       (isearch-search)))
823   (isearch-push-state)
824   (isearch-update))
825
826 (defun isearch-repeat-forward ()
827   "Repeat incremental search forwards."
828   (interactive)
829   (isearch-repeat 'forward))
830
831 (defun isearch-repeat-backward ()
832   "Repeat incremental search backwards."
833   (interactive)
834   (isearch-repeat 'backward))
835
836 (defun isearch-toggle-regexp ()
837   "Toggle regexp searching on or off."
838   ;; The status stack is left unchanged.
839   (interactive)
840   (setq isearch-regexp (not isearch-regexp))
841   (if isearch-regexp (setq isearch-word nil))
842   (isearch-update))
843
844 (defun isearch-toggle-case-fold ()
845   "Toggle case folding in searching on or off."
846   (interactive)
847   (setq isearch-case-fold-search
848         (if isearch-case-fold-search nil 'yes))
849   (message "%s%s [case %ssensitive]"
850            (isearch-message-prefix)
851            isearch-message
852            (if isearch-case-fold-search "in" ""))
853   (setq isearch-adjusted t)
854   (sit-for 1)
855   (isearch-update))
856
857 (defun isearch-delete-char ()
858   "Discard last input item and move point back.  
859 If no previous match was done, just beep."
860   (interactive)
861   (if (null (cdr isearch-cmds))
862       (ding nil 'isearch-quit)
863     (isearch-pop-state))
864   (isearch-update))
865
866 (defun isearch-help-or-delete-char ()
867   "Show Isearch help or delete backward in the search string.
868 Deletes when `delete-key-deletes-forward' is t and C-h is used for deleting
869 backwards."
870   (interactive)
871   (if (and delete-key-deletes-forward
872            (case (device-type)
873              ('tty (eq tty-erase-char ?\C-h))
874              ('x (not (x-keysym-on-keyboard-sans-modifiers-p 'backspace)))))
875       (isearch-delete-char)
876     (isearch-mode-help)))
877
878 (defun isearch-yank (chunk)
879   ;; Helper for isearch-yank-* functions.  CHUNK can be a string or a
880   ;; function.
881   (let ((word (if (stringp chunk)
882                   chunk
883                 (save-excursion
884                   (and (not isearch-forward) isearch-other-end
885                        (goto-char isearch-other-end))
886                   (buffer-substring
887                    (point)
888                    (save-excursion
889                      (funcall chunk)
890                      (point)))))))
891     ;; if configured so that typing upper-case characters turns off case
892     ;; folding, then downcase the string so that yanking an upper-case
893     ;; word doesn't mess with case-foldedness.
894     (if (and search-caps-disable-folding isearch-case-fold-search)
895         (setq word (downcase word)))
896     (if isearch-regexp (setq word (regexp-quote word)))
897     (setq isearch-string (concat isearch-string word)
898           isearch-message
899           (concat isearch-message
900                   (mapconcat 'isearch-text-char-description
901                              word ""))
902           ;; Don't move cursor in reverse search.
903           isearch-yank-flag t))
904   (isearch-search-and-update))
905
906
907 (defun isearch-yank-word ()
908   "Pull next word from buffer into search string."
909   (interactive)
910   (isearch-yank (function (lambda () (forward-word 1)))))
911
912 (defun isearch-yank-line ()
913   "Pull rest of line from buffer into search string."
914   (interactive)
915   (isearch-yank 'end-of-line))
916
917 (defun isearch-yank-kill ()
918   "Pull rest of line from kill ring into search string."
919   (interactive)
920   (isearch-yank (current-kill 0)))
921
922 (defun isearch-yank-sexp ()
923   "Pull next expression from buffer into search string."
924   (interactive)
925   (isearch-yank 'forward-sexp))
926
927 (defun isearch-yank-x-selection ()
928   "Pull the current X selection into the search string."
929   (interactive)
930   (isearch-yank (x-get-selection)))
931
932 (defun isearch-yank-x-clipboard ()
933   "Pull the current X clipboard selection into the search string."
934   (interactive)
935   (isearch-yank (x-get-clipboard)))
936
937 (defun isearch-fix-case ()
938   (if (and isearch-case-fold-search search-caps-disable-folding)
939       (setq isearch-case-fold-search 
940             (no-upper-case-p isearch-string isearch-regexp)))
941   (setq isearch-mode (if case-fold-search
942                          (if isearch-case-fold-search
943                              " Isearch"  ;As God Intended Mode
944                            " ISeARch") ;Warn about evil case via StuDLYcAps.
945                        "Isearch"
946 ;                        (if isearch-case-fold-search
947 ;                            " isearch"    ;Presumably case-sensitive losers
948 ;                                          ;will notice this 1-char difference.
949 ;                            " Isearch")   ;Weenie mode.
950                          )))
951
952 (defun isearch-search-and-update ()
953   ;; Do the search and update the display.
954   (if (and (not isearch-success)
955            ;; unsuccessful regexp search may become
956            ;;  successful by addition of characters which
957            ;;  make isearch-string valid
958            (not isearch-regexp))
959       nil
960     ;; In reverse search, adding stuff at
961     ;; the end may cause zero or many more chars to be
962     ;; matched, in the string following point.
963     ;; Allow all those possibilities without moving point as
964     ;; long as the match does not extend past search origin.
965     (if (and (not isearch-forward) (not isearch-adjusted)
966              (condition-case ()
967                  (progn
968                    (isearch-fix-case)
969                    (let ((case-fold-search isearch-case-fold-search))
970                      (looking-at (if isearch-regexp isearch-string
971                                    (regexp-quote isearch-string)))))
972                (error nil))
973              (or isearch-yank-flag
974                  (<= (match-end 0) 
975                      (min isearch-opoint isearch-barrier))))
976         (setq isearch-success t 
977               isearch-invalid-regexp nil
978               isearch-other-end (match-end 0))
979       ;; Not regexp, not reverse, or no match at point.
980       (if (and isearch-other-end (not isearch-adjusted))
981           (goto-char (if isearch-forward isearch-other-end
982                        (min isearch-opoint 
983                             isearch-barrier 
984                             (1+ isearch-other-end)))))
985       (isearch-search)
986       ))
987   (isearch-push-state)
988   (if isearch-op-fun (funcall isearch-op-fun))
989   (isearch-update))
990
991
992 ;; *, ?, and | chars can make a regexp more liberal.
993 ;; They can make a regexp match sooner
994 ;; or make it succeed instead of failing.
995 ;; So go back to place last successful search started
996 ;; or to the last ^S/^R (barrier), whichever is nearer.
997
998 (defun isearch-*-char ()
999   "Handle * and ? specially in regexps."
1000   (interactive)
1001   (if isearch-regexp 
1002
1003       (progn
1004         (setq isearch-adjusted t)
1005         (let ((cs (nth (if isearch-forward
1006                            5            ; isearch-other-end
1007                          2)             ; saved (point)
1008                        (car (cdr isearch-cmds)))))
1009           ;; (car isearch-cmds) is after last search;
1010           ;; (car (cdr isearch-cmds)) is from before it.
1011           (setq cs (or cs isearch-barrier))
1012           (goto-char
1013            (if isearch-forward
1014                (max cs isearch-barrier)
1015              (min cs isearch-barrier))))))
1016   (isearch-process-search-char last-command-event))
1017   
1018
1019
1020 (defun isearch-|-char ()
1021   "If in regexp search, jump to the barrier."
1022   (interactive)
1023   (if isearch-regexp
1024       (progn
1025         (setq isearch-adjusted t)
1026         (goto-char isearch-barrier)))
1027   (isearch-process-search-char last-command-event))
1028
1029 (defun isearch-quote-char ()
1030   "Quote special characters for incremental search."
1031   (interactive)
1032   (isearch-process-search-char (read-quoted-char (isearch-message t))))
1033
1034
1035 (defun isearch-return-char ()
1036   "Convert return into newline for incremental search.
1037 Obsolete."
1038   (interactive)
1039   (isearch-process-search-char ?\n))
1040
1041
1042 (defun isearch-printing-char ()
1043   "Any other printing character => add it to the search string and search."
1044   (interactive)
1045   (isearch-process-search-char last-command-event))
1046
1047
1048 (defun isearch-whitespace-chars ()
1049   "Match all whitespace chars, if in regexp mode."
1050   (interactive)
1051   (if (and isearch-regexp search-whitespace-regexp)
1052       (isearch-process-search-string search-whitespace-regexp " ")
1053     (beep)
1054     (isearch-process-search-char ?\ )
1055 ;    (if isearch-word
1056 ;       nil
1057 ;      (setq isearch-word t)
1058 ;      (goto-char isearch-other-end)
1059 ;      (isearch-process-search-char ?\ ))
1060     ))
1061
1062 (defun isearch-process-search-char (char)
1063   ;; Append the char to the search string, update the message and re-search.
1064   (isearch-process-search-string (isearch-char-to-string char) 
1065                                  (isearch-text-char-description char)))
1066
1067 (defun isearch-process-search-string (string message)
1068   (setq isearch-string (concat isearch-string string)
1069         isearch-message (concat isearch-message message))
1070   (isearch-search-and-update))
1071
1072 \f
1073 ;;===========================================================
1074 ;; Search Ring
1075
1076 (defcustom search-ring-update nil
1077   "*Non-nil if advancing or retreating in the search ring should cause search.
1078 Default nil means edit the string from the search ring first."
1079   :type 'boolean
1080   :group 'isearch)
1081   
1082 (defun isearch-ring-adjust1 (advance)
1083   ;; Helper for isearch-ring-adjust
1084   (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
1085          (length (length ring))
1086          (yank-pointer-name (if isearch-regexp
1087                                 'regexp-search-ring-yank-pointer
1088                               'search-ring-yank-pointer))
1089          (yank-pointer (eval yank-pointer-name)))
1090     (if (zerop length)
1091         ()
1092       (set yank-pointer-name
1093            (setq yank-pointer
1094                  (nthcdr (% (+ (- length (length yank-pointer))
1095                                (if advance (1- length) 1))
1096                             length) ring)))
1097       (setq isearch-string (car yank-pointer)
1098             isearch-message (mapconcat 'isearch-text-char-description
1099                                        isearch-string "")))))
1100
1101 (defun isearch-ring-adjust (advance)
1102   ;; Helper for isearch-ring-advance and isearch-ring-retreat
1103   (if (cdr isearch-cmds)  ;; is there more than one thing on stack?
1104       (isearch-pop-state))
1105   (isearch-ring-adjust1 advance)
1106   (isearch-push-state)
1107   (if search-ring-update
1108       (progn
1109         (isearch-search)
1110         (isearch-update))
1111     (isearch-edit-string)
1112     ))
1113
1114 (defun isearch-ring-advance ()
1115   "Advance to the next search string in the ring."
1116   ;; This could be more general to handle a prefix arg, but who would use it.
1117   (interactive)
1118   (isearch-ring-adjust 'advance))
1119
1120 (defun isearch-ring-retreat ()
1121   "Retreat to the previous search string in the ring."
1122   (interactive)
1123   (isearch-ring-adjust nil))
1124
1125 (defun isearch-ring-adjust-edit (advance)
1126   "Use the next or previous search string in the ring while in minibuffer."
1127   (isearch-ring-adjust1 advance)
1128   (erase-buffer)
1129   (insert isearch-string))
1130
1131 (defun isearch-ring-advance-edit ()
1132   (interactive)
1133   (isearch-ring-adjust-edit 'advance))
1134
1135 (defun isearch-ring-retreat-edit ()
1136   "Retreat to the previous search string in the ring while in the minibuffer."
1137   (interactive)
1138   (isearch-ring-adjust-edit nil))
1139
1140
1141 (defun isearch-complete1 ()
1142   ;; Helper for isearch-complete and isearch-complete-edit
1143   ;; Return t if completion OK, 
1144   (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
1145          (alist (mapcar (function (lambda (string) (list string))) ring))
1146          (completion-ignore-case case-fold-search)
1147          (completion (try-completion isearch-string alist))
1148          )
1149     (cond
1150      ((eq completion t)
1151       ;; isearch-string stays the same
1152       t)
1153      ((or completion ; not nil, must be a string
1154           (= 0 (length isearch-string))) ; shouldn't have to say this
1155       (if (equal completion isearch-string)  ;; no extension?
1156           (if completion-auto-help
1157               (with-output-to-temp-buffer "*Isearch completions*"
1158                 (display-completion-list 
1159                  (all-completions isearch-string alist))))
1160         (setq isearch-string completion))
1161       t)
1162      (t
1163       (temp-minibuffer-message "No completion")
1164       nil))))
1165
1166 (defun isearch-complete ()
1167   "Complete the search string from the strings on the search ring.
1168 The completed string is then editable in the minibuffer.
1169 If there is no completion possible, say so and continue searching."
1170   (interactive)
1171   (if (isearch-complete1)
1172       (isearch-edit-string)
1173     ;; else
1174     (sit-for 1)
1175     (isearch-update)))
1176
1177 (defun isearch-complete-edit ()
1178   "Same as `isearch-complete' except in the minibuffer."
1179   (interactive)
1180   (setq isearch-string (buffer-string))
1181   (if (isearch-complete1)
1182       (progn
1183         (erase-buffer)
1184         (insert isearch-string))))
1185
1186 \f
1187 ;;;==============================================================
1188 ;; The search status stack (and isearch window-local variables, not used).
1189
1190 (defun isearch-top-state ()
1191 ;;  (fetch-window-local-variables)
1192   (let ((cmd (car isearch-cmds)))
1193     (setq isearch-string (car cmd)
1194           isearch-message (car (cdr cmd))
1195           isearch-success (nth 3 cmd)
1196           isearch-forward (nth 4 cmd)
1197           isearch-other-end (nth 5 cmd)
1198           isearch-invalid-regexp (nth 6 cmd)
1199           isearch-wrapped (nth 7 cmd)
1200           isearch-barrier (nth 8 cmd))
1201     (goto-char (car (cdr (cdr cmd))))))
1202
1203 (defun isearch-pop-state ()
1204 ;;  (fetch-window-local-variables)
1205   (setq isearch-cmds (cdr isearch-cmds))
1206   (isearch-top-state)
1207   )
1208
1209 (defun isearch-push-state ()
1210   (setq isearch-cmds 
1211         (cons (list isearch-string isearch-message (point)
1212                     isearch-success isearch-forward isearch-other-end 
1213                     isearch-invalid-regexp isearch-wrapped isearch-barrier)
1214               isearch-cmds)))
1215
1216 \f
1217 ;;;==================================================================
1218 ;; Message string
1219
1220 (defun isearch-message (&optional c-q-hack ellipsis)
1221   ;; Generate and print the message string.
1222   (let ((cursor-in-echo-area ellipsis)
1223         (m (concat
1224             (isearch-message-prefix c-q-hack)
1225             isearch-message
1226             (isearch-message-suffix c-q-hack)
1227             )))
1228     (if c-q-hack m (display-message 'progress (format "%s" m)))))
1229
1230 (defun isearch-message-prefix (&optional c-q-hack nonincremental)
1231   ;; If about to search, and previous search regexp was invalid,
1232   ;; check that it still is.  If it is valid now,
1233   ;; let the message we display while searching say that it is valid.
1234   (and isearch-invalid-regexp
1235        (condition-case ()
1236            (progn (re-search-forward isearch-string (point) t)
1237                   (setq isearch-invalid-regexp nil))
1238          (error nil)))
1239   ;; #### - Yo!  Emacs assembles strings all over the place, they can't all
1240   ;; be internationalized in the manner proposed below...  Add an explicit
1241   ;; call to `gettext' and have the string snarfer pluck the english
1242   ;; strings out of the comment below.  XEmacs is on a purespace diet! -Stig
1243   (let ((m (concat (if isearch-success nil "failing ")
1244                    (if isearch-wrapped "wrapped ")
1245                    (if isearch-word "word ")
1246                    (if isearch-regexp "regexp ")
1247                    (if nonincremental "search" "I-search")
1248                    (if isearch-forward nil " backward")
1249                    ": "
1250                    )))
1251     (aset m 0 (upcase (aref m 0)))
1252     (gettext m)))
1253
1254 (defun isearch-message-suffix (&optional c-q-hack)
1255   (concat (if c-q-hack "^Q" "")
1256           (if isearch-invalid-regexp
1257               (concat " [" isearch-invalid-regexp "]")
1258             "")))
1259
1260 ;;;;; #### - yuck...this is soooo lame.  Is this really worth 4k of purespace???
1261 ;;;
1262 ;;;(let ((i (logior (if isearch-success 32 0)
1263 ;;;                (if isearch-wrapped 16 0)
1264 ;;;                (if isearch-word     8 0)
1265 ;;;                (if isearch-regexp   4 0)
1266 ;;;                (if nonincremental   2 0)
1267 ;;;                (if isearch-forward  1 0))))
1268 ;;;  (cond
1269 ;;;   ((= i 63) (gettext "Wrapped word regexp search: "))              ; 111111
1270 ;;;   ((= i 62) (gettext "Wrapped word regexp search backward: "))     ; 111110
1271 ;;;   ((= i 61) (gettext "Wrapped word regexp I-search: "))            ; 111101
1272 ;;;   ((= i 60) (gettext "Wrapped word regexp I-search backward: "))   ; 111100
1273 ;;;   ((= i 59) (gettext "Wrapped word search: "))                     ; 111011
1274 ;;;   ((= i 58) (gettext "Wrapped word search backward: "))            ; 111010
1275 ;;;   ((= i 57) (gettext "Wrapped word I-search: "))                   ; 111001
1276 ;;;   ((= i 56) (gettext "Wrapped word I-search backward: "))          ; 111000
1277 ;;;   ((= i 55) (gettext "Wrapped regexp search: "))                   ; 110111
1278 ;;;   ((= i 54) (gettext "Wrapped regexp search backward: "))          ; 110110
1279 ;;;   ((= i 53) (gettext "Wrapped regexp I-search: "))                 ; 110101
1280 ;;;   ((= i 52) (gettext "Wrapped regexp I-search backward: "))        ; 110100
1281 ;;;   ((= i 51) (gettext "Wrapped search: "))                          ; 110011
1282 ;;;   ((= i 50) (gettext "Wrapped search backward: "))                 ; 110010
1283 ;;;   ((= i 49) (gettext "Wrapped I-search: "))                        ; 110001
1284 ;;;   ((= i 48) (gettext "Wrapped I-search backward: "))               ; 110000
1285 ;;;   ((= i 47) (gettext "Word regexp search: "))                      ; 101111
1286 ;;;   ((= i 46) (gettext "Word regexp search backward: "))             ; 101110
1287 ;;;   ((= i 45) (gettext "Word regexp I-search: "))                    ; 101101
1288 ;;;   ((= i 44) (gettext "Word regexp I-search backward: "))           ; 101100
1289 ;;;   ((= i 43) (gettext "Word search: "))                             ; 101011
1290 ;;;   ((= i 42) (gettext "Word search backward: "))                    ; 101010
1291 ;;;   ((= i 41) (gettext "Word I-search: "))                           ; 101001
1292 ;;;   ((= i 40) (gettext "Word I-search backward: "))                  ; 101000
1293 ;;;   ((= i 39) (gettext "Regexp search: "))                           ; 100111
1294 ;;;   ((= i 38) (gettext "Regexp search backward: "))                  ; 100110
1295 ;;;   ((= i 37) (gettext "Regexp I-search: "))                         ; 100101
1296 ;;;   ((= i 36) (gettext "Regexp I-search backward: "))                ; 100100
1297 ;;;   ((= i 35) (gettext "Search: "))                                  ; 100011
1298 ;;;   ((= i 34) (gettext "Search backward: "))                         ; 100010
1299 ;;;   ((= i 33) (gettext "I-search: "))                                ; 100001
1300 ;;;   ((= i 32) (gettext "I-search backward: "))                       ; 100000
1301 ;;;   ((= i 31) (gettext "Failing wrapped word regexp search: "))      ; 011111
1302 ;;;   ((= i 30) (gettext "Failing wrapped word regexp search backward: ")) ; 011110
1303 ;;;   ((= i 29) (gettext "Failing wrapped word regexp I-search: "))    ; 011101
1304 ;;;   ((= i 28) (gettext "Failing wrapped word regexp I-search backward: ")) ; 011100
1305 ;;;   ((= i 27) (gettext "Failing wrapped word search: "))             ; 011011
1306 ;;;   ((= i 26) (gettext "Failing wrapped word search backward: "))    ; 011010
1307 ;;;   ((= i 25) (gettext "Failing wrapped word I-search: "))           ; 011001
1308 ;;;   ((= i 24) (gettext "Failing wrapped word I-search backward: "))  ; 011000
1309 ;;;   ((= i 23) (gettext "Failing wrapped regexp search: "))           ; 010111
1310 ;;;   ((= i 22) (gettext "Failing wrapped regexp search backward: "))  ; 010110
1311 ;;;   ((= i 21) (gettext "Failing wrapped regexp I-search: "))         ; 010101
1312 ;;;   ((= i 20) (gettext "Failing wrapped regexp I-search backward: ")) ; 010100
1313 ;;;   ((= i 19) (gettext "Failing wrapped search: "))                  ; 010011
1314 ;;;   ((= i 18) (gettext "Failing wrapped search backward: "))         ; 010010
1315 ;;;   ((= i 17) (gettext "Failing wrapped I-search: "))                ; 010001
1316 ;;;   ((= i 16) (gettext "Failing wrapped I-search backward: "))       ; 010000
1317 ;;;   ((= i 15) (gettext "Failing word regexp search: "))              ; 001111
1318 ;;;   ((= i 14) (gettext "Failing word regexp search backward: "))     ; 001110
1319 ;;;   ((= i 13) (gettext "Failing word regexp I-search: "))            ; 001101
1320 ;;;   ((= i 12) (gettext "Failing word regexp I-search backward: "))   ; 001100
1321 ;;;   ((= i 11) (gettext "Failing word search: "))                     ; 001011
1322 ;;;   ((= i 10) (gettext "Failing word search backward: "))            ; 001010
1323 ;;;   ((= i  9) (gettext "Failing word I-search: "))                   ; 001001
1324 ;;;   ((= i  8) (gettext "Failing word I-search backward: "))          ; 001000
1325 ;;;   ((= i  7) (gettext "Failing regexp search: "))                   ; 000111
1326 ;;;   ((= i  6) (gettext "Failing regexp search backward: "))          ; 000110
1327 ;;;   ((= i  5) (gettext "Failing regexp I-search: "))                 ; 000101
1328 ;;;   ((= i  4) (gettext "Failing regexp I-search backward: "))        ; 000100
1329 ;;;   ((= i  3) (gettext "Failing search: "))                          ; 000011
1330 ;;;   ((= i  2) (gettext "Failing search backward: "))                 ; 000010
1331 ;;;   ((= i  1) (gettext "Failing I-search: "))                        ; 000001
1332 ;;;   ((= i  0) (gettext "Failing I-search backward: "))               ; 000000
1333 ;;;   (t (error "Something's rotten")))))
1334
1335 \f
1336 ;;;========================================================
1337 ;;; Exiting
1338
1339 (put 'isearch-printing-char                     'isearch-command t)
1340 (put 'isearch-return-char                       'isearch-command t)
1341 (put 'isearch-repeat-forward                    'isearch-command t)
1342 (put 'isearch-repeat-backward                   'isearch-command t)
1343 (put 'isearch-delete-char                       'isearch-command t)
1344 (put 'isearch-help-or-delete-char               'isearch-command t)
1345 (put 'isearch-abort                             'isearch-command t)
1346 (put 'isearch-quote-char                        'isearch-command t)
1347 (put 'isearch-exit                              'isearch-command t)
1348 (put 'isearch-printing-char                     'isearch-command t)
1349 (put 'isearch-printing-char                     'isearch-command t)
1350 (put 'isearch-yank-word                         'isearch-command t)
1351 (put 'isearch-yank-line                         'isearch-command t)
1352 (put 'isearch-yank-kill                         'isearch-command t)
1353 (put 'isearch-yank-sexp                         'isearch-command t)
1354 (put 'isearch-*-char                            'isearch-command t)
1355 (put 'isearch-*-char                            'isearch-command t)
1356 (put 'isearch-|-char                            'isearch-command t)
1357 (put 'isearch-toggle-regexp                     'isearch-command t)
1358 (put 'isearch-toggle-case-fold                  'isearch-command t)
1359 (put 'isearch-edit-string                       'isearch-command t)
1360 (put 'isearch-mode-help                         'isearch-command t)
1361 (put 'isearch-ring-advance                      'isearch-command t)
1362 (put 'isearch-ring-retreat                      'isearch-command t)
1363 (put 'isearch-ring-advance-edit                 'isearch-command t)
1364 (put 'isearch-ring-retreat-edit                 'isearch-command t)
1365 (put 'isearch-whitespace-chars                  'isearch-command t)
1366 (put 'isearch-complete                          'isearch-command t)
1367 (put 'isearch-complete-edit                     'isearch-command t)
1368 (put 'isearch-edit-string                       'isearch-command t)
1369 (put 'isearch-toggle-regexp                     'isearch-command t)
1370 (put 'isearch-forward-exit-minibuffer           'isearch-command t)
1371 (put 'isearch-reverse-exit-minibuffer           'isearch-command t)
1372 (put 'isearch-nonincremental-exit-minibuffer    'isearch-command t)
1373 (put 'isearch-yank-x-selection                  'isearch-command t)
1374 (put 'isearch-yank-x-clipboard                  'isearch-command t)
1375
1376 ;; scrolling the scrollbar should not terminate isearch.
1377
1378 ;; vertical scrollbar:
1379 (put 'scrollbar-line-up                         'isearch-command t)
1380 (put 'scrollbar-line-down                       'isearch-command t)
1381 (put 'scrollbar-page-up                         'isearch-command t)
1382 (put 'scrollbar-page-down                       'isearch-command t)
1383 (put 'scrollbar-to-top                          'isearch-command t)
1384 (put 'scrollbar-to-bottom                       'isearch-command t)
1385 (put 'scrollbar-vertical-drag                   'isearch-command t)
1386
1387 ;; horizontal scrollbar:
1388 (put 'scrollbar-char-left                       'isearch-command t)
1389 (put 'scrollbar-char-right                      'isearch-command t)
1390 (put 'scrollbar-page-left                       'isearch-command t)
1391 (put 'scrollbar-page-right                      'isearch-command t)
1392 (put 'scrollbar-to-left                         'isearch-command t)
1393 (put 'scrollbar-to-right                        'isearch-command t)
1394 (put 'scrollbar-horizontal-drag                 'isearch-command t)
1395
1396 (defun isearch-pre-command-hook ()
1397   ;;
1398   ;; For use as the value of `pre-command-hook' when isearch-mode is active.
1399   ;; If the command about to be executed is not one of the isearch commands,
1400   ;; then isearch-mode is turned off before that command is executed.
1401   ;;
1402   ;; If the command about to be executed is self-insert-command, or is a
1403   ;; keyboard macro of a single key sequence which is bound to self-insert-
1404   ;; command, then we add those chars to the search ring instead of inserting
1405   ;; them in the buffer.  In this way, the set of self-searching characters
1406   ;; need not be exhaustively enumerated, but is derived from other maps.
1407   ;;
1408   (cond ((not (eq (current-buffer) isearch-buffer))
1409          ;; If the buffer (likely meaning "frame") has changed, bail.
1410          ;; This can also happen if a proc filter has popped up another
1411          ;; buffer, which is arguably a bad thing for it to have done,
1412          ;; but the way in which isearch would have hosed you in that
1413          ;; case is unarguably even worse. -jwz
1414          (isearch-done))
1415         (t
1416          (isearch-maybe-frob-keyboard-macros)
1417          (if (and this-command
1418                   (symbolp this-command)
1419                   (get this-command 'isearch-command))
1420              nil ; then continue.
1421            (isearch-done)))))
1422
1423 (defun isearch-maybe-frob-keyboard-macros ()
1424   ;;
1425   ;; If the command about to be executed is `self-insert-command' then change
1426   ;; the command to `isearch-printing-char' instead, meaning add the last-
1427   ;; typed character to the search string.
1428   ;;
1429   ;; If `this-command' is a string or a vector (that is, a keyboard macro)
1430   ;; and it contains only one command, which is bound to self-insert-command,
1431   ;; then do the same thing as for self-inserting commands: arrange for that
1432   ;; character to be added to the search string.  If we didn't do this, then
1433   ;; typing a compose sequence (a la x-compose.el) would terminate the search
1434   ;; and insert the character, instead of searching for that character.
1435   ;;
1436   ;; We should continue doing this, since it's pretty much the behavior one
1437   ;; would expect, but it will stop being so necessary once key-translation-
1438   ;; map exists and is used by x-compose.el and things like it, since the
1439   ;; translation will have been done before we see the keys.
1440   ;;
1441   (cond ((eq this-command 'self-insert-command)
1442          (setq this-command 'isearch-printing-char))
1443         ((and (or (stringp this-command) (vectorp this-command))
1444               (eq (key-binding this-command) 'self-insert-command))
1445          (setq last-command-event (character-to-event (aref this-command 0))
1446                last-command-char (and (stringp this-command)
1447                                       (aref this-command 0))
1448                this-command 'isearch-printing-char))
1449         ))
1450
1451 \f
1452 ;;;========================================================
1453 ;;; Highlighting
1454
1455 (defcustom isearch-highlight t
1456   "*Whether isearch and query-replace should highlight the text which 
1457 currently matches the search-string.")
1458
1459 (defvar isearch-extent nil)
1460
1461 ;; this face is initialized by x-faces.el since isearch is preloaded.
1462 ;; this face is now created in initialize-faces
1463 ;;(make-face 'isearch)
1464
1465 (defun isearch-make-extent (begin end)
1466   (let ((x (make-extent begin end (current-buffer))))
1467     ;; make the isearch extent always take prescedence over any mouse-
1468     ;; highlighted extents we may be passing through, since isearch, being
1469     ;; modal, is more interesting (there's nothing they could do with a
1470     ;; mouse-highlighted extent while in the midst of a search anyway).
1471     (set-extent-priority x (1+ mouse-highlight-priority))
1472     (set-extent-face x 'isearch)
1473     (setq isearch-extent x)))
1474
1475 (defun isearch-highlight (begin end)
1476   (if (null isearch-highlight)
1477       nil
1478     ;; make sure isearch-extent is in the current buffer
1479     (or (extentp isearch-extent)
1480         (isearch-make-extent begin end))
1481     (set-extent-endpoints isearch-extent begin end (current-buffer))))
1482
1483 (defun isearch-dehighlight (totally)
1484   (if (and isearch-highlight isearch-extent)
1485       (if totally
1486           (let ((inhibit-quit t))
1487             (if (extentp isearch-extent)
1488                 (delete-extent isearch-extent))
1489             (setq isearch-extent nil))
1490         (if (extentp isearch-extent)
1491             (detach-extent isearch-extent)
1492           (setq isearch-extent nil)))))
1493
1494 \f
1495 ;;;========================================================
1496 ;;; Searching
1497
1498 (defun isearch-search ()
1499   ;; Do the search with the current search string.
1500   (isearch-message nil t)
1501   (isearch-fix-case)
1502   (condition-case lossage
1503       (let ((inhibit-quit nil)
1504             (case-fold-search isearch-case-fold-search))
1505         (if isearch-regexp (setq isearch-invalid-regexp nil))
1506         (setq isearch-success
1507               (funcall
1508                (cond (isearch-word
1509                       (if isearch-forward
1510                           'word-search-forward 'word-search-backward))
1511                      (isearch-regexp
1512                       (if isearch-forward
1513                           're-search-forward 're-search-backward))
1514                      (t
1515                       (if isearch-forward 'search-forward 'search-backward)))
1516                isearch-string nil t))
1517         (setq isearch-just-started nil)
1518         (if isearch-success
1519             (setq isearch-other-end
1520                   (if isearch-forward (match-beginning 0) (match-end 0)))))
1521
1522     (quit (setq unread-command-event (character-to-event (quit-char)))
1523           (setq isearch-success nil))
1524
1525     (invalid-regexp 
1526      (setq isearch-invalid-regexp (car (cdr lossage)))
1527      (if (string-match
1528           "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
1529           isearch-invalid-regexp)
1530          (setq isearch-invalid-regexp (gettext "incomplete input")))))
1531
1532   (if isearch-success
1533       nil
1534
1535     ;; If we're being run inside a keyboard macro, then the call to
1536     ;; ding will signal an error (to terminate the macro).  We must
1537     ;; turn off isearch-mode first, so that we aren't still in isearch
1538     ;; mode after the macro exits.  Note that isearch-recursive-edit
1539     ;; must not be true if a keyboard macro is executing.
1540     (if (and executing-kbd-macro (not defining-kbd-macro))
1541         (progn
1542           (isearch-done)
1543           (ding nil 'isearch-failed)))
1544
1545     ;; Ding if failed this time after succeeding last time.
1546     (and (nth 3 (car isearch-cmds))
1547          (ding nil 'isearch-failed))
1548     (goto-char (nth 2 (car isearch-cmds)))))
1549
1550 ;;;=================================================
1551 ;; This is called from incremental-search
1552 ;; if the first input character is the exit character.
1553
1554 ;; We store the search string in `isearch-string'
1555 ;; which has been bound already by `isearch-search'
1556 ;; so that, when we exit, it is copied into `search-last-string'.
1557
1558 ;(defun nonincremental-search (forward regexp)
1559 ;  ;; This may be broken.  Anyway, it is replaced by the isearch-edit-string.
1560 ;  ;; Missing features: word search option, command history.
1561 ;  (setq isearch-forward forward
1562 ;       isearch-regexp regexp)
1563 ;  (let (char function
1564 ;       inhibit-quit
1565 ;       (cursor-in-echo-area t))
1566 ;    ;; Prompt assuming not word search,
1567 ;    (setq isearch-message 
1568 ;         (if isearch-regexp 
1569 ;             (if isearch-forward "Regexp search: "
1570 ;               "Regexp search backward: ")
1571 ;           (if isearch-forward "Search: " "Search backward: ")))
1572 ;    (message "%s" isearch-message)
1573 ;    ;; Read 1 char and switch to word search if it is ^W.
1574 ;    (setq char (read-char))
1575 ;    (if (eq char search-yank-word-char)
1576 ;       (setq isearch-message (if isearch-forward "Word search: " 
1577 ;                               "Word search backward: "))
1578 ;      ;; Otherwise let that 1 char be part of the search string.
1579 ;      (setq unread-command-event (character-to-event char))
1580 ;      )
1581 ;    (setq function
1582 ;         (if (eq char search-yank-word-char)
1583 ;             (if isearch-forward 'word-search-forward 'word-search-backward)
1584 ;           (if isearch-regexp
1585 ;               (if isearch-forward 're-search-forward 're-search-backward)
1586 ;             (if isearch-forward 'search-forward 'search-backward))))
1587 ;    ;; Read the search string with corrected prompt.
1588 ;    (setq isearch-string (read-string isearch-message isearch-string))
1589 ;    ;; Empty means use default.
1590 ;    (if (= 0 (length isearch-string))
1591 ;       (setq isearch-string search-last-string)
1592 ;      ;; Set last search string now so it is set even if we fail.
1593 ;      (setq search-last-string isearch-string))
1594 ;    ;; Since we used the minibuffer, we should be available for redo.
1595 ;    (setq command-history 
1596 ;         (cons (list function isearch-string) command-history))
1597 ;    ;; Go ahead and search.
1598 ;    (if search-caps-disable-folding
1599 ;       (setq isearch-case-fold-search 
1600 ;             (no-upper-case-p isearch-string isearch-regexp)))
1601 ;    (let ((case-fold-search isearch-case-fold-search))
1602 ;      (funcall function isearch-string))))
1603
1604 (defun isearch-no-upper-case-p (string)
1605   "Return t if there are no upper case chars in string.
1606 But upper case chars preceded by \\ do not count since they
1607 have special meaning in a regexp."
1608   ;; this incorrectly returns t for "\\\\A"
1609   (let ((case-fold-search nil))
1610     (not (string-match "\\(^\\|[^\\]\\)[A-Z]" string))))
1611 (make-obsolete 'isearch-no-upper-case-p 'no-upper-case-p)
1612
1613 ;; Used by etags.el and info.el
1614 (defmacro with-caps-disable-folding (string &rest body) "\
1615 Eval BODY with `case-fold-search' let to nil if STRING contains
1616 uppercase letters and `search-caps-disable-folding' is t."
1617   `(let ((case-fold-search
1618           (if (and case-fold-search search-caps-disable-folding)
1619               (isearch-no-upper-case-p ,string)
1620             case-fold-search)))
1621      ,@body))
1622 (make-obsolete 'with-caps-disable-folding 'with-search-caps-disable-folding)
1623 (put 'with-caps-disable-folding 'lisp-indent-function 1)
1624 (put 'with-caps-disable-folding 'edebug-form-spec '(form body))
1625
1626 ;;; isearch-mode.el ends here