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

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

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

7
;; |$Date: 1993/03/30 19:38:34 $|$Revision: 1.28 $
Jim Blandy's avatar
Jim Blandy committed
8

9 10
;; This file is not yet part of GNU Emacs, but it is based almost
;; entirely on isearch.el which is part of GNU Emacs.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY.  No author or distributor
;; accepts responsibility to anyone for the consequences of using it
;; or for whether it serves any particular purpose or works at all,
;; unless he says so in writing.  Refer to the GNU Emacs General Public
;; License for full details.

;; Everyone is granted permission to copy, modify and redistribute
;; GNU Emacs, but only under the conditions described in the
;; GNU Emacs General Public License.   A copy of this license is
;; supposed to have been given to you along with GNU Emacs so you
;; can know your rights and responsibilities.  It should be in a
;; file named COPYING.  Among other things, the copyright notice
;; and this notice must be preserved on all copies.

27 28
;;; Commentary:

Jim Blandy's avatar
Jim Blandy committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
;;;====================================================================
;; Instructions

;; Searching with isearch-mode.el should work just like isearch.el,
;; except it is done in a temporary minor mode that terminates when
;; you finish searching.

;; To use isearch-mode instead of the standard isearch.el, add the
;; following to your .emacs file.  The standard key bindings to
;; isearch-forward, etc, will then use isearch-mode instead of
;; isearch.

;; (fset 'isearch 'isearch-mode)
;; (autoload 'isearch-mode "isearch-mode")

44 45 46 47 48 49 50 51 52 53 54 55 56 57
;; 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).

;; If any package you use invokes isearching non-interactively to get
;; the modal behavior described above, you must use the redefinitions
;; of isearch-forward, etc. found in this file instead of those in
;; loaddefs.el.  The simplest way to ensure this is to just load
;; isearch-mode explicitly in your .emacs instead of using the above
;; fset and autoload.

;; (load "isearch-mode")

Jim Blandy's avatar
Jim Blandy committed
58
;; The key bindings active within isearch-mode are defined below in
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
;; `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
;; - Integrate the emacs 19 generalized commmand history.
;; - Think about incorporating query-replace.
;; - Hooks and options for failed search.
Eric S. Raymond's avatar
Eric S. Raymond committed
89

90 91
;;; Change Log:

Eric S. Raymond's avatar
Eric S. Raymond committed
92
;;;====================================================================
93 94
;;; Change History

95
;;; $Header: /gd/gnu/emacs/19.0/lisp/RCS/isearch.el,v 1.28 1993/03/30 19:38:34 rms Exp rms $
96
;;; $Log: isearch.el,v $
97 98 99
; Revision 1.28  1993/03/30  19:38:34  rms
; (isearch-mode-map): Delete the binding for C-h.
;
100 101 102 103
; Revision 1.27  1993/03/21  05:50:17  jimb
; 	* isearch.el (isearch-switch-frame-handler): Call
; 	handle-switch-frame instead of select-frame; it has been renamed.
;
104 105 106
; Revision 1.26  1993/03/17  17:17:05  eric
; Add standard library headers.
;
107 108 109
; Revision 1.25  1993/03/17  16:44:50  eric
; Add standard library headers.
;
110 111 112
; Revision 1.24  1993/03/17  15:58:09  eric
; Add standard library headers.
;
113 114 115 116 117
; Revision 1.23  1993/03/07  20:17:27  rms
; (isearch-other-meta-char): Call listify-key-sequence.
; (isearch-unread): Don't call it here.
; (isearch-mode-map): Bind the ASCII-equivalent function keys.
;
118 119 120
; Revision 1.22  1993/03/07  08:43:57  rms
; (isearch-mode): Don't make a pre-command-hook.
;
121 122 123
; Revision 1.21  1993/03/07  04:22:00  rms
; (isearch-unread): Find last list element by hand.
;
124 125 126 127 128 129 130
; Revision 1.20  1993/03/06  06:15:05  rms
; (isearch-unread): Handle multiple args.
; For Emacs 19, use listify-key-sequence.
; If not Emacs 19, assume they are a meta sequence.
; (isearch-other-meta-char): Pass the whole key sequence.
; (isearch-other-control-char): Make this alias for ...-meta-char.
;
131 132 133
; Revision 1.19  1993/02/17  21:30:25  rms
; Fix minor bugs in previous change.
;
134 135 136 137 138 139 140
; Revision 1.18  1993/02/17  20:34:20  rms
; (isearch-backward-regexp):
; New arg no-recursive-edit, always non-nil for interactive call.
; Rename first arg, and set it right in interactive call.
; (isearch-forward-regexp): Likewise.
; (isearch-forward, isearch-backward): Likewise no-recursive-edit.
;
141 142 143
; Revision 1.17  1993/01/26  01:48:27  jimb
; JimB's changes since January 18th
;
Jim Blandy's avatar
Jim Blandy committed
144 145 146 147 148 149 150
; Revision 1.16  1992/11/16  01:37:06  jimb
; 	* bytecomp.el: Declare unread-command-char an obsolete variable.
; 	* vip.el (vip-escape-to-emacs, vip-prefix-arg-value,
; 	vip-prefix-arg-com): Use unread-command-event instead of
; 	unread-command-char; respect its new semantics.
; 	* isearch-mode.el (isearch-update, isearch-unread): Same.
;
151 152 153 154 155 156 157 158 159 160 161 162 163
; Revision 1.15  1992/11/07  06:17:04  jimb
;         * isearch.el (isearch-frames-exist): This isn't what we want -
; 	replaced by...
; 	(isearch-gnu-emacs-events): non-nil if should expect events in the
; 	style generated by GNU Emacs 19.  Set if set-frame-height is
; 	fboundp; this is true on any GNU Emacs 19, whether or not it was
; 	compiled with multiple frame support.
; 	(isearch-mode-map): Test isearch-gnu-emacs-events instead of
; 	isearch-frames-exist to see if we should bind switch-frame events.
; 	(isearch-update): Test isearch-gnu-emacs-events instead of
; 	isearch-frames-exist to see if unread-command-char's quiescent
; 	value is nil or -1.
;
164 165 166
; Revision 1.14  1992/11/01  22:10:59  rms
; (isearch-search): Handle all sorts of errors from regexp search.
;
167 168 169 170
; Revision 1.13  1992/10/27  04:11:46  rms
; (isearch-edit-string):
; Bind cursor-in-echo-area only around read-char/allocate-event.
;
Richard M. Stallman's avatar
Richard M. Stallman committed
171 172 173 174
; Revision 1.12  1992/10/20  21:21:47  rms
; (isearch-mode-map): Make the top-level keymap dense.
; Explicitly bind control characters at that level.
;
175 176 177
; Revision 1.11  1992/10/11  05:25:11  rms
; (isearch-ring-advance-edit): Delete spurious `)'.
;
178 179 180
; Revision 1.10  1992/09/21  08:28:43  rms
; entered into RCS
;
181 182 183 184 185 186 187 188 189
;;; 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
190
;;; 
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
;;; 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
209 210 211 212 213

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

214
;;; Code:
215 216 217 218 219 220 221 222 223 224 225


;;;=========================================================================
;;; 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.)

226
(defconst isearch-gnu-emacs-events (fboundp 'set-frame-height)) ;; emacs 19
227
(defconst isearch-pre-command-hook-exists (boundp 'pre-command-hook)) ;; lemacs
228
(defconst isearch-event-data-type nil)  ;; lemacs
229

230
(defconst search-exit-option t
231
  "*Non-nil means random control characters terminate incremental search.")
232 233 234 235 236 237 238 239 240 241 242

(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
243 244 245 246

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

247
(defvar search-upper-case t
Jim Blandy's avatar
Jim Blandy committed
248
  "*If non-nil, upper case chars disable case fold searching.
249 250
That is, upper and lower case chars must match exactly.
This applies no matter where the chars come from, but does not
251 252
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
253 254 255

(defvar search-nonincremental-instead t
  "*If non-nil, do a nonincremental search instead if exiting immediately.
256 257
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
258 259 260 261 262

(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.")

263 264 265
;; 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.
266
(defvar search-highlight nil
267
  "Whether isearch and query-replace should highlight the text which 
268 269 270 271 272 273 274 275 276
currently matches the search-string.")


(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
277 278 279 280 281
;;;==================================================================
;;; Search ring.

(defvar search-ring nil
  "List of search string sequences.")
282
(defvar regexp-search-ring nil
Jim Blandy's avatar
Jim Blandy committed
283 284 285 286
  "List of regular expression search string sequences.")

(defconst search-ring-max 16
  "*Maximum length of search ring before oldest elements are thrown away.")
287 288
(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
289 290

(defvar search-ring-yank-pointer nil
291 292
  "Index in `search-ring' of last string reused.
nil if none yet.")
293
(defvar regexp-search-ring-yank-pointer nil
294 295
  "Index in `regexp-search-ring' of last string reused.
nil if none yet.")
Jim Blandy's avatar
Jim Blandy committed
296

297 298 299 300
(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
301 302 303 304 305 306
;;;====================================================
;;; Define isearch-mode keymap.

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

307 308
(or isearch-mode-map
    (let* ((i 0)
309
	   (map (make-keymap)))
310

311 312
      ;; Make function keys, etc, exit the search.
      (define-key map [t] 'isearch-other-control-char)
313
      ;; Control chars, by default, end isearch mode transparently.
314 315 316
      ;; 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.
317 318 319 320 321
      (while (< i ?\ )
	(define-key map (make-string 1 i) 'isearch-other-control-char)
	(setq i (1+ i)))

      ;; Printing chars extend the selection by default.
322
      (setq i ?\ )
323
      (while (< i 128)
324 325 326 327 328 329 330 331
	(define-key map (make-string 1 i) 'isearch-printing-char)
	(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
332
    
333 334 335 336 337 338
      (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
339
    
340 341 342
      (define-key map "\C-w" 'isearch-yank-word)
      (define-key map "\C-y" 'isearch-yank-line)

343 344 345 346 347 348 349 350 351 352
      ;; 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)
      (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)

353 354 355 356 357 358
      ;; 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)

359 360 361
;;; 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)
362 363 364 365 366 367

      ;; 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.
368 369 370
      (let ((meta-map (make-sparse-keymap)))
	(define-key map (char-to-string meta-prefix-char) meta-map)
	(define-key map [escape] meta-map))
371
      (define-key map (vector meta-prefix-char t) 'isearch-other-meta-char)
372 373 374

      (define-key map "\M-n" 'isearch-ring-advance)
      (define-key map "\M-p" 'isearch-ring-retreat)
375

376 377 378
      (define-key map "\M-\t" 'isearch-complete)

      ;; For emacs 19, switching frames should terminate isearch-mode
379
      (if isearch-gnu-emacs-events
380 381 382 383
	  (define-key map [switch-frame] 'isearch-switch-frame-handler))
      
      (setq isearch-mode-map map)
      ))
Jim Blandy's avatar
Jim Blandy committed
384

385 386 387 388
;; Some bindings you may want to put in your isearch-mode-hook.
;; Suggest some alternates...
;; (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
389 390


391 392
(defvar minibuffer-local-isearch-map nil
  "Keymap for editing isearch strings in the minibuffer.")
Jim Blandy's avatar
Jim Blandy committed
393

394 395 396
(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
397 398
      (define-key map "\M-n" 'isearch-ring-advance-edit)
      (define-key map "\M-p" 'isearch-ring-retreat-edit)
399 400 401 402 403
      (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
404 405 406

;;;========================================================
;; Internal variables declared globally for byte-compiler.
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
;; 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.
(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
422 423
(defvar isearch-barrier 0)

424
(defvar isearch-case-fold-search nil) ; case-fold-search while searching.
Jim Blandy's avatar
Jim Blandy committed
425 426 427

(defvar isearch-adjusted nil)
(defvar isearch-slow-terminal-mode nil)
428 429
;;; If t, using a small window.
(defvar isearch-small-window nil)
Jim Blandy's avatar
Jim Blandy committed
430
(defvar isearch-opoint 0)
431 432 433
;;; The window configuration active at the beginning of the search.
(defvar isearch-window-configuration nil)
(defvar isearch-old-local-map nil)
Jim Blandy's avatar
Jim Blandy committed
434

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

438 439 440 441
;;; 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
442

443 444
;;;  Is isearch-mode in a recursive edit for modal searching.
(defvar isearch-recursive-edit nil)
Jim Blandy's avatar
Jim Blandy committed
445

446 447 448 449 450
;;; 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
451 452 453 454 455 456 457 458 459 460


;;;==============================================================
;; 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))))

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

464 465 466 467 468
(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
469 470
;;;===============================================================
;;; Entry points to isearch-mode.
471 472 473
;;; These four functions should replace those in loaddefs.el
;;; An alternative is to fset isearch-forward etc to isearch-mode,
;;; and look at this-command to set the options accordingly.
Jim Blandy's avatar
Jim Blandy committed
474

475
(defun isearch-forward (&optional regexp-p no-recursive-edit)
Jim Blandy's avatar
Jim Blandy committed
476 477
  "\
Do incremental search forward.
478 479
With a prefix argument, do an incremental regular expression search instead.
\\<isearch-mode-map>
Jim Blandy's avatar
Jim Blandy committed
480
As you type characters, they add to the search string and are found.
481
The following non-printing keys are bound in `isearch-mode-map'.  
Jim Blandy's avatar
Jim Blandy committed
482

483
Type \\[isearch-delete-char] to cancel characters from end of search string.
Jim Blandy's avatar
Jim Blandy committed
484
Type \\[isearch-exit] to exit, leaving point at location found.
485 486 487 488 489 490 491
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
492
Type \\[isearch-quote-char] to quote control character to search for it.
493 494 495 496 497 498
Type \\[isearch-whitespace-chars] to match all whitespace chars in regexp.
\\[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
499 500 501

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.
502 503 504
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
505

506 507
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
508
Other control and meta characters terminate the search
509
 and are then executed normally (depending on `search-exit-option').
Jim Blandy's avatar
Jim Blandy committed
510

511 512
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
513

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

517
(defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
Jim Blandy's avatar
Jim Blandy committed
518 519
  "\
Do incremental search forward for regular expression.
520
With a prefix argument, do a regular string search instead.
Jim Blandy's avatar
Jim Blandy committed
521 522
Like ordinary incremental search except that your input
is treated as a regexp.  See \\[isearch-forward] for more info."
523
  (interactive "P\np")
524
  (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
Jim Blandy's avatar
Jim Blandy committed
525

526
(defun isearch-backward (&optional regexp-p no-recursive-edit)
Jim Blandy's avatar
Jim Blandy committed
527 528
  "\
Do incremental search backward.
529
With a prefix argument, do a regular expression search instead.
Jim Blandy's avatar
Jim Blandy committed
530
See \\[isearch-forward] for more information."
531
  (interactive "P\np")
532
  (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
Jim Blandy's avatar
Jim Blandy committed
533

534
(defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
Jim Blandy's avatar
Jim Blandy committed
535 536
  "\
Do incremental search backward for regular expression.
537
With a prefix argument, do a regular string search instead.
Jim Blandy's avatar
Jim Blandy committed
538 539
Like ordinary incremental search except that your input
is treated as a regexp.  See \\[isearch-forward] for more info."
540
  (interactive "P\np")
541
  (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
542 543 544 545 546 547


(defun isearch-mode-help ()
  (interactive)
  (describe-function 'isearch-forward)
  (isearch-update))
Jim Blandy's avatar
Jim Blandy committed
548 549 550 551 552 553

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

554 555 556 557 558 559 560
;; 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
561 562 563 564 565
  "Start isearch minor mode.  Called by isearch-forward, etc."

  ;; Initialize global vars.
  (setq isearch-forward forward
	isearch-regexp regexp
566
	isearch-word word-p
Jim Blandy's avatar
Jim Blandy committed
567 568 569 570 571 572 573 574 575 576 577
	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
Joseph Arceneaux's avatar
Joseph Arceneaux committed
578 579
	;; 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
580 581 582 583 584 585 586
					(> (window-height)
					   (* 4 search-slow-window-lines)))
	isearch-other-end nil
	isearch-small-window nil

	isearch-opoint (point)
	isearch-window-configuration (current-window-configuration)
587 588 589
	isearch-old-local-map (current-local-map)
	search-ring-yank-pointer nil
	regexp-search-ring-yank-pointer nil)
590 591 592 593
;; 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
594 595 596 597 598 599 600 601
  (setq	isearch-mode " Isearch")  ;; forward? regexp?
  (set-buffer-modified-p (buffer-modified-p)) ; update modeline

  (isearch-push-state)

  (use-local-map isearch-mode-map)
  (isearch-update)
  (run-hooks 'isearch-mode-hook)
602 603 604 605 606

  ;; 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.
  (if recursive-edit (recursive-edit))
Jim Blandy's avatar
Jim Blandy committed
607 608 609 610 611 612 613 614
  )


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

(defun isearch-update ()
  ;; Called after each command to update the display.  
615
  (if (if isearch-event-data-type
616
	  (null unread-command-event)
617
	(if isearch-gnu-emacs-events
Jim Blandy's avatar
Jim Blandy committed
618
	    (null unread-command-events)
619
	  (< unread-command-char 0)))
Jim Blandy's avatar
Jim Blandy committed
620 621 622 623 624 625
      (progn
	(if (not (input-pending-p))
	    (isearch-message))
	(if (and isearch-slow-terminal-mode
		 (not (or isearch-small-window 
			  (pos-visible-in-window-p))))
626
	    (let ((found-point (point)))
Jim Blandy's avatar
Jim Blandy committed
627 628 629 630 631 632 633 634 635 636 637 638 639 640
	      (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))
641 642 643 644 645 646
	      (goto-char found-point)))
	(if isearch-other-end
	    (if (< isearch-other-end (point)) ; isearch-forward?
		(isearch-highlight isearch-other-end (point))
	      (isearch-highlight (point) isearch-other-end)))
	))
Jim Blandy's avatar
Jim Blandy committed
647 648 649 650 651 652
  (setq ;; quit-flag nil  not for isearch-mode
   isearch-adjusted nil
   isearch-yank-flag nil)
  )


Richard M. Stallman's avatar
Richard M. Stallman committed
653
(defun isearch-done (&optional nopush)
Jim Blandy's avatar
Jim Blandy committed
654
  ;; Called by all commands that terminate isearch-mode.
Richard M. Stallman's avatar
Richard M. Stallman committed
655
  ;; If NOPUSH is non-nil, we don't push the string on the search ring.
Jim Blandy's avatar
Jim Blandy committed
656
  (use-local-map isearch-old-local-map)
657 658 659 660 661 662 663 664 665
  ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
  (isearch-dehighlight t)
  (let ((found-start (window-start (selected-window)))
	(found-point (point)))
    (set-window-configuration isearch-window-configuration)

    ;; If there was movement, mark the starting position.
    ;; Maybe should test difference between and set mark iff > threshold.
    (if (/= (point) isearch-opoint)
666 667 668 669
	(progn
	  (push-mark isearch-opoint t)
	  (or executing-macro (> (minibuffer-depth) 0)
	      (message "Mark saved where search started")))
670 671 672 673 674 675 676 677 678
      ;; (message "") why is this needed?
      )
    (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)))

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

Richard M. Stallman's avatar
Richard M. Stallman committed
680
  (if (and (> (length isearch-string) 0) (not nopush))
Jim Blandy's avatar
Jim Blandy committed
681 682
      ;; Update the ring data.
      (if isearch-regexp 
683 684
	  (if (or (null regexp-search-ring)
		  (not (string= isearch-string (car regexp-search-ring))))
Jim Blandy's avatar
Jim Blandy committed
685
	      (progn
686
		(setq regexp-search-ring
687
		      (cons isearch-string regexp-search-ring))
688 689
		(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
690
			    nil))))
691 692
	(if (or (null search-ring)
		(not (string= isearch-string (car search-ring))))
Jim Blandy's avatar
Jim Blandy committed
693
	    (progn
694
	      (setq search-ring (cons isearch-string search-ring))
Jim Blandy's avatar
Jim Blandy committed
695 696 697 698
	      (if (> (length search-ring) search-ring-max)
		  (setcdr (nthcdr (1- search-ring-max) search-ring) nil))))))

  (run-hooks 'isearch-mode-end-hook)
699 700 701 702 703 704 705 706 707 708 709 710
  (if isearch-recursive-edit (exit-recursive-edit)))

;;;=======================================================
;;; Switching buffers should first terminate isearch-mode.
;;; This is done quite differently for each varient of emacs.
;;; 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)
711
  (handle-switch-frame (car (cdr (isearch-last-command-char)))))
712 713

;;;========================================================
Jim Blandy's avatar
Jim Blandy committed
714 715 716 717 718 719 720 721 722


;;;====================================================
;; 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
723
nonincremental search instead via `isearch-edit-string'."
Jim Blandy's avatar
Jim Blandy committed
724 725 726
  (interactive)
  (if (and search-nonincremental-instead 
	   (= 0 (length isearch-string)))
727 728
      (let ((isearch-nonincremental t))
	(isearch-edit-string)))
Jim Blandy's avatar
Jim Blandy committed
729 730 731 732
  (isearch-done))


(defun isearch-edit-string ()
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
  "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.
\\[isearch-backward-exit-minibuffer] to resume isearching backward.
\\[isearch-ring-advance-edit] to replace the search string with the next item in the search ring.
\\[isearch-ring-retreat-edit] to replace the search string with the previou item in the search ring.
\\[isearch-complete-edit] to complete the search string using the search ring.

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.
  ;; Editing doesnt back up the search point.  Should it?
Jim Blandy's avatar
Jim Blandy committed
751
  (interactive)
752
  (condition-case err
753
      (let (isearch-nonincremental	; should search nonincrementally?
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785

	    ;; 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)
	    (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
786
	    (isearch-done t)
787 788 789 790 791 792
	  (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
793 794 795
		   (e (let ((cursor-in-echo-area t))
			(if isearch-event-data-type
			    (allocate-event) (read-char))))
796 797 798 799 800 801 802 803 804 805 806 807 808 809
		   ;; 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
		      (lookup-key
		       isearch-mode-map
		       (char-to-string
810
			(if isearch-event-data-type
811 812 813 814 815
			    (or (event-to-character (next-command-event e)) 0)
			  e))))
		  (setq isearch-word t  ;; so message-prefix is right
			isearch-new-word t)
		(isearch-unread e))
816 817
	      (setq cursor-in-echo-area nil)
	      (setq isearch-new-string
Richard M. Stallman's avatar
Richard M. Stallman committed
818
		    (let (junk-ring)
819 820 821
		      (read-from-minibuffer (isearch-message-prefix)
					    isearch-string
					    minibuffer-local-isearch-map nil
Richard M. Stallman's avatar
Richard M. Stallman committed
822
					    'junk-ring))
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
		    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))
840 841 842 843 844 845
	    (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.
	  )
846 847 848 849 850 851 852 853 854

	;; 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
855

856 857 858 859 860 861 862 863 864 865 866 867 868
    (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
869

870
(defun isearch-reverse-exit-minibuffer ()
Jim Blandy's avatar
Jim Blandy committed
871
  (interactive)
872 873 874 875 876 877 878 879 880 881
  (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)
;;  (ding)  signal instead below, if quiting
Jim Blandy's avatar
Jim Blandy committed
882 883 884 885 886
  (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
887
	     (isearch-done t)   ; exit isearch
888
	     (signal 'quit nil))  ; and pass on quit signal
889
    ;; If search is failing, rub out until it is once more successful.
Jim Blandy's avatar
Jim Blandy committed
890 891 892 893 894 895 896 897 898 899 900 901
    (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
902 903
			(car regexp-search-ring)
		      (car search-ring))
Jim Blandy's avatar
Jim Blandy committed
904 905
		    "")
		isearch-message
906
		(mapconcat 'isearch-text-char-description
Jim Blandy's avatar
Jim Blandy committed
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943
			   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.
  (setq isearch-success t)
  (or (equal isearch-string "")
      (progn
	;; If repeating a search that found
	;; an empty string, ensure we advance.
	(if (equal (match-end 0) (match-beginning 0))
	    (forward-char (if isearch-forward 1 -1)))
	(isearch-search)))
  (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))
944
  (if isearch-regexp (setq isearch-word nil))
Jim Blandy's avatar
Jim Blandy committed
945 946 947 948 949 950 951 952 953 954 955 956 957 958
  (isearch-update))

(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
959 960 961 962 963 964 965 966 967 968 969 970 971 972
  (let ((string (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))))))
    ;; Downcase the string if not supposed to case-fold yanked strings.
    (if (and isearch-case-fold-search
973
	     (eq 'not-yanks search-upper-case))
974 975 976
	(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
977 978
	  isearch-message
	  (concat isearch-message
979 980
		  (mapconcat 'isearch-text-char-description
			     string ""))
Jim Blandy's avatar
Jim Blandy committed
981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
	  ;; Don't move cursor in reverse search.
	  isearch-yank-flag t))
  (isearch-search-and-update))


(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
	      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.
1035
;; They can make a regexp match sooner or make it succeed instead of failing.
Jim Blandy's avatar
Jim Blandy committed
1036 1037
;; So go back to place last successful search started
;; or to the last ^S/^R (barrier), whichever is nearer.
1038
;; + needs no special handling because the string must match at least once.
Jim Blandy's avatar
Jim Blandy committed
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057

(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))))))
1058
  (isearch-process-search-char (isearch-last-command-char)))
Jim Blandy's avatar
Jim Blandy committed
1059 1060 1061 1062 1063 1064 1065 1066 1067
  

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


1071
(fset 'isearch-other-control-char 'isearch-other-meta-char)
Jim Blandy's avatar
Jim Blandy committed
1072 1073

(defun isearch-other-meta-char ()
1074
  "Exit the search normally and reread this key sequence.
Richard M. Stallman's avatar
Richard M. Stallman committed
1075 1076 1077
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
1078
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
1079 1080
  (cond ((eq search-exit-option 'edit)
	 (let ((key (this-command-keys)))
1081
	   (apply 'isearch-unread (listify-key-sequence key)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1082 1083 1084
	 (isearch-edit-string))
	(search-exit-option
	 (let ((key (this-command-keys)))
1085
	   (apply 'isearch-unread (listify-key-sequence key)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1086 1087 1088 1089
	 (isearch-done))
	(t;; otherwise nil
	 (isearch-process-search-string (this-command-keys)
					(this-command-keys)))))
Jim Blandy's avatar
Jim Blandy committed
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105


(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 ()
  "Any other printing character => add it to the search string and search."
  (interactive)
1106
  (isearch-process-search-char (isearch-last-command-char)))
Jim Blandy's avatar
Jim Blandy committed
1107 1108

(defun isearch-whitespace-chars ()
1109 1110
  "Match all whitespace chars, if in regexp mode.
If not in regexp mode, activate word search."
Jim Blandy's avatar
Jim Blandy committed
1111
  (interactive)
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
  (if isearch-regexp 
      (if search-whitespace-regexp
	  (isearch-process-search-string search-whitespace-regexp " ")
	(isearch-printing-char))
    (progn
      ;; This way of doing word search doesnt correctly extend current search.
      ;;      (setq isearch-word t)
      ;;      (setq isearch-adjusted t)
      ;;      (goto-char isearch-barrier)
      (isearch-printing-char))))
Jim Blandy's avatar
Jim Blandy committed
1122 1123 1124

(defun isearch-process-search-char (char)
  ;; Append the char to the search string, update the message and re-search.
1125 1126 1127
  (isearch-process-search-string 
   (isearch-char-to-string char) 
   (isearch-text-char-description char)))
Jim Blandy's avatar
Jim Blandy committed
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137

(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

1138 1139 1140
(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
1141 1142
	 (length (length ring))
	 (yank-pointer-name (if isearch-regexp
1143
				'regexp-search-ring-yank-pointer
Jim Blandy's avatar
Jim Blandy committed
1144 1145 1146 1147 1148 1149
			      'search-ring-yank-pointer))
	 (yank-pointer (eval yank-pointer-name)))
    (if (zerop length)
	()
      (set yank-pointer-name
	   (setq yank-pointer
1150 1151 1152 1153
		 (% (+ (or yank-pointer 0)
		       (if advance (1- length) 1))
		    length)))
      (setq isearch-string (nth yank-pointer ring)
1154 1155 1156 1157 1158 1159 1160 1161
	    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
1162
  (isearch-push-state)
1163 1164 1165 1166 1167 1168
  (if search-ring-update
      (progn
	(isearch-search)
	(isearch-update))
    (isearch-edit-string)
    ))
Jim Blandy's avatar
Jim Blandy committed
1169 1170 1171

(defun isearch-ring-advance ()
  "Advance to the next search string in the ring."
1172
  ;; This could be more general to handle a prefix arg, but who would use it.
Jim Blandy's avatar
Jim Blandy committed
1173 1174 1175 1176 1177 1178 1179 1180
  (interactive)
  (isearch-ring-adjust 'advance))

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

1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
(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
		 (% (+ (or yank-pointer 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
1195 1196 1197
		       ;; Add LENGTH here to ensure a positive result.
		       length
		       (% (- n) length))
1198 1199 1200
		    length)))

      (erase-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
1201
      (insert (nth yank-pointer ring))
1202
      (goto-char (point-max)))))
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222

(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))
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258


(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
1259

1260 1261 1262 1263 1264
(defun isearch-complete-edit ()
  "Same as `isearch-complete' except in the minibuffer."
  (interactive)
  (setq isearch-string (buffer-string))
  (if (isearch-complete1)
Jim Blandy's avatar
Jim Blandy committed
1265
      (progn
1266 1267
	(erase-buffer)
	(insert isearch-string))))
Jim Blandy's avatar
Jim Blandy committed
1268 1269 1270 1271


;;;==============================================================
;; The search status stack (and isearch window-local variables, not used).
1272
;; Need a structure for this.
Jim Blandy's avatar
Jim Blandy committed
1273 1274 1275 1276 1277 1278 1279 1280

(defun isearch-top-state ()
  (let ((cmd (car isearch-cmds)))
    (setq isearch-string (car cmd)
	  isearch-message (car (cdr cmd))
	  isearch-success (nth 3 cmd)
	  isearch-forward (nth 4 cmd)
	  isearch-other-end (nth 5 cmd)
1281 1282 1283 1284
	  isearch-word (nth 6 cmd)
	  isearch-invalid-regexp (nth 7 cmd)
	  isearch-wrapped (nth 8 cmd)
	  isearch-barrier (nth 9 cmd))