| blob | ff9173444539ed63f39e132b589833e02c350042 |
1 ;;; replace.el --- replace commands for Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2017 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:
34 "Non-nil means `query-replace' should preserve case in replacements."
39 "Non-nil means replacement commands should do character folding in matches.
41 unicode quotes.
42 This variable affects `query-replace' and `replace-string', but not
43 `replace-regexp'."
49 "Non-nil means `query-replace' matches a sequence of whitespace chars.
50 When you enter a space or spaces in the strings to be replaced,
51 it will match any sequence matched by the regexp `search-whitespace-regexp'."
57 "Non-nil means `query-replace-regexp' matches a sequence of whitespace chars.
58 When you enter a space or spaces in the regexps to be replaced,
59 it will match any sequence matched by the regexp `search-whitespace-regexp'."
65 "Default history list for query-replace commands.
66 See `query-replace-from-history-variable' and
70 "Default values of FROM-STRING and TO-STRING for `query-replace'.
71 This is a list of cons cells (FROM-STRING . TO-STRING), or nil
75 "Non-nil means `query-replace' uses the last search string.
78 "use `M-n' to pull the last incremental search string
79 to the minibuffer that reads the string to replace, or invoke replacements
85 "String that separates FROM and TO in the history of replacement pairs."
86 ;; Avoids error when attempt to autoload char-displayable-p fails
87 ;; while preparing to dump, also stops customize-rogue listing this.
94 "History list to use for the FROM argument of `query-replace' commands.
95 The value of this variable should be a symbol; that symbol
96 is used as a variable to hold a history list for the strings
97 or patterns to be replaced."
103 "History list to use for the TO argument of `query-replace' commands.
104 The value of this variable should be a symbol; that symbol
105 is used as a variable to hold a history list for replacement
106 strings or patterns."
112 "Non-nil means `query-replace' and friends ignore read-only matches."
118 "Non-nil means show substituted replacement text in the minibuffer.
119 This variable affects only `query-replace-regexp'."
125 "Non-nil means to highlight matches during query replacement."
130 "Controls the lazy-highlighting during query replacements.
131 When non-nil, all text in the buffer matching the current match
132 is highlighted lazily using isearch lazy highlighting (see
133 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
141 "Face for highlighting query replacement matches."
146 "Number of replacements done so far.
153 "Split string STRING at a character with property `separator'"
163 "Query and return the `from' argument of a query-replace operation.
164 The return value can also be a pair (FROM . TO) indicating that the user
165 wants to replace FROM with TO."
168 ;; Reevaluating will check char-displayable-p that is
169 ;; 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.
203 prompt nil nil nil nil
213 ;; Warn if user types \n or \t, but don't reject the input.
224 from
230 "Maybe convert a regexp replacement TO to Lisp.
231 Returns a list suitable for `perform-replace' if necessary,
232 the original string if not."
248 ;; Swallow a space after a symbol
249 ;; if there is a space.
251 ;; Swallow a space after 'foo
252 ;; but not after (quote foo).
267 to))
271 "Query and return the `to' argument of a query-replace operation."
277 nil nil nil
278 query-replace-to-history-variable from t)))
281 to))
282 regexp-flag))
294 (defun query-replace (from-string to-string &optional delimited start end backward region-noncontiguous-p)
295 "Replace some occurrences of FROM-STRING with TO-STRING.
296 As each match is found, the user must type a character saying
299 In Transient Mark mode, if the mark is active, operate on the contents
300 of the region. Otherwise, operate from point to the end of the buffer's
301 accessible portion.
303 In interactive use, the prefix arg (non-nil DELIMITED in
304 non-interactive use), means replace only matches surrounded by
305 word boundaries. A negative prefix arg means replace backward.
308 to pull the last incremental search string to the minibuffer
309 that reads FROM-STRING, or invoke replacements from
310 incremental search with a key sequence like `C-s C-s M-%'
311 to use its current search string as the string to replace.
313 Matching is independent of case if `case-fold-search' is non-nil and
314 FROM-STRING has no uppercase letters. Replacement transfers the case
315 pattern of the old text to the new text, if `case-replace' and
316 `case-fold-search' are non-nil and FROM-STRING has no uppercase
317 letters. (Transferring the case pattern means that if the old text
318 matched is all caps, or capitalized, then its replacement is upcased
319 or capitalized.)
321 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
322 ignore hidden matches if `search-invisible' is nil, and ignore more
323 matches using `isearch-filter-predicate'.
325 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
326 to be replaced will match a sequence of whitespace chars defined by the
327 regexp in `search-whitespace-regexp'.
329 If `replace-char-fold' is non-nil, matching uses character folding,
330 i.e. it ignores diacritics and other differences between equivalent
331 character strings.
333 Fourth and fifth arg START and END specify the region to operate on.
335 To customize possible responses, change the bindings in `query-replace-map'."
344 nil)))
346 ;; These are done separately here
347 ;; so that command-history will record these expressions
348 ;; rather than the values they had this time.
353 (perform-replace from-string to-string t nil delimited nil nil start end backward region-noncontiguous-p))
357 (defun query-replace-regexp (regexp to-string &optional delimited start end backward region-noncontiguous-p)
358 "Replace some things after point matching REGEXP with TO-STRING.
359 As each match is found, the user must type a character saying
362 In Transient Mark mode, if the mark is active, operate on the contents
363 of the region. Otherwise, operate from point to the end of the buffer's
364 accessible portion.
367 to pull the last incremental search regexp to the minibuffer
368 that reads REGEXP, or invoke replacements from
369 incremental search with a key sequence like `C-M-s C-M-s C-M-%'
370 to use its current search regexp as the regexp to replace.
372 Matching is independent of case if `case-fold-search' is non-nil and
373 REGEXP has no uppercase letters. Replacement transfers the case
374 pattern of the old text to the new text, if `case-replace' and
375 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
376 \(Transferring the case pattern means that if the old text matched is
377 all caps, or capitalized, then its replacement is upcased or
378 capitalized.)
380 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
381 ignore hidden matches if `search-invisible' is nil, and ignore more
382 matches using `isearch-filter-predicate'.
384 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
385 to be replaced will match a sequence of whitespace chars defined by the
386 regexp in `search-whitespace-regexp'.
388 This function is not affected by `replace-char-fold'.
390 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
391 only matches surrounded by word boundaries. A negative prefix arg means
392 replace backward.
394 Fourth and fifth arg START and END specify the region to operate on.
399 counted from 1.
401 at the given position for each replacement.
404 followed by a Lisp expression. Each
405 replacement evaluates that expression to compute the replacement
408 for the whole or a partial match converted to a number with
410 done so far (starting with zero).
412 If the replacement expression is a symbol, write a space after it
413 to terminate it. One space there, if any, will be discarded.
415 When using those Lisp features interactively in the replacement
416 text, TO-STRING is actually made a list instead of a string.
425 " regexp"
427 t)))
429 ;; These are done separately here
430 ;; so that command-history will record these expressions
431 ;; rather than the values they had this time.
436 (perform-replace regexp to-string t t delimited nil nil start end backward region-noncontiguous-p))
441 "Replace some things after point matching REGEXP with the result of TO-EXPR.
443 Interactive use of this function is deprecated in favor of the
445 using `search-forward-regexp' and `replace-match' is preferred.
447 As each match is found, the user must type a character saying
450 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
451 reference `replace-count' to get the number of replacements already made.
452 If the result of TO-EXPR is not a string, it is converted to one using
453 `prin1-to-string' with the NOESCAPE argument (which see).
458 in REGEXP.
463 In Transient Mark mode, if the mark is active, operate on the contents
464 of the region. Otherwise, operate from point to the end of the buffer's
465 accessible portion.
468 to pull the last incremental search regexp to the minibuffer
469 that reads REGEXP.
471 Preserves case in each replacement if `case-replace' and `case-fold-search'
472 are non-nil and REGEXP has no uppercase letters.
474 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
475 ignore hidden matches if `search-invisible' is nil, and ignore more
476 matches using `isearch-filter-predicate'.
478 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
479 to be replaced will match a sequence of whitespace chars defined by the
480 regexp in `search-whitespace-regexp'.
482 This function is not affected by `replace-char-fold'.
484 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
485 only matches that are surrounded by word boundaries.
486 Fourth and fifth arg START and END specify the region to operate on."
488 for interactive calls, and `search-forward-regexp'/`replace-match'
494 ;; Let-bind the history var to disable the "foo -> bar"
495 ;; default. Maybe we shouldn't disable this default, but
496 ;; for now I'll leave it off. --Stef
502 nil nil t query-replace-to-history-variable from t))))
503 ;; We make TO a list because replace-match-string-symbols requires one,
504 ;; and the user might enter a single token.
513 "Replace some matches for REGEXP with various strings, in rotation.
514 The second argument TO-STRINGS contains the replacement strings, separated
515 by spaces. This command works like `query-replace-regexp' except that
516 each successive replacement uses the next successive replacement string,
517 wrapping around from the last such string to the first.
519 In Transient Mark mode, if the mark is active, operate on the contents
520 of the region. Otherwise, operate from point to the end of the buffer's
521 accessible portion.
523 Non-interactively, TO-STRINGS may be a list of replacement strings.
525 Interactively, reads the regexp using `read-regexp'.
527 to pull the last incremental search regexp to the minibuffer
528 that reads REGEXP.
530 A prefix argument N says to use each replacement string N times
531 before rotating to the next.
532 Fourth and fifth arg START and END specify the region to operate on."
535 query-replace-from-history-variable))
539 nil nil nil
540 query-replace-to-history-variable from t)))
562 "Replace occurrences of FROM-STRING with TO-STRING.
563 Preserve case in each match if `case-replace' and `case-fold-search'
564 are non-nil and FROM-STRING has no uppercase letters.
565 \(Preserving case means that if the string matched is all caps, or capitalized,
566 then its replacement is upcased or capitalized.)
568 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
569 ignore hidden matches if `search-invisible' is nil, and ignore more
570 matches using `isearch-filter-predicate'.
572 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
573 to be replaced will match a sequence of whitespace chars defined by the
574 regexp in `search-whitespace-regexp'.
576 If `replace-char-fold' is non-nil, matching uses character folding,
577 i.e. it ignores diacritics and other differences between equivalent
578 character strings.
580 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
581 only matches surrounded by word boundaries. A negative prefix arg means
582 replace backward.
584 Operates on the region between START and END (if both are nil, from point
585 to the end of the buffer). Interactively, if Transient Mark mode is
586 enabled and the mark is active, operates on the contents of the region;
587 otherwise from point to the end of the buffer's accessible portion.
590 to pull the last incremental search string to the minibuffer
591 that reads FROM-STRING.
593 This function is usually the wrong thing to use in a Lisp program.
594 What you probably want is a loop like this:
595 (while (search-forward FROM-STRING nil t)
596 (replace-match TO-STRING nil t))
597 which will run faster and will not set the mark or print anything.
598 \(You may need a more complex loop if FROM-STRING can match the null string
599 and TO-STRING is also null.)"
609 " string"
611 nil)))
619 "Replace things after point matching REGEXP with TO-STRING.
620 Preserve case in each match if `case-replace' and `case-fold-search'
621 are non-nil and REGEXP has no uppercase letters.
623 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
624 ignore hidden matches if `search-invisible' is nil, and ignore more
625 matches using `isearch-filter-predicate'.
627 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
628 to be replaced will match a sequence of whitespace chars defined by the
629 regexp in `search-whitespace-regexp'.
631 This function is not affected by `replace-char-fold'
633 In Transient Mark mode, if the mark is active, operate on the contents
634 of the region. Otherwise, operate from point to the end of the buffer's
635 accessible portion.
637 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
638 only matches surrounded by word boundaries. A negative prefix arg means
639 replace backward.
641 Fourth and fifth arg START and END specify the region to operate on.
647 at the given position for each replacement.
650 followed by a Lisp expression used as part of the replacement
654 `replace-count', the number of replacements occurred so far.
656 If your Lisp expression is an identifier and the next letter in
657 the replacement string would be interpreted as part of it, you
660 replacement text directly.
662 When using those Lisp features interactively in the replacement
663 text, TO-STRING is actually made a list instead of a string.
667 to pull the last incremental search regexp to the minibuffer
668 that reads REGEXP.
670 This function is usually the wrong thing to use in a Lisp program.
671 What you probably want is a loop like this:
672 (while (re-search-forward REGEXP nil t)
673 (replace-match TO-STRING nil nil))
674 which will run faster and will not set the mark or print anything."
684 " regexp"
686 t)))
693 \f
695 "History list for some commands that read regular expressions.
697 Maximum length of the history list is determined by the value
704 "Function that provides default regexp(s) for `read-regexp'.
705 This function should take no arguments and return one of: nil, a
706 regexp, or a list of regexps. Interactively, `read-regexp' uses
707 the return value of this function for its DEFAULT argument.
709 As an example, set this variable to `find-tag-default-as-regexp'
710 to default to the symbol at point.
712 To provide different default regexps for different commands,
713 the function that you set this to can check `this-command'."
718 find-tag-default)
720 find-tag-default-as-regexp)
722 find-tag-default-as-symbol-regexp)
728 "Return a list of standard suggestions for `read-regexp'.
729 By default, the list includes the tag at point, the last isearch regexp,
730 the last isearch string, and the last replacement regexp. `read-regexp'
731 appends the list returned by this function to the end of values available
741 "Read and return a regular expression as a string.
744 possibly preceded by the default result (see below).
746 The optional argument DEFAULTS can be either: nil, a string, a list
747 of strings, or a symbol. We use DEFAULTS to construct the default
748 return value in case of empty input.
750 If DEFAULTS is a string, we use it as-is.
752 If DEFAULTS is a list of strings, the first element is the
753 default return value, but all the elements are accessible
756 If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
757 is non-nil, we use that in place of DEFAULTS in the following:
758 If DEFAULTS is the symbol `regexp-history-last', we use the first
759 element of HISTORY (if specified) or `regexp-history'.
760 If DEFAULTS is a function, we call it with no arguments and use
761 what it returns, which should be either nil, a string, or a list of strings.
763 We append the standard values from `read-regexp-suggestions' to DEFAULTS
764 before using it.
766 If the first element of DEFAULTS is non-nil (and if PROMPT does not end
769 The optional argument HISTORY is a symbol to use for the history list.
770 If nil, uses `regexp-history'."
779 defaults))
784 ;; Do not automatically add default to the history for empty input.
788 prompt)
796 ;; Return the default value when the user enters empty input.
800 ;; Otherwise, add non-empty input to the history and return input.
811 "Read arguments for `keep-lines' and friends.
812 Prompt for a regexp with PROMPT.
813 Value is a list, (REGEXP)."
817 "Delete all lines except those containing matches for REGEXP.
818 A match split across lines preserves all the lines it lies in.
819 When called from Lisp (and usually interactively as well, see below)
820 applies to all lines starting after point.
823 and `search-upper-case' is non-nil, the matching is case-sensitive.
825 Second and third arg RSTART and REND specify the region to operate on.
826 This command operates on (the accessible part of) all lines whose
827 accessible part is entirely contained in the region determined by RSTART
828 and REND. (A newline ending a line counts as part of that line.)
830 Interactively, in Transient Mark mode when the mark is active, operate
831 on all lines whose accessible part is entirely contained in the region.
832 Otherwise, the command applies to all lines starting after point.
833 When calling this function from Lisp, you can pretend that it was
834 called interactively by passing a non-nil INTERACTIVE argument.
836 This function starts looking for the next match from the end of
837 the previous match. Hence, it ignores matches that overlap
838 a previously found match."
870 case-fold-search)))
872 ;; Start is first char not preserved by previous match.
878 ;; Now end is first char preserved by the new match.
883 ;; If the match was empty, avoid matching again at same place.
888 nil)
892 "Delete lines containing matches for REGEXP.
893 When called from Lisp (and usually when called interactively as
894 well, see below), applies to the part of the buffer after point.
895 The line point is in is deleted if and only if it contains a
896 match for regexp starting after point.
899 and `search-upper-case' is non-nil, the matching is case-sensitive.
901 Second and third arg RSTART and REND specify the region to operate on.
902 Lines partially contained in this region are deleted if and only if
903 they contain a match entirely contained in it.
905 Interactively, in Transient Mark mode when the mark is active, operate
906 on the contents of the region. Otherwise, operate from point to the
907 end of (the accessible portion of) the buffer. When calling this function
908 from Lisp, you can pretend that it was called interactively by passing
909 a non-nil INTERACTIVE argument.
911 If a match is split across lines, all the lines it lies in are deleted.
912 They are deleted _before_ looking for the next match. Hence, a match
913 starting on the same line at which another match ended is ignored."
932 case-fold-search)))
941 nil)
945 "Print and return number of matches for REGEXP following point.
946 When called from Lisp and INTERACTIVE is omitted or nil, just return
947 the number, do not print it; if INTERACTIVE is t, the function behaves
948 in all respects as if it had been called interactively.
951 and `search-upper-case' is non-nil, the matching is case-sensitive.
953 Second and third arg RSTART and REND specify the region to operate on.
955 Interactively, in Transient Mark mode when the mark is active, operate
956 on the contents of the region. Otherwise, operate from point to the
957 end of (the accessible portion of) the buffer.
959 This function starts looking for the next match from the end of
960 the previous match. Hence, it ignores matches that overlap
961 a previously found match."
980 opoint
984 case-fold-search)))
992 count
994 count)))
996 \f
1001 next-error-follow-minor-mode
1004 next-error-follow-minor-mode))))
1040 map)
1045 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
1058 map)
1062 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
1068 "Hook run when entering Occur mode."
1073 "Hook run by Occur when there are any matches."
1078 "Hook run by Occur after locating an occurrence.
1079 This will be called with the cursor position at the occurrence. An application
1080 for this is to reveal context in an outline-mode when the occurrence is hidden."
1095 \f
1096 ;;; Occur Edit mode
1106 map)
1110 "Major mode for editing *Occur* buffers.
1111 In this mode, changes to the *Occur* buffer are also applied to
1112 the originating buffer.
1121 "Switch from Occur Edit mode to Occur mode."
1133 col)
1137 ;; Apply occur-target property to inserted (e.g. yanked) text.
1139 ;; Did we insert a newline? Occur Edit mode can't create new
1140 ;; Occur entries; just discard everything after the newline.
1154 line-beg 'occur-prefix nil
1155 line-end))
1167 \f
1169 "Handle `revert-buffer' for Occur mode buffers."
1178 pos))
1182 "Go to the occurrence on the current line."
1186 ;; Actually `event-end' works correctly with a nil argument as
1187 ;; well, so we could dispense with this test, but let's not
1188 ;; rely on this undocumented behavior.
1199 "Go to the occurrence the current line describes, in another window."
1207 "Display in another window the occurrence the current line describes."
1210 window)
1212 ;; This is the way to set point in the proper window.
1232 "Move to the Nth (default 1) next match in an Occur mode buffer."
1237 "Move to the Nth (default 1) previous match in an Occur mode buffer."
1242 "Move to the Nth (default 1) next match in an Occur mode buffer.
1245 ;; we need to run occur-find-match from within the Occur buffer
1247 ;; Choose the buffer and make it current.
1261 #'previous-single-property-change
1264 ;; In case the *Occur* buffer is visible in a nonselected window.
1268 \f
1281 "Face used to highlight matches permanently."
1287 "Default number of context lines included around `list-matching-lines' matches.
1288 A negative number means to include that many lines before the match.
1289 A positive number means to include that many lines both before and after."
1297 If the value is nil, don't highlight the matching portions specially."
1303 If the value is nil, don't highlight the buffer names specially."
1309 If the face doesn't differ from the default face,
1310 don't highlight the prefix with line numbers specially."
1317 yank-handler follow-link)
1318 "Text properties to discard when copying lines to the *Occur* buffer.
1319 The value should be a list of text properties to discard or t,
1320 which means to discard all text properties."
1328 "Collect strings matching regexp"
1333 ;; Perform collect operation
1335 ;; No subexpression so collect the entire match.
1337 ;; Get the regexp for collection pattern.
1342 ;; Otherwise normal occur takes numerical prefix argument.
1347 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1348 Here `original-buffer-name' is the buffer name where Occur was originally run.
1349 When given the prefix argument, or called non-interactively, the renaming
1350 will not clobber the existing buffer(s) of that name, but use
1351 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1352 if you always want a separate *Occur* buffer for each buffer where you
1353 invoke `occur'."
1364 "Show all lines in the current buffer containing a match for REGEXP.
1365 If a match spreads across multiple lines, all those lines are shown.
1367 Each line is displayed with NLINES lines before and after, or -NLINES
1368 before if NLINES is negative.
1369 NLINES defaults to `list-matching-lines-default-context-lines'.
1370 Interactively it is the prefix arg.
1372 The lines are shown in a buffer named `*Occur*'.
1373 It serves as a menu to find any of the occurrences in this buffer.
1377 and `search-upper-case' is non-nil, the matching is case-sensitive.
1379 When NLINES is a string or when the function is called
1380 interactively with prefix argument without a number (`C-u' alone
1381 as prefix) the matching strings are collected into the `*Occur*'
1382 buffer by using NLINES as a replacement regexp. NLINES may
1386 program. When there is no parenthesized subexpressions in REGEXP
1387 the entire match is collected. In any case the searched buffer
1388 is not modified."
1395 "Show all lines in buffers BUFS containing a match for REGEXP.
1396 This function acts on multiple buffers; otherwise, it is exactly like
1397 `occur'. When you invoke this command interactively, you must specify
1398 the buffer names that you want, one by one.
1399 See also `multi-occur-in-matching-buffers'."
1409 "Next buffer to search (C-j to end): "
1411 nil t))
1420 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1421 Normally BUFREGEXP matches against each buffer's visited file name,
1422 but if you specify a prefix argument, it matches against the buffer name.
1423 See also `multi-occur'."
1430 "List lines in buffers whose names match regexp: "
1433 default
1434 input))
1446 buf))
1468 bufs))))
1469 ;; Handle the case where one of the buffers we're searching is the
1470 ;; output buffer. Just rename it.
1475 ;; Now find or create the output buffer.
1476 ;; If we just renamed that buffer, we will make a new one here.
1484 ;; Don't generate undo entries for creation of the initial contents.
1489 ;; Treat nlines as a regexp to collect.
1497 ;; Insert the replacement regexp.
1506 count)
1507 ;; Perform normal occur.
1509 regexp active-bufs occur-buf
1513 case-fold-search)
1514 list-matching-lines-buffer-name-face
1516 list-matching-lines-prefix-face)
1517 list-matching-lines-face
1526 ;; Don't display regexp if with remaining text
1527 ;; it is longer than window-width.
1529 regexp))
1543 title-face prefix-face match-face keep-props)
1549 ;; Map over all the buffers
1568 ;; Set CODING only if the current buffer locally
1569 ;; binds buffer-file-coding-system.
1579 ;; Get beginning of first match line and end of the last.
1585 ;; Sum line numbers up to the first match line.
1590 ;; Highlight the matches
1593 ;; Count empty lines that don't use next loop (Bug#22062).
1603 ;; Add `match-face' to faces copied from the buffer.
1606 match-face nil curstring))
1607 ;; Avoid infloop (Bug#7593).
1610 ;; Generate the string to insert for this match
1612 ;; Using 7 digits aligns tabs properly.
1618 ;; Allow insertion of text at
1619 ;; the end of the prefix (for
1620 ;; Occur Edit mode).
1621 front-sticky t rear-nonsticky t
1622 occur-target ,marker follow-link t
1625 ;; We don't put `mouse-face' on the newline,
1626 ;; because that loses. And don't put it
1627 ;; on context lines to reduce flicker.
1629 'occur-target marker
1630 'follow-link t
1631 'help-echo
1635 match-prefix
1636 ;; Add non-numeric prefix to all non-first lines
1637 ;; of multi-line matches.
1643 match-str)
1644 ;; Add marker at eol, but no mouse props.
1648 ;; The simple display style
1649 out-line
1650 ;; The complex multi-line display style.
1652 out-line nlines keep-props begpt endpt
1653 curr-line prev-line prev-after-lines
1654 prefix-face))
1655 ;; Set first elem of the returned list to `data',
1656 ;; and the second elem to `prev-after-lines'.
1659 ;; Actually insert the match display data
1665 ;; Sum line numbers between first and last match lines.
1667 ;; Add 1 for empty last match line since
1668 ;; count-lines returns 1 line less.
1670 ;; On to the next match...
1674 ;; Flush remaining context after-lines.
1678 prev-after-lines prefix-face)))))))
1685 end)
1689 ;; Don't display the same number of lines
1690 ;; and matches in case of 1 match per line.
1694 ;; Don't display regexp for multi-buffer.
1704 ;; Display total match count and regexp for multi-buffer.
1708 end)
1711 ;; Don't display the same number of lines
1712 ;; and matches in case of 1 match per line.
1722 ;; CODING is buffer-file-coding-system of the first buffer
1723 ;; that locally binds it. Let's use it also for the output
1724 ;; buffer.
1726 ;; Return the number of matches
1727 global-matches)))
1738 str)
1748 lines))
1755 result beg end moved)
1767 ;; Generate context display for occur.
1768 ;; OUT-LINE is the line where the match is.
1769 ;; NLINES and KEEP-PROPS are args to occur-engine.
1770 ;; CURR-LINE is line count of the current match,
1771 ;; PREV-LINE is line count of the previous match,
1772 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1773 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1774 ;; then concatenate them all together.
1776 curr-line prev-line prev-after-lines
1778 ;; Find after- and before-context lines of the current match.
1785 separator)
1787 ;; Combine after-lines of the previous match
1788 ;; with before-lines of the current match.
1791 ;; Don't overlap prev after-lines with current before-lines.
1798 ;; Separate non-overlapping context lines with a dashed line.
1802 ;; Don't overlap current before-lines with previous match line.
1804 prev-line)
1808 before-lines))
1809 ;; Separate non-overlapping before-context lines.
1814 ;; Return a list where the first element is the output line.
1822 separator)))
1825 ;; And the second element is the list of context after-lines.
1828 \f
1829 ;; It would be nice to use \\[...], but there is no reasonable way
1830 ;; to make that display both SPC and Y.
1832 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1833 RET or `q' to exit, Period to replace one match and exit,
1834 Comma to replace but not move point immediately,
1836 C-w to delete match and recursive edit,
1837 C-l to clear the screen, redisplay, and offer same replacement again,
1838 ! to replace all remaining matches in this buffer with no more questions,
1839 ^ to move point back to previous match,
1840 u to undo previous replacement,
1841 U to undo all replacements,
1842 E to edit the replacement string.
1843 In multi-buffer replacements type `Y' to replace all remaining
1844 matches in all remaining buffers with no more questions,
1845 `N' to skip to the next buffer without replacing remaining matches
1846 in the current buffer."
1854 (define-key map [backspace] 'skip)
1855 (define-key map "y" 'act)
1856 (define-key map "n" 'skip)
1857 (define-key map "Y" 'act)
1858 (define-key map "N" 'skip)
1859 (define-key map "e" 'edit-replacement)
1860 (define-key map "E" 'edit-replacement)
1861 (define-key map "," 'act-and-show)
1862 (define-key map "q" 'exit)
1864 (define-key map [return] 'exit)
1865 (define-key map "." 'act-and-exit)
1866 (define-key map "\C-r" 'edit)
1867 (define-key map "\C-w" 'delete-and-edit)
1868 (define-key map "\C-l" 'recenter)
1869 (define-key map "!" 'automatic)
1870 (define-key map "^" 'backup)
1871 (define-key map "u" 'undo)
1872 (define-key map "U" 'undo-all)
1873 (define-key map "\C-h" 'help)
1874 (define-key map [f1] 'help)
1875 (define-key map [help] 'help)
1876 (define-key map "?" 'help)
1877 (define-key map "\C-g" 'quit)
1878 (define-key map "\C-]" 'quit)
1879 (define-key map "\C-v" 'scroll-up)
1880 (define-key map "\M-v" 'scroll-down)
1881 (define-key map [next] 'scroll-up)
1882 (define-key map [prior] 'scroll-down)
1883 (define-key map [?\C-\M-v] 'scroll-other-window)
1884 (define-key map [M-next] 'scroll-other-window)
1885 (define-key map [?\C-\M-\S-v] 'scroll-other-window-down)
1886 (define-key map [M-prior] 'scroll-other-window-down)
1887 ;; Binding ESC would prohibit the M-v binding. Instead, callers
1888 ;; should check for ESC specially.
1889 ;; (define-key map "\e" 'exit-prefix)
1890 (define-key map [escape] 'exit-prefix)
1891 map)
1892 "Keymap of responses to questions posed by commands like `query-replace'.
1894 The valid answers include `act', `skip', `act-and-show',
1895 `act-and-exit', `exit', `exit-prefix', `recenter', `scroll-up',
1896 `scroll-down', `scroll-other-window', `scroll-other-window-down',
1897 `edit', `edit-replacement', `delete-and-edit', `automatic',
1898 `backup', `undo', `undo-all', `quit', and `help'.
1900 This keymap is used by `y-or-n-p' as well as `query-replace'.")
1902 (defvar multi-query-replace-map
1903 (let ((map (make-sparse-keymap)))
1904 (set-keymap-parent map query-replace-map)
1905 (define-key map "Y" 'automatic-all)
1906 (define-key map "N" 'exit-current)
1907 map)
1908 "Keymap that defines additional bindings for multi-buffer replacements.
1909 It extends its parent map `query-replace-map' with new bindings to
1910 operate on a set of buffers/files. The difference with its parent map
1911 is the additional answers `automatic-all' to replace all remaining
1912 matches in all remaining buffers with no more questions, and
1913 `exit-current' to skip remaining matches in the current buffer
1914 and to continue with the next buffer in the sequence.")
1916 (defun replace-match-string-symbols (n)
1917 "Process a list (and any sub-lists), expanding certain symbols.
1918 Symbol Expands To
1919 N (match-string N) (where N is a string of digits)
1920 #N (string-to-number (match-string N))
1921 & (match-string 0)
1922 #& (string-to-number (match-string 0))
1923 # replace-count
1925 Note that these symbols must be preceded by a backslash in order to
1926 type them using Lisp syntax."
1927 (while (consp n)
1928 (cond
1929 ((consp (car n))
1930 (replace-match-string-symbols (car n))) ;Process sub-list
1931 ((symbolp (car n))
1932 (let ((name (symbol-name (car n))))
1933 (cond
1934 ((string-match "^[0-9]+$" name)
1935 (setcar n (list 'match-string (string-to-number name))))
1936 ((string-match "^#[0-9]+$" name)
1937 (setcar n (list 'string-to-number
1938 (list 'match-string
1939 (string-to-number (substring name 1))))))
1940 ((string= "&" name)
1941 (setcar n '(match-string 0)))
1942 ((string= "#&" name)
1943 (setcar n '(string-to-number (match-string 0))))
1944 ((string= "#" name)
1945 (setcar n 'replace-count))))))
1946 (setq n (cdr n))))
1948 (defun replace-eval-replacement (expression count)
1949 (let* ((replace-count count)
1950 (replacement
1951 (condition-case err
1952 (eval expression)
1953 (error
1954 (error "Error evaluating replacement expression: %S" err)))))
1955 (if (stringp replacement)
1956 replacement
1957 (prin1-to-string replacement t))))
1959 (defun replace-quote (replacement)
1960 "Quote a replacement string.
1961 This just doubles all backslashes in REPLACEMENT and
1962 returns the resulting string. If REPLACEMENT is not
1963 a string, it is first passed through `prin1-to-string'
1964 with the `noescape' argument set.
1966 `match-data' is preserved across the call."
1967 (save-match-data
1969 (if (stringp replacement)
1970 replacement
1971 (prin1-to-string replacement t))
1972 t t)))
1974 (defun replace-loop-through-replacements (data count)
1975 ;; DATA is a vector containing the following values:
1976 ;; 0 next-rotate-count
1977 ;; 1 repeat-count
1978 ;; 2 next-replacement
1979 ;; 3 replacements
1980 (if (= (aref data 0) count)
1981 (progn
1982 (aset data 0 (+ count (aref data 1)))
1983 (let ((next (cdr (aref data 2))))
1984 (aset data 2 (if (consp next) next (aref data 3))))))
1985 (car (aref data 2)))
1987 (defun replace-match-data (integers reuse &optional new)
1988 "Like `match-data', but markers in REUSE get invalidated.
1989 If NEW is non-nil, it is set and returned instead of fresh data,
1990 but coerced to the correct value of INTEGERS."
1991 (or (and new
1992 (progn
1993 (set-match-data new)
1994 (and (eq new reuse)
1995 (eq (null integers) (markerp (car reuse)))
1996 new)))
1997 (match-data integers reuse t)))
1999 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data
2000 &optional backward)
2002 FIXEDCASE, LITERAL are passed to `replace-match' (which see).
2005 is made (to save time).
2006 MATCH-DATA is used for the replacement, and is a data structure
2007 as returned from the `match-data' function.
2008 In case editing is done, it is changed to use markers. BACKWARD is
2009 used to reverse the replacement direction.
2012 passed in. If LITERAL is set, no checking is done, anyway."
2013 (unless (or literal noedit)
2014 (setq noedit t)
2016 newtext)
2017 (setq newtext
2018 (read-string "Edit replacement string: "
2019 (prog1
2020 (cons
2021 (replace-match "" t t newtext 3)
2022 (1+ (match-beginning 3)))
2023 (setq match-data
2024 (replace-match-data
2025 nil match-data match-data))))
2026 noedit nil)))
2027 (set-match-data match-data)
2028 (replace-match newtext fixedcase literal)
2029 ;; `replace-match' leaves point at the end of the replacement text,
2030 ;; so move point to the beginning when replacing backward.
2031 (when backward (goto-char (nth 0 match-data)))
2032 noedit)
2034 (defvar replace-update-post-hook nil
2035 "Function(s) to call after query-replace has found a match in the buffer.")
2037 (defvar replace-search-function nil
2038 "Function to use when searching for strings to replace.
2039 It is used by `query-replace' and `replace-string', and is called
2040 with three arguments, as if it were `search-forward'.")
2042 (defvar replace-re-search-function nil
2043 "Function to use when searching for regexps to replace.
2044 It is used by `query-replace-regexp', `replace-regexp',
2045 `query-replace-regexp-eval', and `map-query-replace-regexp'.
2046 It is called with three arguments, as if it were
2047 `re-search-forward'.")
2049 (defun replace-search (search-string limit regexp-flag delimited-flag
2050 case-fold &optional backward)
2051 "Search for the next occurrence of SEARCH-STRING to replace."
2052 ;; Let-bind global isearch-* variables to values used
2053 ;; to search the next replacement. These let-bindings
2054 ;; should be effective both at the time of calling
2055 ;; `isearch-search-fun-default' and also at the
2056 ;; time of funcalling `search-function'.
2057 ;; These isearch-* bindings can't be placed higher
2058 ;; outside of this function because then another I-search
2059 ;; used after `recursive-edit' might override them.
2060 (let* ((isearch-regexp regexp-flag)
2061 (isearch-regexp-function (or delimited-flag
2062 (and replace-char-fold
2063 (not regexp-flag)
2064 #'char-fold-to-regexp)))
2065 (isearch-lax-whitespace
2066 replace-lax-whitespace)
2067 (isearch-regexp-lax-whitespace
2068 replace-regexp-lax-whitespace)
2069 (isearch-case-fold-search case-fold)
2070 (isearch-adjusted nil)
2071 (isearch-nonincremental t) ; don't use lax word mode
2072 (isearch-forward (not backward))
2073 (search-function
2074 (or (if regexp-flag
2075 replace-re-search-function
2076 replace-search-function)
2077 (isearch-search-fun-default))))
2078 (funcall search-function search-string limit t)))
2080 (defvar replace-overlay nil)
2082 (defun replace-highlight (match-beg match-end range-beg range-end
2083 search-string regexp-flag delimited-flag
2084 case-fold &optional backward)
2085 (if query-replace-highlight
2086 (if replace-overlay
2087 (move-overlay replace-overlay match-beg match-end (current-buffer))
2088 (setq replace-overlay (make-overlay match-beg match-end))
2089 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
2090 (overlay-put replace-overlay 'face 'query-replace)))
2091 (if query-replace-lazy-highlight
2092 (let ((isearch-string search-string)
2093 (isearch-regexp regexp-flag)
2094 (isearch-regexp-function delimited-flag)
2095 (isearch-lax-whitespace
2096 replace-lax-whitespace)
2097 (isearch-regexp-lax-whitespace
2098 replace-regexp-lax-whitespace)
2099 (isearch-case-fold-search case-fold)
2100 (isearch-forward (not backward))
2101 (isearch-other-end match-beg)
2102 (isearch-error nil))
2103 (isearch-lazy-highlight-new-loop range-beg range-end))))
2105 (defun replace-dehighlight ()
2106 (when replace-overlay
2107 (delete-overlay replace-overlay))
2108 (when query-replace-lazy-highlight
2109 (lazy-highlight-cleanup lazy-highlight-cleanup)
2110 (setq isearch-lazy-highlight-last-string nil))
2111 ;; Close overlays opened by `isearch-range-invisible' in `perform-replace'.
2112 (isearch-clean-overlays))
2114 (defun perform-replace (from-string replacements
2115 query-flag regexp-flag delimited-flag
2116 &optional repeat-count map start end backward region-noncontiguous-p)
2117 "Subroutine of `query-replace'. Its complexity handles interactive queries.
2118 Don't use this in your own program unless you want to query and set the mark
2119 just as `query-replace' does. Instead, write a simple loop like this:
2124 which will run faster and probably do exactly what you want. Please
2125 see the documentation of `replace-match' to find out how to simulate
2126 `case-replace'.
2128 This function returns nil if and only if there were no matches to
2129 make, or the user didn't cancel the call.
2131 REPLACEMENTS is either a string, a list of strings, or a cons cell
2132 containing a function and its first argument. The function is
2133 called to generate each replacement like this:
2134 (funcall (car replacements) (cdr replacements) replace-count)
2135 It must return a string."
2136 (or map (setq map query-replace-map))
2137 (and query-flag minibuffer-auto-raise
2138 (raise-frame (window-frame (minibuffer-window))))
2139 (let* ((case-fold-search
2140 (if (and case-fold-search search-upper-case)
2141 (isearch-no-upper-case-p from-string regexp-flag)
2142 case-fold-search))
2143 (nocasify (not (and case-replace case-fold-search)))
2144 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
2145 (search-string from-string)
2146 (real-match-data nil) ; The match data for the current match.
2147 (next-replacement nil)
2148 ;; This is non-nil if we know there is nothing for the user
2149 ;; to edit in the replacement.
2150 (noedit nil)
2151 (keep-going t)
2152 (stack nil)
2153 (search-string-replaced nil) ; last string matching `from-string'
2154 (next-replacement-replaced nil) ; replacement string
2155 ; (substituted regexp)
2156 (last-was-undo)
2157 (replace-count 0)
2158 (skip-read-only-count 0)
2159 (skip-filtered-count 0)
2160 (skip-invisible-count 0)
2161 (nonempty-match nil)
2162 (multi-buffer nil)
2163 (recenter-last-op nil) ; Start cycling order with initial position.
2165 ;; If non-nil, it is marker saying where in the buffer to stop.
2166 (limit nil)
2167 ;; Use local binding in add-function below.
2168 (isearch-filter-predicate isearch-filter-predicate)
2169 (region-bounds nil)
2171 ;; Data for the next match. If a cons, it has the same format as
2172 ;; (match-data); otherwise it is t if a match is possible at point.
2173 (match-again t)
2175 (message
2176 (if query-flag
2177 (apply 'propertize
2178 (substitute-command-keys
2180 minibuffer-prompt-properties))))
2182 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
2183 (when region-noncontiguous-p
2184 (setq region-bounds
2185 (mapcar (lambda (position)
2186 (cons (copy-marker (car position))
2187 (copy-marker (cdr position))))
2188 (funcall region-extract-function 'bounds)))
2189 (add-function :after-while isearch-filter-predicate
2190 (lambda (start end)
2191 (delq nil (mapcar
2192 (lambda (bounds)
2193 (and
2194 (>= start (car bounds))
2195 (<= start (cdr bounds))
2196 (>= end (car bounds))
2197 (<= end (cdr bounds))))
2198 region-bounds)))))
2200 ;; If region is active, in Transient Mark mode, operate on region.
2201 (if backward
2202 (when end
2203 (setq limit (copy-marker (min start end)))
2204 (goto-char (max start end))
2205 (deactivate-mark))
2206 (when start
2207 (setq limit (copy-marker (max start end)))
2208 (goto-char (min start end))
2209 (deactivate-mark)))
2211 ;; If last typed key in previous call of multi-buffer perform-replace
2212 ;; was `automatic-all', don't ask more questions in next files
2213 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
2214 (setq query-flag nil multi-buffer t))
2216 (cond
2217 ((stringp replacements)
2218 (setq next-replacement replacements
2219 replacements nil))
2220 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
2221 (or repeat-count (setq repeat-count 1))
2222 (setq replacements (cons 'replace-loop-through-replacements
2223 (vector repeat-count repeat-count
2224 replacements replacements)))))
2226 (when query-replace-lazy-highlight
2227 (setq isearch-lazy-highlight-last-string nil))
2229 (push-mark)
2230 (undo-boundary)
2231 (unwind-protect
2232 ;; Loop finding occurrences that perhaps should be replaced.
2233 (while (and keep-going
2234 (if backward
2235 (not (or (bobp) (and limit (<= (point) limit))))
2236 (not (or (eobp) (and limit (>= (point) limit)))))
2237 ;; Use the next match if it is already known;
2238 ;; otherwise, search for a match after moving forward
2239 ;; one char if progress is required.
2240 (setq real-match-data
2241 (cond ((consp match-again)
2242 (goto-char (if backward
2243 (nth 0 match-again)
2244 (nth 1 match-again)))
2245 (replace-match-data
2246 t real-match-data match-again))
2247 ;; MATCH-AGAIN non-nil means accept an
2248 ;; adjacent match.
2249 (match-again
2250 (and
2251 (replace-search search-string limit
2252 regexp-flag delimited-flag
2253 case-fold-search backward)
2254 ;; For speed, use only integers and
2255 ;; reuse the list used last time.
2256 (replace-match-data t real-match-data)))
2257 ((and (if backward
2258 (> (1- (point)) (point-min))
2259 (< (1+ (point)) (point-max)))
2260 (or (null limit)
2261 (if backward
2262 (> (1- (point)) limit)
2263 (< (1+ (point)) limit))))
2264 ;; If not accepting adjacent matches,
2265 ;; move one char to the right before
2266 ;; searching again. Undo the motion
2267 ;; if the search fails.
2268 (let ((opoint (point)))
2269 (forward-char (if backward -1 1))
2270 (if (replace-search search-string limit
2271 regexp-flag delimited-flag
2272 case-fold-search backward)
2273 (replace-match-data
2274 t real-match-data)
2275 (goto-char opoint)
2276 nil))))))
2278 ;; Record whether the match is nonempty, to avoid an infinite loop
2279 ;; repeatedly matching the same empty string.
2280 (setq nonempty-match
2281 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
2283 ;; If the match is empty, record that the next one can't be
2284 ;; adjacent.
2286 ;; Otherwise, if matching a regular expression, do the next
2287 ;; match now, since the replacement for this match may
2288 ;; affect whether the next match is adjacent to this one.
2289 ;; If that match is empty, don't use it.
2290 (setq match-again
2291 (and nonempty-match
2292 (or (not regexp-flag)
2293 (and (if backward
2294 (looking-back search-string nil)
2295 (looking-at search-string))
2296 (let ((match (match-data)))
2297 (and (/= (nth 0 match) (nth 1 match))
2298 match))))))
2300 (cond
2301 ;; Optionally ignore matches that have a read-only property.
2302 ((not (or (not query-replace-skip-read-only)
2303 (not (text-property-not-all
2304 (nth 0 real-match-data) (nth 1 real-match-data)
2305 'read-only nil))))
2306 (setq skip-read-only-count (1+ skip-read-only-count)))
2307 ;; Optionally filter out matches.
2308 ((not (funcall isearch-filter-predicate
2309 (nth 0 real-match-data) (nth 1 real-match-data)))
2310 (setq skip-filtered-count (1+ skip-filtered-count)))
2311 ;; Optionally ignore invisible matches.
2312 ((not (or (eq search-invisible t)
2313 ;; Don't open overlays for automatic replacements.
2314 (and (not query-flag) search-invisible)
2315 ;; Open hidden overlays for interactive replacements.
2316 (not (isearch-range-invisible
2317 (nth 0 real-match-data) (nth 1 real-match-data)))))
2318 (setq skip-invisible-count (1+ skip-invisible-count)))
2319 (t
2320 ;; Calculate the replacement string, if necessary.
2321 (when replacements
2322 (set-match-data real-match-data)
2323 (setq next-replacement
2324 (funcall (car replacements) (cdr replacements)
2325 replace-count)))
2326 (if (not query-flag)
2327 (progn
2328 (unless (or literal noedit)
2329 (replace-highlight
2330 (nth 0 real-match-data) (nth 1 real-match-data)
2331 start end search-string
2332 regexp-flag delimited-flag case-fold-search backward))
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 (undo-boundary)
2339 (let (done replaced key def)
2340 ;; Loop reading commands until one of them sets done,
2341 ;; which means it has finished handling this
2342 ;; occurrence. Any command that sets `done' should
2343 ;; leave behind proper match data for the stack.
2344 ;; Commands not setting `done' need to adjust
2345 ;; `real-match-data'.
2346 (while (not done)
2347 (set-match-data real-match-data)
2348 (run-hooks 'replace-update-post-hook) ; Before `replace-highlight'.
2349 (replace-highlight
2350 (match-beginning 0) (match-end 0)
2351 start end search-string
2352 regexp-flag delimited-flag case-fold-search backward)
2353 ;; Obtain the matched groups: needed only when
2354 ;; regexp-flag non nil.
2355 (when (and last-was-undo regexp-flag)
2356 (setq last-was-undo nil
2357 real-match-data
2358 (save-excursion
2359 (goto-char (match-beginning 0))
2360 (looking-at search-string)
2361 (match-data t real-match-data))))
2362 ;; Matched string and next-replacement-replaced
2363 ;; stored in stack.
2364 (setq search-string-replaced (buffer-substring-no-properties
2365 (match-beginning 0)
2366 (match-end 0))
2367 next-replacement-replaced
2368 (query-replace-descr
2369 (save-match-data
2370 (set-match-data real-match-data)
2371 (match-substitute-replacement
2372 next-replacement nocasify literal))))
2373 ;; Bind message-log-max so we don't fill up the
2374 ;; message log with a bunch of identical messages.
2375 (let ((message-log-max nil)
2376 (replacement-presentation
2377 (if query-replace-show-replacement
2378 (save-match-data
2379 (set-match-data real-match-data)
2380 (match-substitute-replacement next-replacement
2381 nocasify literal))
2382 next-replacement)))
2383 (message message
2384 (query-replace-descr from-string)
2385 (query-replace-descr replacement-presentation)))
2386 (setq key (read-event))
2387 ;; Necessary in case something happens during
2388 ;; read-event that clobbers the match data.
2389 (set-match-data real-match-data)
2390 (setq key (vector key))
2391 (setq def (lookup-key map key))
2392 ;; Restore the match data while we process the command.
2393 (cond ((eq def 'help)
2394 (with-output-to-temp-buffer "*Help*"
2395 (princ
2396 (concat "Query replacing "
2397 (if delimited-flag
2398 (or (and (symbolp delimited-flag)
2399 (get delimited-flag
2400 'isearch-message-prefix))
2401 "word ") "")
2402 (if regexp-flag "regexp " "")
2403 (if backward "backward " "")
2404 from-string " with "
2406 (substitute-command-keys
2407 query-replace-help)))
2408 (with-current-buffer standard-output
2409 (help-mode))))
2410 ((eq def 'exit)
2411 (setq keep-going nil)
2412 (setq done t))
2413 ((eq def 'exit-current)
2414 (setq multi-buffer t keep-going nil done t))
2415 ((eq def 'backup)
2416 (if stack
2417 (let ((elt (pop stack)))
2418 (goto-char (nth 0 elt))
2419 (setq replaced (nth 1 elt)
2420 real-match-data
2421 (replace-match-data
2422 t real-match-data
2423 (nth 2 elt))))
2424 (message "No previous match")
2425 (ding 'no-terminate)
2426 (sit-for 1)))
2427 ((or (eq def 'undo) (eq def 'undo-all))
2428 (if (null stack)
2429 (progn
2430 (message "Nothing to undo")
2431 (ding 'no-terminate)
2432 (sit-for 1))
2433 (let ((stack-idx 0)
2434 (stack-len (length stack))
2435 (num-replacements 0)
2436 search-string
2437 next-replacement)
2438 (while (and (< stack-idx stack-len)
2439 stack
2440 (null replaced))
2441 (let* ((elt (nth stack-idx stack)))
2442 (setq
2443 stack-idx (1+ stack-idx)
2444 replaced (nth 1 elt)
2445 ;; Bind swapped values
2446 ;; (search-string <--> replacement)
2447 search-string (nth (if replaced 4 3) elt)
2448 next-replacement (nth (if replaced 3 4) elt)
2449 search-string-replaced search-string
2450 next-replacement-replaced next-replacement)
2452 (when (and (= stack-idx stack-len)
2453 (null replaced)
2454 (zerop num-replacements))
2455 (message "Nothing to undo")
2456 (ding 'no-terminate)
2457 (sit-for 1))
2459 (when replaced
2460 (setq stack (nthcdr stack-idx stack))
2461 (goto-char (nth 0 elt))
2462 (set-match-data (nth 2 elt))
2463 (setq real-match-data
2464 (save-excursion
2465 (goto-char (match-beginning 0))
2466 (looking-at search-string)
2467 (match-data t (nth 2 elt)))
2468 noedit
2469 (replace-match-maybe-edit
2470 next-replacement nocasify literal
2471 noedit real-match-data backward)
2472 replace-count (1- replace-count)
2473 real-match-data
2474 (save-excursion
2475 (goto-char (match-beginning 0))
2476 (looking-at next-replacement)
2477 (match-data t (nth 2 elt))))
2478 ;; Set replaced nil to keep in loop
2479 (when (eq def 'undo-all)
2480 (setq replaced nil
2481 stack-len (- stack-len stack-idx)
2482 stack-idx 0
2483 num-replacements
2484 (1+ num-replacements))))))
2485 (when (and (eq def 'undo-all)
2486 (null (zerop num-replacements)))
2487 (message "Undid %d %s" num-replacements
2488 (if (= num-replacements 1)
2489 "replacement"
2490 "replacements"))
2491 (ding 'no-terminate)
2492 (sit-for 1)))
2493 (setq replaced nil last-was-undo t)))
2494 ((eq def 'act)
2495 (or replaced
2496 (setq noedit
2497 (replace-match-maybe-edit
2498 next-replacement nocasify literal
2499 noedit real-match-data backward)
2500 replace-count (1+ replace-count)))
2501 (setq done t replaced t))
2502 ((eq def 'act-and-exit)
2503 (or replaced
2504 (setq noedit
2505 (replace-match-maybe-edit
2506 next-replacement nocasify literal
2507 noedit real-match-data backward)
2508 replace-count (1+ replace-count)))
2509 (setq keep-going nil)
2510 (setq done t replaced t))
2511 ((eq def 'act-and-show)
2512 (if (not replaced)
2513 (setq noedit
2514 (replace-match-maybe-edit
2515 next-replacement nocasify literal
2516 noedit real-match-data backward)
2517 replace-count (1+ replace-count)
2518 real-match-data (replace-match-data
2519 t real-match-data)
2520 replaced t)))
2521 ((or (eq def 'automatic) (eq def 'automatic-all))
2522 (or replaced
2523 (setq noedit
2524 (replace-match-maybe-edit
2525 next-replacement nocasify literal
2526 noedit real-match-data backward)
2527 replace-count (1+ replace-count)))
2528 (setq done t query-flag nil replaced t)
2529 (if (eq def 'automatic-all) (setq multi-buffer t)))
2530 ((eq def 'skip)
2531 (setq done t))
2532 ((eq def 'recenter)
2533 ;; `this-command' has the value `query-replace',
2534 ;; so we need to bind it to `recenter-top-bottom'
2535 ;; to allow it to detect a sequence of `C-l'.
2536 (let ((this-command 'recenter-top-bottom)
2537 (last-command 'recenter-top-bottom))
2538 (recenter-top-bottom)))
2539 ((eq def 'edit)
2540 (let ((opos (point-marker)))
2541 (setq real-match-data (replace-match-data
2542 nil real-match-data
2543 real-match-data))
2544 (goto-char (match-beginning 0))
2545 (save-excursion
2546 (save-window-excursion
2547 (recursive-edit)))
2548 (goto-char opos)
2549 (set-marker opos nil))
2550 ;; Before we make the replacement,
2551 ;; decide whether the search string
2552 ;; can match again just after this match.
2553 (if (and regexp-flag nonempty-match)
2554 (setq match-again (and (looking-at search-string)
2555 (match-data)))))
2556 ;; Edit replacement.
2557 ((eq def 'edit-replacement)
2558 (setq real-match-data (replace-match-data
2559 nil real-match-data
2560 real-match-data)
2561 next-replacement
2562 (read-string "Edit replacement string: "
2563 next-replacement)
2564 noedit nil)
2565 (if replaced
2566 (set-match-data real-match-data)
2567 (setq noedit
2568 (replace-match-maybe-edit
2569 next-replacement nocasify literal noedit
2570 real-match-data backward)
2571 replaced t))
2572 (setq done t))
2574 ((eq def 'delete-and-edit)
2575 (replace-match "" t t)
2576 (setq real-match-data (replace-match-data
2577 nil real-match-data))
2578 (replace-dehighlight)
2579 (save-excursion (recursive-edit))
2580 (setq replaced t))
2581 ;; Note: we do not need to treat `exit-prefix'
2582 ;; specially here, since we reread
2583 ;; any unrecognized character.
2584 (t
2585 (setq this-command 'mode-exited)
2586 (setq keep-going nil)
2587 (setq unread-command-events
2588 (append (listify-key-sequence key)
2589 unread-command-events))
2590 (setq done t)))
2591 (when query-replace-lazy-highlight
2592 ;; Force lazy rehighlighting only after replacements.
2593 (if (not (memq def '(skip backup)))
2594 (setq isearch-lazy-highlight-last-string nil)))
2595 (unless (eq def 'recenter)
2596 ;; Reset recenter cycling order to initial position.
2597 (setq recenter-last-op nil)))
2598 ;; Record previous position for ^ when we move on.
2599 ;; Change markers to numbers in the match data
2600 ;; since lots of markers slow down editing.
2601 (push (list (point) replaced
2602 ;;; If the replacement has already happened, all we need is the
2603 ;;; current match start and end. We could get this with a trivial
2604 ;;; match like
2605 ;;; (save-excursion (goto-char (match-beginning 0))
2606 ;;; (search-forward (match-string 0))
2607 ;;; (match-data t))
2608 ;;; if we really wanted to avoid manually constructing match data.
2609 ;;; Adding current-buffer is necessary so that match-data calls can
2610 ;;; return markers which are appropriate for editing.
2611 (if replaced
2612 (list
2613 (match-beginning 0)
2614 (match-end 0)
2615 (current-buffer))
2616 (match-data t))
2617 search-string-replaced
2618 next-replacement-replaced)
2619 stack)
2620 (setq next-replacement-replaced nil
2621 search-string-replaced nil))))))
2622 (replace-dehighlight))
2623 (or unread-command-events
2624 (message "Replaced %d occurrence%s%s"
2625 replace-count
2626 (if (= replace-count 1) "" "s")
2627 (if (> (+ skip-read-only-count
2628 skip-filtered-count
2629 skip-invisible-count) 0)
2630 (format " (skipped %s)"
2631 (mapconcat
2632 'identity
2633 (delq nil (list
2634 (if (> skip-read-only-count 0)
2635 (format "%s read-only"
2636 skip-read-only-count))
2637 (if (> skip-invisible-count 0)
2638 (format "%s invisible"
2639 skip-invisible-count))
2640 (if (> skip-filtered-count 0)
2641 (format "%s filtered out"
2642 skip-filtered-count))))
2643 ", "))
2644 "")))
2645 (or (and keep-going stack) multi-buffer)))
2647 (provide 'replace)
2649 ;;; replace.el ends here