| blob | 1bf134302e4937b7ca11fe14ae9a4221734fe668 |
1 ;;; replace.el --- replace commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2015 Free
4 ;; Software Foundation, Inc.
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This package supplies the string and regular-expression replace functions
27 ;; documented in the Emacs user's manual.
29 ;;; Code:
32 "Non-nil means `query-replace' should preserve case in replacements."
37 "Non-nil means `query-replace' matches a sequence of whitespace chars.
38 When you enter a space or spaces in the strings to be replaced,
39 it will match any sequence matched by the regexp `search-whitespace-regexp'."
45 "Non-nil means `query-replace-regexp' matches a sequence of whitespace chars.
46 When you enter a space or spaces in the regexps to be replaced,
47 it will match any sequence matched by the regexp `search-whitespace-regexp'."
53 "Default history list for query-replace commands.
54 See `query-replace-from-history-variable' and
58 "Default values of FROM-STRING and TO-STRING for `query-replace'.
59 This is a list of cons cells (FROM-STRING . TO-STRING), or nil
63 "Non-nil means `query-replace' uses the last search string.
66 "use `M-n' to pull the last incremental search string
67 to the minibuffer that reads the string to replace, or invoke replacements
73 "String that separates FROM and TO in the history of replacement pairs."
74 ;; Avoids error when attempt to autoload char-displayable-p fails
75 ;; while preparing to dump, also stops customize-rogue listing this.
82 "History list to use for the FROM argument of `query-replace' commands.
83 The value of this variable should be a symbol; that symbol
84 is used as a variable to hold a history list for the strings
85 or patterns to be replaced."
91 "History list to use for the TO argument of `query-replace' commands.
92 The value of this variable should be a symbol; that symbol
93 is used as a variable to hold a history list for replacement
94 strings or patterns."
100 "Non-nil means `query-replace' and friends ignore read-only matches."
106 "Non-nil means to show what actual replacement text will be."
112 "Non-nil means to highlight matches during query replacement."
117 "Controls the lazy-highlighting during query replacements.
118 When non-nil, all text in the buffer matching the current match
119 is highlighted lazily using isearch lazy highlighting (see
120 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
128 "Face for highlighting query replacement matches."
133 "Number of replacements done so far.
140 "Split string STRING at a character with property `separator'"
150 "Query and return the `from' argument of a query-replace operation.
151 The return value can also be a pair (FROM . TO) indicating that the user
152 wants to replace FROM with TO."
155 ;; Reevaluating will check char-displayable-p that is
156 ;; unavailable while preparing to dump.
162 'display query-replace-from-to-separator
169 separator
171 query-replace-defaults))
179 ;; The save-excursion here is in case the user marks and copies
180 ;; a region in order to specify the minibuffer input.
181 ;; That should not clobber the region for the query-replace itself.
186 prompt nil nil nil 'query-replace-from-to-history
196 ;; Warn if user types \n or \t, but don't reject the input.
207 from
213 "Maybe convert a regexp replacement TO to Lisp.
214 Returns a list suitable for `perform-replace' if necessary,
215 the original string if not."
231 ;; Swallow a space after a symbol
232 ;; if there is a space.
234 ;; Swallow a space after 'foo
235 ;; but not after (quote foo).
250 to))
254 "Query and return the `to' argument of a query-replace operation."
260 nil nil nil
261 query-replace-to-history-variable from t)))
264 to))
265 regexp-flag))
278 "Replace some occurrences of FROM-STRING with TO-STRING.
279 As each match is found, the user must type a character saying
282 In Transient Mark mode, if the mark is active, operate on the contents
283 of the region. Otherwise, operate from point to the end of the buffer.
286 to pull the last incremental search string to the minibuffer
287 that reads FROM-STRING, or invoke replacements from
288 incremental search with a key sequence like `C-s C-s M-%'
289 to use its current search string as the string to replace.
291 Matching is independent of case if `case-fold-search' is non-nil and
292 FROM-STRING has no uppercase letters. Replacement transfers the case
293 pattern of the old text to the new text, if `case-replace' and
294 `case-fold-search' are non-nil and FROM-STRING has no uppercase
295 letters. (Transferring the case pattern means that if the old text
296 matched is all caps, or capitalized, then its replacement is upcased
297 or capitalized.)
299 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
300 ignore hidden matches if `search-invisible' is nil, and ignore more
301 matches using `isearch-filter-predicate'.
303 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
304 to be replaced will match a sequence of whitespace chars defined by the
305 regexp in `search-whitespace-regexp'.
307 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
308 only matches surrounded by word boundaries. A negative prefix arg means
309 replace backward.
311 Fourth and fifth arg START and END specify the region to operate on.
313 To customize possible responses, change the bindings in `query-replace-map'."
322 nil)))
324 ;; These are done separately here
325 ;; so that command-history will record these expressions
326 ;; rather than the values they had this time.
337 "Replace some things after point matching REGEXP with TO-STRING.
338 As each match is found, the user must type a character saying
341 In Transient Mark mode, if the mark is active, operate on the contents
342 of the region. Otherwise, operate from point to the end of the buffer.
345 to pull the last incremental search regexp to the minibuffer
346 that reads REGEXP, or invoke replacements from
347 incremental search with a key sequence like `C-M-s C-M-s C-M-%'
348 to use its current search regexp as the regexp to replace.
350 Matching is independent of case if `case-fold-search' is non-nil and
351 REGEXP has no uppercase letters. Replacement transfers the case
352 pattern of the old text to the new text, if `case-replace' and
353 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
354 \(Transferring the case pattern means that if the old text matched is
355 all caps, or capitalized, then its replacement is upcased or
356 capitalized.)
358 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
359 ignore hidden matches if `search-invisible' is nil, and ignore more
360 matches using `isearch-filter-predicate'.
362 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
363 to be replaced will match a sequence of whitespace chars defined by the
364 regexp in `search-whitespace-regexp'.
366 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
367 only matches surrounded by word boundaries. A negative prefix arg means
368 replace backward.
370 Fourth and fifth arg START and END specify the region to operate on.
376 at the given position for each replacement.
379 followed by a Lisp expression. Each
380 replacement evaluates that expression to compute the replacement
383 for the whole or a partial match converted to a number with
385 done so far (starting with zero).
387 If the replacement expression is a symbol, write a space after it
388 to terminate it. One space there, if any, will be discarded.
390 When using those Lisp features interactively in the replacement
391 text, TO-STRING is actually made a list instead of a string.
400 " regexp"
402 t)))
404 ;; These are done separately here
405 ;; so that command-history will record these expressions
406 ;; rather than the values they had this time.
417 "Replace some things after point matching REGEXP with the result of TO-EXPR.
419 Interactive use of this function is deprecated in favor of the
421 using `search-forward-regexp' and `replace-match' is preferred.
423 As each match is found, the user must type a character saying
426 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
427 reference `replace-count' to get the number of replacements already made.
428 If the result of TO-EXPR is not a string, it is converted to one using
429 `prin1-to-string' with the NOESCAPE argument (which see).
437 In Transient Mark mode, if the mark is active, operate on the contents
438 of the region. Otherwise, operate from point to the end of the buffer.
441 to pull the last incremental search regexp to the minibuffer
442 that reads REGEXP.
444 Preserves case in each replacement if `case-replace' and `case-fold-search'
445 are non-nil and REGEXP has no uppercase letters.
447 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
448 ignore hidden matches if `search-invisible' is nil, and ignore more
449 matches using `isearch-filter-predicate'.
451 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
452 to be replaced will match a sequence of whitespace chars defined by the
453 regexp in `search-whitespace-regexp'.
455 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
456 only matches that are surrounded by word boundaries.
457 Fourth and fifth arg START and END specify the region to operate on."
459 for interactive calls, and `search-forward-regexp'/`replace-match'
465 ;; Let-bind the history var to disable the "foo -> bar"
466 ;; default. Maybe we shouldn't disable this default, but
467 ;; for now I'll leave it off. --Stef
473 nil nil t query-replace-to-history-variable from t))))
474 ;; We make TO a list because replace-match-string-symbols requires one,
475 ;; and the user might enter a single token.
486 "Replace some matches for REGEXP with various strings, in rotation.
487 The second argument TO-STRINGS contains the replacement strings, separated
488 by spaces. This command works like `query-replace-regexp' except that
489 each successive replacement uses the next successive replacement string,
490 wrapping around from the last such string to the first.
492 In Transient Mark mode, if the mark is active, operate on the contents
493 of the region. Otherwise, operate from point to the end of the buffer.
495 Non-interactively, TO-STRINGS may be a list of replacement strings.
497 Interactively, reads the regexp using `read-regexp'.
499 to pull the last incremental search regexp to the minibuffer
500 that reads REGEXP.
502 A prefix argument N says to use each replacement string N times
503 before rotating to the next.
504 Fourth and fifth arg START and END specify the region to operate on."
507 query-replace-from-history-variable))
511 nil nil nil
512 query-replace-to-history-variable from t)))
536 "Replace occurrences of FROM-STRING with TO-STRING.
537 Preserve case in each match if `case-replace' and `case-fold-search'
538 are non-nil and FROM-STRING has no uppercase letters.
539 \(Preserving case means that if the string matched is all caps, or capitalized,
540 then its replacement is upcased or capitalized.)
542 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
543 ignore hidden matches if `search-invisible' is nil, and ignore more
544 matches using `isearch-filter-predicate'.
546 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
547 to be replaced will match a sequence of whitespace chars defined by the
548 regexp in `search-whitespace-regexp'.
550 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
551 only matches surrounded by word boundaries. A negative prefix arg means
552 replace backward.
554 Operates on the region between START and END (if both are nil, from point
555 to the end of the buffer). Interactively, if Transient Mark mode is
556 enabled and the mark is active, operates on the contents of the region;
557 otherwise from point to the end of the buffer.
560 to pull the last incremental search string to the minibuffer
561 that reads FROM-STRING.
563 This function is usually the wrong thing to use in a Lisp program.
564 What you probably want is a loop like this:
565 (while (search-forward FROM-STRING nil t)
566 (replace-match TO-STRING nil t))
567 which will run faster and will not set the mark or print anything.
568 \(You may need a more complex loop if FROM-STRING can match the null string
569 and TO-STRING is also null.)"
579 " string"
581 nil)))
591 "Replace things after point matching REGEXP with TO-STRING.
592 Preserve case in each match if `case-replace' and `case-fold-search'
593 are non-nil and REGEXP has no uppercase letters.
595 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
596 ignore hidden matches if `search-invisible' is nil, and ignore more
597 matches using `isearch-filter-predicate'.
599 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
600 to be replaced will match a sequence of whitespace chars defined by the
601 regexp in `search-whitespace-regexp'.
603 In Transient Mark mode, if the mark is active, operate on the contents
604 of the region. Otherwise, operate from point to the end of the buffer.
606 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
607 only matches surrounded by word boundaries. A negative prefix arg means
608 replace backward.
610 Fourth and fifth arg START and END specify the region to operate on.
616 at the given position for each replacement.
619 followed by a Lisp expression used as part of the replacement
623 `replace-count', the number of replacements occurred so far.
625 If your Lisp expression is an identifier and the next letter in
626 the replacement string would be interpreted as part of it, you
629 replacement text directly.
631 When using those Lisp features interactively in the replacement
632 text, TO-STRING is actually made a list instead of a string.
636 to pull the last incremental search regexp to the minibuffer
637 that reads REGEXP.
639 This function is usually the wrong thing to use in a Lisp program.
640 What you probably want is a loop like this:
641 (while (re-search-forward REGEXP nil t)
642 (replace-match TO-STRING nil nil))
643 which will run faster and will not set the mark or print anything."
653 " regexp"
655 t)))
664 \f
666 "History list for some commands that read regular expressions.
668 Maximum length of the history list is determined by the value
675 "Function that provides default regexp(s) for `read-regexp'.
676 This function should take no arguments and return one of: nil, a
677 regexp, or a list of regexps. Interactively, `read-regexp' uses
678 the return value of this function for its DEFAULT argument.
680 As an example, set this variable to `find-tag-default-as-regexp'
681 to default to the symbol at point.
683 To provide different default regexps for different commands,
684 the function that you set this to can check `this-command'."
689 find-tag-default)
691 find-tag-default-as-regexp)
693 find-tag-default-as-symbol-regexp)
699 "Return a list of standard suggestions for `read-regexp'.
700 By default, the list includes the tag at point, the last isearch regexp,
701 the last isearch string, and the last replacement regexp. `read-regexp'
702 appends the list returned by this function to the end of values available
712 "Read and return a regular expression as a string.
715 possibly preceded by the default result (see below).
717 The optional argument DEFAULTS can be either: nil, a string, a list
718 of strings, or a symbol. We use DEFAULTS to construct the default
719 return value in case of empty input.
721 If DEFAULTS is a string, we use it as-is.
723 If DEFAULTS is a list of strings, the first element is the
724 default return value, but all the elements are accessible
727 If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
728 is non-nil, we use that in place of DEFAULTS in the following:
729 If DEFAULTS is the symbol `regexp-history-last', we use the first
730 element of HISTORY (if specified) or `regexp-history'.
731 If DEFAULTS is a function, we call it with no arguments and use
732 what it returns, which should be either nil, a string, or a list of strings.
734 We append the standard values from `read-regexp-suggestions' to DEFAULTS
735 before using it.
737 If the first element of DEFAULTS is non-nil (and if PROMPT does not end
740 The optional argument HISTORY is a symbol to use for the history list.
741 If nil, uses `regexp-history'."
750 defaults))
755 ;; Do not automatically add default to the history for empty input.
759 prompt)
767 ;; Return the default value when the user enters empty input.
771 ;; Otherwise, add non-empty input to the history and return input.
782 "Read arguments for `keep-lines' and friends.
783 Prompt for a regexp with PROMPT.
784 Value is a list, (REGEXP)."
788 "Delete all lines except those containing matches for REGEXP.
789 A match split across lines preserves all the lines it lies in.
790 When called from Lisp (and usually interactively as well, see below)
791 applies to all lines starting after point.
794 and `search-upper-case' is non-nil, the matching is case-sensitive.
796 Second and third arg RSTART and REND specify the region to operate on.
797 This command operates on (the accessible part of) all lines whose
798 accessible part is entirely contained in the region determined by RSTART
799 and REND. (A newline ending a line counts as part of that line.)
801 Interactively, in Transient Mark mode when the mark is active, operate
802 on all lines whose accessible part is entirely contained in the region.
803 Otherwise, the command applies to all lines starting after point.
804 When calling this function from Lisp, you can pretend that it was
805 called interactively by passing a non-nil INTERACTIVE argument.
807 This function starts looking for the next match from the end of
808 the previous match. Hence, it ignores matches that overlap
809 a previously found match."
841 case-fold-search)))
843 ;; Start is first char not preserved by previous match.
849 ;; Now end is first char preserved by the new match.
854 ;; If the match was empty, avoid matching again at same place.
859 nil)
863 "Delete lines containing matches for REGEXP.
864 When called from Lisp (and usually when called interactively as
865 well, see below), applies to the part of the buffer after point.
866 The line point is in is deleted if and only if it contains a
867 match for regexp starting after point.
870 and `search-upper-case' is non-nil, the matching is case-sensitive.
872 Second and third arg RSTART and REND specify the region to operate on.
873 Lines partially contained in this region are deleted if and only if
874 they contain a match entirely contained in it.
876 Interactively, in Transient Mark mode when the mark is active, operate
877 on the contents of the region. Otherwise, operate from point to the
878 end of (the accessible portion of) the buffer. When calling this function
879 from Lisp, you can pretend that it was called interactively by passing
880 a non-nil INTERACTIVE argument.
882 If a match is split across lines, all the lines it lies in are deleted.
883 They are deleted _before_ looking for the next match. Hence, a match
884 starting on the same line at which another match ended is ignored."
903 case-fold-search)))
912 nil)
916 "Print and return number of matches for REGEXP following point.
917 When called from Lisp and INTERACTIVE is omitted or nil, just return
918 the number, do not print it; if INTERACTIVE is t, the function behaves
919 in all respects as if it had been called interactively.
922 and `search-upper-case' is non-nil, the matching is case-sensitive.
924 Second and third arg RSTART and REND specify the region to operate on.
926 Interactively, in Transient Mark mode when the mark is active, operate
927 on the contents of the region. Otherwise, operate from point to the
928 end of (the accessible portion of) the buffer.
930 This function starts looking for the next match from the end of
931 the previous match. Hence, it ignores matches that overlap
932 a previously found match."
951 opoint
955 case-fold-search)))
963 count
965 count)))
967 \f
972 next-error-follow-minor-mode
975 next-error-follow-minor-mode))))
1011 map)
1016 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
1029 map)
1033 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
1039 "Hook run when entering Occur mode."
1044 "Hook run by Occur when there are any matches."
1049 "Hook run by Occur after locating an occurrence.
1050 This will be called with the cursor position at the occurrence. An application
1051 for this is to reveal context in an outline-mode when the occurrence is hidden."
1066 \f
1067 ;;; Occur Edit mode
1077 map)
1081 "Major mode for editing *Occur* buffers.
1082 In this mode, changes to the *Occur* buffer are also applied to
1083 the originating buffer.
1092 "Switch from Occur Edit mode to Occur mode."
1104 col)
1108 ;; Apply occur-target property to inserted (e.g. yanked) text.
1110 ;; Did we insert a newline? Occur Edit mode can't create new
1111 ;; Occur entries; just discard everything after the newline.
1125 line-beg 'occur-prefix nil
1126 line-end))
1138 \f
1140 "Handle `revert-buffer' for Occur mode buffers."
1149 pos))
1153 "Go to the occurrence on the current line."
1157 ;; Actually `event-end' works correctly with a nil argument as
1158 ;; well, so we could dispense with this test, but let's not
1159 ;; rely on this undocumented behavior.
1170 "Go to the occurrence the current line describes, in another window."
1178 "Display in another window the occurrence the current line describes."
1181 window)
1183 ;; This is the way to set point in the proper window.
1203 "Move to the Nth (default 1) next match in an Occur mode buffer."
1208 "Move to the Nth (default 1) previous match in an Occur mode buffer."
1213 "Move to the Nth (default 1) next match in an Occur mode buffer.
1216 ;; we need to run occur-find-match from within the Occur buffer
1218 ;; Choose the buffer and make it current.
1232 #'previous-single-property-change
1235 ;; In case the *Occur* buffer is visible in a nonselected window.
1239 \f
1252 "Face used to highlight matches permanently."
1257 "Default number of context lines included around `list-matching-lines' matches.
1258 A negative number means to include that many lines before the match.
1259 A positive number means to include that many lines both before and after."
1267 If the value is nil, don't highlight the matching portions specially."
1273 If the value is nil, don't highlight the buffer names specially."
1279 If the face doesn't differ from the default face,
1280 don't highlight the prefix with line numbers specially."
1287 yank-handler follow-link)
1288 "Text properties to discard when copying lines to the *Occur* buffer.
1289 The value should be a list of text properties to discard or t,
1290 which means to discard all text properties."
1298 "Collect strings matching regexp"
1303 ;; Perform collect operation
1305 ;; No subexpression so collect the entire match.
1307 ;; Get the regexp for collection pattern.
1312 ;; Otherwise normal occur takes numerical prefix argument.
1317 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1318 Here `original-buffer-name' is the buffer name where Occur was originally run.
1319 When given the prefix argument, or called non-interactively, the renaming
1320 will not clobber the existing buffer(s) of that name, but use
1321 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1322 if you always want a separate *Occur* buffer for each buffer where you
1323 invoke `occur'."
1334 "Show all lines in the current buffer containing a match for REGEXP.
1335 If a match spreads across multiple lines, all those lines are shown.
1337 Each line is displayed with NLINES lines before and after, or -NLINES
1338 before if NLINES is negative.
1339 NLINES defaults to `list-matching-lines-default-context-lines'.
1340 Interactively it is the prefix arg.
1342 The lines are shown in a buffer named `*Occur*'.
1343 It serves as a menu to find any of the occurrences in this buffer.
1347 and `search-upper-case' is non-nil, the matching is case-sensitive.
1349 When NLINES is a string or when the function is called
1350 interactively with prefix argument without a number (`C-u' alone
1351 as prefix) the matching strings are collected into the `*Occur*'
1352 buffer by using NLINES as a replacement regexp. NLINES may
1356 program. When there is no parenthesized subexpressions in REGEXP
1357 the entire match is collected. In any case the searched buffer
1358 is not modified."
1365 "Show all lines in buffers BUFS containing a match for REGEXP.
1366 This function acts on multiple buffers; otherwise, it is exactly like
1367 `occur'. When you invoke this command interactively, you must specify
1368 the buffer names that you want, one by one.
1369 See also `multi-occur-in-matching-buffers'."
1379 "Next buffer to search (C-j to end): "
1381 nil t))
1390 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1391 Normally BUFREGEXP matches against each buffer's visited file name,
1392 but if you specify a prefix argument, it matches against the buffer name.
1393 See also `multi-occur'."
1400 "List lines in buffers whose names match regexp: "
1403 default
1404 input))
1416 buf))
1427 bufs))))
1428 ;; Handle the case where one of the buffers we're searching is the
1429 ;; output buffer. Just rename it.
1434 ;; Now find or create the output buffer.
1435 ;; If we just renamed that buffer, we will make a new one here.
1443 ;; Don't generate undo entries for creation of the initial contents.
1448 ;; Treat nlines as a regexp to collect.
1456 ;; Insert the replacement regexp.
1465 count)
1466 ;; Perform normal occur.
1468 regexp active-bufs occur-buf
1472 case-fold-search)
1473 list-matching-lines-buffer-name-face
1475 list-matching-lines-prefix-face)
1476 list-matching-lines-face
1485 ;; Don't display regexp if with remaining text
1486 ;; it is longer than window-width.
1499 title-face prefix-face match-face keep-props)
1505 ;; Map over all the buffers
1524 ;; Set CODING only if the current buffer locally
1525 ;; binds buffer-file-coding-system.
1535 ;; Get beginning of first match line and end of the last.
1541 ;; Sum line numbers up to the first match line.
1546 ;; Highlight the matches
1556 ;; Add `match-face' to faces copied from the buffer.
1559 match-face nil curstring))
1560 ;; Avoid infloop (Bug#7593).
1563 ;; Generate the string to insert for this match
1565 ;; Using 7 digits aligns tabs properly.
1571 ;; Allow insertion of text at
1572 ;; the end of the prefix (for
1573 ;; Occur Edit mode).
1574 front-sticky t rear-nonsticky t
1575 occur-target ,marker follow-link t
1578 ;; We don't put `mouse-face' on the newline,
1579 ;; because that loses. And don't put it
1580 ;; on context lines to reduce flicker.
1582 'occur-target marker
1583 'follow-link t
1584 'help-echo
1588 match-prefix
1589 ;; Add non-numeric prefix to all non-first lines
1590 ;; of multi-line matches.
1596 match-str)
1597 ;; Add marker at eol, but no mouse props.
1601 ;; The simple display style
1602 out-line
1603 ;; The complex multi-line display style.
1605 out-line nlines keep-props begpt endpt
1606 curr-line prev-line prev-after-lines
1607 prefix-face))
1608 ;; Set first elem of the returned list to `data',
1609 ;; and the second elem to `prev-after-lines'.
1612 ;; Actually insert the match display data
1618 ;; Sum line numbers between first and last match lines.
1620 ;; Add 1 for empty last match line since
1621 ;; count-lines returns 1 line less.
1623 ;; On to the next match...
1627 ;; Flush remaining context after-lines.
1631 prev-after-lines prefix-face)))))))
1638 end)
1642 ;; Don't display the same number of lines
1643 ;; and matches in case of 1 match per line.
1647 ;; Don't display regexp for multi-buffer.
1658 ;; Display total match count and regexp for multi-buffer.
1662 end)
1665 ;; Don't display the same number of lines
1666 ;; and matches in case of 1 match per line.
1676 ;; CODING is buffer-file-coding-system of the first buffer
1677 ;; that locally binds it. Let's use it also for the output
1678 ;; buffer.
1680 ;; Return the number of matches
1681 global-matches)))
1692 str)
1702 lines))
1709 result beg end moved)
1721 ;; Generate context display for occur.
1722 ;; OUT-LINE is the line where the match is.
1723 ;; NLINES and KEEP-PROPS are args to occur-engine.
1724 ;; CURR-LINE is line count of the current match,
1725 ;; PREV-LINE is line count of the previous match,
1726 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1727 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1728 ;; then concatenate them all together.
1730 curr-line prev-line prev-after-lines
1732 ;; Find after- and before-context lines of the current match.
1739 separator)
1741 ;; Combine after-lines of the previous match
1742 ;; with before-lines of the current match.
1745 ;; Don't overlap prev after-lines with current before-lines.
1752 ;; Separate non-overlapping context lines with a dashed line.
1756 ;; Don't overlap current before-lines with previous match line.
1758 prev-line)
1762 before-lines))
1763 ;; Separate non-overlapping before-context lines.
1768 ;; Return a list where the first element is the output line.
1776 separator)))
1779 ;; And the second element is the list of context after-lines.
1782 \f
1783 ;; It would be nice to use \\[...], but there is no reasonable way
1784 ;; to make that display both SPC and Y.
1786 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1787 RET or `q' to exit, Period to replace one match and exit,
1788 Comma to replace but not move point immediately,
1790 C-w to delete match and recursive edit,
1791 C-l to clear the screen, redisplay, and offer same replacement again,
1792 ! to replace all remaining matches in this buffer with no more questions,
1793 ^ to move point back to previous match,
1794 E to edit the replacement string.
1795 In multi-buffer replacements type `Y' to replace all remaining
1796 matches in all remaining buffers with no more questions,
1797 `N' to skip to the next buffer without replacing remaining matches
1798 in the current buffer."
1806 (define-key map [backspace] 'skip)
1807 (define-key map "y" 'act)
1808 (define-key map "n" 'skip)
1809 (define-key map "Y" 'act)
1810 (define-key map "N" 'skip)
1811 (define-key map "e" 'edit-replacement)
1812 (define-key map "E" 'edit-replacement)
1813 (define-key map "," 'act-and-show)
1814 (define-key map "q" 'exit)
1816 (define-key map [return] 'exit)
1817 (define-key map "." 'act-and-exit)
1818 (define-key map "\C-r" 'edit)
1819 (define-key map "\C-w" 'delete-and-edit)
1820 (define-key map "\C-l" 'recenter)
1821 (define-key map "!" 'automatic)
1822 (define-key map "^" 'backup)
1823 (define-key map "\C-h" 'help)
1824 (define-key map [f1] 'help)
1825 (define-key map [help] 'help)
1826 (define-key map "?" 'help)
1827 (define-key map "\C-g" 'quit)
1828 (define-key map "\C-]" 'quit)
1829 (define-key map "\C-v" 'scroll-up)
1830 (define-key map "\M-v" 'scroll-down)
1831 (define-key map [next] 'scroll-up)
1832 (define-key map [prior] 'scroll-down)
1833 (define-key map [?\C-\M-v] 'scroll-other-window)
1834 (define-key map [M-next] 'scroll-other-window)
1835 (define-key map [?\C-\M-\S-v] 'scroll-other-window-down)
1836 (define-key map [M-prior] 'scroll-other-window-down)
1837 ;; Binding ESC would prohibit the M-v binding. Instead, callers
1838 ;; should check for ESC specially.
1839 ;; (define-key map "\e" 'exit-prefix)
1840 (define-key map [escape] 'exit-prefix)
1841 map)
1842 "Keymap of responses to questions posed by commands like `query-replace'.
1844 The valid answers include `act', `skip', `act-and-show',
1845 `act-and-exit', `exit', `exit-prefix', `recenter', `scroll-up',
1846 `scroll-down', `scroll-other-window', `scroll-other-window-down',
1847 `edit', `edit-replacement', `delete-and-edit', `automatic',
1848 `backup', `quit', and `help'.
1850 This keymap is used by `y-or-n-p' as well as `query-replace'.")
1852 (defvar multi-query-replace-map
1853 (let ((map (make-sparse-keymap)))
1854 (set-keymap-parent map query-replace-map)
1855 (define-key map "Y" 'automatic-all)
1856 (define-key map "N" 'exit-current)
1857 map)
1858 "Keymap that defines additional bindings for multi-buffer replacements.
1859 It extends its parent map `query-replace-map' with new bindings to
1860 operate on a set of buffers/files. The difference with its parent map
1861 is the additional answers `automatic-all' to replace all remaining
1862 matches in all remaining buffers with no more questions, and
1863 `exit-current' to skip remaining matches in the current buffer
1864 and to continue with the next buffer in the sequence.")
1866 (defun replace-match-string-symbols (n)
1867 "Process a list (and any sub-lists), expanding certain symbols.
1868 Symbol Expands To
1869 N (match-string N) (where N is a string of digits)
1870 #N (string-to-number (match-string N))
1871 & (match-string 0)
1872 #& (string-to-number (match-string 0))
1873 # replace-count
1875 Note that these symbols must be preceded by a backslash in order to
1876 type them using Lisp syntax."
1877 (while (consp n)
1878 (cond
1879 ((consp (car n))
1880 (replace-match-string-symbols (car n))) ;Process sub-list
1881 ((symbolp (car n))
1882 (let ((name (symbol-name (car n))))
1883 (cond
1884 ((string-match "^[0-9]+$" name)
1885 (setcar n (list 'match-string (string-to-number name))))
1886 ((string-match "^#[0-9]+$" name)
1887 (setcar n (list 'string-to-number
1888 (list 'match-string
1889 (string-to-number (substring name 1))))))
1890 ((string= "&" name)
1891 (setcar n '(match-string 0)))
1892 ((string= "#&" name)
1893 (setcar n '(string-to-number (match-string 0))))
1894 ((string= "#" name)
1895 (setcar n 'replace-count))))))
1896 (setq n (cdr n))))
1898 (defun replace-eval-replacement (expression count)
1899 (let* ((replace-count count)
1900 err
1901 (replacement
1902 (condition-case err
1903 (eval expression)
1904 (error
1905 (error "Error evaluating replacement expression: %S" err)))))
1906 (if (stringp replacement)
1907 replacement
1908 (prin1-to-string replacement t))))
1910 (defun replace-quote (replacement)
1911 "Quote a replacement string.
1912 This just doubles all backslashes in REPLACEMENT and
1913 returns the resulting string. If REPLACEMENT is not
1914 a string, it is first passed through `prin1-to-string'
1915 with the `noescape' argument set.
1917 `match-data' is preserved across the call."
1918 (save-match-data
1920 (if (stringp replacement)
1921 replacement
1922 (prin1-to-string replacement t))
1923 t t)))
1925 (defun replace-loop-through-replacements (data count)
1926 ;; DATA is a vector containing the following values:
1927 ;; 0 next-rotate-count
1928 ;; 1 repeat-count
1929 ;; 2 next-replacement
1930 ;; 3 replacements
1931 (if (= (aref data 0) count)
1932 (progn
1933 (aset data 0 (+ count (aref data 1)))
1934 (let ((next (cdr (aref data 2))))
1935 (aset data 2 (if (consp next) next (aref data 3))))))
1936 (car (aref data 2)))
1938 (defun replace-match-data (integers reuse &optional new)
1939 "Like `match-data', but markers in REUSE get invalidated.
1940 If NEW is non-nil, it is set and returned instead of fresh data,
1941 but coerced to the correct value of INTEGERS."
1942 (or (and new
1943 (progn
1944 (set-match-data new)
1945 (and (eq new reuse)
1946 (eq (null integers) (markerp (car reuse)))
1947 new)))
1948 (match-data integers reuse t)))
1950 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data backward)
1952 FIXEDCASE, LITERAL are passed to `replace-match' (which see).
1955 is made (to save time). MATCH-DATA is used for the replacement.
1956 In case editing is done, it is changed to use markers.
1959 passed in. If LITERAL is set, no checking is done, anyway."
1960 (unless (or literal noedit)
1961 (setq noedit t)
1963 newtext)
1964 (setq newtext
1965 (read-string "Edit replacement string: "
1966 (prog1
1967 (cons
1968 (replace-match "" t t newtext 3)
1969 (1+ (match-beginning 3)))
1970 (setq match-data
1971 (replace-match-data
1972 nil match-data match-data))))
1973 noedit nil)))
1974 (set-match-data match-data)
1975 (replace-match newtext fixedcase literal)
1976 ;; `replace-match' leaves point at the end of the replacement text,
1977 ;; so move point to the beginning when replacing backward.
1978 (when backward (goto-char (nth 0 match-data)))
1979 noedit)
1981 (defvar replace-search-function nil
1982 "Function to use when searching for strings to replace.
1983 It is used by `query-replace' and `replace-string', and is called
1984 with three arguments, as if it were `search-forward'.")
1986 (defvar replace-re-search-function nil
1987 "Function to use when searching for regexps to replace.
1988 It is used by `query-replace-regexp', `replace-regexp',
1989 `query-replace-regexp-eval', and `map-query-replace-regexp'.
1990 It is called with three arguments, as if it were
1991 `re-search-forward'.")
1993 (defun replace-search (search-string limit regexp-flag delimited-flag
1994 case-fold-search backward)
1995 "Search for the next occurrence of SEARCH-STRING to replace."
1996 ;; Let-bind global isearch-* variables to values used
1997 ;; to search the next replacement. These let-bindings
1998 ;; should be effective both at the time of calling
1999 ;; `isearch-search-fun-default' and also at the
2000 ;; time of funcalling `search-function'.
2001 ;; These isearch-* bindings can't be placed higher
2002 ;; outside of this function because then another I-search
2003 ;; used after `recursive-edit' might override them.
2004 (let* ((isearch-regexp regexp-flag)
2005 (isearch-word delimited-flag)
2006 (isearch-lax-whitespace
2007 replace-lax-whitespace)
2008 (isearch-regexp-lax-whitespace
2009 replace-regexp-lax-whitespace)
2010 (isearch-case-fold-search case-fold-search)
2011 (isearch-adjusted nil)
2012 (isearch-nonincremental t) ; don't use lax word mode
2013 (isearch-forward (not backward))
2014 (search-function
2015 (or (if regexp-flag
2016 replace-re-search-function
2017 replace-search-function)
2018 (isearch-search-fun-default))))
2019 (funcall search-function search-string limit t)))
2021 (defvar replace-overlay nil)
2023 (defun replace-highlight (match-beg match-end range-beg range-end
2024 search-string regexp-flag delimited-flag
2025 case-fold-search backward)
2026 (if query-replace-highlight
2027 (if replace-overlay
2028 (move-overlay replace-overlay match-beg match-end (current-buffer))
2029 (setq replace-overlay (make-overlay match-beg match-end))
2030 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
2031 (overlay-put replace-overlay 'face 'query-replace)))
2032 (if query-replace-lazy-highlight
2033 (let ((isearch-string search-string)
2034 (isearch-regexp regexp-flag)
2035 (isearch-word delimited-flag)
2036 (isearch-lax-whitespace
2037 replace-lax-whitespace)
2038 (isearch-regexp-lax-whitespace
2039 replace-regexp-lax-whitespace)
2040 (isearch-case-fold-search case-fold-search)
2041 (isearch-forward (not backward))
2042 (isearch-other-end match-beg)
2043 (isearch-error nil))
2044 (isearch-lazy-highlight-new-loop range-beg range-end))))
2046 (defun replace-dehighlight ()
2047 (when replace-overlay
2048 (delete-overlay replace-overlay))
2049 (when query-replace-lazy-highlight
2050 (lazy-highlight-cleanup lazy-highlight-cleanup)
2051 (setq isearch-lazy-highlight-last-string nil))
2052 ;; Close overlays opened by `isearch-range-invisible' in `perform-replace'.
2053 (isearch-clean-overlays))
2055 (defun perform-replace (from-string replacements
2056 query-flag regexp-flag delimited-flag
2057 &optional repeat-count map start end backward)
2058 "Subroutine of `query-replace'. Its complexity handles interactive queries.
2059 Don't use this in your own program unless you want to query and set the mark
2060 just as `query-replace' does. Instead, write a simple loop like this:
2065 which will run faster and probably do exactly what you want. Please
2066 see the documentation of `replace-match' to find out how to simulate
2067 `case-replace'.
2069 This function returns nil if and only if there were no matches to
2070 make, or the user didn't cancel the call."
2071 (or map (setq map query-replace-map))
2072 (and query-flag minibuffer-auto-raise
2073 (raise-frame (window-frame (minibuffer-window))))
2074 (let* ((case-fold-search
2075 (if (and case-fold-search search-upper-case)
2076 (isearch-no-upper-case-p from-string regexp-flag)
2077 case-fold-search))
2078 (nocasify (not (and case-replace case-fold-search)))
2079 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
2080 (search-string from-string)
2081 (real-match-data nil) ; The match data for the current match.
2082 (next-replacement nil)
2083 ;; This is non-nil if we know there is nothing for the user
2084 ;; to edit in the replacement.
2085 (noedit nil)
2086 (keep-going t)
2087 (stack nil)
2088 (replace-count 0)
2089 (skip-read-only-count 0)
2090 (skip-filtered-count 0)
2091 (skip-invisible-count 0)
2092 (nonempty-match nil)
2093 (multi-buffer nil)
2094 (recenter-last-op nil) ; Start cycling order with initial position.
2096 ;; If non-nil, it is marker saying where in the buffer to stop.
2097 (limit nil)
2099 ;; Data for the next match. If a cons, it has the same format as
2100 ;; (match-data); otherwise it is t if a match is possible at point.
2101 (match-again t)
2103 (message
2104 (if query-flag
2105 (apply 'propertize
2106 (substitute-command-keys
2108 minibuffer-prompt-properties))))
2110 ;; If region is active, in Transient Mark mode, operate on region.
2111 (if backward
2112 (when end
2113 (setq limit (copy-marker (min start end)))
2114 (goto-char (max start end))
2115 (deactivate-mark))
2116 (when start
2117 (setq limit (copy-marker (max start end)))
2118 (goto-char (min start end))
2119 (deactivate-mark)))
2121 ;; If last typed key in previous call of multi-buffer perform-replace
2122 ;; was `automatic-all', don't ask more questions in next files
2123 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
2124 (setq query-flag nil multi-buffer t))
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 (cond
2132 ((stringp replacements)
2133 (setq next-replacement replacements
2134 replacements nil))
2135 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
2136 (or repeat-count (setq repeat-count 1))
2137 (setq replacements (cons 'replace-loop-through-replacements
2138 (vector repeat-count repeat-count
2139 replacements replacements)))))
2141 (when query-replace-lazy-highlight
2142 (setq isearch-lazy-highlight-last-string nil))
2144 (push-mark)
2145 (undo-boundary)
2146 (unwind-protect
2147 ;; Loop finding occurrences that perhaps should be replaced.
2148 (while (and keep-going
2149 (if backward
2150 (not (or (bobp) (and limit (<= (point) limit))))
2151 (not (or (eobp) (and limit (>= (point) limit)))))
2152 ;; Use the next match if it is already known;
2153 ;; otherwise, search for a match after moving forward
2154 ;; one char if progress is required.
2155 (setq real-match-data
2156 (cond ((consp match-again)
2157 (goto-char (if backward
2158 (nth 0 match-again)
2159 (nth 1 match-again)))
2160 (replace-match-data
2161 t real-match-data match-again))
2162 ;; MATCH-AGAIN non-nil means accept an
2163 ;; adjacent match.
2164 (match-again
2165 (and
2166 (replace-search search-string limit
2167 regexp-flag delimited-flag
2168 case-fold-search backward)
2169 ;; For speed, use only integers and
2170 ;; reuse the list used last time.
2171 (replace-match-data t real-match-data)))
2172 ((and (if backward
2173 (> (1- (point)) (point-min))
2174 (< (1+ (point)) (point-max)))
2175 (or (null limit)
2176 (if backward
2177 (> (1- (point)) limit)
2178 (< (1+ (point)) limit))))
2179 ;; If not accepting adjacent matches,
2180 ;; move one char to the right before
2181 ;; searching again. Undo the motion
2182 ;; if the search fails.
2183 (let ((opoint (point)))
2184 (forward-char (if backward -1 1))
2185 (if (replace-search search-string limit
2186 regexp-flag delimited-flag
2187 case-fold-search backward)
2188 (replace-match-data
2189 t real-match-data)
2190 (goto-char opoint)
2191 nil))))))
2193 ;; Record whether the match is nonempty, to avoid an infinite loop
2194 ;; repeatedly matching the same empty string.
2195 (setq nonempty-match
2196 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
2198 ;; If the match is empty, record that the next one can't be
2199 ;; adjacent.
2201 ;; Otherwise, if matching a regular expression, do the next
2202 ;; match now, since the replacement for this match may
2203 ;; affect whether the next match is adjacent to this one.
2204 ;; If that match is empty, don't use it.
2205 (setq match-again
2206 (and nonempty-match
2207 (or (not regexp-flag)
2208 (and (if backward
2209 (looking-back search-string)
2210 (looking-at search-string))
2211 (let ((match (match-data)))
2212 (and (/= (nth 0 match) (nth 1 match))
2213 match))))))
2215 (cond
2216 ;; Optionally ignore matches that have a read-only property.
2217 ((not (or (not query-replace-skip-read-only)
2218 (not (text-property-not-all
2219 (nth 0 real-match-data) (nth 1 real-match-data)
2220 'read-only nil))))
2221 (setq skip-read-only-count (1+ skip-read-only-count)))
2222 ;; Optionally filter out matches.
2223 ((not (funcall isearch-filter-predicate
2224 (nth 0 real-match-data) (nth 1 real-match-data)))
2225 (setq skip-filtered-count (1+ skip-filtered-count)))
2226 ;; Optionally ignore invisible matches.
2227 ((not (or (eq search-invisible t)
2228 ;; Don't open overlays for automatic replacements.
2229 (and (not query-flag) search-invisible)
2230 ;; Open hidden overlays for interactive replacements.
2231 (not (isearch-range-invisible
2232 (nth 0 real-match-data) (nth 1 real-match-data)))))
2233 (setq skip-invisible-count (1+ skip-invisible-count)))
2234 (t
2235 ;; Calculate the replacement string, if necessary.
2236 (when replacements
2237 (set-match-data real-match-data)
2238 (setq next-replacement
2239 (funcall (car replacements) (cdr replacements)
2240 replace-count)))
2241 (if (not query-flag)
2242 (progn
2243 (unless (or literal noedit)
2244 (replace-highlight
2245 (nth 0 real-match-data) (nth 1 real-match-data)
2246 start end search-string
2247 regexp-flag delimited-flag case-fold-search backward))
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 (undo-boundary)
2254 (let (done replaced key def)
2255 ;; Loop reading commands until one of them sets done,
2256 ;; which means it has finished handling this
2257 ;; occurrence. Any command that sets `done' should
2258 ;; leave behind proper match data for the stack.
2259 ;; Commands not setting `done' need to adjust
2260 ;; `real-match-data'.
2261 (while (not done)
2262 (set-match-data real-match-data)
2263 (replace-highlight
2264 (match-beginning 0) (match-end 0)
2265 start end search-string
2266 regexp-flag delimited-flag case-fold-search backward)
2267 ;; Bind message-log-max so we don't fill up the message log
2268 ;; with a bunch of identical messages.
2269 (let ((message-log-max nil)
2270 (replacement-presentation
2271 (if query-replace-show-replacement
2272 (save-match-data
2273 (set-match-data real-match-data)
2274 (match-substitute-replacement next-replacement
2275 nocasify literal))
2276 next-replacement)))
2277 (message message
2278 (query-replace-descr from-string)
2279 (query-replace-descr replacement-presentation)))
2280 (setq key (read-event))
2281 ;; Necessary in case something happens during read-event
2282 ;; that clobbers the match data.
2283 (set-match-data real-match-data)
2284 (setq key (vector key))
2285 (setq def (lookup-key map key))
2286 ;; Restore the match data while we process the command.
2287 (cond ((eq def 'help)
2288 (with-output-to-temp-buffer "*Help*"
2289 (princ
2290 (concat "Query replacing "
2291 (if delimited-flag
2292 (or (and (symbolp delimited-flag)
2293 (get delimited-flag 'isearch-message-prefix))
2294 "word ") "")
2295 (if regexp-flag "regexp " "")
2296 (if backward "backward " "")
2297 from-string " with "
2299 (substitute-command-keys
2300 query-replace-help)))
2301 (with-current-buffer standard-output
2302 (help-mode))))
2303 ((eq def 'exit)
2304 (setq keep-going nil)
2305 (setq done t))
2306 ((eq def 'exit-current)
2307 (setq multi-buffer t keep-going nil done t))
2308 ((eq def 'backup)
2309 (if stack
2310 (let ((elt (pop stack)))
2311 (goto-char (nth 0 elt))
2312 (setq replaced (nth 1 elt)
2313 real-match-data
2314 (replace-match-data
2315 t real-match-data
2316 (nth 2 elt))))
2317 (message "No previous match")
2318 (ding 'no-terminate)
2319 (sit-for 1)))
2320 ((eq def 'act)
2321 (or replaced
2322 (setq noedit
2323 (replace-match-maybe-edit
2324 next-replacement nocasify literal
2325 noedit real-match-data backward)
2326 replace-count (1+ replace-count)))
2327 (setq done t replaced t))
2328 ((eq def 'act-and-exit)
2329 (or replaced
2330 (setq noedit
2331 (replace-match-maybe-edit
2332 next-replacement nocasify literal
2333 noedit real-match-data backward)
2334 replace-count (1+ replace-count)))
2335 (setq keep-going nil)
2336 (setq done t replaced t))
2337 ((eq def 'act-and-show)
2338 (if (not replaced)
2339 (setq noedit
2340 (replace-match-maybe-edit
2341 next-replacement nocasify literal
2342 noedit real-match-data backward)
2343 replace-count (1+ replace-count)
2344 real-match-data (replace-match-data
2345 t real-match-data)
2346 replaced t)))
2347 ((or (eq def 'automatic) (eq def 'automatic-all))
2348 (or replaced
2349 (setq noedit
2350 (replace-match-maybe-edit
2351 next-replacement nocasify literal
2352 noedit real-match-data backward)
2353 replace-count (1+ replace-count)))
2354 (setq done t query-flag nil replaced t)
2355 (if (eq def 'automatic-all) (setq multi-buffer t)))
2356 ((eq def 'skip)
2357 (setq done t))
2358 ((eq def 'recenter)
2359 ;; `this-command' has the value `query-replace',
2360 ;; so we need to bind it to `recenter-top-bottom'
2361 ;; to allow it to detect a sequence of `C-l'.
2362 (let ((this-command 'recenter-top-bottom)
2363 (last-command 'recenter-top-bottom))
2364 (recenter-top-bottom)))
2365 ((eq def 'edit)
2366 (let ((opos (point-marker)))
2367 (setq real-match-data (replace-match-data
2368 nil real-match-data
2369 real-match-data))
2370 (goto-char (match-beginning 0))
2371 (save-excursion
2372 (save-window-excursion
2373 (recursive-edit)))
2374 (goto-char opos)
2375 (set-marker opos nil))
2376 ;; Before we make the replacement,
2377 ;; decide whether the search string
2378 ;; can match again just after this match.
2379 (if (and regexp-flag nonempty-match)
2380 (setq match-again (and (looking-at search-string)
2381 (match-data)))))
2382 ;; Edit replacement.
2383 ((eq def 'edit-replacement)
2384 (setq real-match-data (replace-match-data
2385 nil real-match-data
2386 real-match-data)
2387 next-replacement
2388 (read-string "Edit replacement string: "
2389 next-replacement)
2390 noedit nil)
2391 (if replaced
2392 (set-match-data real-match-data)
2393 (setq noedit
2394 (replace-match-maybe-edit
2395 next-replacement nocasify literal noedit
2396 real-match-data backward)
2397 replaced t))
2398 (setq done t))
2400 ((eq def 'delete-and-edit)
2401 (replace-match "" t t)
2402 (setq real-match-data (replace-match-data
2403 nil real-match-data))
2404 (replace-dehighlight)
2405 (save-excursion (recursive-edit))
2406 (setq replaced t))
2407 ;; Note: we do not need to treat `exit-prefix'
2408 ;; specially here, since we reread
2409 ;; any unrecognized character.
2410 (t
2411 (setq this-command 'mode-exited)
2412 (setq keep-going nil)
2413 (setq unread-command-events
2414 (append (listify-key-sequence key)
2415 unread-command-events))
2416 (setq done t)))
2417 (when query-replace-lazy-highlight
2418 ;; Force lazy rehighlighting only after replacements.
2419 (if (not (memq def '(skip backup)))
2420 (setq isearch-lazy-highlight-last-string nil)))
2421 (unless (eq def 'recenter)
2422 ;; Reset recenter cycling order to initial position.
2423 (setq recenter-last-op nil)))
2424 ;; Record previous position for ^ when we move on.
2425 ;; Change markers to numbers in the match data
2426 ;; since lots of markers slow down editing.
2427 (push (list (point) replaced
2428 ;;; If the replacement has already happened, all we need is the
2429 ;;; current match start and end. We could get this with a trivial
2430 ;;; match like
2431 ;;; (save-excursion (goto-char (match-beginning 0))
2432 ;;; (search-forward (match-string 0))
2433 ;;; (match-data t))
2434 ;;; if we really wanted to avoid manually constructing match data.
2435 ;;; Adding current-buffer is necessary so that match-data calls can
2436 ;;; return markers which are appropriate for editing.
2437 (if replaced
2438 (list
2439 (match-beginning 0)
2440 (match-end 0)
2441 (current-buffer))
2442 (match-data t)))
2443 stack))))))
2445 (replace-dehighlight))
2446 (or unread-command-events
2447 (message "Replaced %d occurrence%s%s"
2448 replace-count
2449 (if (= replace-count 1) "" "s")
2450 (if (> (+ skip-read-only-count
2451 skip-filtered-count
2452 skip-invisible-count) 0)
2453 (format " (skipped %s)"
2454 (mapconcat
2455 'identity
2456 (delq nil (list
2457 (if (> skip-read-only-count 0)
2458 (format "%s read-only"
2459 skip-read-only-count))
2460 (if (> skip-invisible-count 0)
2461 (format "%s invisible"
2462 skip-invisible-count))
2463 (if (> skip-filtered-count 0)
2464 (format "%s filtered out"
2465 skip-filtered-count))))
2466 ", "))
2467 "")))
2468 (or (and keep-going stack) multi-buffer)))
2470 ;;; replace.el ends here