]> code.delx.au - gnu-emacs/blobdiff - lisp/isearch.el
(isearch-hidden): New var.
[gnu-emacs] / lisp / isearch.el
index 56179f6b3081f3379ee153c282f966cbc8e14bae..45742b873c41cd5da64fc8456ee6617a67b55ceb 100644 (file)
@@ -1,4 +1,4 @@
-;;; isearch.el --- incremental search minor mode.
+;;; isearch.el --- incremental search minor mode
 
 ;; Copyright (C) 1992, 93, 94, 95, 96, 97, 1999, 2000, 2001
 ;;   Free Software Foundation, Inc.
 ;;; Code:
 
 \f
-;;; Some additional options and constants.
+;; Some additional options and constants.
 
 (defgroup isearch nil
   "Incremental search minor mode."
@@ -171,7 +171,9 @@ nil means don't match invisible text.
 If the value is `open', if the text matched is made invisible by
 an overlay having an `invisible' property and that overlay has a property
 `isearch-open-invisible', then incremental search will show the contents.
-\(This applies when using `outline.el' and `hideshow.el'.)"
+\(This applies when using `outline.el' and `hideshow.el'.)
+See also `reveal-mode' if you want overlays to automatically be opened
+whenever point is in one of them."
   :type '(choice (const :tag "Match hidden text" t)
                 (const :tag "Open overlays" open)
                 (const :tag "Don't match hidden text" nil))
@@ -186,13 +188,18 @@ Ordinarily the text becomes invisible again at the end of the search."
   :type 'boolean 
   :group 'isearch)
 
+(defcustom isearch-resume-enabled t
+  "*If non-nil, `isearch-resume' commands are added to the command history."
+  :type 'boolean
+  :group 'isearch)
+
 (defvar isearch-mode-hook nil
   "Function(s) to call after starting up an incremental search.")
 
 (defvar isearch-mode-end-hook nil
   "Function(s) to call after terminating an incremental search.")
 
-;;; Search ring.
+;; Search ring.
 
 (defvar search-ring nil
   "List of search string sequences.")
@@ -221,7 +228,7 @@ Default value, nil, means edit the string instead."
   :type 'boolean
   :group 'isearch)
 
-;;; Define isearch-mode keymap.
+;; Define isearch-mode keymap.
 
 (defvar isearch-mode-map
   (let* ((i 0)
@@ -286,7 +293,7 @@ Default value, nil, means edit the string instead."
     (define-key map " " 'isearch-whitespace-chars)
     (define-key map [?\S-\ ] 'isearch-whitespace-chars)
     
-    (define-key map "\C-w" 'isearch-yank-word)
+    (define-key map "\C-w" 'isearch-yank-word-or-char)
     (define-key map "\C-y" 'isearch-yank-line)
 
     ;; Define keys for regexp chars * ? |.
@@ -295,9 +302,9 @@ Default value, nil, means edit the string instead."
     (define-key map "?" 'isearch-*-char)
     (define-key map "|" 'isearch-|-char)
 
-;;; Turned off because I find I expect to get the global definition--rms.
-;;;      ;; Instead bind C-h to special help command for isearch-mode.
-;;;      (define-key map "\C-h" 'isearch-mode-help)
+    ;; Turned off because I find I expect to get the global definition--rms.
+    ;; ;; Instead bind C-h to special help command for isearch-mode.
+    ;; (define-key map "\C-h" 'isearch-mode-help)
 
     (define-key map "\M-n" 'isearch-ring-advance)
     (define-key map "\M-p" 'isearch-ring-retreat)
@@ -312,12 +319,13 @@ Default value, nil, means edit the string instead."
     (define-key map [delete-frame] nil)
     (define-key map [iconify-frame] nil)
     (define-key map [make-frame-visible] nil)
+    (define-key map [mouse-movement] nil)
     ;; For searching multilingual text.
     (define-key map "\C-\\" 'isearch-toggle-input-method)
     (define-key map "\C-^" 'isearch-toggle-specified-input-method)
 
     ;; People expect to be able to paste with the mouse.
-    (define-key map [mouse-2] #'isearch-mouse-yank)
+    (define-key map [mouse-2] #'isearch-mouse-2)
     (define-key map [down-mouse-2] nil)
 
     ;; Some bindings you may want to put in your isearch-mode-hook.
@@ -348,8 +356,14 @@ Default value, nil, means edit the string instead."
 (defvar isearch-forward nil)   ; Searching in the forward direction.
 (defvar isearch-regexp nil)    ; Searching for a regexp.
 (defvar isearch-word nil)      ; Searching for words.
+(defvar isearch-hidden nil) ; Non-nil if the string exists but is invisible.
+
+(defvar isearch-cmds nil
+  "Stack of search status sets.
+Each set is a list of the form:
+ (STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD
+  INVALID-REGEXP WRAPPED BARRIER WITHIN-BRACKETS CASE-FOLD-SEARCH)")
 
-(defvar isearch-cmds nil)   ; Stack of search status sets.
 (defvar isearch-string "")  ; The current search string.
 (defvar isearch-message "") ; text-char-description version of isearch-string
 
@@ -360,35 +374,38 @@ Default value, nil, means edit the string instead."
 (defvar isearch-wrapped nil)   ; Searching restarted from the top (bottom).
 (defvar isearch-barrier 0)
 (defvar isearch-just-started nil)
+(defvar isearch-start-hscroll 0)       ; hscroll when starting the search.
 
 ; case-fold-search while searching.
 ;   either nil, t, or 'yes.  'yes means the same as t except that mixed
 ;   case in the search string is ignored.
 (defvar isearch-case-fold-search nil)
 
+(defvar isearch-last-case-fold-search nil)
+
 ;; Used to save default value while isearch is active
 (defvar isearch-original-minibuffer-message-timeout nil)
 
 (defvar isearch-adjusted nil)
 (defvar isearch-slow-terminal-mode nil)
-;;; If t, using a small window.
+;; If t, using a small window.
 (defvar isearch-small-window nil)
 (defvar isearch-opoint 0)
-;;; The window configuration active at the beginning of the search.
+;; The window configuration active at the beginning of the search.
 (defvar isearch-window-configuration nil)
 
 ;; Flag to indicate a yank occurred, so don't move the cursor.
 (defvar isearch-yank-flag nil)
 
-;;; A function to be called after each input character is processed.
-;;; (It is not called after characters that exit the search.)
-;;; It is only set from an optional argument to `isearch-mode'.
+;; A function to be called after each input character is processed.
+;; (It is not called after characters that exit the search.)
+;; It is only set from an optional argument to `isearch-mode'.
 (defvar isearch-op-fun nil)
 
-;;;  Is isearch-mode in a recursive edit for modal searching.
+;;  Is isearch-mode in a recursive edit for modal searching.
 (defvar isearch-recursive-edit nil)
 
-;;; Should isearch be terminated after doing one search?
+;; Should isearch be terminated after doing one search?
 (defvar isearch-nonincremental nil)
 
 ;; New value of isearch-forward after isearch-edit-string.
@@ -419,7 +436,7 @@ Default value, nil, means edit the string instead."
 (define-key global-map "\C-r" 'isearch-backward)
 (define-key esc-map "\C-r" 'isearch-backward-regexp)
 
-;;; Entry points to isearch-mode.
+;; Entry points to isearch-mode.
 
 (defun isearch-forward (&optional regexp-p no-recursive-edit)
   "\
@@ -434,7 +451,7 @@ Type \\[isearch-exit] to exit, leaving point at location found.
 Type LFD (C-j) to match end of line.
 Type \\[isearch-repeat-forward] to search again forward,\
  \\[isearch-repeat-backward] to search again backward.
-Type \\[isearch-yank-word] to yank word from buffer onto end of search\
+Type \\[isearch-yank-word-or-char] to yank word from buffer onto end of search\
  string and search for it.
 Type \\[isearch-yank-line] to yank rest of line onto end of search string\
  and search for it.
@@ -457,13 +474,13 @@ Type \\[isearch-ring-retreat] to search for the previous item in the search\
  ring.
 Type \\[isearch-complete] to complete the search string using the search ring.
 
-If an input method is turned on in the current buffer, the input
+If an input method is turned on in the current buffer, that input
 method is also active while you are typing a characters to search.  To
 toggle the input method, type \\[isearch-toggle-input-method].  It
 also toggles the input method in the current buffer.
 
 To use a different input method for searching, type
-\\[isearch-toggle-input-method] and specify an input method
+\\[isearch-toggle-specified-input-method], and specify an input method
 you want to use.
 
 The above keys, bound in `isearch-mode-map', are often controlled by 
@@ -530,6 +547,7 @@ is treated as a regexp.  See \\[isearch-forward] for more info."
        isearch-regexp regexp
        isearch-word word-p
        isearch-op-fun op-fun
+       isearch-last-case-fold-search isearch-case-fold-search
        isearch-case-fold-search case-fold-search
        isearch-string ""
        isearch-message ""
@@ -543,10 +561,12 @@ is treated as a regexp.  See \\[isearch-forward] for more info."
        isearch-within-brackets nil
        isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
                                        (> (window-height)
-                                          (* 4 search-slow-window-lines)))
+                                          (* 4
+                                             (abs search-slow-window-lines))))
        isearch-other-end nil
        isearch-small-window nil
        isearch-just-started t
+       isearch-start-hscroll (window-hscroll)
 
        isearch-opoint (point)
        search-ring-yank-pointer nil
@@ -573,11 +593,11 @@ is treated as a regexp.  See \\[isearch-forward] for more info."
 
   ;; Maybe make minibuffer frame visible and/or raise it.
   (let ((frame (window-frame (minibuffer-window))))
-    (if (not (memq (frame-live-p frame) '(nil t)))
-       (progn
-         (make-frame-visible frame)
-         (if minibuffer-auto-raise
-             (raise-frame frame)))))
+    (unless (memq (frame-live-p frame) '(nil t))
+      (unless (frame-visible-p frame)
+       (make-frame-visible frame))
+      (if minibuffer-auto-raise
+         (raise-frame frame))))
 
   (setq        isearch-mode " Isearch")  ;; forward? regexp?
   (force-mode-line-update)
@@ -603,8 +623,9 @@ is treated as a regexp.  See \\[isearch-forward] for more info."
 ;; Some high level utilities.  Others below.
 
 (defun isearch-update ()
-  ;; Called after each command to update the display.  
-  (if (null unread-command-events)
+  ;; Called after each command to update the display.
+  (if (and (null unread-command-events)
+          (null executing-kbd-macro))
       (progn
         (if (not (input-pending-p))
             (isearch-message))
@@ -626,8 +647,13 @@ is treated as a regexp.  See \\[isearch-forward] for more info."
                                              (window-hscroll))
                          (set-window-hscroll (selected-window) 0))
                 (other-window 1))
-              (goto-char found-point)))
-        (if isearch-other-end
+              (goto-char found-point))
+         ;; Keep same hscrolling as at the start of the search when possible
+         (let ((current-scroll (window-hscroll)))
+           (set-window-hscroll (selected-window) isearch-start-hscroll)
+           (unless (pos-visible-in-window-p)
+             (set-window-hscroll (selected-window) current-scroll))))
+       (if isearch-other-end
             (if (< isearch-other-end (point)) ; isearch-forward?
                 (isearch-highlight isearch-other-end (point))
               (isearch-highlight (point) isearch-other-end))
@@ -642,12 +668,13 @@ is treated as a regexp.  See \\[isearch-forward] for more info."
   (setq disable-point-adjustment t))
 
 (defun isearch-done (&optional nopush edit)
-  (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
-                                 ,isearch-word ,isearch-forward
-                                 ,isearch-message
-                                 ,isearch-case-fold-search)))
-    (unless (equal (car command-history) command)
-      (setq command-history (cons command command-history))))
+  (if isearch-resume-enabled
+      (let ((command `(isearch-resume ,isearch-string ,isearch-regexp
+                                     ,isearch-word ,isearch-forward
+                                     ,isearch-message
+                                     ',isearch-case-fold-search)))
+       (unless (equal (car command-history) command)
+         (setq command-history (cons command command-history)))))
 
   (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
   (remove-hook 'kbd-macro-termination-hook 'isearch-done)
@@ -723,14 +750,14 @@ REGEXP says which ring to use."
          (if (> (length search-ring) search-ring-max)
              (setcdr (nthcdr (1- search-ring-max) search-ring) nil))))))
 
-;;; Switching buffers should first terminate isearch-mode.
-;;; ;; For Emacs 19, the frame switch event is handled.
-;;; (defun isearch-switch-frame-handler ()
-;;;   (interactive) ;; Is this necessary?
-;;;   ;; First terminate isearch-mode.
-;;;   (isearch-done)
-;;;   (isearch-clean-overlays) 
-;;;   (handle-switch-frame (car (cdr last-command-char))))
+;; Switching buffers should first terminate isearch-mode.
+;; ;; For Emacs 19, the frame switch event is handled.
+;; (defun isearch-switch-frame-handler ()
+;;   (interactive) ;; Is this necessary?
+;;   ;; First terminate isearch-mode.
+;;   (isearch-done)
+;;   (isearch-clean-overlays)
+;;   (handle-switch-frame (car (cdr last-command-char))))
 
 \f
 ;; Commands active while inside of the isearch minor mode.
@@ -761,7 +788,7 @@ The following additional command keys are active while editing.
 \\[isearch-ring-retreat-edit] to replace the search string with the previous item in the search ring.
 \\[isearch-complete-edit] to complete the search string using the search ring.
 \\<isearch-mode-map>
-If first char entered is \\[isearch-yank-word], then do word search instead."
+If first char entered is \\[isearch-yank-word-or-char], then do word search instead."
 
   ;; This code is very hairy for several reasons, explained in the code.
   ;; Mainly, isearch-mode must be terminated while editing and then restarted.
@@ -836,8 +863,9 @@ If first char entered is \\[isearch-yank-word], then do word search instead."
                ;; Word search does not apply (yet) to regexp searches,
                ;; no check is made here.
                (message (isearch-message-prefix nil nil t))
-               (if (eq 'isearch-yank-word
-                       (lookup-key isearch-mode-map (vector e)))
+               (if (memq (lookup-key isearch-mode-map (vector e))
+                         '(isearch-yank-word
+                           isearch-yank-word-or-char))
                    (setq isearch-word t;; so message-prefix is right
                          isearch-new-word t)
                  (cancel-kbd-macro-events)
@@ -871,7 +899,11 @@ If first char entered is \\[isearch-yank-word], then do word search instead."
              (setq isearch-string (or (car (if isearch-regexp
                                                regexp-search-ring
                                              search-ring))
-                                      ""))
+                                      "")
+
+                   isearch-message
+                   (mapconcat 'isearch-text-char-description
+                              isearch-string ""))
            ;; This used to set the last search string,
            ;; but I think it is not right to do that here.
            ;; Only the string actually used should be saved.
@@ -949,7 +981,8 @@ Use `isearch-exit' to quit without signaling."
                    "")
                isearch-message
                (mapconcat 'isearch-text-char-description
-                          isearch-string ""))
+                          isearch-string "")
+               isearch-case-fold-search isearch-last-case-fold-search)
        ;; If already have what to search for, repeat it.
        (or isearch-success
            (progn
@@ -1011,7 +1044,7 @@ Use `isearch-exit' to quit without signaling."
   (isearch-update))
 
 (defun isearch-delete-char ()
-  "Discard last input item and move point back.  
+  "Discard last input item and move point back.
 If no previous match was done, just beep."
   (interactive)
   (if (null (cdr isearch-cmds))
@@ -1046,45 +1079,75 @@ If no previous match was done, just beep."
   (interactive)
   (isearch-yank-string (x-get-selection)))
 
-(defun isearch-mouse-yank (click arg)
-  "Yank with the mouse in Isearch mode.
+
+(defun isearch-mouse-2 (click)
+  "Handle mouse-2 in Isearch mode.
 For a click in the echo area, invoke `isearch-yank-x-selection'.
-Otherwise invoke `mouse-yank-at-click'."
-  (interactive "e\nP")
-  (let ((w (posn-window (event-start click))))
+Otherwise invoke whatever mouse-2 is bound to outside of Isearch."
+  (interactive "e")
+  (let* ((w (posn-window (event-start click)))
+        (overriding-terminal-local-map nil)
+        (key (vector (event-basic-type click)))
+        ;; FIXME: `key-binding' should accept an event as argument
+        ;; and do all the overlay/text-properties lookup etc...
+        (binding (with-current-buffer
+                     (if (window-live-p w) (window-buffer w) (current-buffer))
+                   (key-binding key))))
     (if (and (window-minibuffer-p w)
             (not (minibuffer-window-active-p w))) ; in echo area
        (isearch-yank-x-selection)
-      (mouse-yank-at-click click arg))))
+      (when (functionp binding)
+       (call-interactively binding)))))
 
-(defun isearch-yank-word ()
-  "Pull next word from buffer into search string."
-  (interactive)
+
+(defun isearch-yank-internal (jumpform)
+  "Pull the text from point to the point reached by JUMPFORM.
+JUMPFORM is a lambda expression that takes no arguments and returns a
+buffer position, possibly having moved point to that position.  For
+example, it might move point forward by a word and return point, or it
+might return the position of the end of the line."
   (isearch-yank-string
    (save-excursion
      (and (not isearch-forward) isearch-other-end
          (goto-char isearch-other-end))
-     (buffer-substring-no-properties
-      (point) (progn (forward-word 1) (point))))))
+     (buffer-substring-no-properties (point) (funcall jumpform)))))
+
+(defun isearch-yank-char ()
+  "Pull next letter from buffer into search string."
+  (interactive)
+  (isearch-yank-internal (lambda () (forward-char 1) (point))))
+
+(defun isearch-yank-word-or-char ()
+  "Pull next character or word from buffer into search string."
+  (interactive)
+  (isearch-yank-internal
+   (lambda () 
+     (if (or (= (char-syntax (or (char-after) 0)) ?w)
+             (= (char-syntax (or (char-after (1+ (point))) 0)) ?w))
+         (forward-word 1)
+       (forward-char 1)) (point))))
+
+(defun isearch-yank-word ()
+  "Pull next word from buffer into search string."
+  (interactive)
+  (isearch-yank-internal (lambda () (forward-word 1) (point))))
 
 (defun isearch-yank-line ()
   "Pull rest of line from buffer into search string."
   (interactive)
-  (isearch-yank-string
-   (save-excursion
-     (and (not isearch-forward) isearch-other-end
-         (goto-char isearch-other-end))
-     (buffer-substring-no-properties (point) (line-end-position)))))
+  (isearch-yank-internal 'line-end-position)))
 
 
 (defun isearch-search-and-update ()
   ;; Do the search and update the display.
-  (if (and (not isearch-success)
-          ;; unsuccessful regexp search may become
-          ;;  successful by addition of characters which
-          ;;  make isearch-string valid
-          (not isearch-regexp))
-      nil
+  (when (or isearch-success
+           ;; unsuccessful regexp search may become
+           ;;  successful by addition of characters which
+           ;;  make isearch-string valid
+           isearch-regexp
+           ;; If the string was found but was completely invisible,
+           ;; it might now be partly visible, so try again.
+           (prog1 isearch-hidden (setq isearch-hidden nil)))
     ;; In reverse search, adding stuff at
     ;; the end may cause zero or many more chars to be
     ;; matched, in the string following point.
@@ -1100,10 +1163,10 @@ Otherwise invoke `mouse-yank-at-click'."
                                 (regexp-quote isearch-string))))
               (error nil))
             (or isearch-yank-flag
-                (<= (match-end 0) 
+                (<= (match-end 0)
                     (min isearch-opoint isearch-barrier))))
        (progn
-         (setq isearch-success t 
+         (setq isearch-success t
                isearch-invalid-regexp nil
                isearch-within-brackets nil
                isearch-other-end (match-end 0))
@@ -1113,8 +1176,8 @@ Otherwise invoke `mouse-yank-at-click'."
       ;; Not regexp, not reverse, or no match at point.
       (if (and isearch-other-end (not isearch-adjusted))
          (goto-char (if isearch-forward isearch-other-end
-                      (min isearch-opoint 
-                           isearch-barrier 
+                      (min isearch-opoint
+                           isearch-barrier
                            (1+ isearch-other-end)))))
       (isearch-search)
       ))
@@ -1132,7 +1195,7 @@ Otherwise invoke `mouse-yank-at-click'."
 (defun isearch-*-char ()
   "Handle * and ? specially in regexps."
   (interactive)
-  (if isearch-regexp 
+  (if isearch-regexp
       (let ((idx (length isearch-string)))
        (while (and (> idx 0)
                    (eq (aref isearch-string (1- idx)) ?\\))
@@ -1229,24 +1292,39 @@ and the meta character is unread so that it applies to editing the string."
           (let (window)
             (cancel-kbd-macro-events)
             (apply 'isearch-unread keylist)
-            ;; Properly handle scroll-bar and mode-line clicks
-            ;; for which a dummy prefix event was generated as (aref key 0).
-            (and (> (length key) 1)
-                 (symbolp (aref key 0))
-                 (listp (aref key 1))
-                 (not (numberp (posn-point (event-start (aref key 1)))))
-                 ;; Convert the event back into its raw form,
-                 ;; with the dummy prefix implicit in the mouse event,
-                 ;; so it will get split up once again.
-                 (progn (setq unread-command-events
-                              (cdr unread-command-events))
-                        (setq main-event (car unread-command-events))
-                        (setcar (cdr (event-start main-event))
-                                (car (nth 1 (event-start main-event))))))
-            ;; If we got a mouse click, maybe it was read with the buffer
+
+            ;; Properly handle scroll-bar and mode-line clicks for
+            ;; which a dummy prefix event was generated as (aref key
+            ;; 0).  Note that we don't have to modify the event
+            ;; anymore in 21 because read_key_sequence no longer modifies
+            ;; events to produce fake prefix keys.
+            (when (and (> (length key) 1)
+                       (symbolp (aref key 0))
+                       (listp (aref key 1))
+                       (not (numberp (posn-point
+                                      (event-start (aref key 1))))))
+              (pop unread-command-events)
+              (setq main-event (car unread-command-events)))
+
+            ;; If we got a mouse click event, that event contains the
+            ;; window clicked on. maybe it was read with the buffer
             ;; it was clicked on.  If so, that buffer, not the current one,
             ;; is in isearch mode.  So end the search in that buffer.
-            (if (and (listp main-event)
+
+            ;; ??? I have no idea what this if checks for, but it's
+            ;; obviously wrong for the case that a down-mouse event
+            ;; on another window invokes this function.  The event
+            ;; will contain the window clicked on and that window's
+            ;; buffer is certainaly not always in Isearch mode.
+            ;;
+            ;; Leave the code in, but check for current buffer not
+            ;; being in Isearch mode for now, until someone tells
+            ;; what it's really supposed to do.
+            ;;
+            ;; --gerd 2001-08-10.
+
+            (if (and (not isearch-mode)
+                     (listp main-event)
                      (setq window (posn-window (event-start main-event)))
                      (windowp window)
                      (or (> (minibuffer-depth) 0)
@@ -1297,7 +1375,7 @@ Obsolete."
 
 (defun isearch-whitespace-chars ()
   "Match all whitespace chars, if in regexp mode.
-If you want to search for just a space, type \\[quoted-insert] SPC."
+If you want to search for just a space, type \\<isearch-mode-map>\\[isearch-quote-char] SPC."
   (interactive)
   (if isearch-regexp 
       (if (and search-whitespace-regexp (not isearch-within-brackets)
@@ -1313,8 +1391,8 @@ If you want to search for just a space, type \\[quoted-insert] SPC."
 
 (defun isearch-process-search-char (char)
   ;; Append the char to the search string, update the message and re-search.
-  (isearch-process-search-string 
-   (char-to-string char) 
+  (isearch-process-search-string
+   (char-to-string char)
    (if (>= char ?\200)
        (char-to-string char)
      (isearch-text-char-description char))))
@@ -1532,8 +1610,8 @@ If there is no completion possible, say so and continue searching."
                       (concat " [" current-input-method-title "]: ")
                     ": ")
                   )))
-    (concat (upcase (substring m 0 1)) (substring m 1))))
-
+    (propertize (concat (upcase (substring m 0 1)) (substring m 1))
+               'face 'minibuffer-prompt)))
 
 (defun isearch-message-suffix (&optional c-q-hack ellipsis)
   (concat (if c-q-hack "^Q" "")
@@ -1542,7 +1620,22 @@ If there is no completion possible, say so and continue searching."
            "")))
 
 \f
-;;; Searching
+;; Searching
+
+(defvar isearch-search-fun-function nil "Override `isearch-function-fun'.")
+
+(defun isearch-search-fun ()
+  "Return the function to use for the search.
+Can be changed via `isearch-search-fun-function' for special needs."
+  (if isearch-search-fun-function
+      (funcall isearch-search-fun-function)
+    (cond
+     (isearch-word
+      (if isearch-forward 'word-search-forward 'word-search-backward))
+     (isearch-regexp
+      (if isearch-forward 're-search-forward 're-search-backward))
+     (t
+      (if isearch-forward 'search-forward 'search-backward)))))
 
 (defun isearch-search ()
   ;; Do the search with the current search string.
@@ -1560,14 +1653,7 @@ If there is no completion possible, say so and continue searching."
        (while retry
          (setq isearch-success
                (funcall
-                (cond (isearch-word
-                       (if isearch-forward
-                           'word-search-forward 'word-search-backward))
-                      (isearch-regexp
-                       (if isearch-forward
-                           're-search-forward 're-search-backward))
-                      (t
-                       (if isearch-forward 'search-forward 'search-backward)))
+                (isearch-search-fun)
                 isearch-string nil t))
          ;; Clear RETRY unless we matched some invisible text
          ;; and we aren't supposed to do that.
@@ -1586,7 +1672,7 @@ If there is no completion possible, say so and continue searching."
     (quit (isearch-unread ?\C-g)
          (setq isearch-success nil))
 
-    (invalid-regexp 
+    (invalid-regexp
      (setq isearch-invalid-regexp (car (cdr lossage)))
      (setq isearch-within-brackets (string-match "\\`Unmatched \\["
                                                 isearch-invalid-regexp))
@@ -1606,7 +1692,7 @@ If there is no completion possible, say so and continue searching."
     (goto-char (nth 2 (car isearch-cmds)))))
 
 
-;;; Called when opening an overlay, and we are still in isearch.
+;; Called when opening an overlay, and we are still in isearch.
 (defun isearch-open-overlay-temporary (ov)
   (if (not (null (overlay-get ov 'isearch-open-invisible-temporary))) 
       ;; Some modes would want to open the overlays temporary during
@@ -1626,12 +1712,12 @@ If there is no completion possible, say so and continue searching."
     (overlay-put ov 'intangible nil)))
 
 
-;;; This is called at the end of isearch.  It will open the overlays
-;;; that contain the latest match.  Obviously in case of a C-g the
-;;; point returns to the original location which surely is not contain
-;;; in any of these overlays, se we are safe in this case too.
+;; This is called at the end of isearch.  It will open the overlays
+;; that contain the latest match.  Obviously in case of a C-g the
+;; point returns to the original location which surely is not contain
+;; in any of these overlays, se we are safe in this case too.
 (defun isearch-open-necessary-overlays (ov)
-  (let ((inside-overlay (and  (> (point) (overlay-start ov)) 
+  (let ((inside-overlay (and  (> (point) (overlay-start ov))
                              (< (point) (overlay-end ov))))
        ;; If this exists it means that the overlay was opened using
        ;; this function, not by us tweaking the overlay properties.
@@ -1648,107 +1734,109 @@ If there is no completion possible, say so and continue searching."
       (if fct-temp
          (funcall fct-temp ov t)))))
 
-;;; This is called when exiting isearch. It closes the temporary
-;;; opened overlays, except the ones that contain the latest match.
+;; This is called when exiting isearch. It closes the temporary
+;; opened overlays, except the ones that contain the latest match.
 (defun isearch-clean-overlays ()
   (when isearch-opened-overlays
     (mapc 'isearch-open-necessary-overlays isearch-opened-overlays)
     (setq isearch-opened-overlays nil)))
 
-;;; Verify if the current match is outside of each element of
-;;; `isearch-opened-overlays', if so close that overlay.
-(defun isearch-close-unecessary-overlays (begin end)
-  (let ((ov-list isearch-opened-overlays)
-       ov
-       inside-overlay
-       fct-temp)
+
+(defun isearch-intersects-p (start0 end0 start1 end1)
+  "Return t if regions START0..END0 and START1..END1 intersect."
+  (or (and (>= start0 start1) (<  start0 end1))
+      (and (>  end0 start1)   (<= end0 end1))
+      (and (>= start1 start0) (<  start1 end0))
+      (and (>  end1 start0)   (<= end1 end0))))
+
+
+;; Verify if the current match is outside of each element of
+;; `isearch-opened-overlays', if so close that overlay.
+
+(defun isearch-close-unnecessary-overlays (begin end)
+  (let ((overlays isearch-opened-overlays))
     (setq isearch-opened-overlays nil)
-    (while ov-list
-      (setq ov (car ov-list))
-      (setq ov-list (cdr ov-list))
-      (setq inside-overlay (or (and  (> begin (overlay-start ov)) 
-                                    (< begin (overlay-end ov)))
-                              (and  (> end (overlay-start ov)) 
-                                    (< end (overlay-end ov)))))
-      ;; If this exists it means that the overlay was opened using
-      ;; this function, not by us tweaking the overlay properties.
-      (setq fct-temp (overlay-get ov 'isearch-open-invisible-temporary))
-      (if inside-overlay
-         (setq isearch-opened-overlays (cons ov isearch-opened-overlays))
-       (if fct-temp
-           (funcall fct-temp ov t)
-         (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
-         (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
-         (overlay-put ov 'isearch-invisible nil)
-         (overlay-put ov 'isearch-intangible nil))))))
+    (dolist (ov overlays)
+      (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov))
+         (push ov isearch-opened-overlays)
+       (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary)))
+         (if fct-temp
+             ;; If this exists it means that the overlay was opened
+             ;; using this function, not by us tweaking the overlay
+             ;; properties.
+             (funcall fct-temp ov t)
+           (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible))
+           (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible))
+           (overlay-put ov 'isearch-invisible nil)
+           (overlay-put ov 'isearch-intangible nil)))))))
+
 
 (defun isearch-range-invisible (beg end)
   "Return t if all the text from BEG to END is invisible."
-  (and (/= beg end)
-       ;; Check that invisibility runs up to END.
-       (save-excursion
-        (goto-char beg)
-        (let (
-              ;; can-be-opened keeps track if we can open some overlays.
-              (can-be-opened (eq search-invisible 'open))
-              ;; the list of overlays that could be opened
-              (crt-overlays nil))
-          (when (and can-be-opened isearch-hide-immediately) 
-            (isearch-close-unecessary-overlays beg end))
-          ;; If the following character is currently invisible,
-          ;; skip all characters with that same `invisible' property value.
-          ;; Do that over and over.
-          (while (and (< (point) end)
-                      (let ((prop
-                             (get-char-property (point) 'invisible)))
-                        (if (eq buffer-invisibility-spec t)
-                            prop
-                          (or (memq prop buffer-invisibility-spec)
-                              (assq prop buffer-invisibility-spec)))))
-            (if (get-text-property (point) 'invisible)
-                (progn 
-                  (goto-char (next-single-property-change (point) 'invisible
-                                                          nil end))
-                  ;; if text is hidden by an `invisible' text property
-                  ;; we cannot open it at all.
-                  (setq can-be-opened nil))
-              (unless (null can-be-opened)
-                (let ((overlays (overlays-at (point)))
-                      ov-list
-                      o
-                      invis-prop)
-                  (while overlays
-                    (setq o (car overlays)
-                          invis-prop (overlay-get o 'invisible))
-                    (if (if (eq buffer-invisibility-spec t)
-                            invis-prop
-                          (or (memq invis-prop buffer-invisibility-spec)
-                              (assq invis-prop buffer-invisibility-spec)))
-                        (if (overlay-get o 'isearch-open-invisible)
-                            (setq ov-list (cons o ov-list))
-                          ;; We found one overlay that cannot be
-                          ;; opened, that means the whole chunk
-                          ;; cannot be opened.
-                          (setq can-be-opened nil)))
-                    (setq overlays (cdr overlays)))
-                  (if can-be-opened 
-                      ;; It makes sense to append to the open
-                      ;; overlays list only if we know that this is
-                      ;; t.
-                      (setq crt-overlays (append ov-list crt-overlays)))))
-              (goto-char (next-overlay-change (point)))))
-        ;; See if invisibility reaches up thru END.
-        (if (>= (point) end)
-            (if (and (not (null can-be-opened)) (consp crt-overlays))
-                (progn
-                  (setq isearch-opened-overlays
-                        (append isearch-opened-overlays crt-overlays))
-                  (mapc 'isearch-open-overlay-temporary crt-overlays)
-                  nil)
-              t))))))
+  (when (/= beg end)
+    ;; Check that invisibility runs up to END.
+    (save-excursion
+      (goto-char beg)
+      (let (;; can-be-opened keeps track if we can open some overlays.
+           (can-be-opened (eq search-invisible 'open))
+           ;; the list of overlays that could be opened
+           (crt-overlays nil))
+       (when (and can-be-opened isearch-hide-immediately)
+         (isearch-close-unnecessary-overlays beg end))
+       ;; If the following character is currently invisible,
+       ;; skip all characters with that same `invisible' property value.
+       ;; Do that over and over.
+       (while (and (< (point) end)
+                   (let ((prop
+                          (get-char-property (point) 'invisible)))
+                     (if (eq buffer-invisibility-spec t)
+                         prop
+                       (or (memq prop buffer-invisibility-spec)
+                           (assq prop buffer-invisibility-spec)))))
+         (if (get-text-property (point) 'invisible)
+             (progn
+               (goto-char (next-single-property-change (point) 'invisible
+                                                       nil end))
+               ;; if text is hidden by an `invisible' text property
+               ;; we cannot open it at all.
+               (setq can-be-opened nil))
+           (when can-be-opened
+             (let ((overlays (overlays-at (point)))
+                   ov-list
+                   o
+                   invis-prop)
+               (while overlays
+                 (setq o (car overlays)
+                       invis-prop (overlay-get o 'invisible))
+                 (if (if (eq buffer-invisibility-spec t)
+                         invis-prop
+                       (or (memq invis-prop buffer-invisibility-spec)
+                           (assq invis-prop buffer-invisibility-spec)))
+                     (if (overlay-get o 'isearch-open-invisible)
+                         (setq ov-list (cons o ov-list))
+                       ;; We found one overlay that cannot be
+                       ;; opened, that means the whole chunk
+                       ;; cannot be opened.
+                       (setq can-be-opened nil)))
+                 (setq overlays (cdr overlays)))
+               (if can-be-opened
+                   ;; It makes sense to append to the open
+                   ;; overlays list only if we know that this is
+                   ;; t.
+                   (setq crt-overlays (append ov-list crt-overlays)))))
+           (goto-char (next-overlay-change (point)))))
+       ;; See if invisibility reaches up thru END.
+       (if (>= (point) end)
+           (if (and can-be-opened (consp crt-overlays))
+               (progn
+                 (setq isearch-opened-overlays
+                       (append isearch-opened-overlays crt-overlays))
+                 (mapc 'isearch-open-overlay-temporary crt-overlays)
+                 nil)
+             (setq isearch-hidden t)))))))
 
 \f
-;;; Highlighting
+;; Highlighting
 
 (defvar isearch-overlay nil)
 
@@ -1770,7 +1858,7 @@ If there is no completion possible, say so and continue searching."
     (delete-overlay isearch-overlay)))
 
 
-;;; General utilities
+;; General utilities
 
 
 (defun isearch-no-upper-case-p (string regexp-flag)
@@ -1803,32 +1891,30 @@ since they have special meaning in a regexp."
        (append char-or-events unread-command-events)))
 
 \f
-;;; isearch-lazy-highlight feature
-;;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
-
-;;; When active, *every* match for the current search string is
-;;; highlighted: the current one using the normal isearch match color
-;;; and all the others using `isearch-lazy-highlight-face'.  The extra
-;;; highlighting makes it easier to anticipate where the cursor will
-;;; land each time you press C-s or C-r to repeat a pending search.
-;;; Highlighting of these additional matches happens in a deferred
-;;; fashion using "idle timers," so the cycles needed do not rob
-;;; isearch of its usual snappy response.
-
-;;; IMPLEMENTATION NOTE: This depends on some isearch internals.
-;;; Specifically:
-;;;  - `isearch-update' is expected to be called (at least) every time
-;;;    the search string or window-start changes;
-;;;  - `isearch-string' is expected to contain the current search
-;;;    string as entered by the user;
-;;;  - the type of the current search is expected to be given by
-;;;    `isearch-word' and `isearch-regexp';
-;;;  - the direction of the current search is expected to be given by
-;;;    `isearch-forward';
-;;;  - the variable `isearch-invalid-regexp' is expected to be true
-;;;    iff `isearch-string' is an invalid regexp.
-
-(require 'timer)
+;; isearch-lazy-highlight feature
+;; by Bob Glickstein <http://www.zanshin.com/~bobg/>
+
+;; When active, *every* match for the current search string is
+;; highlighted: the current one using the normal isearch match color
+;; and all the others using `isearch-lazy-highlight-face'.  The extra
+;; highlighting makes it easier to anticipate where the cursor will
+;; land each time you press C-s or C-r to repeat a pending search.
+;; Highlighting of these additional matches happens in a deferred
+;; fashion using "idle timers," so the cycles needed do not rob
+;; isearch of its usual snappy response.
+
+;; IMPLEMENTATION NOTE: This depends on some isearch internals.
+;; Specifically:
+;;  - `isearch-update' is expected to be called (at least) every time
+;;    the search string or window-start changes;
+;;  - `isearch-string' is expected to contain the current search
+;;    string as entered by the user;
+;;  - the type of the current search is expected to be given by
+;;    `isearch-word' and `isearch-regexp';
+;;  - the direction of the current search is expected to be given by
+;;    `isearch-forward';
+;;  - the variable `isearch-invalid-regexp' is expected to be true
+;;    iff `isearch-string' is an invalid regexp.
 
 (defgroup isearch-lazy-highlight nil
   "Lazy highlighting feature for incremental search."
@@ -1879,7 +1965,9 @@ A value of nil means highlight all matches."
   '((((type tty pc) (class color))
      (:background "magenta4" :foreground "cyan1"))
     (((class color) (background light))
-     (:background "magenta4" :foreground "lightskyblue1"))
+     ;; The background must not be too dark, for that means
+     ;; the character is hard to see when the cursor is there.
+     (:background "magenta2" :foreground "lightskyblue1"))
     (((class color) (background dark))
      (:background "palevioletred2" :foreground "brown4"))
     (t (:inverse-video t)))
@@ -1930,6 +2018,7 @@ is nil.  This function is called when exiting an incremental search if
 This happens when `isearch-update' is invoked (which can cause the
 search string to change or the window to scroll)."
   (when (and isearch-lazy-highlight
+            (null executing-kbd-macro)
              (sit-for 0)         ;make sure (window-start) is credible
              (or (not (equal isearch-string
                              isearch-lazy-highlight-last-string))
@@ -1959,16 +2048,8 @@ search string to change or the window to scroll)."
 (defun isearch-lazy-highlight-search ()
   "Search ahead for the next or previous match, for lazy highlighting.
 Attempt to do the search exactly the way the pending isearch would."
-  (let ((case-fold-search isearch-case-fold-search)
-        (choices (cond (isearch-word
-                        '(word-search-forward . word-search-backward))
-                       (isearch-regexp
-                        '(re-search-forward . re-search-backward))
-                       (t
-                        '(search-forward . search-backward)))))
-    (funcall (if isearch-forward
-                 (car choices)
-               (cdr choices))
+  (let ((case-fold-search isearch-case-fold-search))
+    (funcall (isearch-search-fun)
              isearch-string
              (if isearch-forward
                  (if isearch-lazy-highlight-wrapped
@@ -2040,5 +2121,5 @@ CASE-FOLD non-nil means the search was case-insensitive."
        isearch-message message
        isearch-case-fold-search case-fold)
   (isearch-search))
-       
+
 ;;; isearch.el ends here