| blob | f5c8d33b5f56ab990adde2266c409a956aa6903e |
1 ;;; replace.el --- replace commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2016 Free
4 ;; Software Foundation, Inc.
6 ;; Maintainer: emacs-devel@gnu.org
7 ;; Package: emacs
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; This package supplies the string and regular-expression replace functions
27 ;; documented in the Emacs user's manual.
29 ;;; Code:
32 "Non-nil means `query-replace' should preserve case in replacements."
37 "Non-nil means replacement commands should do character folding in matches.
39 unicode quotes.
40 This variable affects `query-replace' and `replace-string', but not
41 `replace-regexp'."
47 "Non-nil means `query-replace' matches a sequence of whitespace chars.
48 When you enter a space or spaces in the strings to be replaced,
49 it will match any sequence matched by the regexp `search-whitespace-regexp'."
55 "Non-nil means `query-replace-regexp' matches a sequence of whitespace chars.
56 When you enter a space or spaces in the regexps to be replaced,
57 it will match any sequence matched by the regexp `search-whitespace-regexp'."
63 "Default history list for query-replace commands.
64 See `query-replace-from-history-variable' and
68 "Default values of FROM-STRING and TO-STRING for `query-replace'.
69 This is a list of cons cells (FROM-STRING . TO-STRING), or nil
73 "Non-nil means `query-replace' uses the last search string.
76 "use `M-n' to pull the last incremental search string
77 to the minibuffer that reads the string to replace, or invoke replacements
83 "String that separates FROM and TO in the history of replacement pairs."
84 ;; Avoids error when attempt to autoload char-displayable-p fails
85 ;; while preparing to dump, also stops customize-rogue listing this.
92 "History list to use for the FROM argument of `query-replace' commands.
93 The value of this variable should be a symbol; that symbol
94 is used as a variable to hold a history list for the strings
95 or patterns to be replaced."
101 "History list to use for the TO argument of `query-replace' commands.
102 The value of this variable should be a symbol; that symbol
103 is used as a variable to hold a history list for replacement
104 strings or patterns."
110 "Non-nil means `query-replace' and friends ignore read-only matches."
116 "Non-nil means show substituted replacement text in the minibuffer.
117 This variable affects only `query-replace-regexp'."
123 "Non-nil means to highlight matches during query replacement."
128 "Controls the lazy-highlighting during query replacements.
129 When non-nil, all text in the buffer matching the current match
130 is highlighted lazily using isearch lazy highlighting (see
131 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
139 "Face for highlighting query replacement matches."
144 "Number of replacements done so far.
151 "Split string STRING at a character with property `separator'"
161 "Query and return the `from' argument of a query-replace operation.
162 The return value can also be a pair (FROM . TO) indicating that the user
163 wants to replace FROM with TO."
166 ;; Reevaluating will check char-displayable-p that is
167 ;; unavailable while preparing to dump.
175 'display query-replace-from-to-separator
182 separator
184 query-replace-defaults))
192 ;; The save-excursion here is in case the user marks and copies
193 ;; a region in order to specify the minibuffer input.
194 ;; That should not clobber the region for the query-replace itself.
199 prompt nil nil nil 'query-replace-from-to-history
209 ;; Warn if user types \n or \t, but don't reject the input.
220 from
226 "Maybe convert a regexp replacement TO to Lisp.
227 Returns a list suitable for `perform-replace' if necessary,
228 the original string if not."
244 ;; Swallow a space after a symbol
245 ;; if there is a space.
247 ;; Swallow a space after 'foo
248 ;; but not after (quote foo).
263 to))
267 "Query and return the `to' argument of a query-replace operation."
273 nil nil nil
274 query-replace-to-history-variable from t)))
277 to))
278 regexp-flag))
290 (defun query-replace (from-string to-string &optional delimited start end backward region-noncontiguous-p)
291 "Replace some occurrences of FROM-STRING with TO-STRING.
292 As each match is found, the user must type a character saying
295 In Transient Mark mode, if the mark is active, operate on the contents
296 of the region. Otherwise, operate from point to the end of the buffer.
299 to pull the last incremental search string to the minibuffer
300 that reads FROM-STRING, or invoke replacements from
301 incremental search with a key sequence like `C-s C-s M-%'
302 to use its current search string as the string to replace.
304 Matching is independent of case if `case-fold-search' is non-nil and
305 FROM-STRING has no uppercase letters. Replacement transfers the case
306 pattern of the old text to the new text, if `case-replace' and
307 `case-fold-search' are non-nil and FROM-STRING has no uppercase
308 letters. (Transferring the case pattern means that if the old text
309 matched is all caps, or capitalized, then its replacement is upcased
310 or capitalized.)
312 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
313 ignore hidden matches if `search-invisible' is nil, and ignore more
314 matches using `isearch-filter-predicate'.
316 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
317 to be replaced will match a sequence of whitespace chars defined by the
318 regexp in `search-whitespace-regexp'.
320 If `replace-character-fold' is non-nil, matching uses character folding,
321 i.e. it ignores diacritics and other differences between equivalent
322 character strings.
324 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
325 only matches surrounded by word boundaries. A negative prefix arg means
326 replace backward.
328 Fourth and fifth arg START and END specify the region to operate on.
330 To customize possible responses, change the bindings in `query-replace-map'."
339 nil)))
341 ;; These are done separately here
342 ;; so that command-history will record these expressions
343 ;; rather than the values they had this time.
348 (perform-replace from-string to-string t nil delimited nil nil start end backward region-noncontiguous-p))
352 (defun query-replace-regexp (regexp to-string &optional delimited start end backward region-noncontiguous-p)
353 "Replace some things after point matching REGEXP with TO-STRING.
354 As each match is found, the user must type a character saying
357 In Transient Mark mode, if the mark is active, operate on the contents
358 of the region. Otherwise, operate from point to the end of the buffer.
361 to pull the last incremental search regexp to the minibuffer
362 that reads REGEXP, or invoke replacements from
363 incremental search with a key sequence like `C-M-s C-M-s C-M-%'
364 to use its current search regexp as the regexp to replace.
366 Matching is independent of case if `case-fold-search' is non-nil and
367 REGEXP has no uppercase letters. Replacement transfers the case
368 pattern of the old text to the new text, if `case-replace' and
369 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
370 \(Transferring the case pattern means that if the old text matched is
371 all caps, or capitalized, then its replacement is upcased or
372 capitalized.)
374 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
375 ignore hidden matches if `search-invisible' is nil, and ignore more
376 matches using `isearch-filter-predicate'.
378 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
379 to be replaced will match a sequence of whitespace chars defined by the
380 regexp in `search-whitespace-regexp'.
382 This function is not affected by `replace-character-fold'.
384 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
385 only matches surrounded by word boundaries. A negative prefix arg means
386 replace backward.
388 Fourth and fifth arg START and END specify the region to operate on.
394 at the given position for each replacement.
397 followed by a Lisp expression. Each
398 replacement evaluates that expression to compute the replacement
401 for the whole or a partial match converted to a number with
403 done so far (starting with zero).
405 If the replacement expression is a symbol, write a space after it
406 to terminate it. One space there, if any, will be discarded.
408 When using those Lisp features interactively in the replacement
409 text, TO-STRING is actually made a list instead of a string.
418 " regexp"
420 t)))
422 ;; These are done separately here
423 ;; so that command-history will record these expressions
424 ;; rather than the values they had this time.
429 (perform-replace regexp to-string t t delimited nil nil start end backward region-noncontiguous-p))
434 "Replace some things after point matching REGEXP with the result of TO-EXPR.
436 Interactive use of this function is deprecated in favor of the
438 using `search-forward-regexp' and `replace-match' is preferred.
440 As each match is found, the user must type a character saying
443 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
444 reference `replace-count' to get the number of replacements already made.
445 If the result of TO-EXPR is not a string, it is converted to one using
446 `prin1-to-string' with the NOESCAPE argument (which see).
454 In Transient Mark mode, if the mark is active, operate on the contents
455 of the region. Otherwise, operate from point to the end of the buffer.
458 to pull the last incremental search regexp to the minibuffer
459 that reads REGEXP.
461 Preserves case in each replacement if `case-replace' and `case-fold-search'
462 are non-nil and REGEXP has no uppercase letters.
464 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
465 ignore hidden matches if `search-invisible' is nil, and ignore more
466 matches using `isearch-filter-predicate'.
468 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
469 to be replaced will match a sequence of whitespace chars defined by the
470 regexp in `search-whitespace-regexp'.
472 This function is not affected by `replace-character-fold'.
474 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
475 only matches that are surrounded by word boundaries.
476 Fourth and fifth arg START and END specify the region to operate on."
478 for interactive calls, and `search-forward-regexp'/`replace-match'
484 ;; Let-bind the history var to disable the "foo -> bar"
485 ;; default. Maybe we shouldn't disable this default, but
486 ;; for now I'll leave it off. --Stef
492 nil nil t query-replace-to-history-variable from t))))
493 ;; We make TO a list because replace-match-string-symbols requires one,
494 ;; and the user might enter a single token.
503 "Replace some matches for REGEXP with various strings, in rotation.
504 The second argument TO-STRINGS contains the replacement strings, separated
505 by spaces. This command works like `query-replace-regexp' except that
506 each successive replacement uses the next successive replacement string,
507 wrapping around from the last such string to the first.
509 In Transient Mark mode, if the mark is active, operate on the contents
510 of the region. Otherwise, operate from point to the end of the buffer.
512 Non-interactively, TO-STRINGS may be a list of replacement strings.
514 Interactively, reads the regexp using `read-regexp'.
516 to pull the last incremental search regexp to the minibuffer
517 that reads REGEXP.
519 A prefix argument N says to use each replacement string N times
520 before rotating to the next.
521 Fourth and fifth arg START and END specify the region to operate on."
524 query-replace-from-history-variable))
528 nil nil nil
529 query-replace-to-history-variable from t)))
551 "Replace occurrences of FROM-STRING with TO-STRING.
552 Preserve case in each match if `case-replace' and `case-fold-search'
553 are non-nil and FROM-STRING has no uppercase letters.
554 \(Preserving case means that if the string matched is all caps, or capitalized,
555 then its replacement is upcased or capitalized.)
557 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
558 ignore hidden matches if `search-invisible' is nil, and ignore more
559 matches using `isearch-filter-predicate'.
561 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
562 to be replaced will match a sequence of whitespace chars defined by the
563 regexp in `search-whitespace-regexp'.
565 If `replace-character-fold' is non-nil, matching uses character folding,
566 i.e. it ignores diacritics and other differences between equivalent
567 character strings.
569 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
570 only matches surrounded by word boundaries. A negative prefix arg means
571 replace backward.
573 Operates on the region between START and END (if both are nil, from point
574 to the end of the buffer). Interactively, if Transient Mark mode is
575 enabled and the mark is active, operates on the contents of the region;
576 otherwise from point to the end of the buffer.
579 to pull the last incremental search string to the minibuffer
580 that reads FROM-STRING.
582 This function is usually the wrong thing to use in a Lisp program.
583 What you probably want is a loop like this:
584 (while (search-forward FROM-STRING nil t)
585 (replace-match TO-STRING nil t))
586 which will run faster and will not set the mark or print anything.
587 \(You may need a more complex loop if FROM-STRING can match the null string
588 and TO-STRING is also null.)"
598 " string"
600 nil)))
608 "Replace things after point matching REGEXP with TO-STRING.
609 Preserve case in each match if `case-replace' and `case-fold-search'
610 are non-nil and REGEXP has no uppercase letters.
612 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
613 ignore hidden matches if `search-invisible' is nil, and ignore more
614 matches using `isearch-filter-predicate'.
616 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
617 to be replaced will match a sequence of whitespace chars defined by the
618 regexp in `search-whitespace-regexp'.
620 This function is not affected by `replace-character-fold'
622 In Transient Mark mode, if the mark is active, operate on the contents
623 of the region. Otherwise, operate from point to the end of the buffer.
625 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
626 only matches surrounded by word boundaries. A negative prefix arg means
627 replace backward.
629 Fourth and fifth arg START and END specify the region to operate on.
635 at the given position for each replacement.
638 followed by a Lisp expression used as part of the replacement
642 `replace-count', the number of replacements occurred so far.
644 If your Lisp expression is an identifier and the next letter in
645 the replacement string would be interpreted as part of it, you
648 replacement text directly.
650 When using those Lisp features interactively in the replacement
651 text, TO-STRING is actually made a list instead of a string.
655 to pull the last incremental search regexp to the minibuffer
656 that reads REGEXP.
658 This function is usually the wrong thing to use in a Lisp program.
659 What you probably want is a loop like this:
660 (while (re-search-forward REGEXP nil t)
661 (replace-match TO-STRING nil nil))
662 which will run faster and will not set the mark or print anything."
672 " regexp"
674 t)))
681 \f
683 "History list for some commands that read regular expressions.
685 Maximum length of the history list is determined by the value
692 "Function that provides default regexp(s) for `read-regexp'.
693 This function should take no arguments and return one of: nil, a
694 regexp, or a list of regexps. Interactively, `read-regexp' uses
695 the return value of this function for its DEFAULT argument.
697 As an example, set this variable to `find-tag-default-as-regexp'
698 to default to the symbol at point.
700 To provide different default regexps for different commands,
701 the function that you set this to can check `this-command'."
706 find-tag-default)
708 find-tag-default-as-regexp)
710 find-tag-default-as-symbol-regexp)
716 "Return a list of standard suggestions for `read-regexp'.
717 By default, the list includes the tag at point, the last isearch regexp,
718 the last isearch string, and the last replacement regexp. `read-regexp'
719 appends the list returned by this function to the end of values available
729 "Read and return a regular expression as a string.
732 possibly preceded by the default result (see below).
734 The optional argument DEFAULTS can be either: nil, a string, a list
735 of strings, or a symbol. We use DEFAULTS to construct the default
736 return value in case of empty input.
738 If DEFAULTS is a string, we use it as-is.
740 If DEFAULTS is a list of strings, the first element is the
741 default return value, but all the elements are accessible
744 If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
745 is non-nil, we use that in place of DEFAULTS in the following:
746 If DEFAULTS is the symbol `regexp-history-last', we use the first
747 element of HISTORY (if specified) or `regexp-history'.
748 If DEFAULTS is a function, we call it with no arguments and use
749 what it returns, which should be either nil, a string, or a list of strings.
751 We append the standard values from `read-regexp-suggestions' to DEFAULTS
752 before using it.
754 If the first element of DEFAULTS is non-nil (and if PROMPT does not end
757 The optional argument HISTORY is a symbol to use for the history list.
758 If nil, uses `regexp-history'."
767 defaults))
772 ;; Do not automatically add default to the history for empty input.
776 prompt)
784 ;; Return the default value when the user enters empty input.
788 ;; Otherwise, add non-empty input to the history and return input.
799 "Read arguments for `keep-lines' and friends.
800 Prompt for a regexp with PROMPT.
801 Value is a list, (REGEXP)."
805 "Delete all lines except those containing matches for REGEXP.
806 A match split across lines preserves all the lines it lies in.
807 When called from Lisp (and usually interactively as well, see below)
808 applies to all lines starting after point.
811 and `search-upper-case' is non-nil, the matching is case-sensitive.
813 Second and third arg RSTART and REND specify the region to operate on.
814 This command operates on (the accessible part of) all lines whose
815 accessible part is entirely contained in the region determined by RSTART
816 and REND. (A newline ending a line counts as part of that line.)
818 Interactively, in Transient Mark mode when the mark is active, operate
819 on all lines whose accessible part is entirely contained in the region.
820 Otherwise, the command applies to all lines starting after point.
821 When calling this function from Lisp, you can pretend that it was
822 called interactively by passing a non-nil INTERACTIVE argument.
824 This function starts looking for the next match from the end of
825 the previous match. Hence, it ignores matches that overlap
826 a previously found match."
858 case-fold-search)))
860 ;; Start is first char not preserved by previous match.
866 ;; Now end is first char preserved by the new match.
871 ;; If the match was empty, avoid matching again at same place.
876 nil)
880 "Delete lines containing matches for REGEXP.
881 When called from Lisp (and usually when called interactively as
882 well, see below), applies to the part of the buffer after point.
883 The line point is in is deleted if and only if it contains a
884 match for regexp starting after point.
887 and `search-upper-case' is non-nil, the matching is case-sensitive.
889 Second and third arg RSTART and REND specify the region to operate on.
890 Lines partially contained in this region are deleted if and only if
891 they contain a match entirely contained in it.
893 Interactively, in Transient Mark mode when the mark is active, operate
894 on the contents of the region. Otherwise, operate from point to the
895 end of (the accessible portion of) the buffer. When calling this function
896 from Lisp, you can pretend that it was called interactively by passing
897 a non-nil INTERACTIVE argument.
899 If a match is split across lines, all the lines it lies in are deleted.
900 They are deleted _before_ looking for the next match. Hence, a match
901 starting on the same line at which another match ended is ignored."
920 case-fold-search)))
929 nil)
933 "Print and return number of matches for REGEXP following point.
934 When called from Lisp and INTERACTIVE is omitted or nil, just return
935 the number, do not print it; if INTERACTIVE is t, the function behaves
936 in all respects as if it had been called interactively.
939 and `search-upper-case' is non-nil, the matching is case-sensitive.
941 Second and third arg RSTART and REND specify the region to operate on.
943 Interactively, in Transient Mark mode when the mark is active, operate
944 on the contents of the region. Otherwise, operate from point to the
945 end of (the accessible portion of) the buffer.
947 This function starts looking for the next match from the end of
948 the previous match. Hence, it ignores matches that overlap
949 a previously found match."
968 opoint
972 case-fold-search)))
980 count
982 count)))
984 \f
989 next-error-follow-minor-mode
992 next-error-follow-minor-mode))))
1028 map)
1033 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
1046 map)
1050 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
1056 "Hook run when entering Occur mode."
1061 "Hook run by Occur when there are any matches."
1066 "Hook run by Occur after locating an occurrence.
1067 This will be called with the cursor position at the occurrence. An application
1068 for this is to reveal context in an outline-mode when the occurrence is hidden."
1083 \f
1084 ;;; Occur Edit mode
1094 map)
1098 "Major mode for editing *Occur* buffers.
1099 In this mode, changes to the *Occur* buffer are also applied to
1100 the originating buffer.
1109 "Switch from Occur Edit mode to Occur mode."
1121 col)
1125 ;; Apply occur-target property to inserted (e.g. yanked) text.
1127 ;; Did we insert a newline? Occur Edit mode can't create new
1128 ;; Occur entries; just discard everything after the newline.
1142 line-beg 'occur-prefix nil
1143 line-end))
1155 \f
1157 "Handle `revert-buffer' for Occur mode buffers."
1166 pos))
1170 "Go to the occurrence on the current line."
1174 ;; Actually `event-end' works correctly with a nil argument as
1175 ;; well, so we could dispense with this test, but let's not
1176 ;; rely on this undocumented behavior.
1187 "Go to the occurrence the current line describes, in another window."
1195 "Display in another window the occurrence the current line describes."
1198 window)
1200 ;; This is the way to set point in the proper window.
1220 "Move to the Nth (default 1) next match in an Occur mode buffer."
1225 "Move to the Nth (default 1) previous match in an Occur mode buffer."
1230 "Move to the Nth (default 1) next match in an Occur mode buffer.
1233 ;; we need to run occur-find-match from within the Occur buffer
1235 ;; Choose the buffer and make it current.
1249 #'previous-single-property-change
1252 ;; In case the *Occur* buffer is visible in a nonselected window.
1256 \f
1269 "Face used to highlight matches permanently."
1274 "Default number of context lines included around `list-matching-lines' matches.
1275 A negative number means to include that many lines before the match.
1276 A positive number means to include that many lines both before and after."
1284 If the value is nil, don't highlight the matching portions specially."
1290 If the value is nil, don't highlight the buffer names specially."
1296 If the face doesn't differ from the default face,
1297 don't highlight the prefix with line numbers specially."
1304 yank-handler follow-link)
1305 "Text properties to discard when copying lines to the *Occur* buffer.
1306 The value should be a list of text properties to discard or t,
1307 which means to discard all text properties."
1315 "Collect strings matching regexp"
1320 ;; Perform collect operation
1322 ;; No subexpression so collect the entire match.
1324 ;; Get the regexp for collection pattern.
1329 ;; Otherwise normal occur takes numerical prefix argument.
1334 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1335 Here `original-buffer-name' is the buffer name where Occur was originally run.
1336 When given the prefix argument, or called non-interactively, the renaming
1337 will not clobber the existing buffer(s) of that name, but use
1338 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1339 if you always want a separate *Occur* buffer for each buffer where you
1340 invoke `occur'."
1351 "Show all lines in the current buffer containing a match for REGEXP.
1352 If a match spreads across multiple lines, all those lines are shown.
1354 Each line is displayed with NLINES lines before and after, or -NLINES
1355 before if NLINES is negative.
1356 NLINES defaults to `list-matching-lines-default-context-lines'.
1357 Interactively it is the prefix arg.
1359 The lines are shown in a buffer named `*Occur*'.
1360 It serves as a menu to find any of the occurrences in this buffer.
1364 and `search-upper-case' is non-nil, the matching is case-sensitive.
1366 When NLINES is a string or when the function is called
1367 interactively with prefix argument without a number (`C-u' alone
1368 as prefix) the matching strings are collected into the `*Occur*'
1369 buffer by using NLINES as a replacement regexp. NLINES may
1373 program. When there is no parenthesized subexpressions in REGEXP
1374 the entire match is collected. In any case the searched buffer
1375 is not modified."
1382 "Show all lines in buffers BUFS containing a match for REGEXP.
1383 This function acts on multiple buffers; otherwise, it is exactly like
1384 `occur'. When you invoke this command interactively, you must specify
1385 the buffer names that you want, one by one.
1386 See also `multi-occur-in-matching-buffers'."
1396 "Next buffer to search (C-j to end): "
1398 nil t))
1407 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1408 Normally BUFREGEXP matches against each buffer's visited file name,
1409 but if you specify a prefix argument, it matches against the buffer name.
1410 See also `multi-occur'."
1417 "List lines in buffers whose names match regexp: "
1420 default
1421 input))
1433 buf))
1455 bufs))))
1456 ;; Handle the case where one of the buffers we're searching is the
1457 ;; output buffer. Just rename it.
1462 ;; Now find or create the output buffer.
1463 ;; If we just renamed that buffer, we will make a new one here.
1471 ;; Don't generate undo entries for creation of the initial contents.
1476 ;; Treat nlines as a regexp to collect.
1484 ;; Insert the replacement regexp.
1493 count)
1494 ;; Perform normal occur.
1496 regexp active-bufs occur-buf
1500 case-fold-search)
1501 list-matching-lines-buffer-name-face
1503 list-matching-lines-prefix-face)
1504 list-matching-lines-face
1513 ;; Don't display regexp if with remaining text
1514 ;; it is longer than window-width.
1516 regexp))
1530 title-face prefix-face match-face keep-props)
1536 ;; Map over all the buffers
1555 ;; Set CODING only if the current buffer locally
1556 ;; binds buffer-file-coding-system.
1566 ;; Get beginning of first match line and end of the last.
1572 ;; Sum line numbers up to the first match line.
1577 ;; Highlight the matches
1580 ;; Count empty lines that don't use next loop (Bug#22062).
1590 ;; Add `match-face' to faces copied from the buffer.
1593 match-face nil curstring))
1594 ;; Avoid infloop (Bug#7593).
1597 ;; Generate the string to insert for this match
1599 ;; Using 7 digits aligns tabs properly.
1605 ;; Allow insertion of text at
1606 ;; the end of the prefix (for
1607 ;; Occur Edit mode).
1608 front-sticky t rear-nonsticky t
1609 occur-target ,marker follow-link t
1612 ;; We don't put `mouse-face' on the newline,
1613 ;; because that loses. And don't put it
1614 ;; on context lines to reduce flicker.
1616 'occur-target marker
1617 'follow-link t
1618 'help-echo
1622 match-prefix
1623 ;; Add non-numeric prefix to all non-first lines
1624 ;; of multi-line matches.
1630 match-str)
1631 ;; Add marker at eol, but no mouse props.
1635 ;; The simple display style
1636 out-line
1637 ;; The complex multi-line display style.
1639 out-line nlines keep-props begpt endpt
1640 curr-line prev-line prev-after-lines
1641 prefix-face))
1642 ;; Set first elem of the returned list to `data',
1643 ;; and the second elem to `prev-after-lines'.
1646 ;; Actually insert the match display data
1652 ;; Sum line numbers between first and last match lines.
1654 ;; Add 1 for empty last match line since
1655 ;; count-lines returns 1 line less.
1657 ;; On to the next match...
1661 ;; Flush remaining context after-lines.
1665 prev-after-lines prefix-face)))))))
1672 end)
1676 ;; Don't display the same number of lines
1677 ;; and matches in case of 1 match per line.
1681 ;; Don't display regexp for multi-buffer.
1691 ;; Display total match count and regexp for multi-buffer.
1695 end)
1698 ;; Don't display the same number of lines
1699 ;; and matches in case of 1 match per line.
1709 ;; CODING is buffer-file-coding-system of the first buffer
1710 ;; that locally binds it. Let's use it also for the output
1711 ;; buffer.
1713 ;; Return the number of matches
1714 global-matches)))
1725 str)
1735 lines))
1742 result beg end moved)
1754 ;; Generate context display for occur.
1755 ;; OUT-LINE is the line where the match is.
1756 ;; NLINES and KEEP-PROPS are args to occur-engine.
1757 ;; CURR-LINE is line count of the current match,
1758 ;; PREV-LINE is line count of the previous match,
1759 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1760 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1761 ;; then concatenate them all together.
1763 curr-line prev-line prev-after-lines
1765 ;; Find after- and before-context lines of the current match.
1772 separator)
1774 ;; Combine after-lines of the previous match
1775 ;; with before-lines of the current match.
1778 ;; Don't overlap prev after-lines with current before-lines.
1785 ;; Separate non-overlapping context lines with a dashed line.
1789 ;; Don't overlap current before-lines with previous match line.
1791 prev-line)
1795 before-lines))
1796 ;; Separate non-overlapping before-context lines.
1801 ;; Return a list where the first element is the output line.
1809 separator)))
1812 ;; And the second element is the list of context after-lines.
1815 \f
1816 ;; It would be nice to use \\[...], but there is no reasonable way
1817 ;; to make that display both SPC and Y.
1819 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1820 RET or `q' to exit, Period to replace one match and exit,
1821 Comma to replace but not move point immediately,
1823 C-w to delete match and recursive edit,
1824 C-l to clear the screen, redisplay, and offer same replacement again,
1825 ! to replace all remaining matches in this buffer with no more questions,
1826 ^ to move point back to previous match,
1827 E to edit the replacement string.
1828 In multi-buffer replacements type `Y' to replace all remaining
1829 matches in all remaining buffers with no more questions,
1830 `N' to skip to the next buffer without replacing remaining matches
1831 in the current buffer."
1839 (define-key map [backspace] 'skip)
1840 (define-key map "y" 'act)
1841 (define-key map "n" 'skip)
1842 (define-key map "Y" 'act)
1843 (define-key map "N" 'skip)
1844 (define-key map "e" 'edit-replacement)
1845 (define-key map "E" 'edit-replacement)
1846 (define-key map "," 'act-and-show)
1847 (define-key map "q" 'exit)
1849 (define-key map [return] 'exit)
1850 (define-key map "." 'act-and-exit)
1851 (define-key map "\C-r" 'edit)
1852 (define-key map "\C-w" 'delete-and-edit)
1853 (define-key map "\C-l" 'recenter)
1854 (define-key map "!" 'automatic)
1855 (define-key map "^" 'backup)
1856 (define-key map "\C-h" 'help)
1857 (define-key map [f1] 'help)
1858 (define-key map [help] 'help)
1859 (define-key map "?" 'help)
1860 (define-key map "\C-g" 'quit)
1861 (define-key map "\C-]" 'quit)
1862 (define-key map "\C-v" 'scroll-up)
1863 (define-key map "\M-v" 'scroll-down)
1864 (define-key map [next] 'scroll-up)
1865 (define-key map [prior] 'scroll-down)
1866 (define-key map [?\C-\M-v] 'scroll-other-window)
1867 (define-key map [M-next] 'scroll-other-window)
1868 (define-key map [?\C-\M-\S-v] 'scroll-other-window-down)
1869 (define-key map [M-prior] 'scroll-other-window-down)
1870 ;; Binding ESC would prohibit the M-v binding. Instead, callers
1871 ;; should check for ESC specially.
1872 ;; (define-key map "\e" 'exit-prefix)
1873 (define-key map [escape] 'exit-prefix)
1874 map)
1875 "Keymap of responses to questions posed by commands like `query-replace'.
1877 The valid answers include `act', `skip', `act-and-show',
1878 `act-and-exit', `exit', `exit-prefix', `recenter', `scroll-up',
1879 `scroll-down', `scroll-other-window', `scroll-other-window-down',
1880 `edit', `edit-replacement', `delete-and-edit', `automatic',
1881 `backup', `quit', and `help'.
1883 This keymap is used by `y-or-n-p' as well as `query-replace'.")
1885 (defvar multi-query-replace-map
1886 (let ((map (make-sparse-keymap)))
1887 (set-keymap-parent map query-replace-map)
1888 (define-key map "Y" 'automatic-all)
1889 (define-key map "N" 'exit-current)
1890 map)
1891 "Keymap that defines additional bindings for multi-buffer replacements.
1892 It extends its parent map `query-replace-map' with new bindings to
1893 operate on a set of buffers/files. The difference with its parent map
1894 is the additional answers `automatic-all' to replace all remaining
1895 matches in all remaining buffers with no more questions, and
1896 `exit-current' to skip remaining matches in the current buffer
1897 and to continue with the next buffer in the sequence.")
1899 (defun replace-match-string-symbols (n)
1900 "Process a list (and any sub-lists), expanding certain symbols.
1901 Symbol Expands To
1902 N (match-string N) (where N is a string of digits)
1903 #N (string-to-number (match-string N))
1904 & (match-string 0)
1905 #& (string-to-number (match-string 0))
1906 # replace-count
1908 Note that these symbols must be preceded by a backslash in order to
1909 type them using Lisp syntax."
1910 (while (consp n)
1911 (cond
1912 ((consp (car n))
1913 (replace-match-string-symbols (car n))) ;Process sub-list
1914 ((symbolp (car n))
1915 (let ((name (symbol-name (car n))))
1916 (cond
1917 ((string-match "^[0-9]+$" name)
1918 (setcar n (list 'match-string (string-to-number name))))
1919 ((string-match "^#[0-9]+$" name)
1920 (setcar n (list 'string-to-number
1921 (list 'match-string
1922 (string-to-number (substring name 1))))))
1923 ((string= "&" name)
1924 (setcar n '(match-string 0)))
1925 ((string= "#&" name)
1926 (setcar n '(string-to-number (match-string 0))))
1927 ((string= "#" name)
1928 (setcar n 'replace-count))))))
1929 (setq n (cdr n))))
1931 (defun replace-eval-replacement (expression count)
1932 (let* ((replace-count count)
1933 err
1934 (replacement
1935 (condition-case err
1936 (eval expression)
1937 (error
1938 (error "Error evaluating replacement expression: %S" err)))))
1939 (if (stringp replacement)
1940 replacement
1941 (prin1-to-string replacement t))))
1943 (defun replace-quote (replacement)
1944 "Quote a replacement string.
1945 This just doubles all backslashes in REPLACEMENT and
1946 returns the resulting string. If REPLACEMENT is not
1947 a string, it is first passed through `prin1-to-string'
1948 with the `noescape' argument set.
1950 `match-data' is preserved across the call."
1951 (save-match-data
1953 (if (stringp replacement)
1954 replacement
1955 (prin1-to-string replacement t))
1956 t t)))
1958 (defun replace-loop-through-replacements (data count)
1959 ;; DATA is a vector containing the following values:
1960 ;; 0 next-rotate-count
1961 ;; 1 repeat-count
1962 ;; 2 next-replacement
1963 ;; 3 replacements
1964 (if (= (aref data 0) count)
1965 (progn
1966 (aset data 0 (+ count (aref data 1)))
1967 (let ((next (cdr (aref data 2))))
1968 (aset data 2 (if (consp next) next (aref data 3))))))
1969 (car (aref data 2)))
1971 (defun replace-match-data (integers reuse &optional new)
1972 "Like `match-data', but markers in REUSE get invalidated.
1973 If NEW is non-nil, it is set and returned instead of fresh data,
1974 but coerced to the correct value of INTEGERS."
1975 (or (and new
1976 (progn
1977 (set-match-data new)
1978 (and (eq new reuse)
1979 (eq (null integers) (markerp (car reuse)))
1980 new)))
1981 (match-data integers reuse t)))
1983 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data backward)
1985 FIXEDCASE, LITERAL are passed to `replace-match' (which see).
1988 is made (to save time). MATCH-DATA is used for the replacement.
1989 In case editing is done, it is changed to use markers.
1992 passed in. If LITERAL is set, no checking is done, anyway."
1993 (unless (or literal noedit)
1994 (setq noedit t)
1996 newtext)
1997 (setq newtext
1998 (read-string "Edit replacement string: "
1999 (prog1
2000 (cons
2001 (replace-match "" t t newtext 3)
2002 (1+ (match-beginning 3)))
2003 (setq match-data
2004 (replace-match-data
2005 nil match-data match-data))))
2006 noedit nil)))
2007 (set-match-data match-data)
2008 (replace-match newtext fixedcase literal)
2009 ;; `replace-match' leaves point at the end of the replacement text,
2010 ;; so move point to the beginning when replacing backward.
2011 (when backward (goto-char (nth 0 match-data)))
2012 noedit)
2014 (defvar replace-update-post-hook nil
2015 "Function(s) to call after query-replace has found a match in the buffer.")
2017 (defvar replace-search-function nil
2018 "Function to use when searching for strings to replace.
2019 It is used by `query-replace' and `replace-string', and is called
2020 with three arguments, as if it were `search-forward'.")
2022 (defvar replace-re-search-function nil
2023 "Function to use when searching for regexps to replace.
2024 It is used by `query-replace-regexp', `replace-regexp',
2025 `query-replace-regexp-eval', and `map-query-replace-regexp'.
2026 It is called with three arguments, as if it were
2027 `re-search-forward'.")
2029 (defun replace-search (search-string limit regexp-flag delimited-flag
2030 case-fold-search backward)
2031 "Search for the next occurrence of SEARCH-STRING to replace."
2032 ;; Let-bind global isearch-* variables to values used
2033 ;; to search the next replacement. These let-bindings
2034 ;; should be effective both at the time of calling
2035 ;; `isearch-search-fun-default' and also at the
2036 ;; time of funcalling `search-function'.
2037 ;; These isearch-* bindings can't be placed higher
2038 ;; outside of this function because then another I-search
2039 ;; used after `recursive-edit' might override them.
2040 (let* ((isearch-regexp regexp-flag)
2041 (isearch-regexp-function (or delimited-flag
2042 (and replace-character-fold
2043 (not regexp-flag)
2044 #'character-fold-to-regexp)))
2045 (isearch-lax-whitespace
2046 replace-lax-whitespace)
2047 (isearch-regexp-lax-whitespace
2048 replace-regexp-lax-whitespace)
2049 (isearch-case-fold-search case-fold-search)
2050 (isearch-adjusted nil)
2051 (isearch-nonincremental t) ; don't use lax word mode
2052 (isearch-forward (not backward))
2053 (search-function
2054 (or (if regexp-flag
2055 replace-re-search-function
2056 replace-search-function)
2057 (isearch-search-fun-default))))
2058 (funcall search-function search-string limit t)))
2060 (defvar replace-overlay nil)
2062 (defun replace-highlight (match-beg match-end range-beg range-end
2063 search-string regexp-flag delimited-flag
2064 case-fold-search backward)
2065 (if query-replace-highlight
2066 (if replace-overlay
2067 (move-overlay replace-overlay match-beg match-end (current-buffer))
2068 (setq replace-overlay (make-overlay match-beg match-end))
2069 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
2070 (overlay-put replace-overlay 'face 'query-replace)))
2071 (if query-replace-lazy-highlight
2072 (let ((isearch-string search-string)
2073 (isearch-regexp regexp-flag)
2074 (isearch-regexp-function delimited-flag)
2075 (isearch-lax-whitespace
2076 replace-lax-whitespace)
2077 (isearch-regexp-lax-whitespace
2078 replace-regexp-lax-whitespace)
2079 (isearch-case-fold-search case-fold-search)
2080 (isearch-forward (not backward))
2081 (isearch-other-end match-beg)
2082 (isearch-error nil))
2083 (isearch-lazy-highlight-new-loop range-beg range-end))))
2085 (defun replace-dehighlight ()
2086 (when replace-overlay
2087 (delete-overlay replace-overlay))
2088 (when query-replace-lazy-highlight
2089 (lazy-highlight-cleanup lazy-highlight-cleanup)
2090 (setq isearch-lazy-highlight-last-string nil))
2091 ;; Close overlays opened by `isearch-range-invisible' in `perform-replace'.
2092 (isearch-clean-overlays))
2094 (defun perform-replace (from-string replacements
2095 query-flag regexp-flag delimited-flag
2096 &optional repeat-count map start end backward region-noncontiguous-p)
2097 "Subroutine of `query-replace'. Its complexity handles interactive queries.
2098 Don't use this in your own program unless you want to query and set the mark
2099 just as `query-replace' does. Instead, write a simple loop like this:
2104 which will run faster and probably do exactly what you want. Please
2105 see the documentation of `replace-match' to find out how to simulate
2106 `case-replace'.
2108 This function returns nil if and only if there were no matches to
2109 make, or the user didn't cancel the call.
2111 REPLACEMENTS is either a string, a list of strings, or a cons cell
2112 containing a function and its first argument. The function is
2113 called to generate each replacement like this:
2114 (funcall (car replacements) (cdr replacements) replace-count)
2115 It must return a string."
2116 (or map (setq map query-replace-map))
2117 (and query-flag minibuffer-auto-raise
2118 (raise-frame (window-frame (minibuffer-window))))
2119 (let* ((case-fold-search
2120 (if (and case-fold-search search-upper-case)
2121 (isearch-no-upper-case-p from-string regexp-flag)
2122 case-fold-search))
2123 (nocasify (not (and case-replace case-fold-search)))
2124 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
2125 (search-string from-string)
2126 (real-match-data nil) ; The match data for the current match.
2127 (next-replacement nil)
2128 ;; This is non-nil if we know there is nothing for the user
2129 ;; to edit in the replacement.
2130 (noedit nil)
2131 (keep-going t)
2132 (stack nil)
2133 (replace-count 0)
2134 (skip-read-only-count 0)
2135 (skip-filtered-count 0)
2136 (skip-invisible-count 0)
2137 (nonempty-match nil)
2138 (multi-buffer nil)
2139 (recenter-last-op nil) ; Start cycling order with initial position.
2141 ;; If non-nil, it is marker saying where in the buffer to stop.
2142 (limit nil)
2143 ;; Use local binding in add-function below.
2144 (isearch-filter-predicate isearch-filter-predicate)
2145 (region-bounds nil)
2147 ;; Data for the next match. If a cons, it has the same format as
2148 ;; (match-data); otherwise it is t if a match is possible at point.
2149 (match-again t)
2151 (message
2152 (if query-flag
2153 (apply 'propertize
2154 (substitute-command-keys
2156 minibuffer-prompt-properties))))
2158 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
2159 (when region-noncontiguous-p
2160 (setq region-bounds
2161 (mapcar (lambda (position)
2162 (cons (copy-marker (car position))
2163 (copy-marker (cdr position))))
2164 (funcall region-extract-function 'bounds)))
2165 (add-function :after-while isearch-filter-predicate
2166 (lambda (start end)
2167 (delq nil (mapcar
2168 (lambda (bounds)
2169 (and
2170 (>= start (car bounds))
2171 (<= start (cdr bounds))
2172 (>= end (car bounds))
2173 (<= end (cdr bounds))))
2174 region-bounds)))))
2176 ;; If region is active, in Transient Mark mode, operate on region.
2177 (if backward
2178 (when end
2179 (setq limit (copy-marker (min start end)))
2180 (goto-char (max start end))
2181 (deactivate-mark))
2182 (when start
2183 (setq limit (copy-marker (max start end)))
2184 (goto-char (min start end))
2185 (deactivate-mark)))
2187 ;; If last typed key in previous call of multi-buffer perform-replace
2188 ;; was `automatic-all', don't ask more questions in next files
2189 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
2190 (setq query-flag nil multi-buffer t))
2192 (cond
2193 ((stringp replacements)
2194 (setq next-replacement replacements
2195 replacements nil))
2196 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
2197 (or repeat-count (setq repeat-count 1))
2198 (setq replacements (cons 'replace-loop-through-replacements
2199 (vector repeat-count repeat-count
2200 replacements replacements)))))
2202 (when query-replace-lazy-highlight
2203 (setq isearch-lazy-highlight-last-string nil))
2205 (push-mark)
2206 (undo-boundary)
2207 (unwind-protect
2208 ;; Loop finding occurrences that perhaps should be replaced.
2209 (while (and keep-going
2210 (if backward
2211 (not (or (bobp) (and limit (<= (point) limit))))
2212 (not (or (eobp) (and limit (>= (point) limit)))))
2213 ;; Use the next match if it is already known;
2214 ;; otherwise, search for a match after moving forward
2215 ;; one char if progress is required.
2216 (setq real-match-data
2217 (cond ((consp match-again)
2218 (goto-char (if backward
2219 (nth 0 match-again)
2220 (nth 1 match-again)))
2221 (replace-match-data
2222 t real-match-data match-again))
2223 ;; MATCH-AGAIN non-nil means accept an
2224 ;; adjacent match.
2225 (match-again
2226 (and
2227 (replace-search search-string limit
2228 regexp-flag delimited-flag
2229 case-fold-search backward)
2230 ;; For speed, use only integers and
2231 ;; reuse the list used last time.
2232 (replace-match-data t real-match-data)))
2233 ((and (if backward
2234 (> (1- (point)) (point-min))
2235 (< (1+ (point)) (point-max)))
2236 (or (null limit)
2237 (if backward
2238 (> (1- (point)) limit)
2239 (< (1+ (point)) limit))))
2240 ;; If not accepting adjacent matches,
2241 ;; move one char to the right before
2242 ;; searching again. Undo the motion
2243 ;; if the search fails.
2244 (let ((opoint (point)))
2245 (forward-char (if backward -1 1))
2246 (if (replace-search search-string limit
2247 regexp-flag delimited-flag
2248 case-fold-search backward)
2249 (replace-match-data
2250 t real-match-data)
2251 (goto-char opoint)
2252 nil))))))
2254 ;; Record whether the match is nonempty, to avoid an infinite loop
2255 ;; repeatedly matching the same empty string.
2256 (setq nonempty-match
2257 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
2259 ;; If the match is empty, record that the next one can't be
2260 ;; adjacent.
2262 ;; Otherwise, if matching a regular expression, do the next
2263 ;; match now, since the replacement for this match may
2264 ;; affect whether the next match is adjacent to this one.
2265 ;; If that match is empty, don't use it.
2266 (setq match-again
2267 (and nonempty-match
2268 (or (not regexp-flag)
2269 (and (if backward
2270 (looking-back search-string nil)
2271 (looking-at search-string))
2272 (let ((match (match-data)))
2273 (and (/= (nth 0 match) (nth 1 match))
2274 match))))))
2276 (cond
2277 ;; Optionally ignore matches that have a read-only property.
2278 ((not (or (not query-replace-skip-read-only)
2279 (not (text-property-not-all
2280 (nth 0 real-match-data) (nth 1 real-match-data)
2281 'read-only nil))))
2282 (setq skip-read-only-count (1+ skip-read-only-count)))
2283 ;; Optionally filter out matches.
2284 ((not (funcall isearch-filter-predicate
2285 (nth 0 real-match-data) (nth 1 real-match-data)))
2286 (setq skip-filtered-count (1+ skip-filtered-count)))
2287 ;; Optionally ignore invisible matches.
2288 ((not (or (eq search-invisible t)
2289 ;; Don't open overlays for automatic replacements.
2290 (and (not query-flag) search-invisible)
2291 ;; Open hidden overlays for interactive replacements.
2292 (not (isearch-range-invisible
2293 (nth 0 real-match-data) (nth 1 real-match-data)))))
2294 (setq skip-invisible-count (1+ skip-invisible-count)))
2295 (t
2296 ;; Calculate the replacement string, if necessary.
2297 (when replacements
2298 (set-match-data real-match-data)
2299 (setq next-replacement
2300 (funcall (car replacements) (cdr replacements)
2301 replace-count)))
2302 (if (not query-flag)
2303 (progn
2304 (unless (or literal noedit)
2305 (replace-highlight
2306 (nth 0 real-match-data) (nth 1 real-match-data)
2307 start end search-string
2308 regexp-flag delimited-flag case-fold-search backward))
2309 (setq noedit
2310 (replace-match-maybe-edit
2311 next-replacement nocasify literal
2312 noedit real-match-data backward)
2313 replace-count (1+ replace-count)))
2314 (undo-boundary)
2315 (let (done replaced key def)
2316 ;; Loop reading commands until one of them sets done,
2317 ;; which means it has finished handling this
2318 ;; occurrence. Any command that sets `done' should
2319 ;; leave behind proper match data for the stack.
2320 ;; Commands not setting `done' need to adjust
2321 ;; `real-match-data'.
2322 (while (not done)
2323 (set-match-data real-match-data)
2324 (run-hooks 'replace-update-post-hook) ; Before `replace-highlight'.
2325 (replace-highlight
2326 (match-beginning 0) (match-end 0)
2327 start end search-string
2328 regexp-flag delimited-flag case-fold-search backward)
2329 ;; Bind message-log-max so we don't fill up the message log
2330 ;; with a bunch of identical messages.
2331 (let ((message-log-max nil)
2332 (replacement-presentation
2333 (if query-replace-show-replacement
2334 (save-match-data
2335 (set-match-data real-match-data)
2336 (match-substitute-replacement next-replacement
2337 nocasify literal))
2338 next-replacement)))
2339 (message message
2340 (query-replace-descr from-string)
2341 (query-replace-descr replacement-presentation)))
2342 (setq key (read-event))
2343 ;; Necessary in case something happens during read-event
2344 ;; that clobbers the match data.
2345 (set-match-data real-match-data)
2346 (setq key (vector key))
2347 (setq def (lookup-key map key))
2348 ;; Restore the match data while we process the command.
2349 (cond ((eq def 'help)
2350 (with-output-to-temp-buffer "*Help*"
2351 (princ
2352 (concat "Query replacing "
2353 (if delimited-flag
2354 (or (and (symbolp delimited-flag)
2355 (get delimited-flag 'isearch-message-prefix))
2356 "word ") "")
2357 (if regexp-flag "regexp " "")
2358 (if backward "backward " "")
2359 from-string " with "
2361 (substitute-command-keys
2362 query-replace-help)))
2363 (with-current-buffer standard-output
2364 (help-mode))))
2365 ((eq def 'exit)
2366 (setq keep-going nil)
2367 (setq done t))
2368 ((eq def 'exit-current)
2369 (setq multi-buffer t keep-going nil done t))
2370 ((eq def 'backup)
2371 (if stack
2372 (let ((elt (pop stack)))
2373 (goto-char (nth 0 elt))
2374 (setq replaced (nth 1 elt)
2375 real-match-data
2376 (replace-match-data
2377 t real-match-data
2378 (nth 2 elt))))
2379 (message "No previous match")
2380 (ding 'no-terminate)
2381 (sit-for 1)))
2382 ((eq def 'act)
2383 (or replaced
2384 (setq noedit
2385 (replace-match-maybe-edit
2386 next-replacement nocasify literal
2387 noedit real-match-data backward)
2388 replace-count (1+ replace-count)))
2389 (setq done t replaced t))
2390 ((eq def 'act-and-exit)
2391 (or replaced
2392 (setq noedit
2393 (replace-match-maybe-edit
2394 next-replacement nocasify literal
2395 noedit real-match-data backward)
2396 replace-count (1+ replace-count)))
2397 (setq keep-going nil)
2398 (setq done t replaced t))
2399 ((eq def 'act-and-show)
2400 (if (not replaced)
2401 (setq noedit
2402 (replace-match-maybe-edit
2403 next-replacement nocasify literal
2404 noedit real-match-data backward)
2405 replace-count (1+ replace-count)
2406 real-match-data (replace-match-data
2407 t real-match-data)
2408 replaced t)))
2409 ((or (eq def 'automatic) (eq def 'automatic-all))
2410 (or replaced
2411 (setq noedit
2412 (replace-match-maybe-edit
2413 next-replacement nocasify literal
2414 noedit real-match-data backward)
2415 replace-count (1+ replace-count)))
2416 (setq done t query-flag nil replaced t)
2417 (if (eq def 'automatic-all) (setq multi-buffer t)))
2418 ((eq def 'skip)
2419 (setq done t))
2420 ((eq def 'recenter)
2421 ;; `this-command' has the value `query-replace',
2422 ;; so we need to bind it to `recenter-top-bottom'
2423 ;; to allow it to detect a sequence of `C-l'.
2424 (let ((this-command 'recenter-top-bottom)
2425 (last-command 'recenter-top-bottom))
2426 (recenter-top-bottom)))
2427 ((eq def 'edit)
2428 (let ((opos (point-marker)))
2429 (setq real-match-data (replace-match-data
2430 nil real-match-data
2431 real-match-data))
2432 (goto-char (match-beginning 0))
2433 (save-excursion
2434 (save-window-excursion
2435 (recursive-edit)))
2436 (goto-char opos)
2437 (set-marker opos nil))
2438 ;; Before we make the replacement,
2439 ;; decide whether the search string
2440 ;; can match again just after this match.
2441 (if (and regexp-flag nonempty-match)
2442 (setq match-again (and (looking-at search-string)
2443 (match-data)))))
2444 ;; Edit replacement.
2445 ((eq def 'edit-replacement)
2446 (setq real-match-data (replace-match-data
2447 nil real-match-data
2448 real-match-data)
2449 next-replacement
2450 (read-string "Edit replacement string: "
2451 next-replacement)
2452 noedit nil)
2453 (if replaced
2454 (set-match-data real-match-data)
2455 (setq noedit
2456 (replace-match-maybe-edit
2457 next-replacement nocasify literal noedit
2458 real-match-data backward)
2459 replaced t))
2460 (setq done t))
2462 ((eq def 'delete-and-edit)
2463 (replace-match "" t t)
2464 (setq real-match-data (replace-match-data
2465 nil real-match-data))
2466 (replace-dehighlight)
2467 (save-excursion (recursive-edit))
2468 (setq replaced t))
2469 ;; Note: we do not need to treat `exit-prefix'
2470 ;; specially here, since we reread
2471 ;; any unrecognized character.
2472 (t
2473 (setq this-command 'mode-exited)
2474 (setq keep-going nil)
2475 (setq unread-command-events
2476 (append (listify-key-sequence key)
2477 unread-command-events))
2478 (setq done t)))
2479 (when query-replace-lazy-highlight
2480 ;; Force lazy rehighlighting only after replacements.
2481 (if (not (memq def '(skip backup)))
2482 (setq isearch-lazy-highlight-last-string nil)))
2483 (unless (eq def 'recenter)
2484 ;; Reset recenter cycling order to initial position.
2485 (setq recenter-last-op nil)))
2486 ;; Record previous position for ^ when we move on.
2487 ;; Change markers to numbers in the match data
2488 ;; since lots of markers slow down editing.
2489 (push (list (point) replaced
2490 ;;; If the replacement has already happened, all we need is the
2491 ;;; current match start and end. We could get this with a trivial
2492 ;;; match like
2493 ;;; (save-excursion (goto-char (match-beginning 0))
2494 ;;; (search-forward (match-string 0))
2495 ;;; (match-data t))
2496 ;;; if we really wanted to avoid manually constructing match data.
2497 ;;; Adding current-buffer is necessary so that match-data calls can
2498 ;;; return markers which are appropriate for editing.
2499 (if replaced
2500 (list
2501 (match-beginning 0)
2502 (match-end 0)
2503 (current-buffer))
2504 (match-data t)))
2505 stack))))))
2507 (replace-dehighlight))
2508 (or unread-command-events
2509 (message "Replaced %d occurrence%s%s"
2510 replace-count
2511 (if (= replace-count 1) "" "s")
2512 (if (> (+ skip-read-only-count
2513 skip-filtered-count
2514 skip-invisible-count) 0)
2515 (format " (skipped %s)"
2516 (mapconcat
2517 'identity
2518 (delq nil (list
2519 (if (> skip-read-only-count 0)
2520 (format "%s read-only"
2521 skip-read-only-count))
2522 (if (> skip-invisible-count 0)
2523 (format "%s invisible"
2524 skip-invisible-count))
2525 (if (> skip-filtered-count 0)
2526 (format "%s filtered out"
2527 skip-filtered-count))))
2528 ", "))
2529 "")))
2530 (or (and keep-going stack) multi-buffer)))
2532 ;;; replace.el ends here