lisp/isearch.el

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