| blob | 2c7ad19ea3b94a4f1987e6236a89fd405a1d5f0b |
1 ;;; replace.el --- replace commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2014 Free
4 ;; Software Foundation, Inc.
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This package supplies the string and regular-expression replace functions
27 ;; documented in the Emacs user's manual.
29 ;;; Code:
32 "Non-nil means `query-replace' should preserve case in replacements."
37 "Non-nil means `query-replace' matches a sequence of whitespace chars.
38 When you enter a space or spaces in the strings to be replaced,
39 it will match any sequence matched by the regexp `search-whitespace-regexp'."
45 "Non-nil means `query-replace-regexp' matches a sequence of whitespace chars.
46 When you enter a space or spaces in the regexps to be replaced,
47 it will match any sequence matched by the regexp `search-whitespace-regexp'."
53 "Default history list for query-replace commands.
54 See `query-replace-from-history-variable' and
58 "Default values of FROM-STRING and TO-STRING for `query-replace'.
59 This is a list of cons cells (FROM-STRING . TO-STRING), or nil
63 "Non-nil means `query-replace' uses the last search string.
66 "use `M-n' to pull the last incremental search string
67 to the minibuffer that reads the string to replace, or invoke replacements
76 "String that separates FROM and TO in the history of replacement pairs."
82 "History list to use for the FROM argument of `query-replace' commands.
83 The value of this variable should be a symbol; that symbol
84 is used as a variable to hold a history list for the strings
85 or patterns to be replaced."
91 "History list to use for the TO argument of `query-replace' commands.
92 The value of this variable should be a symbol; that symbol
93 is used as a variable to hold a history list for replacement
94 strings or patterns."
100 "Non-nil means `query-replace' and friends ignore read-only matches."
106 "Non-nil means to show what actual replacement text will be."
112 "Non-nil means to highlight matches during query replacement."
117 "Controls the lazy-highlighting during query replacements.
118 When non-nil, all text in the buffer matching the current match
119 is highlighted lazily using isearch lazy highlighting (see
120 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
128 "Face for highlighting query replacement matches."
133 "Number of replacements done so far.
140 "Query and return the `from' argument of a query-replace operation.
141 The return value can also be a pair (FROM . TO) indicating that the user
142 wants to replace FROM with TO."
150 'display query-replace-from-to-separator
157 separator
159 query-replace-defaults))
167 ;; The save-excursion here is in case the user marks and copies
168 ;; a region in order to specify the minibuffer input.
169 ;; That should not clobber the region for the query-replace itself.
174 prompt nil nil nil 'query-replace-from-to-history
187 ;; Warn if user types \n or \t, but don't reject the input.
198 from
204 "Maybe convert a regexp replacement TO to Lisp.
205 Returns a list suitable for `perform-replace' if necessary,
206 the original string if not."
222 ;; Swallow a space after a symbol
223 ;; if there is a space.
225 ;; Swallow a space after 'foo
226 ;; but not after (quote foo).
241 to))
245 "Query and return the `to' argument of a query-replace operation."
251 nil nil nil
252 query-replace-to-history-variable from t)))
255 to))
256 regexp-flag))
269 "Replace some occurrences of FROM-STRING with TO-STRING.
270 As each match is found, the user must type a character saying
273 In Transient Mark mode, if the mark is active, operate on the contents
274 of the region. Otherwise, operate from point to the end of the buffer.
277 to pull the last incremental search string to the minibuffer
278 that reads FROM-STRING, or invoke replacements from
279 incremental search with a key sequence like `C-s C-s M-%'
280 to use its current search string as the string to replace.
282 Matching is independent of case if `case-fold-search' is non-nil and
283 FROM-STRING has no uppercase letters. Replacement transfers the case
284 pattern of the old text to the new text, if `case-replace' and
285 `case-fold-search' are non-nil and FROM-STRING has no uppercase
286 letters. (Transferring the case pattern means that if the old text
287 matched is all caps, or capitalized, then its replacement is upcased
288 or capitalized.)
290 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
291 ignore hidden matches if `search-invisible' is nil, and ignore more
292 matches using `isearch-filter-predicate'.
294 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
295 to be replaced will match a sequence of whitespace chars defined by the
296 regexp in `search-whitespace-regexp'.
298 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
299 only matches surrounded by word boundaries. A negative prefix arg means
300 replace backward.
302 Fourth and fifth arg START and END specify the region to operate on.
304 To customize possible responses, change the bindings in `query-replace-map'."
313 nil)))
315 ;; These are done separately here
316 ;; so that command-history will record these expressions
317 ;; rather than the values they had this time.
328 "Replace some things after point matching REGEXP with TO-STRING.
329 As each match is found, the user must type a character saying
332 In Transient Mark mode, if the mark is active, operate on the contents
333 of the region. Otherwise, operate from point to the end of the buffer.
336 to pull the last incremental search regexp to the minibuffer
337 that reads REGEXP, or invoke replacements from
338 incremental search with a key sequence like `C-M-s C-M-s C-M-%'
339 to use its current search regexp as the regexp to replace.
341 Matching is independent of case if `case-fold-search' is non-nil and
342 REGEXP has no uppercase letters. Replacement transfers the case
343 pattern of the old text to the new text, if `case-replace' and
344 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
345 \(Transferring the case pattern means that if the old text matched is
346 all caps, or capitalized, then its replacement is upcased or
347 capitalized.)
349 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
350 ignore hidden matches if `search-invisible' is nil, and ignore more
351 matches using `isearch-filter-predicate'.
353 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
354 to be replaced will match a sequence of whitespace chars defined by the
355 regexp in `search-whitespace-regexp'.
357 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
358 only matches surrounded by word boundaries. A negative prefix arg means
359 replace backward.
361 Fourth and fifth arg START and END specify the region to operate on.
367 at the given position for each replacement.
370 followed by a Lisp expression. Each
371 replacement evaluates that expression to compute the replacement
374 for the whole or a partial match converted to a number with
376 done so far (starting with zero).
378 If the replacement expression is a symbol, write a space after it
379 to terminate it. One space there, if any, will be discarded.
381 When using those Lisp features interactively in the replacement
382 text, TO-STRING is actually made a list instead of a string.
391 " regexp"
393 t)))
395 ;; These are done separately here
396 ;; so that command-history will record these expressions
397 ;; rather than the values they had this time.
408 "Replace some things after point matching REGEXP with the result of TO-EXPR.
410 Interactive use of this function is deprecated in favor of the
412 using `search-forward-regexp' and `replace-match' is preferred.
414 As each match is found, the user must type a character saying
417 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
418 reference `replace-count' to get the number of replacements already made.
419 If the result of TO-EXPR is not a string, it is converted to one using
420 `prin1-to-string' with the NOESCAPE argument (which see).
428 In Transient Mark mode, if the mark is active, operate on the contents
429 of the region. Otherwise, operate from point to the end of the buffer.
432 to pull the last incremental search regexp to the minibuffer
433 that reads REGEXP.
435 Preserves case in each replacement if `case-replace' and `case-fold-search'
436 are non-nil and REGEXP has no uppercase letters.
438 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
439 ignore hidden matches if `search-invisible' is nil, and ignore more
440 matches using `isearch-filter-predicate'.
442 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
443 to be replaced will match a sequence of whitespace chars defined by the
444 regexp in `search-whitespace-regexp'.
446 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
447 only matches that are surrounded by word boundaries.
448 Fourth and fifth arg START and END specify the region to operate on."
450 for interactive calls, and `search-forward-regexp'/`replace-match'
456 ;; Let-bind the history var to disable the "foo -> bar"
457 ;; default. Maybe we shouldn't disable this default, but
458 ;; for now I'll leave it off. --Stef
464 nil nil t query-replace-to-history-variable from t))))
465 ;; We make TO a list because replace-match-string-symbols requires one,
466 ;; and the user might enter a single token.
477 "Replace some matches for REGEXP with various strings, in rotation.
478 The second argument TO-STRINGS contains the replacement strings, separated
479 by spaces. This command works like `query-replace-regexp' except that
480 each successive replacement uses the next successive replacement string,
481 wrapping around from the last such string to the first.
483 In Transient Mark mode, if the mark is active, operate on the contents
484 of the region. Otherwise, operate from point to the end of the buffer.
486 Non-interactively, TO-STRINGS may be a list of replacement strings.
488 Interactively, reads the regexp using `read-regexp'.
490 to pull the last incremental search regexp to the minibuffer
491 that reads REGEXP.
493 A prefix argument N says to use each replacement string N times
494 before rotating to the next.
495 Fourth and fifth arg START and END specify the region to operate on."
498 query-replace-from-history-variable))
502 nil nil nil
503 query-replace-to-history-variable from t)))
527 "Replace occurrences of FROM-STRING with TO-STRING.
528 Preserve case in each match if `case-replace' and `case-fold-search'
529 are non-nil and FROM-STRING has no uppercase letters.
530 \(Preserving case means that if the string matched is all caps, or capitalized,
531 then its replacement is upcased or capitalized.)
533 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
534 ignore hidden matches if `search-invisible' is nil, and ignore more
535 matches using `isearch-filter-predicate'.
537 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
538 to be replaced will match a sequence of whitespace chars defined by the
539 regexp in `search-whitespace-regexp'.
541 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
542 only matches surrounded by word boundaries. A negative prefix arg means
543 replace backward.
545 Operates on the region between START and END (if both are nil, from point
546 to the end of the buffer). Interactively, if Transient Mark mode is
547 enabled and the mark is active, operates on the contents of the region;
548 otherwise from point to the end of the buffer.
551 to pull the last incremental search string to the minibuffer
552 that reads FROM-STRING.
554 This function is usually the wrong thing to use in a Lisp program.
555 What you probably want is a loop like this:
556 (while (search-forward FROM-STRING nil t)
557 (replace-match TO-STRING nil t))
558 which will run faster and will not set the mark or print anything.
559 \(You may need a more complex loop if FROM-STRING can match the null string
560 and TO-STRING is also null.)"
570 " string"
572 nil)))
582 "Replace things after point matching REGEXP with TO-STRING.
583 Preserve case in each match if `case-replace' and `case-fold-search'
584 are non-nil and REGEXP has no uppercase letters.
586 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
587 ignore hidden matches if `search-invisible' is nil, and ignore more
588 matches using `isearch-filter-predicate'.
590 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
591 to be replaced will match a sequence of whitespace chars defined by the
592 regexp in `search-whitespace-regexp'.
594 In Transient Mark mode, if the mark is active, operate on the contents
595 of the region. Otherwise, operate from point to the end of the buffer.
597 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
598 only matches surrounded by word boundaries. A negative prefix arg means
599 replace backward.
601 Fourth and fifth arg START and END specify the region to operate on.
607 at the given position for each replacement.
610 followed by a Lisp expression used as part of the replacement
614 `replace-count', the number of replacements occurred so far.
616 If your Lisp expression is an identifier and the next letter in
617 the replacement string would be interpreted as part of it, you
620 replacement text directly.
622 When using those Lisp features interactively in the replacement
623 text, TO-STRING is actually made a list instead of a string.
627 to pull the last incremental search regexp to the minibuffer
628 that reads REGEXP.
630 This function is usually the wrong thing to use in a Lisp program.
631 What you probably want is a loop like this:
632 (while (re-search-forward REGEXP nil t)
633 (replace-match TO-STRING nil nil))
634 which will run faster and will not set the mark or print anything."
644 " regexp"
646 t)))
655 \f
657 "History list for some commands that read regular expressions.
659 Maximum length of the history list is determined by the value
666 "Function that provides default regexp(s) for `read-regexp'.
667 This function should take no arguments and return one of: nil, a
668 regexp, or a list of regexps. Interactively, `read-regexp' uses
669 the return value of this function for its DEFAULT argument.
671 As an example, set this variable to `find-tag-default-as-regexp'
672 to default to the symbol at point.
674 To provide different default regexps for different commands,
675 the function that you set this to can check `this-command'."
680 find-tag-default)
682 find-tag-default-as-regexp)
684 find-tag-default-as-symbol-regexp)
690 "Return a list of standard suggestions for `read-regexp'.
691 By default, the list includes the tag at point, the last isearch regexp,
692 the last isearch string, and the last replacement regexp. `read-regexp'
693 appends the list returned by this function to the end of values available
703 "Read and return a regular expression as a string.
706 possibly preceded by the default result (see below).
708 The optional argument DEFAULTS can be either: nil, a string, a list
709 of strings, or a symbol. We use DEFAULTS to construct the default
710 return value in case of empty input.
712 If DEFAULTS is a string, we use it as-is.
714 If DEFAULTS is a list of strings, the first element is the
715 default return value, but all the elements are accessible
718 If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
719 is non-nil, we use that in place of DEFAULTS in the following:
720 If DEFAULTS is the symbol `regexp-history-last', we use the first
721 element of HISTORY (if specified) or `regexp-history'.
722 If DEFAULTS is a function, we call it with no arguments and use
723 what it returns, which should be either nil, a string, or a list of strings.
725 We append the standard values from `read-regexp-suggestions' to DEFAULTS
726 before using it.
728 If the first element of DEFAULTS is non-nil (and if PROMPT does not end
731 The optional argument HISTORY is a symbol to use for the history list.
732 If nil, uses `regexp-history'."
741 defaults))
746 ;; Do not automatically add default to the history for empty input.
750 prompt)
758 ;; Return the default value when the user enters empty input.
762 ;; Otherwise, add non-empty input to the history and return input.
773 "Read arguments for `keep-lines' and friends.
774 Prompt for a regexp with PROMPT.
775 Value is a list, (REGEXP)."
779 "Delete all lines except those containing matches for REGEXP.
780 A match split across lines preserves all the lines it lies in.
781 When called from Lisp (and usually interactively as well, see below)
782 applies to all lines starting after point.
785 and `search-upper-case' is non-nil, the matching is case-sensitive.
787 Second and third arg RSTART and REND specify the region to operate on.
788 This command operates on (the accessible part of) all lines whose
789 accessible part is entirely contained in the region determined by RSTART
790 and REND. (A newline ending a line counts as part of that line.)
792 Interactively, in Transient Mark mode when the mark is active, operate
793 on all lines whose accessible part is entirely contained in the region.
794 Otherwise, the command applies to all lines starting after point.
795 When calling this function from Lisp, you can pretend that it was
796 called interactively by passing a non-nil INTERACTIVE argument.
798 This function starts looking for the next match from the end of
799 the previous match. Hence, it ignores matches that overlap
800 a previously found match."
832 case-fold-search)))
834 ;; Start is first char not preserved by previous match.
840 ;; Now end is first char preserved by the new match.
845 ;; If the match was empty, avoid matching again at same place.
850 nil)
854 "Delete lines containing matches for REGEXP.
855 When called from Lisp (and usually when called interactively as
856 well, see below), applies to the part of the buffer after point.
857 The line point is in is deleted if and only if it contains a
858 match for regexp starting after point.
861 and `search-upper-case' is non-nil, the matching is case-sensitive.
863 Second and third arg RSTART and REND specify the region to operate on.
864 Lines partially contained in this region are deleted if and only if
865 they contain a match entirely contained in it.
867 Interactively, in Transient Mark mode when the mark is active, operate
868 on the contents of the region. Otherwise, operate from point to the
869 end of (the accessible portion of) the buffer. When calling this function
870 from Lisp, you can pretend that it was called interactively by passing
871 a non-nil INTERACTIVE argument.
873 If a match is split across lines, all the lines it lies in are deleted.
874 They are deleted _before_ looking for the next match. Hence, a match
875 starting on the same line at which another match ended is ignored."
894 case-fold-search)))
903 nil)
907 "Print and return number of matches for REGEXP following point.
908 When called from Lisp and INTERACTIVE is omitted or nil, just return
909 the number, do not print it; if INTERACTIVE is t, the function behaves
910 in all respects as if it had been called interactively.
913 and `search-upper-case' is non-nil, the matching is case-sensitive.
915 Second and third arg RSTART and REND specify the region to operate on.
917 Interactively, in Transient Mark mode when the mark is active, operate
918 on the contents of the region. Otherwise, operate from point to the
919 end of (the accessible portion of) the buffer.
921 This function starts looking for the next match from the end of
922 the previous match. Hence, it ignores matches that overlap
923 a previously found match."
942 opoint
946 case-fold-search)))
954 count
956 count)))
958 \f
963 next-error-follow-minor-mode
966 next-error-follow-minor-mode))))
1002 map)
1007 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
1020 map)
1024 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
1030 "Hook run when entering Occur mode."
1035 "Hook run by Occur when there are any matches."
1040 "Hook run by Occur after locating an occurrence.
1041 This will be called with the cursor position at the occurrence. An application
1042 for this is to reveal context in an outline-mode when the occurrence is hidden."
1057 \f
1058 ;;; Occur Edit mode
1068 map)
1072 "Major mode for editing *Occur* buffers.
1073 In this mode, changes to the *Occur* buffer are also applied to
1074 the originating buffer.
1083 "Switch from Occur Edit mode to Occur mode."
1095 col)
1099 ;; Apply occur-target property to inserted (e.g. yanked) text.
1101 ;; Did we insert a newline? Occur Edit mode can't create new
1102 ;; Occur entries; just discard everything after the newline.
1116 line-beg 'occur-prefix nil
1117 line-end))
1129 \f
1131 "Handle `revert-buffer' for Occur mode buffers."
1140 pos))
1144 "Go to the occurrence on the current line."
1148 ;; Actually `event-end' works correctly with a nil argument as
1149 ;; well, so we could dispense with this test, but let's not
1150 ;; rely on this undocumented behavior.
1161 "Go to the occurrence the current line describes, in another window."
1169 "Display in another window the occurrence the current line describes."
1172 window)
1174 ;; This is the way to set point in the proper window.
1194 "Move to the Nth (default 1) next match in an Occur mode buffer."
1199 "Move to the Nth (default 1) previous match in an Occur mode buffer."
1204 "Move to the Nth (default 1) next match in an Occur mode buffer.
1207 ;; we need to run occur-find-match from within the Occur buffer
1209 ;; Choose the buffer and make it current.
1223 #'previous-single-property-change
1226 ;; In case the *Occur* buffer is visible in a nonselected window.
1230 \f
1243 "Face used to highlight matches permanently."
1248 "Default number of context lines included around `list-matching-lines' matches.
1249 A negative number means to include that many lines before the match.
1250 A positive number means to include that many lines both before and after."
1258 If the value is nil, don't highlight the matching portions specially."
1264 If the value is nil, don't highlight the buffer names specially."
1270 If the face doesn't differ from the default face,
1271 don't highlight the prefix with line numbers specially."
1278 yank-handler follow-link)
1279 "Text properties to discard when copying lines to the *Occur* buffer.
1280 The value should be a list of text properties to discard or t,
1281 which means to discard all text properties."
1289 "Collect strings matching regexp"
1294 ;; Perform collect operation
1296 ;; No subexpression so collect the entire match.
1298 ;; Get the regexp for collection pattern.
1303 ;; Otherwise normal occur takes numerical prefix argument.
1308 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1309 Here `original-buffer-name' is the buffer name where Occur was originally run.
1310 When given the prefix argument, or called non-interactively, the renaming
1311 will not clobber the existing buffer(s) of that name, but use
1312 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1313 if you always want a separate *Occur* buffer for each buffer where you
1314 invoke `occur'."
1325 "Show all lines in the current buffer containing a match for REGEXP.
1326 If a match spreads across multiple lines, all those lines are shown.
1328 Each line is displayed with NLINES lines before and after, or -NLINES
1329 before if NLINES is negative.
1330 NLINES defaults to `list-matching-lines-default-context-lines'.
1331 Interactively it is the prefix arg.
1333 The lines are shown in a buffer named `*Occur*'.
1334 It serves as a menu to find any of the occurrences in this buffer.
1338 and `search-upper-case' is non-nil, the matching is case-sensitive.
1340 When NLINES is a string or when the function is called
1341 interactively with prefix argument without a number (`C-u' alone
1342 as prefix) the matching strings are collected into the `*Occur*'
1343 buffer by using NLINES as a replacement regexp. NLINES may
1347 program. When there is no parenthesized subexpressions in REGEXP
1348 the entire match is collected. In any case the searched buffer
1349 is not modified."
1356 "Show all lines in buffers BUFS containing a match for REGEXP.
1357 This function acts on multiple buffers; otherwise, it is exactly like
1358 `occur'. When you invoke this command interactively, you must specify
1359 the buffer names that you want, one by one.
1360 See also `multi-occur-in-matching-buffers'."
1370 "Next buffer to search (C-j to end): "
1372 nil t))
1381 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1382 Normally BUFREGEXP matches against each buffer's visited file name,
1383 but if you specify a prefix argument, it matches against the buffer name.
1384 See also `multi-occur'."
1391 "List lines in buffers whose names match regexp: "
1394 default
1395 input))
1407 buf))
1418 bufs))))
1419 ;; Handle the case where one of the buffers we're searching is the
1420 ;; output buffer. Just rename it.
1425 ;; Now find or create the output buffer.
1426 ;; If we just renamed that buffer, we will make a new one here.
1434 ;; Don't generate undo entries for creation of the initial contents.
1439 ;; Treat nlines as a regexp to collect.
1447 ;; Insert the replacement regexp.
1456 count)
1457 ;; Perform normal occur.
1459 regexp active-bufs occur-buf
1463 case-fold-search)
1464 list-matching-lines-buffer-name-face
1466 list-matching-lines-prefix-face)
1467 list-matching-lines-face
1476 ;; Don't display regexp if with remaining text
1477 ;; it is longer than window-width.
1490 title-face prefix-face match-face keep-props)
1496 ;; Map over all the buffers
1515 ;; Set CODING only if the current buffer locally
1516 ;; binds buffer-file-coding-system.
1526 ;; Get beginning of first match line and end of the last.
1532 ;; Sum line numbers up to the first match line.
1537 ;; Highlight the matches
1547 ;; Add `match-face' to faces copied from the buffer.
1550 match-face nil curstring))
1551 ;; Avoid infloop (Bug#7593).
1554 ;; Generate the string to insert for this match
1556 ;; Using 7 digits aligns tabs properly.
1562 ;; Allow insertion of text at
1563 ;; the end of the prefix (for
1564 ;; Occur Edit mode).
1565 front-sticky t rear-nonsticky t
1566 occur-target ,marker follow-link t
1569 ;; We don't put `mouse-face' on the newline,
1570 ;; because that loses. And don't put it
1571 ;; on context lines to reduce flicker.
1573 'occur-target marker
1574 'follow-link t
1575 'help-echo
1579 match-prefix
1580 ;; Add non-numeric prefix to all non-first lines
1581 ;; of multi-line matches.
1587 match-str)
1588 ;; Add marker at eol, but no mouse props.
1592 ;; The simple display style
1593 out-line
1594 ;; The complex multi-line display style.
1596 out-line nlines keep-props begpt endpt
1597 curr-line prev-line prev-after-lines
1598 prefix-face))
1599 ;; Set first elem of the returned list to `data',
1600 ;; and the second elem to `prev-after-lines'.
1603 ;; Actually insert the match display data
1609 ;; Sum line numbers between first and last match lines.
1611 ;; Add 1 for empty last match line since
1612 ;; count-lines returns 1 line less.
1614 ;; On to the next match...
1618 ;; Flush remaining context after-lines.
1622 prev-after-lines prefix-face)))))))
1629 end)
1633 ;; Don't display the same number of lines
1634 ;; and matches in case of 1 match per line.
1638 ;; Don't display regexp for multi-buffer.
1649 ;; Display total match count and regexp for multi-buffer.
1653 end)
1656 ;; Don't display the same number of lines
1657 ;; and matches in case of 1 match per line.
1667 ;; CODING is buffer-file-coding-system of the first buffer
1668 ;; that locally binds it. Let's use it also for the output
1669 ;; buffer.
1671 ;; Return the number of matches
1672 global-matches)))
1683 str)
1693 lines))
1700 result beg end moved)
1712 ;; Generate context display for occur.
1713 ;; OUT-LINE is the line where the match is.
1714 ;; NLINES and KEEP-PROPS are args to occur-engine.
1715 ;; CURR-LINE is line count of the current match,
1716 ;; PREV-LINE is line count of the previous match,
1717 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1718 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1719 ;; then concatenate them all together.
1721 curr-line prev-line prev-after-lines
1723 ;; Find after- and before-context lines of the current match.
1730 separator)
1732 ;; Combine after-lines of the previous match
1733 ;; with before-lines of the current match.
1736 ;; Don't overlap prev after-lines with current before-lines.
1743 ;; Separate non-overlapping context lines with a dashed line.
1747 ;; Don't overlap current before-lines with previous match line.
1749 prev-line)
1753 before-lines))
1754 ;; Separate non-overlapping before-context lines.
1759 ;; Return a list where the first element is the output line.
1767 separator)))
1770 ;; And the second element is the list of context after-lines.
1773 \f
1774 ;; It would be nice to use \\[...], but there is no reasonable way
1775 ;; to make that display both SPC and Y.
1777 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1778 RET or `q' to exit, Period to replace one match and exit,
1779 Comma to replace but not move point immediately,
1781 C-w to delete match and recursive edit,
1782 C-l to clear the screen, redisplay, and offer same replacement again,
1783 ! to replace all remaining matches in this buffer with no more questions,
1784 ^ to move point back to previous match,
1785 E to edit the replacement string.
1786 In multi-buffer replacements type `Y' to replace all remaining
1787 matches in all remaining buffers with no more questions,
1788 `N' to skip to the next buffer without replacing remaining matches
1789 in the current buffer."
1797 (define-key map [backspace] 'skip)
1798 (define-key map "y" 'act)
1799 (define-key map "n" 'skip)
1800 (define-key map "Y" 'act)
1801 (define-key map "N" 'skip)
1802 (define-key map "e" 'edit-replacement)
1803 (define-key map "E" 'edit-replacement)
1804 (define-key map "," 'act-and-show)
1805 (define-key map "q" 'exit)
1807 (define-key map [return] 'exit)
1808 (define-key map "." 'act-and-exit)
1809 (define-key map "\C-r" 'edit)
1810 (define-key map "\C-w" 'delete-and-edit)
1811 (define-key map "\C-l" 'recenter)
1812 (define-key map "!" 'automatic)
1813 (define-key map "^" 'backup)
1814 (define-key map "\C-h" 'help)
1815 (define-key map [f1] 'help)
1816 (define-key map [help] 'help)
1817 (define-key map "?" 'help)
1818 (define-key map "\C-g" 'quit)
1819 (define-key map "\C-]" 'quit)
1820 (define-key map "\C-v" 'scroll-up)
1821 (define-key map "\M-v" 'scroll-down)
1822 (define-key map [next] 'scroll-up)
1823 (define-key map [prior] 'scroll-down)
1824 (define-key map [?\C-\M-v] 'scroll-other-window)
1825 (define-key map [M-next] 'scroll-other-window)
1826 (define-key map [?\C-\M-\S-v] 'scroll-other-window-down)
1827 (define-key map [M-prior] 'scroll-other-window-down)
1828 ;; Binding ESC would prohibit the M-v binding. Instead, callers
1829 ;; should check for ESC specially.
1830 ;; (define-key map "\e" 'exit-prefix)
1831 (define-key map [escape] 'exit-prefix)
1832 map)
1833 "Keymap of responses to questions posed by commands like `query-replace'.
1835 The valid answers include `act', `skip', `act-and-show',
1836 `act-and-exit', `exit', `exit-prefix', `recenter', `scroll-up',
1837 `scroll-down', `scroll-other-window', `scroll-other-window-down',
1838 `edit', `edit-replacement', `delete-and-edit', `automatic',
1839 `backup', `quit', and `help'.
1841 This keymap is used by `y-or-n-p' as well as `query-replace'.")
1843 (defvar multi-query-replace-map
1844 (let ((map (make-sparse-keymap)))
1845 (set-keymap-parent map query-replace-map)
1846 (define-key map "Y" 'automatic-all)
1847 (define-key map "N" 'exit-current)
1848 map)
1849 "Keymap that defines additional bindings for multi-buffer replacements.
1850 It extends its parent map `query-replace-map' with new bindings to
1851 operate on a set of buffers/files. The difference with its parent map
1852 is the additional answers `automatic-all' to replace all remaining
1853 matches in all remaining buffers with no more questions, and
1854 `exit-current' to skip remaining matches in the current buffer
1855 and to continue with the next buffer in the sequence.")
1857 (defun replace-match-string-symbols (n)
1858 "Process a list (and any sub-lists), expanding certain symbols.
1859 Symbol Expands To
1860 N (match-string N) (where N is a string of digits)
1861 #N (string-to-number (match-string N))
1862 & (match-string 0)
1863 #& (string-to-number (match-string 0))
1864 # replace-count
1866 Note that these symbols must be preceded by a backslash in order to
1867 type them using Lisp syntax."
1868 (while (consp n)
1869 (cond
1870 ((consp (car n))
1871 (replace-match-string-symbols (car n))) ;Process sub-list
1872 ((symbolp (car n))
1873 (let ((name (symbol-name (car n))))
1874 (cond
1875 ((string-match "^[0-9]+$" name)
1876 (setcar n (list 'match-string (string-to-number name))))
1877 ((string-match "^#[0-9]+$" name)
1878 (setcar n (list 'string-to-number
1879 (list 'match-string
1880 (string-to-number (substring name 1))))))
1881 ((string= "&" name)
1882 (setcar n '(match-string 0)))
1883 ((string= "#&" name)
1884 (setcar n '(string-to-number (match-string 0))))
1885 ((string= "#" name)
1886 (setcar n 'replace-count))))))
1887 (setq n (cdr n))))
1889 (defun replace-eval-replacement (expression count)
1890 (let* ((replace-count count)
1891 err
1892 (replacement
1893 (condition-case err
1894 (eval expression)
1895 (error
1896 (error "Error evaluating replacement expression: %S" err)))))
1897 (if (stringp replacement)
1898 replacement
1899 (prin1-to-string replacement t))))
1901 (defun replace-quote (replacement)
1902 "Quote a replacement string.
1903 This just doubles all backslashes in REPLACEMENT and
1904 returns the resulting string. If REPLACEMENT is not
1905 a string, it is first passed through `prin1-to-string'
1906 with the `noescape' argument set.
1908 `match-data' is preserved across the call."
1909 (save-match-data
1911 (if (stringp replacement)
1912 replacement
1913 (prin1-to-string replacement t))
1914 t t)))
1916 (defun replace-loop-through-replacements (data count)
1917 ;; DATA is a vector containing the following values:
1918 ;; 0 next-rotate-count
1919 ;; 1 repeat-count
1920 ;; 2 next-replacement
1921 ;; 3 replacements
1922 (if (= (aref data 0) count)
1923 (progn
1924 (aset data 0 (+ count (aref data 1)))
1925 (let ((next (cdr (aref data 2))))
1926 (aset data 2 (if (consp next) next (aref data 3))))))
1927 (car (aref data 2)))
1929 (defun replace-match-data (integers reuse &optional new)
1930 "Like `match-data', but markers in REUSE get invalidated.
1931 If NEW is non-nil, it is set and returned instead of fresh data,
1932 but coerced to the correct value of INTEGERS."
1933 (or (and new
1934 (progn
1935 (set-match-data new)
1936 (and (eq new reuse)
1937 (eq (null integers) (markerp (car reuse)))
1938 new)))
1939 (match-data integers reuse t)))
1941 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data backward)
1943 FIXEDCASE, LITERAL are passed to `replace-match' (which see).
1946 is made (to save time). MATCH-DATA is used for the replacement.
1947 In case editing is done, it is changed to use markers.
1950 passed in. If LITERAL is set, no checking is done, anyway."
1951 (unless (or literal noedit)
1952 (setq noedit t)
1954 newtext)
1955 (setq newtext
1956 (read-string "Edit replacement string: "
1957 (prog1
1958 (cons
1959 (replace-match "" t t newtext 3)
1960 (1+ (match-beginning 3)))
1961 (setq match-data
1962 (replace-match-data
1963 nil match-data match-data))))
1964 noedit nil)))
1965 (set-match-data match-data)
1966 (replace-match newtext fixedcase literal)
1967 ;; `replace-match' leaves point at the end of the replacement text,
1968 ;; so move point to the beginning when replacing backward.
1969 (when backward (goto-char (nth 0 match-data)))
1970 noedit)
1972 (defvar replace-search-function nil
1973 "Function to use when searching for strings to replace.
1974 It is used by `query-replace' and `replace-string', and is called
1975 with three arguments, as if it were `search-forward'.")
1977 (defvar replace-re-search-function nil
1978 "Function to use when searching for regexps to replace.
1979 It is used by `query-replace-regexp', `replace-regexp',
1980 `query-replace-regexp-eval', and `map-query-replace-regexp'.
1981 It is called with three arguments, as if it were
1982 `re-search-forward'.")
1984 (defun replace-search (search-string limit regexp-flag delimited-flag
1985 case-fold-search backward)
1986 "Search for the next occurrence of SEARCH-STRING to replace."
1987 ;; Let-bind global isearch-* variables to values used
1988 ;; to search the next replacement. These let-bindings
1989 ;; should be effective both at the time of calling
1990 ;; `isearch-search-fun-default' and also at the
1991 ;; time of funcalling `search-function'.
1992 ;; These isearch-* bindings can't be placed higher
1993 ;; outside of this function because then another I-search
1994 ;; used after `recursive-edit' might override them.
1995 (let* ((isearch-regexp regexp-flag)
1996 (isearch-word delimited-flag)
1997 (isearch-lax-whitespace
1998 replace-lax-whitespace)
1999 (isearch-regexp-lax-whitespace
2000 replace-regexp-lax-whitespace)
2001 (isearch-case-fold-search case-fold-search)
2002 (isearch-adjusted nil)
2003 (isearch-nonincremental t) ; don't use lax word mode
2004 (isearch-forward (not backward))
2005 (search-function
2006 (or (if regexp-flag
2007 replace-re-search-function
2008 replace-search-function)
2009 (isearch-search-fun-default))))
2010 (funcall search-function search-string limit t)))
2012 (defvar replace-overlay nil)
2014 (defun replace-highlight (match-beg match-end range-beg range-end
2015 search-string regexp-flag delimited-flag
2016 case-fold-search backward)
2017 (if query-replace-highlight
2018 (if replace-overlay
2019 (move-overlay replace-overlay match-beg match-end (current-buffer))
2020 (setq replace-overlay (make-overlay match-beg match-end))
2021 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
2022 (overlay-put replace-overlay 'face 'query-replace)))
2023 (if query-replace-lazy-highlight
2024 (let ((isearch-string search-string)
2025 (isearch-regexp regexp-flag)
2026 (isearch-word delimited-flag)
2027 (isearch-lax-whitespace
2028 replace-lax-whitespace)
2029 (isearch-regexp-lax-whitespace
2030 replace-regexp-lax-whitespace)
2031 (isearch-case-fold-search case-fold-search)
2032 (isearch-forward (not backward))
2033 (isearch-other-end match-beg)
2034 (isearch-error nil))
2035 (isearch-lazy-highlight-new-loop range-beg range-end))))
2037 (defun replace-dehighlight ()
2038 (when replace-overlay
2039 (delete-overlay replace-overlay))
2040 (when query-replace-lazy-highlight
2041 (lazy-highlight-cleanup lazy-highlight-cleanup)
2042 (setq isearch-lazy-highlight-last-string nil))
2043 ;; Close overlays opened by `isearch-range-invisible' in `perform-replace'.
2044 (isearch-clean-overlays))
2046 (defun perform-replace (from-string replacements
2047 query-flag regexp-flag delimited-flag
2048 &optional repeat-count map start end backward)
2049 "Subroutine of `query-replace'. Its complexity handles interactive queries.
2050 Don't use this in your own program unless you want to query and set the mark
2051 just as `query-replace' does. Instead, write a simple loop like this:
2056 which will run faster and probably do exactly what you want. Please
2057 see the documentation of `replace-match' to find out how to simulate
2058 `case-replace'.
2060 This function returns nil if and only if there were no matches to
2061 make, or the user didn't cancel the call."
2062 (or map (setq map query-replace-map))
2063 (and query-flag minibuffer-auto-raise
2064 (raise-frame (window-frame (minibuffer-window))))
2065 (let* ((case-fold-search
2066 (if (and case-fold-search search-upper-case)
2067 (isearch-no-upper-case-p from-string regexp-flag)
2068 case-fold-search))
2069 (nocasify (not (and case-replace case-fold-search)))
2070 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
2071 (search-string from-string)
2072 (real-match-data nil) ; The match data for the current match.
2073 (next-replacement nil)
2074 ;; This is non-nil if we know there is nothing for the user
2075 ;; to edit in the replacement.
2076 (noedit nil)
2077 (keep-going t)
2078 (stack nil)
2079 (replace-count 0)
2080 (skip-read-only-count 0)
2081 (skip-filtered-count 0)
2082 (skip-invisible-count 0)
2083 (nonempty-match nil)
2084 (multi-buffer nil)
2085 (recenter-last-op nil) ; Start cycling order with initial position.
2087 ;; If non-nil, it is marker saying where in the buffer to stop.
2088 (limit nil)
2090 ;; Data for the next match. If a cons, it has the same format as
2091 ;; (match-data); otherwise it is t if a match is possible at point.
2092 (match-again t)
2094 (message
2095 (if query-flag
2096 (apply 'propertize
2097 (substitute-command-keys
2099 minibuffer-prompt-properties))))
2101 ;; If region is active, in Transient Mark mode, operate on region.
2102 (if backward
2103 (when end
2104 (setq limit (copy-marker (min start end)))
2105 (goto-char (max start end))
2106 (deactivate-mark))
2107 (when start
2108 (setq limit (copy-marker (max start end)))
2109 (goto-char (min start end))
2110 (deactivate-mark)))
2112 ;; If last typed key in previous call of multi-buffer perform-replace
2113 ;; was `automatic-all', don't ask more questions in next files
2114 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
2115 (setq query-flag nil multi-buffer t))
2117 ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
2118 ;; containing a function and its first argument. The function is
2119 ;; called to generate each replacement like this:
2120 ;; (funcall (car replacements) (cdr replacements) replace-count)
2121 ;; It must return a string.
2122 (cond
2123 ((stringp replacements)
2124 (setq next-replacement replacements
2125 replacements nil))
2126 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
2127 (or repeat-count (setq repeat-count 1))
2128 (setq replacements (cons 'replace-loop-through-replacements
2129 (vector repeat-count repeat-count
2130 replacements replacements)))))
2132 (when query-replace-lazy-highlight
2133 (setq isearch-lazy-highlight-last-string nil))
2135 (push-mark)
2136 (undo-boundary)
2137 (unwind-protect
2138 ;; Loop finding occurrences that perhaps should be replaced.
2139 (while (and keep-going
2140 (if backward
2141 (not (or (bobp) (and limit (<= (point) limit))))
2142 (not (or (eobp) (and limit (>= (point) limit)))))
2143 ;; Use the next match if it is already known;
2144 ;; otherwise, search for a match after moving forward
2145 ;; one char if progress is required.
2146 (setq real-match-data
2147 (cond ((consp match-again)
2148 (goto-char (if backward
2149 (nth 0 match-again)
2150 (nth 1 match-again)))
2151 (replace-match-data
2152 t real-match-data match-again))
2153 ;; MATCH-AGAIN non-nil means accept an
2154 ;; adjacent match.
2155 (match-again
2156 (and
2157 (replace-search search-string limit
2158 regexp-flag delimited-flag
2159 case-fold-search backward)
2160 ;; For speed, use only integers and
2161 ;; reuse the list used last time.
2162 (replace-match-data t real-match-data)))
2163 ((and (if backward
2164 (> (1- (point)) (point-min))
2165 (< (1+ (point)) (point-max)))
2166 (or (null limit)
2167 (if backward
2168 (> (1- (point)) limit)
2169 (< (1+ (point)) limit))))
2170 ;; If not accepting adjacent matches,
2171 ;; move one char to the right before
2172 ;; searching again. Undo the motion
2173 ;; if the search fails.
2174 (let ((opoint (point)))
2175 (forward-char (if backward -1 1))
2176 (if (replace-search search-string limit
2177 regexp-flag delimited-flag
2178 case-fold-search backward)
2179 (replace-match-data
2180 t real-match-data)
2181 (goto-char opoint)
2182 nil))))))
2184 ;; Record whether the match is nonempty, to avoid an infinite loop
2185 ;; repeatedly matching the same empty string.
2186 (setq nonempty-match
2187 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
2189 ;; If the match is empty, record that the next one can't be
2190 ;; adjacent.
2192 ;; Otherwise, if matching a regular expression, do the next
2193 ;; match now, since the replacement for this match may
2194 ;; affect whether the next match is adjacent to this one.
2195 ;; If that match is empty, don't use it.
2196 (setq match-again
2197 (and nonempty-match
2198 (or (not regexp-flag)
2199 (and (if backward
2200 (looking-back search-string)
2201 (looking-at search-string))
2202 (let ((match (match-data)))
2203 (and (/= (nth 0 match) (nth 1 match))
2204 match))))))
2206 (cond
2207 ;; Optionally ignore matches that have a read-only property.
2208 ((not (or (not query-replace-skip-read-only)
2209 (not (text-property-not-all
2210 (nth 0 real-match-data) (nth 1 real-match-data)
2211 'read-only nil))))
2212 (setq skip-read-only-count (1+ skip-read-only-count)))
2213 ;; Optionally filter out matches.
2214 ((not (funcall isearch-filter-predicate
2215 (nth 0 real-match-data) (nth 1 real-match-data)))
2216 (setq skip-filtered-count (1+ skip-filtered-count)))
2217 ;; Optionally ignore invisible matches.
2218 ((not (or (eq search-invisible t)
2219 ;; Don't open overlays for automatic replacements.
2220 (and (not query-flag) search-invisible)
2221 ;; Open hidden overlays for interactive replacements.
2222 (not (isearch-range-invisible
2223 (nth 0 real-match-data) (nth 1 real-match-data)))))
2224 (setq skip-invisible-count (1+ skip-invisible-count)))
2225 (t
2226 ;; Calculate the replacement string, if necessary.
2227 (when replacements
2228 (set-match-data real-match-data)
2229 (setq next-replacement
2230 (funcall (car replacements) (cdr replacements)
2231 replace-count)))
2232 (if (not query-flag)
2233 (progn
2234 (unless (or literal noedit)
2235 (replace-highlight
2236 (nth 0 real-match-data) (nth 1 real-match-data)
2237 start end search-string
2238 regexp-flag delimited-flag case-fold-search backward))
2239 (setq noedit
2240 (replace-match-maybe-edit
2241 next-replacement nocasify literal
2242 noedit real-match-data backward)
2243 replace-count (1+ replace-count)))
2244 (undo-boundary)
2245 (let (done replaced key def)
2246 ;; Loop reading commands until one of them sets done,
2247 ;; which means it has finished handling this
2248 ;; occurrence. Any command that sets `done' should
2249 ;; leave behind proper match data for the stack.
2250 ;; Commands not setting `done' need to adjust
2251 ;; `real-match-data'.
2252 (while (not done)
2253 (set-match-data real-match-data)
2254 (replace-highlight
2255 (match-beginning 0) (match-end 0)
2256 start end search-string
2257 regexp-flag delimited-flag case-fold-search backward)
2258 ;; Bind message-log-max so we don't fill up the message log
2259 ;; with a bunch of identical messages.
2260 (let ((message-log-max nil)
2261 (replacement-presentation
2262 (if query-replace-show-replacement
2263 (save-match-data
2264 (set-match-data real-match-data)
2265 (match-substitute-replacement next-replacement
2266 nocasify literal))
2267 next-replacement)))
2268 (message message
2269 (query-replace-descr from-string)
2270 (query-replace-descr replacement-presentation)))
2271 (setq key (read-event))
2272 ;; Necessary in case something happens during read-event
2273 ;; that clobbers the match data.
2274 (set-match-data real-match-data)
2275 (setq key (vector key))
2276 (setq def (lookup-key map key))
2277 ;; Restore the match data while we process the command.
2278 (cond ((eq def 'help)
2279 (with-output-to-temp-buffer "*Help*"
2280 (princ
2281 (concat "Query replacing "
2282 (if delimited-flag
2283 (or (and (symbolp delimited-flag)
2284 (get delimited-flag 'isearch-message-prefix))
2285 "word ") "")
2286 (if regexp-flag "regexp " "")
2287 (if backward "backward " "")
2288 from-string " with "
2290 (substitute-command-keys
2291 query-replace-help)))
2292 (with-current-buffer standard-output
2293 (help-mode))))
2294 ((eq def 'exit)
2295 (setq keep-going nil)
2296 (setq done t))
2297 ((eq def 'exit-current)
2298 (setq multi-buffer t keep-going nil done t))
2299 ((eq def 'backup)
2300 (if stack
2301 (let ((elt (pop stack)))
2302 (goto-char (nth 0 elt))
2303 (setq replaced (nth 1 elt)
2304 real-match-data
2305 (replace-match-data
2306 t real-match-data
2307 (nth 2 elt))))
2308 (message "No previous match")
2309 (ding 'no-terminate)
2310 (sit-for 1)))
2311 ((eq def 'act)
2312 (or replaced
2313 (setq noedit
2314 (replace-match-maybe-edit
2315 next-replacement nocasify literal
2316 noedit real-match-data backward)
2317 replace-count (1+ replace-count)))
2318 (setq done t replaced t))
2319 ((eq def 'act-and-exit)
2320 (or replaced
2321 (setq noedit
2322 (replace-match-maybe-edit
2323 next-replacement nocasify literal
2324 noedit real-match-data backward)
2325 replace-count (1+ replace-count)))
2326 (setq keep-going nil)
2327 (setq done t replaced t))
2328 ((eq def 'act-and-show)
2329 (if (not replaced)
2330 (setq noedit
2331 (replace-match-maybe-edit
2332 next-replacement nocasify literal
2333 noedit real-match-data backward)
2334 replace-count (1+ replace-count)
2335 real-match-data (replace-match-data
2336 t real-match-data)
2337 replaced t)))
2338 ((or (eq def 'automatic) (eq def 'automatic-all))
2339 (or replaced
2340 (setq noedit
2341 (replace-match-maybe-edit
2342 next-replacement nocasify literal
2343 noedit real-match-data backward)
2344 replace-count (1+ replace-count)))
2345 (setq done t query-flag nil replaced t)
2346 (if (eq def 'automatic-all) (setq multi-buffer t)))
2347 ((eq def 'skip)
2348 (setq done t))
2349 ((eq def 'recenter)
2350 ;; `this-command' has the value `query-replace',
2351 ;; so we need to bind it to `recenter-top-bottom'
2352 ;; to allow it to detect a sequence of `C-l'.
2353 (let ((this-command 'recenter-top-bottom)
2354 (last-command 'recenter-top-bottom))
2355 (recenter-top-bottom)))
2356 ((eq def 'edit)
2357 (let ((opos (point-marker)))
2358 (setq real-match-data (replace-match-data
2359 nil real-match-data
2360 real-match-data))
2361 (goto-char (match-beginning 0))
2362 (save-excursion
2363 (save-window-excursion
2364 (recursive-edit)))
2365 (goto-char opos)
2366 (set-marker opos nil))
2367 ;; Before we make the replacement,
2368 ;; decide whether the search string
2369 ;; can match again just after this match.
2370 (if (and regexp-flag nonempty-match)
2371 (setq match-again (and (looking-at search-string)
2372 (match-data)))))
2373 ;; Edit replacement.
2374 ((eq def 'edit-replacement)
2375 (setq real-match-data (replace-match-data
2376 nil real-match-data
2377 real-match-data)
2378 next-replacement
2379 (read-string "Edit replacement string: "
2380 next-replacement)
2381 noedit nil)
2382 (if replaced
2383 (set-match-data real-match-data)
2384 (setq noedit
2385 (replace-match-maybe-edit
2386 next-replacement nocasify literal noedit
2387 real-match-data backward)
2388 replaced t))
2389 (setq done t))
2391 ((eq def 'delete-and-edit)
2392 (replace-match "" t t)
2393 (setq real-match-data (replace-match-data
2394 nil real-match-data))
2395 (replace-dehighlight)
2396 (save-excursion (recursive-edit))
2397 (setq replaced t))
2398 ;; Note: we do not need to treat `exit-prefix'
2399 ;; specially here, since we reread
2400 ;; any unrecognized character.
2401 (t
2402 (setq this-command 'mode-exited)
2403 (setq keep-going nil)
2404 (setq unread-command-events
2405 (append (listify-key-sequence key)
2406 unread-command-events))
2407 (setq done t)))
2408 (when query-replace-lazy-highlight
2409 ;; Force lazy rehighlighting only after replacements.
2410 (if (not (memq def '(skip backup)))
2411 (setq isearch-lazy-highlight-last-string nil)))
2412 (unless (eq def 'recenter)
2413 ;; Reset recenter cycling order to initial position.
2414 (setq recenter-last-op nil)))
2415 ;; Record previous position for ^ when we move on.
2416 ;; Change markers to numbers in the match data
2417 ;; since lots of markers slow down editing.
2418 (push (list (point) replaced
2419 ;;; If the replacement has already happened, all we need is the
2420 ;;; current match start and end. We could get this with a trivial
2421 ;;; match like
2422 ;;; (save-excursion (goto-char (match-beginning 0))
2423 ;;; (search-forward (match-string 0))
2424 ;;; (match-data t))
2425 ;;; if we really wanted to avoid manually constructing match data.
2426 ;;; Adding current-buffer is necessary so that match-data calls can
2427 ;;; return markers which are appropriate for editing.
2428 (if replaced
2429 (list
2430 (match-beginning 0)
2431 (match-end 0)
2432 (current-buffer))
2433 (match-data t)))
2434 stack))))))
2436 (replace-dehighlight))
2437 (or unread-command-events
2438 (message "Replaced %d occurrence%s%s"
2439 replace-count
2440 (if (= replace-count 1) "" "s")
2441 (if (> (+ skip-read-only-count
2442 skip-filtered-count
2443 skip-invisible-count) 0)
2444 (format " (skipped %s)"
2445 (mapconcat
2446 'identity
2447 (delq nil (list
2448 (if (> skip-read-only-count 0)
2449 (format "%s read-only"
2450 skip-read-only-count))
2451 (if (> skip-invisible-count 0)
2452 (format "%s invisible"
2453 skip-invisible-count))
2454 (if (> skip-filtered-count 0)
2455 (format "%s filtered out"
2456 skip-filtered-count))))
2457 ", "))
2458 "")))
2459 (or (and keep-going stack) multi-buffer)))
2461 ;;; replace.el ends here