| blob | 42f7f3c900a7488d0173ea2f8e24d2ccf94951f4 |
1 ;;; replace.el --- replace commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2013
4 ;; Free Software Foundation, Inc.
6 ;; Maintainer: FSF
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.
454 to pull the last incremental search regexp to the minibuffer
455 that reads REGEXP.
457 A prefix argument N says to use each replacement string N times
458 before rotating to the next.
459 Fourth and fifth arg START and END specify the region to operate on."
462 query-replace-from-history-variable))
466 nil nil nil
467 query-replace-to-history-variable from t)))
491 "Replace occurrences of FROM-STRING with TO-STRING.
492 Preserve case in each match if `case-replace' and `case-fold-search'
493 are non-nil and FROM-STRING has no uppercase letters.
494 \(Preserving case means that if the string matched is all caps, or capitalized,
495 then its replacement is upcased or capitalized.)
497 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
498 ignore hidden matches if `search-invisible' is nil, and ignore more
499 matches using `isearch-filter-predicate'.
501 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
502 to be replaced will match a sequence of whitespace chars defined by the
503 regexp in `search-whitespace-regexp'.
505 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
506 only matches surrounded by word boundaries. A negative prefix arg means
507 replace backward.
509 Operates on the region between START and END (if both are nil, from point
510 to the end of the buffer). Interactively, if Transient Mark mode is
511 enabled and the mark is active, operates on the contents of the region;
512 otherwise from point to the end of the buffer.
515 to pull the last incremental search string to the minibuffer
516 that reads FROM-STRING.
518 This function is usually the wrong thing to use in a Lisp program.
519 What you probably want is a loop like this:
520 (while (search-forward FROM-STRING nil t)
521 (replace-match TO-STRING nil t))
522 which will run faster and will not set the mark or print anything.
523 \(You may need a more complex loop if FROM-STRING can match the null string
524 and TO-STRING is also null.)"
532 " string"
534 nil)))
546 "Replace things after point matching REGEXP with TO-STRING.
547 Preserve case in each match if `case-replace' and `case-fold-search'
548 are non-nil and REGEXP has no uppercase letters.
550 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
551 ignore hidden matches if `search-invisible' is nil, and ignore more
552 matches using `isearch-filter-predicate'.
554 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
555 to be replaced will match a sequence of whitespace chars defined by the
556 regexp in `search-whitespace-regexp'.
558 In Transient Mark mode, if the mark is active, operate on the contents
559 of the region. Otherwise, operate from point to the end of the buffer.
561 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
562 only matches surrounded by word boundaries. A negative prefix arg means
563 replace backward.
565 Fourth and fifth arg START and END specify the region to operate on.
571 at the given position for each replacement.
574 followed by a Lisp expression used as part of the replacement
578 `replace-count', the number of replacements occurred so far.
580 If your Lisp expression is an identifier and the next letter in
581 the replacement string would be interpreted as part of it, you
584 replacement text directly.
586 When using those Lisp features interactively in the replacement
587 text, TO-STRING is actually made a list instead of a string.
591 to pull the last incremental search regexp to the minibuffer
592 that reads REGEXP.
594 This function is usually the wrong thing to use in a Lisp program.
595 What you probably want is a loop like this:
596 (while (re-search-forward REGEXP nil t)
597 (replace-match TO-STRING nil nil))
598 which will run faster and will not set the mark or print anything."
606 " regexp"
608 t)))
619 \f
621 "History list for some commands that read regular expressions.
623 Maximum length of the history list is determined by the value
630 "Read and return a regular expression as a string.
632 If the first element of DEFAULTS is non-nil, it's added to the prompt.
634 Optional arg DEFAULTS has the form (DEFAULT . SUGGESTIONS)
635 or simply DEFAULT where DEFAULT, if non-nil, should be a string that
636 is returned as the default value when the user enters empty input.
637 SUGGESTIONS is a list of strings that can be inserted into
639 The values supplied in SUGGESTIONS
640 are prepended to the list of standard suggestions that include
641 the tag at point, the last isearch regexp, the last isearch string,
642 and the last replacement regexp.
644 Optional arg HISTORY is a symbol to use for the history list.
645 If HISTORY is nil, `regexp-history' is used."
650 suggestions
657 ;; Do not automatically add default to the history for empty input.
661 prompt)
669 ;; Return the default value when the user enters empty input.
671 ;; Otherwise, add non-empty input to the history and return input.
682 "Read arguments for `keep-lines' and friends.
683 Prompt for a regexp with PROMPT.
684 Value is a list, (REGEXP)."
688 "Delete all lines except those containing matches for REGEXP.
689 A match split across lines preserves all the lines it lies in.
690 When called from Lisp (and usually interactively as well, see below)
691 applies to all lines starting after point.
694 and `search-upper-case' is non-nil, the matching is case-sensitive.
696 Second and third arg RSTART and REND specify the region to operate on.
697 This command operates on (the accessible part of) all lines whose
698 accessible part is entirely contained in the region determined by RSTART
699 and REND. (A newline ending a line counts as part of that line.)
701 Interactively, in Transient Mark mode when the mark is active, operate
702 on all lines whose accessible part is entirely contained in the region.
703 Otherwise, the command applies to all lines starting after point.
704 When calling this function from Lisp, you can pretend that it was
705 called interactively by passing a non-nil INTERACTIVE argument.
707 This function starts looking for the next match from the end of
708 the previous match. Hence, it ignores matches that overlap
709 a previously found match."
741 case-fold-search)))
743 ;; Start is first char not preserved by previous match.
749 ;; Now end is first char preserved by the new match.
754 ;; If the match was empty, avoid matching again at same place.
759 nil)
763 "Delete lines containing matches for REGEXP.
764 When called from Lisp (and usually when called interactively as
765 well, see below), applies to the part of the buffer after point.
766 The line point is in is deleted if and only if it contains a
767 match for regexp starting after point.
770 and `search-upper-case' is non-nil, the matching is case-sensitive.
772 Second and third arg RSTART and REND specify the region to operate on.
773 Lines partially contained in this region are deleted if and only if
774 they contain a match entirely contained in it.
776 Interactively, in Transient Mark mode when the mark is active, operate
777 on the contents of the region. Otherwise, operate from point to the
778 end of (the accessible portion of) the buffer. When calling this function
779 from Lisp, you can pretend that it was called interactively by passing
780 a non-nil INTERACTIVE argument.
782 If a match is split across lines, all the lines it lies in are deleted.
783 They are deleted _before_ looking for the next match. Hence, a match
784 starting on the same line at which another match ended is ignored."
803 case-fold-search)))
812 nil)
816 "Print and return number of matches for REGEXP following point.
817 When called from Lisp and INTERACTIVE is omitted or nil, just return
818 the number, do not print it; if INTERACTIVE is t, the function behaves
819 in all respects as if it had been called interactively.
822 and `search-upper-case' is non-nil, the matching is case-sensitive.
824 Second and third arg RSTART and REND specify the region to operate on.
826 Interactively, in Transient Mark mode when the mark is active, operate
827 on the contents of the region. Otherwise, operate from point to the
828 end of (the accessible portion of) the buffer.
830 This function starts looking for the next match from the end of
831 the previous match. Hence, it ignores matches that overlap
832 a previously found match."
851 opoint
855 case-fold-search)))
863 count
865 count)))
867 \f
872 next-error-follow-minor-mode
875 next-error-follow-minor-mode))))
911 map)
916 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
929 map)
933 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
939 "Hook run when entering Occur mode."
944 "Hook run by Occur when there are any matches."
949 "Hook run by Occur after locating an occurrence.
950 This will be called with the cursor position at the occurrence. An application
951 for this is to reveal context in an outline-mode when the occurrence is hidden."
966 \f
967 ;;; Occur Edit mode
977 map)
981 "Major mode for editing *Occur* buffers.
982 In this mode, changes to the *Occur* buffer are also applied to
983 the originating buffer.
992 "Switch from Occur Edit mode to Occur mode."
1004 col)
1008 ;; Apply occur-target property to inserted (e.g. yanked) text.
1010 ;; Did we insert a newline? Occur Edit mode can't create new
1011 ;; Occur entries; just discard everything after the newline.
1025 line-beg 'occur-prefix nil
1026 line-end))
1038 \f
1040 "Handle `revert-buffer' for Occur mode buffers."
1049 pos))
1053 "Go to the occurrence on the current line."
1057 ;; Actually `event-end' works correctly with a nil argument as
1058 ;; well, so we could dispense with this test, but let's not
1059 ;; rely on this undocumented behavior.
1070 "Go to the occurrence the current line describes, in another window."
1078 "Display in another window the occurrence the current line describes."
1081 window)
1083 ;; This is the way to set point in the proper window.
1103 "Move to the Nth (default 1) next match in an Occur mode buffer."
1108 "Move to the Nth (default 1) previous match in an Occur mode buffer."
1113 "Move to the Nth (default 1) next match in an Occur mode buffer.
1116 ;; we need to run occur-find-match from within the Occur buffer
1118 ;; Choose the buffer and make it current.
1132 #'previous-single-property-change
1135 ;; In case the *Occur* buffer is visible in a nonselected window.
1139 \f
1152 "Face used to highlight matches permanently."
1157 "Default number of context lines included around `list-matching-lines' matches.
1158 A negative number means to include that many lines before the match.
1159 A positive number means to include that many lines both before and after."
1167 If the value is nil, don't highlight the matching portions specially."
1173 If the value is nil, don't highlight the buffer names specially."
1179 If the face doesn't differ from the default face,
1180 don't highlight the prefix with line numbers specially."
1187 yank-handler follow-link)
1188 "Text properties to discard when copying lines to the *Occur* buffer.
1189 The value should be a list of text properties to discard or t,
1190 which means to discard all text properties."
1196 'occur-read-regexp-defaults
1197 "Function that provides default regexp(s) for occur commands.
1198 This function should take no arguments and return one of nil, a
1199 regexp or a list of regexps for use with occur commands -
1200 `occur', `multi-occur' and `multi-occur-in-matching-buffers'.
1201 The return value of this function is used as DEFAULTS param of
1202 `read-regexp' while executing the occur command. This function
1203 is called only during interactive use.
1205 For example, to check for occurrence of symbol at point use
1207 (setq occur-read-regexp-defaults-function
1211 "Return the latest regexp from `regexp-history'.
1212 See `occur-read-regexp-defaults-function' for details."
1218 "Collect strings matching regexp"
1223 ;; Perform collect operation
1225 ;; No subexpression so collect the entire match.
1227 ;; Get the regexp for collection pattern.
1232 ;; Otherwise normal occur takes numerical prefix argument.
1237 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1238 Here `original-buffer-name' is the buffer name where Occur was originally run.
1239 When given the prefix argument, or called non-interactively, the renaming
1240 will not clobber the existing buffer(s) of that name, but use
1241 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1242 if you always want a separate *Occur* buffer for each buffer where you
1243 invoke `occur'."
1254 "Show all lines in the current buffer containing a match for REGEXP.
1255 If a match spreads across multiple lines, all those lines are shown.
1257 Each line is displayed with NLINES lines before and after, or -NLINES
1258 before if NLINES is negative.
1259 NLINES defaults to `list-matching-lines-default-context-lines'.
1260 Interactively it is the prefix arg.
1262 The lines are shown in a buffer named `*Occur*'.
1263 It serves as a menu to find any of the occurrences in this buffer.
1267 and `search-upper-case' is non-nil, the matching is case-sensitive.
1269 When NLINES is a string or when the function is called
1270 interactively with prefix argument without a number (`C-u' alone
1271 as prefix) the matching strings are collected into the `*Occur*'
1272 buffer by using NLINES as a replacement regexp. NLINES may
1276 program. When there is no parenthesized subexpressions in REGEXP
1277 the entire match is collected. In any case the searched buffer
1278 is not modified."
1285 "Show all lines in buffers BUFS containing a match for REGEXP.
1286 This function acts on multiple buffers; otherwise, it is exactly like
1287 `occur'. When you invoke this command interactively, you must specify
1288 the buffer names that you want, one by one.
1289 See also `multi-occur-in-matching-buffers'."
1299 "Next buffer to search (C-j to end): "
1301 nil t))
1310 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1311 Normally BUFREGEXP matches against each buffer's visited file name,
1312 but if you specify a prefix argument, it matches against the buffer name.
1313 See also `multi-occur'."
1320 "List lines in buffers whose names match regexp: "
1323 default
1324 input))
1336 buf))
1347 bufs))))
1348 ;; Handle the case where one of the buffers we're searching is the
1349 ;; output buffer. Just rename it.
1354 ;; Now find or create the output buffer.
1355 ;; If we just renamed that buffer, we will make a new one here.
1363 ;; Don't generate undo entries for creation of the initial contents.
1368 ;; Treat nlines as a regexp to collect.
1376 ;; Insert the replacement regexp.
1385 count)
1386 ;; Perform normal occur.
1388 regexp active-bufs occur-buf
1392 case-fold-search)
1393 list-matching-lines-buffer-name-face
1395 list-matching-lines-prefix-face)
1396 list-matching-lines-face
1405 ;; Don't display regexp if with remaining text
1406 ;; it is longer than window-width.
1419 title-face prefix-face match-face keep-props)
1425 ;; Map over all the buffers
1444 ;; Set CODING only if the current buffer locally
1445 ;; binds buffer-file-coding-system.
1455 ;; Get beginning of first match line and end of the last.
1461 ;; Sum line numbers up to the first match line.
1466 ;; Highlight the matches
1476 ;; Add `match-face' to faces copied from the buffer.
1479 match-face nil curstring))
1480 ;; Avoid infloop (Bug#7593).
1483 ;; Generate the string to insert for this match
1485 ;; Using 7 digits aligns tabs properly.
1491 ;; Allow insertion of text at
1492 ;; the end of the prefix (for
1493 ;; Occur Edit mode).
1494 front-sticky t rear-nonsticky t
1495 occur-target ,marker follow-link t
1498 ;; We don't put `mouse-face' on the newline,
1499 ;; because that loses. And don't put it
1500 ;; on context lines to reduce flicker.
1502 'occur-target marker
1503 'follow-link t
1504 'help-echo
1508 match-prefix
1509 ;; Add non-numeric prefix to all non-first lines
1510 ;; of multi-line matches.
1516 match-str)
1517 ;; Add marker at eol, but no mouse props.
1521 ;; The simple display style
1522 out-line
1523 ;; The complex multi-line display style.
1525 out-line nlines keep-props begpt endpt
1526 curr-line prev-line prev-after-lines
1527 prefix-face))
1528 ;; Set first elem of the returned list to `data',
1529 ;; and the second elem to `prev-after-lines'.
1532 ;; Actually insert the match display data
1538 ;; Sum line numbers between first and last match lines.
1540 ;; Add 1 for empty last match line since
1541 ;; count-lines returns 1 line less.
1543 ;; On to the next match...
1547 ;; Flush remaining context after-lines.
1551 prev-after-lines prefix-face)))))))
1558 end)
1562 ;; Don't display the same number of lines
1563 ;; and matches in case of 1 match per line.
1567 ;; Don't display regexp for multi-buffer.
1578 ;; Display total match count and regexp for multi-buffer.
1582 end)
1585 ;; Don't display the same number of lines
1586 ;; and matches in case of 1 match per line.
1596 ;; CODING is buffer-file-coding-system of the first buffer
1597 ;; that locally binds it. Let's use it also for the output
1598 ;; buffer.
1600 ;; Return the number of matches
1601 global-matches)))
1612 str)
1622 lines))
1629 result beg end moved)
1641 ;; Generate context display for occur.
1642 ;; OUT-LINE is the line where the match is.
1643 ;; NLINES and KEEP-PROPS are args to occur-engine.
1644 ;; CURR-LINE is line count of the current match,
1645 ;; PREV-LINE is line count of the previous match,
1646 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1647 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1648 ;; then concatenate them all together.
1650 curr-line prev-line prev-after-lines
1652 ;; Find after- and before-context lines of the current match.
1659 separator)
1661 ;; Combine after-lines of the previous match
1662 ;; with before-lines of the current match.
1665 ;; Don't overlap prev after-lines with current before-lines.
1672 ;; Separate non-overlapping context lines with a dashed line.
1676 ;; Don't overlap current before-lines with previous match line.
1678 prev-line)
1682 before-lines))
1683 ;; Separate non-overlapping before-context lines.
1688 ;; Return a list where the first element is the output line.
1696 separator)))
1699 ;; And the second element is the list of context after-lines.
1702 \f
1703 ;; It would be nice to use \\[...], but there is no reasonable way
1704 ;; to make that display both SPC and Y.
1706 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1707 RET or `q' to exit, Period to replace one match and exit,
1708 Comma to replace but not move point immediately,
1710 C-w to delete match and recursive edit,
1711 C-l to clear the screen, redisplay, and offer same replacement again,
1712 ! to replace all remaining matches in this buffer with no more questions,
1713 ^ to move point back to previous match,
1714 E to edit the replacement string.
1715 In multi-buffer replacements type `Y' to replace all remaining
1716 matches in all remaining buffers with no more questions,
1717 `N' to skip to the next buffer without replacing remaining matches
1718 in the current buffer."
1726 (define-key map [backspace] 'skip)
1727 (define-key map "y" 'act)
1728 (define-key map "n" 'skip)
1729 (define-key map "Y" 'act)
1730 (define-key map "N" 'skip)
1731 (define-key map "e" 'edit-replacement)
1732 (define-key map "E" 'edit-replacement)
1733 (define-key map "," 'act-and-show)
1734 (define-key map "q" 'exit)
1736 (define-key map [return] 'exit)
1737 (define-key map "." 'act-and-exit)
1738 (define-key map "\C-r" 'edit)
1739 (define-key map "\C-w" 'delete-and-edit)
1740 (define-key map "\C-l" 'recenter)
1741 (define-key map "!" 'automatic)
1742 (define-key map "^" 'backup)
1743 (define-key map "\C-h" 'help)
1744 (define-key map [f1] 'help)
1745 (define-key map [help] 'help)
1746 (define-key map "?" 'help)
1747 (define-key map "\C-g" 'quit)
1748 (define-key map "\C-]" 'quit)
1749 (define-key map "\C-v" 'scroll-up)
1750 (define-key map "\M-v" 'scroll-down)
1751 (define-key map [next] 'scroll-up)
1752 (define-key map [prior] 'scroll-down)
1753 (define-key map [?\C-\M-v] 'scroll-other-window)
1754 (define-key map [M-next] 'scroll-other-window)
1755 (define-key map [?\C-\M-\S-v] 'scroll-other-window-down)
1756 (define-key map [M-prior] 'scroll-other-window-down)
1757 ;; Binding ESC would prohibit the M-v binding. Instead, callers
1758 ;; should check for ESC specially.
1759 ;; (define-key map "\e" 'exit-prefix)
1760 (define-key map [escape] 'exit-prefix)
1761 map)
1762 "Keymap of responses to questions posed by commands like `query-replace'.
1764 The valid answers include `act', `skip', `act-and-show',
1765 `act-and-exit', `exit', `exit-prefix', `recenter', `scroll-up',
1766 `scroll-down', `scroll-other-window', `scroll-other-window-down',
1767 `edit', `edit-replacement', `delete-and-edit', `automatic',
1768 `backup', `quit', and `help'.
1770 This keymap is used by `y-or-n-p' as well as `query-replace'.")
1772 (defvar multi-query-replace-map
1773 (let ((map (make-sparse-keymap)))
1774 (set-keymap-parent map query-replace-map)
1775 (define-key map "Y" 'automatic-all)
1776 (define-key map "N" 'exit-current)
1777 map)
1778 "Keymap that defines additional bindings for multi-buffer replacements.
1779 It extends its parent map `query-replace-map' with new bindings to
1780 operate on a set of buffers/files. The difference with its parent map
1781 is the additional answers `automatic-all' to replace all remaining
1782 matches in all remaining buffers with no more questions, and
1783 `exit-current' to skip remaining matches in the current buffer
1784 and to continue with the next buffer in the sequence.")
1786 (defun replace-match-string-symbols (n)
1787 "Process a list (and any sub-lists), expanding certain symbols.
1788 Symbol Expands To
1789 N (match-string N) (where N is a string of digits)
1790 #N (string-to-number (match-string N))
1791 & (match-string 0)
1792 #& (string-to-number (match-string 0))
1793 # replace-count
1795 Note that these symbols must be preceded by a backslash in order to
1796 type them using Lisp syntax."
1797 (while (consp n)
1798 (cond
1799 ((consp (car n))
1800 (replace-match-string-symbols (car n))) ;Process sub-list
1801 ((symbolp (car n))
1802 (let ((name (symbol-name (car n))))
1803 (cond
1804 ((string-match "^[0-9]+$" name)
1805 (setcar n (list 'match-string (string-to-number name))))
1806 ((string-match "^#[0-9]+$" name)
1807 (setcar n (list 'string-to-number
1808 (list 'match-string
1809 (string-to-number (substring name 1))))))
1810 ((string= "&" name)
1811 (setcar n '(match-string 0)))
1812 ((string= "#&" name)
1813 (setcar n '(string-to-number (match-string 0))))
1814 ((string= "#" name)
1815 (setcar n 'replace-count))))))
1816 (setq n (cdr n))))
1818 (defun replace-eval-replacement (expression count)
1819 (let* ((replace-count count)
1820 err
1821 (replacement
1822 (condition-case err
1823 (eval expression)
1824 (error
1825 (error "Error evaluating replacement expression: %S" err)))))
1826 (if (stringp replacement)
1827 replacement
1828 (prin1-to-string replacement t))))
1830 (defun replace-quote (replacement)
1831 "Quote a replacement string.
1832 This just doubles all backslashes in REPLACEMENT and
1833 returns the resulting string. If REPLACEMENT is not
1834 a string, it is first passed through `prin1-to-string'
1835 with the `noescape' argument set.
1837 `match-data' is preserved across the call."
1838 (save-match-data
1840 (if (stringp replacement)
1841 replacement
1842 (prin1-to-string replacement t))
1843 t t)))
1845 (defun replace-loop-through-replacements (data count)
1846 ;; DATA is a vector containing the following values:
1847 ;; 0 next-rotate-count
1848 ;; 1 repeat-count
1849 ;; 2 next-replacement
1850 ;; 3 replacements
1851 (if (= (aref data 0) count)
1852 (progn
1853 (aset data 0 (+ count (aref data 1)))
1854 (let ((next (cdr (aref data 2))))
1855 (aset data 2 (if (consp next) next (aref data 3))))))
1856 (car (aref data 2)))
1858 (defun replace-match-data (integers reuse &optional new)
1859 "Like `match-data', but markers in REUSE get invalidated.
1860 If NEW is non-nil, it is set and returned instead of fresh data,
1861 but coerced to the correct value of INTEGERS."
1862 (or (and new
1863 (progn
1864 (set-match-data new)
1865 (and (eq new reuse)
1866 (eq (null integers) (markerp (car reuse)))
1867 new)))
1868 (match-data integers reuse t)))
1870 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data backward)
1872 NEWTEXT, FIXEDCASE, LITERAL are just passed on. If NOEDIT is true, no
1874 replacement. In case editing is done, it is changed to use markers.
1877 passed in. If LITERAL is set, no checking is done, anyway."
1878 (unless (or literal noedit)
1879 (setq noedit t)
1881 newtext)
1882 (setq newtext
1883 (read-string "Edit replacement string: "
1884 (prog1
1885 (cons
1886 (replace-match "" t t newtext 3)
1887 (1+ (match-beginning 3)))
1888 (setq match-data
1889 (replace-match-data
1890 nil match-data match-data))))
1891 noedit nil)))
1892 (set-match-data match-data)
1893 (replace-match newtext fixedcase literal)
1894 ;; `replace-match' leaves point at the end of the replacement text,
1895 ;; so move point to the beginning when replacing backward.
1896 (when backward (goto-char (nth 0 match-data)))
1897 noedit)
1899 (defvar replace-search-function nil
1900 "Function to use when searching for strings to replace.
1901 It is used by `query-replace' and `replace-string', and is called
1902 with three arguments, as if it were `search-forward'.")
1904 (defvar replace-re-search-function nil
1905 "Function to use when searching for regexps to replace.
1906 It is used by `query-replace-regexp', `replace-regexp',
1907 `query-replace-regexp-eval', and `map-query-replace-regexp'.
1908 It is called with three arguments, as if it were
1909 `re-search-forward'.")
1911 (defun replace-search (search-string limit regexp-flag delimited-flag
1912 case-fold-search backward)
1913 "Search for the next occurrence of SEARCH-STRING to replace."
1914 ;; Let-bind global isearch-* variables to values used
1915 ;; to search the next replacement. These let-bindings
1916 ;; should be effective both at the time of calling
1917 ;; `isearch-search-fun-default' and also at the
1918 ;; time of funcalling `search-function'.
1919 ;; These isearch-* bindings can't be placed higher
1920 ;; outside of this function because then another I-search
1921 ;; used after `recursive-edit' might override them.
1922 (let* ((isearch-regexp regexp-flag)
1923 (isearch-word delimited-flag)
1924 (isearch-lax-whitespace
1925 replace-lax-whitespace)
1926 (isearch-regexp-lax-whitespace
1927 replace-regexp-lax-whitespace)
1928 (isearch-case-fold-search case-fold-search)
1929 (isearch-adjusted nil)
1930 (isearch-nonincremental t) ; don't use lax word mode
1931 (isearch-forward (not backward))
1932 (search-function
1933 (or (if regexp-flag
1934 replace-re-search-function
1935 replace-search-function)
1936 (isearch-search-fun-default))))
1937 (funcall search-function search-string limit t)))
1939 (defvar replace-overlay nil)
1941 (defun replace-highlight (match-beg match-end range-beg range-end
1942 search-string regexp-flag delimited-flag
1943 case-fold-search backward)
1944 (if query-replace-highlight
1945 (if replace-overlay
1946 (move-overlay replace-overlay match-beg match-end (current-buffer))
1947 (setq replace-overlay (make-overlay match-beg match-end))
1948 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
1949 (overlay-put replace-overlay 'face 'query-replace)))
1950 (if query-replace-lazy-highlight
1951 (let ((isearch-string search-string)
1952 (isearch-regexp regexp-flag)
1953 (isearch-word delimited-flag)
1954 (isearch-lax-whitespace
1955 replace-lax-whitespace)
1956 (isearch-regexp-lax-whitespace
1957 replace-regexp-lax-whitespace)
1958 (isearch-case-fold-search case-fold-search)
1959 (isearch-forward (not backward))
1960 (isearch-other-end match-beg)
1961 (isearch-error nil))
1962 (isearch-lazy-highlight-new-loop range-beg range-end))))
1964 (defun replace-dehighlight ()
1965 (when replace-overlay
1966 (delete-overlay replace-overlay))
1967 (when query-replace-lazy-highlight
1968 (lazy-highlight-cleanup lazy-highlight-cleanup)
1969 (setq isearch-lazy-highlight-last-string nil))
1970 ;; Close overlays opened by `isearch-range-invisible' in `perform-replace'.
1971 (isearch-clean-overlays))
1973 (defun perform-replace (from-string replacements
1974 query-flag regexp-flag delimited-flag
1975 &optional repeat-count map start end backward)
1976 "Subroutine of `query-replace'. Its complexity handles interactive queries.
1977 Don't use this in your own program unless you want to query and set the mark
1978 just as `query-replace' does. Instead, write a simple loop like this:
1983 which will run faster and probably do exactly what you want. Please
1984 see the documentation of `replace-match' to find out how to simulate
1985 `case-replace'.
1987 This function returns nil if and only if there were no matches to
1988 make, or the user didn't cancel the call."
1989 (or map (setq map query-replace-map))
1990 (and query-flag minibuffer-auto-raise
1991 (raise-frame (window-frame (minibuffer-window))))
1992 (let* ((case-fold-search
1993 (if (and case-fold-search search-upper-case)
1994 (isearch-no-upper-case-p from-string regexp-flag)
1995 case-fold-search))
1996 (nocasify (not (and case-replace case-fold-search)))
1997 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
1998 (search-string from-string)
1999 (real-match-data nil) ; The match data for the current match.
2000 (next-replacement nil)
2001 ;; This is non-nil if we know there is nothing for the user
2002 ;; to edit in the replacement.
2003 (noedit nil)
2004 (keep-going t)
2005 (stack nil)
2006 (replace-count 0)
2007 (skip-read-only-count 0)
2008 (skip-filtered-count 0)
2009 (skip-invisible-count 0)
2010 (nonempty-match nil)
2011 (multi-buffer nil)
2012 (recenter-last-op nil) ; Start cycling order with initial position.
2014 ;; If non-nil, it is marker saying where in the buffer to stop.
2015 (limit nil)
2017 ;; Data for the next match. If a cons, it has the same format as
2018 ;; (match-data); otherwise it is t if a match is possible at point.
2019 (match-again t)
2021 (message
2022 (if query-flag
2023 (apply 'propertize
2024 (substitute-command-keys
2026 minibuffer-prompt-properties))))
2028 ;; If region is active, in Transient Mark mode, operate on region.
2029 (if backward
2030 (when end
2031 (setq limit (copy-marker (min start end)))
2032 (goto-char (max start end))
2033 (deactivate-mark))
2034 (when start
2035 (setq limit (copy-marker (max start end)))
2036 (goto-char (min start end))
2037 (deactivate-mark)))
2039 ;; If last typed key in previous call of multi-buffer perform-replace
2040 ;; was `automatic-all', don't ask more questions in next files
2041 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
2042 (setq query-flag nil multi-buffer t))
2044 ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
2045 ;; containing a function and its first argument. The function is
2046 ;; called to generate each replacement like this:
2047 ;; (funcall (car replacements) (cdr replacements) replace-count)
2048 ;; It must return a string.
2049 (cond
2050 ((stringp replacements)
2051 (setq next-replacement replacements
2052 replacements nil))
2053 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
2054 (or repeat-count (setq repeat-count 1))
2055 (setq replacements (cons 'replace-loop-through-replacements
2056 (vector repeat-count repeat-count
2057 replacements replacements)))))
2059 (when query-replace-lazy-highlight
2060 (setq isearch-lazy-highlight-last-string nil))
2062 (push-mark)
2063 (undo-boundary)
2064 (unwind-protect
2065 ;; Loop finding occurrences that perhaps should be replaced.
2066 (while (and keep-going
2067 (if backward
2068 (not (or (bobp) (and limit (<= (point) limit))))
2069 (not (or (eobp) (and limit (>= (point) limit)))))
2070 ;; Use the next match if it is already known;
2071 ;; otherwise, search for a match after moving forward
2072 ;; one char if progress is required.
2073 (setq real-match-data
2074 (cond ((consp match-again)
2075 (goto-char (if backward
2076 (nth 0 match-again)
2077 (nth 1 match-again)))
2078 (replace-match-data
2079 t real-match-data match-again))
2080 ;; MATCH-AGAIN non-nil means accept an
2081 ;; adjacent match.
2082 (match-again
2083 (and
2084 (replace-search search-string limit
2085 regexp-flag delimited-flag
2086 case-fold-search backward)
2087 ;; For speed, use only integers and
2088 ;; reuse the list used last time.
2089 (replace-match-data t real-match-data)))
2090 ((and (if backward
2091 (> (1- (point)) (point-min))
2092 (< (1+ (point)) (point-max)))
2093 (or (null limit)
2094 (if backward
2095 (> (1- (point)) limit)
2096 (< (1+ (point)) limit))))
2097 ;; If not accepting adjacent matches,
2098 ;; move one char to the right before
2099 ;; searching again. Undo the motion
2100 ;; if the search fails.
2101 (let ((opoint (point)))
2102 (forward-char (if backward -1 1))
2103 (if (replace-search search-string limit
2104 regexp-flag delimited-flag
2105 case-fold-search backward)
2106 (replace-match-data
2107 t real-match-data)
2108 (goto-char opoint)
2109 nil))))))
2111 ;; Record whether the match is nonempty, to avoid an infinite loop
2112 ;; repeatedly matching the same empty string.
2113 (setq nonempty-match
2114 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
2116 ;; If the match is empty, record that the next one can't be
2117 ;; adjacent.
2119 ;; Otherwise, if matching a regular expression, do the next
2120 ;; match now, since the replacement for this match may
2121 ;; affect whether the next match is adjacent to this one.
2122 ;; If that match is empty, don't use it.
2123 (setq match-again
2124 (and nonempty-match
2125 (or (not regexp-flag)
2126 (and (if backward
2127 (looking-back search-string)
2128 (looking-at search-string))
2129 (let ((match (match-data)))
2130 (and (/= (nth 0 match) (nth 1 match))
2131 match))))))
2133 (cond
2134 ;; Optionally ignore matches that have a read-only property.
2135 ((not (or (not query-replace-skip-read-only)
2136 (not (text-property-not-all
2137 (nth 0 real-match-data) (nth 1 real-match-data)
2138 'read-only nil))))
2139 (setq skip-read-only-count (1+ skip-read-only-count)))
2140 ;; Optionally filter out matches.
2141 ((not (funcall isearch-filter-predicate
2142 (nth 0 real-match-data) (nth 1 real-match-data)))
2143 (setq skip-filtered-count (1+ skip-filtered-count)))
2144 ;; Optionally ignore invisible matches.
2145 ((not (or (eq search-invisible t)
2146 ;; Don't open overlays for automatic replacements.
2147 (and (not query-flag) search-invisible)
2148 ;; Open hidden overlays for interactive replacements.
2149 (not (isearch-range-invisible
2150 (nth 0 real-match-data) (nth 1 real-match-data)))))
2151 (setq skip-invisible-count (1+ skip-invisible-count)))
2152 (t
2153 ;; Calculate the replacement string, if necessary.
2154 (when replacements
2155 (set-match-data real-match-data)
2156 (setq next-replacement
2157 (funcall (car replacements) (cdr replacements)
2158 replace-count)))
2159 (if (not query-flag)
2160 (progn
2161 (unless (or literal noedit)
2162 (replace-highlight
2163 (nth 0 real-match-data) (nth 1 real-match-data)
2164 start end search-string
2165 regexp-flag delimited-flag case-fold-search backward))
2166 (setq noedit
2167 (replace-match-maybe-edit
2168 next-replacement nocasify literal
2169 noedit real-match-data backward)
2170 replace-count (1+ replace-count)))
2171 (undo-boundary)
2172 (let (done replaced key def)
2173 ;; Loop reading commands until one of them sets done,
2174 ;; which means it has finished handling this
2175 ;; occurrence. Any command that sets `done' should
2176 ;; leave behind proper match data for the stack.
2177 ;; Commands not setting `done' need to adjust
2178 ;; `real-match-data'.
2179 (while (not done)
2180 (set-match-data real-match-data)
2181 (replace-highlight
2182 (match-beginning 0) (match-end 0)
2183 start end search-string
2184 regexp-flag delimited-flag case-fold-search backward)
2185 ;; Bind message-log-max so we don't fill up the message log
2186 ;; with a bunch of identical messages.
2187 (let ((message-log-max nil)
2188 (replacement-presentation
2189 (if query-replace-show-replacement
2190 (save-match-data
2191 (set-match-data real-match-data)
2192 (match-substitute-replacement next-replacement
2193 nocasify literal))
2194 next-replacement)))
2195 (message message
2196 (query-replace-descr from-string)
2197 (query-replace-descr replacement-presentation)))
2198 (setq key (read-event))
2199 ;; Necessary in case something happens during read-event
2200 ;; that clobbers the match data.
2201 (set-match-data real-match-data)
2202 (setq key (vector key))
2203 (setq def (lookup-key map key))
2204 ;; Restore the match data while we process the command.
2205 (cond ((eq def 'help)
2206 (with-output-to-temp-buffer "*Help*"
2207 (princ
2208 (concat "Query replacing "
2209 (if delimited-flag
2210 (or (and (symbolp delimited-flag)
2211 (get delimited-flag 'isearch-message-prefix))
2212 "word ") "")
2213 (if regexp-flag "regexp " "")
2214 (if backward "backward " "")
2215 from-string " with "
2217 (substitute-command-keys
2218 query-replace-help)))
2219 (with-current-buffer standard-output
2220 (help-mode))))
2221 ((eq def 'exit)
2222 (setq keep-going nil)
2223 (setq done t))
2224 ((eq def 'exit-current)
2225 (setq multi-buffer t keep-going nil done t))
2226 ((eq def 'backup)
2227 (if stack
2228 (let ((elt (pop stack)))
2229 (goto-char (nth 0 elt))
2230 (setq replaced (nth 1 elt)
2231 real-match-data
2232 (replace-match-data
2233 t real-match-data
2234 (nth 2 elt))))
2235 (message "No previous match")
2236 (ding 'no-terminate)
2237 (sit-for 1)))
2238 ((eq def 'act)
2239 (or replaced
2240 (setq noedit
2241 (replace-match-maybe-edit
2242 next-replacement nocasify literal
2243 noedit real-match-data backward)
2244 replace-count (1+ replace-count)))
2245 (setq done t replaced t))
2246 ((eq def 'act-and-exit)
2247 (or replaced
2248 (setq noedit
2249 (replace-match-maybe-edit
2250 next-replacement nocasify literal
2251 noedit real-match-data backward)
2252 replace-count (1+ replace-count)))
2253 (setq keep-going nil)
2254 (setq done t replaced t))
2255 ((eq def 'act-and-show)
2256 (if (not replaced)
2257 (setq noedit
2258 (replace-match-maybe-edit
2259 next-replacement nocasify literal
2260 noedit real-match-data backward)
2261 replace-count (1+ replace-count)
2262 real-match-data (replace-match-data
2263 t real-match-data)
2264 replaced t)))
2265 ((or (eq def 'automatic) (eq def 'automatic-all))
2266 (or replaced
2267 (setq noedit
2268 (replace-match-maybe-edit
2269 next-replacement nocasify literal
2270 noedit real-match-data backward)
2271 replace-count (1+ replace-count)))
2272 (setq done t query-flag nil replaced t)
2273 (if (eq def 'automatic-all) (setq multi-buffer t)))
2274 ((eq def 'skip)
2275 (setq done t))
2276 ((eq def 'recenter)
2277 ;; `this-command' has the value `query-replace',
2278 ;; so we need to bind it to `recenter-top-bottom'
2279 ;; to allow it to detect a sequence of `C-l'.
2280 (let ((this-command 'recenter-top-bottom)
2281 (last-command 'recenter-top-bottom))
2282 (recenter-top-bottom)))
2283 ((eq def 'edit)
2284 (let ((opos (point-marker)))
2285 (setq real-match-data (replace-match-data
2286 nil real-match-data
2287 real-match-data))
2288 (goto-char (match-beginning 0))
2289 (save-excursion
2290 (save-window-excursion
2291 (recursive-edit)))
2292 (goto-char opos)
2293 (set-marker opos nil))
2294 ;; Before we make the replacement,
2295 ;; decide whether the search string
2296 ;; can match again just after this match.
2297 (if (and regexp-flag nonempty-match)
2298 (setq match-again (and (looking-at search-string)
2299 (match-data)))))
2300 ;; Edit replacement.
2301 ((eq def 'edit-replacement)
2302 (setq real-match-data (replace-match-data
2303 nil real-match-data
2304 real-match-data)
2305 next-replacement
2306 (read-string "Edit replacement string: "
2307 next-replacement)
2308 noedit nil)
2309 (if replaced
2310 (set-match-data real-match-data)
2311 (setq noedit
2312 (replace-match-maybe-edit
2313 next-replacement nocasify literal noedit
2314 real-match-data backward)
2315 replaced t))
2316 (setq done t))
2318 ((eq def 'delete-and-edit)
2319 (replace-match "" t t)
2320 (setq real-match-data (replace-match-data
2321 nil real-match-data))
2322 (replace-dehighlight)
2323 (save-excursion (recursive-edit))
2324 (setq replaced t))
2325 ;; Note: we do not need to treat `exit-prefix'
2326 ;; specially here, since we reread
2327 ;; any unrecognized character.
2328 (t
2329 (setq this-command 'mode-exited)
2330 (setq keep-going nil)
2331 (setq unread-command-events
2332 (append (listify-key-sequence key)
2333 unread-command-events))
2334 (setq done t)))
2335 (when query-replace-lazy-highlight
2336 ;; Force lazy rehighlighting only after replacements.
2337 (if (not (memq def '(skip backup)))
2338 (setq isearch-lazy-highlight-last-string nil)))
2339 (unless (eq def 'recenter)
2340 ;; Reset recenter cycling order to initial position.
2341 (setq recenter-last-op nil)))
2342 ;; Record previous position for ^ when we move on.
2343 ;; Change markers to numbers in the match data
2344 ;; since lots of markers slow down editing.
2345 (push (list (point) replaced
2346 ;;; If the replacement has already happened, all we need is the
2347 ;;; current match start and end. We could get this with a trivial
2348 ;;; match like
2349 ;;; (save-excursion (goto-char (match-beginning 0))
2350 ;;; (search-forward (match-string 0))
2351 ;;; (match-data t))
2352 ;;; if we really wanted to avoid manually constructing match data.
2353 ;;; Adding current-buffer is necessary so that match-data calls can
2354 ;;; return markers which are appropriate for editing.
2355 (if replaced
2356 (list
2357 (match-beginning 0)
2358 (match-end 0)
2359 (current-buffer))
2360 (match-data t)))
2361 stack))))))
2363 (replace-dehighlight))
2364 (or unread-command-events
2365 (message "Replaced %d occurrence%s%s"
2366 replace-count
2367 (if (= replace-count 1) "" "s")
2368 (if (> (+ skip-read-only-count
2369 skip-filtered-count
2370 skip-invisible-count) 0)
2371 (format " (skipped %s)"
2372 (mapconcat
2373 'identity
2374 (delq nil (list
2375 (if (> skip-read-only-count 0)
2376 (format "%s read-only"
2377 skip-read-only-count))
2378 (if (> skip-invisible-count 0)
2379 (format "%s invisible"
2380 skip-invisible-count))
2381 (if (> skip-filtered-count 0)
2382 (format "%s filtered out"
2383 skip-filtered-count))))
2384 ", "))
2385 "")))
2386 (or (and keep-going stack) multi-buffer)))
2388 ;;; replace.el ends here