| blob | 70b86dd2016c23c904ef683209090412a2be793c |
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 ;; Ignore errors when attempt to autoload char-displayable-p
74 ;; fails while preparing to dump.
78 "String that separates FROM and TO in the history of replacement pairs."
84 "History list to use for the FROM argument of `query-replace' commands.
85 The value of this variable should be a symbol; that symbol
86 is used as a variable to hold a history list for the strings
87 or patterns to be replaced."
93 "History list to use for the TO argument of `query-replace' commands.
94 The value of this variable should be a symbol; that symbol
95 is used as a variable to hold a history list for replacement
96 strings or patterns."
102 "Non-nil means `query-replace' and friends ignore read-only matches."
108 "Non-nil means to show what actual replacement text will be."
114 "Non-nil means to highlight matches during query replacement."
119 "Controls the lazy-highlighting during query replacements.
120 When non-nil, all text in the buffer matching the current match
121 is highlighted lazily using isearch lazy highlighting (see
122 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
130 "Face for highlighting query replacement matches."
135 "Number of replacements done so far.
142 "Query and return the `from' argument of a query-replace operation.
143 The return value can also be a pair (FROM . TO) indicating that the user
144 wants to replace FROM with TO."
147 ;; Reevaluating will check char-displayable-p that is
148 ;; unavailable while preparing to dump.
154 'display query-replace-from-to-separator
161 separator
163 query-replace-defaults))
171 ;; The save-excursion here is in case the user marks and copies
172 ;; a region in order to specify the minibuffer input.
173 ;; That should not clobber the region for the query-replace itself.
178 prompt nil nil nil 'query-replace-from-to-history
190 ;; Warn if user types \n or \t, but don't reject the input.
201 from
207 "Maybe convert a regexp replacement TO to Lisp.
208 Returns a list suitable for `perform-replace' if necessary,
209 the original string if not."
225 ;; Swallow a space after a symbol
226 ;; if there is a space.
228 ;; Swallow a space after 'foo
229 ;; but not after (quote foo).
244 to))
248 "Query and return the `to' argument of a query-replace operation."
254 nil nil nil
255 query-replace-to-history-variable from t)))
258 to))
259 regexp-flag))
272 "Replace some occurrences of FROM-STRING with TO-STRING.
273 As each match is found, the user must type a character saying
276 In Transient Mark mode, if the mark is active, operate on the contents
277 of the region. Otherwise, operate from point to the end of the buffer.
280 to pull the last incremental search string to the minibuffer
281 that reads FROM-STRING, or invoke replacements from
282 incremental search with a key sequence like `C-s C-s M-%'
283 to use its current search string as the string to replace.
285 Matching is independent of case if `case-fold-search' is non-nil and
286 FROM-STRING has no uppercase letters. Replacement transfers the case
287 pattern of the old text to the new text, if `case-replace' and
288 `case-fold-search' are non-nil and FROM-STRING has no uppercase
289 letters. (Transferring the case pattern means that if the old text
290 matched is all caps, or capitalized, then its replacement is upcased
291 or capitalized.)
293 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
294 ignore hidden matches if `search-invisible' is nil, and ignore more
295 matches using `isearch-filter-predicate'.
297 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
298 to be replaced will match a sequence of whitespace chars defined by the
299 regexp in `search-whitespace-regexp'.
301 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
302 only matches surrounded by word boundaries. A negative prefix arg means
303 replace backward.
305 Fourth and fifth arg START and END specify the region to operate on.
307 To customize possible responses, change the bindings in `query-replace-map'."
316 nil)))
318 ;; These are done separately here
319 ;; so that command-history will record these expressions
320 ;; rather than the values they had this time.
331 "Replace some things after point matching REGEXP with TO-STRING.
332 As each match is found, the user must type a character saying
335 In Transient Mark mode, if the mark is active, operate on the contents
336 of the region. Otherwise, operate from point to the end of the buffer.
339 to pull the last incremental search regexp to the minibuffer
340 that reads REGEXP, or invoke replacements from
341 incremental search with a key sequence like `C-M-s C-M-s C-M-%'
342 to use its current search regexp as the regexp to replace.
344 Matching is independent of case if `case-fold-search' is non-nil and
345 REGEXP has no uppercase letters. Replacement transfers the case
346 pattern of the old text to the new text, if `case-replace' and
347 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
348 \(Transferring the case pattern means that if the old text matched is
349 all caps, or capitalized, then its replacement is upcased or
350 capitalized.)
352 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
353 ignore hidden matches if `search-invisible' is nil, and ignore more
354 matches using `isearch-filter-predicate'.
356 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
357 to be replaced will match a sequence of whitespace chars defined by the
358 regexp in `search-whitespace-regexp'.
360 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
361 only matches surrounded by word boundaries. A negative prefix arg means
362 replace backward.
364 Fourth and fifth arg START and END specify the region to operate on.
370 at the given position for each replacement.
373 followed by a Lisp expression. Each
374 replacement evaluates that expression to compute the replacement
377 for the whole or a partial match converted to a number with
379 done so far (starting with zero).
381 If the replacement expression is a symbol, write a space after it
382 to terminate it. One space there, if any, will be discarded.
384 When using those Lisp features interactively in the replacement
385 text, TO-STRING is actually made a list instead of a string.
394 " regexp"
396 t)))
398 ;; These are done separately here
399 ;; so that command-history will record these expressions
400 ;; rather than the values they had this time.
411 "Replace some things after point matching REGEXP with the result of TO-EXPR.
413 Interactive use of this function is deprecated in favor of the
415 using `search-forward-regexp' and `replace-match' is preferred.
417 As each match is found, the user must type a character saying
420 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
421 reference `replace-count' to get the number of replacements already made.
422 If the result of TO-EXPR is not a string, it is converted to one using
423 `prin1-to-string' with the NOESCAPE argument (which see).
431 In Transient Mark mode, if the mark is active, operate on the contents
432 of the region. Otherwise, operate from point to the end of the buffer.
435 to pull the last incremental search regexp to the minibuffer
436 that reads REGEXP.
438 Preserves case in each replacement if `case-replace' and `case-fold-search'
439 are non-nil and REGEXP has no uppercase letters.
441 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
442 ignore hidden matches if `search-invisible' is nil, and ignore more
443 matches using `isearch-filter-predicate'.
445 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
446 to be replaced will match a sequence of whitespace chars defined by the
447 regexp in `search-whitespace-regexp'.
449 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
450 only matches that are surrounded by word boundaries.
451 Fourth and fifth arg START and END specify the region to operate on."
453 for interactive calls, and `search-forward-regexp'/`replace-match'
459 ;; Let-bind the history var to disable the "foo -> bar"
460 ;; default. Maybe we shouldn't disable this default, but
461 ;; for now I'll leave it off. --Stef
467 nil nil t query-replace-to-history-variable from t))))
468 ;; We make TO a list because replace-match-string-symbols requires one,
469 ;; and the user might enter a single token.
480 "Replace some matches for REGEXP with various strings, in rotation.
481 The second argument TO-STRINGS contains the replacement strings, separated
482 by spaces. This command works like `query-replace-regexp' except that
483 each successive replacement uses the next successive replacement string,
484 wrapping around from the last such string to the first.
486 In Transient Mark mode, if the mark is active, operate on the contents
487 of the region. Otherwise, operate from point to the end of the buffer.
489 Non-interactively, TO-STRINGS may be a list of replacement strings.
491 Interactively, reads the regexp using `read-regexp'.
493 to pull the last incremental search regexp to the minibuffer
494 that reads REGEXP.
496 A prefix argument N says to use each replacement string N times
497 before rotating to the next.
498 Fourth and fifth arg START and END specify the region to operate on."
501 query-replace-from-history-variable))
505 nil nil nil
506 query-replace-to-history-variable from t)))
530 "Replace occurrences of FROM-STRING with TO-STRING.
531 Preserve case in each match if `case-replace' and `case-fold-search'
532 are non-nil and FROM-STRING has no uppercase letters.
533 \(Preserving case means that if the string matched is all caps, or capitalized,
534 then its replacement is upcased or capitalized.)
536 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
537 ignore hidden matches if `search-invisible' is nil, and ignore more
538 matches using `isearch-filter-predicate'.
540 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
541 to be replaced will match a sequence of whitespace chars defined by the
542 regexp in `search-whitespace-regexp'.
544 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
545 only matches surrounded by word boundaries. A negative prefix arg means
546 replace backward.
548 Operates on the region between START and END (if both are nil, from point
549 to the end of the buffer). Interactively, if Transient Mark mode is
550 enabled and the mark is active, operates on the contents of the region;
551 otherwise from point to the end of the buffer.
554 to pull the last incremental search string to the minibuffer
555 that reads FROM-STRING.
557 This function is usually the wrong thing to use in a Lisp program.
558 What you probably want is a loop like this:
559 (while (search-forward FROM-STRING nil t)
560 (replace-match TO-STRING nil t))
561 which will run faster and will not set the mark or print anything.
562 \(You may need a more complex loop if FROM-STRING can match the null string
563 and TO-STRING is also null.)"
573 " string"
575 nil)))
585 "Replace things after point matching REGEXP with TO-STRING.
586 Preserve case in each match if `case-replace' and `case-fold-search'
587 are non-nil and REGEXP has no uppercase letters.
589 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
590 ignore hidden matches if `search-invisible' is nil, and ignore more
591 matches using `isearch-filter-predicate'.
593 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
594 to be replaced will match a sequence of whitespace chars defined by the
595 regexp in `search-whitespace-regexp'.
597 In Transient Mark mode, if the mark is active, operate on the contents
598 of the region. Otherwise, operate from point to the end of the buffer.
600 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
601 only matches surrounded by word boundaries. A negative prefix arg means
602 replace backward.
604 Fourth and fifth arg START and END specify the region to operate on.
610 at the given position for each replacement.
613 followed by a Lisp expression used as part of the replacement
617 `replace-count', the number of replacements occurred so far.
619 If your Lisp expression is an identifier and the next letter in
620 the replacement string would be interpreted as part of it, you
623 replacement text directly.
625 When using those Lisp features interactively in the replacement
626 text, TO-STRING is actually made a list instead of a string.
630 to pull the last incremental search regexp to the minibuffer
631 that reads REGEXP.
633 This function is usually the wrong thing to use in a Lisp program.
634 What you probably want is a loop like this:
635 (while (re-search-forward REGEXP nil t)
636 (replace-match TO-STRING nil nil))
637 which will run faster and will not set the mark or print anything."
647 " regexp"
649 t)))
658 \f
660 "History list for some commands that read regular expressions.
662 Maximum length of the history list is determined by the value
669 "Function that provides default regexp(s) for `read-regexp'.
670 This function should take no arguments and return one of: nil, a
671 regexp, or a list of regexps. Interactively, `read-regexp' uses
672 the return value of this function for its DEFAULT argument.
674 As an example, set this variable to `find-tag-default-as-regexp'
675 to default to the symbol at point.
677 To provide different default regexps for different commands,
678 the function that you set this to can check `this-command'."
683 find-tag-default)
685 find-tag-default-as-regexp)
687 find-tag-default-as-symbol-regexp)
693 "Return a list of standard suggestions for `read-regexp'.
694 By default, the list includes the tag at point, the last isearch regexp,
695 the last isearch string, and the last replacement regexp. `read-regexp'
696 appends the list returned by this function to the end of values available
706 "Read and return a regular expression as a string.
709 possibly preceded by the default result (see below).
711 The optional argument DEFAULTS can be either: nil, a string, a list
712 of strings, or a symbol. We use DEFAULTS to construct the default
713 return value in case of empty input.
715 If DEFAULTS is a string, we use it as-is.
717 If DEFAULTS is a list of strings, the first element is the
718 default return value, but all the elements are accessible
721 If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
722 is non-nil, we use that in place of DEFAULTS in the following:
723 If DEFAULTS is the symbol `regexp-history-last', we use the first
724 element of HISTORY (if specified) or `regexp-history'.
725 If DEFAULTS is a function, we call it with no arguments and use
726 what it returns, which should be either nil, a string, or a list of strings.
728 We append the standard values from `read-regexp-suggestions' to DEFAULTS
729 before using it.
731 If the first element of DEFAULTS is non-nil (and if PROMPT does not end
734 The optional argument HISTORY is a symbol to use for the history list.
735 If nil, uses `regexp-history'."
744 defaults))
749 ;; Do not automatically add default to the history for empty input.
753 prompt)
761 ;; Return the default value when the user enters empty input.
765 ;; Otherwise, add non-empty input to the history and return input.
776 "Read arguments for `keep-lines' and friends.
777 Prompt for a regexp with PROMPT.
778 Value is a list, (REGEXP)."
782 "Delete all lines except those containing matches for REGEXP.
783 A match split across lines preserves all the lines it lies in.
784 When called from Lisp (and usually interactively as well, see below)
785 applies to all lines starting after point.
788 and `search-upper-case' is non-nil, the matching is case-sensitive.
790 Second and third arg RSTART and REND specify the region to operate on.
791 This command operates on (the accessible part of) all lines whose
792 accessible part is entirely contained in the region determined by RSTART
793 and REND. (A newline ending a line counts as part of that line.)
795 Interactively, in Transient Mark mode when the mark is active, operate
796 on all lines whose accessible part is entirely contained in the region.
797 Otherwise, the command applies to all lines starting after point.
798 When calling this function from Lisp, you can pretend that it was
799 called interactively by passing a non-nil INTERACTIVE argument.
801 This function starts looking for the next match from the end of
802 the previous match. Hence, it ignores matches that overlap
803 a previously found match."
835 case-fold-search)))
837 ;; Start is first char not preserved by previous match.
843 ;; Now end is first char preserved by the new match.
848 ;; If the match was empty, avoid matching again at same place.
853 nil)
857 "Delete lines containing matches for REGEXP.
858 When called from Lisp (and usually when called interactively as
859 well, see below), applies to the part of the buffer after point.
860 The line point is in is deleted if and only if it contains a
861 match for regexp starting after point.
864 and `search-upper-case' is non-nil, the matching is case-sensitive.
866 Second and third arg RSTART and REND specify the region to operate on.
867 Lines partially contained in this region are deleted if and only if
868 they contain a match entirely contained in it.
870 Interactively, in Transient Mark mode when the mark is active, operate
871 on the contents of the region. Otherwise, operate from point to the
872 end of (the accessible portion of) the buffer. When calling this function
873 from Lisp, you can pretend that it was called interactively by passing
874 a non-nil INTERACTIVE argument.
876 If a match is split across lines, all the lines it lies in are deleted.
877 They are deleted _before_ looking for the next match. Hence, a match
878 starting on the same line at which another match ended is ignored."
897 case-fold-search)))
906 nil)
910 "Print and return number of matches for REGEXP following point.
911 When called from Lisp and INTERACTIVE is omitted or nil, just return
912 the number, do not print it; if INTERACTIVE is t, the function behaves
913 in all respects as if it had been called interactively.
916 and `search-upper-case' is non-nil, the matching is case-sensitive.
918 Second and third arg RSTART and REND specify the region to operate on.
920 Interactively, in Transient Mark mode when the mark is active, operate
921 on the contents of the region. Otherwise, operate from point to the
922 end of (the accessible portion of) the buffer.
924 This function starts looking for the next match from the end of
925 the previous match. Hence, it ignores matches that overlap
926 a previously found match."
945 opoint
949 case-fold-search)))
957 count
959 count)))
961 \f
966 next-error-follow-minor-mode
969 next-error-follow-minor-mode))))
1005 map)
1010 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
1023 map)
1027 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
1033 "Hook run when entering Occur mode."
1038 "Hook run by Occur when there are any matches."
1043 "Hook run by Occur after locating an occurrence.
1044 This will be called with the cursor position at the occurrence. An application
1045 for this is to reveal context in an outline-mode when the occurrence is hidden."
1060 \f
1061 ;;; Occur Edit mode
1071 map)
1075 "Major mode for editing *Occur* buffers.
1076 In this mode, changes to the *Occur* buffer are also applied to
1077 the originating buffer.
1086 "Switch from Occur Edit mode to Occur mode."
1098 col)
1102 ;; Apply occur-target property to inserted (e.g. yanked) text.
1104 ;; Did we insert a newline? Occur Edit mode can't create new
1105 ;; Occur entries; just discard everything after the newline.
1119 line-beg 'occur-prefix nil
1120 line-end))
1132 \f
1134 "Handle `revert-buffer' for Occur mode buffers."
1143 pos))
1147 "Go to the occurrence on the current line."
1151 ;; Actually `event-end' works correctly with a nil argument as
1152 ;; well, so we could dispense with this test, but let's not
1153 ;; rely on this undocumented behavior.
1164 "Go to the occurrence the current line describes, in another window."
1172 "Display in another window the occurrence the current line describes."
1175 window)
1177 ;; This is the way to set point in the proper window.
1197 "Move to the Nth (default 1) next match in an Occur mode buffer."
1202 "Move to the Nth (default 1) previous match in an Occur mode buffer."
1207 "Move to the Nth (default 1) next match in an Occur mode buffer.
1210 ;; we need to run occur-find-match from within the Occur buffer
1212 ;; Choose the buffer and make it current.
1226 #'previous-single-property-change
1229 ;; In case the *Occur* buffer is visible in a nonselected window.
1233 \f
1246 "Face used to highlight matches permanently."
1251 "Default number of context lines included around `list-matching-lines' matches.
1252 A negative number means to include that many lines before the match.
1253 A positive number means to include that many lines both before and after."
1261 If the value is nil, don't highlight the matching portions specially."
1267 If the value is nil, don't highlight the buffer names specially."
1273 If the face doesn't differ from the default face,
1274 don't highlight the prefix with line numbers specially."
1281 yank-handler follow-link)
1282 "Text properties to discard when copying lines to the *Occur* buffer.
1283 The value should be a list of text properties to discard or t,
1284 which means to discard all text properties."
1292 "Collect strings matching regexp"
1297 ;; Perform collect operation
1299 ;; No subexpression so collect the entire match.
1301 ;; Get the regexp for collection pattern.
1306 ;; Otherwise normal occur takes numerical prefix argument.
1311 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1312 Here `original-buffer-name' is the buffer name where Occur was originally run.
1313 When given the prefix argument, or called non-interactively, the renaming
1314 will not clobber the existing buffer(s) of that name, but use
1315 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1316 if you always want a separate *Occur* buffer for each buffer where you
1317 invoke `occur'."
1328 "Show all lines in the current buffer containing a match for REGEXP.
1329 If a match spreads across multiple lines, all those lines are shown.
1331 Each line is displayed with NLINES lines before and after, or -NLINES
1332 before if NLINES is negative.
1333 NLINES defaults to `list-matching-lines-default-context-lines'.
1334 Interactively it is the prefix arg.
1336 The lines are shown in a buffer named `*Occur*'.
1337 It serves as a menu to find any of the occurrences in this buffer.
1341 and `search-upper-case' is non-nil, the matching is case-sensitive.
1343 When NLINES is a string or when the function is called
1344 interactively with prefix argument without a number (`C-u' alone
1345 as prefix) the matching strings are collected into the `*Occur*'
1346 buffer by using NLINES as a replacement regexp. NLINES may
1350 program. When there is no parenthesized subexpressions in REGEXP
1351 the entire match is collected. In any case the searched buffer
1352 is not modified."
1359 "Show all lines in buffers BUFS containing a match for REGEXP.
1360 This function acts on multiple buffers; otherwise, it is exactly like
1361 `occur'. When you invoke this command interactively, you must specify
1362 the buffer names that you want, one by one.
1363 See also `multi-occur-in-matching-buffers'."
1373 "Next buffer to search (C-j to end): "
1375 nil t))
1384 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1385 Normally BUFREGEXP matches against each buffer's visited file name,
1386 but if you specify a prefix argument, it matches against the buffer name.
1387 See also `multi-occur'."
1394 "List lines in buffers whose names match regexp: "
1397 default
1398 input))
1410 buf))
1421 bufs))))
1422 ;; Handle the case where one of the buffers we're searching is the
1423 ;; output buffer. Just rename it.
1428 ;; Now find or create the output buffer.
1429 ;; If we just renamed that buffer, we will make a new one here.
1437 ;; Don't generate undo entries for creation of the initial contents.
1442 ;; Treat nlines as a regexp to collect.
1450 ;; Insert the replacement regexp.
1459 count)
1460 ;; Perform normal occur.
1462 regexp active-bufs occur-buf
1466 case-fold-search)
1467 list-matching-lines-buffer-name-face
1469 list-matching-lines-prefix-face)
1470 list-matching-lines-face
1479 ;; Don't display regexp if with remaining text
1480 ;; it is longer than window-width.
1493 title-face prefix-face match-face keep-props)
1499 ;; Map over all the buffers
1518 ;; Set CODING only if the current buffer locally
1519 ;; binds buffer-file-coding-system.
1529 ;; Get beginning of first match line and end of the last.
1535 ;; Sum line numbers up to the first match line.
1540 ;; Highlight the matches
1550 ;; Add `match-face' to faces copied from the buffer.
1553 match-face nil curstring))
1554 ;; Avoid infloop (Bug#7593).
1557 ;; Generate the string to insert for this match
1559 ;; Using 7 digits aligns tabs properly.
1565 ;; Allow insertion of text at
1566 ;; the end of the prefix (for
1567 ;; Occur Edit mode).
1568 front-sticky t rear-nonsticky t
1569 occur-target ,marker follow-link t
1572 ;; We don't put `mouse-face' on the newline,
1573 ;; because that loses. And don't put it
1574 ;; on context lines to reduce flicker.
1576 'occur-target marker
1577 'follow-link t
1578 'help-echo
1582 match-prefix
1583 ;; Add non-numeric prefix to all non-first lines
1584 ;; of multi-line matches.
1590 match-str)
1591 ;; Add marker at eol, but no mouse props.
1595 ;; The simple display style
1596 out-line
1597 ;; The complex multi-line display style.
1599 out-line nlines keep-props begpt endpt
1600 curr-line prev-line prev-after-lines
1601 prefix-face))
1602 ;; Set first elem of the returned list to `data',
1603 ;; and the second elem to `prev-after-lines'.
1606 ;; Actually insert the match display data
1612 ;; Sum line numbers between first and last match lines.
1614 ;; Add 1 for empty last match line since
1615 ;; count-lines returns 1 line less.
1617 ;; On to the next match...
1621 ;; Flush remaining context after-lines.
1625 prev-after-lines prefix-face)))))))
1632 end)
1636 ;; Don't display the same number of lines
1637 ;; and matches in case of 1 match per line.
1641 ;; Don't display regexp for multi-buffer.
1652 ;; Display total match count and regexp for multi-buffer.
1656 end)
1659 ;; Don't display the same number of lines
1660 ;; and matches in case of 1 match per line.
1670 ;; CODING is buffer-file-coding-system of the first buffer
1671 ;; that locally binds it. Let's use it also for the output
1672 ;; buffer.
1674 ;; Return the number of matches
1675 global-matches)))
1686 str)
1696 lines))
1703 result beg end moved)
1715 ;; Generate context display for occur.
1716 ;; OUT-LINE is the line where the match is.
1717 ;; NLINES and KEEP-PROPS are args to occur-engine.
1718 ;; CURR-LINE is line count of the current match,
1719 ;; PREV-LINE is line count of the previous match,
1720 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1721 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1722 ;; then concatenate them all together.
1724 curr-line prev-line prev-after-lines
1726 ;; Find after- and before-context lines of the current match.
1733 separator)
1735 ;; Combine after-lines of the previous match
1736 ;; with before-lines of the current match.
1739 ;; Don't overlap prev after-lines with current before-lines.
1746 ;; Separate non-overlapping context lines with a dashed line.
1750 ;; Don't overlap current before-lines with previous match line.
1752 prev-line)
1756 before-lines))
1757 ;; Separate non-overlapping before-context lines.
1762 ;; Return a list where the first element is the output line.
1770 separator)))
1773 ;; And the second element is the list of context after-lines.
1776 \f
1777 ;; It would be nice to use \\[...], but there is no reasonable way
1778 ;; to make that display both SPC and Y.
1780 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1781 RET or `q' to exit, Period to replace one match and exit,
1782 Comma to replace but not move point immediately,
1784 C-w to delete match and recursive edit,
1785 C-l to clear the screen, redisplay, and offer same replacement again,
1786 ! to replace all remaining matches in this buffer with no more questions,
1787 ^ to move point back to previous match,
1788 E to edit the replacement string.
1789 In multi-buffer replacements type `Y' to replace all remaining
1790 matches in all remaining buffers with no more questions,
1791 `N' to skip to the next buffer without replacing remaining matches
1792 in the current buffer."
1800 (define-key map [backspace] 'skip)
1801 (define-key map "y" 'act)
1802 (define-key map "n" 'skip)
1803 (define-key map "Y" 'act)
1804 (define-key map "N" 'skip)
1805 (define-key map "e" 'edit-replacement)
1806 (define-key map "E" 'edit-replacement)
1807 (define-key map "," 'act-and-show)
1808 (define-key map "q" 'exit)
1810 (define-key map [return] 'exit)
1811 (define-key map "." 'act-and-exit)
1812 (define-key map "\C-r" 'edit)
1813 (define-key map "\C-w" 'delete-and-edit)
1814 (define-key map "\C-l" 'recenter)
1815 (define-key map "!" 'automatic)
1816 (define-key map "^" 'backup)
1817 (define-key map "\C-h" 'help)
1818 (define-key map [f1] 'help)
1819 (define-key map [help] 'help)
1820 (define-key map "?" 'help)
1821 (define-key map "\C-g" 'quit)
1822 (define-key map "\C-]" 'quit)
1823 (define-key map "\C-v" 'scroll-up)
1824 (define-key map "\M-v" 'scroll-down)
1825 (define-key map [next] 'scroll-up)
1826 (define-key map [prior] 'scroll-down)
1827 (define-key map [?\C-\M-v] 'scroll-other-window)
1828 (define-key map [M-next] 'scroll-other-window)
1829 (define-key map [?\C-\M-\S-v] 'scroll-other-window-down)
1830 (define-key map [M-prior] 'scroll-other-window-down)
1831 ;; Binding ESC would prohibit the M-v binding. Instead, callers
1832 ;; should check for ESC specially.
1833 ;; (define-key map "\e" 'exit-prefix)
1834 (define-key map [escape] 'exit-prefix)
1835 map)
1836 "Keymap of responses to questions posed by commands like `query-replace'.
1838 The valid answers include `act', `skip', `act-and-show',
1839 `act-and-exit', `exit', `exit-prefix', `recenter', `scroll-up',
1840 `scroll-down', `scroll-other-window', `scroll-other-window-down',
1841 `edit', `edit-replacement', `delete-and-edit', `automatic',
1842 `backup', `quit', and `help'.
1844 This keymap is used by `y-or-n-p' as well as `query-replace'.")
1846 (defvar multi-query-replace-map
1847 (let ((map (make-sparse-keymap)))
1848 (set-keymap-parent map query-replace-map)
1849 (define-key map "Y" 'automatic-all)
1850 (define-key map "N" 'exit-current)
1851 map)
1852 "Keymap that defines additional bindings for multi-buffer replacements.
1853 It extends its parent map `query-replace-map' with new bindings to
1854 operate on a set of buffers/files. The difference with its parent map
1855 is the additional answers `automatic-all' to replace all remaining
1856 matches in all remaining buffers with no more questions, and
1857 `exit-current' to skip remaining matches in the current buffer
1858 and to continue with the next buffer in the sequence.")
1860 (defun replace-match-string-symbols (n)
1861 "Process a list (and any sub-lists), expanding certain symbols.
1862 Symbol Expands To
1863 N (match-string N) (where N is a string of digits)
1864 #N (string-to-number (match-string N))
1865 & (match-string 0)
1866 #& (string-to-number (match-string 0))
1867 # replace-count
1869 Note that these symbols must be preceded by a backslash in order to
1870 type them using Lisp syntax."
1871 (while (consp n)
1872 (cond
1873 ((consp (car n))
1874 (replace-match-string-symbols (car n))) ;Process sub-list
1875 ((symbolp (car n))
1876 (let ((name (symbol-name (car n))))
1877 (cond
1878 ((string-match "^[0-9]+$" name)
1879 (setcar n (list 'match-string (string-to-number name))))
1880 ((string-match "^#[0-9]+$" name)
1881 (setcar n (list 'string-to-number
1882 (list 'match-string
1883 (string-to-number (substring name 1))))))
1884 ((string= "&" name)
1885 (setcar n '(match-string 0)))
1886 ((string= "#&" name)
1887 (setcar n '(string-to-number (match-string 0))))
1888 ((string= "#" name)
1889 (setcar n 'replace-count))))))
1890 (setq n (cdr n))))
1892 (defun replace-eval-replacement (expression count)
1893 (let* ((replace-count count)
1894 err
1895 (replacement
1896 (condition-case err
1897 (eval expression)
1898 (error
1899 (error "Error evaluating replacement expression: %S" err)))))
1900 (if (stringp replacement)
1901 replacement
1902 (prin1-to-string replacement t))))
1904 (defun replace-quote (replacement)
1905 "Quote a replacement string.
1906 This just doubles all backslashes in REPLACEMENT and
1907 returns the resulting string. If REPLACEMENT is not
1908 a string, it is first passed through `prin1-to-string'
1909 with the `noescape' argument set.
1911 `match-data' is preserved across the call."
1912 (save-match-data
1914 (if (stringp replacement)
1915 replacement
1916 (prin1-to-string replacement t))
1917 t t)))
1919 (defun replace-loop-through-replacements (data count)
1920 ;; DATA is a vector containing the following values:
1921 ;; 0 next-rotate-count
1922 ;; 1 repeat-count
1923 ;; 2 next-replacement
1924 ;; 3 replacements
1925 (if (= (aref data 0) count)
1926 (progn
1927 (aset data 0 (+ count (aref data 1)))
1928 (let ((next (cdr (aref data 2))))
1929 (aset data 2 (if (consp next) next (aref data 3))))))
1930 (car (aref data 2)))
1932 (defun replace-match-data (integers reuse &optional new)
1933 "Like `match-data', but markers in REUSE get invalidated.
1934 If NEW is non-nil, it is set and returned instead of fresh data,
1935 but coerced to the correct value of INTEGERS."
1936 (or (and new
1937 (progn
1938 (set-match-data new)
1939 (and (eq new reuse)
1940 (eq (null integers) (markerp (car reuse)))
1941 new)))
1942 (match-data integers reuse t)))
1944 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data backward)
1946 FIXEDCASE, LITERAL are passed to `replace-match' (which see).
1949 is made (to save time). MATCH-DATA is used for the replacement.
1950 In case editing is done, it is changed to use markers.
1953 passed in. If LITERAL is set, no checking is done, anyway."
1954 (unless (or literal noedit)
1955 (setq noedit t)
1957 newtext)
1958 (setq newtext
1959 (read-string "Edit replacement string: "
1960 (prog1
1961 (cons
1962 (replace-match "" t t newtext 3)
1963 (1+ (match-beginning 3)))
1964 (setq match-data
1965 (replace-match-data
1966 nil match-data match-data))))
1967 noedit nil)))
1968 (set-match-data match-data)
1969 (replace-match newtext fixedcase literal)
1970 ;; `replace-match' leaves point at the end of the replacement text,
1971 ;; so move point to the beginning when replacing backward.
1972 (when backward (goto-char (nth 0 match-data)))
1973 noedit)
1975 (defvar replace-search-function nil
1976 "Function to use when searching for strings to replace.
1977 It is used by `query-replace' and `replace-string', and is called
1978 with three arguments, as if it were `search-forward'.")
1980 (defvar replace-re-search-function nil
1981 "Function to use when searching for regexps to replace.
1982 It is used by `query-replace-regexp', `replace-regexp',
1983 `query-replace-regexp-eval', and `map-query-replace-regexp'.
1984 It is called with three arguments, as if it were
1985 `re-search-forward'.")
1987 (defun replace-search (search-string limit regexp-flag delimited-flag
1988 case-fold-search backward)
1989 "Search for the next occurrence of SEARCH-STRING to replace."
1990 ;; Let-bind global isearch-* variables to values used
1991 ;; to search the next replacement. These let-bindings
1992 ;; should be effective both at the time of calling
1993 ;; `isearch-search-fun-default' and also at the
1994 ;; time of funcalling `search-function'.
1995 ;; These isearch-* bindings can't be placed higher
1996 ;; outside of this function because then another I-search
1997 ;; used after `recursive-edit' might override them.
1998 (let* ((isearch-regexp regexp-flag)
1999 (isearch-word delimited-flag)
2000 (isearch-lax-whitespace
2001 replace-lax-whitespace)
2002 (isearch-regexp-lax-whitespace
2003 replace-regexp-lax-whitespace)
2004 (isearch-case-fold-search case-fold-search)
2005 (isearch-adjusted nil)
2006 (isearch-nonincremental t) ; don't use lax word mode
2007 (isearch-forward (not backward))
2008 (search-function
2009 (or (if regexp-flag
2010 replace-re-search-function
2011 replace-search-function)
2012 (isearch-search-fun-default))))
2013 (funcall search-function search-string limit t)))
2015 (defvar replace-overlay nil)
2017 (defun replace-highlight (match-beg match-end range-beg range-end
2018 search-string regexp-flag delimited-flag
2019 case-fold-search backward)
2020 (if query-replace-highlight
2021 (if replace-overlay
2022 (move-overlay replace-overlay match-beg match-end (current-buffer))
2023 (setq replace-overlay (make-overlay match-beg match-end))
2024 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
2025 (overlay-put replace-overlay 'face 'query-replace)))
2026 (if query-replace-lazy-highlight
2027 (let ((isearch-string search-string)
2028 (isearch-regexp regexp-flag)
2029 (isearch-word delimited-flag)
2030 (isearch-lax-whitespace
2031 replace-lax-whitespace)
2032 (isearch-regexp-lax-whitespace
2033 replace-regexp-lax-whitespace)
2034 (isearch-case-fold-search case-fold-search)
2035 (isearch-forward (not backward))
2036 (isearch-other-end match-beg)
2037 (isearch-error nil))
2038 (isearch-lazy-highlight-new-loop range-beg range-end))))
2040 (defun replace-dehighlight ()
2041 (when replace-overlay
2042 (delete-overlay replace-overlay))
2043 (when query-replace-lazy-highlight
2044 (lazy-highlight-cleanup lazy-highlight-cleanup)
2045 (setq isearch-lazy-highlight-last-string nil))
2046 ;; Close overlays opened by `isearch-range-invisible' in `perform-replace'.
2047 (isearch-clean-overlays))
2049 (defun perform-replace (from-string replacements
2050 query-flag regexp-flag delimited-flag
2051 &optional repeat-count map start end backward)
2052 "Subroutine of `query-replace'. Its complexity handles interactive queries.
2053 Don't use this in your own program unless you want to query and set the mark
2054 just as `query-replace' does. Instead, write a simple loop like this:
2059 which will run faster and probably do exactly what you want. Please
2060 see the documentation of `replace-match' to find out how to simulate
2061 `case-replace'.
2063 This function returns nil if and only if there were no matches to
2064 make, or the user didn't cancel the call."
2065 (or map (setq map query-replace-map))
2066 (and query-flag minibuffer-auto-raise
2067 (raise-frame (window-frame (minibuffer-window))))
2068 (let* ((case-fold-search
2069 (if (and case-fold-search search-upper-case)
2070 (isearch-no-upper-case-p from-string regexp-flag)
2071 case-fold-search))
2072 (nocasify (not (and case-replace case-fold-search)))
2073 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
2074 (search-string from-string)
2075 (real-match-data nil) ; The match data for the current match.
2076 (next-replacement nil)
2077 ;; This is non-nil if we know there is nothing for the user
2078 ;; to edit in the replacement.
2079 (noedit nil)
2080 (keep-going t)
2081 (stack nil)
2082 (replace-count 0)
2083 (skip-read-only-count 0)
2084 (skip-filtered-count 0)
2085 (skip-invisible-count 0)
2086 (nonempty-match nil)
2087 (multi-buffer nil)
2088 (recenter-last-op nil) ; Start cycling order with initial position.
2090 ;; If non-nil, it is marker saying where in the buffer to stop.
2091 (limit nil)
2093 ;; Data for the next match. If a cons, it has the same format as
2094 ;; (match-data); otherwise it is t if a match is possible at point.
2095 (match-again t)
2097 (message
2098 (if query-flag
2099 (apply 'propertize
2100 (substitute-command-keys
2102 minibuffer-prompt-properties))))
2104 ;; If region is active, in Transient Mark mode, operate on region.
2105 (if backward
2106 (when end
2107 (setq limit (copy-marker (min start end)))
2108 (goto-char (max start end))
2109 (deactivate-mark))
2110 (when start
2111 (setq limit (copy-marker (max start end)))
2112 (goto-char (min start end))
2113 (deactivate-mark)))
2115 ;; If last typed key in previous call of multi-buffer perform-replace
2116 ;; was `automatic-all', don't ask more questions in next files
2117 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
2118 (setq query-flag nil multi-buffer t))
2120 ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
2121 ;; containing a function and its first argument. The function is
2122 ;; called to generate each replacement like this:
2123 ;; (funcall (car replacements) (cdr replacements) replace-count)
2124 ;; It must return a string.
2125 (cond
2126 ((stringp replacements)
2127 (setq next-replacement replacements
2128 replacements nil))
2129 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
2130 (or repeat-count (setq repeat-count 1))
2131 (setq replacements (cons 'replace-loop-through-replacements
2132 (vector repeat-count repeat-count
2133 replacements replacements)))))
2135 (when query-replace-lazy-highlight
2136 (setq isearch-lazy-highlight-last-string nil))
2138 (push-mark)
2139 (undo-boundary)
2140 (unwind-protect
2141 ;; Loop finding occurrences that perhaps should be replaced.
2142 (while (and keep-going
2143 (if backward
2144 (not (or (bobp) (and limit (<= (point) limit))))
2145 (not (or (eobp) (and limit (>= (point) limit)))))
2146 ;; Use the next match if it is already known;
2147 ;; otherwise, search for a match after moving forward
2148 ;; one char if progress is required.
2149 (setq real-match-data
2150 (cond ((consp match-again)
2151 (goto-char (if backward
2152 (nth 0 match-again)
2153 (nth 1 match-again)))
2154 (replace-match-data
2155 t real-match-data match-again))
2156 ;; MATCH-AGAIN non-nil means accept an
2157 ;; adjacent match.
2158 (match-again
2159 (and
2160 (replace-search search-string limit
2161 regexp-flag delimited-flag
2162 case-fold-search backward)
2163 ;; For speed, use only integers and
2164 ;; reuse the list used last time.
2165 (replace-match-data t real-match-data)))
2166 ((and (if backward
2167 (> (1- (point)) (point-min))
2168 (< (1+ (point)) (point-max)))
2169 (or (null limit)
2170 (if backward
2171 (> (1- (point)) limit)
2172 (< (1+ (point)) limit))))
2173 ;; If not accepting adjacent matches,
2174 ;; move one char to the right before
2175 ;; searching again. Undo the motion
2176 ;; if the search fails.
2177 (let ((opoint (point)))
2178 (forward-char (if backward -1 1))
2179 (if (replace-search search-string limit
2180 regexp-flag delimited-flag
2181 case-fold-search backward)
2182 (replace-match-data
2183 t real-match-data)
2184 (goto-char opoint)
2185 nil))))))
2187 ;; Record whether the match is nonempty, to avoid an infinite loop
2188 ;; repeatedly matching the same empty string.
2189 (setq nonempty-match
2190 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
2192 ;; If the match is empty, record that the next one can't be
2193 ;; adjacent.
2195 ;; Otherwise, if matching a regular expression, do the next
2196 ;; match now, since the replacement for this match may
2197 ;; affect whether the next match is adjacent to this one.
2198 ;; If that match is empty, don't use it.
2199 (setq match-again
2200 (and nonempty-match
2201 (or (not regexp-flag)
2202 (and (if backward
2203 (looking-back search-string)
2204 (looking-at search-string))
2205 (let ((match (match-data)))
2206 (and (/= (nth 0 match) (nth 1 match))
2207 match))))))
2209 (cond
2210 ;; Optionally ignore matches that have a read-only property.
2211 ((not (or (not query-replace-skip-read-only)
2212 (not (text-property-not-all
2213 (nth 0 real-match-data) (nth 1 real-match-data)
2214 'read-only nil))))
2215 (setq skip-read-only-count (1+ skip-read-only-count)))
2216 ;; Optionally filter out matches.
2217 ((not (funcall isearch-filter-predicate
2218 (nth 0 real-match-data) (nth 1 real-match-data)))
2219 (setq skip-filtered-count (1+ skip-filtered-count)))
2220 ;; Optionally ignore invisible matches.
2221 ((not (or (eq search-invisible t)
2222 ;; Don't open overlays for automatic replacements.
2223 (and (not query-flag) search-invisible)
2224 ;; Open hidden overlays for interactive replacements.
2225 (not (isearch-range-invisible
2226 (nth 0 real-match-data) (nth 1 real-match-data)))))
2227 (setq skip-invisible-count (1+ skip-invisible-count)))
2228 (t
2229 ;; Calculate the replacement string, if necessary.
2230 (when replacements
2231 (set-match-data real-match-data)
2232 (setq next-replacement
2233 (funcall (car replacements) (cdr replacements)
2234 replace-count)))
2235 (if (not query-flag)
2236 (progn
2237 (unless (or literal noedit)
2238 (replace-highlight
2239 (nth 0 real-match-data) (nth 1 real-match-data)
2240 start end search-string
2241 regexp-flag delimited-flag case-fold-search backward))
2242 (setq noedit
2243 (replace-match-maybe-edit
2244 next-replacement nocasify literal
2245 noedit real-match-data backward)
2246 replace-count (1+ replace-count)))
2247 (undo-boundary)
2248 (let (done replaced key def)
2249 ;; Loop reading commands until one of them sets done,
2250 ;; which means it has finished handling this
2251 ;; occurrence. Any command that sets `done' should
2252 ;; leave behind proper match data for the stack.
2253 ;; Commands not setting `done' need to adjust
2254 ;; `real-match-data'.
2255 (while (not done)
2256 (set-match-data real-match-data)
2257 (replace-highlight
2258 (match-beginning 0) (match-end 0)
2259 start end search-string
2260 regexp-flag delimited-flag case-fold-search backward)
2261 ;; Bind message-log-max so we don't fill up the message log
2262 ;; with a bunch of identical messages.
2263 (let ((message-log-max nil)
2264 (replacement-presentation
2265 (if query-replace-show-replacement
2266 (save-match-data
2267 (set-match-data real-match-data)
2268 (match-substitute-replacement next-replacement
2269 nocasify literal))
2270 next-replacement)))
2271 (message message
2272 (query-replace-descr from-string)
2273 (query-replace-descr replacement-presentation)))
2274 (setq key (read-event))
2275 ;; Necessary in case something happens during read-event
2276 ;; that clobbers the match data.
2277 (set-match-data real-match-data)
2278 (setq key (vector key))
2279 (setq def (lookup-key map key))
2280 ;; Restore the match data while we process the command.
2281 (cond ((eq def 'help)
2282 (with-output-to-temp-buffer "*Help*"
2283 (princ
2284 (concat "Query replacing "
2285 (if delimited-flag
2286 (or (and (symbolp delimited-flag)
2287 (get delimited-flag 'isearch-message-prefix))
2288 "word ") "")
2289 (if regexp-flag "regexp " "")
2290 (if backward "backward " "")
2291 from-string " with "
2293 (substitute-command-keys
2294 query-replace-help)))
2295 (with-current-buffer standard-output
2296 (help-mode))))
2297 ((eq def 'exit)
2298 (setq keep-going nil)
2299 (setq done t))
2300 ((eq def 'exit-current)
2301 (setq multi-buffer t keep-going nil done t))
2302 ((eq def 'backup)
2303 (if stack
2304 (let ((elt (pop stack)))
2305 (goto-char (nth 0 elt))
2306 (setq replaced (nth 1 elt)
2307 real-match-data
2308 (replace-match-data
2309 t real-match-data
2310 (nth 2 elt))))
2311 (message "No previous match")
2312 (ding 'no-terminate)
2313 (sit-for 1)))
2314 ((eq def 'act)
2315 (or replaced
2316 (setq noedit
2317 (replace-match-maybe-edit
2318 next-replacement nocasify literal
2319 noedit real-match-data backward)
2320 replace-count (1+ replace-count)))
2321 (setq done t replaced t))
2322 ((eq def 'act-and-exit)
2323 (or replaced
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 (setq keep-going nil)
2330 (setq done t replaced t))
2331 ((eq def 'act-and-show)
2332 (if (not replaced)
2333 (setq noedit
2334 (replace-match-maybe-edit
2335 next-replacement nocasify literal
2336 noedit real-match-data backward)
2337 replace-count (1+ replace-count)
2338 real-match-data (replace-match-data
2339 t real-match-data)
2340 replaced t)))
2341 ((or (eq def 'automatic) (eq def 'automatic-all))
2342 (or replaced
2343 (setq noedit
2344 (replace-match-maybe-edit
2345 next-replacement nocasify literal
2346 noedit real-match-data backward)
2347 replace-count (1+ replace-count)))
2348 (setq done t query-flag nil replaced t)
2349 (if (eq def 'automatic-all) (setq multi-buffer t)))
2350 ((eq def 'skip)
2351 (setq done t))
2352 ((eq def 'recenter)
2353 ;; `this-command' has the value `query-replace',
2354 ;; so we need to bind it to `recenter-top-bottom'
2355 ;; to allow it to detect a sequence of `C-l'.
2356 (let ((this-command 'recenter-top-bottom)
2357 (last-command 'recenter-top-bottom))
2358 (recenter-top-bottom)))
2359 ((eq def 'edit)
2360 (let ((opos (point-marker)))
2361 (setq real-match-data (replace-match-data
2362 nil real-match-data
2363 real-match-data))
2364 (goto-char (match-beginning 0))
2365 (save-excursion
2366 (save-window-excursion
2367 (recursive-edit)))
2368 (goto-char opos)
2369 (set-marker opos nil))
2370 ;; Before we make the replacement,
2371 ;; decide whether the search string
2372 ;; can match again just after this match.
2373 (if (and regexp-flag nonempty-match)
2374 (setq match-again (and (looking-at search-string)
2375 (match-data)))))
2376 ;; Edit replacement.
2377 ((eq def 'edit-replacement)
2378 (setq real-match-data (replace-match-data
2379 nil real-match-data
2380 real-match-data)
2381 next-replacement
2382 (read-string "Edit replacement string: "
2383 next-replacement)
2384 noedit nil)
2385 (if replaced
2386 (set-match-data real-match-data)
2387 (setq noedit
2388 (replace-match-maybe-edit
2389 next-replacement nocasify literal noedit
2390 real-match-data backward)
2391 replaced t))
2392 (setq done t))
2394 ((eq def 'delete-and-edit)
2395 (replace-match "" t t)
2396 (setq real-match-data (replace-match-data
2397 nil real-match-data))
2398 (replace-dehighlight)
2399 (save-excursion (recursive-edit))
2400 (setq replaced t))
2401 ;; Note: we do not need to treat `exit-prefix'
2402 ;; specially here, since we reread
2403 ;; any unrecognized character.
2404 (t
2405 (setq this-command 'mode-exited)
2406 (setq keep-going nil)
2407 (setq unread-command-events
2408 (append (listify-key-sequence key)
2409 unread-command-events))
2410 (setq done t)))
2411 (when query-replace-lazy-highlight
2412 ;; Force lazy rehighlighting only after replacements.
2413 (if (not (memq def '(skip backup)))
2414 (setq isearch-lazy-highlight-last-string nil)))
2415 (unless (eq def 'recenter)
2416 ;; Reset recenter cycling order to initial position.
2417 (setq recenter-last-op nil)))
2418 ;; Record previous position for ^ when we move on.
2419 ;; Change markers to numbers in the match data
2420 ;; since lots of markers slow down editing.
2421 (push (list (point) replaced
2422 ;;; If the replacement has already happened, all we need is the
2423 ;;; current match start and end. We could get this with a trivial
2424 ;;; match like
2425 ;;; (save-excursion (goto-char (match-beginning 0))
2426 ;;; (search-forward (match-string 0))
2427 ;;; (match-data t))
2428 ;;; if we really wanted to avoid manually constructing match data.
2429 ;;; Adding current-buffer is necessary so that match-data calls can
2430 ;;; return markers which are appropriate for editing.
2431 (if replaced
2432 (list
2433 (match-beginning 0)
2434 (match-end 0)
2435 (current-buffer))
2436 (match-data t)))
2437 stack))))))
2439 (replace-dehighlight))
2440 (or unread-command-events
2441 (message "Replaced %d occurrence%s%s"
2442 replace-count
2443 (if (= replace-count 1) "" "s")
2444 (if (> (+ skip-read-only-count
2445 skip-filtered-count
2446 skip-invisible-count) 0)
2447 (format " (skipped %s)"
2448 (mapconcat
2449 'identity
2450 (delq nil (list
2451 (if (> skip-read-only-count 0)
2452 (format "%s read-only"
2453 skip-read-only-count))
2454 (if (> skip-invisible-count 0)
2455 (format "%s invisible"
2456 skip-invisible-count))
2457 (if (> skip-filtered-count 0)
2458 (format "%s filtered out"
2459 skip-filtered-count))))
2460 ", "))
2461 "")))
2462 (or (and keep-going stack) multi-buffer)))
2464 ;;; replace.el ends here