| blob | eb5e0cfffcb7511ce0080db2155adde546a15d67 |
1 ;;; replace.el --- replace commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2016 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 replacement commands should do character folding in matches.
39 unicode quotes.
40 This variable affects `query-replace' and `replace-string', but not
41 `replace-regexp'."
47 "Non-nil means `query-replace' matches a sequence of whitespace chars.
48 When you enter a space or spaces in the strings to be replaced,
49 it will match any sequence matched by the regexp `search-whitespace-regexp'."
55 "Non-nil means `query-replace-regexp' matches a sequence of whitespace chars.
56 When you enter a space or spaces in the regexps to be replaced,
57 it will match any sequence matched by the regexp `search-whitespace-regexp'."
63 "Default history list for query-replace commands.
64 See `query-replace-from-history-variable' and
68 "Default values of FROM-STRING and TO-STRING for `query-replace'.
69 This is a list of cons cells (FROM-STRING . TO-STRING), or nil
73 "Non-nil means `query-replace' uses the last search string.
76 "use `M-n' to pull the last incremental search string
77 to the minibuffer that reads the string to replace, or invoke replacements
83 "String that separates FROM and TO in the history of replacement pairs."
84 ;; Avoids error when attempt to autoload char-displayable-p fails
85 ;; while preparing to dump, also stops customize-rogue listing this.
92 "History list to use for the FROM argument of `query-replace' commands.
93 The value of this variable should be a symbol; that symbol
94 is used as a variable to hold a history list for the strings
95 or patterns to be replaced."
101 "History list to use for the TO argument of `query-replace' commands.
102 The value of this variable should be a symbol; that symbol
103 is used as a variable to hold a history list for replacement
104 strings or patterns."
110 "Non-nil means `query-replace' and friends ignore read-only matches."
116 "Non-nil means show substituted replacement text in the minibuffer.
117 This variable affects only `query-replace-regexp'."
123 "Non-nil means to highlight matches during query replacement."
128 "Controls the lazy-highlighting during query replacements.
129 When non-nil, all text in the buffer matching the current match
130 is highlighted lazily using isearch lazy highlighting (see
131 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
139 "Face for highlighting query replacement matches."
144 "Number of replacements done so far.
151 "Split string STRING at a character with property `separator'"
161 "Query and return the `from' argument of a query-replace operation.
162 The return value can also be a pair (FROM . TO) indicating that the user
163 wants to replace FROM with TO."
166 ;; Reevaluating will check char-displayable-p that is
167 ;; unavailable while preparing to dump.
173 'display query-replace-from-to-separator
180 separator
182 query-replace-defaults))
190 ;; The save-excursion here is in case the user marks and copies
191 ;; a region in order to specify the minibuffer input.
192 ;; That should not clobber the region for the query-replace itself.
201 prompt nil nil nil 'query-replace-from-to-history
211 ;; Warn if user types \n or \t, but don't reject the input.
222 from
228 "Maybe convert a regexp replacement TO to Lisp.
229 Returns a list suitable for `perform-replace' if necessary,
230 the original string if not."
246 ;; Swallow a space after a symbol
247 ;; if there is a space.
249 ;; Swallow a space after 'foo
250 ;; but not after (quote foo).
265 to))
269 "Query and return the `to' argument of a query-replace operation."
275 nil nil nil
276 query-replace-to-history-variable from t)))
279 to))
280 regexp-flag))
292 (defun query-replace (from-string to-string &optional delimited start end backward region-noncontiguous-p)
293 "Replace some occurrences of FROM-STRING 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's
299 accessible portion.
301 In interactive use, the prefix arg (non-nil DELIMITED in
302 non-interactive use), means replace only matches surrounded by
303 word boundaries. A negative prefix arg means replace backward.
306 to pull the last incremental search string to the minibuffer
307 that reads FROM-STRING, or invoke replacements from
308 incremental search with a key sequence like `C-s C-s M-%'
309 to use its current search string as the string to replace.
311 Matching is independent of case if `case-fold-search' is non-nil and
312 FROM-STRING has no uppercase letters. Replacement transfers the case
313 pattern of the old text to the new text, if `case-replace' and
314 `case-fold-search' are non-nil and FROM-STRING has no uppercase
315 letters. (Transferring the case pattern means that if the old text
316 matched is all caps, or capitalized, then its replacement is upcased
317 or capitalized.)
319 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
320 ignore hidden matches if `search-invisible' is nil, and ignore more
321 matches using `isearch-filter-predicate'.
323 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
324 to be replaced will match a sequence of whitespace chars defined by the
325 regexp in `search-whitespace-regexp'.
327 If `replace-char-fold' is non-nil, matching uses character folding,
328 i.e. it ignores diacritics and other differences between equivalent
329 character strings.
331 Fourth and fifth arg START and END specify the region to operate on.
333 To customize possible responses, change the bindings in `query-replace-map'."
342 nil)))
344 ;; These are done separately here
345 ;; so that command-history will record these expressions
346 ;; rather than the values they had this time.
351 (perform-replace from-string to-string t nil delimited nil nil start end backward region-noncontiguous-p))
355 (defun query-replace-regexp (regexp to-string &optional delimited start end backward region-noncontiguous-p)
356 "Replace some things after point matching REGEXP with TO-STRING.
357 As each match is found, the user must type a character saying
360 In Transient Mark mode, if the mark is active, operate on the contents
361 of the region. Otherwise, operate from point to the end of the buffer's
362 accessible portion.
365 to pull the last incremental search regexp to the minibuffer
366 that reads REGEXP, or invoke replacements from
367 incremental search with a key sequence like `C-M-s C-M-s C-M-%'
368 to use its current search regexp as the regexp to replace.
370 Matching is independent of case if `case-fold-search' is non-nil and
371 REGEXP has no uppercase letters. Replacement transfers the case
372 pattern of the old text to the new text, if `case-replace' and
373 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
374 \(Transferring the case pattern means that if the old text matched is
375 all caps, or capitalized, then its replacement is upcased or
376 capitalized.)
378 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
379 ignore hidden matches if `search-invisible' is nil, and ignore more
380 matches using `isearch-filter-predicate'.
382 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
383 to be replaced will match a sequence of whitespace chars defined by the
384 regexp in `search-whitespace-regexp'.
386 This function is not affected by `replace-char-fold'.
388 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
389 only matches surrounded by word boundaries. A negative prefix arg means
390 replace backward.
392 Fourth and fifth arg START and END specify the region to operate on.
397 counted from 1.
399 at the given position for each replacement.
402 followed by a Lisp expression. Each
403 replacement evaluates that expression to compute the replacement
406 for the whole or a partial match converted to a number with
408 done so far (starting with zero).
410 If the replacement expression is a symbol, write a space after it
411 to terminate it. One space there, if any, will be discarded.
413 When using those Lisp features interactively in the replacement
414 text, TO-STRING is actually made a list instead of a string.
423 " regexp"
425 t)))
427 ;; These are done separately here
428 ;; so that command-history will record these expressions
429 ;; rather than the values they had this time.
434 (perform-replace regexp to-string t t delimited nil nil start end backward region-noncontiguous-p))
439 "Replace some things after point matching REGEXP with the result of TO-EXPR.
441 Interactive use of this function is deprecated in favor of the
443 using `search-forward-regexp' and `replace-match' is preferred.
445 As each match is found, the user must type a character saying
448 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
449 reference `replace-count' to get the number of replacements already made.
450 If the result of TO-EXPR is not a string, it is converted to one using
451 `prin1-to-string' with the NOESCAPE argument (which see).
456 in REGEXP.
461 In Transient Mark mode, if the mark is active, operate on the contents
462 of the region. Otherwise, operate from point to the end of the buffer's
463 accessible portion.
466 to pull the last incremental search regexp to the minibuffer
467 that reads REGEXP.
469 Preserves case in each replacement if `case-replace' and `case-fold-search'
470 are non-nil and REGEXP has no uppercase letters.
472 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
473 ignore hidden matches if `search-invisible' is nil, and ignore more
474 matches using `isearch-filter-predicate'.
476 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
477 to be replaced will match a sequence of whitespace chars defined by the
478 regexp in `search-whitespace-regexp'.
480 This function is not affected by `replace-char-fold'.
482 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
483 only matches that are surrounded by word boundaries.
484 Fourth and fifth arg START and END specify the region to operate on."
486 for interactive calls, and `search-forward-regexp'/`replace-match'
492 ;; Let-bind the history var to disable the "foo -> bar"
493 ;; default. Maybe we shouldn't disable this default, but
494 ;; for now I'll leave it off. --Stef
500 nil nil t query-replace-to-history-variable from t))))
501 ;; We make TO a list because replace-match-string-symbols requires one,
502 ;; and the user might enter a single token.
511 "Replace some matches for REGEXP with various strings, in rotation.
512 The second argument TO-STRINGS contains the replacement strings, separated
513 by spaces. This command works like `query-replace-regexp' except that
514 each successive replacement uses the next successive replacement string,
515 wrapping around from the last such string to the first.
517 In Transient Mark mode, if the mark is active, operate on the contents
518 of the region. Otherwise, operate from point to the end of the buffer's
519 accessible portion.
521 Non-interactively, TO-STRINGS may be a list of replacement strings.
523 Interactively, reads the regexp using `read-regexp'.
525 to pull the last incremental search regexp to the minibuffer
526 that reads REGEXP.
528 A prefix argument N says to use each replacement string N times
529 before rotating to the next.
530 Fourth and fifth arg START and END specify the region to operate on."
533 query-replace-from-history-variable))
537 nil nil nil
538 query-replace-to-history-variable from t)))
560 "Replace occurrences of FROM-STRING with TO-STRING.
561 Preserve case in each match if `case-replace' and `case-fold-search'
562 are non-nil and FROM-STRING has no uppercase letters.
563 \(Preserving case means that if the string matched is all caps, or capitalized,
564 then its replacement is upcased or capitalized.)
566 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
567 ignore hidden matches if `search-invisible' is nil, and ignore more
568 matches using `isearch-filter-predicate'.
570 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
571 to be replaced will match a sequence of whitespace chars defined by the
572 regexp in `search-whitespace-regexp'.
574 If `replace-char-fold' is non-nil, matching uses character folding,
575 i.e. it ignores diacritics and other differences between equivalent
576 character strings.
578 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
579 only matches surrounded by word boundaries. A negative prefix arg means
580 replace backward.
582 Operates on the region between START and END (if both are nil, from point
583 to the end of the buffer). Interactively, if Transient Mark mode is
584 enabled and the mark is active, operates on the contents of the region;
585 otherwise from point to the end of the buffer's accessible portion.
588 to pull the last incremental search string to the minibuffer
589 that reads FROM-STRING.
591 This function is usually the wrong thing to use in a Lisp program.
592 What you probably want is a loop like this:
593 (while (search-forward FROM-STRING nil t)
594 (replace-match TO-STRING nil t))
595 which will run faster and will not set the mark or print anything.
596 \(You may need a more complex loop if FROM-STRING can match the null string
597 and TO-STRING is also null.)"
607 " string"
609 nil)))
617 "Replace things after point matching REGEXP with TO-STRING.
618 Preserve case in each match if `case-replace' and `case-fold-search'
619 are non-nil and REGEXP has no uppercase letters.
621 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
622 ignore hidden matches if `search-invisible' is nil, and ignore more
623 matches using `isearch-filter-predicate'.
625 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
626 to be replaced will match a sequence of whitespace chars defined by the
627 regexp in `search-whitespace-regexp'.
629 This function is not affected by `replace-char-fold'
631 In Transient Mark mode, if the mark is active, operate on the contents
632 of the region. Otherwise, operate from point to the end of the buffer's
633 accessible portion.
635 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
636 only matches surrounded by word boundaries. A negative prefix arg means
637 replace backward.
639 Fourth and fifth arg START and END specify the region to operate on.
645 at the given position for each replacement.
648 followed by a Lisp expression used as part of the replacement
652 `replace-count', the number of replacements occurred so far.
654 If your Lisp expression is an identifier and the next letter in
655 the replacement string would be interpreted as part of it, you
658 replacement text directly.
660 When using those Lisp features interactively in the replacement
661 text, TO-STRING is actually made a list instead of a string.
665 to pull the last incremental search regexp to the minibuffer
666 that reads REGEXP.
668 This function is usually the wrong thing to use in a Lisp program.
669 What you probably want is a loop like this:
670 (while (re-search-forward REGEXP nil t)
671 (replace-match TO-STRING nil nil))
672 which will run faster and will not set the mark or print anything."
682 " regexp"
684 t)))
691 \f
693 "History list for some commands that read regular expressions.
695 Maximum length of the history list is determined by the value
702 "Function that provides default regexp(s) for `read-regexp'.
703 This function should take no arguments and return one of: nil, a
704 regexp, or a list of regexps. Interactively, `read-regexp' uses
705 the return value of this function for its DEFAULT argument.
707 As an example, set this variable to `find-tag-default-as-regexp'
708 to default to the symbol at point.
710 To provide different default regexps for different commands,
711 the function that you set this to can check `this-command'."
716 find-tag-default)
718 find-tag-default-as-regexp)
720 find-tag-default-as-symbol-regexp)
726 "Return a list of standard suggestions for `read-regexp'.
727 By default, the list includes the tag at point, the last isearch regexp,
728 the last isearch string, and the last replacement regexp. `read-regexp'
729 appends the list returned by this function to the end of values available
739 "Read and return a regular expression as a string.
742 possibly preceded by the default result (see below).
744 The optional argument DEFAULTS can be either: nil, a string, a list
745 of strings, or a symbol. We use DEFAULTS to construct the default
746 return value in case of empty input.
748 If DEFAULTS is a string, we use it as-is.
750 If DEFAULTS is a list of strings, the first element is the
751 default return value, but all the elements are accessible
754 If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
755 is non-nil, we use that in place of DEFAULTS in the following:
756 If DEFAULTS is the symbol `regexp-history-last', we use the first
757 element of HISTORY (if specified) or `regexp-history'.
758 If DEFAULTS is a function, we call it with no arguments and use
759 what it returns, which should be either nil, a string, or a list of strings.
761 We append the standard values from `read-regexp-suggestions' to DEFAULTS
762 before using it.
764 If the first element of DEFAULTS is non-nil (and if PROMPT does not end
767 The optional argument HISTORY is a symbol to use for the history list.
768 If nil, uses `regexp-history'."
777 defaults))
782 ;; Do not automatically add default to the history for empty input.
786 prompt)
794 ;; Return the default value when the user enters empty input.
798 ;; Otherwise, add non-empty input to the history and return input.
809 "Read arguments for `keep-lines' and friends.
810 Prompt for a regexp with PROMPT.
811 Value is a list, (REGEXP)."
815 "Delete all lines except those containing matches for REGEXP.
816 A match split across lines preserves all the lines it lies in.
817 When called from Lisp (and usually interactively as well, see below)
818 applies to all lines starting after point.
821 and `search-upper-case' is non-nil, the matching is case-sensitive.
823 Second and third arg RSTART and REND specify the region to operate on.
824 This command operates on (the accessible part of) all lines whose
825 accessible part is entirely contained in the region determined by RSTART
826 and REND. (A newline ending a line counts as part of that line.)
828 Interactively, in Transient Mark mode when the mark is active, operate
829 on all lines whose accessible part is entirely contained in the region.
830 Otherwise, the command applies to all lines starting after point.
831 When calling this function from Lisp, you can pretend that it was
832 called interactively by passing a non-nil INTERACTIVE argument.
834 This function starts looking for the next match from the end of
835 the previous match. Hence, it ignores matches that overlap
836 a previously found match."
868 case-fold-search)))
870 ;; Start is first char not preserved by previous match.
876 ;; Now end is first char preserved by the new match.
881 ;; If the match was empty, avoid matching again at same place.
886 nil)
890 "Delete lines containing matches for REGEXP.
891 When called from Lisp (and usually when called interactively as
892 well, see below), applies to the part of the buffer after point.
893 The line point is in is deleted if and only if it contains a
894 match for regexp starting after point.
897 and `search-upper-case' is non-nil, the matching is case-sensitive.
899 Second and third arg RSTART and REND specify the region to operate on.
900 Lines partially contained in this region are deleted if and only if
901 they contain a match entirely contained in it.
903 Interactively, in Transient Mark mode when the mark is active, operate
904 on the contents of the region. Otherwise, operate from point to the
905 end of (the accessible portion of) the buffer. When calling this function
906 from Lisp, you can pretend that it was called interactively by passing
907 a non-nil INTERACTIVE argument.
909 If a match is split across lines, all the lines it lies in are deleted.
910 They are deleted _before_ looking for the next match. Hence, a match
911 starting on the same line at which another match ended is ignored."
930 case-fold-search)))
939 nil)
943 "Print and return number of matches for REGEXP following point.
944 When called from Lisp and INTERACTIVE is omitted or nil, just return
945 the number, do not print it; if INTERACTIVE is t, the function behaves
946 in all respects as if it had been called interactively.
949 and `search-upper-case' is non-nil, the matching is case-sensitive.
951 Second and third arg RSTART and REND specify the region to operate on.
953 Interactively, in Transient Mark mode when the mark is active, operate
954 on the contents of the region. Otherwise, operate from point to the
955 end of (the accessible portion of) the buffer.
957 This function starts looking for the next match from the end of
958 the previous match. Hence, it ignores matches that overlap
959 a previously found match."
978 opoint
982 case-fold-search)))
990 count
992 count)))
994 \f
999 next-error-follow-minor-mode
1002 next-error-follow-minor-mode))))
1038 map)
1043 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
1056 map)
1060 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
1066 "Hook run when entering Occur mode."
1071 "Hook run by Occur when there are any matches."
1076 "Hook run by Occur after locating an occurrence.
1077 This will be called with the cursor position at the occurrence. An application
1078 for this is to reveal context in an outline-mode when the occurrence is hidden."
1093 \f
1094 ;;; Occur Edit mode
1104 map)
1108 "Major mode for editing *Occur* buffers.
1109 In this mode, changes to the *Occur* buffer are also applied to
1110 the originating buffer.
1119 "Switch from Occur Edit mode to Occur mode."
1131 col)
1135 ;; Apply occur-target property to inserted (e.g. yanked) text.
1137 ;; Did we insert a newline? Occur Edit mode can't create new
1138 ;; Occur entries; just discard everything after the newline.
1152 line-beg 'occur-prefix nil
1153 line-end))
1165 \f
1167 "Handle `revert-buffer' for Occur mode buffers."
1176 pos))
1180 "Go to the occurrence on the current line."
1184 ;; Actually `event-end' works correctly with a nil argument as
1185 ;; well, so we could dispense with this test, but let's not
1186 ;; rely on this undocumented behavior.
1197 "Go to the occurrence the current line describes, in another window."
1205 "Display in another window the occurrence the current line describes."
1208 window)
1210 ;; This is the way to set point in the proper window.
1230 "Move to the Nth (default 1) next match in an Occur mode buffer."
1235 "Move to the Nth (default 1) previous match in an Occur mode buffer."
1240 "Move to the Nth (default 1) next match in an Occur mode buffer.
1243 ;; we need to run occur-find-match from within the Occur buffer
1245 ;; Choose the buffer and make it current.
1259 #'previous-single-property-change
1262 ;; In case the *Occur* buffer is visible in a nonselected window.
1266 \f
1279 "Face used to highlight matches permanently."
1285 "Default number of context lines included around `list-matching-lines' matches.
1286 A negative number means to include that many lines before the match.
1287 A positive number means to include that many lines both before and after."
1295 If the value is nil, don't highlight the matching portions specially."
1301 If the value is nil, don't highlight the buffer names specially."
1307 If the face doesn't differ from the default face,
1308 don't highlight the prefix with line numbers specially."
1315 yank-handler follow-link)
1316 "Text properties to discard when copying lines to the *Occur* buffer.
1317 The value should be a list of text properties to discard or t,
1318 which means to discard all text properties."
1326 "Collect strings matching regexp"
1331 ;; Perform collect operation
1333 ;; No subexpression so collect the entire match.
1335 ;; Get the regexp for collection pattern.
1340 ;; Otherwise normal occur takes numerical prefix argument.
1345 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1346 Here `original-buffer-name' is the buffer name where Occur was originally run.
1347 When given the prefix argument, or called non-interactively, the renaming
1348 will not clobber the existing buffer(s) of that name, but use
1349 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1350 if you always want a separate *Occur* buffer for each buffer where you
1351 invoke `occur'."
1362 "Show all lines in the current buffer containing a match for REGEXP.
1363 If a match spreads across multiple lines, all those lines are shown.
1365 Each line is displayed with NLINES lines before and after, or -NLINES
1366 before if NLINES is negative.
1367 NLINES defaults to `list-matching-lines-default-context-lines'.
1368 Interactively it is the prefix arg.
1370 The lines are shown in a buffer named `*Occur*'.
1371 It serves as a menu to find any of the occurrences in this buffer.
1375 and `search-upper-case' is non-nil, the matching is case-sensitive.
1377 When NLINES is a string or when the function is called
1378 interactively with prefix argument without a number (`C-u' alone
1379 as prefix) the matching strings are collected into the `*Occur*'
1380 buffer by using NLINES as a replacement regexp. NLINES may
1384 program. When there is no parenthesized subexpressions in REGEXP
1385 the entire match is collected. In any case the searched buffer
1386 is not modified."
1393 "Show all lines in buffers BUFS containing a match for REGEXP.
1394 This function acts on multiple buffers; otherwise, it is exactly like
1395 `occur'. When you invoke this command interactively, you must specify
1396 the buffer names that you want, one by one.
1397 See also `multi-occur-in-matching-buffers'."
1407 "Next buffer to search (C-j to end): "
1409 nil t))
1418 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1419 Normally BUFREGEXP matches against each buffer's visited file name,
1420 but if you specify a prefix argument, it matches against the buffer name.
1421 See also `multi-occur'."
1428 "List lines in buffers whose names match regexp: "
1431 default
1432 input))
1444 buf))
1466 bufs))))
1467 ;; Handle the case where one of the buffers we're searching is the
1468 ;; output buffer. Just rename it.
1473 ;; Now find or create the output buffer.
1474 ;; If we just renamed that buffer, we will make a new one here.
1482 ;; Don't generate undo entries for creation of the initial contents.
1487 ;; Treat nlines as a regexp to collect.
1495 ;; Insert the replacement regexp.
1504 count)
1505 ;; Perform normal occur.
1507 regexp active-bufs occur-buf
1511 case-fold-search)
1512 list-matching-lines-buffer-name-face
1514 list-matching-lines-prefix-face)
1515 list-matching-lines-face
1524 ;; Don't display regexp if with remaining text
1525 ;; it is longer than window-width.
1527 regexp))
1541 title-face prefix-face match-face keep-props)
1547 ;; Map over all the buffers
1566 ;; Set CODING only if the current buffer locally
1567 ;; binds buffer-file-coding-system.
1577 ;; Get beginning of first match line and end of the last.
1583 ;; Sum line numbers up to the first match line.
1588 ;; Highlight the matches
1591 ;; Count empty lines that don't use next loop (Bug#22062).
1601 ;; Add `match-face' to faces copied from the buffer.
1604 match-face nil curstring))
1605 ;; Avoid infloop (Bug#7593).
1608 ;; Generate the string to insert for this match
1610 ;; Using 7 digits aligns tabs properly.
1616 ;; Allow insertion of text at
1617 ;; the end of the prefix (for
1618 ;; Occur Edit mode).
1619 front-sticky t rear-nonsticky t
1620 occur-target ,marker follow-link t
1623 ;; We don't put `mouse-face' on the newline,
1624 ;; because that loses. And don't put it
1625 ;; on context lines to reduce flicker.
1627 'occur-target marker
1628 'follow-link t
1629 'help-echo
1633 match-prefix
1634 ;; Add non-numeric prefix to all non-first lines
1635 ;; of multi-line matches.
1641 match-str)
1642 ;; Add marker at eol, but no mouse props.
1646 ;; The simple display style
1647 out-line
1648 ;; The complex multi-line display style.
1650 out-line nlines keep-props begpt endpt
1651 curr-line prev-line prev-after-lines
1652 prefix-face))
1653 ;; Set first elem of the returned list to `data',
1654 ;; and the second elem to `prev-after-lines'.
1657 ;; Actually insert the match display data
1663 ;; Sum line numbers between first and last match lines.
1665 ;; Add 1 for empty last match line since
1666 ;; count-lines returns 1 line less.
1668 ;; On to the next match...
1672 ;; Flush remaining context after-lines.
1676 prev-after-lines prefix-face)))))))
1683 end)
1687 ;; Don't display the same number of lines
1688 ;; and matches in case of 1 match per line.
1692 ;; Don't display regexp for multi-buffer.
1702 ;; Display total match count and regexp for multi-buffer.
1706 end)
1709 ;; Don't display the same number of lines
1710 ;; and matches in case of 1 match per line.
1720 ;; CODING is buffer-file-coding-system of the first buffer
1721 ;; that locally binds it. Let's use it also for the output
1722 ;; buffer.
1724 ;; Return the number of matches
1725 global-matches)))
1736 str)
1746 lines))
1753 result beg end moved)
1765 ;; Generate context display for occur.
1766 ;; OUT-LINE is the line where the match is.
1767 ;; NLINES and KEEP-PROPS are args to occur-engine.
1768 ;; CURR-LINE is line count of the current match,
1769 ;; PREV-LINE is line count of the previous match,
1770 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1771 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1772 ;; then concatenate them all together.
1774 curr-line prev-line prev-after-lines
1776 ;; Find after- and before-context lines of the current match.
1783 separator)
1785 ;; Combine after-lines of the previous match
1786 ;; with before-lines of the current match.
1789 ;; Don't overlap prev after-lines with current before-lines.
1796 ;; Separate non-overlapping context lines with a dashed line.
1800 ;; Don't overlap current before-lines with previous match line.
1802 prev-line)
1806 before-lines))
1807 ;; Separate non-overlapping before-context lines.
1812 ;; Return a list where the first element is the output line.
1820 separator)))
1823 ;; And the second element is the list of context after-lines.
1826 \f
1827 ;; It would be nice to use \\[...], but there is no reasonable way
1828 ;; to make that display both SPC and Y.
1830 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1831 RET or `q' to exit, Period to replace one match and exit,
1832 Comma to replace but not move point immediately,
1834 C-w to delete match and recursive edit,
1835 C-l to clear the screen, redisplay, and offer same replacement again,
1836 ! to replace all remaining matches in this buffer with no more questions,
1837 ^ to move point back to previous match,
1838 E to edit the replacement string.
1839 In multi-buffer replacements type `Y' to replace all remaining
1840 matches in all remaining buffers with no more questions,
1841 `N' to skip to the next buffer without replacing remaining matches
1842 in the current buffer."
1850 (define-key map [backspace] 'skip)
1851 (define-key map "y" 'act)
1852 (define-key map "n" 'skip)
1853 (define-key map "Y" 'act)
1854 (define-key map "N" 'skip)
1855 (define-key map "e" 'edit-replacement)
1856 (define-key map "E" 'edit-replacement)
1857 (define-key map "," 'act-and-show)
1858 (define-key map "q" 'exit)
1860 (define-key map [return] 'exit)
1861 (define-key map "." 'act-and-exit)
1862 (define-key map "\C-r" 'edit)
1863 (define-key map "\C-w" 'delete-and-edit)
1864 (define-key map "\C-l" 'recenter)
1865 (define-key map "!" 'automatic)
1866 (define-key map "^" 'backup)
1867 (define-key map "\C-h" 'help)
1868 (define-key map [f1] 'help)
1869 (define-key map [help] 'help)
1870 (define-key map "?" 'help)
1871 (define-key map "\C-g" 'quit)
1872 (define-key map "\C-]" 'quit)
1873 (define-key map "\C-v" 'scroll-up)
1874 (define-key map "\M-v" 'scroll-down)
1875 (define-key map [next] 'scroll-up)
1876 (define-key map [prior] 'scroll-down)
1877 (define-key map [?\C-\M-v] 'scroll-other-window)
1878 (define-key map [M-next] 'scroll-other-window)
1879 (define-key map [?\C-\M-\S-v] 'scroll-other-window-down)
1880 (define-key map [M-prior] 'scroll-other-window-down)
1881 ;; Binding ESC would prohibit the M-v binding. Instead, callers
1882 ;; should check for ESC specially.
1883 ;; (define-key map "\e" 'exit-prefix)
1884 (define-key map [escape] 'exit-prefix)
1885 map)
1886 "Keymap of responses to questions posed by commands like `query-replace'.
1888 The valid answers include `act', `skip', `act-and-show',
1889 `act-and-exit', `exit', `exit-prefix', `recenter', `scroll-up',
1890 `scroll-down', `scroll-other-window', `scroll-other-window-down',
1891 `edit', `edit-replacement', `delete-and-edit', `automatic',
1892 `backup', `quit', and `help'.
1894 This keymap is used by `y-or-n-p' as well as `query-replace'.")
1896 (defvar multi-query-replace-map
1897 (let ((map (make-sparse-keymap)))
1898 (set-keymap-parent map query-replace-map)
1899 (define-key map "Y" 'automatic-all)
1900 (define-key map "N" 'exit-current)
1901 map)
1902 "Keymap that defines additional bindings for multi-buffer replacements.
1903 It extends its parent map `query-replace-map' with new bindings to
1904 operate on a set of buffers/files. The difference with its parent map
1905 is the additional answers `automatic-all' to replace all remaining
1906 matches in all remaining buffers with no more questions, and
1907 `exit-current' to skip remaining matches in the current buffer
1908 and to continue with the next buffer in the sequence.")
1910 (defun replace-match-string-symbols (n)
1911 "Process a list (and any sub-lists), expanding certain symbols.
1912 Symbol Expands To
1913 N (match-string N) (where N is a string of digits)
1914 #N (string-to-number (match-string N))
1915 & (match-string 0)
1916 #& (string-to-number (match-string 0))
1917 # replace-count
1919 Note that these symbols must be preceded by a backslash in order to
1920 type them using Lisp syntax."
1921 (while (consp n)
1922 (cond
1923 ((consp (car n))
1924 (replace-match-string-symbols (car n))) ;Process sub-list
1925 ((symbolp (car n))
1926 (let ((name (symbol-name (car n))))
1927 (cond
1928 ((string-match "^[0-9]+$" name)
1929 (setcar n (list 'match-string (string-to-number name))))
1930 ((string-match "^#[0-9]+$" name)
1931 (setcar n (list 'string-to-number
1932 (list 'match-string
1933 (string-to-number (substring name 1))))))
1934 ((string= "&" name)
1935 (setcar n '(match-string 0)))
1936 ((string= "#&" name)
1937 (setcar n '(string-to-number (match-string 0))))
1938 ((string= "#" name)
1939 (setcar n 'replace-count))))))
1940 (setq n (cdr n))))
1942 (defun replace-eval-replacement (expression count)
1943 (let* ((replace-count count)
1944 err
1945 (replacement
1946 (condition-case err
1947 (eval expression)
1948 (error
1949 (error "Error evaluating replacement expression: %S" err)))))
1950 (if (stringp replacement)
1951 replacement
1952 (prin1-to-string replacement t))))
1954 (defun replace-quote (replacement)
1955 "Quote a replacement string.
1956 This just doubles all backslashes in REPLACEMENT and
1957 returns the resulting string. If REPLACEMENT is not
1958 a string, it is first passed through `prin1-to-string'
1959 with the `noescape' argument set.
1961 `match-data' is preserved across the call."
1962 (save-match-data
1964 (if (stringp replacement)
1965 replacement
1966 (prin1-to-string replacement t))
1967 t t)))
1969 (defun replace-loop-through-replacements (data count)
1970 ;; DATA is a vector containing the following values:
1971 ;; 0 next-rotate-count
1972 ;; 1 repeat-count
1973 ;; 2 next-replacement
1974 ;; 3 replacements
1975 (if (= (aref data 0) count)
1976 (progn
1977 (aset data 0 (+ count (aref data 1)))
1978 (let ((next (cdr (aref data 2))))
1979 (aset data 2 (if (consp next) next (aref data 3))))))
1980 (car (aref data 2)))
1982 (defun replace-match-data (integers reuse &optional new)
1983 "Like `match-data', but markers in REUSE get invalidated.
1984 If NEW is non-nil, it is set and returned instead of fresh data,
1985 but coerced to the correct value of INTEGERS."
1986 (or (and new
1987 (progn
1988 (set-match-data new)
1989 (and (eq new reuse)
1990 (eq (null integers) (markerp (car reuse)))
1991 new)))
1992 (match-data integers reuse t)))
1994 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data
1995 &optional backward)
1997 FIXEDCASE, LITERAL are passed to `replace-match' (which see).
2000 is made (to save time).
2001 MATCH-DATA is used for the replacement, and is a data structure
2002 as returned from the `match-data' function.
2003 In case editing is done, it is changed to use markers. BACKWARD is
2004 used to reverse the replacement direction.
2007 passed in. If LITERAL is set, no checking is done, anyway."
2008 (unless (or literal noedit)
2009 (setq noedit t)
2011 newtext)
2012 (setq newtext
2013 (read-string "Edit replacement string: "
2014 (prog1
2015 (cons
2016 (replace-match "" t t newtext 3)
2017 (1+ (match-beginning 3)))
2018 (setq match-data
2019 (replace-match-data
2020 nil match-data match-data))))
2021 noedit nil)))
2022 (set-match-data match-data)
2023 (replace-match newtext fixedcase literal)
2024 ;; `replace-match' leaves point at the end of the replacement text,
2025 ;; so move point to the beginning when replacing backward.
2026 (when backward (goto-char (nth 0 match-data)))
2027 noedit)
2029 (defvar replace-update-post-hook nil
2030 "Function(s) to call after query-replace has found a match in the buffer.")
2032 (defvar replace-search-function nil
2033 "Function to use when searching for strings to replace.
2034 It is used by `query-replace' and `replace-string', and is called
2035 with three arguments, as if it were `search-forward'.")
2037 (defvar replace-re-search-function nil
2038 "Function to use when searching for regexps to replace.
2039 It is used by `query-replace-regexp', `replace-regexp',
2040 `query-replace-regexp-eval', and `map-query-replace-regexp'.
2041 It is called with three arguments, as if it were
2042 `re-search-forward'.")
2044 (defun replace-search (search-string limit regexp-flag delimited-flag
2045 case-fold-search &optional backward)
2046 "Search for the next occurrence of SEARCH-STRING to replace."
2047 ;; Let-bind global isearch-* variables to values used
2048 ;; to search the next replacement. These let-bindings
2049 ;; should be effective both at the time of calling
2050 ;; `isearch-search-fun-default' and also at the
2051 ;; time of funcalling `search-function'.
2052 ;; These isearch-* bindings can't be placed higher
2053 ;; outside of this function because then another I-search
2054 ;; used after `recursive-edit' might override them.
2055 (let* ((isearch-regexp regexp-flag)
2056 (isearch-regexp-function (or delimited-flag
2057 (and replace-char-fold
2058 (not regexp-flag)
2059 #'char-fold-to-regexp)))
2060 (isearch-lax-whitespace
2061 replace-lax-whitespace)
2062 (isearch-regexp-lax-whitespace
2063 replace-regexp-lax-whitespace)
2064 (isearch-case-fold-search case-fold-search)
2065 (isearch-adjusted nil)
2066 (isearch-nonincremental t) ; don't use lax word mode
2067 (isearch-forward (not backward))
2068 (search-function
2069 (or (if regexp-flag
2070 replace-re-search-function
2071 replace-search-function)
2072 (isearch-search-fun-default))))
2073 (funcall search-function search-string limit t)))
2075 (defvar replace-overlay nil)
2077 (defun replace-highlight (match-beg match-end range-beg range-end
2078 search-string regexp-flag delimited-flag
2079 case-fold-search &optional backward)
2080 (if query-replace-highlight
2081 (if replace-overlay
2082 (move-overlay replace-overlay match-beg match-end (current-buffer))
2083 (setq replace-overlay (make-overlay match-beg match-end))
2084 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
2085 (overlay-put replace-overlay 'face 'query-replace)))
2086 (if query-replace-lazy-highlight
2087 (let ((isearch-string search-string)
2088 (isearch-regexp regexp-flag)
2089 (isearch-regexp-function delimited-flag)
2090 (isearch-lax-whitespace
2091 replace-lax-whitespace)
2092 (isearch-regexp-lax-whitespace
2093 replace-regexp-lax-whitespace)
2094 (isearch-case-fold-search case-fold-search)
2095 (isearch-forward (not backward))
2096 (isearch-other-end match-beg)
2097 (isearch-error nil))
2098 (isearch-lazy-highlight-new-loop range-beg range-end))))
2100 (defun replace-dehighlight ()
2101 (when replace-overlay
2102 (delete-overlay replace-overlay))
2103 (when query-replace-lazy-highlight
2104 (lazy-highlight-cleanup lazy-highlight-cleanup)
2105 (setq isearch-lazy-highlight-last-string nil))
2106 ;; Close overlays opened by `isearch-range-invisible' in `perform-replace'.
2107 (isearch-clean-overlays))
2109 (defun perform-replace (from-string replacements
2110 query-flag regexp-flag delimited-flag
2111 &optional repeat-count map start end backward region-noncontiguous-p)
2112 "Subroutine of `query-replace'. Its complexity handles interactive queries.
2113 Don't use this in your own program unless you want to query and set the mark
2114 just as `query-replace' does. Instead, write a simple loop like this:
2119 which will run faster and probably do exactly what you want. Please
2120 see the documentation of `replace-match' to find out how to simulate
2121 `case-replace'.
2123 This function returns nil if and only if there were no matches to
2124 make, or the user didn't cancel the call.
2126 REPLACEMENTS is either a string, a list of strings, or a cons cell
2127 containing a function and its first argument. The function is
2128 called to generate each replacement like this:
2129 (funcall (car replacements) (cdr replacements) replace-count)
2130 It must return a string."
2131 (or map (setq map query-replace-map))
2132 (and query-flag minibuffer-auto-raise
2133 (raise-frame (window-frame (minibuffer-window))))
2134 (let* ((case-fold-search
2135 (if (and case-fold-search search-upper-case)
2136 (isearch-no-upper-case-p from-string regexp-flag)
2137 case-fold-search))
2138 (nocasify (not (and case-replace case-fold-search)))
2139 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
2140 (search-string from-string)
2141 (real-match-data nil) ; The match data for the current match.
2142 (next-replacement nil)
2143 ;; This is non-nil if we know there is nothing for the user
2144 ;; to edit in the replacement.
2145 (noedit nil)
2146 (keep-going t)
2147 (stack nil)
2148 (replace-count 0)
2149 (skip-read-only-count 0)
2150 (skip-filtered-count 0)
2151 (skip-invisible-count 0)
2152 (nonempty-match nil)
2153 (multi-buffer nil)
2154 (recenter-last-op nil) ; Start cycling order with initial position.
2156 ;; If non-nil, it is marker saying where in the buffer to stop.
2157 (limit nil)
2158 ;; Use local binding in add-function below.
2159 (isearch-filter-predicate isearch-filter-predicate)
2160 (region-bounds nil)
2162 ;; Data for the next match. If a cons, it has the same format as
2163 ;; (match-data); otherwise it is t if a match is possible at point.
2164 (match-again t)
2166 (message
2167 (if query-flag
2168 (apply 'propertize
2169 (substitute-command-keys
2171 minibuffer-prompt-properties))))
2173 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
2174 (when region-noncontiguous-p
2175 (setq region-bounds
2176 (mapcar (lambda (position)
2177 (cons (copy-marker (car position))
2178 (copy-marker (cdr position))))
2179 (funcall region-extract-function 'bounds)))
2180 (add-function :after-while isearch-filter-predicate
2181 (lambda (start end)
2182 (delq nil (mapcar
2183 (lambda (bounds)
2184 (and
2185 (>= start (car bounds))
2186 (<= start (cdr bounds))
2187 (>= end (car bounds))
2188 (<= end (cdr bounds))))
2189 region-bounds)))))
2191 ;; If region is active, in Transient Mark mode, operate on region.
2192 (if backward
2193 (when end
2194 (setq limit (copy-marker (min start end)))
2195 (goto-char (max start end))
2196 (deactivate-mark))
2197 (when start
2198 (setq limit (copy-marker (max start end)))
2199 (goto-char (min start end))
2200 (deactivate-mark)))
2202 ;; If last typed key in previous call of multi-buffer perform-replace
2203 ;; was `automatic-all', don't ask more questions in next files
2204 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
2205 (setq query-flag nil multi-buffer t))
2207 (cond
2208 ((stringp replacements)
2209 (setq next-replacement replacements
2210 replacements nil))
2211 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
2212 (or repeat-count (setq repeat-count 1))
2213 (setq replacements (cons 'replace-loop-through-replacements
2214 (vector repeat-count repeat-count
2215 replacements replacements)))))
2217 (when query-replace-lazy-highlight
2218 (setq isearch-lazy-highlight-last-string nil))
2220 (push-mark)
2221 (undo-boundary)
2222 (unwind-protect
2223 ;; Loop finding occurrences that perhaps should be replaced.
2224 (while (and keep-going
2225 (if backward
2226 (not (or (bobp) (and limit (<= (point) limit))))
2227 (not (or (eobp) (and limit (>= (point) limit)))))
2228 ;; Use the next match if it is already known;
2229 ;; otherwise, search for a match after moving forward
2230 ;; one char if progress is required.
2231 (setq real-match-data
2232 (cond ((consp match-again)
2233 (goto-char (if backward
2234 (nth 0 match-again)
2235 (nth 1 match-again)))
2236 (replace-match-data
2237 t real-match-data match-again))
2238 ;; MATCH-AGAIN non-nil means accept an
2239 ;; adjacent match.
2240 (match-again
2241 (and
2242 (replace-search search-string limit
2243 regexp-flag delimited-flag
2244 case-fold-search backward)
2245 ;; For speed, use only integers and
2246 ;; reuse the list used last time.
2247 (replace-match-data t real-match-data)))
2248 ((and (if backward
2249 (> (1- (point)) (point-min))
2250 (< (1+ (point)) (point-max)))
2251 (or (null limit)
2252 (if backward
2253 (> (1- (point)) limit)
2254 (< (1+ (point)) limit))))
2255 ;; If not accepting adjacent matches,
2256 ;; move one char to the right before
2257 ;; searching again. Undo the motion
2258 ;; if the search fails.
2259 (let ((opoint (point)))
2260 (forward-char (if backward -1 1))
2261 (if (replace-search search-string limit
2262 regexp-flag delimited-flag
2263 case-fold-search backward)
2264 (replace-match-data
2265 t real-match-data)
2266 (goto-char opoint)
2267 nil))))))
2269 ;; Record whether the match is nonempty, to avoid an infinite loop
2270 ;; repeatedly matching the same empty string.
2271 (setq nonempty-match
2272 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
2274 ;; If the match is empty, record that the next one can't be
2275 ;; adjacent.
2277 ;; Otherwise, if matching a regular expression, do the next
2278 ;; match now, since the replacement for this match may
2279 ;; affect whether the next match is adjacent to this one.
2280 ;; If that match is empty, don't use it.
2281 (setq match-again
2282 (and nonempty-match
2283 (or (not regexp-flag)
2284 (and (if backward
2285 (looking-back search-string nil)
2286 (looking-at search-string))
2287 (let ((match (match-data)))
2288 (and (/= (nth 0 match) (nth 1 match))
2289 match))))))
2291 (cond
2292 ;; Optionally ignore matches that have a read-only property.
2293 ((not (or (not query-replace-skip-read-only)
2294 (not (text-property-not-all
2295 (nth 0 real-match-data) (nth 1 real-match-data)
2296 'read-only nil))))
2297 (setq skip-read-only-count (1+ skip-read-only-count)))
2298 ;; Optionally filter out matches.
2299 ((not (funcall isearch-filter-predicate
2300 (nth 0 real-match-data) (nth 1 real-match-data)))
2301 (setq skip-filtered-count (1+ skip-filtered-count)))
2302 ;; Optionally ignore invisible matches.
2303 ((not (or (eq search-invisible t)
2304 ;; Don't open overlays for automatic replacements.
2305 (and (not query-flag) search-invisible)
2306 ;; Open hidden overlays for interactive replacements.
2307 (not (isearch-range-invisible
2308 (nth 0 real-match-data) (nth 1 real-match-data)))))
2309 (setq skip-invisible-count (1+ skip-invisible-count)))
2310 (t
2311 ;; Calculate the replacement string, if necessary.
2312 (when replacements
2313 (set-match-data real-match-data)
2314 (setq next-replacement
2315 (funcall (car replacements) (cdr replacements)
2316 replace-count)))
2317 (if (not query-flag)
2318 (progn
2319 (unless (or literal noedit)
2320 (replace-highlight
2321 (nth 0 real-match-data) (nth 1 real-match-data)
2322 start end search-string
2323 regexp-flag delimited-flag case-fold-search backward))
2324 (setq noedit
2325 (replace-match-maybe-edit
2326 next-replacement nocasify literal
2327 noedit real-match-data backward)
2328 replace-count (1+ replace-count)))
2329 (undo-boundary)
2330 (let (done replaced key def)
2331 ;; Loop reading commands until one of them sets done,
2332 ;; which means it has finished handling this
2333 ;; occurrence. Any command that sets `done' should
2334 ;; leave behind proper match data for the stack.
2335 ;; Commands not setting `done' need to adjust
2336 ;; `real-match-data'.
2337 (while (not done)
2338 (set-match-data real-match-data)
2339 (run-hooks 'replace-update-post-hook) ; Before `replace-highlight'.
2340 (replace-highlight
2341 (match-beginning 0) (match-end 0)
2342 start end search-string
2343 regexp-flag delimited-flag case-fold-search backward)
2344 ;; Bind message-log-max so we don't fill up the message log
2345 ;; with a bunch of identical messages.
2346 (let ((message-log-max nil)
2347 (replacement-presentation
2348 (if query-replace-show-replacement
2349 (save-match-data
2350 (set-match-data real-match-data)
2351 (match-substitute-replacement next-replacement
2352 nocasify literal))
2353 next-replacement)))
2354 (message message
2355 (query-replace-descr from-string)
2356 (query-replace-descr replacement-presentation)))
2357 (setq key (read-event))
2358 ;; Necessary in case something happens during read-event
2359 ;; that clobbers the match data.
2360 (set-match-data real-match-data)
2361 (setq key (vector key))
2362 (setq def (lookup-key map key))
2363 ;; Restore the match data while we process the command.
2364 (cond ((eq def 'help)
2365 (with-output-to-temp-buffer "*Help*"
2366 (princ
2367 (concat "Query replacing "
2368 (if delimited-flag
2369 (or (and (symbolp delimited-flag)
2370 (get delimited-flag 'isearch-message-prefix))
2371 "word ") "")
2372 (if regexp-flag "regexp " "")
2373 (if backward "backward " "")
2374 from-string " with "
2376 (substitute-command-keys
2377 query-replace-help)))
2378 (with-current-buffer standard-output
2379 (help-mode))))
2380 ((eq def 'exit)
2381 (setq keep-going nil)
2382 (setq done t))
2383 ((eq def 'exit-current)
2384 (setq multi-buffer t keep-going nil done t))
2385 ((eq def 'backup)
2386 (if stack
2387 (let ((elt (pop stack)))
2388 (goto-char (nth 0 elt))
2389 (setq replaced (nth 1 elt)
2390 real-match-data
2391 (replace-match-data
2392 t real-match-data
2393 (nth 2 elt))))
2394 (message "No previous match")
2395 (ding 'no-terminate)
2396 (sit-for 1)))
2397 ((eq def 'act)
2398 (or replaced
2399 (setq noedit
2400 (replace-match-maybe-edit
2401 next-replacement nocasify literal
2402 noedit real-match-data backward)
2403 replace-count (1+ replace-count)))
2404 (setq done t replaced t))
2405 ((eq def 'act-and-exit)
2406 (or replaced
2407 (setq noedit
2408 (replace-match-maybe-edit
2409 next-replacement nocasify literal
2410 noedit real-match-data backward)
2411 replace-count (1+ replace-count)))
2412 (setq keep-going nil)
2413 (setq done t replaced t))
2414 ((eq def 'act-and-show)
2415 (if (not replaced)
2416 (setq noedit
2417 (replace-match-maybe-edit
2418 next-replacement nocasify literal
2419 noedit real-match-data backward)
2420 replace-count (1+ replace-count)
2421 real-match-data (replace-match-data
2422 t real-match-data)
2423 replaced t)))
2424 ((or (eq def 'automatic) (eq def 'automatic-all))
2425 (or replaced
2426 (setq noedit
2427 (replace-match-maybe-edit
2428 next-replacement nocasify literal
2429 noedit real-match-data backward)
2430 replace-count (1+ replace-count)))
2431 (setq done t query-flag nil replaced t)
2432 (if (eq def 'automatic-all) (setq multi-buffer t)))
2433 ((eq def 'skip)
2434 (setq done t))
2435 ((eq def 'recenter)
2436 ;; `this-command' has the value `query-replace',
2437 ;; so we need to bind it to `recenter-top-bottom'
2438 ;; to allow it to detect a sequence of `C-l'.
2439 (let ((this-command 'recenter-top-bottom)
2440 (last-command 'recenter-top-bottom))
2441 (recenter-top-bottom)))
2442 ((eq def 'edit)
2443 (let ((opos (point-marker)))
2444 (setq real-match-data (replace-match-data
2445 nil real-match-data
2446 real-match-data))
2447 (goto-char (match-beginning 0))
2448 (save-excursion
2449 (save-window-excursion
2450 (recursive-edit)))
2451 (goto-char opos)
2452 (set-marker opos nil))
2453 ;; Before we make the replacement,
2454 ;; decide whether the search string
2455 ;; can match again just after this match.
2456 (if (and regexp-flag nonempty-match)
2457 (setq match-again (and (looking-at search-string)
2458 (match-data)))))
2459 ;; Edit replacement.
2460 ((eq def 'edit-replacement)
2461 (setq real-match-data (replace-match-data
2462 nil real-match-data
2463 real-match-data)
2464 next-replacement
2465 (read-string "Edit replacement string: "
2466 next-replacement)
2467 noedit nil)
2468 (if replaced
2469 (set-match-data real-match-data)
2470 (setq noedit
2471 (replace-match-maybe-edit
2472 next-replacement nocasify literal noedit
2473 real-match-data backward)
2474 replaced t))
2475 (setq done t))
2477 ((eq def 'delete-and-edit)
2478 (replace-match "" t t)
2479 (setq real-match-data (replace-match-data
2480 nil real-match-data))
2481 (replace-dehighlight)
2482 (save-excursion (recursive-edit))
2483 (setq replaced t))
2484 ;; Note: we do not need to treat `exit-prefix'
2485 ;; specially here, since we reread
2486 ;; any unrecognized character.
2487 (t
2488 (setq this-command 'mode-exited)
2489 (setq keep-going nil)
2490 (setq unread-command-events
2491 (append (listify-key-sequence key)
2492 unread-command-events))
2493 (setq done t)))
2494 (when query-replace-lazy-highlight
2495 ;; Force lazy rehighlighting only after replacements.
2496 (if (not (memq def '(skip backup)))
2497 (setq isearch-lazy-highlight-last-string nil)))
2498 (unless (eq def 'recenter)
2499 ;; Reset recenter cycling order to initial position.
2500 (setq recenter-last-op nil)))
2501 ;; Record previous position for ^ when we move on.
2502 ;; Change markers to numbers in the match data
2503 ;; since lots of markers slow down editing.
2504 (push (list (point) replaced
2505 ;;; If the replacement has already happened, all we need is the
2506 ;;; current match start and end. We could get this with a trivial
2507 ;;; match like
2508 ;;; (save-excursion (goto-char (match-beginning 0))
2509 ;;; (search-forward (match-string 0))
2510 ;;; (match-data t))
2511 ;;; if we really wanted to avoid manually constructing match data.
2512 ;;; Adding current-buffer is necessary so that match-data calls can
2513 ;;; return markers which are appropriate for editing.
2514 (if replaced
2515 (list
2516 (match-beginning 0)
2517 (match-end 0)
2518 (current-buffer))
2519 (match-data t)))
2520 stack))))))
2522 (replace-dehighlight))
2523 (or unread-command-events
2524 (message "Replaced %d occurrence%s%s"
2525 replace-count
2526 (if (= replace-count 1) "" "s")
2527 (if (> (+ skip-read-only-count
2528 skip-filtered-count
2529 skip-invisible-count) 0)
2530 (format " (skipped %s)"
2531 (mapconcat
2532 'identity
2533 (delq nil (list
2534 (if (> skip-read-only-count 0)
2535 (format "%s read-only"
2536 skip-read-only-count))
2537 (if (> skip-invisible-count 0)
2538 (format "%s invisible"
2539 skip-invisible-count))
2540 (if (> skip-filtered-count 0)
2541 (format "%s filtered out"
2542 skip-filtered-count))))
2543 ", "))
2544 "")))
2545 (or (and keep-going stack) multi-buffer)))
2547 ;;; replace.el ends here