lisp/isearch.el

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