home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / emacs-19.28-src.tgz / tar.out / fsf / emacs / lisp / isearch.el < prev    next >
Text File  |  1996-09-28  |  53KB  |  1,453 lines

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