| blob | ee7a1b0447610e07de6ead9af45fc3fadbad55fc |
1 ;;; isearch.el --- incremental search commands
3 ;; Copyright (C) 1985, 1986 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 ;;; Code:
26 Last string search for by a non-regexp search command.
27 This does not include direct calls to the primitive search functions,
31 Last string searched for by a regexp search command.
32 This does not include direct calls to the primitive search functions,
59 *Number of lines in slow search display windows.
60 These are the short windows used during incremental search on slow terminals.
61 Negative means put the slow search window at the top (normally it's at bottom)
66 This is the style where a one-line window is created to show the line
70 "*Non-nil means an upper-case letter as search input means case-sensitive.
71 Any upper-case letter given explicitly as input to the incremental search
72 has the effect of turning off `case-fold-search' for the rest of this search.
79 "List of recent non-regexp incremental searches.
83 "List of recent regexp incremental searches.
93 "The tail of the regular expression search ring whose car is the last
98 "Do incremental search forward.
99 As you type characters, they add to the search string and are found.
100 Type Delete to cancel characters from end of search string.
101 Type RET to exit, leaving point at location found.
102 Type C-s to search again forward, C-r to search again backward.
103 Type C-w to yank word from buffer onto end of search string and search for it.
104 Type C-y to yank rest of line onto end of search string, etc.
105 Type C-q to quote control character to search for it.
106 Other control and meta characters terminate the search
107 and are then executed normally.
108 The above special characters are mostly controlled by parameters;
109 do M-x apropos on search-.*-char to find them.
110 C-g while searching or when search has failed
111 cancels input back to what has been found successfully.
112 C-g when search is successful aborts and moves point to starting point."
118 "Do incremental search forward for regular expression.
119 Like ordinary incremental search except that your input
126 "Do incremental search backward.
133 "Do incremental search backward for regular expression.
134 Like ordinary incremental search except that your input
141 ;; This function does all the work of incremental search.
142 ;; The functions attached to ^R and ^S are trivial,
143 ;; merely calling this one, but they are always loaded by default
144 ;; whereas this file can optionally be autoloadable.
145 ;; This is the only entry point in this file.
147 ;; OP-FUN is a function to be called after each input character is processed.
148 ;; (It is not called after characters that exit the search.)
153 ;; List of previous states during this search.
155 ;; t means search is currently successful.
157 ;; Set once the search has wrapped around the end of the buffer.
159 ;; Nominal starting point for searching
160 ;; Usually this is the same as the opoint,
161 ;; but it is changed by wrapping
162 ;; and also by repeating the search.
164 ;; Set temporarily when adding a character to a regexp
165 ;; enables it to match more rather than fewer places in the buffer.
166 liberalized
167 ;; Set temporarily by yanking text into the search string.
168 yank-flag
170 ;; non-nil means an explicit uppercase letter seen in the input
172 ;; Non-nil means start using a small window
173 ;; if the search moves outside what is currently on the frame.
177 ;; t means a small window is currently in use.
179 ;; These variables preserve information from the small window
180 ;; through exit from the save-window-excursion.
183 ;; Point is at one end of the last match.
184 ;; This variable records the other end of that match.
186 ;; Value of point at start of search,
187 ;; for moving the cursor back on quitting.
190 ;; The frame we're working on; if this changes, we exit isearch.
221 ?\C-g
228 search-exit-option)
232 ;; If the user switches to a different frame, exit.
238 ;; RET means exit search normally.
239 ;; Except, if first thing typed, it means do nonincremental
244 ;; ^G means the user tried to quit.
248 ;; If search is successful, move back to starting point
249 ;; and really do quit.
252 ;; If search is failing, rub out until it is once more
253 ;; successful.
258 ;; C-s in forward or C-r in reverse.
260 ;; If search string is empty, use last one.
262 ;; If already have what to search for, repeat it.
266 ;; C-s in reverse or C-r in forward, change direction.
272 ;; If repeating a search that found an empty string,
273 ;; ensure we advance. Test history to make sure we
274 ;; actually have done a search already; otherwise,
275 ;; the match data will be random.
282 ;; Rubout means discard last input item and move point
283 ;; back. If buffer is empty, just beep.
292 ()
295 length)
296 regexp-search-ring))
300 ()
303 length)
304 search-ring))
313 ()
317 length)
318 regexp-search-ring))
322 ()
326 length)
327 search-ring))
334 ;; ^W means gobble next word from buffer.
335 ;; ^Y means gobble rest of line from buffer.
349 search-message
353 ;; Don't move cursor in reverse search.
354 yank-flag t)))
355 ;; Any other control char =>
356 ;; unread it and exit the search normally.
366 ;; Any other character => add it to the
367 ;; search string and search.
372 ;; RET translates to newline.
381 ;; unsuccessful regexp search may become
382 ;; successful by addition of characters which
383 ;; make search-string valid
385 nil
386 ;; Check for chars that can make a regexp more liberal.
387 ;; They can make a regexp match sooner
388 ;; or make it succeed instead of failing.
389 ;; So go back to place last successful search started
390 ;; or to the last ^S/^R (barrier), whichever is nearer.
393 ;; Don't treat *, ? as special
394 ;; within [] or after \.
397 ;; This used to use element 2
398 ;; in a reverse search, but it seems that 5
399 ;; (which is the end of the old match)
400 ;; is better in that case too.
403 ;; (car history) is after last search;
404 ;; (car (cdr history)) is from before it.
413 ;; Turn off case-sensitivity if string requests it.
417 search-upper-case)))))
418 ;; In reverse search, adding stuff at
419 ;; the end may cause zero or many more chars to be
420 ;; matched, in the string following point.
421 ;; Allow all those possibilities without moving point as
422 ;; long as the match does not extend past search origin.
429 ;; Used to have (min opoint barrier)
430 ;; instead of barrier.
431 ;; This lost when wrapping.
435 ;; Not regexp, not reverse, or no match at point.
438 ;; Used to have opoint inside the min.
439 ;; This lost when wrapping.
450 regexp-search-ring)
451 regexp-search-ring-yank-pointer regexp-search-ring)
457 search-ring)
458 search-ring-yank-pointer search-ring)
461 ;; If we displayed a single-line window, set point in this window.
464 ;; If there was movement, mark the starting position.
465 ;; Maybe should test difference between and set mark iff > threshold.
470 ;; Exiting the save-window-excursion clobbers this; restore it.
474 ;; If about to search, and previous search regexp was invalid,
475 ;; check that it still is. If it is valid now,
476 ;; let the message we display while searching say that it is valid.
482 ;; If currently failing, display no ellipsis.
490 "I-search"
492 search-message
501 ;; Get the search string from the "front" of the ring of previous searches.
506 ;; ELT describes the most recent search or where we have rotated the ring.
511 ;; Let's give this one the benefit of the doubt.
531 success forward other-end invalid-regexp
532 wrapped barrier uppercase-flag)
533 history)))
539 search-upper-case)))))
549 search-string nil t))
557 invalid-regexp)
560 nil
561 ;; Ding if failed this time after succeeding last time.
566 ;; This is called from incremental-search
567 ;; if the first input character is the exit character.
568 ;; The interactive-arg-reader uses free variables `forward' and `regexp'
569 ;; which are bound by `incremental-search'.
571 ;; We store the search string in `search-string'
572 ;; which has been bound already by `incremental-search'
573 ;; so that, when we exit, it is copied into `search-last-string'.
578 ;; Prompt assuming not word search,
584 ;; Read 1 char and switch to word search if it is ^W.
588 ;; Otherwise let that 1 char be part of the search string.
596 ;; Read the search string with corrected prompt.
598 ;; Empty means use default.
601 ;; Set last search string now so it is set even if we fail.
603 ;; Since we used the minibuffer, we should be available for redo.
605 ;; Go ahead and search.
608 ;;; isearch.el ends here