1 ;;; replace.el --- replace commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1996, 1997, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 ;; This package supplies the string and regular-expression replace functions
28 ;; documented in the Emacs user's manual.
32 (defcustom case-replace t
33 "*Non-nil means `query-replace' should preserve case in replacements."
37 (defvar query-replace-history nil
)
39 (defvar query-replace-interactive nil
40 "Non-nil means `query-replace' uses the last search string.
41 That becomes the \"string to replace\".")
43 (defcustom query-replace-from-history-variable
'query-replace-history
44 "History list to use for the FROM argument of `query-replace' commands.
45 The value of this variable should be a symbol; that symbol
46 is used as a variable to hold a history list for the strings
47 or patterns to be replaced."
52 (defcustom query-replace-to-history-variable
'query-replace-history
53 "History list to use for the TO argument of `query-replace' commands.
54 The value of this variable should be a symbol; that symbol
55 is used as a variable to hold a history list for replacement
61 (defcustom query-replace-skip-read-only nil
62 "*Non-nil means `query-replace' and friends ignore read-only matches."
67 (defcustom query-replace-highlight t
68 "*Non-nil means to highlight matches during query replacement."
72 (defcustom query-replace-lazy-highlight t
73 "*Controls the lazy-highlighting during query replacements.
74 When non-nil, all text in the buffer matching the current match
75 is highlighted lazily using isearch lazy highlighting (see
76 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
78 :group
'lazy-highlight
82 (defface query-replace
83 '((t (:inherit isearch
)))
84 "Face for highlighting query replacement matches."
88 (defun query-replace-descr (string)
89 (mapconcat 'isearch-text-char-description string
""))
91 (defun query-replace-read-from (prompt regexp-flag
)
92 "Query and return the `from' argument of a query-replace operation.
93 The return value can also be a pair (FROM . TO) indicating that the user
94 wants to replace FROM with TO."
95 (if query-replace-interactive
96 (car (if regexp-flag regexp-search-ring search-ring
))
97 (let* ((lastfrom (car (symbol-value query-replace-from-history-variable
)))
98 (lastto (car (symbol-value query-replace-to-history-variable
)))
100 ;; The save-excursion here is in case the user marks and copies
101 ;; a region in order to specify the minibuffer input.
102 ;; That should not clobber the region for the query-replace itself.
104 (when (equal lastfrom lastto
)
105 ;; Typically, this is because the two histlists are shared.
106 (setq lastfrom
(cadr (symbol-value
107 query-replace-from-history-variable
))))
108 (read-from-minibuffer
109 (if (and lastto lastfrom
)
110 (format "%s (default %s -> %s): " prompt
111 (query-replace-descr lastfrom
)
112 (query-replace-descr lastto
))
113 (format "%s: " prompt
))
115 query-replace-from-history-variable
117 (if (and (zerop (length from
)) lastto lastfrom
)
119 (set query-replace-from-history-variable
120 (cdr (symbol-value query-replace-from-history-variable
)))
122 (query-replace-compile-replacement lastto regexp-flag
)))
123 ;; Warn if user types \n or \t, but don't reject the input.
125 (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\[nt]\\)" from
)
126 (let ((match (match-string 3 from
)))
128 ((string= match
"\\n")
129 (message "Note: `\\n' here doesn't match a newline; to do that, type C-q C-j instead"))
130 ((string= match
"\\t")
131 (message "Note: `\\t' here doesn't match a tab; to do that, just type TAB")))
135 (defun query-replace-compile-replacement (to regexp-flag
)
136 "Maybe convert a regexp replacement TO to Lisp.
137 Returns a list suitable for `perform-replace' if necessary,
138 the original string if not."
140 (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to
))
144 (setq pos
(match-end 0))
145 (push (substring to
0 (- pos
2)) list
)
146 (setq char
(aref to
(1- pos
))
147 to
(substring to pos
))
149 (push '(number-to-string replace-count
) list
))
151 (setq pos
(read-from-string to
))
152 (push `(replace-quote ,(car pos
)) list
)
154 ;; Swallow a space after a symbol
155 ;; if there is a space.
156 (if (and (or (symbolp (car pos
))
157 ;; Swallow a space after 'foo
158 ;; but not after (quote foo).
159 (and (eq (car-safe (car pos
)) 'quote
)
160 (not (= ?\
( (aref to
0)))))
161 (eq (string-match " " to
(cdr pos
))
165 (setq to
(substring to end
)))))
166 (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to
)))
167 (setq to
(nreverse (delete "" (cons to list
))))
168 (replace-match-string-symbols to
)
169 (cons 'replace-eval-replacement
176 (defun query-replace-read-to (from prompt regexp-flag
)
177 "Query and return the `to' argument of a query-replace operation."
178 (query-replace-compile-replacement
180 (read-from-minibuffer
181 (format "%s %s with: " prompt
(query-replace-descr from
))
183 query-replace-to-history-variable from t t
))
186 (defun query-replace-read-args (prompt regexp-flag
&optional noerror
)
188 (barf-if-buffer-read-only))
189 (let* ((from (query-replace-read-from prompt regexp-flag
))
190 (to (if (consp from
) (prog1 (cdr from
) (setq from
(car from
)))
191 (query-replace-read-to from prompt regexp-flag
))))
192 (list from to current-prefix-arg
)))
194 (defun query-replace (from-string to-string
&optional delimited start end
)
195 "Replace some occurrences of FROM-STRING with TO-STRING.
196 As each match is found, the user must type a character saying
197 what to do with it. For directions, type \\[help-command] at that time.
199 In Transient Mark mode, if the mark is active, operate on the contents
200 of the region. Otherwise, operate from point to the end of the buffer.
202 If `query-replace-interactive' is non-nil, the last incremental search
203 string is used as FROM-STRING--you don't have to specify it with the
206 Matching is independent of case if `case-fold-search' is non-nil and
207 FROM-STRING has no uppercase letters. Replacement transfers the case
208 pattern of the old text to the new text, if `case-replace' and
209 `case-fold-search' are non-nil and FROM-STRING has no uppercase
210 letters. \(Transferring the case pattern means that if the old text
211 matched is all caps, or capitalized, then its replacement is upcased
214 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
215 only matches surrounded by word boundaries.
216 Fourth and fifth arg START and END specify the region to operate on.
218 To customize possible responses, change the \"bindings\" in `query-replace-map'."
219 (interactive (let ((common
220 (query-replace-read-args
221 (if (and transient-mark-mode mark-active
)
222 "Query replace in region"
225 (list (nth 0 common
) (nth 1 common
) (nth 2 common
)
226 ;; These are done separately here
227 ;; so that command-history will record these expressions
228 ;; rather than the values they had this time.
229 (if (and transient-mark-mode mark-active
)
231 (if (and transient-mark-mode mark-active
)
233 (perform-replace from-string to-string t nil delimited nil nil start end
))
235 (define-key esc-map
"%" 'query-replace
)
237 (defun query-replace-regexp (regexp to-string
&optional delimited start end
)
238 "Replace some things after point matching REGEXP with TO-STRING.
239 As each match is found, the user must type a character saying
240 what to do with it. For directions, type \\[help-command] at that time.
242 In Transient Mark mode, if the mark is active, operate on the contents
243 of the region. Otherwise, operate from point to the end of the buffer.
245 If `query-replace-interactive' is non-nil, the last incremental search
246 regexp is used as REGEXP--you don't have to specify it with the
249 Matching is independent of case if `case-fold-search' is non-nil and
250 REGEXP has no uppercase letters. Replacement transfers the case
251 pattern of the old text to the new text, if `case-replace' and
252 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
253 \(Transferring the case pattern means that if the old text matched is
254 all caps, or capitalized, then its replacement is upcased or
257 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
258 only matches surrounded by word boundaries.
259 Fourth and fifth arg START and END specify the region to operate on.
261 In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
262 and `\\=\\N' (where N is a digit) stands for
263 whatever what matched the Nth `\\(...\\)' in REGEXP.
264 `\\?' lets you edit the replacement text in the minibuffer
265 at the given position for each replacement.
267 In interactive calls, the replacement text can contain `\\,'
268 followed by a Lisp expression. Each
269 replacement evaluates that expression to compute the replacement
270 string. Inside of that expression, `\\&' is a string denoting the
271 whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
272 for the whole or a partial match converted to a number with
273 `string-to-number', and `\\#' itself for the number of replacements
274 done so far (starting with zero).
276 If the replacement expression is a symbol, write a space after it
277 to terminate it. One space there, if any, will be discarded.
279 When using those Lisp features interactively in the replacement
280 text, TO-STRING is actually made a list instead of a string.
281 Use \\[repeat-complex-command] after this command for details."
284 (query-replace-read-args
285 (if (and transient-mark-mode mark-active
)
286 "Query replace regexp in region"
287 "Query replace regexp")
289 (list (nth 0 common
) (nth 1 common
) (nth 2 common
)
290 ;; These are done separately here
291 ;; so that command-history will record these expressions
292 ;; rather than the values they had this time.
293 (if (and transient-mark-mode mark-active
)
295 (if (and transient-mark-mode mark-active
)
297 (perform-replace regexp to-string t t delimited nil nil start end
))
299 (define-key esc-map
[?\C-%
] 'query-replace-regexp
)
301 (defun query-replace-regexp-eval (regexp to-expr
&optional delimited start end
)
302 "Replace some things after point matching REGEXP with the result of TO-EXPR.
303 As each match is found, the user must type a character saying
304 what to do with it. For directions, type \\[help-command] at that time.
306 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
307 reference `replace-count' to get the number of replacements already made.
308 If the result of TO-EXPR is not a string, it is converted to one using
309 `prin1-to-string' with the NOESCAPE argument (which see).
311 For convenience, when entering TO-EXPR interactively, you can use `\\&' or
312 `\\0' to stand for whatever matched the whole of REGEXP, and `\\N' (where
313 N is a digit) to stand for whatever matched the Nth `\\(...\\)' in REGEXP.
314 Use `\\#&' or `\\#N' if you want a number instead of a string.
315 In interactive use, `\\#' in itself stands for `replace-count'.
317 In Transient Mark mode, if the mark is active, operate on the contents
318 of the region. Otherwise, operate from point to the end of the buffer.
320 If `query-replace-interactive' is non-nil, the last incremental search
321 regexp is used as REGEXP--you don't have to specify it with the
324 Preserves case in each replacement if `case-replace' and `case-fold-search'
325 are non-nil and REGEXP has no uppercase letters.
327 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
328 only matches that are surrounded by word boundaries.
329 Fourth and fifth arg START and END specify the region to operate on."
332 (barf-if-buffer-read-only)
334 ;; Let-bind the history var to disable the "foo -> bar" default.
335 ;; Maybe we shouldn't disable this default, but for now I'll
336 ;; leave it off. --Stef
337 (let ((query-replace-to-history-variable nil
))
338 (query-replace-read-from "Query replace regexp" t
)))
339 (to (list (read-from-minibuffer
340 (format "Query replace regexp %s with eval: "
341 (query-replace-descr from
))
342 nil nil t query-replace-to-history-variable from t
))))
343 ;; We make TO a list because replace-match-string-symbols requires one,
344 ;; and the user might enter a single token.
345 (replace-match-string-symbols to
)
346 (list from
(car to
) current-prefix-arg
347 (if (and transient-mark-mode mark-active
)
349 (if (and transient-mark-mode mark-active
)
351 (perform-replace regexp
(cons 'replace-eval-replacement to-expr
)
352 t
'literal delimited nil nil start end
))
354 (defun map-query-replace-regexp (regexp to-strings
&optional n start end
)
355 "Replace some matches for REGEXP with various strings, in rotation.
356 The second argument TO-STRINGS contains the replacement strings,
357 separated by spaces. Third arg DELIMITED (prefix arg if interactive),
358 if non-nil, means replace only matches surrounded by word boundaries.
359 This command works like `query-replace-regexp' except that each
360 successive replacement uses the next successive replacement string,
361 wrapping around from the last such string to the first.
363 In Transient Mark mode, if the mark is active, operate on the contents
364 of the region. Otherwise, operate from point to the end of the buffer.
366 Non-interactively, TO-STRINGS may be a list of replacement strings.
368 If `query-replace-interactive' is non-nil, the last incremental search
369 regexp is used as REGEXP--you don't have to specify it with the minibuffer.
371 A prefix argument N says to use each replacement string N times
372 before rotating to the next.
373 Fourth and fifth arg START and END specify the region to operate on."
375 (let* ((from (if query-replace-interactive
376 (car regexp-search-ring
)
377 (read-from-minibuffer "Map query replace (regexp): "
379 'query-replace-history nil t
)))
380 (to (read-from-minibuffer
381 (format "Query replace %s with (space-separated strings): "
382 (query-replace-descr from
))
384 'query-replace-history from t
)))
386 (and current-prefix-arg
387 (prefix-numeric-value current-prefix-arg
))
388 (if (and transient-mark-mode mark-active
)
390 (if (and transient-mark-mode mark-active
)
393 (if (listp to-strings
)
394 (setq replacements to-strings
)
395 (while (/= (length to-strings
) 0)
396 (if (string-match " " to-strings
)
399 (list (substring to-strings
0
400 (string-match " " to-strings
))))
401 to-strings
(substring to-strings
402 (1+ (string-match " " to-strings
))))
403 (setq replacements
(append replacements
(list to-strings
))
405 (perform-replace regexp replacements t t nil n nil start end
)))
407 (defun replace-string (from-string to-string
&optional delimited start end
)
408 "Replace occurrences of FROM-STRING with TO-STRING.
409 Preserve case in each match if `case-replace' and `case-fold-search'
410 are non-nil and FROM-STRING has no uppercase letters.
411 \(Preserving case means that if the string matched is all caps, or capitalized,
412 then its replacement is upcased or capitalized.)
414 In Transient Mark mode, if the mark is active, operate on the contents
415 of the region. Otherwise, operate from point to the end of the buffer.
417 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
418 only matches surrounded by word boundaries.
419 Fourth and fifth arg START and END specify the region to operate on.
421 If `query-replace-interactive' is non-nil, the last incremental search
422 string is used as FROM-STRING--you don't have to specify it with the
425 This function is usually the wrong thing to use in a Lisp program.
426 What you probably want is a loop like this:
427 (while (search-forward FROM-STRING nil t)
428 (replace-match TO-STRING nil t))
429 which will run faster and will not set the mark or print anything.
430 \(You may need a more complex loop if FROM-STRING can match the null string
431 and TO-STRING is also null.)"
434 (query-replace-read-args
435 (if (and transient-mark-mode mark-active
)
436 "Replace string in region"
439 (list (nth 0 common
) (nth 1 common
) (nth 2 common
)
440 (if (and transient-mark-mode mark-active
)
442 (if (and transient-mark-mode mark-active
)
444 (perform-replace from-string to-string nil nil delimited nil nil start end
))
446 (defun replace-regexp (regexp to-string
&optional delimited start end
)
447 "Replace things after point matching REGEXP with TO-STRING.
448 Preserve case in each match if `case-replace' and `case-fold-search'
449 are non-nil and REGEXP has no uppercase letters.
451 In Transient Mark mode, if the mark is active, operate on the contents
452 of the region. Otherwise, operate from point to the end of the buffer.
454 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
455 only matches surrounded by word boundaries.
456 Fourth and fifth arg START and END specify the region to operate on.
458 In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
459 and `\\=\\N' (where N is a digit) stands for
460 whatever what matched the Nth `\\(...\\)' in REGEXP.
461 `\\?' lets you edit the replacement text in the minibuffer
462 at the given position for each replacement.
464 In interactive calls, the replacement text may contain `\\,'
465 followed by a Lisp expression used as part of the replacement
466 text. Inside of that expression, `\\&' is a string denoting the
467 whole match, `\\N' a partial matches, `\\#&' and `\\#N' the
468 respective numeric values from `string-to-number', and `\\#'
469 itself for `replace-count', the number of replacements occured so
472 If your Lisp expression is an identifier and the next letter in
473 the replacement string would be interpreted as part of it, you
474 can wrap it with an expression like `\\,(or \\#)'. Incidentally,
475 for this particular case you may also enter `\\#' in the
476 replacement text directly.
478 When using those Lisp features interactively in the replacement
479 text, TO-STRING is actually made a list instead of a string.
480 Use \\[repeat-complex-command] after this command for details.
482 If `query-replace-interactive' is non-nil, the last incremental search
483 regexp is used as REGEXP--you don't have to specify it with the minibuffer.
485 This function is usually the wrong thing to use in a Lisp program.
486 What you probably want is a loop like this:
487 (while (re-search-forward REGEXP nil t)
488 (replace-match TO-STRING nil nil))
489 which will run faster and will not set the mark or print anything."
492 (query-replace-read-args
493 (if (and transient-mark-mode mark-active
)
494 "Replace regexp in region"
497 (list (nth 0 common
) (nth 1 common
) (nth 2 common
)
498 (if (and transient-mark-mode mark-active
)
500 (if (and transient-mark-mode mark-active
)
502 (perform-replace regexp to-string nil t delimited nil nil start end
))
505 (defvar regexp-history nil
506 "History list for some commands that read regular expressions.")
509 (defalias 'delete-non-matching-lines
'keep-lines
)
510 (defalias 'delete-matching-lines
'flush-lines
)
511 (defalias 'count-matches
'how-many
)
514 (defun keep-lines-read-args (prompt)
515 "Read arguments for `keep-lines' and friends.
516 Prompt for a regexp with PROMPT.
517 Value is a list, (REGEXP)."
518 (list (read-from-minibuffer prompt nil nil nil
519 'regexp-history nil t
)
522 (defun keep-lines (regexp &optional rstart rend interactive
)
523 "Delete all lines except those containing matches for REGEXP.
524 A match split across lines preserves all the lines it lies in.
525 When called from Lisp (and usually interactively as well, see below)
526 applies to all lines starting after point.
528 If REGEXP contains upper case characters (excluding those preceded by `\\'),
529 the matching is case-sensitive.
531 Second and third arg RSTART and REND specify the region to operate on.
532 This command operates on (the accessible part of) all lines whose
533 accessible part is entirely contained in the region determined by RSTART
534 and REND. (A newline ending a line counts as part of that line.)
536 Interactively, in Transient Mark mode when the mark is active, operate
537 on all lines whose accessible part is entirely contained in the region.
538 Otherwise, the command applies to all lines starting after point.
539 When calling this function from Lisp, you can pretend that it was
540 called interactively by passing a non-nil INTERACTIVE argument.
542 This function starts looking for the next match from the end of
543 the previous match. Hence, it ignores matches that overlap
544 a previously found match."
548 (barf-if-buffer-read-only)
549 (keep-lines-read-args "Keep lines (containing match for regexp): ")))
552 (goto-char (min rstart rend
))
556 (goto-char (max rstart rend
))
557 (unless (or (bolp) (eobp))
560 (if (and interactive transient-mark-mode mark-active
)
561 (setq rstart
(region-beginning)
563 (goto-char (region-end))
564 (unless (or (bolp) (eobp))
568 rend
(point-max-marker)))
571 (or (bolp) (forward-line 1))
572 (let ((start (point))
573 (case-fold-search (and case-fold-search
574 (isearch-no-upper-case-p regexp t
))))
575 (while (< (point) rend
)
576 ;; Start is first char not preserved by previous match.
577 (if (not (re-search-forward regexp rend
'move
))
578 (delete-region start rend
)
579 (let ((end (save-excursion (goto-char (match-beginning 0))
582 ;; Now end is first char preserved by the new match.
584 (delete-region start end
))))
586 (setq start
(save-excursion (forward-line 1) (point)))
587 ;; If the match was empty, avoid matching again at same place.
588 (and (< (point) rend
)
589 (= (match-beginning 0) (match-end 0))
591 (set-marker rend nil
)
595 (defun flush-lines (regexp &optional rstart rend interactive
)
596 "Delete lines containing matches for REGEXP.
597 When called from Lisp (and usually when called interactively as
598 well, see below), applies to the part of the buffer after point.
599 The line point is in is deleted if and only if it contains a
600 match for regexp starting after point.
602 If REGEXP contains upper case characters (excluding those preceded by `\\'),
603 the matching is case-sensitive.
605 Second and third arg RSTART and REND specify the region to operate on.
606 Lines partially contained in this region are deleted if and only if
607 they contain a match entirely contained in it.
609 Interactively, in Transient Mark mode when the mark is active, operate
610 on the contents of the region. Otherwise, operate from point to the
611 end of (the accessible portion of) the buffer. When calling this function
612 from Lisp, you can pretend that it was called interactively by passing
613 a non-nil INTERACTIVE argument.
615 If a match is split across lines, all the lines it lies in are deleted.
616 They are deleted _before_ looking for the next match. Hence, a match
617 starting on the same line at which another match ended is ignored."
621 (barf-if-buffer-read-only)
622 (keep-lines-read-args "Flush lines (containing match for regexp): ")))
625 (goto-char (min rstart rend
))
626 (setq rend
(copy-marker (max rstart rend
))))
627 (if (and interactive transient-mark-mode mark-active
)
628 (setq rstart
(region-beginning)
629 rend
(copy-marker (region-end)))
631 rend
(point-max-marker)))
633 (let ((case-fold-search (and case-fold-search
634 (isearch-no-upper-case-p regexp t
))))
636 (while (and (< (point) rend
)
637 (re-search-forward regexp rend t
))
638 (delete-region (save-excursion (goto-char (match-beginning 0))
641 (progn (forward-line 1) (point))))))
642 (set-marker rend nil
)
646 (defun how-many (regexp &optional rstart rend interactive
)
647 "Print and return number of matches for REGEXP following point.
648 When called from Lisp and INTERACTIVE is omitted or nil, just return
649 the number, do not print it; if INTERACTIVE is t, the function behaves
650 in all respects has if it had been called interactively.
652 If REGEXP contains upper case characters (excluding those preceded by `\\'),
653 the matching is case-sensitive.
655 Second and third arg RSTART and REND specify the region to operate on.
657 Interactively, in Transient Mark mode when the mark is active, operate
658 on the contents of the region. Otherwise, operate from point to the
659 end of (the accessible portion of) the buffer.
661 This function starts looking for the next match from the end of
662 the previous match. Hence, it ignores matches that overlap
663 a previously found match."
666 (keep-lines-read-args "How many matches for (regexp): "))
670 (goto-char (min rstart rend
))
671 (setq rend
(max rstart rend
)))
672 (if (and interactive transient-mark-mode mark-active
)
673 (setq rstart
(region-beginning)
680 (case-fold-search (and case-fold-search
681 (isearch-no-upper-case-p regexp t
))))
682 (while (and (< (point) rend
)
683 (progn (setq opoint
(point))
684 (re-search-forward regexp rend t
)))
685 (if (= opoint
(point))
687 (setq count
(1+ count
))))
688 (when interactive
(message "%d occurrence%s"
690 (if (= count
1) "" "s")))
694 (defvar occur-mode-map
695 (let ((map (make-sparse-keymap)))
696 (define-key map
[mouse-2
] 'occur-mode-mouse-goto
)
697 (define-key map
"\C-c\C-c" 'occur-mode-goto-occurrence
)
698 (define-key map
"\C-m" 'occur-mode-goto-occurrence
)
699 (define-key map
"o" 'occur-mode-goto-occurrence-other-window
)
700 (define-key map
"\C-o" 'occur-mode-display-occurrence
)
701 (define-key map
"\M-n" 'occur-next
)
702 (define-key map
"\M-p" 'occur-prev
)
703 (define-key map
"r" 'occur-rename-buffer
)
704 (define-key map
"c" 'clone-buffer
)
705 (define-key map
"g" 'revert-buffer
)
706 (define-key map
"q" 'quit-window
)
707 (define-key map
"z" 'kill-this-buffer
)
708 (define-key map
"\C-c\C-f" 'next-error-follow-minor-mode
)
710 "Keymap for `occur-mode'.")
712 (defvar occur-revert-arguments nil
713 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
714 See `occur-revert-function'.")
716 (defcustom occur-mode-hook
'(turn-on-font-lock)
717 "Hook run when entering Occur mode."
721 (defcustom occur-hook nil
722 "Hook run by Occur when there are any matches."
726 (put 'occur-mode
'mode-class
'special
)
728 "Major mode for output from \\[occur].
729 \\<occur-mode-map>Move point to one of the items in this buffer, then use
730 \\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to.
731 Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it.
735 (kill-all-local-variables)
736 (use-local-map occur-mode-map
)
737 (setq major-mode
'occur-mode
)
738 (setq mode-name
"Occur")
739 (set (make-local-variable 'revert-buffer-function
) 'occur-revert-function
)
740 (make-local-variable 'occur-revert-arguments
)
741 (add-hook 'change-major-mode-hook
'font-lock-defontify nil t
)
742 (setq next-error-function
'occur-next-error
)
743 (run-mode-hooks 'occur-mode-hook
))
745 (defun occur-revert-function (ignore1 ignore2
)
746 "Handle `revert-buffer' for Occur mode buffers."
747 (apply 'occur-1
(append occur-revert-arguments
(list (buffer-name)))))
749 (defun occur-mode-mouse-goto (event)
750 "In Occur mode, go to the occurrence whose line you click on."
754 (set-buffer (window-buffer (posn-window (event-end event
))))
756 (goto-char (posn-point (event-end event
)))
757 (setq pos
(occur-mode-find-occurrence))))
758 (switch-to-buffer-other-window (marker-buffer pos
))
761 (defun occur-mode-find-occurrence ()
762 (let ((pos (get-text-property (point) 'occur-target
)))
764 (error "No occurrence on this line"))
765 (unless (buffer-live-p (marker-buffer pos
))
766 (error "Buffer for this occurrence was killed"))
769 (defun occur-mode-goto-occurrence ()
770 "Go to the occurrence the current line describes."
772 (let ((pos (occur-mode-find-occurrence)))
773 (switch-to-buffer (marker-buffer pos
))
776 (defun occur-mode-goto-occurrence-other-window ()
777 "Go to the occurrence the current line describes, in another window."
779 (let ((pos (occur-mode-find-occurrence)))
780 (switch-to-buffer-other-window (marker-buffer pos
))
783 (defun occur-mode-display-occurrence ()
784 "Display in another window the occurrence the current line describes."
786 (let ((pos (occur-mode-find-occurrence))
788 ;; Bind these to ensure `display-buffer' puts it in another window.
789 same-window-buffer-names
791 (setq window
(display-buffer (marker-buffer pos
)))
792 ;; This is the way to set point in the proper window.
793 (save-selected-window
794 (select-window window
)
797 (defun occur-find-match (n search message
)
798 (if (not n
) (setq n
1))
801 (setq r
(funcall search
(point) 'occur-match
))
803 (get-text-property r
'occur-match
)
804 (setq r
(funcall search r
'occur-match
)))
810 (defun occur-next (&optional n
)
811 "Move to the Nth (default 1) next match in an Occur mode buffer."
813 (occur-find-match n
#'next-single-property-change
"No more matches"))
815 (defun occur-prev (&optional n
)
816 "Move to the Nth (default 1) previous match in an Occur mode buffer."
818 (occur-find-match n
#'previous-single-property-change
"No earlier matches"))
820 (defun occur-next-error (&optional argp reset
)
821 "Move to the Nth (default 1) next match in an Occur mode buffer.
822 Compatibility function for \\[next-error] invocations."
824 ;; we need to run occur-find-match from within the Occur buffer
826 ;; Choose the buffer and make it current.
827 (if (next-error-buffer-p (current-buffer))
829 (next-error-find-buffer nil nil
831 (eq major-mode
'occur-mode
))))
833 (goto-char (cond (reset (point-min))
834 ((< argp
0) (line-beginning-position))
835 ((line-end-position))))
839 #'previous-single-property-change
840 #'next-single-property-change
)
842 ;; In case the *Occur* buffer is visible in a nonselected window.
843 (set-window-point (get-buffer-window (current-buffer)) (point))
844 (occur-mode-goto-occurrence)))
847 '((((class color
) (min-colors 88) (background light
))
849 (((class color
) (min-colors 88) (background dark
))
850 :background
"RoyalBlue3")
851 (((class color
) (min-colors 8))
852 :background
"blue" :foreground
"white")
853 (((type tty
) (class mono
))
855 (t :background
"gray"))
856 "Face used to highlight matches permanently."
860 (defcustom list-matching-lines-default-context-lines
0
861 "*Default number of context lines included around `list-matching-lines' matches.
862 A negative number means to include that many lines before the match.
863 A positive number means to include that many lines both before and after."
867 (defalias 'list-matching-lines
'occur
)
869 (defcustom list-matching-lines-face
'match
870 "*Face used by \\[list-matching-lines] to show the text that matches.
871 If the value is nil, don't highlight the matching portions specially."
875 (defcustom list-matching-lines-buffer-name-face
'underline
876 "*Face used by \\[list-matching-lines] to show the names of buffers.
877 If the value is nil, don't highlight the buffer names specially."
881 (defcustom occur-excluded-properties
882 '(read-only invisible intangible field mouse-face help-echo local-map keymap
883 yank-handler follow-link
)
884 "*Text properties to discard when copying lines to the *Occur* buffer.
885 The value should be a list of text properties to discard or t,
886 which means to discard all text properties."
887 :type
'(choice (const :tag
"All" t
) (repeat symbol
))
891 (defun occur-accumulate-lines (count &optional keep-props
)
893 (let ((forwardp (> count
0))
895 (while (not (or (zerop count
)
899 (setq count
(+ count
(if forwardp -
1 1)))
900 (setq beg
(line-beginning-position)
901 end
(line-end-position))
902 (if (and keep-props
(if (boundp 'jit-lock-mode
) jit-lock-mode
)
903 (text-property-not-all beg end
'fontified t
))
904 (if (fboundp 'jit-lock-fontify-now
)
905 (jit-lock-fontify-now beg end
)))
907 (if (and keep-props
(not (eq occur-excluded-properties t
)))
908 (let ((str (buffer-substring beg end
)))
909 (remove-list-of-text-properties
910 0 (length str
) occur-excluded-properties str
)
912 (buffer-substring-no-properties beg end
))
914 (forward-line (if forwardp
1 -
1)))
917 (defun occur-read-primary-args ()
918 (list (let* ((default (car regexp-history
))
920 (read-from-minibuffer
922 (format "List lines matching regexp (default %s): "
923 (query-replace-descr default
))
924 "List lines matching regexp: ")
933 (when current-prefix-arg
934 (prefix-numeric-value current-prefix-arg
))))
936 (defun occur-rename-buffer (&optional unique-p interactive-p
)
937 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
938 Here `original-buffer-name' is the buffer name were Occur was originally run.
939 When given the prefix argument, or called non-interactively, the renaming
940 will not clobber the existing buffer(s) of that name, but use
941 `generate-new-buffer-name' instead. You can add this to `occur-hook'
942 if you always want a separate *Occur* buffer for each buffer where you
946 (if (eq major-mode
'occur-mode
) (current-buffer) (get-buffer "*Occur*"))
947 (rename-buffer (concat "*Occur: "
948 (mapconcat #'buffer-name
949 (car (cddr occur-revert-arguments
)) "/")
951 (or unique-p
(not interactive-p
)))))
953 (defun occur (regexp &optional nlines
)
954 "Show all lines in the current buffer containing a match for REGEXP.
955 This function can not handle matches that span more than one line.
957 Each line is displayed with NLINES lines before and after, or -NLINES
958 before if NLINES is negative.
959 NLINES defaults to `list-matching-lines-default-context-lines'.
960 Interactively it is the prefix arg.
962 The lines are shown in a buffer named `*Occur*'.
963 It serves as a menu to find any of the occurrences in this buffer.
964 \\<occur-mode-map>\\[describe-mode] in that buffer will explain how.
966 If REGEXP contains upper case characters (excluding those preceded by `\\'),
967 the matching is case-sensitive."
968 (interactive (occur-read-primary-args))
969 (occur-1 regexp nlines
(list (current-buffer))))
971 (defun multi-occur (bufs regexp
&optional nlines
)
972 "Show all lines in buffers BUFS containing a match for REGEXP.
973 This function acts on multiple buffers; otherwise, it is exactly like
977 (let* ((bufs (list (read-buffer "First buffer to search: "
978 (current-buffer) t
)))
980 (ido-ignore-item-temp-list bufs
))
981 (while (not (string-equal
982 (setq buf
(read-buffer
983 (if (eq read-buffer-function
'ido-read-buffer
)
984 "Next buffer to search (C-j to end): "
985 "Next buffer to search (RET to end): ")
988 (add-to-list 'bufs buf
)
989 (setq ido-ignore-item-temp-list bufs
))
990 (nreverse (mapcar #'get-buffer bufs
)))
991 (occur-read-primary-args)))
992 (occur-1 regexp nlines bufs
))
994 (defun multi-occur-by-filename-regexp (bufregexp regexp
&optional nlines
)
995 "Show all lines matching REGEXP in buffers named by BUFREGEXP.
996 See also `multi-occur'."
999 (let* ((default (car regexp-history
))
1001 (read-from-minibuffer
1002 "List lines in buffers whose filename matches regexp: "
1007 (if (equal input
"")
1010 (occur-read-primary-args)))
1012 (occur-1 regexp nlines
1014 (mapcar (lambda (buf)
1015 (when (and (buffer-file-name buf
)
1016 (string-match bufregexp
1017 (buffer-file-name buf
)))
1021 (defun occur-1 (regexp nlines bufs
&optional buf-name
)
1023 (setq buf-name
"*Occur*"))
1025 (active-bufs (delq nil
(mapcar #'(lambda (buf)
1026 (when (buffer-live-p buf
) buf
))
1028 ;; Handle the case where one of the buffers we're searching is the
1029 ;; output buffer. Just rename it.
1030 (when (member buf-name
(mapcar 'buffer-name active-bufs
))
1031 (with-current-buffer (get-buffer buf-name
)
1034 ;; Now find or create the output buffer.
1035 ;; If we just renamed that buffer, we will make a new one here.
1036 (setq occur-buf
(get-buffer-create buf-name
))
1038 (with-current-buffer occur-buf
1040 (let ((inhibit-read-only t
))
1042 (let ((count (occur-engine
1043 regexp active-bufs occur-buf
1044 (or nlines list-matching-lines-default-context-lines
)
1045 (and case-fold-search
1046 (isearch-no-upper-case-p regexp t
))
1047 list-matching-lines-buffer-name-face
1048 nil list-matching-lines-face
1049 (not (eq occur-excluded-properties t
)))))
1050 (let* ((bufcount (length active-bufs
))
1051 (diff (- (length bufs
) bufcount
)))
1052 (message "Searched %d buffer%s%s; %s match%s for `%s'"
1053 bufcount
(if (= bufcount
1) "" "s")
1054 (if (zerop diff
) "" (format " (%d killed)" diff
))
1055 (if (zerop count
) "no" (format "%d" count
))
1056 (if (= count
1) "" "es")
1058 (setq occur-revert-arguments
(list regexp nlines bufs
))
1060 (kill-buffer occur-buf
)
1061 (display-buffer occur-buf
)
1062 (setq next-error-last-buffer occur-buf
)
1063 (setq buffer-read-only t
)
1064 (set-buffer-modified-p nil
)
1065 (run-hooks 'occur-hook
)))))))
1067 (defun occur-engine-add-prefix (lines)
1070 (concat " :" line
"\n"))
1073 (defun occur-engine (regexp buffers out-buf nlines case-fold-search
1074 title-face prefix-face match-face keep-props
)
1075 (with-current-buffer out-buf
1076 (let ((globalcount 0)
1077 ;; Don't generate undo entries for creation of the initial contents.
1078 (buffer-undo-list t
)
1080 ;; Map over all the buffers
1081 (dolist (buf buffers
)
1082 (when (buffer-live-p buf
)
1083 (let ((matches 0) ;; count of matched lines
1084 (lines 1) ;; line count
1091 (headerpt (with-current-buffer out-buf
(point))))
1095 ;; Set CODING only if the current buffer locally
1096 ;; binds buffer-file-coding-system.
1097 (not (local-variable-p 'buffer-file-coding-system
))
1098 (setq coding buffer-file-coding-system
))
1100 (goto-char (point-min)) ;; begin searching in the buffer
1102 (setq origpt
(point))
1103 (when (setq endpt
(re-search-forward regexp nil t
))
1104 (setq matches
(1+ matches
)) ;; increment match count
1105 (setq matchbeg
(match-beginning 0))
1106 (setq lines
(+ lines
(1- (count-lines origpt endpt
))))
1108 (goto-char matchbeg
)
1109 (setq begpt
(line-beginning-position)
1110 endpt
(line-end-position)))
1111 (setq marker
(make-marker))
1112 (set-marker marker matchbeg
)
1114 (if (boundp 'jit-lock-mode
) jit-lock-mode
)
1115 (text-property-not-all begpt endpt
'fontified t
))
1116 (if (fboundp 'jit-lock-fontify-now
)
1117 (jit-lock-fontify-now begpt endpt
)))
1118 (if (and keep-props
(not (eq occur-excluded-properties t
)))
1120 (setq curstring
(buffer-substring begpt endpt
))
1121 (remove-list-of-text-properties
1122 0 (length curstring
) occur-excluded-properties curstring
))
1123 (setq curstring
(buffer-substring-no-properties begpt endpt
)))
1124 ;; Highlight the matches
1125 (let ((len (length curstring
))
1127 (while (and (< start len
)
1128 (string-match regexp curstring start
))
1129 (add-text-properties
1130 (match-beginning 0) (match-end 0)
1134 ;; Use `face' rather than `font-lock-face' here
1135 ;; so as to override faces copied from the buffer.
1136 `(face ,match-face
)))
1138 (setq start
(match-end 0))))
1139 ;; Generate the string to insert for this match
1142 ;; Using 7 digits aligns tabs properly.
1143 (apply #'propertize
(format "%7d:" lines
)
1146 `(font-lock-face prefix-face
))
1147 `(occur-prefix t mouse-face
(highlight)
1148 occur-target
,marker follow-link t
1149 help-echo
"mouse-2: go to this occurrence")))
1150 ;; We don't put `mouse-face' on the newline,
1151 ;; because that loses. And don't put it
1152 ;; on context lines to reduce flicker.
1153 (propertize curstring
'mouse-face
(list 'highlight
)
1154 'occur-target marker
1157 "mouse-2: go to this occurrence")
1158 ;; Add marker at eol, but no mouse props.
1159 (propertize "\n" 'occur-target marker
)))
1162 ;; The simple display style
1164 ;; The complex multi-line display
1165 ;; style. Generate a list of lines,
1166 ;; concatenate them all together.
1169 (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ (abs nlines
))) keep-props
))))
1172 (occur-engine-add-prefix
1173 (cdr (occur-accumulate-lines (1+ nlines
) keep-props
)))))))))
1174 ;; Actually insert the match display data
1175 (with-current-buffer out-buf
1177 (end (progn (insert data
) (point))))
1178 (unless (= nlines
0)
1179 (insert "-------\n")))))
1183 (setq lines
(1+ lines
))
1184 ;; On to the next match...
1186 (goto-char (point-max))))))
1187 (when (not (zerop matches
)) ;; is the count zero?
1188 (setq globalcount
(+ globalcount matches
))
1189 (with-current-buffer out-buf
1190 (goto-char headerpt
)
1193 (insert (format "%d match%s for \"%s\" in buffer: %s\n"
1194 matches
(if (= matches
1) "" "es")
1195 regexp
(buffer-name buf
)))
1197 (add-text-properties beg end
1200 `(font-lock-face ,title-face
))
1201 `(occur-title ,buf
))))
1202 (goto-char (point-min)))))))
1204 ;; CODING is buffer-file-coding-system of the first buffer
1205 ;; that locally binds it. Let's use it also for the output
1207 (set-buffer-file-coding-system coding
))
1208 ;; Return the number of matches
1212 ;; It would be nice to use \\[...], but there is no reasonable way
1213 ;; to make that display both SPC and Y.
1214 (defconst query-replace-help
1215 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1216 RET or `q' to exit, Period to replace one match and exit,
1217 Comma to replace but not move point immediately,
1218 C-r to enter recursive edit (\\[exit-recursive-edit] to get out again),
1219 C-w to delete match and recursive edit,
1220 C-l to clear the screen, redisplay, and offer same replacement again,
1221 ! to replace all remaining matches with no more questions,
1222 ^ to move point back to previous match,
1223 E to edit the replacement string"
1224 "Help message while in `query-replace'.")
1226 (defvar query-replace-map
(make-sparse-keymap)
1227 "Keymap that defines the responses to questions in `query-replace'.
1228 The \"bindings\" in this map are not commands; they are answers.
1229 The valid answers include `act', `skip', `act-and-show',
1230 `exit', `act-and-exit', `edit', `delete-and-edit', `recenter',
1231 `automatic', `backup', `exit-prefix', and `help'.")
1233 (define-key query-replace-map
" " 'act
)
1234 (define-key query-replace-map
"\d" 'skip
)
1235 (define-key query-replace-map
[delete] 'skip)
1236 (define-key query-replace-map [backspace] 'skip)
1237 (define-key query-replace-map "y" 'act)
1238 (define-key query-replace-map "n" 'skip)
1239 (define-key query-replace-map "Y" 'act)
1240 (define-key query-replace-map "N" 'skip)
1241 (define-key query-replace-map "e" 'edit-replacement)
1242 (define-key query-replace-map "E" 'edit-replacement)
1243 (define-key query-replace-map "," 'act-and-show)
1244 (define-key query-replace-map "q" 'exit)
1245 (define-key query-replace-map "\r" 'exit)
1246 (define-key query-replace-map [return] 'exit)
1247 (define-key query-replace-map "." 'act-and-exit)
1248 (define-key query-replace-map "\C-r" 'edit)
1249 (define-key query-replace-map "\C-w" 'delete-and-edit)
1250 (define-key query-replace-map "\C-l" 'recenter)
1251 (define-key query-replace-map "!" 'automatic)
1252 (define-key query-replace-map "^" 'backup)
1253 (define-key query-replace-map "\C-h" 'help)
1254 (define-key query-replace-map [f1] 'help)
1255 (define-key query-replace-map [help] 'help)
1256 (define-key query-replace-map "?" 'help)
1257 (define-key query-replace-map "\C-g" 'quit)
1258 (define-key query-replace-map "\C-]" 'quit)
1259 (define-key query-replace-map "\e" 'exit-prefix)
1260 (define-key query-replace-map [escape] 'exit-prefix)
1262 (defun replace-match-string-symbols (n)
1263 "Process a list (and any sub-lists), expanding certain symbols.
1265 N (match-string N) (where N is a string of digits)
1266 #N (string-to-number (match-string N))
1268 #& (string-to-number (match-string 0))
1271 Note that these symbols must be preceeded by a backslash in order to
1276 (replace-match-string-symbols (car n))) ;Process sub-list
1278 (let ((name (symbol-name (car n))))
1280 ((string-match "^[0-9]+$" name)
1281 (setcar n (list 'match-string (string-to-number name))))
1282 ((string-match "^#[0-9]+$" name)
1283 (setcar n (list 'string-to-number
1285 (string-to-number (substring name 1))))))
1287 (setcar n '(match-string 0)))
1288 ((string= "#&" name)
1289 (setcar n '(string-to-number (match-string 0))))
1291 (setcar n 'replace-count))))))
1294 (defun replace-eval-replacement (expression replace-count)
1295 (let ((replacement (eval expression)))
1296 (if (stringp replacement)
1298 (prin1-to-string replacement t))))
1300 (defun replace-quote (replacement)
1301 "Quote a replacement string.
1302 This just doubles all backslashes in REPLACEMENT and
1303 returns the resulting string. If REPLACEMENT is not
1304 a string, it is first passed through `prin1-to-string'
1305 with the `noescape' argument set.
1307 `match-data' is preserved across the call."
1309 (replace-regexp-in-string "\\\\" "\\\\"
1310 (if (stringp replacement)
1312 (prin1-to-string replacement t))
1315 (defun replace-loop-through-replacements (data replace-count)
1316 ;; DATA is a vector contaning the following values:
1317 ;; 0 next-rotate-count
1319 ;; 2 next-replacement
1321 (if (= (aref data 0) replace-count)
1323 (aset data 0 (+ replace-count (aref data 1)))
1324 (let ((next (cdr (aref data 2))))
1325 (aset data 2 (if (consp next) next (aref data 3))))))
1326 (car (aref data 2)))
1328 (defun replace-match-data (integers reuse &optional new)
1329 "Like `match-data', but markers in REUSE get invalidated.
1330 If NEW is non-NIL, it is set and returned instead of fresh data,
1331 but coerced to the correct value of INTEGERS."
1334 (set-match-data new)
1336 (eq (null integers) (markerp (car reuse)))
1338 (match-data integers reuse t)))
1340 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data)
1341 "Make a replacement with `replace-match', editing `\\?'.
1342 NEWTEXT, FIXEDCASE, LITERAL are just passed on. If NOEDIT is true, no
1343 check for `\\?' is made to save time. MATCH-DATA is used for the
1344 replacement. In case editing is done, it is changed to use markers.
1346 The return value is non-NIL if there has been no `\\?' or NOEDIT was
1347 passed in. If LITERAL is set, no checking is done, anyway."
1348 (unless (or literal noedit)
1350 (while (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\?\\)"
1353 (read-string "Edit replacement string: "
1356 (replace-match "" t t newtext 3)
1357 (1+ (match-beginning 3)))
1360 nil match-data match-data))))
1362 (set-match-data match-data)
1363 (replace-match newtext fixedcase literal)
1366 (defun perform-replace (from-string replacements
1367 query-flag regexp-flag delimited-flag
1368 &optional repeat-count map start end)
1369 "Subroutine of `query-replace'. Its complexity handles interactive queries.
1370 Don't use this in your own program unless you want to query and set the mark
1371 just as `query-replace' does. Instead, write a simple loop like this:
1373 (while (re-search-forward \"foo[ \\t]+bar\" nil t)
1374 (replace-match \"foobar\" nil nil))
1376 which will run faster and probably do exactly what you want. Please
1377 see the documentation of `replace-match' to find out how to simulate
1380 This function returns nil if and only if there were no matches to
1381 make, or the user didn't cancel the call."
1382 (or map (setq map query-replace-map))
1383 (and query-flag minibuffer-auto-raise
1384 (raise-frame (window-frame (minibuffer-window))))
1385 (let ((nocasify (not (and case-fold-search case-replace
1386 (string-equal from-string
1387 (downcase from-string)))))
1388 (case-fold-search (and case-fold-search
1389 (string-equal from-string
1390 (downcase from-string))))
1391 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
1392 (search-function (if regexp-flag 're-search-forward 'search-forward))
1393 (search-string from-string)
1394 (real-match-data nil) ; the match data for the current match
1395 (next-replacement nil)
1400 (nonempty-match nil)
1402 ;; If non-nil, it is marker saying where in the buffer to stop.
1405 ;; Data for the next match. If a cons, it has the same format as
1406 ;; (match-data); otherwise it is t if a match is possible at point.
1411 (substitute-command-keys
1412 "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) "))))
1414 ;; If region is active, in Transient Mark mode, operate on region.
1416 (setq limit (copy-marker (max start end)))
1417 (goto-char (min start end))
1420 ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
1421 ;; containing a function and its first argument. The function is
1422 ;; called to generate each replacement like this:
1423 ;; (funcall (car replacements) (cdr replacements) replace-count)
1424 ;; It must return a string.
1426 ((stringp replacements)
1427 (setq next-replacement replacements
1429 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
1430 (or repeat-count (setq repeat-count 1))
1431 (setq replacements (cons 'replace-loop-through-replacements
1432 (vector repeat-count repeat-count
1433 replacements replacements)))))
1436 (setq search-function 're-search-forward
1437 search-string (concat "\\b"
1438 (if regexp-flag from-string
1439 (regexp-quote from-string))
1441 (when query-replace-lazy-highlight
1442 (setq isearch-lazy-highlight-last-string nil))
1447 ;; Loop finding occurrences that perhaps should be replaced.
1448 (while (and keep-going
1449 (not (or (eobp) (and limit (>= (point) limit))))
1450 ;; Use the next match if it is already known;
1451 ;; otherwise, search for a match after moving forward
1452 ;; one char if progress is required.
1453 (setq real-match-data
1454 (if (consp match-again)
1455 (progn (goto-char (nth 1 match-again))
1456 (replace-match-data t
1459 (and (or match-again
1460 ;; MATCH-AGAIN non-nil means we
1461 ;; accept an adjacent match. If
1462 ;; we don't, move one char to the
1463 ;; right. This takes us a
1464 ;; character too far at the end,
1465 ;; but this is undone after the
1470 (and limit (>= (point) limit))))))
1471 (funcall search-function search-string limit t)
1472 ;; For speed, use only integers and
1473 ;; reuse the list used last time.
1474 (replace-match-data t real-match-data)))))
1475 ;; Optionally ignore matches that have a read-only property.
1476 (unless (and query-replace-skip-read-only
1477 (text-property-not-all
1478 (match-beginning 0) (match-end 0)
1481 ;; Record whether the match is nonempty, to avoid an infinite loop
1482 ;; repeatedly matching the same empty string.
1483 (setq nonempty-match
1484 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
1486 ;; If the match is empty, record that the next one can't be
1489 ;; Otherwise, if matching a regular expression, do the next
1490 ;; match now, since the replacement for this match may
1491 ;; affect whether the next match is adjacent to this one.
1492 ;; If that match is empty, don't use it.
1495 (or (not regexp-flag)
1496 (and (looking-at search-string)
1497 (let ((match (match-data)))
1498 (and (/= (nth 0 match) (nth 1 match))
1501 ;; Calculate the replacement string, if necessary.
1503 (set-match-data real-match-data)
1504 (setq next-replacement
1505 (funcall (car replacements) (cdr replacements)
1508 (if (not query-flag)
1509 (let ((inhibit-read-only
1510 query-replace-skip-read-only))
1511 (unless (or literal noedit)
1513 (nth 0 real-match-data) (nth 1 real-match-data)
1514 start end search-string
1515 (or delimited-flag regexp-flag) case-fold-search))
1517 (replace-match-maybe-edit
1518 next-replacement nocasify literal
1519 noedit real-match-data)
1520 replace-count (1+ replace-count)))
1522 (let (done replaced key def)
1523 ;; Loop reading commands until one of them sets done,
1524 ;; which means it has finished handling this
1525 ;; occurrence. Any command that sets `done' should
1526 ;; leave behind proper match data for the stack.
1527 ;; Commands not setting `done' need to adjust
1528 ;; `real-match-data'.
1530 (set-match-data real-match-data)
1532 (match-beginning 0) (match-end 0)
1533 start end search-string
1534 (or delimited-flag regexp-flag) case-fold-search)
1535 ;; Bind message-log-max so we don't fill up the message log
1536 ;; with a bunch of identical messages.
1537 (let ((message-log-max nil))
1539 (query-replace-descr from-string)
1540 (query-replace-descr next-replacement)))
1541 (setq key (read-event))
1542 ;; Necessary in case something happens during read-event
1543 ;; that clobbers the match data.
1544 (set-match-data real-match-data)
1545 (setq key (vector key))
1546 (setq def (lookup-key map key))
1547 ;; Restore the match data while we process the command.
1548 (cond ((eq def 'help)
1549 (with-output-to-temp-buffer "*Help*"
1551 (concat "Query replacing "
1552 (if regexp-flag "regexp " "")
1553 from-string " with "
1554 next-replacement ".\n\n"
1555 (substitute-command-keys
1556 query-replace-help)))
1557 (with-current-buffer standard-output
1560 (setq keep-going nil)
1564 (let ((elt (pop stack)))
1565 (goto-char (nth 0 elt))
1566 (setq replaced (nth 1 elt)
1571 (message "No previous match")
1572 (ding 'no-terminate)
1577 (replace-match-maybe-edit
1578 next-replacement nocasify literal
1579 noedit real-match-data)
1580 replace-count (1+ replace-count)))
1581 (setq done t replaced t))
1582 ((eq def 'act-and-exit)
1585 (replace-match-maybe-edit
1586 next-replacement nocasify literal
1587 noedit real-match-data)
1588 replace-count (1+ replace-count)))
1589 (setq keep-going nil)
1590 (setq done t replaced t))
1591 ((eq def 'act-and-show)
1594 (replace-match-maybe-edit
1595 next-replacement nocasify literal
1596 noedit real-match-data)
1597 replace-count (1+ replace-count)
1598 real-match-data (replace-match-data
1601 ((eq def 'automatic)
1604 (replace-match-maybe-edit
1605 next-replacement nocasify literal
1606 noedit real-match-data)
1607 replace-count (1+ replace-count)))
1608 (setq done t query-flag nil replaced t))
1614 (let ((opos (point-marker)))
1615 (setq real-match-data (replace-match-data
1618 (goto-char (match-beginning 0))
1620 (save-window-excursion
1623 (set-marker opos nil))
1624 ;; Before we make the replacement,
1625 ;; decide whether the search string
1626 ;; can match again just after this match.
1627 (if (and regexp-flag nonempty-match)
1628 (setq match-again (and (looking-at search-string)
1630 ;; Edit replacement.
1631 ((eq def 'edit-replacement)
1632 (setq real-match-data (replace-match-data
1636 (read-string "Edit replacement string: "
1640 (set-match-data real-match-data)
1642 (replace-match-maybe-edit
1643 next-replacement nocasify literal noedit
1648 ((eq def 'delete-and-edit)
1649 (replace-match "" t t)
1650 (setq real-match-data (replace-match-data
1651 nil real-match-data))
1652 (replace-dehighlight)
1653 (save-excursion (recursive-edit))
1655 ;; Note: we do not need to treat `exit-prefix'
1656 ;; specially here, since we reread
1657 ;; any unrecognized character.
1659 (setq this-command 'mode-exited)
1660 (setq keep-going nil)
1661 (setq unread-command-events
1662 (append (listify-key-sequence key)
1663 unread-command-events))
1665 (when query-replace-lazy-highlight
1666 ;; Force lazy rehighlighting only after replacements
1667 (if (not (memq def '(skip backup)))
1668 (setq isearch-lazy-highlight-last-string nil))))
1669 ;; Record previous position for ^ when we move on.
1670 ;; Change markers to numbers in the match data
1671 ;; since lots of markers slow down editing.
1672 (push (list (point) replaced
1673 ;;; If the replacement has already happened, all we need is the
1674 ;;; current match start and end. We could get this with a trivial
1676 ;;; (save-excursion (goto-char (match-beginning 0))
1677 ;;; (search-forward (match-string 0))
1679 ;;; if we really wanted to avoid manually constructing match data.
1680 ;;; Adding current-buffer is necessary so that match-data calls can
1681 ;;; return markers which are appropriate for editing.
1690 ;; The code preventing adjacent regexp matches in the condition
1691 ;; of the while-loop above will haven taken us one character
1692 ;; beyond the last replacement. Undo that.
1693 (when (and regexp-flag (not match-again) (> replace-count 0))
1696 (replace-dehighlight))
1697 (or unread-command-events
1698 (message "Replaced %d occurrence%s"
1700 (if (= replace-count 1) "" "s")))
1701 (and keep-going stack)))
1703 (defvar replace-overlay nil)
1705 (defun replace-highlight (match-beg match-end range-beg range-end
1706 string regexp case-fold)
1707 (if query-replace-highlight
1709 (move-overlay replace-overlay match-beg match-end (current-buffer))
1710 (setq replace-overlay (make-overlay match-beg match-end))
1711 (overlay-put replace-overlay 'priority 1) ;higher than lazy overlays
1712 (overlay-put replace-overlay 'face 'query-replace)))
1713 (if query-replace-lazy-highlight
1714 (let ((isearch-string string)
1715 (isearch-regexp regexp)
1716 (isearch-case-fold-search case-fold))
1717 (isearch-lazy-highlight-new-loop range-beg range-end))))
1719 (defun replace-dehighlight ()
1720 (when replace-overlay
1721 (delete-overlay replace-overlay))
1722 (when query-replace-lazy-highlight
1723 (lazy-highlight-cleanup lazy-highlight-cleanup)
1724 (setq isearch-lazy-highlight-last-string nil)))
1726 ;; arch-tag: 16b4cd61-fd40-497b-b86f-b667c4cf88e4
1727 ;;; replace.el ends here
HCoop / bpt / emacs.git / blob