| blob | fda2213236bfd2e4daaa89b6bdad3ca9fbda3b02 |
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 cons cell (FROM-STRING . TO-STRING), or nil if there is
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
71 "History list to use for the FROM argument of `query-replace' commands.
72 The value of this variable should be a symbol; that symbol
73 is used as a variable to hold a history list for the strings
74 or patterns to be replaced."
80 "History list to use for the TO argument of `query-replace' commands.
81 The value of this variable should be a symbol; that symbol
82 is used as a variable to hold a history list for replacement
83 strings or patterns."
89 "Non-nil means `query-replace' and friends ignore read-only matches."
95 "Non-nil means to show what actual replacement text will be."
101 "Non-nil means to highlight matches during query replacement."
106 "Controls the lazy-highlighting during query replacements.
107 When non-nil, all text in the buffer matching the current match
108 is highlighted lazily using isearch lazy highlighting (see
109 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
117 "Face for highlighting query replacement matches."
122 "Number of replacements done so far.
129 "Query and return the `from' argument of a query-replace operation.
130 The return value can also be a pair (FROM . TO) indicating that the user
131 wants to replace FROM with TO."
142 ;; The save-excursion here is in case the user marks and copies
143 ;; a region in order to specify the minibuffer input.
144 ;; That should not clobber the region for the query-replace itself.
149 prompt nil nil nil query-replace-from-history-variable
156 ;; Warn if user types \n or \t, but don't reject the input.
166 from))))
169 "Maybe convert a regexp replacement TO to Lisp.
170 Returns a list suitable for `perform-replace' if necessary,
171 the original string if not."
187 ;; Swallow a space after a symbol
188 ;; if there is a space.
190 ;; Swallow a space after 'foo
191 ;; but not after (quote foo).
206 to))
210 "Query and return the `to' argument of a query-replace operation."
216 nil nil nil
217 query-replace-to-history-variable from t)))
220 to))
221 regexp-flag))
234 "Replace some occurrences of FROM-STRING with TO-STRING.
235 As each match is found, the user must type a character saying
238 In Transient Mark mode, if the mark is active, operate on the contents
239 of the region. Otherwise, operate from point to the end of the buffer.
242 to pull the last incremental search string to the minibuffer
243 that reads FROM-STRING, or invoke replacements from
244 incremental search with a key sequence like `C-s C-s M-%'
245 to use its current search string as the string to replace.
247 Matching is independent of case if `case-fold-search' is non-nil and
248 FROM-STRING has no uppercase letters. Replacement transfers the case
249 pattern of the old text to the new text, if `case-replace' and
250 `case-fold-search' are non-nil and FROM-STRING has no uppercase
251 letters. (Transferring the case pattern means that if the old text
252 matched is all caps, or capitalized, then its replacement is upcased
253 or capitalized.)
255 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
256 ignore hidden matches if `search-invisible' is nil, and ignore more
257 matches using `isearch-filter-predicate'.
259 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
260 to be replaced will match a sequence of whitespace chars defined by the
261 regexp in `search-whitespace-regexp'.
263 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
264 only matches surrounded by word boundaries. A negative prefix arg means
265 replace backward.
267 Fourth and fifth arg START and END specify the region to operate on.
278 nil)))
280 ;; These are done separately here
281 ;; so that command-history will record these expressions
282 ;; rather than the values they had this time.
293 "Replace some things after point matching REGEXP with TO-STRING.
294 As each match is found, the user must type a character saying
297 In Transient Mark mode, if the mark is active, operate on the contents
298 of the region. Otherwise, operate from point to the end of the buffer.
301 to pull the last incremental search regexp to the minibuffer
302 that reads REGEXP, or invoke replacements from
303 incremental search with a key sequence like `C-M-s C-M-s C-M-%'
304 to use its current search regexp as the regexp to replace.
306 Matching is independent of case if `case-fold-search' is non-nil and
307 REGEXP has no uppercase letters. Replacement transfers the case
308 pattern of the old text to the new text, if `case-replace' and
309 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
310 \(Transferring the case pattern means that if the old text matched is
311 all caps, or capitalized, then its replacement is upcased or
312 capitalized.)
314 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
315 ignore hidden matches if `search-invisible' is nil, and ignore more
316 matches using `isearch-filter-predicate'.
318 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
319 to be replaced will match a sequence of whitespace chars defined by the
320 regexp in `search-whitespace-regexp'.
322 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
323 only matches surrounded by word boundaries. A negative prefix arg means
324 replace backward.
326 Fourth and fifth arg START and END specify the region to operate on.
332 at the given position for each replacement.
335 followed by a Lisp expression. Each
336 replacement evaluates that expression to compute the replacement
339 for the whole or a partial match converted to a number with
341 done so far (starting with zero).
343 If the replacement expression is a symbol, write a space after it
344 to terminate it. One space there, if any, will be discarded.
346 When using those Lisp features interactively in the replacement
347 text, TO-STRING is actually made a list instead of a string.
356 " regexp"
358 t)))
360 ;; These are done separately here
361 ;; so that command-history will record these expressions
362 ;; rather than the values they had this time.
373 "Replace some things after point matching REGEXP with the result of TO-EXPR.
375 Interactive use of this function is deprecated in favor of the
377 using `search-forward-regexp' and `replace-match' is preferred.
379 As each match is found, the user must type a character saying
382 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
383 reference `replace-count' to get the number of replacements already made.
384 If the result of TO-EXPR is not a string, it is converted to one using
385 `prin1-to-string' with the NOESCAPE argument (which see).
393 In Transient Mark mode, if the mark is active, operate on the contents
394 of the region. Otherwise, operate from point to the end of the buffer.
397 to pull the last incremental search regexp to the minibuffer
398 that reads REGEXP.
400 Preserves case in each replacement if `case-replace' and `case-fold-search'
401 are non-nil and REGEXP has no uppercase letters.
403 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
404 ignore hidden matches if `search-invisible' is nil, and ignore more
405 matches using `isearch-filter-predicate'.
407 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
408 to be replaced will match a sequence of whitespace chars defined by the
409 regexp in `search-whitespace-regexp'.
411 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
412 only matches that are surrounded by word boundaries.
413 Fourth and fifth arg START and END specify the region to operate on."
415 for interactive calls, and `search-forward-regexp'/`replace-match'
421 ;; Let-bind the history var to disable the "foo -> bar"
422 ;; default. Maybe we shouldn't disable this default, but
423 ;; for now I'll leave it off. --Stef
429 nil nil t query-replace-to-history-variable from t))))
430 ;; We make TO a list because replace-match-string-symbols requires one,
431 ;; and the user might enter a single token.
442 "Replace some matches for REGEXP with various strings, in rotation.
443 The second argument TO-STRINGS contains the replacement strings, separated
444 by spaces. This command works like `query-replace-regexp' except that
445 each successive replacement uses the next successive replacement string,
446 wrapping around from the last such string to the first.
448 In Transient Mark mode, if the mark is active, operate on the contents
449 of the region. Otherwise, operate from point to the end of the buffer.
451 Non-interactively, TO-STRINGS may be a list of replacement strings.
453 Interactively, reads the regexp using `read-regexp'.
455 to pull the last incremental search regexp to the minibuffer
456 that reads REGEXP.
458 A prefix argument N says to use each replacement string N times
459 before rotating to the next.
460 Fourth and fifth arg START and END specify the region to operate on."
463 query-replace-from-history-variable))
467 nil nil nil
468 query-replace-to-history-variable from t)))
492 "Replace occurrences of FROM-STRING with TO-STRING.
493 Preserve case in each match if `case-replace' and `case-fold-search'
494 are non-nil and FROM-STRING has no uppercase letters.
495 \(Preserving case means that if the string matched is all caps, or capitalized,
496 then its replacement is upcased or capitalized.)
498 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
499 ignore hidden matches if `search-invisible' is nil, and ignore more
500 matches using `isearch-filter-predicate'.
502 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
503 to be replaced will match a sequence of whitespace chars defined by the
504 regexp in `search-whitespace-regexp'.
506 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
507 only matches surrounded by word boundaries. A negative prefix arg means
508 replace backward.
510 Operates on the region between START and END (if both are nil, from point
511 to the end of the buffer). Interactively, if Transient Mark mode is
512 enabled and the mark is active, operates on the contents of the region;
513 otherwise from point to the end of the buffer.
516 to pull the last incremental search string to the minibuffer
517 that reads FROM-STRING.
519 This function is usually the wrong thing to use in a Lisp program.
520 What you probably want is a loop like this:
521 (while (search-forward FROM-STRING nil t)
522 (replace-match TO-STRING nil t))
523 which will run faster and will not set the mark or print anything.
524 \(You may need a more complex loop if FROM-STRING can match the null string
525 and TO-STRING is also null.)"
533 " string"
535 nil)))
547 "Replace things after point matching REGEXP with TO-STRING.
548 Preserve case in each match if `case-replace' and `case-fold-search'
549 are non-nil and REGEXP has no uppercase letters.
551 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
552 ignore hidden matches if `search-invisible' is nil, and ignore more
553 matches using `isearch-filter-predicate'.
555 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
556 to be replaced will match a sequence of whitespace chars defined by the
557 regexp in `search-whitespace-regexp'.
559 In Transient Mark mode, if the mark is active, operate on the contents
560 of the region. Otherwise, operate from point to the end of the buffer.
562 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
563 only matches surrounded by word boundaries. A negative prefix arg means
564 replace backward.
566 Fourth and fifth arg START and END specify the region to operate on.
572 at the given position for each replacement.
575 followed by a Lisp expression used as part of the replacement
579 `replace-count', the number of replacements occurred so far.
581 If your Lisp expression is an identifier and the next letter in
582 the replacement string would be interpreted as part of it, you
585 replacement text directly.
587 When using those Lisp features interactively in the replacement
588 text, TO-STRING is actually made a list instead of a string.
592 to pull the last incremental search regexp to the minibuffer
593 that reads REGEXP.
595 This function is usually the wrong thing to use in a Lisp program.
596 What you probably want is a loop like this:
597 (while (re-search-forward REGEXP nil t)
598 (replace-match TO-STRING nil nil))
599 which will run faster and will not set the mark or print anything."
607 " regexp"
609 t)))
620 \f
622 "History list for some commands that read regular expressions.
624 Maximum length of the history list is determined by the value
631 "Function that provides default regexp(s) for `read-regexp'.
632 This function should take no arguments and return one of: nil, a
633 regexp, or a list of regexps. Interactively, `read-regexp' uses
634 the return value of this function for its DEFAULT argument.
636 As an example, set this variable to `find-tag-default-as-regexp'
637 to default to the symbol at point.
639 To provide different default regexps for different commands,
640 the function that you set this to can check `this-command'."
645 find-tag-default)
647 find-tag-default-as-regexp)
649 find-tag-default-as-symbol-regexp)
655 "Return a list of standard suggestions for `read-regexp'.
656 By default, the list includes the tag at point, the last isearch regexp,
657 the last isearch string, and the last replacement regexp. `read-regexp'
658 appends the list returned by this function to the end of values available
668 "Read and return a regular expression as a string.
671 possibly preceded by the default result (see below).
673 The optional argument DEFAULTS can be either: nil, a string, a list
674 of strings, or a symbol. We use DEFAULTS to construct the default
675 return value in case of empty input.
677 If DEFAULTS is a string, we use it as-is.
679 If DEFAULTS is a list of strings, the first element is the
680 default return value, but all the elements are accessible
683 If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
684 is non-nil, we use that in place of DEFAULTS in the following:
685 If DEFAULTS is the symbol `regexp-history-last', we use the first
686 element of HISTORY (if specified) or `regexp-history'.
687 If DEFAULTS is a function, we call it with no arguments and use
688 what it returns, which should be either nil, a string, or a list of strings.
690 We append the standard values from `read-regexp-suggestions' to DEFAULTS
691 before using it.
693 If the first element of DEFAULTS is non-nil (and if PROMPT does not end
696 The optional argument HISTORY is a symbol to use for the history list.
697 If nil, uses `regexp-history'."
706 defaults))
711 ;; Do not automatically add default to the history for empty input.
715 prompt)
723 ;; Return the default value when the user enters empty input.
727 ;; Otherwise, add non-empty input to the history and return input.
738 "Read arguments for `keep-lines' and friends.
739 Prompt for a regexp with PROMPT.
740 Value is a list, (REGEXP)."
744 "Delete all lines except those containing matches for REGEXP.
745 A match split across lines preserves all the lines it lies in.
746 When called from Lisp (and usually interactively as well, see below)
747 applies to all lines starting after point.
750 and `search-upper-case' is non-nil, the matching is case-sensitive.
752 Second and third arg RSTART and REND specify the region to operate on.
753 This command operates on (the accessible part of) all lines whose
754 accessible part is entirely contained in the region determined by RSTART
755 and REND. (A newline ending a line counts as part of that line.)
757 Interactively, in Transient Mark mode when the mark is active, operate
758 on all lines whose accessible part is entirely contained in the region.
759 Otherwise, the command applies to all lines starting after point.
760 When calling this function from Lisp, you can pretend that it was
761 called interactively by passing a non-nil INTERACTIVE argument.
763 This function starts looking for the next match from the end of
764 the previous match. Hence, it ignores matches that overlap
765 a previously found match."
797 case-fold-search)))
799 ;; Start is first char not preserved by previous match.
805 ;; Now end is first char preserved by the new match.
810 ;; If the match was empty, avoid matching again at same place.
815 nil)
819 "Delete lines containing matches for REGEXP.
820 When called from Lisp (and usually when called interactively as
821 well, see below), applies to the part of the buffer after point.
822 The line point is in is deleted if and only if it contains a
823 match for regexp starting after point.
826 and `search-upper-case' is non-nil, the matching is case-sensitive.
828 Second and third arg RSTART and REND specify the region to operate on.
829 Lines partially contained in this region are deleted if and only if
830 they contain a match entirely contained in it.
832 Interactively, in Transient Mark mode when the mark is active, operate
833 on the contents of the region. Otherwise, operate from point to the
834 end of (the accessible portion of) the buffer. When calling this function
835 from Lisp, you can pretend that it was called interactively by passing
836 a non-nil INTERACTIVE argument.
838 If a match is split across lines, all the lines it lies in are deleted.
839 They are deleted _before_ looking for the next match. Hence, a match
840 starting on the same line at which another match ended is ignored."
859 case-fold-search)))
868 nil)
872 "Print and return number of matches for REGEXP following point.
873 When called from Lisp and INTERACTIVE is omitted or nil, just return
874 the number, do not print it; if INTERACTIVE is t, the function behaves
875 in all respects as if it had been called interactively.
878 and `search-upper-case' is non-nil, the matching is case-sensitive.
880 Second and third arg RSTART and REND specify the region to operate on.
882 Interactively, in Transient Mark mode when the mark is active, operate
883 on the contents of the region. Otherwise, operate from point to the
884 end of (the accessible portion of) the buffer.
886 This function starts looking for the next match from the end of
887 the previous match. Hence, it ignores matches that overlap
888 a previously found match."
907 opoint
911 case-fold-search)))
919 count
921 count)))
923 \f
928 next-error-follow-minor-mode
931 next-error-follow-minor-mode))))
967 map)
972 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
985 map)
989 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
995 "Hook run when entering Occur mode."
1000 "Hook run by Occur when there are any matches."
1005 "Hook run by Occur after locating an occurrence.
1006 This will be called with the cursor position at the occurrence. An application
1007 for this is to reveal context in an outline-mode when the occurrence is hidden."
1022 \f
1023 ;;; Occur Edit mode
1033 map)
1037 "Major mode for editing *Occur* buffers.
1038 In this mode, changes to the *Occur* buffer are also applied to
1039 the originating buffer.
1048 "Switch from Occur Edit mode to Occur mode."
1060 col)
1064 ;; Apply occur-target property to inserted (e.g. yanked) text.
1066 ;; Did we insert a newline? Occur Edit mode can't create new
1067 ;; Occur entries; just discard everything after the newline.
1081 line-beg 'occur-prefix nil
1082 line-end))
1094 \f
1096 "Handle `revert-buffer' for Occur mode buffers."
1105 pos))
1109 "Go to the occurrence on the current line."
1113 ;; Actually `event-end' works correctly with a nil argument as
1114 ;; well, so we could dispense with this test, but let's not
1115 ;; rely on this undocumented behavior.
1126 "Go to the occurrence the current line describes, in another window."
1134 "Display in another window the occurrence the current line describes."
1137 window)
1139 ;; This is the way to set point in the proper window.
1159 "Move to the Nth (default 1) next match in an Occur mode buffer."
1164 "Move to the Nth (default 1) previous match in an Occur mode buffer."
1169 "Move to the Nth (default 1) next match in an Occur mode buffer.
1172 ;; we need to run occur-find-match from within the Occur buffer
1174 ;; Choose the buffer and make it current.
1188 #'previous-single-property-change
1191 ;; In case the *Occur* buffer is visible in a nonselected window.
1195 \f
1208 "Face used to highlight matches permanently."
1213 "Default number of context lines included around `list-matching-lines' matches.
1214 A negative number means to include that many lines before the match.
1215 A positive number means to include that many lines both before and after."
1223 If the value is nil, don't highlight the matching portions specially."
1229 If the value is nil, don't highlight the buffer names specially."
1235 If the face doesn't differ from the default face,
1236 don't highlight the prefix with line numbers specially."
1243 yank-handler follow-link)
1244 "Text properties to discard when copying lines to the *Occur* buffer.
1245 The value should be a list of text properties to discard or t,
1246 which means to discard all text properties."
1254 "Collect strings matching regexp"
1259 ;; Perform collect operation
1261 ;; No subexpression so collect the entire match.
1263 ;; Get the regexp for collection pattern.
1268 ;; Otherwise normal occur takes numerical prefix argument.
1273 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1274 Here `original-buffer-name' is the buffer name where Occur was originally run.
1275 When given the prefix argument, or called non-interactively, the renaming
1276 will not clobber the existing buffer(s) of that name, but use
1277 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1278 if you always want a separate *Occur* buffer for each buffer where you
1279 invoke `occur'."
1290 "Show all lines in the current buffer containing a match for REGEXP.
1291 If a match spreads across multiple lines, all those lines are shown.
1293 Each line is displayed with NLINES lines before and after, or -NLINES
1294 before if NLINES is negative.
1295 NLINES defaults to `list-matching-lines-default-context-lines'.
1296 Interactively it is the prefix arg.
1298 The lines are shown in a buffer named `*Occur*'.
1299 It serves as a menu to find any of the occurrences in this buffer.
1303 and `search-upper-case' is non-nil, the matching is case-sensitive.
1305 When NLINES is a string or when the function is called
1306 interactively with prefix argument without a number (`C-u' alone
1307 as prefix) the matching strings are collected into the `*Occur*'
1308 buffer by using NLINES as a replacement regexp. NLINES may
1312 program. When there is no parenthesized subexpressions in REGEXP
1313 the entire match is collected. In any case the searched buffer
1314 is not modified."
1321 "Show all lines in buffers BUFS containing a match for REGEXP.
1322 This function acts on multiple buffers; otherwise, it is exactly like
1323 `occur'. When you invoke this command interactively, you must specify
1324 the buffer names that you want, one by one.
1325 See also `multi-occur-in-matching-buffers'."
1335 "Next buffer to search (C-j to end): "
1337 nil t))
1346 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1347 Normally BUFREGEXP matches against each buffer's visited file name,
1348 but if you specify a prefix argument, it matches against the buffer name.
1349 See also `multi-occur'."
1356 "List lines in buffers whose names match regexp: "
1359 default
1360 input))
1372 buf))
1383 bufs))))
1384 ;; Handle the case where one of the buffers we're searching is the
1385 ;; output buffer. Just rename it.
1390 ;; Now find or create the output buffer.
1391 ;; If we just renamed that buffer, we will make a new one here.
1399 ;; Don't generate undo entries for creation of the initial contents.
1404 ;; Treat nlines as a regexp to collect.
1412 ;; Insert the replacement regexp.
1421 count)
1422 ;; Perform normal occur.
1424 regexp active-bufs occur-buf
1428 case-fold-search)
1429 list-matching-lines-buffer-name-face
1431 list-matching-lines-prefix-face)
1432 list-matching-lines-face
1441 ;; Don't display regexp if with remaining text
1442 ;; it is longer than window-width.
1455 title-face prefix-face match-face keep-props)
1461 ;; Map over all the buffers
1480 ;; Set CODING only if the current buffer locally
1481 ;; binds buffer-file-coding-system.
1491 ;; Get beginning of first match line and end of the last.
1497 ;; Sum line numbers up to the first match line.
1502 ;; Highlight the matches
1512 ;; Add `match-face' to faces copied from the buffer.
1515 match-face nil curstring))
1516 ;; Avoid infloop (Bug#7593).
1519 ;; Generate the string to insert for this match
1521 ;; Using 7 digits aligns tabs properly.
1527 ;; Allow insertion of text at
1528 ;; the end of the prefix (for
1529 ;; Occur Edit mode).
1530 front-sticky t rear-nonsticky t
1531 occur-target ,marker follow-link t
1534 ;; We don't put `mouse-face' on the newline,
1535 ;; because that loses. And don't put it
1536 ;; on context lines to reduce flicker.
1538 'occur-target marker
1539 'follow-link t
1540 'help-echo
1544 match-prefix
1545 ;; Add non-numeric prefix to all non-first lines
1546 ;; of multi-line matches.
1552 match-str)
1553 ;; Add marker at eol, but no mouse props.
1557 ;; The simple display style
1558 out-line
1559 ;; The complex multi-line display style.
1561 out-line nlines keep-props begpt endpt
1562 curr-line prev-line prev-after-lines
1563 prefix-face))
1564 ;; Set first elem of the returned list to `data',
1565 ;; and the second elem to `prev-after-lines'.
1568 ;; Actually insert the match display data
1574 ;; Sum line numbers between first and last match lines.
1576 ;; Add 1 for empty last match line since
1577 ;; count-lines returns 1 line less.
1579 ;; On to the next match...
1583 ;; Flush remaining context after-lines.
1587 prev-after-lines prefix-face)))))))
1594 end)
1598 ;; Don't display the same number of lines
1599 ;; and matches in case of 1 match per line.
1603 ;; Don't display regexp for multi-buffer.
1614 ;; Display total match count and regexp for multi-buffer.
1618 end)
1621 ;; Don't display the same number of lines
1622 ;; and matches in case of 1 match per line.
1632 ;; CODING is buffer-file-coding-system of the first buffer
1633 ;; that locally binds it. Let's use it also for the output
1634 ;; buffer.
1636 ;; Return the number of matches
1637 global-matches)))
1648 str)
1658 lines))
1665 result beg end moved)
1677 ;; Generate context display for occur.
1678 ;; OUT-LINE is the line where the match is.
1679 ;; NLINES and KEEP-PROPS are args to occur-engine.
1680 ;; CURR-LINE is line count of the current match,
1681 ;; PREV-LINE is line count of the previous match,
1682 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1683 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1684 ;; then concatenate them all together.
1686 curr-line prev-line prev-after-lines
1688 ;; Find after- and before-context lines of the current match.
1695 separator)
1697 ;; Combine after-lines of the previous match
1698 ;; with before-lines of the current match.
1701 ;; Don't overlap prev after-lines with current before-lines.
1708 ;; Separate non-overlapping context lines with a dashed line.
1712 ;; Don't overlap current before-lines with previous match line.
1714 prev-line)
1718 before-lines))
1719 ;; Separate non-overlapping before-context lines.
1724 ;; Return a list where the first element is the output line.
1732 separator)))
1735 ;; And the second element is the list of context after-lines.
1738 \f
1739 ;; It would be nice to use \\[...], but there is no reasonable way
1740 ;; to make that display both SPC and Y.
1742 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1743 RET or `q' to exit, Period to replace one match and exit,
1744 Comma to replace but not move point immediately,
1746 C-w to delete match and recursive edit,
1747 C-l to clear the screen, redisplay, and offer same replacement again,
1748 ! to replace all remaining matches in this buffer with no more questions,
1749 ^ to move point back to previous match,
1750 E to edit the replacement string.
1751 In multi-buffer replacements type `Y' to replace all remaining
1752 matches in all remaining buffers with no more questions,
1753 `N' to skip to the next buffer without replacing remaining matches
1754 in the current buffer."
1762 (define-key map [backspace] 'skip)
1763 (define-key map "y" 'act)
1764 (define-key map "n" 'skip)
1765 (define-key map "Y" 'act)
1766 (define-key map "N" 'skip)
1767 (define-key map "e" 'edit-replacement)
1768 (define-key map "E" 'edit-replacement)
1769 (define-key map "," 'act-and-show)
1770 (define-key map "q" 'exit)
1772 (define-key map [return] 'exit)
1773 (define-key map "." 'act-and-exit)
1774 (define-key map "\C-r" 'edit)
1775 (define-key map "\C-w" 'delete-and-edit)
1776 (define-key map "\C-l" 'recenter)
1777 (define-key map "!" 'automatic)
1778 (define-key map "^" 'backup)
1779 (define-key map "\C-h" 'help)
1780 (define-key map [f1] 'help)
1781 (define-key map [help] 'help)
1782 (define-key map "?" 'help)
1783 (define-key map "\C-g" 'quit)
1784 (define-key map "\C-]" 'quit)
1785 (define-key map "\C-v" 'scroll-up)
1786 (define-key map "\M-v" 'scroll-down)
1787 (define-key map [next] 'scroll-up)
1788 (define-key map [prior] 'scroll-down)
1789 (define-key map [?\C-\M-v] 'scroll-other-window)
1790 (define-key map [M-next] 'scroll-other-window)
1791 (define-key map [?\C-\M-\S-v] 'scroll-other-window-down)
1792 (define-key map [M-prior] 'scroll-other-window-down)
1793 ;; Binding ESC would prohibit the M-v binding. Instead, callers
1794 ;; should check for ESC specially.
1795 ;; (define-key map "\e" 'exit-prefix)
1796 (define-key map [escape] 'exit-prefix)
1797 map)
1798 "Keymap of responses to questions posed by commands like `query-replace'.
1800 The valid answers include `act', `skip', `act-and-show',
1801 `act-and-exit', `exit', `exit-prefix', `recenter', `scroll-up',
1802 `scroll-down', `scroll-other-window', `scroll-other-window-down',
1803 `edit', `edit-replacement', `delete-and-edit', `automatic',
1804 `backup', `quit', and `help'.
1806 This keymap is used by `y-or-n-p' as well as `query-replace'.")
1808 (defvar multi-query-replace-map
1809 (let ((map (make-sparse-keymap)))
1810 (set-keymap-parent map query-replace-map)
1811 (define-key map "Y" 'automatic-all)
1812 (define-key map "N" 'exit-current)
1813 map)
1814 "Keymap that defines additional bindings for multi-buffer replacements.
1815 It extends its parent map `query-replace-map' with new bindings to
1816 operate on a set of buffers/files. The difference with its parent map
1817 is the additional answers `automatic-all' to replace all remaining
1818 matches in all remaining buffers with no more questions, and
1819 `exit-current' to skip remaining matches in the current buffer
1820 and to continue with the next buffer in the sequence.")
1822 (defun replace-match-string-symbols (n)
1823 "Process a list (and any sub-lists), expanding certain symbols.
1824 Symbol Expands To
1825 N (match-string N) (where N is a string of digits)
1826 #N (string-to-number (match-string N))
1827 & (match-string 0)
1828 #& (string-to-number (match-string 0))
1829 # replace-count
1831 Note that these symbols must be preceded by a backslash in order to
1832 type them using Lisp syntax."
1833 (while (consp n)
1834 (cond
1835 ((consp (car n))
1836 (replace-match-string-symbols (car n))) ;Process sub-list
1837 ((symbolp (car n))
1838 (let ((name (symbol-name (car n))))
1839 (cond
1840 ((string-match "^[0-9]+$" name)
1841 (setcar n (list 'match-string (string-to-number name))))
1842 ((string-match "^#[0-9]+$" name)
1843 (setcar n (list 'string-to-number
1844 (list 'match-string
1845 (string-to-number (substring name 1))))))
1846 ((string= "&" name)
1847 (setcar n '(match-string 0)))
1848 ((string= "#&" name)
1849 (setcar n '(string-to-number (match-string 0))))
1850 ((string= "#" name)
1851 (setcar n 'replace-count))))))
1852 (setq n (cdr n))))
1854 (defun replace-eval-replacement (expression count)
1855 (let* ((replace-count count)
1856 err
1857 (replacement
1858 (condition-case err
1859 (eval expression)
1860 (error
1861 (error "Error evaluating replacement expression: %S" err)))))
1862 (if (stringp replacement)
1863 replacement
1864 (prin1-to-string replacement t))))
1866 (defun replace-quote (replacement)
1867 "Quote a replacement string.
1868 This just doubles all backslashes in REPLACEMENT and
1869 returns the resulting string. If REPLACEMENT is not
1870 a string, it is first passed through `prin1-to-string'
1871 with the `noescape' argument set.
1873 `match-data' is preserved across the call."
1874 (save-match-data
1876 (if (stringp replacement)
1877 replacement
1878 (prin1-to-string replacement t))
1879 t t)))
1881 (defun replace-loop-through-replacements (data count)
1882 ;; DATA is a vector containing the following values:
1883 ;; 0 next-rotate-count
1884 ;; 1 repeat-count
1885 ;; 2 next-replacement
1886 ;; 3 replacements
1887 (if (= (aref data 0) count)
1888 (progn
1889 (aset data 0 (+ count (aref data 1)))
1890 (let ((next (cdr (aref data 2))))
1891 (aset data 2 (if (consp next) next (aref data 3))))))
1892 (car (aref data 2)))
1894 (defun replace-match-data (integers reuse &optional new)
1895 "Like `match-data', but markers in REUSE get invalidated.
1896 If NEW is non-nil, it is set and returned instead of fresh data,
1897 but coerced to the correct value of INTEGERS."
1898 (or (and new
1899 (progn
1900 (set-match-data new)
1901 (and (eq new reuse)
1902 (eq (null integers) (markerp (car reuse)))
1903 new)))
1904 (match-data integers reuse t)))
1906 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data backward)
1908 FIXEDCASE, LITERAL are passed to `replace-match' (which see).
1911 is made (to save time). MATCH-DATA is used for the replacement.
1912 In case editing is done, it is changed to use markers.
1915 passed in. If LITERAL is set, no checking is done, anyway."
1916 (unless (or literal noedit)
1917 (setq noedit t)
1919 newtext)
1920 (setq newtext
1921 (read-string "Edit replacement string: "
1922 (prog1
1923 (cons
1924 (replace-match "" t t newtext 3)
1925 (1+ (match-beginning 3)))
1926 (setq match-data
1927 (replace-match-data
1928 nil match-data match-data))))
1929 noedit nil)))
1930 (set-match-data match-data)
1931 (replace-match newtext fixedcase literal)
1932 ;; `replace-match' leaves point at the end of the replacement text,
1933 ;; so move point to the beginning when replacing backward.
1934 (when backward (goto-char (nth 0 match-data)))
1935 noedit)
1937 (defvar replace-search-function nil
1938 "Function to use when searching for strings to replace.
1939 It is used by `query-replace' and `replace-string', and is called
1940 with three arguments, as if it were `search-forward'.")
1942 (defvar replace-re-search-function nil
1943 "Function to use when searching for regexps to replace.
1944 It is used by `query-replace-regexp', `replace-regexp',
1945 `query-replace-regexp-eval', and `map-query-replace-regexp'.
1946 It is called with three arguments, as if it were
1947 `re-search-forward'.")
1949 (defun replace-search (search-string limit regexp-flag delimited-flag
1950 case-fold-search backward)
1951 "Search for the next occurrence of SEARCH-STRING to replace."
1952 ;; Let-bind global isearch-* variables to values used
1953 ;; to search the next replacement. These let-bindings
1954 ;; should be effective both at the time of calling
1955 ;; `isearch-search-fun-default' and also at the
1956 ;; time of funcalling `search-function'.
1957 ;; These isearch-* bindings can't be placed higher
1958 ;; outside of this function because then another I-search
1959 ;; used after `recursive-edit' might override them.
1960 (let* ((isearch-regexp regexp-flag)
1961 (isearch-word delimited-flag)
1962 (isearch-lax-whitespace
1963 replace-lax-whitespace)
1964 (isearch-regexp-lax-whitespace
1965 replace-regexp-lax-whitespace)
1966 (isearch-case-fold-search case-fold-search)
1967 (isearch-adjusted nil)
1968 (isearch-nonincremental t) ; don't use lax word mode
1969 (isearch-forward (not backward))
1970 (search-function
1971 (or (if regexp-flag
1972 replace-re-search-function
1973 replace-search-function)
1974 (isearch-search-fun-default))))
1975 (funcall search-function search-string limit t)))
1977 (defvar replace-overlay nil)
1979 (defun replace-highlight (match-beg match-end range-beg range-end
1980 search-string regexp-flag delimited-flag
1981 case-fold-search backward)
1982 (if query-replace-highlight
1983 (if replace-overlay
1984 (move-overlay replace-overlay match-beg match-end (current-buffer))
1985 (setq replace-overlay (make-overlay match-beg match-end))
1986 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
1987 (overlay-put replace-overlay 'face 'query-replace)))
1988 (if query-replace-lazy-highlight
1989 (let ((isearch-string search-string)
1990 (isearch-regexp regexp-flag)
1991 (isearch-word delimited-flag)
1992 (isearch-lax-whitespace
1993 replace-lax-whitespace)
1994 (isearch-regexp-lax-whitespace
1995 replace-regexp-lax-whitespace)
1996 (isearch-case-fold-search case-fold-search)
1997 (isearch-forward (not backward))
1998 (isearch-other-end match-beg)
1999 (isearch-error nil))
2000 (isearch-lazy-highlight-new-loop range-beg range-end))))
2002 (defun replace-dehighlight ()
2003 (when replace-overlay
2004 (delete-overlay replace-overlay))
2005 (when query-replace-lazy-highlight
2006 (lazy-highlight-cleanup lazy-highlight-cleanup)
2007 (setq isearch-lazy-highlight-last-string nil))
2008 ;; Close overlays opened by `isearch-range-invisible' in `perform-replace'.
2009 (isearch-clean-overlays))
2011 (defun perform-replace (from-string replacements
2012 query-flag regexp-flag delimited-flag
2013 &optional repeat-count map start end backward)
2014 "Subroutine of `query-replace'. Its complexity handles interactive queries.
2015 Don't use this in your own program unless you want to query and set the mark
2016 just as `query-replace' does. Instead, write a simple loop like this:
2021 which will run faster and probably do exactly what you want. Please
2022 see the documentation of `replace-match' to find out how to simulate
2023 `case-replace'.
2025 This function returns nil if and only if there were no matches to
2026 make, or the user didn't cancel the call."
2027 (or map (setq map query-replace-map))
2028 (and query-flag minibuffer-auto-raise
2029 (raise-frame (window-frame (minibuffer-window))))
2030 (let* ((case-fold-search
2031 (if (and case-fold-search search-upper-case)
2032 (isearch-no-upper-case-p from-string regexp-flag)
2033 case-fold-search))
2034 (nocasify (not (and case-replace case-fold-search)))
2035 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
2036 (search-string from-string)
2037 (real-match-data nil) ; The match data for the current match.
2038 (next-replacement nil)
2039 ;; This is non-nil if we know there is nothing for the user
2040 ;; to edit in the replacement.
2041 (noedit nil)
2042 (keep-going t)
2043 (stack nil)
2044 (replace-count 0)
2045 (skip-read-only-count 0)
2046 (skip-filtered-count 0)
2047 (skip-invisible-count 0)
2048 (nonempty-match nil)
2049 (multi-buffer nil)
2050 (recenter-last-op nil) ; Start cycling order with initial position.
2052 ;; If non-nil, it is marker saying where in the buffer to stop.
2053 (limit nil)
2055 ;; Data for the next match. If a cons, it has the same format as
2056 ;; (match-data); otherwise it is t if a match is possible at point.
2057 (match-again t)
2059 (message
2060 (if query-flag
2061 (apply 'propertize
2062 (substitute-command-keys
2064 minibuffer-prompt-properties))))
2066 ;; If region is active, in Transient Mark mode, operate on region.
2067 (if backward
2068 (when end
2069 (setq limit (copy-marker (min start end)))
2070 (goto-char (max start end))
2071 (deactivate-mark))
2072 (when start
2073 (setq limit (copy-marker (max start end)))
2074 (goto-char (min start end))
2075 (deactivate-mark)))
2077 ;; If last typed key in previous call of multi-buffer perform-replace
2078 ;; was `automatic-all', don't ask more questions in next files
2079 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
2080 (setq query-flag nil multi-buffer t))
2082 ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
2083 ;; containing a function and its first argument. The function is
2084 ;; called to generate each replacement like this:
2085 ;; (funcall (car replacements) (cdr replacements) replace-count)
2086 ;; It must return a string.
2087 (cond
2088 ((stringp replacements)
2089 (setq next-replacement replacements
2090 replacements nil))
2091 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
2092 (or repeat-count (setq repeat-count 1))
2093 (setq replacements (cons 'replace-loop-through-replacements
2094 (vector repeat-count repeat-count
2095 replacements replacements)))))
2097 (when query-replace-lazy-highlight
2098 (setq isearch-lazy-highlight-last-string nil))
2100 (push-mark)
2101 (undo-boundary)
2102 (unwind-protect
2103 ;; Loop finding occurrences that perhaps should be replaced.
2104 (while (and keep-going
2105 (if backward
2106 (not (or (bobp) (and limit (<= (point) limit))))
2107 (not (or (eobp) (and limit (>= (point) limit)))))
2108 ;; Use the next match if it is already known;
2109 ;; otherwise, search for a match after moving forward
2110 ;; one char if progress is required.
2111 (setq real-match-data
2112 (cond ((consp match-again)
2113 (goto-char (if backward
2114 (nth 0 match-again)
2115 (nth 1 match-again)))
2116 (replace-match-data
2117 t real-match-data match-again))
2118 ;; MATCH-AGAIN non-nil means accept an
2119 ;; adjacent match.
2120 (match-again
2121 (and
2122 (replace-search search-string limit
2123 regexp-flag delimited-flag
2124 case-fold-search backward)
2125 ;; For speed, use only integers and
2126 ;; reuse the list used last time.
2127 (replace-match-data t real-match-data)))
2128 ((and (if backward
2129 (> (1- (point)) (point-min))
2130 (< (1+ (point)) (point-max)))
2131 (or (null limit)
2132 (if backward
2133 (> (1- (point)) limit)
2134 (< (1+ (point)) limit))))
2135 ;; If not accepting adjacent matches,
2136 ;; move one char to the right before
2137 ;; searching again. Undo the motion
2138 ;; if the search fails.
2139 (let ((opoint (point)))
2140 (forward-char (if backward -1 1))
2141 (if (replace-search search-string limit
2142 regexp-flag delimited-flag
2143 case-fold-search backward)
2144 (replace-match-data
2145 t real-match-data)
2146 (goto-char opoint)
2147 nil))))))
2149 ;; Record whether the match is nonempty, to avoid an infinite loop
2150 ;; repeatedly matching the same empty string.
2151 (setq nonempty-match
2152 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
2154 ;; If the match is empty, record that the next one can't be
2155 ;; adjacent.
2157 ;; Otherwise, if matching a regular expression, do the next
2158 ;; match now, since the replacement for this match may
2159 ;; affect whether the next match is adjacent to this one.
2160 ;; If that match is empty, don't use it.
2161 (setq match-again
2162 (and nonempty-match
2163 (or (not regexp-flag)
2164 (and (if backward
2165 (looking-back search-string)
2166 (looking-at search-string))
2167 (let ((match (match-data)))
2168 (and (/= (nth 0 match) (nth 1 match))
2169 match))))))
2171 (cond
2172 ;; Optionally ignore matches that have a read-only property.
2173 ((not (or (not query-replace-skip-read-only)
2174 (not (text-property-not-all
2175 (nth 0 real-match-data) (nth 1 real-match-data)
2176 'read-only nil))))
2177 (setq skip-read-only-count (1+ skip-read-only-count)))
2178 ;; Optionally filter out matches.
2179 ((not (funcall isearch-filter-predicate
2180 (nth 0 real-match-data) (nth 1 real-match-data)))
2181 (setq skip-filtered-count (1+ skip-filtered-count)))
2182 ;; Optionally ignore invisible matches.
2183 ((not (or (eq search-invisible t)
2184 ;; Don't open overlays for automatic replacements.
2185 (and (not query-flag) search-invisible)
2186 ;; Open hidden overlays for interactive replacements.
2187 (not (isearch-range-invisible
2188 (nth 0 real-match-data) (nth 1 real-match-data)))))
2189 (setq skip-invisible-count (1+ skip-invisible-count)))
2190 (t
2191 ;; Calculate the replacement string, if necessary.
2192 (when replacements
2193 (set-match-data real-match-data)
2194 (setq next-replacement
2195 (funcall (car replacements) (cdr replacements)
2196 replace-count)))
2197 (if (not query-flag)
2198 (progn
2199 (unless (or literal noedit)
2200 (replace-highlight
2201 (nth 0 real-match-data) (nth 1 real-match-data)
2202 start end search-string
2203 regexp-flag delimited-flag case-fold-search backward))
2204 (setq noedit
2205 (replace-match-maybe-edit
2206 next-replacement nocasify literal
2207 noedit real-match-data backward)
2208 replace-count (1+ replace-count)))
2209 (undo-boundary)
2210 (let (done replaced key def)
2211 ;; Loop reading commands until one of them sets done,
2212 ;; which means it has finished handling this
2213 ;; occurrence. Any command that sets `done' should
2214 ;; leave behind proper match data for the stack.
2215 ;; Commands not setting `done' need to adjust
2216 ;; `real-match-data'.
2217 (while (not done)
2218 (set-match-data real-match-data)
2219 (replace-highlight
2220 (match-beginning 0) (match-end 0)
2221 start end search-string
2222 regexp-flag delimited-flag case-fold-search backward)
2223 ;; Bind message-log-max so we don't fill up the message log
2224 ;; with a bunch of identical messages.
2225 (let ((message-log-max nil)
2226 (replacement-presentation
2227 (if query-replace-show-replacement
2228 (save-match-data
2229 (set-match-data real-match-data)
2230 (match-substitute-replacement next-replacement
2231 nocasify literal))
2232 next-replacement)))
2233 (message message
2234 (query-replace-descr from-string)
2235 (query-replace-descr replacement-presentation)))
2236 (setq key (read-event))
2237 ;; Necessary in case something happens during read-event
2238 ;; that clobbers the match data.
2239 (set-match-data real-match-data)
2240 (setq key (vector key))
2241 (setq def (lookup-key map key))
2242 ;; Restore the match data while we process the command.
2243 (cond ((eq def 'help)
2244 (with-output-to-temp-buffer "*Help*"
2245 (princ
2246 (concat "Query replacing "
2247 (if delimited-flag
2248 (or (and (symbolp delimited-flag)
2249 (get delimited-flag 'isearch-message-prefix))
2250 "word ") "")
2251 (if regexp-flag "regexp " "")
2252 (if backward "backward " "")
2253 from-string " with "
2255 (substitute-command-keys
2256 query-replace-help)))
2257 (with-current-buffer standard-output
2258 (help-mode))))
2259 ((eq def 'exit)
2260 (setq keep-going nil)
2261 (setq done t))
2262 ((eq def 'exit-current)
2263 (setq multi-buffer t keep-going nil done t))
2264 ((eq def 'backup)
2265 (if stack
2266 (let ((elt (pop stack)))
2267 (goto-char (nth 0 elt))
2268 (setq replaced (nth 1 elt)
2269 real-match-data
2270 (replace-match-data
2271 t real-match-data
2272 (nth 2 elt))))
2273 (message "No previous match")
2274 (ding 'no-terminate)
2275 (sit-for 1)))
2276 ((eq def 'act)
2277 (or replaced
2278 (setq noedit
2279 (replace-match-maybe-edit
2280 next-replacement nocasify literal
2281 noedit real-match-data backward)
2282 replace-count (1+ replace-count)))
2283 (setq done t replaced t))
2284 ((eq def 'act-and-exit)
2285 (or replaced
2286 (setq noedit
2287 (replace-match-maybe-edit
2288 next-replacement nocasify literal
2289 noedit real-match-data backward)
2290 replace-count (1+ replace-count)))
2291 (setq keep-going nil)
2292 (setq done t replaced t))
2293 ((eq def 'act-and-show)
2294 (if (not replaced)
2295 (setq noedit
2296 (replace-match-maybe-edit
2297 next-replacement nocasify literal
2298 noedit real-match-data backward)
2299 replace-count (1+ replace-count)
2300 real-match-data (replace-match-data
2301 t real-match-data)
2302 replaced t)))
2303 ((or (eq def 'automatic) (eq def 'automatic-all))
2304 (or replaced
2305 (setq noedit
2306 (replace-match-maybe-edit
2307 next-replacement nocasify literal
2308 noedit real-match-data backward)
2309 replace-count (1+ replace-count)))
2310 (setq done t query-flag nil replaced t)
2311 (if (eq def 'automatic-all) (setq multi-buffer t)))
2312 ((eq def 'skip)
2313 (setq done t))
2314 ((eq def 'recenter)
2315 ;; `this-command' has the value `query-replace',
2316 ;; so we need to bind it to `recenter-top-bottom'
2317 ;; to allow it to detect a sequence of `C-l'.
2318 (let ((this-command 'recenter-top-bottom)
2319 (last-command 'recenter-top-bottom))
2320 (recenter-top-bottom)))
2321 ((eq def 'edit)
2322 (let ((opos (point-marker)))
2323 (setq real-match-data (replace-match-data
2324 nil real-match-data
2325 real-match-data))
2326 (goto-char (match-beginning 0))
2327 (save-excursion
2328 (save-window-excursion
2329 (recursive-edit)))
2330 (goto-char opos)
2331 (set-marker opos nil))
2332 ;; Before we make the replacement,
2333 ;; decide whether the search string
2334 ;; can match again just after this match.
2335 (if (and regexp-flag nonempty-match)
2336 (setq match-again (and (looking-at search-string)
2337 (match-data)))))
2338 ;; Edit replacement.
2339 ((eq def 'edit-replacement)
2340 (setq real-match-data (replace-match-data
2341 nil real-match-data
2342 real-match-data)
2343 next-replacement
2344 (read-string "Edit replacement string: "
2345 next-replacement)
2346 noedit nil)
2347 (if replaced
2348 (set-match-data real-match-data)
2349 (setq noedit
2350 (replace-match-maybe-edit
2351 next-replacement nocasify literal noedit
2352 real-match-data backward)
2353 replaced t))
2354 (setq done t))
2356 ((eq def 'delete-and-edit)
2357 (replace-match "" t t)
2358 (setq real-match-data (replace-match-data
2359 nil real-match-data))
2360 (replace-dehighlight)
2361 (save-excursion (recursive-edit))
2362 (setq replaced t))
2363 ;; Note: we do not need to treat `exit-prefix'
2364 ;; specially here, since we reread
2365 ;; any unrecognized character.
2366 (t
2367 (setq this-command 'mode-exited)
2368 (setq keep-going nil)
2369 (setq unread-command-events
2370 (append (listify-key-sequence key)
2371 unread-command-events))
2372 (setq done t)))
2373 (when query-replace-lazy-highlight
2374 ;; Force lazy rehighlighting only after replacements.
2375 (if (not (memq def '(skip backup)))
2376 (setq isearch-lazy-highlight-last-string nil)))
2377 (unless (eq def 'recenter)
2378 ;; Reset recenter cycling order to initial position.
2379 (setq recenter-last-op nil)))
2380 ;; Record previous position for ^ when we move on.
2381 ;; Change markers to numbers in the match data
2382 ;; since lots of markers slow down editing.
2383 (push (list (point) replaced
2384 ;;; If the replacement has already happened, all we need is the
2385 ;;; current match start and end. We could get this with a trivial
2386 ;;; match like
2387 ;;; (save-excursion (goto-char (match-beginning 0))
2388 ;;; (search-forward (match-string 0))
2389 ;;; (match-data t))
2390 ;;; if we really wanted to avoid manually constructing match data.
2391 ;;; Adding current-buffer is necessary so that match-data calls can
2392 ;;; return markers which are appropriate for editing.
2393 (if replaced
2394 (list
2395 (match-beginning 0)
2396 (match-end 0)
2397 (current-buffer))
2398 (match-data t)))
2399 stack))))))
2401 (replace-dehighlight))
2402 (or unread-command-events
2403 (message "Replaced %d occurrence%s%s"
2404 replace-count
2405 (if (= replace-count 1) "" "s")
2406 (if (> (+ skip-read-only-count
2407 skip-filtered-count
2408 skip-invisible-count) 0)
2409 (format " (skipped %s)"
2410 (mapconcat
2411 'identity
2412 (delq nil (list
2413 (if (> skip-read-only-count 0)
2414 (format "%s read-only"
2415 skip-read-only-count))
2416 (if (> skip-invisible-count 0)
2417 (format "%s invisible"
2418 skip-invisible-count))
2419 (if (> skip-filtered-count 0)
2420 (format "%s filtered out"
2421 skip-filtered-count))))
2422 ", "))
2423 "")))
2424 (or (and keep-going stack) multi-buffer)))
2426 ;;; replace.el ends here