| blob | a5548f461d8b2733ddd1d449a1659706b32d2110 |
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 <https://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
83 "String that separates FROM and TO in the history of replacement pairs.
84 When nil, the pair will not be added to the history (same behavior
85 as in emacs 24.5)."
89 string)
93 "History list to use for the FROM argument of `query-replace' commands.
94 The value of this variable should be a symbol; that symbol
95 is used as a variable to hold a history list for the strings
96 or patterns to be replaced."
102 "History list to use for the TO argument of `query-replace' commands.
103 The value of this variable should be a symbol; that symbol
104 is used as a variable to hold a history list for replacement
105 strings or patterns."
111 "Non-nil means `query-replace' and friends ignore read-only matches."
117 "Non-nil means show substituted replacement text in the minibuffer.
118 This variable affects only `query-replace-regexp'."
124 "Non-nil means to highlight matches during query replacement."
129 "Controls the lazy-highlighting during query replacements.
130 When non-nil, all text in the buffer matching the current match
131 is highlighted lazily using isearch lazy highlighting (see
132 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
140 "Face for highlighting query replacement matches."
145 "Number of replacements done so far.
152 "Split string STRING at a substring with property `separator'."
161 length)
162 length)))))
165 "Query and return the `from' argument of a query-replace operation.
166 The return value can also be a pair (FROM . TO) indicating that the user
167 wants to replace FROM with TO."
173 ;; Check if the first non-whitespace char is displayable
177 query-replace-from-to-separator
182 'display separator-string
190 separator
192 query-replace-defaults))
204 ;; The save-excursion here is in case the user marks and copies
205 ;; a region in order to specify the minibuffer input.
206 ;; That should not clobber the region for the query-replace itself.
212 text-property-default-nonsticky)))
225 ;; Warn if user types \n or \t, but don't reject the input.
236 from
242 "Maybe convert a regexp replacement TO to Lisp.
243 Returns a list suitable for `perform-replace' if necessary,
244 the original string if not."
260 ;; Swallow a space after a symbol
261 ;; if there is a space.
263 ;; Swallow a space after 'foo
264 ;; but not after (quote foo).
279 to))
283 "Query and return the `to' argument of a query-replace operation."
289 nil nil nil
290 query-replace-to-history-variable from t)))
293 to))
294 regexp-flag))
306 (defun query-replace (from-string to-string &optional delimited start end backward region-noncontiguous-p)
307 "Replace some occurrences of FROM-STRING with TO-STRING.
308 As each match is found, the user must type a character saying
311 In Transient Mark mode, if the mark is active, operate on the contents
312 of the region. Otherwise, operate from point to the end of the buffer's
313 accessible portion.
315 In interactive use, the prefix arg (non-nil DELIMITED in
316 non-interactive use), means replace only matches surrounded by
317 word boundaries. A negative prefix arg means replace backward.
320 to pull the last incremental search string to the minibuffer
321 that reads FROM-STRING, or invoke replacements from
322 incremental search with a key sequence like `C-s C-s M-%'
323 to use its current search string as the string to replace.
325 Matching is independent of case if `case-fold-search' is non-nil and
326 FROM-STRING has no uppercase letters. Replacement transfers the case
327 pattern of the old text to the new text, if `case-replace' and
328 `case-fold-search' are non-nil and FROM-STRING has no uppercase
329 letters. (Transferring the case pattern means that if the old text
330 matched is all caps, or capitalized, then its replacement is upcased
331 or capitalized.)
333 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
334 ignore hidden matches if `search-invisible' is nil, and ignore more
335 matches using `isearch-filter-predicate'.
337 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
338 to be replaced will match a sequence of whitespace chars defined by the
339 regexp in `search-whitespace-regexp'.
341 If `replace-char-fold' is non-nil, matching uses character folding,
342 i.e. it ignores diacritics and other differences between equivalent
343 character strings.
345 Fourth and fifth arg START and END specify the region to operate on.
347 To customize possible responses, change the bindings in `query-replace-map'."
356 nil)))
358 ;; These are done separately here
359 ;; so that command-history will record these expressions
360 ;; rather than the values they had this time.
365 (perform-replace from-string to-string t nil delimited nil nil start end backward region-noncontiguous-p))
369 (defun query-replace-regexp (regexp to-string &optional delimited start end backward region-noncontiguous-p)
370 "Replace some things after point matching REGEXP with TO-STRING.
371 As each match is found, the user must type a character saying
374 In Transient Mark mode, if the mark is active, operate on the contents
375 of the region. Otherwise, operate from point to the end of the buffer's
376 accessible portion.
379 to pull the last incremental search regexp to the minibuffer
380 that reads REGEXP, or invoke replacements from
381 incremental search with a key sequence like `C-M-s C-M-s C-M-%'
382 to use its current search regexp as the regexp to replace.
384 Matching is independent of case if `case-fold-search' is non-nil and
385 REGEXP has no uppercase letters. Replacement transfers the case
386 pattern of the old text to the new text, if `case-replace' and
387 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
388 \(Transferring the case pattern means that if the old text matched is
389 all caps, or capitalized, then its replacement is upcased or
390 capitalized.)
392 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
393 ignore hidden matches if `search-invisible' is nil, and ignore more
394 matches using `isearch-filter-predicate'.
396 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
397 to be replaced will match a sequence of whitespace chars defined by the
398 regexp in `search-whitespace-regexp'.
400 This function is not affected by `replace-char-fold'.
402 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
403 only matches surrounded by word boundaries. A negative prefix arg means
404 replace backward.
406 Fourth and fifth arg START and END specify the region to operate on.
411 counted from 1.
413 at the given position for each replacement.
416 followed by a Lisp expression. Each
417 replacement evaluates that expression to compute the replacement
420 for the whole or a partial match converted to a number with
422 done so far (starting with zero).
424 If the replacement expression is a symbol, write a space after it
425 to terminate it. One space there, if any, will be discarded.
427 When using those Lisp features interactively in the replacement
428 text, TO-STRING is actually made a list instead of a string.
437 " regexp"
439 t)))
441 ;; These are done separately here
442 ;; so that command-history will record these expressions
443 ;; rather than the values they had this time.
448 (perform-replace regexp to-string t t delimited nil nil start end backward region-noncontiguous-p))
453 "Replace some things after point matching REGEXP with the result of TO-EXPR.
455 Interactive use of this function is deprecated in favor of the
457 using `search-forward-regexp' and `replace-match' is preferred.
459 As each match is found, the user must type a character saying
462 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
463 reference `replace-count' to get the number of replacements already made.
464 If the result of TO-EXPR is not a string, it is converted to one using
465 `prin1-to-string' with the NOESCAPE argument (which see).
470 in REGEXP.
475 In Transient Mark mode, if the mark is active, operate on the contents
476 of the region. Otherwise, operate from point to the end of the buffer's
477 accessible portion.
480 to pull the last incremental search regexp to the minibuffer
481 that reads REGEXP.
483 Preserves case in each replacement if `case-replace' and `case-fold-search'
484 are non-nil and REGEXP has no uppercase letters.
486 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
487 ignore hidden matches if `search-invisible' is nil, and ignore more
488 matches using `isearch-filter-predicate'.
490 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
491 to be replaced will match a sequence of whitespace chars defined by the
492 regexp in `search-whitespace-regexp'.
494 This function is not affected by `replace-char-fold'.
496 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
497 only matches that are surrounded by word boundaries.
498 Fourth and fifth arg START and END specify the region to operate on."
500 for interactive calls, and `search-forward-regexp'/`replace-match'
506 ;; Let-bind the history var to disable the "foo -> bar"
507 ;; default. Maybe we shouldn't disable this default, but
508 ;; for now I'll leave it off. --Stef
514 nil nil t query-replace-to-history-variable from t))))
515 ;; We make TO a list because replace-match-string-symbols requires one,
516 ;; and the user might enter a single token.
525 "Replace some matches for REGEXP with various strings, in rotation.
526 The second argument TO-STRINGS contains the replacement strings, separated
527 by spaces. This command works like `query-replace-regexp' except that
528 each successive replacement uses the next successive replacement string,
529 wrapping around from the last such string to the first.
531 In Transient Mark mode, if the mark is active, operate on the contents
532 of the region. Otherwise, operate from point to the end of the buffer's
533 accessible portion.
535 Non-interactively, TO-STRINGS may be a list of replacement strings.
537 Interactively, reads the regexp using `read-regexp'.
539 to pull the last incremental search regexp to the minibuffer
540 that reads REGEXP.
542 A prefix argument N says to use each replacement string N times
543 before rotating to the next.
544 Fourth and fifth arg START and END specify the region to operate on."
547 query-replace-from-history-variable))
551 nil nil nil
552 query-replace-to-history-variable from t)))
574 "Replace occurrences of FROM-STRING with TO-STRING.
575 Preserve case in each match if `case-replace' and `case-fold-search'
576 are non-nil and FROM-STRING has no uppercase letters.
577 \(Preserving case means that if the string matched is all caps, or capitalized,
578 then its replacement is upcased or capitalized.)
580 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
581 ignore hidden matches if `search-invisible' is nil, and ignore more
582 matches using `isearch-filter-predicate'.
584 If `replace-lax-whitespace' is non-nil, a space or spaces in the string
585 to be replaced will match a sequence of whitespace chars defined by the
586 regexp in `search-whitespace-regexp'.
588 If `replace-char-fold' is non-nil, matching uses character folding,
589 i.e. it ignores diacritics and other differences between equivalent
590 character strings.
592 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
593 only matches surrounded by word boundaries. A negative prefix arg means
594 replace backward.
596 Operates on the region between START and END (if both are nil, from point
597 to the end of the buffer). Interactively, if Transient Mark mode is
598 enabled and the mark is active, operates on the contents of the region;
599 otherwise from point to the end of the buffer's accessible portion.
602 to pull the last incremental search string to the minibuffer
603 that reads FROM-STRING.
605 This function is usually the wrong thing to use in a Lisp program.
606 What you probably want is a loop like this:
607 (while (search-forward FROM-STRING nil t)
608 (replace-match TO-STRING nil t))
609 which will run faster and will not set the mark or print anything.
610 \(You may need a more complex loop if FROM-STRING can match the null string
611 and TO-STRING is also null.)"
621 " string"
623 nil)))
631 "Replace things after point matching REGEXP with TO-STRING.
632 Preserve case in each match if `case-replace' and `case-fold-search'
633 are non-nil and REGEXP has no uppercase letters.
635 Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
636 ignore hidden matches if `search-invisible' is nil, and ignore more
637 matches using `isearch-filter-predicate'.
639 If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
640 to be replaced will match a sequence of whitespace chars defined by the
641 regexp in `search-whitespace-regexp'.
643 This function is not affected by `replace-char-fold'
645 In Transient Mark mode, if the mark is active, operate on the contents
646 of the region. Otherwise, operate from point to the end of the buffer's
647 accessible portion.
649 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
650 only matches surrounded by word boundaries. A negative prefix arg means
651 replace backward.
653 Fourth and fifth arg START and END specify the region to operate on.
659 at the given position for each replacement.
662 followed by a Lisp expression used as part of the replacement
666 `replace-count', the number of replacements occurred so far, starting
667 from zero.
669 If your Lisp expression is an identifier and the next letter in
670 the replacement string would be interpreted as part of it, you
673 replacement text directly.
675 When using those Lisp features interactively in the replacement
676 text, TO-STRING is actually made a list instead of a string.
680 to pull the last incremental search regexp to the minibuffer
681 that reads REGEXP.
683 This function is usually the wrong thing to use in a Lisp program.
684 What you probably want is a loop like this:
685 (while (re-search-forward REGEXP nil t)
686 (replace-match TO-STRING nil nil))
687 which will run faster and will not set the mark or print anything."
697 " regexp"
699 t)))
706 \f
708 "History list for some commands that read regular expressions.
710 Maximum length of the history list is determined by the value
717 "Function that provides default regexp(s) for `read-regexp'.
718 This function should take no arguments and return one of: nil, a
719 regexp, or a list of regexps. Interactively, `read-regexp' uses
720 the return value of this function for its DEFAULT argument.
722 As an example, set this variable to `find-tag-default-as-regexp'
723 to default to the symbol at point.
725 To provide different default regexps for different commands,
726 the function that you set this to can check `this-command'."
731 find-tag-default)
733 find-tag-default-as-regexp)
735 find-tag-default-as-symbol-regexp)
741 "Return a list of standard suggestions for `read-regexp'.
742 By default, the list includes the tag at point, the last isearch regexp,
743 the last isearch string, and the last replacement regexp. `read-regexp'
744 appends the list returned by this function to the end of values available
754 "Read and return a regular expression as a string.
757 possibly preceded by the default result (see below).
759 The optional argument DEFAULTS can be either: nil, a string, a list
760 of strings, or a symbol. We use DEFAULTS to construct the default
761 return value in case of empty input.
763 If DEFAULTS is a string, we use it as-is.
765 If DEFAULTS is a list of strings, the first element is the
766 default return value, but all the elements are accessible
769 If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
770 is non-nil, we use that in place of DEFAULTS in the following:
771 If DEFAULTS is the symbol `regexp-history-last', we use the first
772 element of HISTORY (if specified) or `regexp-history'.
773 If DEFAULTS is a function, we call it with no arguments and use
774 what it returns, which should be either nil, a string, or a list of strings.
776 We append the standard values from `read-regexp-suggestions' to DEFAULTS
777 before using it.
779 If the first element of DEFAULTS is non-nil (and if PROMPT does not end
782 The optional argument HISTORY is a symbol to use for the history list.
783 If nil, uses `regexp-history'."
792 defaults))
797 ;; Do not automatically add default to the history for empty input.
801 prompt)
809 ;; Return the default value when the user enters empty input.
813 ;; Otherwise, add non-empty input to the history and return input.
824 "Read arguments for `keep-lines' and friends.
825 Prompt for a regexp with PROMPT.
826 Value is a list, (REGEXP)."
830 "Delete all lines except those containing matches for REGEXP.
831 A match split across lines preserves all the lines it lies in.
832 When called from Lisp (and usually interactively as well, see below)
833 applies to all lines starting after point.
836 and `search-upper-case' is non-nil, the matching is case-sensitive.
838 Second and third arg RSTART and REND specify the region to operate on.
839 This command operates on (the accessible part of) all lines whose
840 accessible part is entirely contained in the region determined by RSTART
841 and REND. (A newline ending a line counts as part of that line.)
843 Interactively, in Transient Mark mode when the mark is active, operate
844 on all lines whose accessible part is entirely contained in the region.
845 Otherwise, the command applies to all lines starting after point.
846 When calling this function from Lisp, you can pretend that it was
847 called interactively by passing a non-nil INTERACTIVE argument.
849 This function starts looking for the next match from the end of
850 the previous match. Hence, it ignores matches that overlap
851 a previously found match."
882 case-fold-search)))
884 ;; Start is first char not preserved by previous match.
890 ;; Now end is first char preserved by the new match.
895 ;; If the match was empty, avoid matching again at same place.
900 nil)
904 "Delete lines containing matches for REGEXP.
905 When called from Lisp (and usually when called interactively as
906 well, see below), applies to the part of the buffer after point.
907 The line point is in is deleted if and only if it contains a
908 match for regexp starting after point.
911 and `search-upper-case' is non-nil, the matching is case-sensitive.
913 Second and third arg RSTART and REND specify the region to operate on.
914 Lines partially contained in this region are deleted if and only if
915 they contain a match entirely contained in it.
917 Interactively, in Transient Mark mode when the mark is active, operate
918 on the contents of the region. Otherwise, operate from point to the
919 end of (the accessible portion of) the buffer. When calling this function
920 from Lisp, you can pretend that it was called interactively by passing
921 a non-nil INTERACTIVE argument.
923 If a match is split across lines, all the lines it lies in are deleted.
924 They are deleted _before_ looking for the next match. Hence, a match
925 starting on the same line at which another match ended is ignored."
943 case-fold-search)))
952 nil)
956 "Print and return number of matches for REGEXP following point.
957 When called from Lisp and INTERACTIVE is omitted or nil, just return
958 the number, do not print it; if INTERACTIVE is t, the function behaves
959 in all respects as if it had been called interactively.
962 and `search-upper-case' is non-nil, the matching is case-sensitive.
964 Second and third arg RSTART and REND specify the region to operate on.
966 Interactively, in Transient Mark mode when the mark is active, operate
967 on the contents of the region. Otherwise, operate from point to the
968 end of (the accessible portion of) the buffer.
970 This function starts looking for the next match from the end of
971 the previous match. Hence, it ignores matches that overlap
972 a previously found match."
990 opoint
994 case-fold-search)))
1002 count
1004 count)))
1006 \f
1011 next-error-follow-minor-mode
1014 next-error-follow-minor-mode))))
1050 map)
1055 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
1068 map)
1072 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
1078 "Hook run when entering Occur mode."
1083 "Hook run by Occur when there are any matches."
1088 "Hook run by Occur after locating an occurrence.
1089 This will be called with the cursor position at the occurrence. An application
1090 for this is to reveal context in an outline-mode when the occurrence is hidden."
1105 \f
1106 ;;; Occur Edit mode
1116 map)
1120 "Major mode for editing *Occur* buffers.
1121 In this mode, changes to the *Occur* buffer are also applied to
1122 the originating buffer.
1131 "Switch from Occur Edit mode to Occur mode."
1143 col)
1147 ;; Apply occur-target property to inserted (e.g. yanked) text.
1149 ;; Did we insert a newline? Occur Edit mode can't create new
1150 ;; Occur entries; just discard everything after the newline.
1164 line-beg 'occur-prefix nil
1165 line-end))
1177 \f
1179 "Handle `revert-buffer' for Occur mode buffers."
1188 pos))
1192 "Go to the occurrence on the current line."
1196 ;; Actually `event-end' works correctly with a nil argument as
1197 ;; well, so we could dispense with this test, but let's not
1198 ;; rely on this undocumented behavior.
1209 "Go to the occurrence the current line describes, in another window."
1217 "Display in another window the occurrence the current line describes."
1220 window)
1222 ;; This is the way to set point in the proper window.
1242 "Move to the Nth (default 1) next match in an Occur mode buffer."
1247 "Move to the Nth (default 1) previous match in an Occur mode buffer."
1252 "Move to the Nth (default 1) next match in an Occur mode buffer.
1255 ;; we need to run occur-find-match from within the Occur buffer
1257 ;; Choose the buffer and make it current.
1271 #'previous-single-property-change
1274 ;; In case the *Occur* buffer is visible in a nonselected window.
1278 \f
1291 "Face used to highlight matches permanently."
1297 "Default number of context lines included around `list-matching-lines' matches.
1298 A negative number means to include that many lines before the match.
1299 A positive number means to include that many lines both before and after."
1307 If the value is nil, don't highlight the matching portions specially."
1313 If the value is nil, don't highlight the buffer names specially."
1325 Set the point right after such line when there are matches after it."
1332 If the face doesn't differ from the default face,
1333 don't highlight the prefix with line numbers specially."
1340 yank-handler follow-link)
1341 "Text properties to discard when copying lines to the *Occur* buffer.
1342 The value should be a list of text properties to discard or t,
1343 which means to discard all text properties."
1351 "Collect strings matching regexp"
1356 ;; Perform collect operation
1358 ;; No subexpression so collect the entire match.
1360 ;; Get the regexp for collection pattern.
1365 ;; Otherwise normal occur takes numerical prefix argument.
1370 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1371 Here `original-buffer-name' is the buffer name where Occur was originally run.
1372 When given the prefix argument, or called non-interactively, the renaming
1373 will not clobber the existing buffer(s) of that name, but use
1374 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1375 if you always want a separate *Occur* buffer for each buffer where you
1376 invoke `occur'."
1386 ;; Region limits when `occur' applies on a region.
1395 "Show all lines in the current buffer containing a match for REGEXP.
1396 If a match spreads across multiple lines, all those lines are shown.
1398 Each match is extended to include complete lines. Only non-overlapping
1399 matches are considered. (Note that extending matches to complete
1400 lines could cause some of the matches to overlap; if so, they will not
1401 be shown as separate matches.)
1403 Each line is displayed with NLINES lines before and after, or -NLINES
1404 before if NLINES is negative.
1405 NLINES defaults to `list-matching-lines-default-context-lines'.
1406 Interactively it is the prefix arg.
1408 Optional arg REGION, if non-nil, mean restrict search to the
1409 specified region. Otherwise search the entire buffer.
1410 REGION must be a list of (START . END) positions as returned by
1411 `region-bounds'.
1413 The lines are shown in a buffer named `*Occur*'.
1414 It serves as a menu to find any of the occurrences in this buffer.
1416 If `list-matching-lines-jump-to-current-line' is non-nil, then show
1417 the current line highlighted with `list-matching-lines-current-line-face'
1418 and set point at the first match after such line.
1421 and `search-upper-case' is non-nil, the matching is case-sensitive.
1423 When NLINES is a string or when the function is called
1424 interactively with prefix argument without a number (`C-u' alone
1425 as prefix) the matching strings are collected into the `*Occur*'
1426 buffer by using NLINES as a replacement regexp. NLINES may
1430 program. When there is no parenthesized subexpressions in REGEXP
1431 the entire match is collected. In any case the searched buffer
1432 is not modified."
1461 "Show all lines in buffers BUFS containing a match for REGEXP.
1462 This function acts on multiple buffers; otherwise, it is exactly like
1463 `occur'. When you invoke this command interactively, you must specify
1464 the buffer names that you want, one by one.
1465 See also `multi-occur-in-matching-buffers'."
1475 "Next buffer to search (C-j to end): "
1477 nil t))
1486 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1487 Normally BUFREGEXP matches against each buffer's visited file name,
1488 but if you specify a prefix argument, it matches against the buffer name.
1489 See also `multi-occur'."
1496 "List lines in buffers whose names match regexp: "
1499 default
1500 input))
1512 buf))
1534 bufs))))
1535 ;; Handle the case where one of the buffers we're searching is the
1536 ;; output buffer. Just rename it.
1541 ;; Now find or create the output buffer.
1542 ;; If we just renamed that buffer, we will make a new one here.
1550 ;; Don't generate undo entries for creation of the initial contents.
1556 ;; Treat nlines as a regexp to collect.
1564 ;; Insert the replacement regexp.
1573 count)
1574 ;; Perform normal occur.
1576 regexp active-bufs occur-buf
1580 case-fold-search)
1581 list-matching-lines-buffer-name-face
1583 list-matching-lines-prefix-face)
1584 list-matching-lines-face
1593 ;; Don't display regexp if with remaining text
1594 ;; it is longer than window-width.
1596 regexp))
1607 occur--final-pos))
1614 title-face prefix-face match-face keep-props)
1622 ;; Map over all the buffers
1646 ;; Set CODING only if the current buffer locally
1647 ;; binds buffer-file-coding-system.
1657 ;; Get beginning of first match line and end of the last.
1663 ;; Sum line numbers up to the first match line.
1668 ;; Highlight the matches
1671 ;; Count empty lines that don't use next loop (Bug#22062).
1681 ;; Add `match-face' to faces copied from the buffer.
1684 match-face nil curstring))
1685 ;; Avoid infloop (Bug#7593).
1688 ;; Generate the string to insert for this match
1690 ;; Using 7 digits aligns tabs properly.
1696 ;; Allow insertion of text at
1697 ;; the end of the prefix (for
1698 ;; Occur Edit mode).
1699 front-sticky t rear-nonsticky t
1700 occur-target ,marker follow-link t
1703 ;; We don't put `mouse-face' on the newline,
1704 ;; because that loses. And don't put it
1705 ;; on context lines to reduce flicker.
1707 'occur-target marker
1708 'follow-link t
1709 'help-echo
1713 match-prefix
1714 ;; Add non-numeric prefix to all non-first lines
1715 ;; of multi-line matches.
1721 match-str)
1722 ;; Add marker at eol, but no mouse props.
1726 ;; The simple display style
1727 out-line
1728 ;; The complex multi-line display style.
1730 out-line nlines keep-props begpt endpt
1731 curr-line prev-line prev-after-lines
1732 prefix-face))
1733 ;; Set first elem of the returned list to `data',
1734 ;; and the second elem to `prev-after-lines'.
1737 ;; Actually insert the match display data
1747 'face list-matching-lines-current-line-face
1755 ;; Sum line numbers between first and last match lines.
1757 ;; Add 1 for empty last match line since
1758 ;; count-lines returns 1 line less.
1760 ;; On to the next match...
1764 ;; Insert original line if haven't done yet.
1773 'face list-matching-lines-current-line-face
1776 ;; Flush remaining context after-lines.
1780 prev-after-lines prefix-face)))))))
1787 end)
1791 ;; Don't display the same number of lines
1792 ;; and matches in case of 1 match per line.
1796 ;; Don't display regexp for multi-buffer.
1802 occur--region-start
1803 occur--region-end)
1814 ;; Display total match count and regexp for multi-buffer.
1818 end)
1821 ;; Don't display the same number of lines
1822 ;; and matches in case of 1 match per line.
1832 ;; CODING is buffer-file-coding-system of the first buffer
1833 ;; that locally binds it. Let's use it also for the output
1834 ;; buffer.
1836 ;; Return the number of matches
1837 global-matches)))
1848 str)
1858 lines))
1865 result beg end moved)
1877 ;; Generate context display for occur.
1878 ;; OUT-LINE is the line where the match is.
1879 ;; NLINES and KEEP-PROPS are args to occur-engine.
1880 ;; CURR-LINE is line count of the current match,
1881 ;; PREV-LINE is line count of the previous match,
1882 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1883 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1884 ;; then concatenate them all together.
1886 curr-line prev-line prev-after-lines
1888 ;; Find after- and before-context lines of the current match.
1895 separator)
1897 ;; Combine after-lines of the previous match
1898 ;; with before-lines of the current match.
1901 ;; Don't overlap prev after-lines with current before-lines.
1908 ;; Separate non-overlapping context lines with a dashed line.
1912 ;; Don't overlap current before-lines with previous match line.
1914 prev-line)
1918 before-lines))
1919 ;; Separate non-overlapping before-context lines.
1924 ;; Return a list where the first element is the output line.
1932 separator)))
1935 ;; And the second element is the list of context after-lines.
1938 \f
1939 ;; It would be nice to use \\[...], but there is no reasonable way
1940 ;; to make that display both SPC and Y.
1942 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1943 RET or `q' to exit, Period to replace one match and exit,
1944 Comma to replace but not move point immediately,
1946 C-w to delete match and recursive edit,
1947 C-l to clear the screen, redisplay, and offer same replacement again,
1948 ! to replace all remaining matches in this buffer with no more questions,
1949 ^ to move point back to previous match,
1950 u to undo previous replacement,
1951 U to undo all replacements,
1952 E to edit the replacement string.
1953 In multi-buffer replacements type `Y' to replace all remaining
1954 matches in all remaining buffers with no more questions,
1955 `N' to skip to the next buffer without replacing remaining matches
1956 in the current buffer."
1964 (define-key map [backspace] 'skip)
1965 (define-key map "y" 'act)
1966 (define-key map "n" 'skip)
1967 (define-key map "Y" 'act)
1968 (define-key map "N" 'skip)
1969 (define-key map "e" 'edit-replacement)
1970 (define-key map "E" 'edit-replacement)
1971 (define-key map "," 'act-and-show)
1972 (define-key map "q" 'exit)
1974 (define-key map [return] 'exit)
1975 (define-key map "." 'act-and-exit)
1976 (define-key map "\C-r" 'edit)
1977 (define-key map "\C-w" 'delete-and-edit)
1978 (define-key map "\C-l" 'recenter)
1979 (define-key map "!" 'automatic)
1980 (define-key map "^" 'backup)
1981 (define-key map "u" 'undo)
1982 (define-key map "U" 'undo-all)
1983 (define-key map "\C-h" 'help)
1984 (define-key map [f1] 'help)
1985 (define-key map [help] 'help)
1986 (define-key map "?" 'help)
1987 (define-key map "\C-g" 'quit)
1988 (define-key map "\C-]" 'quit)
1989 (define-key map "\C-v" 'scroll-up)
1990 (define-key map "\M-v" 'scroll-down)
1991 (define-key map [next] 'scroll-up)
1992 (define-key map [prior] 'scroll-down)
1993 (define-key map [?\C-\M-v] 'scroll-other-window)
1994 (define-key map [M-next] 'scroll-other-window)
1995 (define-key map [?\C-\M-\S-v] 'scroll-other-window-down)
1996 (define-key map [M-prior] 'scroll-other-window-down)
1997 ;; Binding ESC would prohibit the M-v binding. Instead, callers
1998 ;; should check for ESC specially.
1999 ;; (define-key map "\e" 'exit-prefix)
2000 (define-key map [escape] 'exit-prefix)
2001 map)
2002 "Keymap of responses to questions posed by commands like `query-replace'.
2004 The valid answers include `act', `skip', `act-and-show',
2005 `act-and-exit', `exit', `exit-prefix', `recenter', `scroll-up',
2006 `scroll-down', `scroll-other-window', `scroll-other-window-down',
2007 `edit', `edit-replacement', `delete-and-edit', `automatic',
2008 `backup', `undo', `undo-all', `quit', and `help'.
2010 This keymap is used by `y-or-n-p' as well as `query-replace'.")
2012 (defvar multi-query-replace-map
2013 (let ((map (make-sparse-keymap)))
2014 (set-keymap-parent map query-replace-map)
2015 (define-key map "Y" 'automatic-all)
2016 (define-key map "N" 'exit-current)
2017 map)
2018 "Keymap that defines additional bindings for multi-buffer replacements.
2019 It extends its parent map `query-replace-map' with new bindings to
2020 operate on a set of buffers/files. The difference with its parent map
2021 is the additional answers `automatic-all' to replace all remaining
2022 matches in all remaining buffers with no more questions, and
2023 `exit-current' to skip remaining matches in the current buffer
2024 and to continue with the next buffer in the sequence.")
2026 (defun replace-match-string-symbols (n)
2027 "Process a list (and any sub-lists), expanding certain symbols.
2028 Symbol Expands To
2029 N (match-string N) (where N is a string of digits)
2030 #N (string-to-number (match-string N))
2031 & (match-string 0)
2032 #& (string-to-number (match-string 0))
2033 # replace-count
2035 Note that these symbols must be preceded by a backslash in order to
2036 type them using Lisp syntax."
2037 (while (consp n)
2038 (cond
2039 ((consp (car n))
2040 (replace-match-string-symbols (car n))) ;Process sub-list
2041 ((symbolp (car n))
2042 (let ((name (symbol-name (car n))))
2043 (cond
2044 ((string-match "^[0-9]+$" name)
2045 (setcar n (list 'match-string (string-to-number name))))
2046 ((string-match "^#[0-9]+$" name)
2047 (setcar n (list 'string-to-number
2048 (list 'match-string
2049 (string-to-number (substring name 1))))))
2050 ((string= "&" name)
2051 (setcar n '(match-string 0)))
2052 ((string= "#&" name)
2053 (setcar n '(string-to-number (match-string 0))))
2054 ((string= "#" name)
2055 (setcar n 'replace-count))))))
2056 (setq n (cdr n))))
2058 (defun replace-eval-replacement (expression count)
2059 (let* ((replace-count count)
2060 (replacement
2061 (condition-case err
2062 (eval expression)
2063 (error
2064 (error "Error evaluating replacement expression: %S" err)))))
2065 (if (stringp replacement)
2066 replacement
2067 (prin1-to-string replacement t))))
2069 (defun replace-quote (replacement)
2070 "Quote a replacement string.
2071 This just doubles all backslashes in REPLACEMENT and
2072 returns the resulting string. If REPLACEMENT is not
2073 a string, it is first passed through `prin1-to-string'
2074 with the `noescape' argument set.
2076 `match-data' is preserved across the call."
2077 (save-match-data
2079 (if (stringp replacement)
2080 replacement
2081 (prin1-to-string replacement t))
2082 t t)))
2084 (defun replace-loop-through-replacements (data count)
2085 ;; DATA is a vector containing the following values:
2086 ;; 0 next-rotate-count
2087 ;; 1 repeat-count
2088 ;; 2 next-replacement
2089 ;; 3 replacements
2090 (if (= (aref data 0) count)
2091 (progn
2092 (aset data 0 (+ count (aref data 1)))
2093 (let ((next (cdr (aref data 2))))
2094 (aset data 2 (if (consp next) next (aref data 3))))))
2095 (car (aref data 2)))
2097 (defun replace-match-data (integers reuse &optional new)
2098 "Like `match-data', but markers in REUSE get invalidated.
2099 If NEW is non-nil, it is set and returned instead of fresh data,
2100 but coerced to the correct value of INTEGERS."
2101 (or (and new
2102 (progn
2103 (set-match-data new)
2104 (and (eq new reuse)
2105 (eq (null integers) (markerp (car reuse)))
2106 new)))
2107 (match-data integers reuse t)))
2109 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data
2110 &optional backward)
2112 FIXEDCASE, LITERAL are passed to `replace-match' (which see).
2115 is made (to save time).
2116 MATCH-DATA is used for the replacement, and is a data structure
2117 as returned from the `match-data' function.
2118 In case editing is done, it is changed to use markers. BACKWARD is
2119 used to reverse the replacement direction.
2122 passed in. If LITERAL is set, no checking is done, anyway."
2123 (unless (or literal noedit)
2124 (setq noedit t)
2126 newtext)
2127 (setq newtext
2128 (read-string "Edit replacement string: "
2129 (prog1
2130 (cons
2131 (replace-match "" t t newtext 3)
2132 (1+ (match-beginning 3)))
2133 (setq match-data
2134 (replace-match-data
2135 nil match-data match-data))))
2136 noedit nil)))
2137 (set-match-data match-data)
2138 (replace-match newtext fixedcase literal)
2139 ;; `replace-match' leaves point at the end of the replacement text,
2140 ;; so move point to the beginning when replacing backward.
2141 (when backward (goto-char (nth 0 match-data)))
2142 noedit)
2144 (defvar replace-update-post-hook nil
2145 "Function(s) to call after query-replace has found a match in the buffer.")
2147 (defvar replace-search-function nil
2148 "Function to use when searching for strings to replace.
2149 It is used by `query-replace' and `replace-string', and is called
2150 with three arguments, as if it were `search-forward'.")
2152 (defvar replace-re-search-function nil
2153 "Function to use when searching for regexps to replace.
2154 It is used by `query-replace-regexp', `replace-regexp',
2155 `query-replace-regexp-eval', and `map-query-replace-regexp'.
2156 It is called with three arguments, as if it were
2157 `re-search-forward'.")
2159 (defun replace-search (search-string limit regexp-flag delimited-flag
2160 case-fold &optional backward)
2161 "Search for the next occurrence of SEARCH-STRING to replace."
2162 ;; Let-bind global isearch-* variables to values used
2163 ;; to search the next replacement. These let-bindings
2164 ;; should be effective both at the time of calling
2165 ;; `isearch-search-fun-default' and also at the
2166 ;; time of funcalling `search-function'.
2167 ;; These isearch-* bindings can't be placed higher
2168 ;; outside of this function because then another I-search
2169 ;; used after `recursive-edit' might override them.
2170 (let* ((isearch-regexp regexp-flag)
2171 (isearch-regexp-function (or delimited-flag
2172 (and replace-char-fold
2173 (not regexp-flag)
2174 #'char-fold-to-regexp)))
2175 (isearch-lax-whitespace
2176 replace-lax-whitespace)
2177 (isearch-regexp-lax-whitespace
2178 replace-regexp-lax-whitespace)
2179 (isearch-case-fold-search case-fold)
2180 (isearch-adjusted nil)
2181 (isearch-nonincremental t) ; don't use lax word mode
2182 (isearch-forward (not backward))
2183 (search-function
2184 (or (if regexp-flag
2185 replace-re-search-function
2186 replace-search-function)
2187 (isearch-search-fun-default))))
2188 (funcall search-function search-string limit t)))
2190 (defvar replace-overlay nil)
2192 (defun replace-highlight (match-beg match-end range-beg range-end
2193 search-string regexp-flag delimited-flag
2194 case-fold &optional backward)
2195 (if query-replace-highlight
2196 (if replace-overlay
2197 (move-overlay replace-overlay match-beg match-end (current-buffer))
2198 (setq replace-overlay (make-overlay match-beg match-end))
2199 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
2200 (overlay-put replace-overlay 'face 'query-replace)))
2201 (if query-replace-lazy-highlight
2202 (let ((isearch-string search-string)
2203 (isearch-regexp regexp-flag)
2204 (isearch-regexp-function delimited-flag)
2205 (isearch-lax-whitespace
2206 replace-lax-whitespace)
2207 (isearch-regexp-lax-whitespace
2208 replace-regexp-lax-whitespace)
2209 (isearch-case-fold-search case-fold)
2210 (isearch-forward (not backward))
2211 (isearch-other-end match-beg)
2212 (isearch-error nil))
2213 (isearch-lazy-highlight-new-loop range-beg range-end))))
2215 (defun replace-dehighlight ()
2216 (when replace-overlay
2217 (delete-overlay replace-overlay))
2218 (when query-replace-lazy-highlight
2219 (lazy-highlight-cleanup lazy-highlight-cleanup)
2220 (setq isearch-lazy-highlight-last-string nil))
2221 ;; Close overlays opened by `isearch-range-invisible' in `perform-replace'.
2222 (isearch-clean-overlays))
2224 ;; A macro because we push STACK, i.e. a local var in `perform-replace'.
2225 (defmacro replace--push-stack (replaced search-str next-replace stack)
2226 (declare (indent 0) (debug (form form form gv-place)))
2227 `(push (list (point) ,replaced
2228 ;;; If the replacement has already happened, all we need is the
2229 ;;; current match start and end. We could get this with a trivial
2230 ;;; match like
2231 ;;; (save-excursion (goto-char (match-beginning 0))
2232 ;;; (search-forward (match-string 0))
2233 ;;; (match-data t))
2234 ;;; if we really wanted to avoid manually constructing match data.
2235 ;;; Adding current-buffer is necessary so that match-data calls can
2236 ;;; return markers which are appropriate for editing.
2237 (if ,replaced
2238 (list
2239 (match-beginning 0) (match-end 0) (current-buffer))
2240 (match-data t))
2241 ,search-str ,next-replace)
2242 ,stack))
2244 (defun perform-replace (from-string replacements
2245 query-flag regexp-flag delimited-flag
2246 &optional repeat-count map start end backward region-noncontiguous-p)
2247 "Subroutine of `query-replace'. Its complexity handles interactive queries.
2248 Don't use this in your own program unless you want to query and set the mark
2249 just as `query-replace' does. Instead, write a simple loop like this:
2254 which will run faster and probably do exactly what you want. Please
2255 see the documentation of `replace-match' to find out how to simulate
2256 `case-replace'.
2258 This function returns nil if and only if there were no matches to
2259 make, or the user didn't cancel the call.
2261 REPLACEMENTS is either a string, a list of strings, or a cons cell
2262 containing a function and its first argument. The function is
2263 called to generate each replacement like this:
2264 (funcall (car replacements) (cdr replacements) replace-count)
2265 It must return a string."
2266 (or map (setq map query-replace-map))
2267 (and query-flag minibuffer-auto-raise
2268 (raise-frame (window-frame (minibuffer-window))))
2269 (let* ((case-fold-search
2270 (if (and case-fold-search search-upper-case)
2271 (isearch-no-upper-case-p from-string regexp-flag)
2272 case-fold-search))
2273 (nocasify (not (and case-replace case-fold-search)))
2274 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
2275 (search-string from-string)
2276 (real-match-data nil) ; The match data for the current match.
2277 (next-replacement nil)
2278 ;; This is non-nil if we know there is nothing for the user
2279 ;; to edit in the replacement.
2280 (noedit nil)
2281 (keep-going t)
2282 (stack nil)
2283 (search-string-replaced nil) ; last string matching `from-string'
2284 (next-replacement-replaced nil) ; replacement string
2285 ; (substituted regexp)
2286 (last-was-undo)
2287 (last-was-act-and-show)
2288 (update-stack t)
2289 (replace-count 0)
2290 (skip-read-only-count 0)
2291 (skip-filtered-count 0)
2292 (skip-invisible-count 0)
2293 (nonempty-match nil)
2294 (multi-buffer nil)
2295 (recenter-last-op nil) ; Start cycling order with initial position.
2297 ;; If non-nil, it is marker saying where in the buffer to stop.
2298 (limit nil)
2299 ;; Use local binding in add-function below.
2300 (isearch-filter-predicate isearch-filter-predicate)
2301 (region-bounds nil)
2303 ;; Data for the next match. If a cons, it has the same format as
2304 ;; (match-data); otherwise it is t if a match is possible at point.
2305 (match-again t)
2307 (message
2308 (if query-flag
2309 (apply 'propertize
2310 (substitute-command-keys
2312 minibuffer-prompt-properties))))
2314 ;; Unless a single contiguous chunk is selected, operate on multiple chunks.
2315 (when region-noncontiguous-p
2316 (setq region-bounds
2317 (mapcar (lambda (position)
2318 (cons (copy-marker (car position))
2319 (copy-marker (cdr position))))
2320 (funcall region-extract-function 'bounds)))
2321 (add-function :after-while isearch-filter-predicate
2322 (lambda (start end)
2323 (delq nil (mapcar
2324 (lambda (bounds)
2325 (and
2326 (>= start (car bounds))
2327 (<= start (cdr bounds))
2328 (>= end (car bounds))
2329 (<= end (cdr bounds))))
2330 region-bounds)))))
2332 ;; If region is active, in Transient Mark mode, operate on region.
2333 (if backward
2334 (when end
2335 (setq limit (copy-marker (min start end)))
2336 (goto-char (max start end))
2337 (deactivate-mark))
2338 (when start
2339 (setq limit (copy-marker (max start end)))
2340 (goto-char (min start end))
2341 (deactivate-mark)))
2343 ;; If last typed key in previous call of multi-buffer perform-replace
2344 ;; was `automatic-all', don't ask more questions in next files
2345 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
2346 (setq query-flag nil multi-buffer t))
2348 (cond
2349 ((stringp replacements)
2350 (setq next-replacement replacements
2351 replacements nil))
2352 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
2353 (or repeat-count (setq repeat-count 1))
2354 (setq replacements (cons 'replace-loop-through-replacements
2355 (vector repeat-count repeat-count
2356 replacements replacements)))))
2358 (when query-replace-lazy-highlight
2359 (setq isearch-lazy-highlight-last-string nil))
2361 (push-mark)
2362 (undo-boundary)
2363 (unwind-protect
2364 ;; Loop finding occurrences that perhaps should be replaced.
2365 (while (and keep-going
2366 (if backward
2367 (not (or (bobp) (and limit (<= (point) limit))))
2368 (not (or (eobp) (and limit (>= (point) limit)))))
2369 ;; Use the next match if it is already known;
2370 ;; otherwise, search for a match after moving forward
2371 ;; one char if progress is required.
2372 (setq real-match-data
2373 (cond ((consp match-again)
2374 (goto-char (if backward
2375 (nth 0 match-again)
2376 (nth 1 match-again)))
2377 (replace-match-data
2378 t real-match-data match-again))
2379 ;; MATCH-AGAIN non-nil means accept an
2380 ;; adjacent match.
2381 (match-again
2382 (and
2383 (replace-search search-string limit
2384 regexp-flag delimited-flag
2385 case-fold-search backward)
2386 ;; For speed, use only integers and
2387 ;; reuse the list used last time.
2388 (replace-match-data t real-match-data)))
2389 ((and (if backward
2390 (> (1- (point)) (point-min))
2391 (< (1+ (point)) (point-max)))
2392 (or (null limit)
2393 (if backward
2394 (> (1- (point)) limit)
2395 (< (1+ (point)) limit))))
2396 ;; If not accepting adjacent matches,
2397 ;; move one char to the right before
2398 ;; searching again. Undo the motion
2399 ;; if the search fails.
2400 (let ((opoint (point)))
2401 (forward-char (if backward -1 1))
2402 (if (replace-search search-string limit
2403 regexp-flag delimited-flag
2404 case-fold-search backward)
2405 (replace-match-data
2406 t real-match-data)
2407 (goto-char opoint)
2408 nil))))))
2410 ;; Record whether the match is nonempty, to avoid an infinite loop
2411 ;; repeatedly matching the same empty string.
2412 (setq nonempty-match
2413 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
2415 ;; If the match is empty, record that the next one can't be
2416 ;; adjacent.
2418 ;; Otherwise, if matching a regular expression, do the next
2419 ;; match now, since the replacement for this match may
2420 ;; affect whether the next match is adjacent to this one.
2421 ;; If that match is empty, don't use it.
2422 (setq match-again
2423 (and nonempty-match
2424 (or (not regexp-flag)
2425 (and (if backward
2426 (looking-back search-string nil)
2427 (looking-at search-string))
2428 (let ((match (match-data)))
2429 (and (/= (nth 0 match) (nth 1 match))
2430 match))))))
2432 (cond
2433 ;; Optionally ignore matches that have a read-only property.
2434 ((not (or (not query-replace-skip-read-only)
2435 (not (text-property-not-all
2436 (nth 0 real-match-data) (nth 1 real-match-data)
2437 'read-only nil))))
2438 (setq skip-read-only-count (1+ skip-read-only-count)))
2439 ;; Optionally filter out matches.
2440 ((not (funcall isearch-filter-predicate
2441 (nth 0 real-match-data) (nth 1 real-match-data)))
2442 (setq skip-filtered-count (1+ skip-filtered-count)))
2443 ;; Optionally ignore invisible matches.
2444 ((not (or (eq search-invisible t)
2445 ;; Don't open overlays for automatic replacements.
2446 (and (not query-flag) search-invisible)
2447 ;; Open hidden overlays for interactive replacements.
2448 (not (isearch-range-invisible
2449 (nth 0 real-match-data) (nth 1 real-match-data)))))
2450 (setq skip-invisible-count (1+ skip-invisible-count)))
2451 (t
2452 ;; Calculate the replacement string, if necessary.
2453 (when replacements
2454 (set-match-data real-match-data)
2455 (setq next-replacement
2456 (funcall (car replacements) (cdr replacements)
2457 replace-count)))
2458 (if (not query-flag)
2459 (progn
2460 (unless (or literal noedit)
2461 (replace-highlight
2462 (nth 0 real-match-data) (nth 1 real-match-data)
2463 start end search-string
2464 regexp-flag delimited-flag case-fold-search backward))
2465 (setq noedit
2466 (replace-match-maybe-edit
2467 next-replacement nocasify literal
2468 noedit real-match-data backward)
2469 replace-count (1+ replace-count)))
2470 (undo-boundary)
2471 (let (done replaced key def)
2472 ;; Loop reading commands until one of them sets done,
2473 ;; which means it has finished handling this
2474 ;; occurrence. Any command that sets `done' should
2475 ;; leave behind proper match data for the stack.
2476 ;; Commands not setting `done' need to adjust
2477 ;; `real-match-data'.
2478 (while (not done)
2479 (set-match-data real-match-data)
2480 (run-hooks 'replace-update-post-hook) ; Before `replace-highlight'.
2481 (replace-highlight
2482 (match-beginning 0) (match-end 0)
2483 start end search-string
2484 regexp-flag delimited-flag case-fold-search backward)
2485 ;; Obtain the matched groups: needed only when
2486 ;; regexp-flag non nil.
2487 (when (and last-was-undo regexp-flag)
2488 (setq last-was-undo nil
2489 real-match-data
2490 (save-excursion
2491 (goto-char (match-beginning 0))
2492 (looking-at search-string)
2493 (match-data t real-match-data))))
2494 ;; Matched string and next-replacement-replaced
2495 ;; stored in stack.
2496 (setq search-string-replaced (buffer-substring-no-properties
2497 (match-beginning 0)
2498 (match-end 0))
2499 next-replacement-replaced
2500 (query-replace-descr
2501 (save-match-data
2502 (set-match-data real-match-data)
2503 (match-substitute-replacement
2504 next-replacement nocasify literal))))
2505 ;; Bind message-log-max so we don't fill up the
2506 ;; message log with a bunch of identical messages.
2507 (let ((message-log-max nil)
2508 (replacement-presentation
2509 (if query-replace-show-replacement
2510 (save-match-data
2511 (set-match-data real-match-data)
2512 (match-substitute-replacement next-replacement
2513 nocasify literal))
2514 next-replacement)))
2515 (message message
2516 (query-replace-descr from-string)
2517 (query-replace-descr replacement-presentation)))
2518 (setq key (read-event))
2519 ;; Necessary in case something happens during
2520 ;; read-event that clobbers the match data.
2521 (set-match-data real-match-data)
2522 (setq key (vector key))
2523 (setq def (lookup-key map key))
2524 ;; Restore the match data while we process the command.
2525 (cond ((eq def 'help)
2526 (with-output-to-temp-buffer "*Help*"
2527 (princ
2528 (concat "Query replacing "
2529 (if delimited-flag
2530 (or (and (symbolp delimited-flag)
2531 (get delimited-flag
2532 'isearch-message-prefix))
2533 "word ") "")
2534 (if regexp-flag "regexp " "")
2535 (if backward "backward " "")
2536 from-string " with "
2538 (substitute-command-keys
2539 query-replace-help)))
2540 (with-current-buffer standard-output
2541 (help-mode))))
2542 ((eq def 'exit)
2543 (setq keep-going nil)
2544 (setq done t))
2545 ((eq def 'exit-current)
2546 (setq multi-buffer t keep-going nil done t))
2547 ((eq def 'backup)
2548 (if stack
2549 (let ((elt (pop stack)))
2550 (goto-char (nth 0 elt))
2551 (setq replaced (nth 1 elt)
2552 real-match-data
2553 (replace-match-data
2554 t real-match-data
2555 (nth 2 elt))))
2556 (message "No previous match")
2557 (ding 'no-terminate)
2558 (sit-for 1)))
2559 ((or (eq def 'undo) (eq def 'undo-all))
2560 (if (null stack)
2561 (progn
2562 (message "Nothing to undo")
2563 (ding 'no-terminate)
2564 (sit-for 1))
2565 (let ((stack-idx 0)
2566 (stack-len (length stack))
2567 (num-replacements 0)
2568 search-string
2569 next-replacement)
2570 (while (and (< stack-idx stack-len)
2571 stack
2572 (or (null replaced) last-was-act-and-show))
2573 (let* ((elt (nth stack-idx stack)))
2574 (setq
2575 stack-idx (1+ stack-idx)
2576 replaced (nth 1 elt)
2577 ;; Bind swapped values
2578 ;; (search-string <--> replacement)
2579 search-string (nth (if replaced 4 3) elt)
2580 next-replacement (nth (if replaced 3 4) elt)
2581 search-string-replaced search-string
2582 next-replacement-replaced next-replacement
2583 last-was-act-and-show nil)
2585 (when (and (= stack-idx stack-len)
2586 (and (null replaced) (not last-was-act-and-show))
2587 (zerop num-replacements))
2588 (message "Nothing to undo")
2589 (ding 'no-terminate)
2590 (sit-for 1))
2592 (when replaced
2593 (setq stack (nthcdr stack-idx stack))
2594 (goto-char (nth 0 elt))
2595 (set-match-data (nth 2 elt))
2596 (setq real-match-data
2597 (save-excursion
2598 (goto-char (match-beginning 0))
2599 (looking-at search-string)
2600 (match-data t (nth 2 elt)))
2601 noedit
2602 (replace-match-maybe-edit
2603 next-replacement nocasify literal
2604 noedit real-match-data backward)
2605 replace-count (1- replace-count)
2606 real-match-data
2607 (save-excursion
2608 (goto-char (match-beginning 0))
2609 (looking-at next-replacement)
2610 (match-data t (nth 2 elt))))
2611 ;; Set replaced nil to keep in loop
2612 (when (eq def 'undo-all)
2613 (setq replaced nil
2614 stack-len (- stack-len stack-idx)
2615 stack-idx 0
2616 num-replacements
2617 (1+ num-replacements))))))
2618 (when (and (eq def 'undo-all)
2619 (null (zerop num-replacements)))
2620 (message "Undid %d %s" num-replacements
2621 (if (= num-replacements 1)
2622 "replacement"
2623 "replacements"))
2624 (ding 'no-terminate)
2625 (sit-for 1)))
2626 (setq replaced nil last-was-undo t last-was-act-and-show nil)))
2627 ((eq def 'act)
2628 (or replaced
2629 (setq noedit
2630 (replace-match-maybe-edit
2631 next-replacement nocasify literal
2632 noedit real-match-data backward)
2633 replace-count (1+ replace-count)))
2634 (setq done t replaced t update-stack (not last-was-act-and-show)))
2635 ((eq def 'act-and-exit)
2636 (or replaced
2637 (setq noedit
2638 (replace-match-maybe-edit
2639 next-replacement nocasify literal
2640 noedit real-match-data backward)
2641 replace-count (1+ replace-count)))
2642 (setq keep-going nil)
2643 (setq done t replaced t))
2644 ((eq def 'act-and-show)
2645 (unless replaced
2646 (setq noedit
2647 (replace-match-maybe-edit
2648 next-replacement nocasify literal
2649 noedit real-match-data backward)
2650 replace-count (1+ replace-count)
2651 real-match-data (replace-match-data
2652 t real-match-data)
2653 replaced t last-was-act-and-show t)
2654 (replace--push-stack
2655 replaced
2656 search-string-replaced
2657 next-replacement-replaced stack)))
2658 ((or (eq def 'automatic) (eq def 'automatic-all))
2659 (or replaced
2660 (setq noedit
2661 (replace-match-maybe-edit
2662 next-replacement nocasify literal
2663 noedit real-match-data backward)
2664 replace-count (1+ replace-count)))
2665 (setq done t query-flag nil replaced t)
2666 (if (eq def 'automatic-all) (setq multi-buffer t)))
2667 ((eq def 'skip)
2668 (setq done t update-stack (not last-was-act-and-show)))
2669 ((eq def 'recenter)
2670 ;; `this-command' has the value `query-replace',
2671 ;; so we need to bind it to `recenter-top-bottom'
2672 ;; to allow it to detect a sequence of `C-l'.
2673 (let ((this-command 'recenter-top-bottom)
2674 (last-command 'recenter-top-bottom))
2675 (recenter-top-bottom)))
2676 ((eq def 'edit)
2677 (let ((opos (point-marker)))
2678 (setq real-match-data (replace-match-data
2679 nil real-match-data
2680 real-match-data))
2681 (goto-char (match-beginning 0))
2682 (save-excursion
2683 (save-window-excursion
2684 (recursive-edit)))
2685 (goto-char opos)
2686 (set-marker opos nil))
2687 ;; Before we make the replacement,
2688 ;; decide whether the search string
2689 ;; can match again just after this match.
2690 (if (and regexp-flag nonempty-match)
2691 (setq match-again (and (looking-at search-string)
2692 (match-data)))))
2693 ;; Edit replacement.
2694 ((eq def 'edit-replacement)
2695 (setq real-match-data (replace-match-data
2696 nil real-match-data
2697 real-match-data)
2698 next-replacement
2699 (read-string "Edit replacement string: "
2700 next-replacement)
2701 noedit nil)
2702 (if replaced
2703 (set-match-data real-match-data)
2704 (setq noedit
2705 (replace-match-maybe-edit
2706 next-replacement nocasify literal noedit
2707 real-match-data backward)
2708 replaced t))
2709 (setq done t))
2711 ((eq def 'delete-and-edit)
2712 (replace-match "" t t)
2713 (setq real-match-data (replace-match-data
2714 nil real-match-data))
2715 (replace-dehighlight)
2716 (save-excursion (recursive-edit))
2717 (setq replaced t))
2718 ;; Note: we do not need to treat `exit-prefix'
2719 ;; specially here, since we reread
2720 ;; any unrecognized character.
2721 (t
2722 (setq this-command 'mode-exited)
2723 (setq keep-going nil)
2724 (setq unread-command-events
2725 (append (listify-key-sequence key)
2726 unread-command-events))
2727 (setq done t)))
2728 (when query-replace-lazy-highlight
2729 ;; Force lazy rehighlighting only after replacements.
2730 (if (not (memq def '(skip backup)))
2731 (setq isearch-lazy-highlight-last-string nil)))
2732 (unless (eq def 'recenter)
2733 ;; Reset recenter cycling order to initial position.
2734 (setq recenter-last-op nil)))
2735 ;; Record previous position for ^ when we move on.
2736 ;; Change markers to numbers in the match data
2737 ;; since lots of markers slow down editing.
2738 (when update-stack
2739 (replace--push-stack
2740 replaced
2741 search-string-replaced
2742 next-replacement-replaced stack))
2743 (setq next-replacement-replaced nil
2744 search-string-replaced nil
2745 last-was-act-and-show nil))))))
2746 (replace-dehighlight))
2747 (or unread-command-events
2748 (message "Replaced %d occurrence%s%s"
2749 replace-count
2750 (if (= replace-count 1) "" "s")
2751 (if (> (+ skip-read-only-count
2752 skip-filtered-count
2753 skip-invisible-count) 0)
2754 (format " (skipped %s)"
2755 (mapconcat
2756 'identity
2757 (delq nil (list
2758 (if (> skip-read-only-count 0)
2759 (format "%s read-only"
2760 skip-read-only-count))
2761 (if (> skip-invisible-count 0)
2762 (format "%s invisible"
2763 skip-invisible-count))
2764 (if (> skip-filtered-count 0)
2765 (format "%s filtered out"
2766 skip-filtered-count))))
2767 ", "))
2768 "")))
2769 (or (and keep-going stack) multi-buffer)))
2771 (provide 'replace)
2773 ;;; replace.el ends here