| 1 | ;;; isearch.el --- incremental search minor mode |
| 2 | |
| 3 | ;; Copyright (C) 1992-1997, 1999-2011 Free Software Foundation, Inc. |
| 4 | |
| 5 | ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu> |
| 6 | ;; Maintainer: FSF |
| 7 | ;; Keywords: matching |
| 8 | ;; Package: emacs |
| 9 | |
| 10 | ;; This file is part of GNU Emacs. |
| 11 | |
| 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
| 13 | ;; it under the terms of the GNU General Public License as published by |
| 14 | ;; the Free Software Foundation, either version 3 of the License, or |
| 15 | ;; (at your option) any later version. |
| 16 | |
| 17 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 20 | ;; GNU General Public License for more details. |
| 21 | |
| 22 | ;; You should have received a copy of the GNU General Public License |
| 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
| 24 | |
| 25 | ;;; Commentary: |
| 26 | |
| 27 | ;; Instructions |
| 28 | |
| 29 | ;; For programmed use of isearch-mode, e.g. calling (isearch-forward), |
| 30 | ;; isearch-mode behaves modally and does not return until the search |
| 31 | ;; is completed. It uses a recursive-edit to behave this way. |
| 32 | |
| 33 | ;; The key bindings active within isearch-mode are defined below in |
| 34 | ;; `isearch-mode-map' which is given bindings close to the default |
| 35 | ;; characters of the original isearch.el. With `isearch-mode', |
| 36 | ;; however, you can bind multi-character keys and it should be easier |
| 37 | ;; to add new commands. One bug though: keys with meta-prefix cannot |
| 38 | ;; be longer than two chars. Also see minibuffer-local-isearch-map |
| 39 | ;; for bindings active during `isearch-edit-string'. |
| 40 | |
| 41 | ;; isearch-mode should work even if you switch windows with the mouse, |
| 42 | ;; in which case isearch-mode is terminated automatically before the |
| 43 | ;; switch. |
| 44 | |
| 45 | ;; The search ring and completion commands automatically put you in |
| 46 | ;; the minibuffer to edit the string. This gives you a chance to |
| 47 | ;; modify the search string before executing the search. There are |
| 48 | ;; three commands to terminate the editing: C-s and C-r exit the |
| 49 | ;; minibuffer and search forward and reverse respectively, while C-m |
| 50 | ;; exits and does a nonincremental search. |
| 51 | |
| 52 | ;; Exiting immediately from isearch uses isearch-edit-string instead |
| 53 | ;; of nonincremental-search, if search-nonincremental-instead is non-nil. |
| 54 | ;; The name of this option should probably be changed if we decide to |
| 55 | ;; keep the behavior. No point in forcing nonincremental search until |
| 56 | ;; the last possible moment. |
| 57 | |
| 58 | ;;; Code: |
| 59 | |
| 60 | \f |
| 61 | ;; Some additional options and constants. |
| 62 | |
| 63 | (defgroup isearch nil |
| 64 | "Incremental search minor mode." |
| 65 | :link '(emacs-commentary-link "isearch") |
| 66 | :link '(custom-manual "(emacs)Incremental Search") |
| 67 | :prefix "isearch-" |
| 68 | :prefix "search-" |
| 69 | :group 'matching) |
| 70 | |
| 71 | |
| 72 | (defcustom search-exit-option t |
| 73 | "Non-nil means random control characters terminate incremental search." |
| 74 | :type 'boolean |
| 75 | :group 'isearch) |
| 76 | |
| 77 | (defcustom search-slow-window-lines 1 |
| 78 | "Number of lines in slow search display windows. |
| 79 | These are the short windows used during incremental search on slow terminals. |
| 80 | Negative means put the slow search window at the top (normally it's at bottom) |
| 81 | and the value is minus the number of lines." |
| 82 | :type 'integer |
| 83 | :group 'isearch) |
| 84 | |
| 85 | (defcustom search-slow-speed 1200 |
| 86 | "Highest terminal speed at which to use \"slow\" style incremental search. |
| 87 | This is the style where a one-line window is created to show the line |
| 88 | that the search has reached." |
| 89 | :type 'integer |
| 90 | :group 'isearch) |
| 91 | |
| 92 | (defcustom search-upper-case 'not-yanks |
| 93 | "If non-nil, upper case chars disable case fold searching. |
| 94 | That is, upper and lower case chars must match exactly. |
| 95 | This applies no matter where the chars come from, but does not |
| 96 | apply to chars in regexps that are prefixed with `\\'. |
| 97 | If this value is `not-yanks', text yanked into the search string |
| 98 | in Isearch mode is always downcased." |
| 99 | :type '(choice (const :tag "off" nil) |
| 100 | (const not-yanks) |
| 101 | (other :tag "on" t)) |
| 102 | :group 'isearch) |
| 103 | |
| 104 | (defcustom search-nonincremental-instead t |
| 105 | "If non-nil, do a nonincremental search instead if exiting immediately. |
| 106 | Actually, `isearch-edit-string' is called to let you enter the search |
| 107 | string, and RET terminates editing and does a nonincremental search." |
| 108 | :type 'boolean |
| 109 | :group 'isearch) |
| 110 | |
| 111 | (defcustom search-whitespace-regexp (purecopy "\\s-+") |
| 112 | "If non-nil, regular expression to match a sequence of whitespace chars. |
| 113 | This applies to regular expression incremental search. |
| 114 | When you put a space or spaces in the incremental regexp, it stands for |
| 115 | this, unless it is inside of a regexp construct such as [...] or *, + or ?. |
| 116 | You might want to use something like \"[ \\t\\r\\n]+\" instead. |
| 117 | In the Customization buffer, that is `[' followed by a space, |
| 118 | a tab, a carriage return (control-M), a newline, and `]+'. |
| 119 | |
| 120 | When this is nil, each space you type matches literally, against one space." |
| 121 | :type '(choice (const :tag "Find Spaces Literally" nil) |
| 122 | regexp) |
| 123 | :group 'isearch) |
| 124 | |
| 125 | (defcustom search-invisible 'open |
| 126 | "If t incremental search can match hidden text. |
| 127 | A nil value means don't match invisible text. |
| 128 | When the value is `open', if the text matched is made invisible by |
| 129 | an overlay having an `invisible' property and that overlay has a property |
| 130 | `isearch-open-invisible', then incremental search will show the contents. |
| 131 | \(This applies when using `outline.el' and `hideshow.el'.) |
| 132 | See also `reveal-mode' if you want overlays to automatically be opened |
| 133 | whenever point is in one of them." |
| 134 | :type '(choice (const :tag "Match hidden text" t) |
| 135 | (const :tag "Open overlays" open) |
| 136 | (const :tag "Don't match hidden text" nil)) |
| 137 | :group 'isearch) |
| 138 | |
| 139 | (defcustom isearch-hide-immediately t |
| 140 | "If non-nil, re-hide an invisible match right away. |
| 141 | This variable makes a difference when `search-invisible' is set to `open'. |
| 142 | It means that after search makes some invisible text visible |
| 143 | to show the match, it makes the text invisible again when the match moves. |
| 144 | Ordinarily the text becomes invisible again at the end of the search." |
| 145 | :type 'boolean |
| 146 | :group 'isearch) |
| 147 | |
| 148 | (defcustom isearch-resume-in-command-history nil |
| 149 | "If non-nil, `isearch-resume' commands are added to the command history. |
| 150 | This allows you to resume earlier Isearch sessions through the |
| 151 | command history." |
| 152 | :type 'boolean |
| 153 | :group 'isearch) |
| 154 | |
| 155 | (defvar isearch-mode-hook nil |
| 156 | "Function(s) to call after starting up an incremental search.") |
| 157 | |
| 158 | (defvar isearch-update-post-hook nil |
| 159 | "Function(s) to call after isearch has found matches in the buffer.") |
| 160 | |
| 161 | (defvar isearch-mode-end-hook nil |
| 162 | "Function(s) to call after terminating an incremental search. |
| 163 | When these functions are called, `isearch-mode-end-hook-quit' |
| 164 | is non-nil if the user quits the search.") |
| 165 | |
| 166 | (defvar isearch-mode-end-hook-quit nil |
| 167 | "Non-nil while running `isearch-mode-end-hook' if the user quits the search.") |
| 168 | |
| 169 | (defvar isearch-message-function nil |
| 170 | "Function to call to display the search prompt. |
| 171 | If nil, use `isearch-message'.") |
| 172 | |
| 173 | (defvar isearch-wrap-function nil |
| 174 | "Function to call to wrap the search when search is failed. |
| 175 | If nil, move point to the beginning of the buffer for a forward search, |
| 176 | or to the end of the buffer for a backward search.") |
| 177 | |
| 178 | (defvar isearch-push-state-function nil |
| 179 | "Function to save a function restoring the mode-specific Isearch state |
| 180 | to the search status stack.") |
| 181 | |
| 182 | (defvar isearch-filter-predicate 'isearch-filter-visible |
| 183 | "Predicate that filters the search hits that would normally be available. |
| 184 | Search hits that dissatisfy the predicate are skipped. The function |
| 185 | has two arguments: the positions of start and end of text matched by |
| 186 | the search. If this function returns nil, continue searching without |
| 187 | stopping at this match.") |
| 188 | |
| 189 | ;; Search ring. |
| 190 | |
| 191 | (defvar search-ring nil |
| 192 | "List of search string sequences.") |
| 193 | (defvar regexp-search-ring nil |
| 194 | "List of regular expression search string sequences.") |
| 195 | |
| 196 | (defcustom search-ring-max 16 |
| 197 | "Maximum length of search ring before oldest elements are thrown away." |
| 198 | :type 'integer |
| 199 | :group 'isearch) |
| 200 | (defcustom regexp-search-ring-max 16 |
| 201 | "Maximum length of regexp search ring before oldest elements are thrown away." |
| 202 | :type 'integer |
| 203 | :group 'isearch) |
| 204 | |
| 205 | (defvar search-ring-yank-pointer nil |
| 206 | "Index in `search-ring' of last string reused. |
| 207 | It is nil if none yet.") |
| 208 | (defvar regexp-search-ring-yank-pointer nil |
| 209 | "Index in `regexp-search-ring' of last string reused. |
| 210 | It is nil if none yet.") |
| 211 | |
| 212 | (defcustom search-ring-update nil |
| 213 | "Non-nil if advancing or retreating in the search ring should cause search. |
| 214 | Default value, nil, means edit the string instead." |
| 215 | :type 'boolean |
| 216 | :group 'isearch) |
| 217 | |
| 218 | ;;; isearch highlight customization. |
| 219 | |
| 220 | (defcustom search-highlight t |
| 221 | "Non-nil means incremental search highlights the current match." |
| 222 | :type 'boolean |
| 223 | :group 'isearch) |
| 224 | |
| 225 | (defface isearch |
| 226 | '((((class color) (min-colors 88) (background light)) |
| 227 | ;; The background must not be too dark, for that means |
| 228 | ;; the character is hard to see when the cursor is there. |
| 229 | (:background "magenta3" :foreground "lightskyblue1")) |
| 230 | (((class color) (min-colors 88) (background dark)) |
| 231 | (:background "palevioletred2" :foreground "brown4")) |
| 232 | (((class color) (min-colors 16)) |
| 233 | (:background "magenta4" :foreground "cyan1")) |
| 234 | (((class color) (min-colors 8)) |
| 235 | (:background "magenta4" :foreground "cyan1")) |
| 236 | (t (:inverse-video t))) |
| 237 | "Face for highlighting Isearch matches." |
| 238 | :group 'isearch |
| 239 | :group 'basic-faces) |
| 240 | (defvar isearch-face 'isearch) |
| 241 | |
| 242 | (defface isearch-fail |
| 243 | '((((class color) (min-colors 88) (background light)) |
| 244 | (:background "RosyBrown1")) |
| 245 | (((class color) (min-colors 88) (background dark)) |
| 246 | (:background "red4")) |
| 247 | (((class color) (min-colors 16)) |
| 248 | (:background "red")) |
| 249 | (((class color) (min-colors 8)) |
| 250 | (:background "red")) |
| 251 | (((class color grayscale)) |
| 252 | :foreground "grey") |
| 253 | (t (:inverse-video t))) |
| 254 | "Face for highlighting failed part in Isearch echo-area message." |
| 255 | :version "23.1" |
| 256 | :group 'isearch) |
| 257 | |
| 258 | (defcustom isearch-lazy-highlight t |
| 259 | "Controls the lazy-highlighting during incremental search. |
| 260 | When non-nil, all text in the buffer matching the current search |
| 261 | string is highlighted lazily (see `lazy-highlight-initial-delay' |
| 262 | and `lazy-highlight-interval')." |
| 263 | :type 'boolean |
| 264 | :group 'lazy-highlight |
| 265 | :group 'isearch) |
| 266 | |
| 267 | ;;; Lazy highlight customization. |
| 268 | |
| 269 | (defgroup lazy-highlight nil |
| 270 | "Lazy highlighting feature for matching strings." |
| 271 | :prefix "lazy-highlight-" |
| 272 | :version "21.1" |
| 273 | :group 'isearch |
| 274 | :group 'matching) |
| 275 | |
| 276 | (define-obsolete-variable-alias 'isearch-lazy-highlight-cleanup |
| 277 | 'lazy-highlight-cleanup |
| 278 | "22.1") |
| 279 | |
| 280 | (defcustom lazy-highlight-cleanup t |
| 281 | "Controls whether to remove extra highlighting after a search. |
| 282 | If this is nil, extra highlighting can be \"manually\" removed with |
| 283 | \\[lazy-highlight-cleanup]." |
| 284 | :type 'boolean |
| 285 | :group 'lazy-highlight) |
| 286 | |
| 287 | (define-obsolete-variable-alias 'isearch-lazy-highlight-initial-delay |
| 288 | 'lazy-highlight-initial-delay |
| 289 | "22.1") |
| 290 | |
| 291 | (defcustom lazy-highlight-initial-delay 0.25 |
| 292 | "Seconds to wait before beginning to lazily highlight all matches." |
| 293 | :type 'number |
| 294 | :group 'lazy-highlight) |
| 295 | |
| 296 | (define-obsolete-variable-alias 'isearch-lazy-highlight-interval |
| 297 | 'lazy-highlight-interval |
| 298 | "22.1") |
| 299 | |
| 300 | (defcustom lazy-highlight-interval 0 ; 0.0625 |
| 301 | "Seconds between lazily highlighting successive matches." |
| 302 | :type 'number |
| 303 | :group 'lazy-highlight) |
| 304 | |
| 305 | (define-obsolete-variable-alias 'isearch-lazy-highlight-max-at-a-time |
| 306 | 'lazy-highlight-max-at-a-time |
| 307 | "22.1") |
| 308 | |
| 309 | (defcustom lazy-highlight-max-at-a-time 20 |
| 310 | "Maximum matches to highlight at a time (for `lazy-highlight'). |
| 311 | Larger values may reduce Isearch's responsiveness to user input; |
| 312 | smaller values make matches highlight slowly. |
| 313 | A value of nil means highlight all matches." |
| 314 | :type '(choice (const :tag "All" nil) |
| 315 | (integer :tag "Some")) |
| 316 | :group 'lazy-highlight) |
| 317 | |
| 318 | (defface lazy-highlight |
| 319 | '((((class color) (min-colors 88) (background light)) |
| 320 | (:background "paleturquoise")) |
| 321 | (((class color) (min-colors 88) (background dark)) |
| 322 | (:background "paleturquoise4")) |
| 323 | (((class color) (min-colors 16)) |
| 324 | (:background "turquoise3")) |
| 325 | (((class color) (min-colors 8)) |
| 326 | (:background "turquoise3")) |
| 327 | (t (:underline t))) |
| 328 | "Face for lazy highlighting of matches other than the current one." |
| 329 | :group 'lazy-highlight |
| 330 | :group 'basic-faces) |
| 331 | (define-obsolete-face-alias 'isearch-lazy-highlight-face 'lazy-highlight "22.1") |
| 332 | (define-obsolete-variable-alias 'isearch-lazy-highlight-face |
| 333 | 'lazy-highlight-face |
| 334 | "22.1") |
| 335 | (defvar lazy-highlight-face 'lazy-highlight) |
| 336 | \f |
| 337 | ;; Define isearch help map. |
| 338 | |
| 339 | (defvar isearch-help-map |
| 340 | (let ((map (make-sparse-keymap))) |
| 341 | (define-key map [t] 'isearch-other-control-char) |
| 342 | (define-key map (char-to-string help-char) 'isearch-help-for-help) |
| 343 | (define-key map [help] 'isearch-help-for-help) |
| 344 | (define-key map [f1] 'isearch-help-for-help) |
| 345 | (define-key map "?" 'isearch-help-for-help) |
| 346 | (define-key map "b" 'isearch-describe-bindings) |
| 347 | (define-key map "k" 'isearch-describe-key) |
| 348 | (define-key map "m" 'isearch-describe-mode) |
| 349 | (define-key map "q" 'help-quit) |
| 350 | map) |
| 351 | "Keymap for characters following the Help key for Isearch mode.") |
| 352 | |
| 353 | (eval-when-compile (require 'help-macro)) |
| 354 | |
| 355 | (make-help-screen isearch-help-for-help-internal |
| 356 | (purecopy "Type a help option: [bkm] or ?") |
| 357 | "You have typed %THIS-KEY%, the help character. Type a Help option: |
| 358 | \(Type \\<help-map>\\[help-quit] to exit the Help command.) |
| 359 | |
| 360 | b Display all Isearch key bindings. |
| 361 | k KEYS Display full documentation of Isearch key sequence. |
| 362 | m Display documentation of Isearch mode. |
| 363 | |
| 364 | You can't type here other help keys available in the global help map, |
| 365 | but outside of this help window when you type them in Isearch mode, |
| 366 | they exit Isearch mode before displaying global help." |
| 367 | isearch-help-map) |
| 368 | |
| 369 | (defun isearch-help-for-help () |
| 370 | "Display Isearch help menu." |
| 371 | (interactive) |
| 372 | (let (same-window-buffer-names same-window-regexps) |
| 373 | (isearch-help-for-help-internal)) |
| 374 | (isearch-update)) |
| 375 | |
| 376 | (defun isearch-describe-bindings () |
| 377 | "Show a list of all keys defined in Isearch mode, and their definitions. |
| 378 | This is like `describe-bindings', but displays only Isearch keys." |
| 379 | (interactive) |
| 380 | (let (same-window-buffer-names same-window-regexps) |
| 381 | (with-help-window "*Help*" |
| 382 | (with-current-buffer standard-output |
| 383 | (princ "Isearch Mode Bindings:\n") |
| 384 | (princ (substitute-command-keys "\\{isearch-mode-map}")))))) |
| 385 | |
| 386 | (defun isearch-describe-key () |
| 387 | "Display documentation of the function invoked by isearch key." |
| 388 | (interactive) |
| 389 | (let (same-window-buffer-names same-window-regexps) |
| 390 | (call-interactively 'describe-key)) |
| 391 | (isearch-update)) |
| 392 | |
| 393 | (defun isearch-describe-mode () |
| 394 | "Display documentation of Isearch mode." |
| 395 | (interactive) |
| 396 | (let (same-window-buffer-names same-window-regexps) |
| 397 | (describe-function 'isearch-forward)) |
| 398 | (isearch-update)) |
| 399 | |
| 400 | (defalias 'isearch-mode-help 'isearch-describe-mode) |
| 401 | |
| 402 | \f |
| 403 | ;; Define isearch-mode keymap. |
| 404 | |
| 405 | (defvar isearch-mode-map |
| 406 | (let ((i 0) |
| 407 | (map (make-keymap))) |
| 408 | (or (char-table-p (nth 1 map)) |
| 409 | (error "The initialization of isearch-mode-map must be updated")) |
| 410 | ;; Make all multibyte characters search for themselves. |
| 411 | (set-char-table-range (nth 1 map) (cons #x100 (max-char)) |
| 412 | 'isearch-printing-char) |
| 413 | ;; Make function keys, etc, which aren't bound to a scrolling-function |
| 414 | ;; exit the search. |
| 415 | (define-key map [t] 'isearch-other-control-char) |
| 416 | ;; Control chars, by default, end isearch mode transparently. |
| 417 | ;; We need these explicit definitions because, in a dense keymap, |
| 418 | ;; the binding for t does not affect characters. |
| 419 | ;; We use a dense keymap to save space. |
| 420 | (while (< i ?\s) |
| 421 | (define-key map (make-string 1 i) 'isearch-other-control-char) |
| 422 | (setq i (1+ i))) |
| 423 | |
| 424 | ;; Single-byte printing chars extend the search string by default. |
| 425 | (setq i ?\s) |
| 426 | (while (< i 256) |
| 427 | (define-key map (vector i) 'isearch-printing-char) |
| 428 | (setq i (1+ i))) |
| 429 | |
| 430 | ;; To handle local bindings with meta char prefix keys, define |
| 431 | ;; another full keymap. This must be done for any other prefix |
| 432 | ;; keys as well, one full keymap per char of the prefix key. It |
| 433 | ;; would be simpler to disable the global keymap, and/or have a |
| 434 | ;; default local key binding for any key not otherwise bound. |
| 435 | (let ((meta-map (make-sparse-keymap))) |
| 436 | (define-key map (char-to-string meta-prefix-char) meta-map) |
| 437 | (define-key map [escape] meta-map)) |
| 438 | (define-key map (vector meta-prefix-char t) 'isearch-other-meta-char) |
| 439 | |
| 440 | ;; Several non-printing chars change the searching behavior. |
| 441 | (define-key map "\C-s" 'isearch-repeat-forward) |
| 442 | (define-key map "\C-r" 'isearch-repeat-backward) |
| 443 | ;; Define M-C-s and M-C-r like C-s and C-r so that the same key |
| 444 | ;; combinations can be used to repeat regexp isearches that can |
| 445 | ;; be used to start these searches. |
| 446 | (define-key map "\M-\C-s" 'isearch-repeat-forward) |
| 447 | (define-key map "\M-\C-r" 'isearch-repeat-backward) |
| 448 | (define-key map "\177" 'isearch-delete-char) |
| 449 | (define-key map "\C-g" 'isearch-abort) |
| 450 | |
| 451 | ;; This assumes \e is the meta-prefix-char. |
| 452 | (or (= ?\e meta-prefix-char) |
| 453 | (error "Inconsistency in isearch.el")) |
| 454 | (define-key map "\e\e\e" 'isearch-cancel) |
| 455 | (define-key map [escape escape escape] 'isearch-cancel) |
| 456 | |
| 457 | (define-key map "\C-q" 'isearch-quote-char) |
| 458 | |
| 459 | (define-key map "\r" 'isearch-exit) |
| 460 | (define-key map "\C-j" 'isearch-printing-char) |
| 461 | (define-key map "\t" 'isearch-printing-char) |
| 462 | (define-key map [?\S-\ ] 'isearch-printing-char) |
| 463 | |
| 464 | (define-key map "\C-w" 'isearch-yank-word-or-char) |
| 465 | (define-key map "\M-\C-w" 'isearch-del-char) |
| 466 | (define-key map "\M-\C-y" 'isearch-yank-char) |
| 467 | (define-key map "\C-y" 'isearch-yank-kill) |
| 468 | (define-key map "\M-s\C-e" 'isearch-yank-line) |
| 469 | |
| 470 | (define-key map (char-to-string help-char) isearch-help-map) |
| 471 | (define-key map [help] isearch-help-map) |
| 472 | (define-key map [f1] isearch-help-map) |
| 473 | |
| 474 | (define-key map "\M-n" 'isearch-ring-advance) |
| 475 | (define-key map "\M-p" 'isearch-ring-retreat) |
| 476 | (define-key map "\M-y" 'isearch-yank-pop) |
| 477 | |
| 478 | (define-key map "\M-\t" 'isearch-complete) |
| 479 | |
| 480 | ;; Pass frame events transparently so they won't exit the search. |
| 481 | ;; In particular, if we have more than one display open, then a |
| 482 | ;; switch-frame might be generated by someone typing at another keyboard. |
| 483 | (define-key map [switch-frame] nil) |
| 484 | (define-key map [delete-frame] nil) |
| 485 | (define-key map [iconify-frame] nil) |
| 486 | (define-key map [make-frame-visible] nil) |
| 487 | (define-key map [mouse-movement] nil) |
| 488 | (define-key map [language-change] nil) |
| 489 | |
| 490 | ;; For searching multilingual text. |
| 491 | (define-key map "\C-\\" 'isearch-toggle-input-method) |
| 492 | (define-key map "\C-^" 'isearch-toggle-specified-input-method) |
| 493 | |
| 494 | ;; People expect to be able to paste with the mouse. |
| 495 | (define-key map [mouse-2] #'isearch-mouse-2) |
| 496 | (define-key map [down-mouse-2] nil) |
| 497 | |
| 498 | ;; Some bindings you may want to put in your isearch-mode-hook. |
| 499 | ;; Suggest some alternates... |
| 500 | (define-key map "\M-c" 'isearch-toggle-case-fold) |
| 501 | (define-key map "\M-r" 'isearch-toggle-regexp) |
| 502 | (define-key map "\M-e" 'isearch-edit-string) |
| 503 | |
| 504 | (define-key map "\M-sr" 'isearch-toggle-regexp) |
| 505 | (define-key map "\M-sw" 'isearch-toggle-word) |
| 506 | |
| 507 | (define-key map [?\M-%] 'isearch-query-replace) |
| 508 | (define-key map [?\C-\M-%] 'isearch-query-replace-regexp) |
| 509 | (define-key map "\M-so" 'isearch-occur) |
| 510 | (define-key map "\M-shr" 'isearch-highlight-regexp) |
| 511 | |
| 512 | map) |
| 513 | "Keymap for `isearch-mode'.") |
| 514 | |
| 515 | (defvar minibuffer-local-isearch-map |
| 516 | (let ((map (make-sparse-keymap))) |
| 517 | (set-keymap-parent map minibuffer-local-map) |
| 518 | (define-key map "\r" 'isearch-nonincremental-exit-minibuffer) |
| 519 | (define-key map "\M-\t" 'isearch-complete-edit) |
| 520 | (define-key map "\C-s" 'isearch-forward-exit-minibuffer) |
| 521 | (define-key map "\C-r" 'isearch-reverse-exit-minibuffer) |
| 522 | (define-key map "\C-f" 'isearch-yank-char-in-minibuffer) |
| 523 | (define-key map [right] 'isearch-yank-char-in-minibuffer) |
| 524 | map) |
| 525 | "Keymap for editing Isearch strings in the minibuffer.") |
| 526 | |
| 527 | ;; Internal variables declared globally for byte-compiler. |
| 528 | ;; These are all set with setq while isearching |
| 529 | ;; and bound locally while editing the search string. |
| 530 | |
| 531 | (defvar isearch-forward nil) ; Searching in the forward direction. |
| 532 | (defvar isearch-regexp nil) ; Searching for a regexp. |
| 533 | (defvar isearch-word nil) ; Searching for words. |
| 534 | (defvar isearch-hidden nil) ; Non-nil if the string exists but is invisible. |
| 535 | |
| 536 | (defvar isearch-cmds nil |
| 537 | "Stack of search status sets. |
| 538 | Each set is a vector of the form: |
| 539 | [STRING MESSAGE POINT SUCCESS FORWARD OTHER-END WORD |
| 540 | INVALID-REGEXP WRAPPED BARRIER WITHIN-BRACKETS CASE-FOLD-SEARCH]") |
| 541 | |
| 542 | (defvar isearch-string "") ; The current search string. |
| 543 | (defvar isearch-message "") ; text-char-description version of isearch-string |
| 544 | |
| 545 | (defvar isearch-message-prefix-add nil) ; Additonal text for the message prefix |
| 546 | (defvar isearch-message-suffix-add nil) ; Additonal text for the message suffix |
| 547 | |
| 548 | (defvar isearch-success t) ; Searching is currently successful. |
| 549 | (defvar isearch-error nil) ; Error message for failed search. |
| 550 | (defvar isearch-other-end nil) ; Start (end) of match if forward (backward). |
| 551 | (defvar isearch-wrapped nil) ; Searching restarted from the top (bottom). |
| 552 | (defvar isearch-barrier 0) |
| 553 | (defvar isearch-just-started nil) |
| 554 | (defvar isearch-start-hscroll 0) ; hscroll when starting the search. |
| 555 | |
| 556 | ;; case-fold-search while searching. |
| 557 | ;; either nil, t, or 'yes. 'yes means the same as t except that mixed |
| 558 | ;; case in the search string is ignored. |
| 559 | (defvar isearch-case-fold-search nil) |
| 560 | |
| 561 | (defvar isearch-last-case-fold-search nil) |
| 562 | |
| 563 | ;; Used to save default value while isearch is active |
| 564 | (defvar isearch-original-minibuffer-message-timeout nil) |
| 565 | |
| 566 | (defvar isearch-adjusted nil) |
| 567 | (defvar isearch-slow-terminal-mode nil) |
| 568 | ;; If t, using a small window. |
| 569 | (defvar isearch-small-window nil) |
| 570 | (defvar isearch-opoint 0) |
| 571 | ;; The window configuration active at the beginning of the search. |
| 572 | (defvar isearch-window-configuration nil) |
| 573 | |
| 574 | ;; Flag to indicate a yank occurred, so don't move the cursor. |
| 575 | (defvar isearch-yank-flag nil) |
| 576 | |
| 577 | ;; A function to be called after each input character is processed. |
| 578 | ;; (It is not called after characters that exit the search.) |
| 579 | ;; It is only set from an optional argument to `isearch-mode'. |
| 580 | (defvar isearch-op-fun nil) |
| 581 | |
| 582 | ;; Is isearch-mode in a recursive edit for modal searching. |
| 583 | (defvar isearch-recursive-edit nil) |
| 584 | |
| 585 | ;; Should isearch be terminated after doing one search? |
| 586 | (defvar isearch-nonincremental nil) |
| 587 | |
| 588 | ;; New value of isearch-forward after isearch-edit-string. |
| 589 | (defvar isearch-new-forward nil) |
| 590 | |
| 591 | ;; Accumulate here the overlays opened during searching. |
| 592 | (defvar isearch-opened-overlays nil) |
| 593 | |
| 594 | ;; The value of input-method-function when isearch is invoked. |
| 595 | (defvar isearch-input-method-function nil) |
| 596 | |
| 597 | ;; A flag to tell if input-method-function is locally bound when |
| 598 | ;; isearch is invoked. |
| 599 | (defvar isearch-input-method-local-p nil) |
| 600 | |
| 601 | ;; Minor-mode-alist changes - kind of redundant with the |
| 602 | ;; echo area, but if isearching in multiple windows, it can be useful. |
| 603 | |
| 604 | (or (assq 'isearch-mode minor-mode-alist) |
| 605 | (nconc minor-mode-alist |
| 606 | (list '(isearch-mode isearch-mode)))) |
| 607 | |
| 608 | (defvar isearch-mode nil) ;; Name of the minor mode, if non-nil. |
| 609 | (make-variable-buffer-local 'isearch-mode) |
| 610 | |
| 611 | (define-key global-map "\C-s" 'isearch-forward) |
| 612 | (define-key esc-map "\C-s" 'isearch-forward-regexp) |
| 613 | (define-key global-map "\C-r" 'isearch-backward) |
| 614 | (define-key esc-map "\C-r" 'isearch-backward-regexp) |
| 615 | (define-key search-map "w" 'isearch-forward-word) |
| 616 | |
| 617 | ;; Entry points to isearch-mode. |
| 618 | |
| 619 | (defun isearch-forward (&optional regexp-p no-recursive-edit) |
| 620 | "\ |
| 621 | Do incremental search forward. |
| 622 | With a prefix argument, do an incremental regular expression search instead. |
| 623 | \\<isearch-mode-map> |
| 624 | As you type characters, they add to the search string and are found. |
| 625 | The following non-printing keys are bound in `isearch-mode-map'. |
| 626 | |
| 627 | Type \\[isearch-delete-char] to cancel last input item from end of search string. |
| 628 | Type \\[isearch-exit] to exit, leaving point at location found. |
| 629 | Type LFD (C-j) to match end of line. |
| 630 | Type \\[isearch-repeat-forward] to search again forward,\ |
| 631 | \\[isearch-repeat-backward] to search again backward. |
| 632 | Type \\[isearch-yank-word-or-char] to yank next word or character in buffer |
| 633 | onto the end of the search string, and search for it. |
| 634 | Type \\[isearch-del-char] to delete character from end of search string. |
| 635 | Type \\[isearch-yank-char] to yank char from buffer onto end of search\ |
| 636 | string and search for it. |
| 637 | Type \\[isearch-yank-line] to yank rest of line onto end of search string\ |
| 638 | and search for it. |
| 639 | Type \\[isearch-yank-kill] to yank the last string of killed text. |
| 640 | Type \\[isearch-yank-pop] to replace string just yanked into search prompt |
| 641 | with string killed before it. |
| 642 | Type \\[isearch-quote-char] to quote control character to search for it. |
| 643 | \\[isearch-abort] while searching or when search has failed cancels input\ |
| 644 | back to what has |
| 645 | been found successfully. |
| 646 | \\[isearch-abort] when search is successful aborts and moves point to\ |
| 647 | starting point. |
| 648 | |
| 649 | If you try to exit with the search string still empty, it invokes |
| 650 | nonincremental search. |
| 651 | |
| 652 | Type \\[isearch-toggle-case-fold] to toggle search case-sensitivity. |
| 653 | Type \\[isearch-toggle-regexp] to toggle regular-expression mode. |
| 654 | Type \\[isearch-toggle-word] to toggle word mode. |
| 655 | Type \\[isearch-edit-string] to edit the search string in the minibuffer. |
| 656 | |
| 657 | Also supported is a search ring of the previous 16 search strings. |
| 658 | Type \\[isearch-ring-advance] to search for the next item in the search ring. |
| 659 | Type \\[isearch-ring-retreat] to search for the previous item in the search\ |
| 660 | ring. |
| 661 | Type \\[isearch-complete] to complete the search string using the search ring. |
| 662 | |
| 663 | Type \\[isearch-query-replace] to run `query-replace' with string to\ |
| 664 | replace from last search string. |
| 665 | Type \\[isearch-query-replace-regexp] to run `query-replace-regexp'\ |
| 666 | with the last search string. |
| 667 | Type \\[isearch-occur] to run `occur' that shows\ |
| 668 | the last search string. |
| 669 | Type \\[isearch-highlight-regexp] to run `highlight-regexp'\ |
| 670 | that highlights the last search string. |
| 671 | |
| 672 | Type \\[isearch-describe-bindings] to display all Isearch key bindings. |
| 673 | Type \\[isearch-describe-key] to display documentation of Isearch key. |
| 674 | Type \\[isearch-describe-mode] to display documentation of Isearch mode. |
| 675 | |
| 676 | If an input method is turned on in the current buffer, that input |
| 677 | method is also active while you are typing characters to search. |
| 678 | To toggle the input method, type \\[isearch-toggle-input-method]. \ |
| 679 | It also toggles the input |
| 680 | method in the current buffer. |
| 681 | |
| 682 | To use a different input method for searching, type \ |
| 683 | \\[isearch-toggle-specified-input-method], |
| 684 | and specify an input method you want to use. |
| 685 | |
| 686 | The above keys, bound in `isearch-mode-map', are often controlled by |
| 687 | options; do \\[apropos] on search-.* to find them. |
| 688 | Other control and meta characters terminate the search |
| 689 | and are then executed normally (depending on `search-exit-option'). |
| 690 | Likewise for function keys and mouse button events. |
| 691 | |
| 692 | If this function is called non-interactively, it does not return to |
| 693 | the calling function until the search is done." |
| 694 | |
| 695 | (interactive "P\np") |
| 696 | (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit))) |
| 697 | |
| 698 | (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit) |
| 699 | "\ |
| 700 | Do incremental search forward for regular expression. |
| 701 | With a prefix argument, do a regular string search instead. |
| 702 | Like ordinary incremental search except that your input is treated |
| 703 | as a regexp. See the command `isearch-forward' for more information. |
| 704 | |
| 705 | In regexp incremental searches, a space or spaces normally matches |
| 706 | any whitespace (the variable `search-whitespace-regexp' controls |
| 707 | precisely what that means). If you want to search for a literal space |
| 708 | and nothing else, enter C-q SPC." |
| 709 | (interactive "P\np") |
| 710 | (isearch-mode t (null not-regexp) nil (not no-recursive-edit))) |
| 711 | |
| 712 | (defun isearch-forward-word (&optional not-word no-recursive-edit) |
| 713 | "\ |
| 714 | Do incremental search forward for a sequence of words. |
| 715 | With a prefix argument, do a regular string search instead. |
| 716 | Like ordinary incremental search except that your input is treated |
| 717 | as a sequence of words without regard to how the words are separated. |
| 718 | See the command `isearch-forward' for more information." |
| 719 | (interactive "P\np") |
| 720 | (isearch-mode t nil nil (not no-recursive-edit) (null not-word))) |
| 721 | |
| 722 | (defun isearch-backward (&optional regexp-p no-recursive-edit) |
| 723 | "\ |
| 724 | Do incremental search backward. |
| 725 | With a prefix argument, do a regular expression search instead. |
| 726 | See the command `isearch-forward' for more information." |
| 727 | (interactive "P\np") |
| 728 | (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit))) |
| 729 | |
| 730 | (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit) |
| 731 | "\ |
| 732 | Do incremental search backward for regular expression. |
| 733 | With a prefix argument, do a regular string search instead. |
| 734 | Like ordinary incremental search except that your input is treated |
| 735 | as a regexp. See the command `isearch-forward' for more information." |
| 736 | (interactive "P\np") |
| 737 | (isearch-mode nil (null not-regexp) nil (not no-recursive-edit))) |
| 738 | |
| 739 | \f |
| 740 | ;; isearch-mode only sets up incremental search for the minor mode. |
| 741 | ;; All the work is done by the isearch-mode commands. |
| 742 | |
| 743 | ;; Not used yet: |
| 744 | ;;(defvar isearch-commands '(isearch-forward isearch-backward |
| 745 | ;; isearch-forward-regexp isearch-backward-regexp) |
| 746 | ;; "List of commands for which isearch-mode does not recursive-edit.") |
| 747 | |
| 748 | |
| 749 | (defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p) |
| 750 | "Start Isearch minor mode. |
| 751 | It is called by the function `isearch-forward' and other related functions." |
| 752 | |
| 753 | ;; Initialize global vars. |
| 754 | (setq isearch-forward forward |
| 755 | isearch-regexp regexp |
| 756 | isearch-word word-p |
| 757 | isearch-op-fun op-fun |
| 758 | isearch-last-case-fold-search isearch-case-fold-search |
| 759 | isearch-case-fold-search case-fold-search |
| 760 | isearch-string "" |
| 761 | isearch-message "" |
| 762 | isearch-cmds nil |
| 763 | isearch-success t |
| 764 | isearch-wrapped nil |
| 765 | isearch-barrier (point) |
| 766 | isearch-adjusted nil |
| 767 | isearch-yank-flag nil |
| 768 | isearch-error nil |
| 769 | isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed) |
| 770 | (> (window-height) |
| 771 | (* 4 |
| 772 | (abs search-slow-window-lines)))) |
| 773 | isearch-other-end nil |
| 774 | isearch-small-window nil |
| 775 | isearch-just-started t |
| 776 | isearch-start-hscroll (window-hscroll) |
| 777 | |
| 778 | isearch-opoint (point) |
| 779 | search-ring-yank-pointer nil |
| 780 | isearch-opened-overlays nil |
| 781 | isearch-input-method-function input-method-function |
| 782 | isearch-input-method-local-p (local-variable-p 'input-method-function) |
| 783 | regexp-search-ring-yank-pointer nil |
| 784 | |
| 785 | ;; Save the original value of `minibuffer-message-timeout', and |
| 786 | ;; set it to nil so that isearch's messages don't get timed out. |
| 787 | isearch-original-minibuffer-message-timeout minibuffer-message-timeout |
| 788 | minibuffer-message-timeout nil) |
| 789 | |
| 790 | ;; We must bypass input method while reading key. When a user type |
| 791 | ;; printable character, appropriate input method is turned on in |
| 792 | ;; minibuffer to read multibyte characters. |
| 793 | (or isearch-input-method-local-p |
| 794 | (make-local-variable 'input-method-function)) |
| 795 | (setq input-method-function nil) |
| 796 | |
| 797 | (looking-at "") |
| 798 | (setq isearch-window-configuration |
| 799 | (if isearch-slow-terminal-mode (current-window-configuration) nil)) |
| 800 | |
| 801 | ;; Maybe make minibuffer frame visible and/or raise it. |
| 802 | (let ((frame (window-frame (minibuffer-window)))) |
| 803 | (unless (memq (frame-live-p frame) '(nil t)) |
| 804 | (unless (frame-visible-p frame) |
| 805 | (make-frame-visible frame)) |
| 806 | (if minibuffer-auto-raise |
| 807 | (raise-frame frame)))) |
| 808 | |
| 809 | (setq isearch-mode " Isearch") ;; forward? regexp? |
| 810 | (force-mode-line-update) |
| 811 | |
| 812 | (setq overriding-terminal-local-map isearch-mode-map) |
| 813 | (run-hooks 'isearch-mode-hook) |
| 814 | |
| 815 | ;; Pushing the initial state used to be before running isearch-mode-hook, |
| 816 | ;; but a hook might set `isearch-push-state-function' used in |
| 817 | ;; `isearch-push-state' to save mode-specific initial state. (Bug#4994) |
| 818 | (isearch-push-state) |
| 819 | |
| 820 | (isearch-update) |
| 821 | |
| 822 | (add-hook 'mouse-leave-buffer-hook 'isearch-done) |
| 823 | (add-hook 'kbd-macro-termination-hook 'isearch-done) |
| 824 | |
| 825 | ;; isearch-mode can be made modal (in the sense of not returning to |
| 826 | ;; the calling function until searching is completed) by entering |
| 827 | ;; a recursive-edit and exiting it when done isearching. |
| 828 | (if recursive-edit |
| 829 | (let ((isearch-recursive-edit t)) |
| 830 | (recursive-edit))) |
| 831 | isearch-success) |
| 832 | |
| 833 | |
| 834 | ;; Some high level utilities. Others below. |
| 835 | |
| 836 | (defun isearch-update () |
| 837 | ;; Called after each command to update the display. |
| 838 | (if (and (null unread-command-events) |
| 839 | (null executing-kbd-macro)) |
| 840 | (progn |
| 841 | (if (not (input-pending-p)) |
| 842 | (if isearch-message-function |
| 843 | (funcall isearch-message-function) |
| 844 | (isearch-message))) |
| 845 | (if (and isearch-slow-terminal-mode |
| 846 | (not (or isearch-small-window |
| 847 | (pos-visible-in-window-p)))) |
| 848 | (let ((found-point (point))) |
| 849 | (setq isearch-small-window t) |
| 850 | (move-to-window-line 0) |
| 851 | (let ((window-min-height 1)) |
| 852 | (split-window nil (if (< search-slow-window-lines 0) |
| 853 | (1+ (- search-slow-window-lines)) |
| 854 | (- (window-height) |
| 855 | (1+ search-slow-window-lines))))) |
| 856 | (if (< search-slow-window-lines 0) |
| 857 | (progn (vertical-motion (- 1 search-slow-window-lines)) |
| 858 | (set-window-start (next-window) (point)) |
| 859 | (set-window-hscroll (next-window) |
| 860 | (window-hscroll)) |
| 861 | (set-window-hscroll (selected-window) 0)) |
| 862 | (other-window 1)) |
| 863 | (goto-char found-point)) |
| 864 | ;; Keep same hscrolling as at the start of the search when possible |
| 865 | (let ((current-scroll (window-hscroll))) |
| 866 | (set-window-hscroll (selected-window) isearch-start-hscroll) |
| 867 | (unless (pos-visible-in-window-p) |
| 868 | (set-window-hscroll (selected-window) current-scroll)))) |
| 869 | (if isearch-other-end |
| 870 | (if (< isearch-other-end (point)) ; isearch-forward? |
| 871 | (isearch-highlight isearch-other-end (point)) |
| 872 | (isearch-highlight (point) isearch-other-end)) |
| 873 | (isearch-dehighlight)) |
| 874 | )) |
| 875 | (setq ;; quit-flag nil not for isearch-mode |
| 876 | isearch-adjusted nil |
| 877 | isearch-yank-flag nil) |
| 878 | (when isearch-lazy-highlight |
| 879 | (isearch-lazy-highlight-new-loop)) |
| 880 | ;; We must prevent the point moving to the end of composition when a |
| 881 | ;; part of the composition has just been searched. |
| 882 | (setq disable-point-adjustment t) |
| 883 | (run-hooks 'isearch-update-post-hook)) |
| 884 | |
| 885 | (defun isearch-done (&optional nopush edit) |
| 886 | "Exit Isearch mode. |
| 887 | For successful search, pass no args. |
| 888 | For a failing search, NOPUSH is t. |
| 889 | For going to the minibuffer to edit the search string, |
| 890 | NOPUSH is t and EDIT is t." |
| 891 | |
| 892 | (if isearch-resume-in-command-history |
| 893 | (let ((command `(isearch-resume ,isearch-string ,isearch-regexp |
| 894 | ,isearch-word ,isearch-forward |
| 895 | ,isearch-message |
| 896 | ',isearch-case-fold-search))) |
| 897 | (unless (equal (car command-history) command) |
| 898 | (setq command-history (cons command command-history))))) |
| 899 | |
| 900 | (remove-hook 'mouse-leave-buffer-hook 'isearch-done) |
| 901 | (remove-hook 'kbd-macro-termination-hook 'isearch-done) |
| 902 | (setq isearch-lazy-highlight-start nil) |
| 903 | |
| 904 | ;; Called by all commands that terminate isearch-mode. |
| 905 | ;; If NOPUSH is non-nil, we don't push the string on the search ring. |
| 906 | (setq overriding-terminal-local-map nil) |
| 907 | ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs |
| 908 | (setq minibuffer-message-timeout isearch-original-minibuffer-message-timeout) |
| 909 | (isearch-dehighlight) |
| 910 | (lazy-highlight-cleanup lazy-highlight-cleanup) |
| 911 | (let ((found-start (window-start (selected-window))) |
| 912 | (found-point (point))) |
| 913 | (when isearch-window-configuration |
| 914 | (set-window-configuration isearch-window-configuration) |
| 915 | (if isearch-small-window |
| 916 | (goto-char found-point) |
| 917 | ;; set-window-configuration clobbers window-start; restore it. |
| 918 | ;; This has an annoying side effect of clearing the last_modiff |
| 919 | ;; field of the window, which can cause unwanted scrolling, |
| 920 | ;; so don't do it unless truly necessary. |
| 921 | (set-window-start (selected-window) found-start t)))) |
| 922 | |
| 923 | (setq isearch-mode nil) |
| 924 | (if isearch-input-method-local-p |
| 925 | (setq input-method-function isearch-input-method-function) |
| 926 | (kill-local-variable 'input-method-function)) |
| 927 | |
| 928 | (force-mode-line-update) |
| 929 | |
| 930 | ;; If we ended in the middle of some intangible text, |
| 931 | ;; move to the further end of that intangible text. |
| 932 | (let ((after (if (eobp) nil |
| 933 | (get-text-property (point) 'intangible))) |
| 934 | (before (if (bobp) nil |
| 935 | (get-text-property (1- (point)) 'intangible)))) |
| 936 | (when (and before after (eq before after)) |
| 937 | (if isearch-forward |
| 938 | (goto-char (next-single-property-change (point) 'intangible)) |
| 939 | (goto-char (previous-single-property-change (point) 'intangible))))) |
| 940 | |
| 941 | (if (and (> (length isearch-string) 0) (not nopush)) |
| 942 | ;; Update the ring data. |
| 943 | (isearch-update-ring isearch-string isearch-regexp)) |
| 944 | |
| 945 | (let ((isearch-mode-end-hook-quit (and nopush (not edit)))) |
| 946 | (run-hooks 'isearch-mode-end-hook)) |
| 947 | |
| 948 | ;; If there was movement, mark the starting position. |
| 949 | ;; Maybe should test difference between and set mark only if > threshold. |
| 950 | (if (/= (point) isearch-opoint) |
| 951 | (or (and transient-mark-mode mark-active) |
| 952 | (progn |
| 953 | (push-mark isearch-opoint t) |
| 954 | (or executing-kbd-macro (> (minibuffer-depth) 0) |
| 955 | (message "Mark saved where search started"))))) |
| 956 | |
| 957 | (and (not edit) isearch-recursive-edit (exit-recursive-edit))) |
| 958 | |
| 959 | (defun isearch-update-ring (string &optional regexp) |
| 960 | "Add STRING to the beginning of the search ring. |
| 961 | REGEXP if non-nil says use the regexp search ring." |
| 962 | (add-to-history |
| 963 | (if regexp 'regexp-search-ring 'search-ring) |
| 964 | string |
| 965 | (if regexp regexp-search-ring-max search-ring-max))) |
| 966 | |
| 967 | ;; Switching buffers should first terminate isearch-mode. |
| 968 | ;; ;; For Emacs 19, the frame switch event is handled. |
| 969 | ;; (defun isearch-switch-frame-handler () |
| 970 | ;; (interactive) ;; Is this necessary? |
| 971 | ;; ;; First terminate isearch-mode. |
| 972 | ;; (isearch-done) |
| 973 | ;; (isearch-clean-overlays) |
| 974 | ;; (handle-switch-frame (car (cdr last-command-event)))) |
| 975 | |
| 976 | \f |
| 977 | ;; The search status structure and stack. |
| 978 | |
| 979 | (defsubst isearch-string-state (frame) |
| 980 | "Return the search string in FRAME." |
| 981 | (aref frame 0)) |
| 982 | (defsubst isearch-message-state (frame) |
| 983 | "Return the search string to display to the user in FRAME." |
| 984 | (aref frame 1)) |
| 985 | (defsubst isearch-point-state (frame) |
| 986 | "Return the point in FRAME." |
| 987 | (aref frame 2)) |
| 988 | (defsubst isearch-success-state (frame) |
| 989 | "Return the success flag in FRAME." |
| 990 | (aref frame 3)) |
| 991 | (defsubst isearch-forward-state (frame) |
| 992 | "Return the searching-forward flag in FRAME." |
| 993 | (aref frame 4)) |
| 994 | (defsubst isearch-other-end-state (frame) |
| 995 | "Return the other end of the match in FRAME." |
| 996 | (aref frame 5)) |
| 997 | (defsubst isearch-word-state (frame) |
| 998 | "Return the search-by-word flag in FRAME." |
| 999 | (aref frame 6)) |
| 1000 | (defsubst isearch-error-state (frame) |
| 1001 | "Return the regexp error message in FRAME, or nil if its regexp is valid." |
| 1002 | (aref frame 7)) |
| 1003 | (defsubst isearch-wrapped-state (frame) |
| 1004 | "Return the search-wrapped flag in FRAME." |
| 1005 | (aref frame 8)) |
| 1006 | (defsubst isearch-barrier-state (frame) |
| 1007 | "Return the barrier value in FRAME." |
| 1008 | (aref frame 9)) |
| 1009 | (defsubst isearch-case-fold-search-state (frame) |
| 1010 | "Return the case-folding flag in FRAME." |
| 1011 | (aref frame 10)) |
| 1012 | (defsubst isearch-pop-fun-state (frame) |
| 1013 | "Return the function restoring the mode-specific Isearch state in FRAME." |
| 1014 | (aref frame 11)) |
| 1015 | |
| 1016 | (defun isearch-top-state () |
| 1017 | (let ((cmd (car isearch-cmds))) |
| 1018 | (setq isearch-string (isearch-string-state cmd) |
| 1019 | isearch-message (isearch-message-state cmd) |
| 1020 | isearch-success (isearch-success-state cmd) |
| 1021 | isearch-forward (isearch-forward-state cmd) |
| 1022 | isearch-other-end (isearch-other-end-state cmd) |
| 1023 | isearch-word (isearch-word-state cmd) |
| 1024 | isearch-error (isearch-error-state cmd) |
| 1025 | isearch-wrapped (isearch-wrapped-state cmd) |
| 1026 | isearch-barrier (isearch-barrier-state cmd) |
| 1027 | isearch-case-fold-search (isearch-case-fold-search-state cmd)) |
| 1028 | (if (functionp (isearch-pop-fun-state cmd)) |
| 1029 | (funcall (isearch-pop-fun-state cmd) cmd)) |
| 1030 | (goto-char (isearch-point-state cmd)))) |
| 1031 | |
| 1032 | (defun isearch-pop-state () |
| 1033 | (setq isearch-cmds (cdr isearch-cmds)) |
| 1034 | (isearch-top-state)) |
| 1035 | |
| 1036 | (defun isearch-push-state () |
| 1037 | (setq isearch-cmds |
| 1038 | (cons (vector isearch-string isearch-message (point) |
| 1039 | isearch-success isearch-forward isearch-other-end |
| 1040 | isearch-word |
| 1041 | isearch-error isearch-wrapped isearch-barrier |
| 1042 | isearch-case-fold-search |
| 1043 | (if isearch-push-state-function |
| 1044 | (funcall isearch-push-state-function))) |
| 1045 | isearch-cmds))) |
| 1046 | |
| 1047 | \f |
| 1048 | ;; Commands active while inside of the isearch minor mode. |
| 1049 | |
| 1050 | (defun isearch-exit () |
| 1051 | "Exit search normally. |
| 1052 | However, if this is the first command after starting incremental |
| 1053 | search and `search-nonincremental-instead' is non-nil, do a |
| 1054 | nonincremental search instead via `isearch-edit-string'." |
| 1055 | (interactive) |
| 1056 | (if (and search-nonincremental-instead |
| 1057 | (= 0 (length isearch-string))) |
| 1058 | (let ((isearch-nonincremental t)) |
| 1059 | (isearch-edit-string))) |
| 1060 | (isearch-done) |
| 1061 | (isearch-clean-overlays)) |
| 1062 | |
| 1063 | (defvar minibuffer-history-symbol) ;; from external package gmhist.el |
| 1064 | |
| 1065 | (defun isearch-edit-string () |
| 1066 | "Edit the search string in the minibuffer. |
| 1067 | The following additional command keys are active while editing. |
| 1068 | \\<minibuffer-local-isearch-map> |
| 1069 | \\[exit-minibuffer] to resume incremental searching with the edited string. |
| 1070 | \\[isearch-nonincremental-exit-minibuffer] to do one nonincremental search. |
| 1071 | \\[isearch-forward-exit-minibuffer] to resume isearching forward. |
| 1072 | \\[isearch-reverse-exit-minibuffer] to resume isearching backward. |
| 1073 | \\[isearch-complete-edit] to complete the search string using the search ring. |
| 1074 | \\<isearch-mode-map> |
| 1075 | If first char entered is \\[isearch-yank-word-or-char], then do word search instead." |
| 1076 | |
| 1077 | ;; This code is very hairy for several reasons, explained in the code. |
| 1078 | ;; Mainly, isearch-mode must be terminated while editing and then restarted. |
| 1079 | ;; If there were a way to catch any change of buffer from the minibuffer, |
| 1080 | ;; this could be simplified greatly. |
| 1081 | ;; Editing doesn't back up the search point. Should it? |
| 1082 | (interactive) |
| 1083 | (condition-case nil |
| 1084 | (progn |
| 1085 | (let ((isearch-nonincremental isearch-nonincremental) |
| 1086 | |
| 1087 | ;; Locally bind all isearch global variables to protect them |
| 1088 | ;; from recursive isearching. |
| 1089 | ;; isearch-string -message and -forward are not bound |
| 1090 | ;; so they may be changed. Instead, save the values. |
| 1091 | (isearch-new-string isearch-string) |
| 1092 | (isearch-new-message isearch-message) |
| 1093 | (isearch-new-forward isearch-forward) |
| 1094 | (isearch-new-word isearch-word) |
| 1095 | |
| 1096 | (isearch-regexp isearch-regexp) |
| 1097 | (isearch-op-fun isearch-op-fun) |
| 1098 | (isearch-cmds isearch-cmds) |
| 1099 | (isearch-success isearch-success) |
| 1100 | (isearch-wrapped isearch-wrapped) |
| 1101 | (isearch-barrier isearch-barrier) |
| 1102 | (isearch-adjusted isearch-adjusted) |
| 1103 | (isearch-yank-flag isearch-yank-flag) |
| 1104 | (isearch-error isearch-error) |
| 1105 | ;;; Don't bind this. We want isearch-search, below, to set it. |
| 1106 | ;;; And the old value won't matter after that. |
| 1107 | ;;; (isearch-other-end isearch-other-end) |
| 1108 | ;;; Perhaps some of these other variables should be bound for a |
| 1109 | ;;; shorter period, ending before the next isearch-search. |
| 1110 | ;;; But there doesn't seem to be a real bug, so let's not risk it now. |
| 1111 | (isearch-opoint isearch-opoint) |
| 1112 | (isearch-slow-terminal-mode isearch-slow-terminal-mode) |
| 1113 | (isearch-small-window isearch-small-window) |
| 1114 | (isearch-recursive-edit isearch-recursive-edit) |
| 1115 | ;; Save current configuration so we can restore it here. |
| 1116 | (isearch-window-configuration (current-window-configuration)) |
| 1117 | |
| 1118 | ;; Temporarily restore `minibuffer-message-timeout'. |
| 1119 | (minibuffer-message-timeout |
| 1120 | isearch-original-minibuffer-message-timeout) |
| 1121 | (isearch-original-minibuffer-message-timeout |
| 1122 | isearch-original-minibuffer-message-timeout) |
| 1123 | old-point old-other-end) |
| 1124 | |
| 1125 | ;; Actually terminate isearching until editing is done. |
| 1126 | ;; This is so that the user can do anything without failure, |
| 1127 | ;; like switch buffers and start another isearch, and return. |
| 1128 | (condition-case nil |
| 1129 | (isearch-done t t) |
| 1130 | (exit nil)) ; was recursive editing |
| 1131 | |
| 1132 | ;; Save old point and isearch-other-end before reading from minibuffer |
| 1133 | ;; that can change their values. |
| 1134 | (setq old-point (point) old-other-end isearch-other-end) |
| 1135 | |
| 1136 | (unwind-protect |
| 1137 | (let* ((message-log-max nil) |
| 1138 | ;; Binding minibuffer-history-symbol to nil is a work-around |
| 1139 | ;; for some incompatibility with gmhist. |
| 1140 | (minibuffer-history-symbol)) |
| 1141 | (setq isearch-new-string |
| 1142 | (read-from-minibuffer |
| 1143 | (isearch-message-prefix nil nil isearch-nonincremental) |
| 1144 | isearch-string |
| 1145 | minibuffer-local-isearch-map nil |
| 1146 | (if isearch-regexp |
| 1147 | (cons 'regexp-search-ring |
| 1148 | (1+ (or regexp-search-ring-yank-pointer -1))) |
| 1149 | (cons 'search-ring |
| 1150 | (1+ (or search-ring-yank-pointer -1)))) |
| 1151 | nil t) |
| 1152 | isearch-new-message |
| 1153 | (mapconcat 'isearch-text-char-description |
| 1154 | isearch-new-string ""))) |
| 1155 | |
| 1156 | ;; Set point at the start (end) of old match if forward (backward), |
| 1157 | ;; so after exiting minibuffer isearch resumes at the start (end) |
| 1158 | ;; of this match and can find it again. |
| 1159 | (if (and old-other-end (eq old-point (point)) |
| 1160 | (eq isearch-forward isearch-new-forward)) |
| 1161 | (goto-char old-other-end)) |
| 1162 | |
| 1163 | ;; Always resume isearching by restarting it. |
| 1164 | (isearch-mode isearch-forward |
| 1165 | isearch-regexp |
| 1166 | isearch-op-fun |
| 1167 | nil |
| 1168 | isearch-word) |
| 1169 | |
| 1170 | ;; Copy new local values to isearch globals |
| 1171 | (setq isearch-string isearch-new-string |
| 1172 | isearch-message isearch-new-message |
| 1173 | isearch-forward isearch-new-forward |
| 1174 | isearch-word isearch-new-word)) |
| 1175 | |
| 1176 | ;; Empty isearch-string means use default. |
| 1177 | (if (= 0 (length isearch-string)) |
| 1178 | (setq isearch-string (or (car (if isearch-regexp |
| 1179 | regexp-search-ring |
| 1180 | search-ring)) |
| 1181 | "") |
| 1182 | |
| 1183 | isearch-message |
| 1184 | (mapconcat 'isearch-text-char-description |
| 1185 | isearch-string "")) |
| 1186 | ;; This used to set the last search string, |
| 1187 | ;; but I think it is not right to do that here. |
| 1188 | ;; Only the string actually used should be saved. |
| 1189 | )) |
| 1190 | |
| 1191 | ;; This used to push the state as of before this C-s, but it adds |
| 1192 | ;; an inconsistent state where part of variables are from the |
| 1193 | ;; previous search (e.g. `isearch-success'), and part of variables |
| 1194 | ;; are just entered from the minibuffer (e.g. `isearch-string'). |
| 1195 | ;; (isearch-push-state) |
| 1196 | |
| 1197 | ;; Reinvoke the pending search. |
| 1198 | (isearch-search) |
| 1199 | (isearch-push-state) ; this pushes the correct state |
| 1200 | (isearch-update) |
| 1201 | (if isearch-nonincremental |
| 1202 | (progn |
| 1203 | ;; (sit-for 1) ;; needed if isearch-done does: (message "") |
| 1204 | (isearch-done) |
| 1205 | ;; The search done message is confusing when the string |
| 1206 | ;; is empty, so erase it. |
| 1207 | (if (equal isearch-string "") |
| 1208 | (message ""))))) |
| 1209 | |
| 1210 | (quit ; handle abort-recursive-edit |
| 1211 | (isearch-abort) ;; outside of let to restore outside global values |
| 1212 | ))) |
| 1213 | |
| 1214 | (defun isearch-nonincremental-exit-minibuffer () |
| 1215 | (interactive) |
| 1216 | (setq isearch-nonincremental t) |
| 1217 | (exit-minibuffer)) |
| 1218 | |
| 1219 | (defun isearch-forward-exit-minibuffer () |
| 1220 | (interactive) |
| 1221 | (setq isearch-new-forward t) |
| 1222 | (exit-minibuffer)) |
| 1223 | |
| 1224 | (defun isearch-reverse-exit-minibuffer () |
| 1225 | (interactive) |
| 1226 | (setq isearch-new-forward nil) |
| 1227 | (exit-minibuffer)) |
| 1228 | |
| 1229 | (defun isearch-cancel () |
| 1230 | "Terminate the search and go back to the starting point." |
| 1231 | (interactive) |
| 1232 | (if (and isearch-push-state-function isearch-cmds) |
| 1233 | ;; For defined push-state function, restore the first state. |
| 1234 | ;; This calls pop-state function and restores original point. |
| 1235 | (let ((isearch-cmds (last isearch-cmds))) |
| 1236 | (isearch-top-state)) |
| 1237 | (goto-char isearch-opoint)) |
| 1238 | (isearch-done t) ; exit isearch |
| 1239 | (isearch-clean-overlays) |
| 1240 | (signal 'quit nil)) ; and pass on quit signal |
| 1241 | |
| 1242 | (defun isearch-abort () |
| 1243 | "Abort incremental search mode if searching is successful, signaling quit. |
| 1244 | Otherwise, revert to previous successful search and continue searching. |
| 1245 | Use `isearch-exit' to quit without signaling." |
| 1246 | (interactive) |
| 1247 | ;; (ding) signal instead below, if quitting |
| 1248 | (discard-input) |
| 1249 | (if (and isearch-success (not isearch-error)) |
| 1250 | ;; If search is successful and has no incomplete regexp, |
| 1251 | ;; move back to starting point and really do quit. |
| 1252 | (progn |
| 1253 | (setq isearch-success nil) |
| 1254 | (isearch-cancel)) |
| 1255 | ;; If search is failing, or has an incomplete regexp, |
| 1256 | ;; rub out until it is once more successful. |
| 1257 | (while (or (not isearch-success) isearch-error) |
| 1258 | (isearch-pop-state)) |
| 1259 | (isearch-update))) |
| 1260 | |
| 1261 | (defun isearch-repeat (direction) |
| 1262 | ;; Utility for isearch-repeat-forward and -backward. |
| 1263 | (if (eq isearch-forward (eq direction 'forward)) |
| 1264 | ;; C-s in forward or C-r in reverse. |
| 1265 | (if (equal isearch-string "") |
| 1266 | ;; If search string is empty, use last one. |
| 1267 | (if (null (if isearch-regexp regexp-search-ring search-ring)) |
| 1268 | (setq isearch-error "No previous search string") |
| 1269 | (setq isearch-string |
| 1270 | (if isearch-regexp |
| 1271 | (car regexp-search-ring) |
| 1272 | (car search-ring)) |
| 1273 | isearch-message |
| 1274 | (mapconcat 'isearch-text-char-description |
| 1275 | isearch-string "") |
| 1276 | isearch-case-fold-search isearch-last-case-fold-search)) |
| 1277 | ;; If already have what to search for, repeat it. |
| 1278 | (or isearch-success |
| 1279 | (progn |
| 1280 | ;; Set isearch-wrapped before calling isearch-wrap-function |
| 1281 | (setq isearch-wrapped t) |
| 1282 | (if isearch-wrap-function |
| 1283 | (funcall isearch-wrap-function) |
| 1284 | (goto-char (if isearch-forward (point-min) (point-max))))))) |
| 1285 | ;; C-s in reverse or C-r in forward, change direction. |
| 1286 | (setq isearch-forward (not isearch-forward) |
| 1287 | isearch-success t)) |
| 1288 | |
| 1289 | (setq isearch-barrier (point)) ; For subsequent \| if regexp. |
| 1290 | |
| 1291 | (if (equal isearch-string "") |
| 1292 | (setq isearch-success t) |
| 1293 | (if (and isearch-success |
| 1294 | (equal (point) isearch-other-end) |
| 1295 | (not isearch-just-started)) |
| 1296 | ;; If repeating a search that found |
| 1297 | ;; an empty string, ensure we advance. |
| 1298 | (if (if isearch-forward (eobp) (bobp)) |
| 1299 | ;; If there's nowhere to advance to, fail (and wrap next time). |
| 1300 | (progn |
| 1301 | (setq isearch-success nil) |
| 1302 | (ding)) |
| 1303 | (forward-char (if isearch-forward 1 -1)) |
| 1304 | (isearch-search)) |
| 1305 | (isearch-search))) |
| 1306 | |
| 1307 | (isearch-push-state) |
| 1308 | (isearch-update)) |
| 1309 | |
| 1310 | (defun isearch-repeat-forward () |
| 1311 | "Repeat incremental search forwards." |
| 1312 | (interactive) |
| 1313 | (isearch-repeat 'forward)) |
| 1314 | |
| 1315 | (defun isearch-repeat-backward () |
| 1316 | "Repeat incremental search backwards." |
| 1317 | (interactive) |
| 1318 | (isearch-repeat 'backward)) |
| 1319 | |
| 1320 | (defun isearch-toggle-regexp () |
| 1321 | "Toggle regexp searching on or off." |
| 1322 | ;; The status stack is left unchanged. |
| 1323 | (interactive) |
| 1324 | (setq isearch-regexp (not isearch-regexp)) |
| 1325 | (if isearch-regexp (setq isearch-word nil)) |
| 1326 | (setq isearch-success t isearch-adjusted t) |
| 1327 | (isearch-update)) |
| 1328 | |
| 1329 | (defun isearch-toggle-word () |
| 1330 | "Toggle word searching on or off." |
| 1331 | (interactive) |
| 1332 | (setq isearch-word (not isearch-word)) |
| 1333 | (setq isearch-success t isearch-adjusted t) |
| 1334 | (isearch-update)) |
| 1335 | |
| 1336 | (defun isearch-toggle-case-fold () |
| 1337 | "Toggle case folding in searching on or off." |
| 1338 | (interactive) |
| 1339 | (setq isearch-case-fold-search |
| 1340 | (if isearch-case-fold-search nil 'yes)) |
| 1341 | (let ((message-log-max nil)) |
| 1342 | (message "%s%s [case %ssensitive]" |
| 1343 | (isearch-message-prefix nil nil isearch-nonincremental) |
| 1344 | isearch-message |
| 1345 | (if isearch-case-fold-search "in" ""))) |
| 1346 | (setq isearch-success t isearch-adjusted t) |
| 1347 | (sit-for 1) |
| 1348 | (isearch-update)) |
| 1349 | |
| 1350 | (defun isearch-query-replace (&optional delimited regexp-flag) |
| 1351 | "Start `query-replace' with string to replace from last search string. |
| 1352 | The arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
| 1353 | only matches surrounded by word boundaries. Note that using the prefix arg |
| 1354 | is possible only when `isearch-allow-scroll' is non-nil, and it don't |
| 1355 | always provides the correct matches for `query-replace', so the preferred |
| 1356 | way to run word replacements from Isearch is `M-s w ... M-%'." |
| 1357 | (interactive |
| 1358 | (list current-prefix-arg)) |
| 1359 | (barf-if-buffer-read-only) |
| 1360 | (if regexp-flag (setq isearch-regexp t)) |
| 1361 | (let ((case-fold-search isearch-case-fold-search) |
| 1362 | ;; set `search-upper-case' to nil to not call |
| 1363 | ;; `isearch-no-upper-case-p' in `perform-replace' |
| 1364 | (search-upper-case nil) |
| 1365 | ;; Set `isearch-recursive-edit' to nil to prevent calling |
| 1366 | ;; `exit-recursive-edit' in `isearch-done' that terminates |
| 1367 | ;; the execution of this command when it is non-nil. |
| 1368 | ;; We call `exit-recursive-edit' explicitly at the end below. |
| 1369 | (isearch-recursive-edit nil)) |
| 1370 | (isearch-done nil t) |
| 1371 | (isearch-clean-overlays) |
| 1372 | (if (and isearch-other-end |
| 1373 | (< isearch-other-end (point)) |
| 1374 | (not (and transient-mark-mode mark-active |
| 1375 | (< (mark) (point))))) |
| 1376 | (goto-char isearch-other-end)) |
| 1377 | (set query-replace-from-history-variable |
| 1378 | (cons isearch-string |
| 1379 | (symbol-value query-replace-from-history-variable))) |
| 1380 | (perform-replace |
| 1381 | isearch-string |
| 1382 | (query-replace-read-to |
| 1383 | isearch-string |
| 1384 | (concat "Query replace" |
| 1385 | (if (or delimited isearch-word) " word" "") |
| 1386 | (if isearch-regexp " regexp" "") |
| 1387 | (if (and transient-mark-mode mark-active) " in region" "")) |
| 1388 | isearch-regexp) |
| 1389 | t isearch-regexp (or delimited isearch-word) nil nil |
| 1390 | (if (and transient-mark-mode mark-active) (region-beginning)) |
| 1391 | (if (and transient-mark-mode mark-active) (region-end)))) |
| 1392 | (and isearch-recursive-edit (exit-recursive-edit))) |
| 1393 | |
| 1394 | (defun isearch-query-replace-regexp (&optional delimited) |
| 1395 | "Start `query-replace-regexp' with string to replace from last search string. |
| 1396 | See `isearch-query-replace' for more information." |
| 1397 | (interactive |
| 1398 | (list current-prefix-arg)) |
| 1399 | (isearch-query-replace delimited t)) |
| 1400 | |
| 1401 | (defun isearch-occur (regexp &optional nlines) |
| 1402 | "Run `occur' with regexp to search from the current search string. |
| 1403 | Interactively, REGEXP is the current search regexp or a quoted search |
| 1404 | string. NLINES has the same meaning as in `occur'." |
| 1405 | (interactive |
| 1406 | (list |
| 1407 | (cond |
| 1408 | (isearch-word (concat "\\b" (replace-regexp-in-string |
| 1409 | "\\W+" "\\W+" |
| 1410 | (replace-regexp-in-string |
| 1411 | "^\\W+\\|\\W+$" "" isearch-string) |
| 1412 | nil t) |
| 1413 | "\\b")) |
| 1414 | (isearch-regexp isearch-string) |
| 1415 | (t (regexp-quote isearch-string))) |
| 1416 | (if current-prefix-arg (prefix-numeric-value current-prefix-arg)))) |
| 1417 | (let ((case-fold-search isearch-case-fold-search) |
| 1418 | ;; set `search-upper-case' to nil to not call |
| 1419 | ;; `isearch-no-upper-case-p' in `occur-1' |
| 1420 | (search-upper-case nil)) |
| 1421 | (occur regexp nlines))) |
| 1422 | |
| 1423 | (declare-function hi-lock-read-face-name "hi-lock" ()) |
| 1424 | |
| 1425 | (defun isearch-highlight-regexp () |
| 1426 | "Run `highlight-regexp' with regexp from the current search string. |
| 1427 | It exits Isearch mode and calls `hi-lock-face-buffer' with its regexp |
| 1428 | argument from the last search regexp or a quoted search string, |
| 1429 | and reads its face argument using `hi-lock-read-face-name'." |
| 1430 | (interactive) |
| 1431 | (let ( |
| 1432 | ;; Set `isearch-recursive-edit' to nil to prevent calling |
| 1433 | ;; `exit-recursive-edit' in `isearch-done' that terminates |
| 1434 | ;; the execution of this command when it is non-nil. |
| 1435 | ;; We call `exit-recursive-edit' explicitly at the end below. |
| 1436 | (isearch-recursive-edit nil)) |
| 1437 | (isearch-done nil t) |
| 1438 | (isearch-clean-overlays)) |
| 1439 | (require 'hi-lock nil t) |
| 1440 | (let ((string (cond (isearch-regexp isearch-string) |
| 1441 | ((if (and (eq isearch-case-fold-search t) |
| 1442 | search-upper-case) |
| 1443 | (isearch-no-upper-case-p |
| 1444 | isearch-string isearch-regexp) |
| 1445 | isearch-case-fold-search) |
| 1446 | ;; Turn isearch-string into a case-insensitive |
| 1447 | ;; regexp. |
| 1448 | (mapconcat |
| 1449 | (lambda (c) |
| 1450 | (let ((s (string c))) |
| 1451 | (if (string-match "[[:alpha:]]" s) |
| 1452 | (format "[%s%s]" (upcase s) (downcase s)) |
| 1453 | (regexp-quote s)))) |
| 1454 | isearch-string "")) |
| 1455 | (t (regexp-quote isearch-string))))) |
| 1456 | (hi-lock-face-buffer string (hi-lock-read-face-name))) |
| 1457 | (and isearch-recursive-edit (exit-recursive-edit))) |
| 1458 | |
| 1459 | \f |
| 1460 | (defun isearch-delete-char () |
| 1461 | "Discard last input item and move point back. |
| 1462 | If no previous match was done, just beep." |
| 1463 | (interactive) |
| 1464 | (if (null (cdr isearch-cmds)) |
| 1465 | (ding) |
| 1466 | (isearch-pop-state)) |
| 1467 | (isearch-update)) |
| 1468 | |
| 1469 | (defun isearch-del-char (&optional arg) |
| 1470 | "Delete character from end of search string and search again. |
| 1471 | If search string is empty, just beep." |
| 1472 | (interactive "p") |
| 1473 | (if (= 0 (length isearch-string)) |
| 1474 | (ding) |
| 1475 | (setq isearch-string (substring isearch-string 0 (- (or arg 1))) |
| 1476 | isearch-message (mapconcat 'isearch-text-char-description |
| 1477 | isearch-string ""))) |
| 1478 | ;; Use the isearch-other-end as new starting point to be able |
| 1479 | ;; to find the remaining part of the search string again. |
| 1480 | (if isearch-other-end (goto-char isearch-other-end)) |
| 1481 | (isearch-search) |
| 1482 | (isearch-push-state) |
| 1483 | (isearch-update)) |
| 1484 | |
| 1485 | (defun isearch-yank-string (string) |
| 1486 | "Pull STRING into search string." |
| 1487 | ;; Downcase the string if not supposed to case-fold yanked strings. |
| 1488 | (if (and isearch-case-fold-search |
| 1489 | (eq 'not-yanks search-upper-case)) |
| 1490 | (setq string (downcase string))) |
| 1491 | (if isearch-regexp (setq string (regexp-quote string))) |
| 1492 | ;; Don't move cursor in reverse search. |
| 1493 | (setq isearch-yank-flag t) |
| 1494 | (isearch-process-search-string |
| 1495 | string (mapconcat 'isearch-text-char-description string ""))) |
| 1496 | |
| 1497 | (defun isearch-yank-kill () |
| 1498 | "Pull string from kill ring into search string." |
| 1499 | (interactive) |
| 1500 | (isearch-yank-string (current-kill 0))) |
| 1501 | |
| 1502 | (defun isearch-yank-pop () |
| 1503 | "Replace just-yanked search string with previously killed string." |
| 1504 | (interactive) |
| 1505 | (if (not (memq last-command '(isearch-yank-kill isearch-yank-pop))) |
| 1506 | ;; Fall back on `isearch-yank-kill' for the benefits of people |
| 1507 | ;; who are used to the old behavior of `M-y' in isearch mode. In |
| 1508 | ;; future, this fallback may be changed if we ever change |
| 1509 | ;; `yank-pop' to do something like the kill-ring-browser. |
| 1510 | (isearch-yank-kill) |
| 1511 | (isearch-pop-state) |
| 1512 | (isearch-yank-string (current-kill 1)))) |
| 1513 | |
| 1514 | (defun isearch-yank-x-selection () |
| 1515 | "Pull current X selection into search string." |
| 1516 | (interactive) |
| 1517 | (isearch-yank-string (x-get-selection))) |
| 1518 | |
| 1519 | |
| 1520 | (defun isearch-mouse-2 (click) |
| 1521 | "Handle mouse-2 in Isearch mode. |
| 1522 | For a click in the echo area, invoke `isearch-yank-x-selection'. |
| 1523 | Otherwise invoke whatever the calling mouse-2 command sequence |
| 1524 | is bound to outside of Isearch." |
| 1525 | (interactive "e") |
| 1526 | (let* ((w (posn-window (event-start click))) |
| 1527 | (overriding-terminal-local-map nil) |
| 1528 | (binding (key-binding (this-command-keys-vector) t))) |
| 1529 | (if (and (window-minibuffer-p w) |
| 1530 | (not (minibuffer-window-active-p w))) ; in echo area |
| 1531 | (isearch-yank-x-selection) |
| 1532 | (when (functionp binding) |
| 1533 | (call-interactively binding))))) |
| 1534 | |
| 1535 | (defun isearch-yank-internal (jumpform) |
| 1536 | "Pull the text from point to the point reached by JUMPFORM. |
| 1537 | JUMPFORM is a lambda expression that takes no arguments and returns |
| 1538 | a buffer position, possibly having moved point to that position. |
| 1539 | For example, it might move point forward by a word and return point, |
| 1540 | or it might return the position of the end of the line." |
| 1541 | (isearch-yank-string |
| 1542 | (save-excursion |
| 1543 | (and (not isearch-forward) isearch-other-end |
| 1544 | (goto-char isearch-other-end)) |
| 1545 | (buffer-substring-no-properties (point) (funcall jumpform))))) |
| 1546 | |
| 1547 | (defun isearch-yank-char-in-minibuffer (&optional arg) |
| 1548 | "Pull next character from buffer into end of search string in minibuffer." |
| 1549 | (interactive "p") |
| 1550 | (if (eobp) |
| 1551 | (insert |
| 1552 | (with-current-buffer (cadr (buffer-list)) |
| 1553 | (buffer-substring-no-properties |
| 1554 | (point) (progn (forward-char arg) (point))))) |
| 1555 | (forward-char arg))) |
| 1556 | |
| 1557 | (defun isearch-yank-char (&optional arg) |
| 1558 | "Pull next character from buffer into search string." |
| 1559 | (interactive "p") |
| 1560 | (isearch-yank-internal (lambda () (forward-char arg) (point)))) |
| 1561 | |
| 1562 | (declare-function subword-forward "subword" (&optional arg)) |
| 1563 | (defun isearch-yank-word-or-char () |
| 1564 | "Pull next character, subword or word from buffer into search string. |
| 1565 | Subword is used when `subword-mode' is activated. " |
| 1566 | (interactive) |
| 1567 | (isearch-yank-internal |
| 1568 | (lambda () |
| 1569 | (if (or (= (char-syntax (or (char-after) 0)) ?w) |
| 1570 | (= (char-syntax (or (char-after (1+ (point))) 0)) ?w)) |
| 1571 | (if (and (boundp 'subword-mode) subword-mode) |
| 1572 | (subword-forward 1) |
| 1573 | (forward-word 1)) |
| 1574 | (forward-char 1)) (point)))) |
| 1575 | |
| 1576 | (defun isearch-yank-word () |
| 1577 | "Pull next word from buffer into search string." |
| 1578 | (interactive) |
| 1579 | (isearch-yank-internal (lambda () (forward-word 1) (point)))) |
| 1580 | |
| 1581 | (defun isearch-yank-line () |
| 1582 | "Pull rest of line from buffer into search string." |
| 1583 | (interactive) |
| 1584 | (isearch-yank-internal |
| 1585 | (lambda () (let ((inhibit-field-text-motion t)) |
| 1586 | (line-end-position (if (eolp) 2 1)))))) |
| 1587 | |
| 1588 | (defun isearch-search-and-update () |
| 1589 | ;; Do the search and update the display. |
| 1590 | (when (or isearch-success |
| 1591 | ;; Unsuccessful regexp search may become successful by |
| 1592 | ;; addition of characters which make isearch-string valid |
| 1593 | isearch-regexp |
| 1594 | ;; If the string was found but was completely invisible, |
| 1595 | ;; it might now be partly visible, so try again. |
| 1596 | (prog1 isearch-hidden (setq isearch-hidden nil))) |
| 1597 | ;; In reverse search, adding stuff at |
| 1598 | ;; the end may cause zero or many more chars to be |
| 1599 | ;; matched, in the string following point. |
| 1600 | ;; Allow all those possibilities without moving point as |
| 1601 | ;; long as the match does not extend past search origin. |
| 1602 | (if (and (not isearch-forward) (not isearch-adjusted) |
| 1603 | (condition-case () |
| 1604 | (let ((case-fold-search isearch-case-fold-search)) |
| 1605 | (if (and (eq case-fold-search t) search-upper-case) |
| 1606 | (setq case-fold-search |
| 1607 | (isearch-no-upper-case-p isearch-string isearch-regexp))) |
| 1608 | (looking-at (if isearch-regexp isearch-string |
| 1609 | (regexp-quote isearch-string)))) |
| 1610 | (error nil)) |
| 1611 | (or isearch-yank-flag |
| 1612 | (<= (match-end 0) |
| 1613 | (min isearch-opoint isearch-barrier)))) |
| 1614 | (progn |
| 1615 | (setq isearch-success t |
| 1616 | isearch-error nil |
| 1617 | isearch-other-end (match-end 0)) |
| 1618 | (if (and (eq isearch-case-fold-search t) search-upper-case) |
| 1619 | (setq isearch-case-fold-search |
| 1620 | (isearch-no-upper-case-p isearch-string isearch-regexp)))) |
| 1621 | ;; Not regexp, not reverse, or no match at point. |
| 1622 | (if (and isearch-other-end (not isearch-adjusted)) |
| 1623 | (goto-char (if isearch-forward isearch-other-end |
| 1624 | (min isearch-opoint |
| 1625 | isearch-barrier |
| 1626 | (1+ isearch-other-end))))) |
| 1627 | (isearch-search) |
| 1628 | )) |
| 1629 | (isearch-push-state) |
| 1630 | (if isearch-op-fun (funcall isearch-op-fun)) |
| 1631 | (isearch-update)) |
| 1632 | |
| 1633 | |
| 1634 | ;; *, ?, }, and | chars can make a regexp more liberal. |
| 1635 | ;; They can make a regexp match sooner or make it succeed instead of failing. |
| 1636 | ;; So go back to place last successful search started |
| 1637 | ;; or to the last ^S/^R (barrier), whichever is nearer. |
| 1638 | ;; + needs no special handling because the string must match at least once. |
| 1639 | |
| 1640 | (defun isearch-backslash (str) |
| 1641 | "Return t if STR ends in an odd number of backslashes." |
| 1642 | (= (mod (- (length str) (string-match "\\\\*\\'" str)) 2) 1)) |
| 1643 | |
| 1644 | (defun isearch-fallback (want-backslash &optional allow-invalid to-barrier) |
| 1645 | "Return point to previous successful match to allow regexp liberalization. |
| 1646 | \\<isearch-mode-map> |
| 1647 | Respects \\[isearch-repeat-forward] and \\[isearch-repeat-backward] by \ |
| 1648 | stopping at `isearch-barrier' as needed. |
| 1649 | |
| 1650 | Do nothing if a backslash is escaping the liberalizing character. |
| 1651 | If WANT-BACKSLASH is non-nil, invert this behavior (for \\} and \\|). |
| 1652 | |
| 1653 | Do nothing if regexp has recently been invalid unless optional |
| 1654 | ALLOW-INVALID non-nil. |
| 1655 | |
| 1656 | If optional TO-BARRIER non-nil, ignore previous matches and go exactly |
| 1657 | to the barrier." |
| 1658 | ;; (eq (not a) (not b)) makes all non-nil values equivalent |
| 1659 | (when (and isearch-regexp (eq (not (isearch-backslash isearch-string)) |
| 1660 | (not want-backslash)) |
| 1661 | ;; We have to check 2 stack frames because the last might be |
| 1662 | ;; invalid just because of a backslash. |
| 1663 | (or (not isearch-error) |
| 1664 | (not (isearch-error-state (cadr isearch-cmds))) |
| 1665 | allow-invalid)) |
| 1666 | (if to-barrier |
| 1667 | (progn (goto-char isearch-barrier) |
| 1668 | (setq isearch-adjusted t)) |
| 1669 | (let* ((stack isearch-cmds) |
| 1670 | (previous (cdr stack)) ; lookbelow in the stack |
| 1671 | (frame (car stack))) |
| 1672 | ;; Walk down the stack looking for a valid regexp (as of course only |
| 1673 | ;; they can be the previous successful match); this conveniently |
| 1674 | ;; removes all bracket-sets and groups that might be in the way, as |
| 1675 | ;; well as partial \{\} constructs that the code below leaves behind. |
| 1676 | ;; Also skip over postfix operators -- though horrid, |
| 1677 | ;; 'ab?\{5,6\}+\{1,2\}*' is perfectly valid. |
| 1678 | (while (and previous |
| 1679 | (or (isearch-error-state frame) |
| 1680 | (let* ((string (isearch-string-state frame)) |
| 1681 | (lchar (aref string (1- (length string))))) |
| 1682 | ;; The operators aren't always operators; check |
| 1683 | ;; backslashes. This doesn't handle the case of |
| 1684 | ;; operators at the beginning of the regexp not |
| 1685 | ;; being special, but then we should fall back to |
| 1686 | ;; the barrier anyway because it's all optional. |
| 1687 | (if (isearch-backslash |
| 1688 | (isearch-string-state (car previous))) |
| 1689 | (eq lchar ?\}) |
| 1690 | (memq lchar '(?* ?? ?+)))))) |
| 1691 | (setq stack previous previous (cdr previous) frame (car stack))) |
| 1692 | (when stack |
| 1693 | ;; `stack' now refers the most recent valid regexp that is not at |
| 1694 | ;; all optional in its last term. Now dig one level deeper and find |
| 1695 | ;; what matched before that. |
| 1696 | (let ((last-other-end |
| 1697 | (or (and (car previous) |
| 1698 | (isearch-other-end-state (car previous))) |
| 1699 | isearch-barrier))) |
| 1700 | (goto-char (if isearch-forward |
| 1701 | (max last-other-end isearch-barrier) |
| 1702 | (min last-other-end isearch-barrier))) |
| 1703 | (setq isearch-adjusted t))))))) |
| 1704 | |
| 1705 | (defun isearch-unread-key-sequence (keylist) |
| 1706 | "Unread the given key-sequence KEYLIST. |
| 1707 | Scroll-bar or mode-line events are processed appropriately." |
| 1708 | (cancel-kbd-macro-events) |
| 1709 | (apply 'isearch-unread keylist) |
| 1710 | ;; If the event was a scroll-bar or mode-line click, the event will have |
| 1711 | ;; been prefixed by a symbol such as vertical-scroll-bar. We must remove |
| 1712 | ;; it here, because this symbol will be attached to the event again next |
| 1713 | ;; time it gets read by read-key-sequence. |
| 1714 | ;; |
| 1715 | ;; (Old comment from isearch-other-meta-char: "Note that we don't have to |
| 1716 | ;; modify the event anymore in 21 because read_key_sequence no longer |
| 1717 | ;; modifies events to produce fake prefix keys.") |
| 1718 | (if (and (> (length keylist) 1) |
| 1719 | (symbolp (car keylist)) |
| 1720 | (listp (cadr keylist)) |
| 1721 | (not (numberp (posn-point |
| 1722 | (event-start (cadr keylist) ))))) |
| 1723 | (pop unread-command-events))) |
| 1724 | |
| 1725 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
| 1726 | ;; scrolling within Isearch mode. Alan Mackenzie (acm@muc.de), 2003/2/24 |
| 1727 | ;; |
| 1728 | ;; The idea here is that certain vertical scrolling commands (like C-l |
| 1729 | ;; `recenter') should be usable WITHIN Isearch mode. For a command to be |
| 1730 | ;; suitable, it must NOT alter the buffer, swap to another buffer or frame, |
| 1731 | ;; tamper with isearch's state, or move point. It is unacceptable for the |
| 1732 | ;; search string to be scrolled out of the current window. If a command |
| 1733 | ;; attempts this, we scroll the text back again. |
| 1734 | ;; |
| 1735 | ;; We implement this feature with a property called `isearch-scroll'. |
| 1736 | ;; If a command's symbol has the value t for this property or for the |
| 1737 | ;; `scroll-command' property, it is a scrolling command. The feature |
| 1738 | ;; needs to be enabled by setting the customizable variable |
| 1739 | ;; `isearch-allow-scroll' to a non-nil value. |
| 1740 | ;; |
| 1741 | ;; The universal argument commands (e.g. C-u) in simple.el are marked |
| 1742 | ;; as scrolling commands, and isearch.el has been amended to allow |
| 1743 | ;; prefix arguments to be passed through to scrolling commands. Thus |
| 1744 | ;; M-0 C-l will scroll point to the top of the window. |
| 1745 | ;; |
| 1746 | ;; Horizontal scrolling commands are currently not catered for. |
| 1747 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
| 1748 | |
| 1749 | ;; Set the isearch-scroll property on some standard functions: |
| 1750 | ;; Scroll-bar functions: |
| 1751 | (if (fboundp 'scroll-bar-toolkit-scroll) |
| 1752 | (put 'scroll-bar-toolkit-scroll 'isearch-scroll t)) |
| 1753 | (if (fboundp 'w32-handle-scroll-bar-event) |
| 1754 | (put 'w32-handle-scroll-bar-event 'isearch-scroll t)) |
| 1755 | |
| 1756 | ;; Commands which scroll the window (some scroll commands |
| 1757 | ;; already have the `scroll-command' property on them): |
| 1758 | (put 'recenter 'isearch-scroll t) |
| 1759 | (put 'recenter-top-bottom 'isearch-scroll t) |
| 1760 | (put 'reposition-window 'isearch-scroll t) |
| 1761 | |
| 1762 | ;; Commands which act on the other window |
| 1763 | (put 'list-buffers 'isearch-scroll t) |
| 1764 | (put 'scroll-other-window 'isearch-scroll t) |
| 1765 | (put 'scroll-other-window-down 'isearch-scroll t) |
| 1766 | (put 'beginning-of-buffer-other-window 'isearch-scroll t) |
| 1767 | (put 'end-of-buffer-other-window 'isearch-scroll t) |
| 1768 | |
| 1769 | ;; Commands which change the window layout |
| 1770 | (put 'delete-other-windows 'isearch-scroll t) |
| 1771 | (put 'balance-windows 'isearch-scroll t) |
| 1772 | (put 'split-window-vertically 'isearch-scroll t) |
| 1773 | (put 'split-window-horizontally 'isearch-scroll t) |
| 1774 | (put 'enlarge-window 'isearch-scroll t) |
| 1775 | |
| 1776 | ;; Universal argument commands |
| 1777 | (put 'universal-argument 'isearch-scroll t) |
| 1778 | (put 'negative-argument 'isearch-scroll t) |
| 1779 | (put 'digit-argument 'isearch-scroll t) |
| 1780 | |
| 1781 | (defcustom isearch-allow-scroll nil |
| 1782 | "Whether scrolling is allowed during incremental search. |
| 1783 | If non-nil, scrolling commands can be used in Isearch mode. |
| 1784 | However, the current match will never scroll offscreen. |
| 1785 | If nil, scrolling commands will first cancel Isearch mode." |
| 1786 | :type 'boolean |
| 1787 | :group 'isearch) |
| 1788 | |
| 1789 | (defun isearch-string-out-of-window (isearch-point) |
| 1790 | "Test whether the search string is currently outside of the window. |
| 1791 | Return nil if it's completely visible, or if point is visible, |
| 1792 | together with as much of the search string as will fit; the symbol |
| 1793 | `above' if we need to scroll the text downwards; the symbol `below', |
| 1794 | if upwards." |
| 1795 | (let ((w-start (window-start)) |
| 1796 | (w-end (window-end nil t)) |
| 1797 | (w-L1 (save-excursion (move-to-window-line 1) (point))) |
| 1798 | (w-L-1 (save-excursion (move-to-window-line -1) (point))) |
| 1799 | start end) ; start and end of search string in buffer |
| 1800 | (if isearch-forward |
| 1801 | (setq end isearch-point start (or isearch-other-end isearch-point)) |
| 1802 | (setq start isearch-point end (or isearch-other-end isearch-point))) |
| 1803 | (cond ((or (and (>= start w-start) (<= end w-end)) |
| 1804 | (if isearch-forward |
| 1805 | (and (>= isearch-point w-L-1) (< isearch-point w-end)) ; point on Line -1 |
| 1806 | (and (>= isearch-point w-start) (< isearch-point w-L1)))) ; point on Line 0 |
| 1807 | nil) |
| 1808 | ((and (< start w-start) |
| 1809 | (< isearch-point w-L-1)) |
| 1810 | 'above) |
| 1811 | (t 'below)))) |
| 1812 | |
| 1813 | (defun isearch-back-into-window (above isearch-point) |
| 1814 | "Scroll the window to bring the search string back into view. |
| 1815 | Restore point to ISEARCH-POINT in the process. ABOVE is t when the |
| 1816 | search string is above the top of the window, nil when it is beneath |
| 1817 | the bottom." |
| 1818 | (let (start end) |
| 1819 | (if isearch-forward |
| 1820 | (setq end isearch-point start (or isearch-other-end isearch-point)) |
| 1821 | (setq start isearch-point end (or isearch-other-end isearch-point))) |
| 1822 | (if above |
| 1823 | (progn |
| 1824 | (goto-char start) |
| 1825 | (recenter 0) |
| 1826 | (when (>= isearch-point (window-end nil t)) |
| 1827 | (goto-char isearch-point) |
| 1828 | (recenter -1))) |
| 1829 | (goto-char end) |
| 1830 | (recenter -1) |
| 1831 | (when (< isearch-point (window-start)) |
| 1832 | (goto-char isearch-point) |
| 1833 | (recenter 0)))) |
| 1834 | (goto-char isearch-point)) |
| 1835 | |
| 1836 | (defun isearch-reread-key-sequence-naturally (keylist) |
| 1837 | "Reread key sequence KEYLIST with Isearch mode's keymap deactivated. |
| 1838 | Return the key sequence as a string/vector." |
| 1839 | (isearch-unread-key-sequence keylist) |
| 1840 | (let (overriding-terminal-local-map) |
| 1841 | (read-key-sequence nil))) ; This will go through function-key-map, if nec. |
| 1842 | |
| 1843 | (defun isearch-lookup-scroll-key (key-seq) |
| 1844 | "If KEY-SEQ is bound to a scrolling command, return it as a symbol. |
| 1845 | Otherwise return nil." |
| 1846 | (let* ((overriding-terminal-local-map nil) |
| 1847 | (binding (key-binding key-seq))) |
| 1848 | (and binding (symbolp binding) (commandp binding) |
| 1849 | (or (eq (get binding 'isearch-scroll) t) |
| 1850 | (eq (get binding 'scroll-command) t)) |
| 1851 | binding))) |
| 1852 | |
| 1853 | (defalias 'isearch-other-control-char 'isearch-other-meta-char) |
| 1854 | |
| 1855 | (defun isearch-other-meta-char (&optional arg) |
| 1856 | "Process a miscellaneous key sequence in Isearch mode. |
| 1857 | |
| 1858 | Try to convert the current key-sequence to something usable in Isearch |
| 1859 | mode, either by converting it with `function-key-map', downcasing a |
| 1860 | key with C-<upper case>, or finding a \"scrolling command\" bound to |
| 1861 | it. \(In the last case, we may have to read more events.) If so, |
| 1862 | either unread the converted sequence or execute the command. |
| 1863 | |
| 1864 | Otherwise, if `search-exit-option' is non-nil (the default) unread the |
| 1865 | key-sequence and exit the search normally. If it is the symbol |
| 1866 | `edit', the search string is edited in the minibuffer and the meta |
| 1867 | character is unread so that it applies to editing the string. |
| 1868 | |
| 1869 | ARG is the prefix argument. It will be transmitted through to the |
| 1870 | scrolling command or to the command whose key-sequence exits |
| 1871 | Isearch mode." |
| 1872 | (interactive "P") |
| 1873 | (let* ((key (if current-prefix-arg ; not nec the same as ARG |
| 1874 | (substring (this-command-keys) universal-argument-num-events) |
| 1875 | (this-command-keys))) |
| 1876 | (main-event (aref key 0)) |
| 1877 | (keylist (listify-key-sequence key)) |
| 1878 | scroll-command isearch-point) |
| 1879 | (cond ((and (= (length key) 1) |
| 1880 | (let ((lookup (lookup-key local-function-key-map key))) |
| 1881 | (not (or (null lookup) (integerp lookup) |
| 1882 | (keymapp lookup))))) |
| 1883 | ;; Handle a function key that translates into something else. |
| 1884 | ;; If the key has a global definition too, |
| 1885 | ;; exit and unread the key itself, so its global definition runs. |
| 1886 | ;; Otherwise, unread the translation, |
| 1887 | ;; so that the translated key takes effect within isearch. |
| 1888 | (cancel-kbd-macro-events) |
| 1889 | (if (lookup-key global-map key) |
| 1890 | (progn |
| 1891 | (isearch-done) |
| 1892 | (apply 'isearch-unread keylist)) |
| 1893 | (setq keylist |
| 1894 | (listify-key-sequence (lookup-key local-function-key-map key))) |
| 1895 | (while keylist |
| 1896 | (setq key (car keylist)) |
| 1897 | ;; If KEY is a printing char, we handle it here |
| 1898 | ;; directly to avoid the input method and keyboard |
| 1899 | ;; coding system translating it. |
| 1900 | (if (and (integerp key) |
| 1901 | (>= key ?\s) (/= key 127) (< key 256)) |
| 1902 | (progn |
| 1903 | (isearch-process-search-char key) |
| 1904 | (setq keylist (cdr keylist))) |
| 1905 | ;; As the remaining keys in KEYLIST can't be handled |
| 1906 | ;; here, we must reread them. |
| 1907 | (apply 'isearch-unread keylist) |
| 1908 | (setq keylist nil))))) |
| 1909 | ( |
| 1910 | ;; Handle an undefined shifted control character |
| 1911 | ;; by downshifting it if that makes it defined. |
| 1912 | ;; (As read-key-sequence would normally do, |
| 1913 | ;; if we didn't have a default definition.) |
| 1914 | (let ((mods (event-modifiers main-event))) |
| 1915 | (and (integerp main-event) |
| 1916 | (memq 'shift mods) |
| 1917 | (memq 'control mods) |
| 1918 | (not (memq (lookup-key isearch-mode-map |
| 1919 | (let ((copy (copy-sequence key))) |
| 1920 | (aset copy 0 |
| 1921 | (- main-event |
| 1922 | (- ?\C-\S-a ?\C-a))) |
| 1923 | copy) |
| 1924 | nil) |
| 1925 | '(nil |
| 1926 | isearch-other-control-char))))) |
| 1927 | (setcar keylist (- main-event (- ?\C-\S-a ?\C-a))) |
| 1928 | (cancel-kbd-macro-events) |
| 1929 | (apply 'isearch-unread keylist)) |
| 1930 | ((eq search-exit-option 'edit) |
| 1931 | (apply 'isearch-unread keylist) |
| 1932 | (isearch-edit-string)) |
| 1933 | ;; Handle a scrolling function. |
| 1934 | ((and isearch-allow-scroll |
| 1935 | (progn (setq key (isearch-reread-key-sequence-naturally keylist)) |
| 1936 | (setq keylist (listify-key-sequence key)) |
| 1937 | (setq main-event (aref key 0)) |
| 1938 | (setq scroll-command (isearch-lookup-scroll-key key)))) |
| 1939 | ;; From this point onwards, KEY, KEYLIST and MAIN-EVENT hold a |
| 1940 | ;; complete key sequence, possibly as modified by function-key-map, |
| 1941 | ;; not merely the one or two event fragment which invoked |
| 1942 | ;; isearch-other-meta-char in the first place. |
| 1943 | (setq isearch-point (point)) |
| 1944 | (setq prefix-arg arg) |
| 1945 | (command-execute scroll-command) |
| 1946 | (let ((ab-bel (isearch-string-out-of-window isearch-point))) |
| 1947 | (if ab-bel |
| 1948 | (isearch-back-into-window (eq ab-bel 'above) isearch-point) |
| 1949 | (goto-char isearch-point))) |
| 1950 | (isearch-update)) |
| 1951 | ;; A mouse click on the isearch message starts editing the search string |
| 1952 | ((and (eq (car-safe main-event) 'down-mouse-1) |
| 1953 | (window-minibuffer-p (posn-window (event-start main-event)))) |
| 1954 | ;; Swallow the up-event. |
| 1955 | (read-event) |
| 1956 | (isearch-edit-string)) |
| 1957 | (search-exit-option |
| 1958 | (let (window) |
| 1959 | (isearch-unread-key-sequence keylist) |
| 1960 | (setq main-event (car unread-command-events)) |
| 1961 | |
| 1962 | ;; If we got a mouse click event, that event contains the |
| 1963 | ;; window clicked on. maybe it was read with the buffer |
| 1964 | ;; it was clicked on. If so, that buffer, not the current one, |
| 1965 | ;; is in isearch mode. So end the search in that buffer. |
| 1966 | |
| 1967 | ;; ??? I have no idea what this if checks for, but it's |
| 1968 | ;; obviously wrong for the case that a down-mouse event |
| 1969 | ;; on another window invokes this function. The event |
| 1970 | ;; will contain the window clicked on and that window's |
| 1971 | ;; buffer is certainly not always in Isearch mode. |
| 1972 | ;; |
| 1973 | ;; Leave the code in, but check for current buffer not |
| 1974 | ;; being in Isearch mode for now, until someone tells |
| 1975 | ;; what it's really supposed to do. |
| 1976 | ;; |
| 1977 | ;; --gerd 2001-08-10. |
| 1978 | |
| 1979 | (if (and (not isearch-mode) |
| 1980 | (listp main-event) |
| 1981 | (setq window (posn-window (event-start main-event))) |
| 1982 | (windowp window) |
| 1983 | (or (> (minibuffer-depth) 0) |
| 1984 | (not (window-minibuffer-p window)))) |
| 1985 | (with-current-buffer (window-buffer window) |
| 1986 | (isearch-done) |
| 1987 | (isearch-clean-overlays)) |
| 1988 | (isearch-done) |
| 1989 | (isearch-clean-overlays) |
| 1990 | (setq prefix-arg arg)))) |
| 1991 | (t;; otherwise nil |
| 1992 | (isearch-process-search-string key key))))) |
| 1993 | |
| 1994 | (defun isearch-quote-char () |
| 1995 | "Quote special characters for incremental search." |
| 1996 | (interactive) |
| 1997 | (let ((char (read-quoted-char (isearch-message t)))) |
| 1998 | ;; Assume character codes 0200 - 0377 stand for characters in some |
| 1999 | ;; single-byte character set, and convert them to Emacs |
| 2000 | ;; characters. |
| 2001 | (if (and isearch-regexp (= char ?\s)) |
| 2002 | (if (subregexp-context-p isearch-string (length isearch-string)) |
| 2003 | (isearch-process-search-string "[ ]" " ") |
| 2004 | (isearch-process-search-char char)) |
| 2005 | (and enable-multibyte-characters |
| 2006 | (>= char ?\200) |
| 2007 | (<= char ?\377) |
| 2008 | (setq char (unibyte-char-to-multibyte char))) |
| 2009 | (isearch-process-search-char char)))) |
| 2010 | |
| 2011 | (defun isearch-printing-char () |
| 2012 | "Add this ordinary printing character to the search string and search." |
| 2013 | (interactive) |
| 2014 | (let ((char last-command-event)) |
| 2015 | (if (= char ?\S-\ ) |
| 2016 | (setq char ?\s)) |
| 2017 | (if current-input-method |
| 2018 | (isearch-process-search-multibyte-characters char) |
| 2019 | (isearch-process-search-char char)))) |
| 2020 | |
| 2021 | (defun isearch-process-search-char (char) |
| 2022 | ;; * and ? are special in regexps when not preceded by \. |
| 2023 | ;; } and | are special in regexps when preceded by \. |
| 2024 | ;; Nothing special for + because it matches at least once. |
| 2025 | (cond |
| 2026 | ((memq char '(?* ??)) (isearch-fallback nil)) |
| 2027 | ((eq char ?\}) (isearch-fallback t t)) |
| 2028 | ((eq char ?|) (isearch-fallback t nil t))) |
| 2029 | |
| 2030 | ;; Append the char to the search string, update the message and re-search. |
| 2031 | (isearch-process-search-string |
| 2032 | (char-to-string char) |
| 2033 | (if (>= char ?\200) |
| 2034 | (char-to-string char) |
| 2035 | (isearch-text-char-description char)))) |
| 2036 | |
| 2037 | (defun isearch-process-search-string (string message) |
| 2038 | (setq isearch-string (concat isearch-string string) |
| 2039 | isearch-message (concat isearch-message message)) |
| 2040 | (isearch-search-and-update)) |
| 2041 | |
| 2042 | \f |
| 2043 | ;; Search Ring |
| 2044 | |
| 2045 | (defun isearch-ring-adjust1 (advance) |
| 2046 | ;; Helper for isearch-ring-adjust |
| 2047 | (let* ((ring (if isearch-regexp regexp-search-ring search-ring)) |
| 2048 | (length (length ring)) |
| 2049 | (yank-pointer-name (if isearch-regexp |
| 2050 | 'regexp-search-ring-yank-pointer |
| 2051 | 'search-ring-yank-pointer)) |
| 2052 | (yank-pointer (eval yank-pointer-name))) |
| 2053 | (if (zerop length) |
| 2054 | () |
| 2055 | (set yank-pointer-name |
| 2056 | (setq yank-pointer |
| 2057 | (mod (+ (or yank-pointer 0) |
| 2058 | (if advance -1 1)) |
| 2059 | length))) |
| 2060 | (setq isearch-string (nth yank-pointer ring) |
| 2061 | isearch-message (mapconcat 'isearch-text-char-description |
| 2062 | isearch-string ""))))) |
| 2063 | |
| 2064 | (defun isearch-ring-adjust (advance) |
| 2065 | ;; Helper for isearch-ring-advance and isearch-ring-retreat |
| 2066 | (isearch-ring-adjust1 advance) |
| 2067 | (if search-ring-update |
| 2068 | (progn |
| 2069 | (isearch-search) |
| 2070 | (isearch-push-state) |
| 2071 | (isearch-update)) |
| 2072 | ;; Otherwise, edit the search string instead. Note that there is |
| 2073 | ;; no need to push the search state after isearch-edit-string here |
| 2074 | ;; since isearch-edit-string already pushes its state |
| 2075 | (isearch-edit-string))) |
| 2076 | |
| 2077 | (defun isearch-ring-advance () |
| 2078 | "Advance to the next search string in the ring." |
| 2079 | ;; This could be more general to handle a prefix arg, but who would use it. |
| 2080 | (interactive) |
| 2081 | (isearch-ring-adjust 'advance)) |
| 2082 | |
| 2083 | (defun isearch-ring-retreat () |
| 2084 | "Retreat to the previous search string in the ring." |
| 2085 | (interactive) |
| 2086 | (isearch-ring-adjust nil)) |
| 2087 | |
| 2088 | (defun isearch-complete1 () |
| 2089 | ;; Helper for isearch-complete and isearch-complete-edit |
| 2090 | ;; Return t if completion OK, nil if no completion exists. |
| 2091 | (let* ((ring (if isearch-regexp regexp-search-ring search-ring)) |
| 2092 | (completion-ignore-case case-fold-search) |
| 2093 | (completion (try-completion isearch-string ring))) |
| 2094 | (cond |
| 2095 | ((eq completion t) |
| 2096 | ;; isearch-string stays the same |
| 2097 | t) |
| 2098 | ((or completion ; not nil, must be a string |
| 2099 | (= 0 (length isearch-string))) ; shouldn't have to say this |
| 2100 | (if (equal completion isearch-string) ;; no extension? |
| 2101 | (progn |
| 2102 | (if completion-auto-help |
| 2103 | (with-output-to-temp-buffer "*Isearch completions*" |
| 2104 | (display-completion-list |
| 2105 | (all-completions isearch-string ring)))) |
| 2106 | t) |
| 2107 | (and completion |
| 2108 | (setq isearch-string completion)))) |
| 2109 | (t |
| 2110 | (message "No completion") ; waits a second if in minibuffer |
| 2111 | nil)))) |
| 2112 | |
| 2113 | (defun isearch-complete () |
| 2114 | "Complete the search string from the strings on the search ring. |
| 2115 | The completed string is then editable in the minibuffer. |
| 2116 | If there is no completion possible, say so and continue searching." |
| 2117 | (interactive) |
| 2118 | (if (isearch-complete1) |
| 2119 | (progn (setq isearch-message |
| 2120 | (mapconcat 'isearch-text-char-description |
| 2121 | isearch-string "")) |
| 2122 | (isearch-edit-string)) |
| 2123 | ;; else |
| 2124 | (sit-for 1) |
| 2125 | (isearch-update))) |
| 2126 | |
| 2127 | (defun isearch-complete-edit () |
| 2128 | "Same as `isearch-complete' except in the minibuffer." |
| 2129 | (interactive) |
| 2130 | (setq isearch-string (field-string)) |
| 2131 | (if (isearch-complete1) |
| 2132 | (progn |
| 2133 | (delete-field) |
| 2134 | (insert isearch-string)))) |
| 2135 | |
| 2136 | \f |
| 2137 | ;; Message string |
| 2138 | |
| 2139 | (defun isearch-message (&optional c-q-hack ellipsis) |
| 2140 | ;; Generate and print the message string. |
| 2141 | (let ((cursor-in-echo-area ellipsis) |
| 2142 | (m isearch-message) |
| 2143 | (cmds isearch-cmds) |
| 2144 | succ-msg) |
| 2145 | (when (or (not isearch-success) isearch-error) |
| 2146 | ;; Highlight failed part |
| 2147 | (while (or (not (isearch-success-state (car cmds))) |
| 2148 | (isearch-error-state (car cmds))) |
| 2149 | (pop cmds)) |
| 2150 | (setq succ-msg (and cmds (isearch-message-state (car cmds))) |
| 2151 | m (copy-sequence m)) |
| 2152 | (add-text-properties |
| 2153 | (if (and (stringp succ-msg) |
| 2154 | (< (length succ-msg) (length m)) |
| 2155 | (equal succ-msg (substring m 0 (length succ-msg)))) |
| 2156 | (length succ-msg) |
| 2157 | 0) |
| 2158 | (length m) '(face isearch-fail) m) |
| 2159 | ;; Highlight failed trailing whitespace |
| 2160 | (when (string-match " +$" m) |
| 2161 | (add-text-properties (match-beginning 0) (match-end 0) |
| 2162 | '(face trailing-whitespace) m))) |
| 2163 | (setq m (concat |
| 2164 | (isearch-message-prefix c-q-hack ellipsis isearch-nonincremental) |
| 2165 | m |
| 2166 | (isearch-message-suffix c-q-hack ellipsis))) |
| 2167 | (if c-q-hack m (let ((message-log-max nil)) (message "%s" m))))) |
| 2168 | |
| 2169 | (defun isearch-message-prefix (&optional _c-q-hack ellipsis nonincremental) |
| 2170 | ;; If about to search, and previous search regexp was invalid, |
| 2171 | ;; check that it still is. If it is valid now, |
| 2172 | ;; let the message we display while searching say that it is valid. |
| 2173 | (and isearch-error ellipsis |
| 2174 | (condition-case () |
| 2175 | (progn (re-search-forward isearch-string (point) t) |
| 2176 | (setq isearch-error nil)) |
| 2177 | (error nil))) |
| 2178 | ;; If currently failing, display no ellipsis. |
| 2179 | (or isearch-success (setq ellipsis nil)) |
| 2180 | (let ((m (concat (if isearch-success "" "failing ") |
| 2181 | (if isearch-adjusted "pending " "") |
| 2182 | (if (and isearch-wrapped |
| 2183 | (not isearch-wrap-function) |
| 2184 | (if isearch-forward |
| 2185 | (> (point) isearch-opoint) |
| 2186 | (< (point) isearch-opoint))) |
| 2187 | "over") |
| 2188 | (if isearch-wrapped "wrapped ") |
| 2189 | (if isearch-word "word " "") |
| 2190 | (if isearch-regexp "regexp " "") |
| 2191 | (if multi-isearch-next-buffer-current-function "multi " "") |
| 2192 | (or isearch-message-prefix-add "") |
| 2193 | (if nonincremental "search" "I-search") |
| 2194 | (if isearch-forward "" " backward") |
| 2195 | (if current-input-method |
| 2196 | (concat " [" current-input-method-title "]: ") |
| 2197 | ": ") |
| 2198 | ))) |
| 2199 | (propertize (concat (upcase (substring m 0 1)) (substring m 1)) |
| 2200 | 'face 'minibuffer-prompt))) |
| 2201 | |
| 2202 | (defun isearch-message-suffix (&optional c-q-hack _ellipsis) |
| 2203 | (concat (if c-q-hack "^Q" "") |
| 2204 | (if isearch-error |
| 2205 | (concat " [" isearch-error "]") |
| 2206 | "") |
| 2207 | (or isearch-message-suffix-add ""))) |
| 2208 | |
| 2209 | \f |
| 2210 | ;; Searching |
| 2211 | |
| 2212 | (defvar isearch-search-fun-function nil |
| 2213 | "Override `isearch-search-fun'. |
| 2214 | This function should return the search function for Isearch to use. |
| 2215 | It will call this function with three arguments |
| 2216 | as if it were `search-forward'.") |
| 2217 | |
| 2218 | (defun isearch-search-fun () |
| 2219 | "Return the function to use for the search. |
| 2220 | Can be changed via `isearch-search-fun-function' for special needs." |
| 2221 | (if isearch-search-fun-function |
| 2222 | (funcall isearch-search-fun-function) |
| 2223 | (cond |
| 2224 | (isearch-word |
| 2225 | ;; Use lax versions to not fail at the end of the word while |
| 2226 | ;; the user adds and removes characters in the search string |
| 2227 | ;; (or when using nonincremental word isearch) |
| 2228 | (if (or isearch-nonincremental |
| 2229 | (eq (length isearch-string) |
| 2230 | (length (isearch-string-state (car isearch-cmds))))) |
| 2231 | (if isearch-forward 'word-search-forward 'word-search-backward) |
| 2232 | (if isearch-forward 'word-search-forward-lax 'word-search-backward-lax))) |
| 2233 | (isearch-regexp |
| 2234 | (if isearch-forward 're-search-forward 're-search-backward)) |
| 2235 | (t |
| 2236 | (if isearch-forward 'search-forward 'search-backward))))) |
| 2237 | |
| 2238 | (defun isearch-search-string (string bound noerror) |
| 2239 | "Search for the first occurrence of STRING or its translation. |
| 2240 | If found, move point to the end of the occurrence, |
| 2241 | update the match data, and return point." |
| 2242 | (let* ((func (isearch-search-fun)) |
| 2243 | (pos1 (save-excursion (funcall func string bound noerror))) |
| 2244 | pos2) |
| 2245 | (when (and |
| 2246 | ;; Avoid "obsolete" warnings for translation-table-for-input. |
| 2247 | (with-no-warnings |
| 2248 | (char-table-p translation-table-for-input)) |
| 2249 | (multibyte-string-p string) |
| 2250 | ;; Minor optimization. |
| 2251 | (string-match-p "[^[:ascii:]]" string)) |
| 2252 | (let ((translated |
| 2253 | (apply 'string |
| 2254 | (mapcar (lambda (c) |
| 2255 | (or |
| 2256 | ;; Avoid "obsolete" warnings for |
| 2257 | ;; translation-table-for-input. |
| 2258 | (with-no-warnings |
| 2259 | (aref translation-table-for-input c)) |
| 2260 | c)) |
| 2261 | string))) |
| 2262 | match-data) |
| 2263 | (when translated |
| 2264 | (save-match-data |
| 2265 | (save-excursion |
| 2266 | (if (setq pos2 (funcall func translated bound noerror)) |
| 2267 | (setq match-data (match-data t))))) |
| 2268 | (when (and pos2 |
| 2269 | (or (not pos1) |
| 2270 | (if isearch-forward (< pos2 pos1) (> pos2 pos1)))) |
| 2271 | (setq pos1 pos2) |
| 2272 | (set-match-data match-data))))) |
| 2273 | (when pos1 |
| 2274 | ;; When using multiple buffers isearch, switch to the new buffer here, |
| 2275 | ;; because `save-excursion' above doesn't allow doing it inside funcall. |
| 2276 | (if (and multi-isearch-next-buffer-current-function |
| 2277 | (buffer-live-p multi-isearch-current-buffer)) |
| 2278 | (switch-to-buffer multi-isearch-current-buffer)) |
| 2279 | (goto-char pos1) |
| 2280 | pos1))) |
| 2281 | |
| 2282 | (defun isearch-search () |
| 2283 | ;; Do the search with the current search string. |
| 2284 | (if isearch-message-function |
| 2285 | (funcall isearch-message-function nil t) |
| 2286 | (isearch-message nil t)) |
| 2287 | (if (and (eq isearch-case-fold-search t) search-upper-case) |
| 2288 | (setq isearch-case-fold-search |
| 2289 | (isearch-no-upper-case-p isearch-string isearch-regexp))) |
| 2290 | (condition-case lossage |
| 2291 | (let ((inhibit-point-motion-hooks |
| 2292 | (and (eq isearch-filter-predicate 'isearch-filter-visible) |
| 2293 | search-invisible)) |
| 2294 | (inhibit-quit nil) |
| 2295 | (case-fold-search isearch-case-fold-search) |
| 2296 | (search-spaces-regexp search-whitespace-regexp) |
| 2297 | (retry t)) |
| 2298 | (setq isearch-error nil) |
| 2299 | (while retry |
| 2300 | (setq isearch-success |
| 2301 | (isearch-search-string isearch-string nil t)) |
| 2302 | ;; Clear RETRY unless the search predicate says |
| 2303 | ;; to skip this search hit. |
| 2304 | (if (or (not isearch-success) |
| 2305 | (bobp) (eobp) |
| 2306 | (= (match-beginning 0) (match-end 0)) |
| 2307 | (funcall isearch-filter-predicate |
| 2308 | (match-beginning 0) (match-end 0))) |
| 2309 | (setq retry nil))) |
| 2310 | (setq isearch-just-started nil) |
| 2311 | (if isearch-success |
| 2312 | (setq isearch-other-end |
| 2313 | (if isearch-forward (match-beginning 0) (match-end 0))))) |
| 2314 | |
| 2315 | (quit (isearch-unread ?\C-g) |
| 2316 | (setq isearch-success nil)) |
| 2317 | |
| 2318 | (invalid-regexp |
| 2319 | (setq isearch-error (car (cdr lossage))) |
| 2320 | (if (string-match |
| 2321 | "\\`Premature \\|\\`Unmatched \\|\\`Invalid " |
| 2322 | isearch-error) |
| 2323 | (setq isearch-error "incomplete input"))) |
| 2324 | |
| 2325 | (search-failed |
| 2326 | (setq isearch-success nil) |
| 2327 | (setq isearch-error (nth 2 lossage))) |
| 2328 | |
| 2329 | (error |
| 2330 | ;; stack overflow in regexp search. |
| 2331 | (setq isearch-error (format "%s" lossage)))) |
| 2332 | |
| 2333 | (if isearch-success |
| 2334 | nil |
| 2335 | ;; Ding if failed this time after succeeding last time. |
| 2336 | (and (isearch-success-state (car isearch-cmds)) |
| 2337 | (ding)) |
| 2338 | (if (functionp (isearch-pop-fun-state (car isearch-cmds))) |
| 2339 | (funcall (isearch-pop-fun-state (car isearch-cmds)) (car isearch-cmds))) |
| 2340 | (goto-char (isearch-point-state (car isearch-cmds))))) |
| 2341 | |
| 2342 | |
| 2343 | ;; Called when opening an overlay, and we are still in isearch. |
| 2344 | (defun isearch-open-overlay-temporary (ov) |
| 2345 | (if (not (null (overlay-get ov 'isearch-open-invisible-temporary))) |
| 2346 | ;; Some modes would want to open the overlays temporary during |
| 2347 | ;; isearch in their own way, they should set the |
| 2348 | ;; `isearch-open-invisible-temporary' to a function doing this. |
| 2349 | (funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil) |
| 2350 | ;; Store the values for the `invisible' and `intangible' |
| 2351 | ;; properties, and then set them to nil. This way the text hidden |
| 2352 | ;; by this overlay becomes visible. |
| 2353 | |
| 2354 | ;; Do we really need to set the `intangible' property to t? Can we |
| 2355 | ;; have the point inside an overlay with an `intangible' property? |
| 2356 | ;; In 19.34 this does not exist so I cannot test it. |
| 2357 | (overlay-put ov 'isearch-invisible (overlay-get ov 'invisible)) |
| 2358 | (overlay-put ov 'isearch-intangible (overlay-get ov 'intangible)) |
| 2359 | (overlay-put ov 'invisible nil) |
| 2360 | (overlay-put ov 'intangible nil))) |
| 2361 | |
| 2362 | |
| 2363 | ;; This is called at the end of isearch. It will open the overlays |
| 2364 | ;; that contain the latest match. Obviously in case of a C-g the |
| 2365 | ;; point returns to the original location which surely is not contain |
| 2366 | ;; in any of these overlays, se we are safe in this case too. |
| 2367 | (defun isearch-open-necessary-overlays (ov) |
| 2368 | (let ((inside-overlay (and (> (point) (overlay-start ov)) |
| 2369 | (< (point) (overlay-end ov)))) |
| 2370 | ;; If this exists it means that the overlay was opened using |
| 2371 | ;; this function, not by us tweaking the overlay properties. |
| 2372 | (fct-temp (overlay-get ov 'isearch-open-invisible-temporary))) |
| 2373 | (when (or inside-overlay (not fct-temp)) |
| 2374 | ;; restore the values for the `invisible' and `intangible' |
| 2375 | ;; properties |
| 2376 | (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible)) |
| 2377 | (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible)) |
| 2378 | (overlay-put ov 'isearch-invisible nil) |
| 2379 | (overlay-put ov 'isearch-intangible nil)) |
| 2380 | (if inside-overlay |
| 2381 | (funcall (overlay-get ov 'isearch-open-invisible) ov) |
| 2382 | (if fct-temp |
| 2383 | (funcall fct-temp ov t))))) |
| 2384 | |
| 2385 | ;; This is called when exiting isearch. It closes the temporary |
| 2386 | ;; opened overlays, except the ones that contain the latest match. |
| 2387 | (defun isearch-clean-overlays () |
| 2388 | (when isearch-opened-overlays |
| 2389 | (mapc 'isearch-open-necessary-overlays isearch-opened-overlays) |
| 2390 | (setq isearch-opened-overlays nil))) |
| 2391 | |
| 2392 | |
| 2393 | (defun isearch-intersects-p (start0 end0 start1 end1) |
| 2394 | "Return t if regions START0..END0 and START1..END1 intersect." |
| 2395 | (or (and (>= start0 start1) (< start0 end1)) |
| 2396 | (and (> end0 start1) (<= end0 end1)) |
| 2397 | (and (>= start1 start0) (< start1 end0)) |
| 2398 | (and (> end1 start0) (<= end1 end0)))) |
| 2399 | |
| 2400 | |
| 2401 | ;; Verify if the current match is outside of each element of |
| 2402 | ;; `isearch-opened-overlays', if so close that overlay. |
| 2403 | |
| 2404 | (defun isearch-close-unnecessary-overlays (begin end) |
| 2405 | (let ((overlays isearch-opened-overlays)) |
| 2406 | (setq isearch-opened-overlays nil) |
| 2407 | (dolist (ov overlays) |
| 2408 | (if (isearch-intersects-p begin end (overlay-start ov) (overlay-end ov)) |
| 2409 | (push ov isearch-opened-overlays) |
| 2410 | (let ((fct-temp (overlay-get ov 'isearch-open-invisible-temporary))) |
| 2411 | (if fct-temp |
| 2412 | ;; If this exists it means that the overlay was opened |
| 2413 | ;; using this function, not by us tweaking the overlay |
| 2414 | ;; properties. |
| 2415 | (funcall fct-temp ov t) |
| 2416 | (overlay-put ov 'invisible (overlay-get ov 'isearch-invisible)) |
| 2417 | (overlay-put ov 'intangible (overlay-get ov 'isearch-intangible)) |
| 2418 | (overlay-put ov 'isearch-invisible nil) |
| 2419 | (overlay-put ov 'isearch-intangible nil))))))) |
| 2420 | |
| 2421 | |
| 2422 | (defun isearch-range-invisible (beg end) |
| 2423 | "Return t if all the text from BEG to END is invisible." |
| 2424 | (when (/= beg end) |
| 2425 | ;; Check that invisibility runs up to END. |
| 2426 | (save-excursion |
| 2427 | (goto-char beg) |
| 2428 | (let (;; can-be-opened keeps track if we can open some overlays. |
| 2429 | (can-be-opened (eq search-invisible 'open)) |
| 2430 | ;; the list of overlays that could be opened |
| 2431 | (crt-overlays nil)) |
| 2432 | (when (and can-be-opened isearch-hide-immediately) |
| 2433 | (isearch-close-unnecessary-overlays beg end)) |
| 2434 | ;; If the following character is currently invisible, |
| 2435 | ;; skip all characters with that same `invisible' property value. |
| 2436 | ;; Do that over and over. |
| 2437 | (while (and (< (point) end) (invisible-p (point))) |
| 2438 | (if (get-text-property (point) 'invisible) |
| 2439 | (progn |
| 2440 | (goto-char (next-single-property-change (point) 'invisible |
| 2441 | nil end)) |
| 2442 | ;; if text is hidden by an `invisible' text property |
| 2443 | ;; we cannot open it at all. |
| 2444 | (setq can-be-opened nil)) |
| 2445 | (when can-be-opened |
| 2446 | (let ((overlays (overlays-at (point))) |
| 2447 | ov-list |
| 2448 | o |
| 2449 | invis-prop) |
| 2450 | (while overlays |
| 2451 | (setq o (car overlays) |
| 2452 | invis-prop (overlay-get o 'invisible)) |
| 2453 | (if (invisible-p invis-prop) |
| 2454 | (if (overlay-get o 'isearch-open-invisible) |
| 2455 | (setq ov-list (cons o ov-list)) |
| 2456 | ;; We found one overlay that cannot be |
| 2457 | ;; opened, that means the whole chunk |
| 2458 | ;; cannot be opened. |
| 2459 | (setq can-be-opened nil))) |
| 2460 | (setq overlays (cdr overlays))) |
| 2461 | (if can-be-opened |
| 2462 | ;; It makes sense to append to the open |
| 2463 | ;; overlays list only if we know that this is |
| 2464 | ;; t. |
| 2465 | (setq crt-overlays (append ov-list crt-overlays))))) |
| 2466 | (goto-char (next-overlay-change (point))))) |
| 2467 | ;; See if invisibility reaches up thru END. |
| 2468 | (if (>= (point) end) |
| 2469 | (if (and can-be-opened (consp crt-overlays)) |
| 2470 | (progn |
| 2471 | (setq isearch-opened-overlays |
| 2472 | (append isearch-opened-overlays crt-overlays)) |
| 2473 | (mapc 'isearch-open-overlay-temporary crt-overlays) |
| 2474 | nil) |
| 2475 | (setq isearch-hidden t))))))) |
| 2476 | |
| 2477 | (defun isearch-filter-visible (beg end) |
| 2478 | "Test whether the current search hit is visible at least partially. |
| 2479 | Return non-nil if the text from BEG to END is visible to Isearch as |
| 2480 | determined by `isearch-range-invisible' unless invisible text can be |
| 2481 | searched too when `search-invisible' is t." |
| 2482 | (or (eq search-invisible t) |
| 2483 | (not (isearch-range-invisible beg end)))) |
| 2484 | |
| 2485 | \f |
| 2486 | ;; General utilities |
| 2487 | |
| 2488 | (defun isearch-no-upper-case-p (string regexp-flag) |
| 2489 | "Return t if there are no upper case chars in STRING. |
| 2490 | If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\') |
| 2491 | since they have special meaning in a regexp." |
| 2492 | (let (quote-flag (i 0) (len (length string)) found) |
| 2493 | (while (and (not found) (< i len)) |
| 2494 | (let ((char (aref string i))) |
| 2495 | (if (and regexp-flag (eq char ?\\)) |
| 2496 | (setq quote-flag (not quote-flag)) |
| 2497 | (if (and (not quote-flag) (not (eq char (downcase char)))) |
| 2498 | (setq found t)) |
| 2499 | (setq quote-flag nil))) |
| 2500 | (setq i (1+ i))) |
| 2501 | (not (or found |
| 2502 | ;; Even if there's no uppercase char, we want to detect the use |
| 2503 | ;; of [:upper:] or [:lower:] char-class, which indicates |
| 2504 | ;; clearly that the user cares about case distinction. |
| 2505 | (and regexp-flag (string-match "\\[:\\(upp\\|low\\)er:]" string) |
| 2506 | (condition-case err |
| 2507 | (progn |
| 2508 | (string-match (substring string 0 (match-beginning 0)) |
| 2509 | "") |
| 2510 | nil) |
| 2511 | (invalid-regexp |
| 2512 | (equal "Unmatched [ or [^" (cadr err))))))))) |
| 2513 | |
| 2514 | ;; Portability functions to support various Emacs versions. |
| 2515 | |
| 2516 | (defun isearch-text-char-description (c) |
| 2517 | (cond |
| 2518 | ((< c ?\s) (propertize (format "^%c" (+ c 64)) 'face 'escape-glyph)) |
| 2519 | ((= c ?\^?) (propertize "^?" 'face 'escape-glyph)) |
| 2520 | (t (char-to-string c)))) |
| 2521 | |
| 2522 | ;; General function to unread characters or events. |
| 2523 | ;; Also insert them in a keyboard macro being defined. |
| 2524 | (defun isearch-unread (&rest char-or-events) |
| 2525 | (mapc 'store-kbd-macro-event char-or-events) |
| 2526 | (setq unread-command-events |
| 2527 | (append char-or-events unread-command-events))) |
| 2528 | |
| 2529 | \f |
| 2530 | ;; Highlighting |
| 2531 | |
| 2532 | (defvar isearch-overlay nil) |
| 2533 | |
| 2534 | (defun isearch-highlight (beg end) |
| 2535 | (if search-highlight |
| 2536 | (if isearch-overlay |
| 2537 | ;; Overlay already exists, just move it. |
| 2538 | (move-overlay isearch-overlay beg end (current-buffer)) |
| 2539 | ;; Overlay doesn't exist, create it. |
| 2540 | (setq isearch-overlay (make-overlay beg end)) |
| 2541 | ;; 1001 is higher than lazy's 1000 and ediff's 100+ |
| 2542 | (overlay-put isearch-overlay 'priority 1001) |
| 2543 | (overlay-put isearch-overlay 'face isearch-face)))) |
| 2544 | |
| 2545 | (defun isearch-dehighlight () |
| 2546 | (when isearch-overlay |
| 2547 | (delete-overlay isearch-overlay))) |
| 2548 | \f |
| 2549 | ;; isearch-lazy-highlight feature |
| 2550 | ;; by Bob Glickstein <http://www.zanshin.com/~bobg/> |
| 2551 | |
| 2552 | ;; When active, *every* match for the current search string is |
| 2553 | ;; highlighted: the current one using the normal isearch match color |
| 2554 | ;; and all the others using `isearch-lazy-highlight'. The extra |
| 2555 | ;; highlighting makes it easier to anticipate where the cursor will |
| 2556 | ;; land each time you press C-s or C-r to repeat a pending search. |
| 2557 | ;; Highlighting of these additional matches happens in a deferred |
| 2558 | ;; fashion using "idle timers," so the cycles needed do not rob |
| 2559 | ;; isearch of its usual snappy response. |
| 2560 | |
| 2561 | ;; IMPLEMENTATION NOTE: This depends on some isearch internals. |
| 2562 | ;; Specifically: |
| 2563 | ;; - `isearch-update' is expected to be called (at least) every time |
| 2564 | ;; the search string or window-start changes; |
| 2565 | ;; - `isearch-string' is expected to contain the current search |
| 2566 | ;; string as entered by the user; |
| 2567 | ;; - the type of the current search is expected to be given by |
| 2568 | ;; `isearch-word' and `isearch-regexp'; |
| 2569 | ;; - the direction of the current search is expected to be given by |
| 2570 | ;; `isearch-forward'; |
| 2571 | ;; - the variable `isearch-error' is expected to be true |
| 2572 | ;; only if `isearch-string' is an invalid regexp. |
| 2573 | |
| 2574 | (defvar isearch-lazy-highlight-overlays nil) |
| 2575 | (defvar isearch-lazy-highlight-wrapped nil) |
| 2576 | (defvar isearch-lazy-highlight-start-limit nil) |
| 2577 | (defvar isearch-lazy-highlight-end-limit nil) |
| 2578 | (defvar isearch-lazy-highlight-start nil) |
| 2579 | (defvar isearch-lazy-highlight-end nil) |
| 2580 | (defvar isearch-lazy-highlight-timer nil) |
| 2581 | (defvar isearch-lazy-highlight-last-string nil) |
| 2582 | (defvar isearch-lazy-highlight-window nil) |
| 2583 | (defvar isearch-lazy-highlight-window-start nil) |
| 2584 | (defvar isearch-lazy-highlight-window-end nil) |
| 2585 | (defvar isearch-lazy-highlight-case-fold-search nil) |
| 2586 | (defvar isearch-lazy-highlight-regexp nil) |
| 2587 | (defvar isearch-lazy-highlight-space-regexp nil) |
| 2588 | (defvar isearch-lazy-highlight-forward nil) |
| 2589 | (defvar isearch-lazy-highlight-error nil) |
| 2590 | |
| 2591 | (defun lazy-highlight-cleanup (&optional force) |
| 2592 | "Stop lazy highlighting and remove extra highlighting from current buffer. |
| 2593 | FORCE non-nil means do it whether or not `lazy-highlight-cleanup' |
| 2594 | is nil. This function is called when exiting an incremental search if |
| 2595 | `lazy-highlight-cleanup' is non-nil." |
| 2596 | (interactive '(t)) |
| 2597 | (if (or force lazy-highlight-cleanup) |
| 2598 | (while isearch-lazy-highlight-overlays |
| 2599 | (delete-overlay (car isearch-lazy-highlight-overlays)) |
| 2600 | (setq isearch-lazy-highlight-overlays |
| 2601 | (cdr isearch-lazy-highlight-overlays)))) |
| 2602 | (when isearch-lazy-highlight-timer |
| 2603 | (cancel-timer isearch-lazy-highlight-timer) |
| 2604 | (setq isearch-lazy-highlight-timer nil))) |
| 2605 | |
| 2606 | (define-obsolete-function-alias 'isearch-lazy-highlight-cleanup |
| 2607 | 'lazy-highlight-cleanup |
| 2608 | "22.1") |
| 2609 | |
| 2610 | (defun isearch-lazy-highlight-new-loop (&optional beg end) |
| 2611 | "Cleanup any previous `lazy-highlight' loop and begin a new one. |
| 2612 | BEG and END specify the bounds within which highlighting should occur. |
| 2613 | This is called when `isearch-update' is invoked (which can cause the |
| 2614 | search string to change or the window to scroll). It is also used |
| 2615 | by other Emacs features." |
| 2616 | (when (and (null executing-kbd-macro) |
| 2617 | (sit-for 0) ;make sure (window-start) is credible |
| 2618 | (or (not (equal isearch-string |
| 2619 | isearch-lazy-highlight-last-string)) |
| 2620 | (not (eq (selected-window) |
| 2621 | isearch-lazy-highlight-window)) |
| 2622 | (not (eq isearch-lazy-highlight-case-fold-search |
| 2623 | isearch-case-fold-search)) |
| 2624 | (not (eq isearch-lazy-highlight-regexp |
| 2625 | isearch-regexp)) |
| 2626 | (not (= (window-start) |
| 2627 | isearch-lazy-highlight-window-start)) |
| 2628 | (not (= (window-end) ; Window may have been split/joined. |
| 2629 | isearch-lazy-highlight-window-end)) |
| 2630 | (not (eq isearch-forward |
| 2631 | isearch-lazy-highlight-forward)) |
| 2632 | ;; In case we are recovering from an error. |
| 2633 | (not (equal isearch-error |
| 2634 | isearch-lazy-highlight-error)))) |
| 2635 | ;; something important did indeed change |
| 2636 | (lazy-highlight-cleanup t) ;kill old loop & remove overlays |
| 2637 | (setq isearch-lazy-highlight-error isearch-error) |
| 2638 | (when (not isearch-error) |
| 2639 | (setq isearch-lazy-highlight-start-limit beg |
| 2640 | isearch-lazy-highlight-end-limit end) |
| 2641 | (setq isearch-lazy-highlight-window (selected-window) |
| 2642 | isearch-lazy-highlight-window-start (window-start) |
| 2643 | isearch-lazy-highlight-window-end (window-end) |
| 2644 | isearch-lazy-highlight-start (point) |
| 2645 | isearch-lazy-highlight-end (point) |
| 2646 | isearch-lazy-highlight-last-string isearch-string |
| 2647 | isearch-lazy-highlight-case-fold-search isearch-case-fold-search |
| 2648 | isearch-lazy-highlight-regexp isearch-regexp |
| 2649 | isearch-lazy-highlight-wrapped nil |
| 2650 | isearch-lazy-highlight-space-regexp search-whitespace-regexp |
| 2651 | isearch-lazy-highlight-forward isearch-forward) |
| 2652 | (unless (equal isearch-string "") |
| 2653 | (setq isearch-lazy-highlight-timer |
| 2654 | (run-with-idle-timer lazy-highlight-initial-delay nil |
| 2655 | 'isearch-lazy-highlight-update)))))) |
| 2656 | |
| 2657 | (defun isearch-lazy-highlight-search () |
| 2658 | "Search ahead for the next or previous match, for lazy highlighting. |
| 2659 | Attempt to do the search exactly the way the pending Isearch would." |
| 2660 | (condition-case nil |
| 2661 | (let ((case-fold-search isearch-lazy-highlight-case-fold-search) |
| 2662 | (isearch-regexp isearch-lazy-highlight-regexp) |
| 2663 | (search-spaces-regexp isearch-lazy-highlight-space-regexp) |
| 2664 | (search-invisible nil) ; don't match invisible text |
| 2665 | (retry t) |
| 2666 | (success nil) |
| 2667 | (isearch-forward isearch-lazy-highlight-forward) |
| 2668 | (bound (if isearch-lazy-highlight-forward |
| 2669 | (min (or isearch-lazy-highlight-end-limit (point-max)) |
| 2670 | (if isearch-lazy-highlight-wrapped |
| 2671 | isearch-lazy-highlight-start |
| 2672 | (window-end))) |
| 2673 | (max (or isearch-lazy-highlight-start-limit (point-min)) |
| 2674 | (if isearch-lazy-highlight-wrapped |
| 2675 | isearch-lazy-highlight-end |
| 2676 | (window-start)))))) |
| 2677 | ;; Use a loop like in `isearch-search'. |
| 2678 | (while retry |
| 2679 | (setq success (isearch-search-string |
| 2680 | isearch-lazy-highlight-last-string bound t)) |
| 2681 | ;; Clear RETRY unless the search predicate says |
| 2682 | ;; to skip this search hit. |
| 2683 | (if (or (not success) |
| 2684 | (= (point) bound) ; like (bobp) (eobp) in `isearch-search'. |
| 2685 | (= (match-beginning 0) (match-end 0)) |
| 2686 | (funcall isearch-filter-predicate |
| 2687 | (match-beginning 0) (match-end 0))) |
| 2688 | (setq retry nil))) |
| 2689 | success) |
| 2690 | (error nil))) |
| 2691 | |
| 2692 | (defun isearch-lazy-highlight-update () |
| 2693 | "Update highlighting of other matches for current search." |
| 2694 | (let ((max lazy-highlight-max-at-a-time) |
| 2695 | (looping t) |
| 2696 | nomore) |
| 2697 | (with-local-quit |
| 2698 | (save-selected-window |
| 2699 | (if (and (window-live-p isearch-lazy-highlight-window) |
| 2700 | (not (eq (selected-window) isearch-lazy-highlight-window))) |
| 2701 | (select-window isearch-lazy-highlight-window)) |
| 2702 | (save-excursion |
| 2703 | (save-match-data |
| 2704 | (goto-char (if isearch-lazy-highlight-forward |
| 2705 | isearch-lazy-highlight-end |
| 2706 | isearch-lazy-highlight-start)) |
| 2707 | (while looping |
| 2708 | (let ((found (isearch-lazy-highlight-search))) |
| 2709 | (when max |
| 2710 | (setq max (1- max)) |
| 2711 | (if (<= max 0) |
| 2712 | (setq looping nil))) |
| 2713 | (if found |
| 2714 | (let ((mb (match-beginning 0)) |
| 2715 | (me (match-end 0))) |
| 2716 | (if (= mb me) ;zero-length match |
| 2717 | (if isearch-lazy-highlight-forward |
| 2718 | (if (= mb (if isearch-lazy-highlight-wrapped |
| 2719 | isearch-lazy-highlight-start |
| 2720 | (window-end))) |
| 2721 | (setq found nil) |
| 2722 | (forward-char 1)) |
| 2723 | (if (= mb (if isearch-lazy-highlight-wrapped |
| 2724 | isearch-lazy-highlight-end |
| 2725 | (window-start))) |
| 2726 | (setq found nil) |
| 2727 | (forward-char -1))) |
| 2728 | |
| 2729 | ;; non-zero-length match |
| 2730 | (let ((ov (make-overlay mb me))) |
| 2731 | (push ov isearch-lazy-highlight-overlays) |
| 2732 | ;; 1000 is higher than ediff's 100+, |
| 2733 | ;; but lower than isearch main overlay's 1001 |
| 2734 | (overlay-put ov 'priority 1000) |
| 2735 | (overlay-put ov 'face lazy-highlight-face) |
| 2736 | (overlay-put ov 'window (selected-window)))) |
| 2737 | (if isearch-lazy-highlight-forward |
| 2738 | (setq isearch-lazy-highlight-end (point)) |
| 2739 | (setq isearch-lazy-highlight-start (point))))) |
| 2740 | |
| 2741 | ;; not found or zero-length match at the search bound |
| 2742 | (if (not found) |
| 2743 | (if isearch-lazy-highlight-wrapped |
| 2744 | (setq looping nil |
| 2745 | nomore t) |
| 2746 | (setq isearch-lazy-highlight-wrapped t) |
| 2747 | (if isearch-lazy-highlight-forward |
| 2748 | (progn |
| 2749 | (setq isearch-lazy-highlight-end (window-start)) |
| 2750 | (goto-char (max (or isearch-lazy-highlight-start-limit (point-min)) |
| 2751 | (window-start)))) |
| 2752 | (setq isearch-lazy-highlight-start (window-end)) |
| 2753 | (goto-char (min (or isearch-lazy-highlight-end-limit (point-max)) |
| 2754 | (window-end)))))))) |
| 2755 | (unless nomore |
| 2756 | (setq isearch-lazy-highlight-timer |
| 2757 | (run-at-time lazy-highlight-interval nil |
| 2758 | 'isearch-lazy-highlight-update))))))))) |
| 2759 | |
| 2760 | (defun isearch-resume (string regexp word forward message case-fold) |
| 2761 | "Resume an incremental search. |
| 2762 | STRING is the string or regexp searched for. |
| 2763 | REGEXP non-nil means the resumed search was a regexp search. |
| 2764 | WORD non-nil means resume a word search. |
| 2765 | FORWARD non-nil means resume a forward search. |
| 2766 | MESSAGE is the echo-area message recorded for the search resumed. |
| 2767 | CASE-FOLD non-nil means the search was case-insensitive." |
| 2768 | (isearch-mode forward regexp nil nil word) |
| 2769 | (setq isearch-string string |
| 2770 | isearch-message message |
| 2771 | isearch-case-fold-search case-fold) |
| 2772 | (isearch-search) |
| 2773 | (isearch-update)) |
| 2774 | |
| 2775 | ;;; isearch.el ends here |