lisp/isearch.el

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