isearch.el 51.5 KB
Newer Older
1
;;; isearch.el --- incremental search minor mode.
2

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

5 6
;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>

7
;; |$Date: 1994/05/07 01:33:23 $|$Revision: 1.68 $
Jim Blandy's avatar
Jim Blandy committed
8

David J. MacKenzie's avatar
David J. MacKenzie committed
9
;; This file is part of GNU Emacs.
Jim Blandy's avatar
Jim Blandy committed
10

11 12 13 14 15
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

Jim Blandy's avatar
Jim Blandy committed
16
;; GNU Emacs is distributed in the hope that it will be useful,
17 18 19 20 21 22 23
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
Jim Blandy's avatar
Jim Blandy committed
24

25 26
;;; Commentary:

Jim Blandy's avatar
Jim Blandy committed
27 28 29
;;;====================================================================
;; Instructions

30 31 32 33 34
;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
;; isearch-mode behaves modally and does not return until the search
;; is completed.  It uses a recursive-edit to behave this way.  Note:
;; gnus does it wrong: (call-interactively 'isearch-forward).

Jim Blandy's avatar
Jim Blandy committed
35
;; The key bindings active within isearch-mode are defined below in
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
;; `isearch-mode-map' which is given bindings close to the default
;; characters of the original isearch.el.  With `isearch-mode',
;; however, you can bind multi-character keys and it should be easier
;; to add new commands.  One bug though: keys with meta-prefix cannot
;; be longer than two chars.  Also see minibuffer-local-isearch-map
;; for bindings active during `isearch-edit-string'.

;; Note to emacs version 19 users: isearch-mode should work even if
;; you switch windows with the mouse, in which case isearch-mode is
;; terminated automatically before the switch.  This is true of lemacs
;; too, with a few more cleanups I've neglected in this release. 
;; No one has supplied patches for epoch yet.

;; The search ring and completion commands automatically put you in
;; the minibuffer to edit the string.  This gives you a chance to
;; modify the search string before executing the search.  There are
;; three commands to terminate the editing: C-s and C-r exit the
;; minibuffer and search forward and reverse respectively, while C-m
;; exits and does a nonincremental search.

;; Exiting immediately from isearch uses isearch-edit-string instead
;; of nonincremental-search, if search-nonincremental-instead is non-nil.
;; The name of this option should probably be changed if we decide to
;; keep the behavior.  No point in forcing nonincremental search until
;; the last possible moment.

;; TODO
63
;; - Integrate the emacs 19 generalized command history.
64 65
;; - Think about incorporating query-replace.
;; - Hooks and options for failed search.
Eric S. Raymond's avatar
Eric S. Raymond committed
66

67 68
;;; Change Log:

69 70
;;; Changes before those recorded in ChangeLog:

71 72 73 74 75 76 77 78 79
;;; Revision 1.4  92/09/14  16:26:02  liberte
;;; Added prefix args to isearch-forward, etc. to switch between
;;;    string and regular expression searching.
;;; Added some support for lemacs.
;;; Added general isearch-highlight option - but only for lemacs so far.
;;; Added support for frame switching in emacs 19.
;;; Added word search option to isearch-edit-string.
;;; Renamed isearch-quit to isearch-abort.
;;; Numerous changes to comments and doc strings.
Eric S. Raymond's avatar
Eric S. Raymond committed
80
;;; 
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
;;; Revision 1.3  92/06/29  13:10:08  liberte
;;; Moved modal isearch-mode handling into isearch-mode.
;;; Got rid of buffer-local isearch variables.
;;; isearch-edit-string used by ring adjustments, completion, and
;;; nonincremental searching.  C-s and C-r are additional exit commands.
;;; Renamed all regex to regexp.
;;; Got rid of found-start and found-point globals.
;;; Generalized handling of upper-case chars.
 
;;; Revision 1.2  92/05/27  11:33:57  liberte
;;; Emacs version 19 has a search ring, which is supported here.
;;; Other fixes found in the version 19 isearch are included here.
;;;
;;; Also see variables search-caps-disable-folding,
;;; search-nonincremental-instead, search-whitespace-regexp, and
;;; commands isearch-toggle-regexp, isearch-edit-string.
;;;
;;; semi-modal isearching is supported.
Eric S. Raymond's avatar
Eric S. Raymond committed
99 100 101 102 103

;;; Changes for 1.1
;;; 3/18/92 Fixed invalid-regexp.
;;; 3/18/92 Fixed yanking in regexps.

104
;;; Code:
105 106 107 108 109 110 111 112 113 114 115


;;;=========================================================================
;;; Emacs features

;; isearch-mode takes advantage of the features provided by several
;; different versions of emacs.  Rather than testing the version of
;; emacs, several constants are defined, one for each of the features.
;; Each of the tests below must work on any version of emacs.
;; (Perhaps provide and featurep could be used for this purpose.)

116
(defconst isearch-gnu-emacs-events (fboundp 'set-frame-height)) ;; emacs 19
117
(defconst isearch-pre-command-hook-exists (boundp 'pre-command-hook)) ;; lemacs
118
(defconst isearch-event-data-type nil)  ;; lemacs
119

120
(defconst search-exit-option t
121
  "*Non-nil means random control characters terminate incremental search.")
122 123 124 125 126 127 128 129 130 131 132

(defvar search-slow-window-lines 1
  "*Number of lines in slow search display windows.
These are the short windows used during incremental search on slow terminals.
Negative means put the slow search window at the top (normally it's at bottom)
and the value is minus the number of lines.")

(defvar search-slow-speed 1200
  "*Highest terminal speed at which to use \"slow\" style incremental search.
This is the style where a one-line window is created to show the line
that the search has reached.")
Jim Blandy's avatar
Jim Blandy committed
133 134 135 136

;;;========================================================================
;;; Some additional options and constants.

137
(defvar search-upper-case 'not-yanks
Jim Blandy's avatar
Jim Blandy committed
138
  "*If non-nil, upper case chars disable case fold searching.
139 140
That is, upper and lower case chars must match exactly.
This applies no matter where the chars come from, but does not
141 142
apply to chars in regexps that are prefixed with `\\'.
If this value is `not-yanks', yanked text is always downcased.")
Jim Blandy's avatar
Jim Blandy committed
143 144 145

(defvar search-nonincremental-instead t
  "*If non-nil, do a nonincremental search instead if exiting immediately.
146 147
Actually, `isearch-edit-string' is called to let you enter the search
string, and RET terminates editing and does a nonincremental search.")
Jim Blandy's avatar
Jim Blandy committed
148 149 150 151 152

(defconst search-whitespace-regexp "\\s-+"
  "*If non-nil, regular expression to match a sequence of whitespace chars.
You might want to use something like \"[ \\t\\r\\n]+\" instead.")

153 154 155
;; I removed the * from the doc string because highlighting is not 
;; currently a clean thing to do.  Once highlighting is made clean, 
;; this feature can be re-enabled and advertised.
156
(defvar search-highlight nil
157
  "*Non-nil means incremental search highlights the current match.")
158 159 160 161 162 163 164

(defvar isearch-mode-hook nil
  "Function(s) to call after starting up an incremental search.")

(defvar isearch-mode-end-hook nil
  "Function(s) to call after terminating an incremental search.")

Jim Blandy's avatar
Jim Blandy committed
165 166 167 168 169
;;;==================================================================
;;; Search ring.

(defvar search-ring nil
  "List of search string sequences.")
170
(defvar regexp-search-ring nil
Jim Blandy's avatar
Jim Blandy committed
171 172 173 174
  "List of regular expression search string sequences.")

(defconst search-ring-max 16
  "*Maximum length of search ring before oldest elements are thrown away.")
175 176
(defconst regexp-search-ring-max 16
  "*Maximum length of regexp search ring before oldest elements are thrown away.")
Jim Blandy's avatar
Jim Blandy committed
177 178

(defvar search-ring-yank-pointer nil
179 180
  "Index in `search-ring' of last string reused.
nil if none yet.")
181
(defvar regexp-search-ring-yank-pointer nil
182 183
  "Index in `regexp-search-ring' of last string reused.
nil if none yet.")
Jim Blandy's avatar
Jim Blandy committed
184

185 186 187 188
(defvar search-ring-update nil
  "*Non-nil if advancing or retreating in the search ring should cause search.
Default value, nil, means edit the string instead.")

Jim Blandy's avatar
Jim Blandy committed
189 190 191 192 193 194
;;;====================================================
;;; Define isearch-mode keymap.

(defvar isearch-mode-map nil
  "Keymap for isearch-mode.")

195 196
(or isearch-mode-map
    (let* ((i 0)
197
	   (map (make-keymap)))
198 199 200 201 202
      (or (vectorp (nth 1 map))
	  (error "The initialization of isearch-mode-map must be updated"))
      ;; Give this map a vector 256 long, for dense binding
      ;; of a larger range of ordinary characters.
      (setcar (cdr map) (make-vector 256 nil))
203

204 205
      ;; Make function keys, etc, exit the search.
      (define-key map [t] 'isearch-other-control-char)
206
      ;; Control chars, by default, end isearch mode transparently.
207 208 209
      ;; We need these explicit definitions because, in a dense keymap, 
      ;; the binding for t does not affect characters.
      ;; We use a dense keymap to save space.
210 211 212 213
      (while (< i ?\ )
	(define-key map (make-string 1 i) 'isearch-other-control-char)
	(setq i (1+ i)))

214
      ;; Printing chars extend the search string by default.
215
      (setq i ?\ )
216
      (while (< i (length (nth 1 map)))
217
	(define-key map (vector i) 'isearch-printing-char)
218 219 220 221 222 223 224
	(setq i (1+ i)))

      ;; Several non-printing chars change the searching behavior.
      (define-key map "\C-s" 'isearch-repeat-forward)
      (define-key map "\C-r" 'isearch-repeat-backward)
      (define-key map "\177" 'isearch-delete-char)
      (define-key map "\C-g" 'isearch-abort)
Jim Blandy's avatar
Jim Blandy committed
225
    
226 227 228 229 230 231
      (define-key map "\C-q" 'isearch-quote-char)

      (define-key map "\r" 'isearch-exit)
      (define-key map "\C-j" 'isearch-printing-char)
      (define-key map "\t" 'isearch-printing-char)
      (define-key map " " 'isearch-whitespace-chars)
Jim Blandy's avatar
Jim Blandy committed
232
    
233 234
      (define-key map "\C-w" 'isearch-yank-word)
      (define-key map "\C-y" 'isearch-yank-line)
235 236 237
      (define-key map [mouse-2] 'isearch-yank-kill)
      ;; This overrides the default binding for t.
      (define-key map [down-mouse-2] 'nil)
238

239 240 241 242 243
      ;; Bind the ASCII-equivalent "function keys" explicitly
      ;; if we bind their equivalents, 
      ;; since otherwise the default binding would override.
      ;; We bind [escape] below.
      (define-key map [tab] 'isearch-printing-char)
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
      (define-key map [kp-0] 'isearch-printing-char)
      (define-key map [kp-1] 'isearch-printing-char)
      (define-key map [kp-2] 'isearch-printing-char)
      (define-key map [kp-3] 'isearch-printing-char)
      (define-key map [kp-4] 'isearch-printing-char)
      (define-key map [kp-5] 'isearch-printing-char)
      (define-key map [kp-6] 'isearch-printing-char)
      (define-key map [kp-7] 'isearch-printing-char)
      (define-key map [kp-8] 'isearch-printing-char)
      (define-key map [kp-9] 'isearch-printing-char)
      (define-key map [kp-add] 'isearch-printing-char)
      (define-key map [kp-subtract] 'isearch-printing-char)
      (define-key map [kp-multiply] 'isearch-printing-char)
      (define-key map [kp-divide] 'isearch-printing-char)
      (define-key map [kp-decimal] 'isearch-printing-char)
      (define-key map [kp-separator] 'isearch-printing-char)
      (define-key map [kp-equal] 'isearch-printing-char)
      (define-key map [kp-tab] 'isearch-printing-char)
      (define-key map [kp-space] 'isearch-printing-char)
      (define-key map [kp-enter] 'isearch-exit)
264 265 266 267 268
      (define-key map [delete] 'isearch-delete-char)
      (define-key map [backspace] 'isearch-delete-char)
      (define-key map [return] 'isearch-exit)
      (define-key map [newline] 'isearch-printing-char)

269 270 271 272 273 274
      ;; Define keys for regexp chars * ? |.
      ;; Nothing special for + because it matches at least once.
      (define-key map "*" 'isearch-*-char)
      (define-key map "?" 'isearch-*-char)
      (define-key map "|" 'isearch-|-char)

275 276 277
;;; Turned off because I find I expect to get the global definition--rms.
;;;      ;; Instead bind C-h to special help command for isearch-mode.
;;;      (define-key map "\C-h" 'isearch-mode-help)
278 279 280 281 282 283

      ;; To handle local bindings with meta char prefix keys, define
      ;; another full keymap.  This must be done for any other prefix
      ;; keys as well, one full keymap per char of the prefix key.  It
      ;; would be simpler to disable the global keymap, and/or have a
      ;; default local key binding for any key not otherwise bound.
284 285 286
      (let ((meta-map (make-sparse-keymap)))
	(define-key map (char-to-string meta-prefix-char) meta-map)
	(define-key map [escape] meta-map))
287
      (define-key map (vector meta-prefix-char t) 'isearch-other-meta-char)
288 289 290

      (define-key map "\M-n" 'isearch-ring-advance)
      (define-key map "\M-p" 'isearch-ring-retreat)
291
      (define-key map "\M-y" 'isearch-yank-kill)
292

293 294 295
      (define-key map "\M-\t" 'isearch-complete)

      ;; For emacs 19, switching frames should terminate isearch-mode
296
      (if isearch-gnu-emacs-events
297 298 299 300
	  (define-key map [switch-frame] 'isearch-switch-frame-handler))
      
      (setq isearch-mode-map map)
      ))
Jim Blandy's avatar
Jim Blandy committed
301

302 303
;; Some bindings you may want to put in your isearch-mode-hook.
;; Suggest some alternates...
304
;; (define-key isearch-mode-map "\C-t" 'isearch-toggle-case-fold)
305 306
;; (define-key isearch-mode-map "\C-t" 'isearch-toggle-regexp)
;; (define-key isearch-mode-map "\C-^" 'isearch-edit-string)
Jim Blandy's avatar
Jim Blandy committed
307 308


309 310
(defvar minibuffer-local-isearch-map nil
  "Keymap for editing isearch strings in the minibuffer.")
Jim Blandy's avatar
Jim Blandy committed
311

312 313 314
(or minibuffer-local-isearch-map
    (let ((map (copy-keymap minibuffer-local-map)))
      (define-key map "\r" 'isearch-nonincremental-exit-minibuffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
315 316
      (define-key map "\M-n" 'isearch-ring-advance-edit)
      (define-key map "\M-p" 'isearch-ring-retreat-edit)
317 318 319 320 321
      (define-key map "\M-\t" 'isearch-complete-edit)
      (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
      (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
      (setq minibuffer-local-isearch-map map)
      ))
Jim Blandy's avatar
Jim Blandy committed
322 323 324

;;;========================================================
;; Internal variables declared globally for byte-compiler.
325 326 327 328 329 330 331 332 333 334 335 336 337
;; These are all set with setq while isearching
;; and bound locally while editing the search string.

(defvar isearch-forward nil)	; Searching in the forward direction.
(defvar isearch-regexp nil)	; Searching for a regexp.
(defvar isearch-word nil)	; Searching for words.

(defvar isearch-cmds nil)   ; Stack of search status sets.
(defvar isearch-string "")  ; The current search string.
(defvar isearch-message "") ; text-char-description version of isearch-string

(defvar isearch-success t)		; Searching is currently successful.
(defvar isearch-invalid-regexp nil)	; Regexp not well formed.
338
(defvar isearch-within-brackets nil)	; Regexp has unclosed [.
339 340
(defvar isearch-other-end nil)	; Start (end) of match if forward (backward).
(defvar isearch-wrapped nil)	; Searching restarted from the top (bottom).
Jim Blandy's avatar
Jim Blandy committed
341 342
(defvar isearch-barrier 0)

343 344 345 346
; case-fold-search while searching.
;   either nil, t, or 'yes.  'yes means the same as t except that mixed
;   case in the search string is ignored.
(defvar isearch-case-fold-search nil)
Jim Blandy's avatar
Jim Blandy committed
347 348 349

(defvar isearch-adjusted nil)
(defvar isearch-slow-terminal-mode nil)
350 351
;;; If t, using a small window.
(defvar isearch-small-window nil)
Jim Blandy's avatar
Jim Blandy committed
352
(defvar isearch-opoint 0)
353 354
;;; The window configuration active at the beginning of the search.
(defvar isearch-window-configuration nil)
Jim Blandy's avatar
Jim Blandy committed
355

356 357
;; Flag to indicate a yank occurred, so don't move the cursor.
(defvar isearch-yank-flag nil)
Jim Blandy's avatar
Jim Blandy committed
358

359 360 361 362
;;; A function to be called after each input character is processed.
;;; (It is not called after characters that exit the search.)
;;; It is only set from an optional argument to `isearch-mode'.
(defvar isearch-op-fun nil)
Jim Blandy's avatar
Jim Blandy committed
363

364 365
;;;  Is isearch-mode in a recursive edit for modal searching.
(defvar isearch-recursive-edit nil)
Jim Blandy's avatar
Jim Blandy committed
366

367 368 369 370 371
;;; Should isearch be terminated after doing one search?
(defvar isearch-nonincremental nil)

;; New value of isearch-forward after isearch-edit-string.
(defvar isearch-new-forward nil)
Jim Blandy's avatar
Jim Blandy committed
372 373 374 375 376 377 378 379 380 381


;;;==============================================================
;; Minor-mode-alist changes - kind of redundant with the
;; echo area, but if isearching in multiple windows, it can be useful.

(or (assq 'isearch-mode minor-mode-alist)
    (nconc minor-mode-alist
	   (list '(isearch-mode isearch-mode))))

382
(defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
Jim Blandy's avatar
Jim Blandy committed
383 384
(make-variable-buffer-local 'isearch-mode)

385 386 387 388 389
(define-key global-map "\C-s" 'isearch-forward)
(define-key esc-map "\C-s" 'isearch-forward-regexp)
(define-key global-map "\C-r" 'isearch-backward)
(define-key esc-map "\C-r" 'isearch-backward-regexp)

Jim Blandy's avatar
Jim Blandy committed
390 391
;;;===============================================================
;;; Entry points to isearch-mode.
392
;;; These four functions should replace those in loaddefs.el
393
;;; An alternative is to defalias isearch-forward etc to isearch-mode,
394
;;; and look at this-command to set the options accordingly.
Jim Blandy's avatar
Jim Blandy committed
395

396
(defun isearch-forward (&optional regexp-p no-recursive-edit)
Jim Blandy's avatar
Jim Blandy committed
397 398
  "\
Do incremental search forward.
399 400
With a prefix argument, do an incremental regular expression search instead.
\\<isearch-mode-map>
Jim Blandy's avatar
Jim Blandy committed
401
As you type characters, they add to the search string and are found.
402
The following non-printing keys are bound in `isearch-mode-map'.  
Jim Blandy's avatar
Jim Blandy committed
403

404
Type \\[isearch-delete-char] to cancel characters from end of search string.
Jim Blandy's avatar
Jim Blandy committed
405
Type \\[isearch-exit] to exit, leaving point at location found.
406 407 408 409 410 411 412
Type LFD (C-j) to match end of line.
Type \\[isearch-repeat-forward] to search again forward,\
 \\[isearch-repeat-backward] to search again backward.
Type \\[isearch-yank-word] to yank word from buffer onto end of search\
 string and search for it.
Type \\[isearch-yank-line] to yank rest of line onto end of search string\
 and search for it.
Jim Blandy's avatar
Jim Blandy committed
413
Type \\[isearch-quote-char] to quote control character to search for it.
414 415 416 417 418
\\[isearch-abort] while searching or when search has failed cancels input\
 back to what has
 been found successfully.
\\[isearch-abort] when search is successful aborts and moves point to\
 starting point.
Jim Blandy's avatar
Jim Blandy committed
419 420 421

Also supported is a search ring of the previous 16 search strings.
Type \\[isearch-ring-advance] to search for the next item in the search ring.
422 423 424
Type \\[isearch-ring-retreat] to search for the previous item in the search\
 ring.
Type \\[isearch-complete] to complete the search string using the search ring.
Jim Blandy's avatar
Jim Blandy committed
425

426 427
The above keys, bound in `isearch-mode-map', are often controlled by 
 options; do M-x apropos on search-.* to find them.
Jim Blandy's avatar
Jim Blandy committed
428
Other control and meta characters terminate the search
429
 and are then executed normally (depending on `search-exit-option').
Jim Blandy's avatar
Jim Blandy committed
430

431 432
If this function is called non-interactively, it does not return to
the calling function until the search is done."
Jim Blandy's avatar
Jim Blandy committed
433

434
  (interactive "P\np")
435
  (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
Jim Blandy's avatar
Jim Blandy committed
436

437
(defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
Jim Blandy's avatar
Jim Blandy committed
438 439
  "\
Do incremental search forward for regular expression.
440
With a prefix argument, do a regular string search instead.
Jim Blandy's avatar
Jim Blandy committed
441 442
Like ordinary incremental search except that your input
is treated as a regexp.  See \\[isearch-forward] for more info."
443
  (interactive "P\np")
444
  (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
Jim Blandy's avatar
Jim Blandy committed
445

446
(defun isearch-backward (&optional regexp-p no-recursive-edit)
Jim Blandy's avatar
Jim Blandy committed
447 448
  "\
Do incremental search backward.
449
With a prefix argument, do a regular expression search instead.
Jim Blandy's avatar
Jim Blandy committed
450
See \\[isearch-forward] for more information."
451
  (interactive "P\np")
452
  (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
Jim Blandy's avatar
Jim Blandy committed
453

454
(defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
Jim Blandy's avatar
Jim Blandy committed
455 456
  "\
Do incremental search backward for regular expression.
457
With a prefix argument, do a regular string search instead.
Jim Blandy's avatar
Jim Blandy committed
458 459
Like ordinary incremental search except that your input
is treated as a regexp.  See \\[isearch-forward] for more info."
460
  (interactive "P\np")
461
  (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
462 463 464 465 466 467


(defun isearch-mode-help ()
  (interactive)
  (describe-function 'isearch-forward)
  (isearch-update))
Jim Blandy's avatar
Jim Blandy committed
468 469 470 471 472 473


;;;==================================================================
;; isearch-mode only sets up incremental search for the minor mode.
;; All the work is done by the isearch-mode commands.

474 475 476 477 478 479 480
;; Not used yet:
;;(defconst isearch-commands '(isearch-forward isearch-backward
;;			     isearch-forward-regexp isearch-backward-regexp)
;;  "List of commands for which isearch-mode does not recursive-edit.")
			     

(defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p)
Jim Blandy's avatar
Jim Blandy committed
481 482 483 484 485
  "Start isearch minor mode.  Called by isearch-forward, etc."

  ;; Initialize global vars.
  (setq isearch-forward forward
	isearch-regexp regexp
486
	isearch-word word-p
Jim Blandy's avatar
Jim Blandy committed
487 488 489 490 491 492 493 494 495 496 497
	isearch-op-fun op-fun
	isearch-case-fold-search case-fold-search
	isearch-string ""
	isearch-message ""
	isearch-cmds nil
	isearch-success t
	isearch-wrapped nil
	isearch-barrier (point)
	isearch-adjusted nil
	isearch-yank-flag nil
	isearch-invalid-regexp nil
498
	isearch-within-brackets nil
Joseph Arceneaux's avatar
Joseph Arceneaux committed
499 500
	;; Use (baud-rate) for now, for sake of other versions.
	isearch-slow-terminal-mode (and (<= (baud-rate) search-slow-speed)
Jim Blandy's avatar
Jim Blandy committed
501 502 503 504 505 506
					(> (window-height)
					   (* 4 search-slow-window-lines)))
	isearch-other-end nil
	isearch-small-window nil

	isearch-opoint (point)
507 508
	search-ring-yank-pointer nil
	regexp-search-ring-yank-pointer nil)
509 510
  (setq isearch-window-configuration
	(if isearch-slow-terminal-mode (current-window-configuration) nil))
511

512 513 514 515
;; This was for Lucid Emacs.  But now that we have pre-command-hook,
;; it causes trouble.
;;  (if isearch-pre-command-hook-exists
;;      (add-hook 'pre-command-hook 'isearch-pre-command-hook))
Jim Blandy's avatar
Jim Blandy committed
516 517 518
  (setq	isearch-mode " Isearch")  ;; forward? regexp?
  (set-buffer-modified-p (buffer-modified-p)) ; update modeline

519 520 521 522
  ;; It is ugly to show region highlighting while the search
  ;; is going on.  And we don't want the mark active at the end either.
  (setq deactivate-mark t)      

Jim Blandy's avatar
Jim Blandy committed
523 524
  (isearch-push-state)

525 526
  (make-local-variable 'overriding-local-map)
  (setq overriding-local-map isearch-mode-map)
Jim Blandy's avatar
Jim Blandy committed
527 528
  (isearch-update)
  (run-hooks 'isearch-mode-hook)
529 530 531 532

  ;; isearch-mode can be made modal (in the sense of not returning to 
  ;; the calling function until searching is completed) by entering 
  ;; a recursive-edit and exiting it when done isearching.
533 534 535
  (if recursive-edit
      (let ((isearch-recursive-edit t))
	(recursive-edit)))
Jim Blandy's avatar
Jim Blandy committed
536 537 538 539 540 541 542 543
  )


;;;====================================================
;; Some high level utilities.  Others below.

(defun isearch-update ()
  ;; Called after each command to update the display.  
544
  (if (if isearch-event-data-type
545
	  (null unread-command-event)
546
	(if isearch-gnu-emacs-events
Jim Blandy's avatar
Jim Blandy committed
547
	    (null unread-command-events)
548
	  (< unread-command-char 0)))
Jim Blandy's avatar
Jim Blandy committed
549 550 551 552 553 554
      (progn
	(if (not (input-pending-p))
	    (isearch-message))
	(if (and isearch-slow-terminal-mode
		 (not (or isearch-small-window 
			  (pos-visible-in-window-p))))
555
	    (let ((found-point (point)))
Jim Blandy's avatar
Jim Blandy committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569
	      (setq isearch-small-window t)
	      (move-to-window-line 0)
	      (let ((window-min-height 1))
		(split-window nil (if (< search-slow-window-lines 0)
				      (1+ (- search-slow-window-lines))
				    (- (window-height)
				       (1+ search-slow-window-lines)))))
	      (if (< search-slow-window-lines 0)
		  (progn (vertical-motion (- 1 search-slow-window-lines))
			 (set-window-start (next-window) (point))
			 (set-window-hscroll (next-window)
					     (window-hscroll))
			 (set-window-hscroll (selected-window) 0))
		(other-window 1))
570 571 572 573
	      (goto-char found-point)))
	(if isearch-other-end
	    (if (< isearch-other-end (point)) ; isearch-forward?
		(isearch-highlight isearch-other-end (point))
574 575
	      (isearch-highlight (point) isearch-other-end))
	  (isearch-dehighlight nil))
576
	))
Jim Blandy's avatar
Jim Blandy committed
577 578 579 580 581 582
  (setq ;; quit-flag nil  not for isearch-mode
   isearch-adjusted nil
   isearch-yank-flag nil)
  )


Richard M. Stallman's avatar
Richard M. Stallman committed
583
(defun isearch-done (&optional nopush)
Jim Blandy's avatar
Jim Blandy committed
584
  ;; Called by all commands that terminate isearch-mode.
Richard M. Stallman's avatar
Richard M. Stallman committed
585
  ;; If NOPUSH is non-nil, we don't push the string on the search ring.
586
  (setq overriding-local-map nil)
587 588 589 590
  ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
  (isearch-dehighlight t)
  (let ((found-start (window-start (selected-window)))
	(found-point (point)))
591 592
    (if isearch-window-configuration
	(set-window-configuration isearch-window-configuration))
593

594 595 596 597 598
    (if isearch-small-window
	(goto-char found-point)
      ;; Exiting the save-window-excursion clobbers window-start; restore it.
      (set-window-start (selected-window) found-start t)))

599 600 601
    ;; If there was movement, mark the starting position.
    ;; Maybe should test difference between and set mark iff > threshold.
    (if (/= (point) isearch-opoint)
602 603 604 605
	(progn
	  (push-mark isearch-opoint t)
	  (or executing-macro (> (minibuffer-depth) 0)
	      (message "Mark saved where search started")))
606 607 608 609 610
      ;; (message "") why is this needed?
      )

  (setq isearch-mode nil)
  (set-buffer-modified-p (buffer-modified-p))  ;; update modeline
Jim Blandy's avatar
Jim Blandy committed
611

Richard M. Stallman's avatar
Richard M. Stallman committed
612
  (if (and (> (length isearch-string) 0) (not nopush))
Jim Blandy's avatar
Jim Blandy committed
613 614
      ;; Update the ring data.
      (if isearch-regexp 
615 616
	  (if (or (null regexp-search-ring)
		  (not (string= isearch-string (car regexp-search-ring))))
Jim Blandy's avatar
Jim Blandy committed
617
	      (progn
618
		(setq regexp-search-ring
619
		      (cons isearch-string regexp-search-ring))
620 621
		(if (> (length regexp-search-ring) regexp-search-ring-max)
		    (setcdr (nthcdr (1- search-ring-max) regexp-search-ring)
Jim Blandy's avatar
Jim Blandy committed
622
			    nil))))
623 624
	(if (or (null search-ring)
		(not (string= isearch-string (car search-ring))))
Jim Blandy's avatar
Jim Blandy committed
625
	    (progn
626
	      (setq search-ring (cons isearch-string search-ring))
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630
	      (if (> (length search-ring) search-ring-max)
		  (setcdr (nthcdr (1- search-ring-max) search-ring) nil))))))

  (run-hooks 'isearch-mode-end-hook)
631 632 633 634
  (if isearch-recursive-edit (exit-recursive-edit)))

;;;=======================================================
;;; Switching buffers should first terminate isearch-mode.
635
;;; This is done quite differently for each variant of emacs.
636 637 638 639 640 641 642
;;; For lemacs, see Exiting in lemacs below

;; For Emacs 19, the frame switch event is handled.
(defun isearch-switch-frame-handler ()
  (interactive) ;; Is this necessary?
  ;; First terminate isearch-mode.
  (isearch-done)
643
  (handle-switch-frame (car (cdr (isearch-last-command-char)))))
644 645

;;;========================================================
Jim Blandy's avatar
Jim Blandy committed
646 647 648 649 650 651 652 653 654


;;;====================================================
;; Commands active while inside of the isearch minor mode.

(defun isearch-exit ()
  "Exit search normally.
However, if this is the first command after starting incremental
search and `search-nonincremental-instead' is non-nil, do a
655
nonincremental search instead via `isearch-edit-string'."
Jim Blandy's avatar
Jim Blandy committed
656 657 658
  (interactive)
  (if (and search-nonincremental-instead 
	   (= 0 (length isearch-string)))
659 660
      (let ((isearch-nonincremental t))
	(isearch-edit-string)))
Jim Blandy's avatar
Jim Blandy committed
661 662 663 664
  (isearch-done))


(defun isearch-edit-string ()
665 666 667 668 669 670
  "Edit the search string in the minibuffer.
The following additional command keys are active while editing.
\\<minibuffer-local-isearch-map>
\\[exit-minibuffer] to resume incremental searching with the edited string.
\\[isearch-nonincremental-exit-minibuffer] to do one nonincremental search.
\\[isearch-forward-exit-minibuffer] to resume isearching forward.
Karl Heuer's avatar
Karl Heuer committed
671
\\[isearch-reverse-exit-minibuffer] to resume isearching backward.
672
\\[isearch-ring-advance-edit] to replace the search string with the next item in the search ring.
673
\\[isearch-ring-retreat-edit] to replace the search string with the previous item in the search ring.
674
\\[isearch-complete-edit] to complete the search string using the search ring.
Karl Heuer's avatar
Karl Heuer committed
675
\\<isearch-mode-map>
676 677 678 679 680 681
If first char entered is \\[isearch-yank-word], then do word search instead."

  ;; This code is very hairy for several reasons, explained in the code.
  ;; Mainly, isearch-mode must be terminated while editing and then restarted.
  ;; If there were a way to catch any change of buffer from the minibuffer,
  ;; this could be simplified greatly.
682
  ;; Editing doesn't back up the search point.  Should it?
Jim Blandy's avatar
Jim Blandy committed
683
  (interactive)
684
  (condition-case err
685
      (let ((isearch-nonincremental isearch-nonincremental)
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704

	    ;; Locally bind all isearch global variables to protect them
	    ;; from recursive isearching.
	    ;; isearch-string -message and -forward are not bound
	    ;; so they may be changed.  Instead, save the values.
	    (isearch-new-string isearch-string)
	    (isearch-new-message isearch-message)
	    (isearch-new-forward isearch-forward)
	    (isearch-new-word isearch-word)

	    (isearch-regexp isearch-regexp)
	    (isearch-op-fun isearch-op-fun)
	    (isearch-cmds isearch-cmds)
	    (isearch-success isearch-success)
	    (isearch-wrapped isearch-wrapped)
	    (isearch-barrier isearch-barrier)
	    (isearch-adjusted isearch-adjusted)
	    (isearch-yank-flag isearch-yank-flag)
	    (isearch-invalid-regexp isearch-invalid-regexp)
705
	    (isearch-within-brackets isearch-within-brackets)
706 707 708 709 710 711 712 713 714 715 716 717 718
	    (isearch-other-end isearch-other-end)
	    (isearch-opoint isearch-opoint)
	    (isearch-slow-terminal-mode isearch-slow-terminal-mode)
	    (isearch-small-window isearch-small-window)
	    (isearch-recursive-edit isearch-recursive-edit)
	    ;; Save current configuration so we can restore it here.
	    (isearch-window-configuration (current-window-configuration))
	    )

	;; Actually terminate isearching until editing is done.
	;; This is so that the user can do anything without failure, 
	;; like switch buffers and start another isearch, and return.
	(condition-case err
Richard M. Stallman's avatar
Richard M. Stallman committed
719
	    (isearch-done t)
720 721 722 723 724 725
	  (exit nil))			; was recursive editing

	(isearch-message) ;; for read-char
	(unwind-protect
	    (let* (;; Why does following read-char echo?  
		   ;;(echo-keystrokes 0) ;; not needed with above message
Richard M. Stallman's avatar
Richard M. Stallman committed
726
		   (e (let ((cursor-in-echo-area t))
727
			(read-event)))
728 729 730 731 732 733 734 735 736 737 738
		   ;; Binding minibuffer-history-symbol to nil is a work-around
		   ;; for some incompatibility with gmhist.
		   (minibuffer-history-symbol))
	      ;; If the first character the user types when we prompt them
	      ;; for a string is the yank-word character, then go into
	      ;; word-search mode.  Otherwise unread that character and
	      ;; read a key the normal way.
	      ;; Word search does not apply (yet) to regexp searches,
	      ;; no check is made here.
	      (message (isearch-message-prefix nil nil t))
	      (if (eq 'isearch-yank-word
739
		      (lookup-key isearch-mode-map (vector e)))
740 741 742
		  (setq isearch-word t  ;; so message-prefix is right
			isearch-new-word t)
		(isearch-unread e))
743 744
	      (setq cursor-in-echo-area nil)
	      (setq isearch-new-string
Richard M. Stallman's avatar
Richard M. Stallman committed
745
		    (let (junk-ring)
746 747 748
		      (read-from-minibuffer (isearch-message-prefix)
					    isearch-string
					    minibuffer-local-isearch-map nil
Richard M. Stallman's avatar
Richard M. Stallman committed
749
					    'junk-ring))
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
		    isearch-new-message (mapconcat 'text-char-description
						   isearch-new-string "")))
	  ;; Always resume isearching by restarting it.
	  (isearch-mode isearch-forward 
			isearch-regexp 
			isearch-op-fun 
			isearch-recursive-edit
			isearch-word)

	  ;; Copy new local values to isearch globals
	  (setq isearch-string isearch-new-string
		isearch-message isearch-new-message
		isearch-forward isearch-new-forward
		isearch-word isearch-new-word))

	;; Empty isearch-string means use default.
	(if (= 0 (length isearch-string))
767 768 769 770 771 772
	    (setq isearch-string (car (if isearch-regexp regexp-search-ring
					search-ring)))
	  ;; This used to set the last search string,
	  ;; but I think it is not right to do that here.
	  ;; Only the string actually used should be saved.
	  )
773 774 775 776 777 778 779 780 781

	;; Reinvoke the pending search.
	(isearch-push-state)
	(isearch-search)
	(isearch-update)
	(if isearch-nonincremental 
	    (progn
	      ;; (sit-for 1) ;; needed if isearch-done does: (message "")
	      (isearch-done))))
Jim Blandy's avatar
Jim Blandy committed
782

783 784 785 786 787 788 789 790 791 792 793 794 795
    (quit  ; handle abort-recursive-edit
     (isearch-abort)  ;; outside of let to restore outside global values
     )))

(defun isearch-nonincremental-exit-minibuffer ()
  (interactive)
  (setq isearch-nonincremental t)
  (exit-minibuffer))

(defun isearch-forward-exit-minibuffer ()
  (interactive)
  (setq isearch-new-forward t)
  (exit-minibuffer))
Jim Blandy's avatar
Jim Blandy committed
796

797
(defun isearch-reverse-exit-minibuffer ()
Jim Blandy's avatar
Jim Blandy committed
798
  (interactive)
799 800 801 802 803 804 805 806 807
  (setq isearch-new-forward nil)
  (exit-minibuffer))


(defun isearch-abort ()
  "Abort incremental search mode if searching is successful, signalling quit.
Otherwise, revert to previous successful search and continue searching.
Use `isearch-exit' to quit without signalling."
  (interactive)
808
;;  (ding)  signal instead below, if quitting
Jim Blandy's avatar
Jim Blandy committed
809 810 811 812 813
  (discard-input)
  (if isearch-success
      ;; If search is successful, move back to starting point
      ;; and really do quit.
      (progn (goto-char isearch-opoint)
Richard M. Stallman's avatar
Richard M. Stallman committed
814
	     (isearch-done t)   ; exit isearch
815
	     (signal 'quit nil))  ; and pass on quit signal
816
    ;; If search is failing, rub out until it is once more successful.
Jim Blandy's avatar
Jim Blandy committed
817 818 819 820 821 822 823 824 825 826 827 828
    (while (not isearch-success) (isearch-pop-state))
    (isearch-update)))


(defun isearch-repeat (direction)
  ;; Utility for isearch-repeat-forward and -backward.
  (if (eq isearch-forward (eq direction 'forward))
      ;; C-s in forward or C-r in reverse.
      (if (equal isearch-string "")
	  ;; If search string is empty, use last one.
	  (setq isearch-string
		(or (if isearch-regexp
829 830
			(car regexp-search-ring)
		      (car search-ring))
Jim Blandy's avatar
Jim Blandy committed
831 832
		    "")
		isearch-message
833
		(mapconcat 'isearch-text-char-description
Jim Blandy's avatar
Jim Blandy committed
834 835 836 837 838 839 840 841 842 843 844
			   isearch-string ""))
	;; If already have what to search for, repeat it.
	(or isearch-success
	    (progn 

	      (goto-char (if isearch-forward (point-min) (point-max)))
	      (setq isearch-wrapped t))))
    ;; C-s in reverse or C-r in forward, change direction.
    (setq isearch-forward (not isearch-forward)))

  (setq isearch-barrier (point)) ; For subsequent \| if regexp.
845 846 847 848

  (if (equal isearch-string "")
      (setq isearch-success t)
    (if (and isearch-success (equal (match-end 0) (match-beginning 0)))
Jim Blandy's avatar
Jim Blandy committed
849 850
	;; If repeating a search that found
	;; an empty string, ensure we advance.
851 852 853 854 855 856 857 858 859
	(if (if isearch-forward (eobp) (bobp))
	    ;; If there's nowhere to advance to, fail (and wrap next time).
	    (progn
	      (setq isearch-success nil)
	      (ding))
	  (forward-char (if isearch-forward 1 -1))
	  (isearch-search))
      (isearch-search)))

Jim Blandy's avatar
Jim Blandy committed
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
  (isearch-push-state)
  (isearch-update))

(defun isearch-repeat-forward ()
  "Repeat incremental search forwards."
  (interactive)
  (isearch-repeat 'forward))

(defun isearch-repeat-backward ()
  "Repeat incremental search backwards."
  (interactive)
  (isearch-repeat 'backward))

(defun isearch-toggle-regexp ()
  "Toggle regexp searching on or off."
  ;; The status stack is left unchanged.
  (interactive)
  (setq isearch-regexp (not isearch-regexp))
878
  (if isearch-regexp (setq isearch-word nil))
Jim Blandy's avatar
Jim Blandy committed
879 880
  (isearch-update))

881 882 883 884 885 886 887 888 889 890 891 892 893
(defun isearch-toggle-case-fold ()
  "Toggle case folding in searching on or off."
  (interactive)
  (setq isearch-case-fold-search
	(if isearch-case-fold-search nil 'yes))
  (message "%s%s [case %ssensitive]"
	   (isearch-message-prefix)
	   isearch-message
	   (if isearch-case-fold-search "in" ""))
  (setq isearch-adjusted t)
  (sit-for 1)
  (isearch-update))

Jim Blandy's avatar
Jim Blandy committed
894 895 896 897 898 899 900 901 902 903 904 905
(defun isearch-delete-char ()
  "Discard last input item and move point back.  
If no previous match was done, just beep."
  (interactive)
  (if (null (cdr isearch-cmds))
      (ding)
    (isearch-pop-state))
  (isearch-update))


(defun isearch-yank (chunk)
  ;; Helper for isearch-yank-word and isearch-yank-line
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922
  ;; CHUNK should be word, line or kill.
  (let ((string (cond
                 ((eq chunk 'kill)
                  (current-kill 0))
                 (t
		  (save-excursion
		    (and (not isearch-forward) isearch-other-end
			 (goto-char isearch-other-end))
		    (buffer-substring
		     (point)
		     (save-excursion
		       (cond
			((eq chunk 'word)
			 (forward-word 1))
			((eq chunk 'line)
			 (end-of-line)))
		       (point))))))))
923 924
    ;; Downcase the string if not supposed to case-fold yanked strings.
    (if (and isearch-case-fold-search
925
	     (eq 'not-yanks search-upper-case))
926 927 928
	(setq string (downcase string)))
    (if isearch-regexp (setq string (regexp-quote string)))
    (setq isearch-string (concat isearch-string string)
Jim Blandy's avatar
Jim Blandy committed
929 930
	  isearch-message
	  (concat isearch-message
931 932
		  (mapconcat 'isearch-text-char-description
			     string ""))
Jim Blandy's avatar
Jim Blandy committed
933 934 935 936
	  ;; Don't move cursor in reverse search.
	  isearch-yank-flag t))
  (isearch-search-and-update))

937 938 939 940
(defun isearch-yank-kill ()
  "Pull string from kill ring into search string."
  (interactive)
  (isearch-yank 'kill))
Jim Blandy's avatar
Jim Blandy committed
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975

(defun isearch-yank-word ()
  "Pull next word from buffer into search string."
  (interactive)
  (isearch-yank 'word))

(defun isearch-yank-line ()
  "Pull rest of line from buffer into search string."
  (interactive)
  (isearch-yank 'line))


(defun isearch-search-and-update ()
  ;; Do the search and update the display.
  (if (and (not isearch-success)
	   ;; unsuccessful regexp search may become
	   ;;  successful by addition of characters which
	   ;;  make isearch-string valid
	   (not isearch-regexp))
      nil
    ;; In reverse search, adding stuff at
    ;; the end may cause zero or many more chars to be
    ;; matched, in the string following point.
    ;; Allow all those possibilities without moving point as
    ;; long as the match does not extend past search origin.
    (if (and (not isearch-forward) (not isearch-adjusted)
	     (condition-case ()
		 (looking-at (if isearch-regexp isearch-string
			       (regexp-quote isearch-string)))
	       (error nil))
	       (or isearch-yank-flag
		   (<= (match-end 0) 
		       (min isearch-opoint isearch-barrier))))
	(setq isearch-success t 
	      isearch-invalid-regexp nil
976
	      isearch-within-brackets nil
Jim Blandy's avatar
Jim Blandy committed
977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
	      isearch-other-end (match-end 0))
      ;; Not regexp, not reverse, or no match at point.
      (if (and isearch-other-end (not isearch-adjusted))
	  (goto-char (if isearch-forward isearch-other-end
		       (min isearch-opoint 
			    isearch-barrier 
			    (1+ isearch-other-end)))))
      (isearch-search)
      ))
  (isearch-push-state)
  (if isearch-op-fun (funcall isearch-op-fun))
  (isearch-update))


;; *, ?, and | chars can make a regexp more liberal.
992
;; They can make a regexp match sooner or make it succeed instead of failing.
Jim Blandy's avatar
Jim Blandy committed
993 994
;; So go back to place last successful search started
;; or to the last ^S/^R (barrier), whichever is nearer.
995
;; + needs no special handling because the string must match at least once.
Jim Blandy's avatar
Jim Blandy committed
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014

(defun isearch-*-char ()
  "Handle * and ? specially in regexps."
  (interactive)
  (if isearch-regexp 

      (progn
	(setq isearch-adjusted t)
	(let ((cs (nth (if isearch-forward
			   5		; isearch-other-end
			 2)		; saved (point)
		       (car (cdr isearch-cmds)))))
	  ;; (car isearch-cmds) is after last search;
	  ;; (car (cdr isearch-cmds)) is from before it.
	  (setq cs (or cs isearch-barrier))
	  (goto-char
	   (if isearch-forward
	       (max cs isearch-barrier)
	     (min cs isearch-barrier))))))
1015
  (isearch-process-search-char (isearch-last-command-char)))
Jim Blandy's avatar
Jim Blandy committed
1016 1017 1018 1019 1020 1021 1022 1023 1024
  

(defun isearch-|-char ()
  "If in regexp search, jump to the barrier."
  (interactive)
  (if isearch-regexp
      (progn
	(setq isearch-adjusted t)
	(goto-char isearch-barrier)))
1025
  (isearch-process-search-char (isearch-last-command-char)))
Jim Blandy's avatar
Jim Blandy committed
1026 1027


1028
(defalias 'isearch-other-control-char 'isearch-other-meta-char)
Jim Blandy's avatar
Jim Blandy committed
1029 1030

(defun isearch-other-meta-char ()
1031
  "Exit the search normally and reread this key sequence.
Richard M. Stallman's avatar
Richard M. Stallman committed
1032 1033 1034
But only if `search-exit-option' is non-nil, the default.
If it is the symbol `edit', the search string is edited in the minibuffer
and the meta character is unread so that it applies to editing the string."
Jim Blandy's avatar
Jim Blandy committed
1035
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
1036 1037
  (cond ((eq search-exit-option 'edit)
	 (let ((key (this-command-keys)))
1038
	   (apply 'isearch-unread (listify-key-sequence key)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1039 1040
	 (isearch-edit-string))
	(search-exit-option
1041
	 (let ((key (this-command-keys))
1042
	       (index 0)
1043 1044
	       window)
	   (apply 'isearch-unread (listify-key-sequence key))
1045 1046 1047 1048 1049
	   ;; Properly handle scroll-bar and mode-line clicks
	   ;; for which a dummy prefix event was generated as (aref key 0).
	   (and (> (length key) 1)
		(symbolp (aref key 0))
		(listp (aref key 1))
1050 1051 1052
		;; These events now have a symbol; they used to have a list.
		;; Accept either one.  Other events have a number here.
		(not (numberp (posn-point (event-start (aref key 1)))))
1053
		(setq index 1))
1054 1055 1056
	   ;; If we got a mouse click, maybe it was read with the buffer
	   ;; it was clicked on.  If so, that buffer, not the current one,
	   ;; is in isearch mode.  So end the search in that buffer.
1057 1058
	   (if (and (listp (aref key index))
		    (setq window (posn-window (event-start (aref key index))))
1059 1060 1061 1062 1063
		    (windowp window))
	       (save-excursion
		 (set-buffer (window-buffer window))
		 (isearch-done))
	     (isearch-done))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1064 1065 1066
	(t;; otherwise nil
	 (isearch-process-search-string (this-command-keys)
					(this-command-keys)))))
Jim Blandy's avatar
Jim Blandy committed
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079

(defun isearch-quote-char ()
  "Quote special characters for incremental search."
  (interactive)
  (isearch-process-search-char (read-quoted-char (isearch-message t))))

(defun isearch-return-char ()
  "Convert return into newline for incremental search.
Obsolete."
  (interactive)
  (isearch-process-search-char ?\n))

(defun isearch-printing-char ()
Richard M. Stallman's avatar
Richard M. Stallman committed
1080
  "Add this ordinary printing character to the search string and search."
Jim Blandy's avatar
Jim Blandy committed
1081
  (interactive)
1082
  (isearch-process-search-char (isearch-last-command-char)))
Jim Blandy's avatar
Jim Blandy committed
1083 1084

(defun isearch-whitespace-chars ()
1085
  "Match all whitespace chars, if in regexp mode.
Richard M. Stallman's avatar
Richard M. Stallman committed
1086
If you want to search for just a space, type C-q SPC."
Jim Blandy's avatar
Jim Blandy committed
1087
  (interactive)
1088
  (if isearch-regexp 
1089
      (if (and search-whitespace-regexp (not isearch-within-brackets))
1090 1091 1092
	  (isearch-process-search-string search-whitespace-regexp " ")
	(isearch-printing-char))
    (progn
1093
      ;; This way of doing word search doesn't correctly extend current search.
1094 1095 1096 1097
      ;;      (setq isearch-word t)
      ;;      (setq isearch-adjusted t)
      ;;      (goto-char isearch-barrier)
      (isearch-printing-char))))
Jim Blandy's avatar
Jim Blandy committed
1098 1099 1100

(defun isearch-process-search-char (char)
  ;; Append the char to the search string, update the message and re-search.
1101 1102 1103
  (isearch-process-search-string 
   (isearch-char-to-string char) 
   (isearch-text-char-description char)))
Jim Blandy's avatar
Jim Blandy committed
1104 1105 1106 1107 1108 1109 1110 1111 1112 1113

(defun isearch-process-search-string (string message)
  (setq isearch-string (concat isearch-string string)
	isearch-message (concat isearch-message message))
  (isearch-search-and-update))


;;===========================================================
;; Search Ring

1114 1115 1116
(defun isearch-ring-adjust1 (advance)
  ;; Helper for isearch-ring-adjust
  (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
Jim Blandy's avatar
Jim Blandy committed
1117 1118
	 (length (length ring))
	 (yank-pointer-name (if isearch-regexp
1119
				'regexp-search-ring-yank-pointer
Jim Blandy's avatar
Jim Blandy committed
1120 1121 1122 1123 1124 1125
			      'search-ring-yank-pointer))
	 (yank-pointer (eval yank-pointer-name)))
    (if (zerop length)
	()
      (set yank-pointer-name
	   (setq yank-pointer
1126 1127 1128
		 (mod (+ (or yank-pointer 0)
			 (if advance -1 1))
		      length)))
1129
      (setq isearch-string (nth yank-pointer ring)
1130 1131 1132 1133 1134 1135 1136 1137
	    isearch-message (mapconcat 'isearch-text-char-description
				       isearch-string "")))))

(defun isearch-ring-adjust (advance)
  ;; Helper for isearch-ring-advance and isearch-ring-retreat
  (if (cdr isearch-cmds)  ;; is there more than one thing on stack?
      (isearch-pop-state))
  (isearch-ring-adjust1 advance)
Jim Blandy's avatar
Jim Blandy committed
1138
  (isearch-push-state)
1139 1140 1141 1142 1143 1144
  (if search-ring-update
      (progn
	(isearch-search)
	(isearch-update))
    (isearch-edit-string)
    ))
Jim Blandy's avatar
Jim Blandy committed
1145 1146 1147

(defun isearch-ring-advance ()
  "Advance to the next search string in the ring."
1148
  ;; This could be more general to handle a prefix arg, but who would use it.
Jim Blandy's avatar
Jim Blandy committed
1149 1150 1151 1152 1153 1154 1155 1156
  (interactive)
  (isearch-ring-adjust 'advance))

(defun isearch-ring-retreat ()
  "Retreat to the previous search string in the ring."
  (interactive)
  (isearch-ring-adjust nil))

1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
(defun isearch-ring-advance-edit (n)
  "Insert the next element of the search history into the minibuffer."
  (interactive "p")
  (let* ((yank-pointer-name (if isearch-regexp
				'regexp-search-ring-yank-pointer
			      'search-ring-yank-pointer))
	 (yank-pointer (eval yank-pointer-name))
	 (ring (if isearch-regexp regexp-search-ring search-ring))
	 (length (length ring)))
    (if (zerop length)
	()
      (set yank-pointer-name
	   (setq yank-pointer
1170 1171
		 (mod (- (or yank-pointer 0) n)
		      length)))
1172 1173

      (erase-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
1174
      (insert (nth yank-pointer ring))
1175
      (goto-char (point-max)))))
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195

(defun isearch-ring-retreat-edit (n)
  "Inserts the previous element of the search history into the minibuffer."
  (interactive "p")
  (isearch-ring-advance-edit (- n)))

;;(defun isearch-ring-adjust-edit (advance)
;;  "Use the next or previous search string in the ring while in minibuffer."
;;  (isearch-ring-adjust1 advance)
;;  (erase-buffer)
;;  (insert isearch-string))

;;(defun isearch-ring-advance-edit ()
;;  (interactive)
;;  (isearch-ring-adjust-edit 'advance))

;;(defun isearch-ring-retreat-edit ()
;;  "Retreat to the previous search string in the ring while in the minibuffer."
;;  (interactive)
;;  (isearch-ring-adjust-edit nil))
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231


(defun isearch-complete1 ()
  ;; Helper for isearch-complete and isearch-complete-edit
  ;; Return t if completion OK, nil if no completion exists.
  (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
         (alist (mapcar (function (lambda (string) (list string))) ring))
         (completion-ignore-case case-fold-search)
         (completion (try-completion isearch-string alist)))
    (cond
     ((eq completion t)
      ;; isearch-string stays the same
      t)
     ((or completion ; not nil, must be a string
	  (= 0 (length isearch-string))) ; shouldnt have to say this
      (if (equal completion isearch-string)  ;; no extension?
	  (if completion-auto-help
	      (with-output-to-temp-buffer "*Isearch completions*"
		(display-completion-list 
		 (all-completions isearch-string alist))))
	(setq isearch-string completion))
      t)
     (t
      (message "No completion") ; waits a second if in minibuffer
      nil))))

(defun isearch-complete ()
  "Complete the search string from the strings on the search ring.
The completed string is then editable in the minibuffer.
If there is no completion possible, say so and continue searching."
  (interactive)
  (if (isearch-complete1)
      (isearch-edit-string)
    ;; else
    (sit-for 1)
    (isearch-update)))
Jim Blandy's avatar
Jim Blandy committed
1232

1233 1234 1235 1236 1237
(defun isearch-complete-edit ()
  "Same as `isearch-complete' except in the minibuffer."
  (interactive)
  (setq isearch-string (buffer-string))
  (if (isearch-complete1)
</