1 ;;; replace.el --- replace commands for Emacs
3 ;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2011
4 ;; Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; This package supplies the string and regular-expression replace functions
27 ;; documented in the Emacs user's manual.
31 (defcustom case-replace t
32 "Non-nil means `query-replace' should preserve case in replacements."
36 (defvar query-replace-history nil
37 "Default history list for query-replace commands.
38 See `query-replace-from-history-variable' and
39 `query-replace-to-history-variable'.")
41 (defvar query-replace-defaults nil
42 "Default values of FROM-STRING and TO-STRING for `query-replace'.
43 This is a cons cell (FROM-STRING . TO-STRING), or nil if there is
46 (defvar query-replace-interactive nil
47 "Non-nil means `query-replace' uses the last search string.
48 That becomes the \"string to replace\".")
50 (defcustom query-replace-from-history-variable
'query-replace-history
51 "History list to use for the FROM argument of `query-replace' commands.
52 The value of this variable should be a symbol; that symbol
53 is used as a variable to hold a history list for the strings
54 or patterns to be replaced."
59 (defcustom query-replace-to-history-variable
'query-replace-history
60 "History list to use for the TO argument of `query-replace' commands.
61 The value of this variable should be a symbol; that symbol
62 is used as a variable to hold a history list for replacement
68 (defcustom query-replace-skip-read-only nil
69 "Non-nil means `query-replace' and friends ignore read-only matches."
74 (defcustom query-replace-show-replacement t
75 "Non-nil means to show what actual replacement text will be."
80 (defcustom query-replace-highlight t
81 "Non-nil means to highlight matches during query replacement."
85 (defcustom query-replace-lazy-highlight t
86 "Controls the lazy-highlighting during query replacements.
87 When non-nil, all text in the buffer matching the current match
88 is highlighted lazily using isearch lazy highlighting (see
89 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
91 :group
'lazy-highlight
95 (defface query-replace
96 '((t (:inherit isearch
)))
97 "Face for highlighting query replacement matches."
101 (defun query-replace-descr (string)
102 (mapconcat 'isearch-text-char-description string
""))
104 (defun query-replace-read-from (prompt regexp-flag
)
105 "Query and return the `from' argument of a query-replace operation.
106 The return value can also be a pair (FROM . TO) indicating that the user
107 wants to replace FROM with TO."
108 (if query-replace-interactive
109 (car (if regexp-flag regexp-search-ring search-ring
))
110 (let* ((history-add-new-input nil
)
112 ;; The save-excursion here is in case the user marks and copies
113 ;; a region in order to specify the minibuffer input.
114 ;; That should not clobber the region for the query-replace itself.
116 (read-from-minibuffer
117 (if query-replace-defaults
118 (format "%s (default %s -> %s): " prompt
119 (query-replace-descr (car query-replace-defaults
))
120 (query-replace-descr (cdr query-replace-defaults
)))
121 (format "%s: " prompt
))
123 query-replace-from-history-variable
125 (if (and (zerop (length from
)) query-replace-defaults
)
126 (cons (car query-replace-defaults
)
127 (query-replace-compile-replacement
128 (cdr query-replace-defaults
) regexp-flag
))
129 (add-to-history query-replace-from-history-variable from nil t
)
130 ;; Warn if user types \n or \t, but don't reject the input.
132 (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\[nt]\\)" from
)
133 (let ((match (match-string 3 from
)))
135 ((string= match
"\\n")
136 (message "Note: `\\n' here doesn't match a newline; to do that, type C-q C-j instead"))
137 ((string= match
"\\t")
138 (message "Note: `\\t' here doesn't match a tab; to do that, just type TAB")))
142 (defun query-replace-compile-replacement (to regexp-flag
)
143 "Maybe convert a regexp replacement TO to Lisp.
144 Returns a list suitable for `perform-replace' if necessary,
145 the original string if not."
147 (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to
))
151 (setq pos
(match-end 0))
152 (push (substring to
0 (- pos
2)) list
)
153 (setq char
(aref to
(1- pos
))
154 to
(substring to pos
))
156 (push '(number-to-string replace-count
) list
))
158 (setq pos
(read-from-string to
))
159 (push `(replace-quote ,(car pos
)) list
)
161 ;; Swallow a space after a symbol
162 ;; if there is a space.
163 (if (and (or (symbolp (car pos
))
164 ;; Swallow a space after 'foo
165 ;; but not after (quote foo).
166 (and (eq (car-safe (car pos
)) 'quote
)
167 (not (= ?\
( (aref to
0)))))
168 (eq (string-match " " to
(cdr pos
))
172 (setq to
(substring to end
)))))
173 (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to
)))
174 (setq to
(nreverse (delete "" (cons to list
))))
175 (replace-match-string-symbols to
)
176 (cons 'replace-eval-replacement
183 (defun query-replace-read-to (from prompt regexp-flag
)
184 "Query and return the `to' argument of a query-replace operation."
185 (query-replace-compile-replacement
187 (let* ((history-add-new-input nil
)
188 (to (read-from-minibuffer
189 (format "%s %s with: " prompt
(query-replace-descr from
))
191 query-replace-to-history-variable from t
)))
192 (add-to-history query-replace-to-history-variable to nil t
)
193 (setq query-replace-defaults
(cons from to
))
197 (defun query-replace-read-args (prompt regexp-flag
&optional noerror
)
199 (barf-if-buffer-read-only))
200 (let* ((from (query-replace-read-from prompt regexp-flag
))
201 (to (if (consp from
) (prog1 (cdr from
) (setq from
(car from
)))
202 (query-replace-read-to from prompt regexp-flag
))))
203 (list from to current-prefix-arg
)))
205 (defun query-replace (from-string to-string
&optional delimited start end
)
206 "Replace some occurrences of FROM-STRING with TO-STRING.
207 As each match is found, the user must type a character saying
208 what to do with it. For directions, type \\[help-command] at that time.
210 In Transient Mark mode, if the mark is active, operate on the contents
211 of the region. Otherwise, operate from point to the end of the buffer.
213 If `query-replace-interactive' is non-nil, the last incremental search
214 string is used as FROM-STRING--you don't have to specify it with the
217 Matching is independent of case if `case-fold-search' is non-nil and
218 FROM-STRING has no uppercase letters. Replacement transfers the case
219 pattern of the old text to the new text, if `case-replace' and
220 `case-fold-search' are non-nil and FROM-STRING has no uppercase
221 letters. \(Transferring the case pattern means that if the old text
222 matched is all caps, or capitalized, then its replacement is upcased
225 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
226 only matches surrounded by word boundaries.
227 Fourth and fifth arg START and END specify the region to operate on.
229 To customize possible responses, change the \"bindings\" in `query-replace-map'."
232 (query-replace-read-args
233 (concat "Query replace"
234 (if current-prefix-arg
" word" "")
235 (if (and transient-mark-mode mark-active
) " in region" ""))
237 (list (nth 0 common
) (nth 1 common
) (nth 2 common
)
238 ;; These are done separately here
239 ;; so that command-history will record these expressions
240 ;; rather than the values they had this time.
241 (if (and transient-mark-mode mark-active
)
243 (if (and transient-mark-mode mark-active
)
245 (perform-replace from-string to-string t nil delimited nil nil start end
))
247 (define-key esc-map
"%" 'query-replace
)
249 (defun query-replace-regexp (regexp to-string
&optional delimited start end
)
250 "Replace some things after point matching REGEXP with TO-STRING.
251 As each match is found, the user must type a character saying
252 what to do with it. For directions, type \\[help-command] at that time.
254 In Transient Mark mode, if the mark is active, operate on the contents
255 of the region. Otherwise, operate from point to the end of the buffer.
257 If `query-replace-interactive' is non-nil, the last incremental search
258 regexp is used as REGEXP--you don't have to specify it with the
261 Matching is independent of case if `case-fold-search' is non-nil and
262 REGEXP has no uppercase letters. Replacement transfers the case
263 pattern of the old text to the new text, if `case-replace' and
264 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
265 \(Transferring the case pattern means that if the old text matched is
266 all caps, or capitalized, then its replacement is upcased or
269 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
270 only matches surrounded by word boundaries.
271 Fourth and fifth arg START and END specify the region to operate on.
273 In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
274 and `\\=\\N' (where N is a digit) stands for
275 whatever what matched the Nth `\\(...\\)' in REGEXP.
276 `\\?' lets you edit the replacement text in the minibuffer
277 at the given position for each replacement.
279 In interactive calls, the replacement text can contain `\\,'
280 followed by a Lisp expression. Each
281 replacement evaluates that expression to compute the replacement
282 string. Inside of that expression, `\\&' is a string denoting the
283 whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
284 for the whole or a partial match converted to a number with
285 `string-to-number', and `\\#' itself for the number of replacements
286 done so far (starting with zero).
288 If the replacement expression is a symbol, write a space after it
289 to terminate it. One space there, if any, will be discarded.
291 When using those Lisp features interactively in the replacement
292 text, TO-STRING is actually made a list instead of a string.
293 Use \\[repeat-complex-command] after this command for details."
296 (query-replace-read-args
297 (concat "Query replace"
298 (if current-prefix-arg
" word" "")
300 (if (and transient-mark-mode mark-active
) " in region" ""))
302 (list (nth 0 common
) (nth 1 common
) (nth 2 common
)
303 ;; These are done separately here
304 ;; so that command-history will record these expressions
305 ;; rather than the values they had this time.
306 (if (and transient-mark-mode mark-active
)
308 (if (and transient-mark-mode mark-active
)
310 (perform-replace regexp to-string t t delimited nil nil start end
))
312 (define-key esc-map
[?\C-%
] 'query-replace-regexp
)
314 (defun query-replace-regexp-eval (regexp to-expr
&optional delimited start end
)
315 "Replace some things after point matching REGEXP with the result of TO-EXPR.
317 Interactive use of this function is deprecated in favor of the
318 `\\,' feature of `query-replace-regexp'. For non-interactive use, a loop
319 using `search-forward-regexp' and `replace-match' is preferred.
321 As each match is found, the user must type a character saying
322 what to do with it. For directions, type \\[help-command] at that time.
324 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
325 reference `replace-count' to get the number of replacements already made.
326 If the result of TO-EXPR is not a string, it is converted to one using
327 `prin1-to-string' with the NOESCAPE argument (which see).
329 For convenience, when entering TO-EXPR interactively, you can use `\\&' or
330 `\\0' to stand for whatever matched the whole of REGEXP, and `\\N' (where
331 N is a digit) to stand for whatever matched the Nth `\\(...\\)' in REGEXP.
332 Use `\\#&' or `\\#N' if you want a number instead of a string.
333 In interactive use, `\\#' in itself stands for `replace-count'.
335 In Transient Mark mode, if the mark is active, operate on the contents
336 of the region. Otherwise, operate from point to the end of the buffer.
338 If `query-replace-interactive' is non-nil, the last incremental search
339 regexp is used as REGEXP--you don't have to specify it with the
342 Preserves case in each replacement if `case-replace' and `case-fold-search'
343 are non-nil and REGEXP has no uppercase letters.
345 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
346 only matches that are surrounded by word boundaries.
347 Fourth and fifth arg START and END specify the region to operate on."
350 (barf-if-buffer-read-only)
352 ;; Let-bind the history var to disable the "foo -> bar" default.
353 ;; Maybe we shouldn't disable this default, but for now I'll
354 ;; leave it off. --Stef
355 (let ((query-replace-to-history-variable nil
))
356 (query-replace-read-from "Query replace regexp" t
)))
357 (to (list (read-from-minibuffer
358 (format "Query replace regexp %s with eval: "
359 (query-replace-descr from
))
360 nil nil t query-replace-to-history-variable from t
))))
361 ;; We make TO a list because replace-match-string-symbols requires one,
362 ;; and the user might enter a single token.
363 (replace-match-string-symbols to
)
364 (list from
(car to
) current-prefix-arg
365 (if (and transient-mark-mode mark-active
)
367 (if (and transient-mark-mode mark-active
)
369 (perform-replace regexp
(cons 'replace-eval-replacement to-expr
)
370 t
'literal delimited nil nil start end
))
372 (make-obsolete 'query-replace-regexp-eval
373 "for interactive use, use the special `\\,' feature of
374 `query-replace-regexp' instead. Non-interactively, a loop
375 using `search-forward-regexp' and `replace-match' is preferred." "22.1")
377 (defun map-query-replace-regexp (regexp to-strings
&optional n start end
)
378 "Replace some matches for REGEXP with various strings, in rotation.
379 The second argument TO-STRINGS contains the replacement strings, separated
380 by spaces. This command works like `query-replace-regexp' except that
381 each successive replacement uses the next successive replacement string,
382 wrapping around from the last such string to the first.
384 In Transient Mark mode, if the mark is active, operate on the contents
385 of the region. Otherwise, operate from point to the end of the buffer.
387 Non-interactively, TO-STRINGS may be a list of replacement strings.
389 If `query-replace-interactive' is non-nil, the last incremental search
390 regexp is used as REGEXP--you don't have to specify it with the minibuffer.
392 A prefix argument N says to use each replacement string N times
393 before rotating to the next.
394 Fourth and fifth arg START and END specify the region to operate on."
396 (let* ((from (if query-replace-interactive
397 (car regexp-search-ring
)
398 (read-from-minibuffer "Map query replace (regexp): "
400 query-replace-from-history-variable
402 (to (read-from-minibuffer
403 (format "Query replace %s with (space-separated strings): "
404 (query-replace-descr from
))
406 query-replace-to-history-variable from t
)))
408 (and current-prefix-arg
409 (prefix-numeric-value current-prefix-arg
))
410 (if (and transient-mark-mode mark-active
)
412 (if (and transient-mark-mode mark-active
)
415 (if (listp to-strings
)
416 (setq replacements to-strings
)
417 (while (/= (length to-strings
) 0)
418 (if (string-match " " to-strings
)
421 (list (substring to-strings
0
422 (string-match " " to-strings
))))
423 to-strings
(substring to-strings
424 (1+ (string-match " " to-strings
))))
425 (setq replacements
(append replacements
(list to-strings
))
427 (perform-replace regexp replacements t t nil n nil start end
)))
429 (defun replace-string (from-string to-string
&optional delimited start end
)
430 "Replace occurrences of FROM-STRING with TO-STRING.
431 Preserve case in each match if `case-replace' and `case-fold-search'
432 are non-nil and FROM-STRING has no uppercase letters.
433 \(Preserving case means that if the string matched is all caps, or capitalized,
434 then its replacement is upcased or capitalized.)
436 In Transient Mark mode, if the mark is active, operate on the contents
437 of the region. Otherwise, operate from point to the end of the buffer.
439 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
440 only matches surrounded by word boundaries.
441 Fourth and fifth arg START and END specify the region to operate on.
443 If `query-replace-interactive' is non-nil, the last incremental search
444 string is used as FROM-STRING--you don't have to specify it with the
447 This function is usually the wrong thing to use in a Lisp program.
448 What you probably want is a loop like this:
449 (while (search-forward FROM-STRING nil t)
450 (replace-match TO-STRING nil t))
451 which will run faster and will not set the mark or print anything.
452 \(You may need a more complex loop if FROM-STRING can match the null string
453 and TO-STRING is also null.)"
456 (query-replace-read-args
458 (if current-prefix-arg
" word" "")
460 (if (and transient-mark-mode mark-active
) " in region" ""))
462 (list (nth 0 common
) (nth 1 common
) (nth 2 common
)
463 (if (and transient-mark-mode mark-active
)
465 (if (and transient-mark-mode mark-active
)
467 (perform-replace from-string to-string nil nil delimited nil nil start end
))
469 (defun replace-regexp (regexp to-string
&optional delimited start end
)
470 "Replace things after point matching REGEXP with TO-STRING.
471 Preserve case in each match if `case-replace' and `case-fold-search'
472 are non-nil and REGEXP has no uppercase letters.
474 In Transient Mark mode, if the mark is active, operate on the contents
475 of the region. Otherwise, operate from point to the end of the buffer.
477 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
478 only matches surrounded by word boundaries.
479 Fourth and fifth arg START and END specify the region to operate on.
481 In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
482 and `\\=\\N' (where N is a digit) stands for
483 whatever what matched the Nth `\\(...\\)' in REGEXP.
484 `\\?' lets you edit the replacement text in the minibuffer
485 at the given position for each replacement.
487 In interactive calls, the replacement text may contain `\\,'
488 followed by a Lisp expression used as part of the replacement
489 text. Inside of that expression, `\\&' is a string denoting the
490 whole match, `\\N' a partial match, `\\#&' and `\\#N' the respective
491 numeric values from `string-to-number', and `\\#' itself for
492 `replace-count', the number of replacements occurred so far.
494 If your Lisp expression is an identifier and the next letter in
495 the replacement string would be interpreted as part of it, you
496 can wrap it with an expression like `\\,(or \\#)'. Incidentally,
497 for this particular case you may also enter `\\#' in the
498 replacement text directly.
500 When using those Lisp features interactively in the replacement
501 text, TO-STRING is actually made a list instead of a string.
502 Use \\[repeat-complex-command] after this command for details.
504 If `query-replace-interactive' is non-nil, the last incremental search
505 regexp is used as REGEXP--you don't have to specify it with the minibuffer.
507 This function is usually the wrong thing to use in a Lisp program.
508 What you probably want is a loop like this:
509 (while (re-search-forward REGEXP nil t)
510 (replace-match TO-STRING nil nil))
511 which will run faster and will not set the mark or print anything."
514 (query-replace-read-args
516 (if current-prefix-arg
" word" "")
518 (if (and transient-mark-mode mark-active
) " in region" ""))
520 (list (nth 0 common
) (nth 1 common
) (nth 2 common
)
521 (if (and transient-mark-mode mark-active
)
523 (if (and transient-mark-mode mark-active
)
525 (perform-replace regexp to-string nil t delimited nil nil start end
))
528 (defvar regexp-history nil
529 "History list for some commands that read regular expressions.
531 Maximum length of the history list is determined by the value
532 of `history-length', which see.")
534 (defvar occur-collect-regexp-history
'("\\1")
535 "History of regexp for occur's collect operation")
537 (defun read-regexp (prompt &optional default-value
)
538 "Read regexp as a string using the regexp history and some useful defaults.
539 Prompt for a regular expression with PROMPT (without a colon and
540 space) in the minibuffer. The optional argument DEFAULT-VALUE
541 provides the value to display in the minibuffer prompt that is
542 returned if the user just types RET.
543 Values available via M-n are the string at point, the last isearch
544 regexp, the last isearch string, and the last replacement regexp."
547 (or (funcall (or find-tag-default-function
548 (get major-mode
'find-tag-default-function
)
551 (car regexp-search-ring
)
552 (regexp-quote (or (car search-ring
) ""))
554 query-replace-from-history-variable
))))
555 (defaults (delete-dups (delq nil
(delete "" defaults
))))
556 ;; Don't add automatically the car of defaults for empty input
557 (history-add-new-input nil
)
559 (read-from-minibuffer
561 (format "%s (default %s): " prompt
562 (query-replace-descr default-value
))
563 (format "%s: " prompt
))
564 nil nil nil
'regexp-history defaults t
)))
566 (or default-value input
)
568 (add-to-history 'regexp-history input
)))))
571 (defalias 'delete-non-matching-lines
'keep-lines
)
572 (defalias 'delete-matching-lines
'flush-lines
)
573 (defalias 'count-matches
'how-many
)
576 (defun keep-lines-read-args (prompt)
577 "Read arguments for `keep-lines' and friends.
578 Prompt for a regexp with PROMPT.
579 Value is a list, (REGEXP)."
580 (list (read-regexp prompt
) nil nil t
))
582 (defun keep-lines (regexp &optional rstart rend interactive
)
583 "Delete all lines except those containing matches for REGEXP.
584 A match split across lines preserves all the lines it lies in.
585 When called from Lisp (and usually interactively as well, see below)
586 applies to all lines starting after point.
588 If REGEXP contains upper case characters (excluding those preceded by `\\')
589 and `search-upper-case' is non-nil, the matching is case-sensitive.
591 Second and third arg RSTART and REND specify the region to operate on.
592 This command operates on (the accessible part of) all lines whose
593 accessible part is entirely contained in the region determined by RSTART
594 and REND. (A newline ending a line counts as part of that line.)
596 Interactively, in Transient Mark mode when the mark is active, operate
597 on all lines whose accessible part is entirely contained in the region.
598 Otherwise, the command applies to all lines starting after point.
599 When calling this function from Lisp, you can pretend that it was
600 called interactively by passing a non-nil INTERACTIVE argument.
602 This function starts looking for the next match from the end of
603 the previous match. Hence, it ignores matches that overlap
604 a previously found match."
608 (barf-if-buffer-read-only)
609 (keep-lines-read-args "Keep lines containing match for regexp")))
612 (goto-char (min rstart rend
))
616 (goto-char (max rstart rend
))
617 (unless (or (bolp) (eobp))
620 (if (and interactive transient-mark-mode mark-active
)
621 (setq rstart
(region-beginning)
623 (goto-char (region-end))
624 (unless (or (bolp) (eobp))
628 rend
(point-max-marker)))
631 (or (bolp) (forward-line 1))
632 (let ((start (point))
634 (if (and case-fold-search search-upper-case
)
635 (isearch-no-upper-case-p regexp t
)
637 (while (< (point) rend
)
638 ;; Start is first char not preserved by previous match.
639 (if (not (re-search-forward regexp rend
'move
))
640 (delete-region start rend
)
641 (let ((end (save-excursion (goto-char (match-beginning 0))
644 ;; Now end is first char preserved by the new match.
646 (delete-region start end
))))
648 (setq start
(save-excursion (forward-line 1) (point)))
649 ;; If the match was empty, avoid matching again at same place.
650 (and (< (point) rend
)
651 (= (match-beginning 0) (match-end 0))
653 (set-marker rend nil
)
657 (defun flush-lines (regexp &optional rstart rend interactive
)
658 "Delete lines containing matches for REGEXP.
659 When called from Lisp (and usually when called interactively as
660 well, see below), applies to the part of the buffer after point.
661 The line point is in is deleted if and only if it contains a
662 match for regexp starting after point.
664 If REGEXP contains upper case characters (excluding those preceded by `\\')
665 and `search-upper-case' is non-nil, the matching is case-sensitive.
667 Second and third arg RSTART and REND specify the region to operate on.
668 Lines partially contained in this region are deleted if and only if
669 they contain a match entirely contained in it.
671 Interactively, in Transient Mark mode when the mark is active, operate
672 on the contents of the region. Otherwise, operate from point to the
673 end of (the accessible portion of) the buffer. When calling this function
674 from Lisp, you can pretend that it was called interactively by passing
675 a non-nil INTERACTIVE argument.
677 If a match is split across lines, all the lines it lies in are deleted.
678 They are deleted _before_ looking for the next match. Hence, a match
679 starting on the same line at which another match ended is ignored."
683 (barf-if-buffer-read-only)
684 (keep-lines-read-args "Flush lines containing match for regexp")))
687 (goto-char (min rstart rend
))
688 (setq rend
(copy-marker (max rstart rend
))))
689 (if (and interactive transient-mark-mode mark-active
)
690 (setq rstart
(region-beginning)
691 rend
(copy-marker (region-end)))
693 rend
(point-max-marker)))
695 (let ((case-fold-search
696 (if (and case-fold-search search-upper-case
)
697 (isearch-no-upper-case-p regexp t
)
700 (while (and (< (point) rend
)
701 (re-search-forward regexp rend t
))
702 (delete-region (save-excursion (goto-char (match-beginning 0))
705 (progn (forward-line 1) (point))))))
706 (set-marker rend nil
)
710 (defun how-many (regexp &optional rstart rend interactive
)
711 "Print and return number of matches for REGEXP following point.
712 When called from Lisp and INTERACTIVE is omitted or nil, just return
713 the number, do not print it; if INTERACTIVE is t, the function behaves
714 in all respects as if it had been called interactively.
716 If REGEXP contains upper case characters (excluding those preceded by `\\')
717 and `search-upper-case' is non-nil, the matching is case-sensitive.
719 Second and third arg RSTART and REND specify the region to operate on.
721 Interactively, in Transient Mark mode when the mark is active, operate
722 on the contents of the region. Otherwise, operate from point to the
723 end of (the accessible portion of) the buffer.
725 This function starts looking for the next match from the end of
726 the previous match. Hence, it ignores matches that overlap
727 a previously found match."
730 (keep-lines-read-args "How many matches for regexp"))
734 (goto-char (min rstart rend
))
735 (setq rend
(max rstart rend
)))
736 (if (and interactive transient-mark-mode mark-active
)
737 (setq rstart
(region-beginning)
745 (if (and case-fold-search search-upper-case
)
746 (isearch-no-upper-case-p regexp t
)
748 (while (and (< (point) rend
)
749 (progn (setq opoint
(point))
750 (re-search-forward regexp rend t
)))
751 (if (= opoint
(point))
753 (setq count
(1+ count
))))
754 (when interactive
(message "%d occurrence%s"
756 (if (= count
1) "" "s")))
760 (defvar occur-mode-map
761 (let ((map (make-sparse-keymap)))
762 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
763 (define-key map
[mouse-2
] 'occur-mode-mouse-goto
)
764 (define-key map
"\C-c\C-c" 'occur-mode-goto-occurrence
)
765 (define-key map
"\C-m" 'occur-mode-goto-occurrence
)
766 (define-key map
"o" 'occur-mode-goto-occurrence-other-window
)
767 (define-key map
"\C-o" 'occur-mode-display-occurrence
)
768 (define-key map
"\M-n" 'occur-next
)
769 (define-key map
"\M-p" 'occur-prev
)
770 (define-key map
"r" 'occur-rename-buffer
)
771 (define-key map
"c" 'clone-buffer
)
772 (define-key map
"\C-c\C-f" 'next-error-follow-minor-mode
)
773 (define-key map
[menu-bar
] (make-sparse-keymap))
774 (define-key map
[menu-bar occur
]
775 `(cons ,(purecopy "Occur") map
))
776 (define-key map
[next-error-follow-minor-mode
]
777 (menu-bar-make-mm-toggle next-error-follow-minor-mode
778 "Auto Occurrence Display"
779 "Display another occurrence when moving the cursor"))
780 (define-key map
[separator-1
] menu-bar-separator
)
781 (define-key map
[kill-this-buffer
]
782 `(menu-item ,(purecopy "Kill occur buffer") kill-this-buffer
783 :help
,(purecopy "Kill the current *Occur* buffer")))
784 (define-key map
[quit-window
]
785 `(menu-item ,(purecopy "Quit occur window") quit-window
786 :help
,(purecopy "Quit the current *Occur* buffer. Bury it, and maybe delete the selected frame")))
787 (define-key map
[revert-buffer
]
788 `(menu-item ,(purecopy "Revert occur buffer") revert-buffer
789 :help
,(purecopy "Replace the text in the *Occur* buffer with the results of rerunning occur")))
790 (define-key map
[clone-buffer
]
791 `(menu-item ,(purecopy "Clone occur buffer") clone-buffer
792 :help
,(purecopy "Create and return a twin copy of the current *Occur* buffer")))
793 (define-key map
[occur-rename-buffer
]
794 `(menu-item ,(purecopy "Rename occur buffer") occur-rename-buffer
795 :help
,(purecopy "Rename the current *Occur* buffer to *Occur: original-buffer-name*.")))
796 (define-key map
[separator-2
] menu-bar-separator
)
797 (define-key map
[occur-mode-goto-occurrence-other-window
]
798 `(menu-item ,(purecopy "Go To Occurrence Other Window") occur-mode-goto-occurrence-other-window
799 :help
,(purecopy "Go to the occurrence the current line describes, in another window")))
800 (define-key map
[occur-mode-goto-occurrence
]
801 `(menu-item ,(purecopy "Go To Occurrence") occur-mode-goto-occurrence
802 :help
,(purecopy "Go to the occurrence the current line describes")))
803 (define-key map
[occur-mode-display-occurrence
]
804 `(menu-item ,(purecopy "Display Occurrence") occur-mode-display-occurrence
805 :help
,(purecopy "Display in another window the occurrence the current line describes")))
806 (define-key map
[occur-next
]
807 `(menu-item ,(purecopy "Move to next match") occur-next
808 :help
,(purecopy "Move to the Nth (default 1) next match in an Occur mode buffer")))
809 (define-key map
[occur-prev
]
810 `(menu-item ,(purecopy "Move to previous match") occur-prev
811 :help
,(purecopy "Move to the Nth (default 1) previous match in an Occur mode buffer")))
813 "Keymap for `occur-mode'.")
815 (defvar occur-revert-arguments nil
816 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
817 See `occur-revert-function'.")
819 (defcustom occur-mode-hook
'(turn-on-font-lock)
820 "Hook run when entering Occur mode."
824 (defcustom occur-hook nil
825 "Hook run by Occur when there are any matches."
829 (defcustom occur-mode-find-occurrence-hook nil
830 "Hook run by Occur after locating an occurrence.
831 This will be called with the cursor position at the occurrence. An application
832 for this is to reveal context in an outline-mode when the occurrence is hidden."
836 (put 'occur-mode
'mode-class
'special
)
837 (define-derived-mode occur-mode special-mode
"Occur"
838 "Major mode for output from \\[occur].
839 \\<occur-mode-map>Move point to one of the items in this buffer, then use
840 \\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to.
841 Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it.
844 (set (make-local-variable 'revert-buffer-function
) 'occur-revert-function
)
845 (make-local-variable 'occur-revert-arguments
)
846 (add-hook 'change-major-mode-hook
'font-lock-defontify nil t
)
847 (setq next-error-function
'occur-next-error
))
849 (defun occur-revert-function (ignore1 ignore2
)
850 "Handle `revert-buffer' for Occur mode buffers."
851 (apply 'occur-1
(append occur-revert-arguments
(list (buffer-name)))))
853 (defun occur-mode-find-occurrence ()
854 (let ((pos (get-text-property (point) 'occur-target
)))
856 (error "No occurrence on this line"))
857 (unless (buffer-live-p (marker-buffer pos
))
858 (error "Buffer for this occurrence was killed"))
861 (defalias 'occur-mode-mouse-goto
'occur-mode-goto-occurrence
)
862 (defun occur-mode-goto-occurrence (&optional event
)
863 "Go to the occurrence the current line describes."
864 (interactive (list last-nonmenu-event
))
867 ;; Actually `event-end' works correctly with a nil argument as
868 ;; well, so we could dispense with this test, but let's not
869 ;; rely on this undocumented behavior.
870 (occur-mode-find-occurrence)
871 (with-current-buffer (window-buffer (posn-window (event-end event
)))
873 (goto-char (posn-point (event-end event
)))
874 (occur-mode-find-occurrence)))))
875 same-window-buffer-names
877 (pop-to-buffer (marker-buffer pos
))
879 (run-hooks 'occur-mode-find-occurrence-hook
)))
881 (defun occur-mode-goto-occurrence-other-window ()
882 "Go to the occurrence the current line describes, in another window."
884 (let ((pos (occur-mode-find-occurrence)))
885 (switch-to-buffer-other-window (marker-buffer pos
))
887 (run-hooks 'occur-mode-find-occurrence-hook
)))
889 (defun occur-mode-display-occurrence ()
890 "Display in another window the occurrence the current line describes."
892 (let ((pos (occur-mode-find-occurrence))
894 ;; Bind these to ensure `display-buffer' puts it in another window.
895 same-window-buffer-names
897 (setq window
(display-buffer (marker-buffer pos
)))
898 ;; This is the way to set point in the proper window.
899 (save-selected-window
900 (select-window window
)
902 (run-hooks 'occur-mode-find-occurrence-hook
))))
904 (defun occur-find-match (n search message
)
905 (if (not n
) (setq n
1))
908 (setq r
(funcall search
(point) 'occur-match
))
910 (get-text-property r
'occur-match
)
911 (setq r
(funcall search r
'occur-match
)))
917 (defun occur-next (&optional n
)
918 "Move to the Nth (default 1) next match in an Occur mode buffer."
920 (occur-find-match n
#'next-single-property-change
"No more matches"))
922 (defun occur-prev (&optional n
)
923 "Move to the Nth (default 1) previous match in an Occur mode buffer."
925 (occur-find-match n
#'previous-single-property-change
"No earlier matches"))
927 (defun occur-next-error (&optional argp reset
)
928 "Move to the Nth (default 1) next match in an Occur mode buffer.
929 Compatibility function for \\[next-error] invocations."
931 ;; we need to run occur-find-match from within the Occur buffer
933 ;; Choose the buffer and make it current.
934 (if (next-error-buffer-p (current-buffer))
936 (next-error-find-buffer nil nil
938 (eq major-mode
'occur-mode
))))
940 (goto-char (cond (reset (point-min))
941 ((< argp
0) (line-beginning-position))
942 ((> argp
0) (line-end-position))
947 #'previous-single-property-change
948 #'next-single-property-change
)
950 ;; In case the *Occur* buffer is visible in a nonselected window.
951 (let ((win (get-buffer-window (current-buffer) t
)))
952 (if win
(set-window-point win
(point))))
953 (occur-mode-goto-occurrence)))
956 '((((class color
) (min-colors 88) (background light
))
957 :background
"yellow1")
958 (((class color
) (min-colors 88) (background dark
))
959 :background
"RoyalBlue3")
960 (((class color
) (min-colors 8) (background light
))
961 :background
"yellow" :foreground
"black")
962 (((class color
) (min-colors 8) (background dark
))
963 :background
"blue" :foreground
"white")
964 (((type tty
) (class mono
))
966 (t :background
"gray"))
967 "Face used to highlight matches permanently."
971 (defcustom list-matching-lines-default-context-lines
0
972 "Default number of context lines included around `list-matching-lines' matches.
973 A negative number means to include that many lines before the match.
974 A positive number means to include that many lines both before and after."
978 (defalias 'list-matching-lines
'occur
)
980 (defcustom list-matching-lines-face
'match
981 "Face used by \\[list-matching-lines] to show the text that matches.
982 If the value is nil, don't highlight the matching portions specially."
986 (defcustom list-matching-lines-buffer-name-face
'underline
987 "Face used by \\[list-matching-lines] to show the names of buffers.
988 If the value is nil, don't highlight the buffer names specially."
992 (defcustom occur-excluded-properties
993 '(read-only invisible intangible field mouse-face help-echo local-map keymap
994 yank-handler follow-link
)
995 "Text properties to discard when copying lines to the *Occur* buffer.
996 The value should be a list of text properties to discard or t,
997 which means to discard all text properties."
998 :type
'(choice (const :tag
"All" t
) (repeat symbol
))
1002 (defun occur-read-primary-args ()
1003 (let* ((perform-collect (consp current-prefix-arg
))
1004 (regexp (read-regexp (if perform-collect
1005 "Collect strings matching regexp"
1006 "List lines matching regexp")
1007 (car regexp-history
))))
1010 ;; Perform collect operation
1011 (if (zerop (regexp-opt-depth regexp
))
1012 ;; No subexpression so collect the entire match.
1014 ;; Get the regexp for collection pattern.
1015 (let ((default (car occur-collect-regexp-history
)))
1017 (format "Regexp to collect (default %s): " default
)
1018 nil
'occur-collect-regexp-history default
)))
1019 ;; Otherwise normal occur takes numerical prefix argument.
1020 (when current-prefix-arg
1021 (prefix-numeric-value current-prefix-arg
))))))
1023 (defun occur-rename-buffer (&optional unique-p interactive-p
)
1024 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1025 Here `original-buffer-name' is the buffer name where Occur was originally run.
1026 When given the prefix argument, or called non-interactively, the renaming
1027 will not clobber the existing buffer(s) of that name, but use
1028 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1029 if you always want a separate *Occur* buffer for each buffer where you
1031 (interactive "P\np")
1032 (with-current-buffer
1033 (if (eq major-mode
'occur-mode
) (current-buffer) (get-buffer "*Occur*"))
1034 (rename-buffer (concat "*Occur: "
1035 (mapconcat #'buffer-name
1036 (car (cddr occur-revert-arguments
)) "/")
1038 (or unique-p
(not interactive-p
)))))
1040 (defun occur (regexp &optional nlines
)
1041 "Show all lines in the current buffer containing a match for REGEXP.
1042 If a match spreads across multiple lines, all those lines are shown.
1044 Each line is displayed with NLINES lines before and after, or -NLINES
1045 before if NLINES is negative.
1046 NLINES defaults to `list-matching-lines-default-context-lines'.
1047 Interactively it is the prefix arg.
1049 The lines are shown in a buffer named `*Occur*'.
1050 It serves as a menu to find any of the occurrences in this buffer.
1051 \\<occur-mode-map>\\[describe-mode] in that buffer will explain how.
1053 If REGEXP contains upper case characters (excluding those preceded by `\\')
1054 and `search-upper-case' is non-nil, the matching is case-sensitive.
1056 When NLINES is a string or when the function is called
1057 interactively with prefix argument without a number (`C-u' alone
1058 as prefix) the matching strings are collected into the `*Occur*'
1059 buffer by using NLINES as a replacement regexp. NLINES may
1060 contain \\& and \\N which convention follows `replace-match'.
1061 For example, providing \"defun\\s +\\(\\S +\\)\" for REGEXP and
1062 \"\\1\" for NLINES collects all the function names in a lisp
1063 program. When there is no parenthesized subexpressions in REGEXP
1064 the entire match is collected. In any case the searched buffers
1066 (interactive (occur-read-primary-args))
1067 (occur-1 regexp nlines
(list (current-buffer))))
1069 (defun multi-occur (bufs regexp
&optional nlines
)
1070 "Show all lines in buffers BUFS containing a match for REGEXP.
1071 This function acts on multiple buffers; otherwise, it is exactly like
1072 `occur'. When you invoke this command interactively, you must specify
1073 the buffer names that you want, one by one."
1076 (let* ((bufs (list (read-buffer "First buffer to search: "
1077 (current-buffer) t
)))
1079 (ido-ignore-item-temp-list bufs
))
1080 (while (not (string-equal
1081 (setq buf
(read-buffer
1082 (if (eq read-buffer-function
'ido-read-buffer
)
1083 "Next buffer to search (C-j to end): "
1084 "Next buffer to search (RET to end): ")
1087 (add-to-list 'bufs buf
)
1088 (setq ido-ignore-item-temp-list bufs
))
1089 (nreverse (mapcar #'get-buffer bufs
)))
1090 (occur-read-primary-args)))
1091 (occur-1 regexp nlines bufs
))
1093 (defun multi-occur-in-matching-buffers (bufregexp regexp
&optional allbufs
)
1094 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1095 Normally BUFREGEXP matches against each buffer's visited file name,
1096 but if you specify a prefix argument, it matches against the buffer name.
1097 See also `multi-occur'."
1100 (let* ((default (car regexp-history
))
1102 (read-from-minibuffer
1103 (if current-prefix-arg
1104 "List lines in buffers whose names match regexp: "
1105 "List lines in buffers whose filenames match regexp: ")
1110 (if (equal input
"")
1113 (occur-read-primary-args)))
1117 (mapcar (lambda (buf)
1119 (string-match bufregexp
1121 (and (buffer-file-name buf
)
1122 (string-match bufregexp
1123 (buffer-file-name buf
))))
1127 (defun occur-1 (regexp nlines bufs
&optional buf-name
)
1128 (unless (and regexp
(not (equal regexp
"")))
1129 (error "Occur doesn't work with the empty regexp"))
1131 (setq buf-name
"*Occur*"))
1133 (active-bufs (delq nil
(mapcar #'(lambda (buf)
1134 (when (buffer-live-p buf
) buf
))
1136 ;; Handle the case where one of the buffers we're searching is the
1137 ;; output buffer. Just rename it.
1138 (when (member buf-name
(mapcar 'buffer-name active-bufs
))
1139 (with-current-buffer (get-buffer buf-name
)
1142 ;; Now find or create the output buffer.
1143 ;; If we just renamed that buffer, we will make a new one here.
1144 (setq occur-buf
(get-buffer-create buf-name
))
1146 (with-current-buffer occur-buf
1147 (if (stringp nlines
)
1148 (fundamental-mode) ;; This is for collect opeartion.
1150 (let ((inhibit-read-only t
)
1151 ;; Don't generate undo entries for creation of the initial contents.
1152 (buffer-undo-list t
))
1155 (if (stringp nlines
)
1156 ;; Treat nlines as a regexp to collect.
1157 (let ((bufs active-bufs
)
1160 (with-current-buffer (car bufs
)
1162 (goto-char (point-min))
1163 (while (re-search-forward regexp nil t
)
1164 ;; Insert the replacement regexp.
1165 (let ((str (match-substitute-replacement nlines
)))
1167 (with-current-buffer occur-buf
1169 (setq count
(1+ count
))
1170 (or (zerop (current-column))
1171 (insert "\n"))))))))
1172 (setq bufs
(cdr bufs
)))
1174 ;; Perform normal occur.
1176 regexp active-bufs occur-buf
1177 (or nlines list-matching-lines-default-context-lines
)
1178 (if (and case-fold-search search-upper-case
)
1179 (isearch-no-upper-case-p regexp t
)
1181 list-matching-lines-buffer-name-face
1182 nil list-matching-lines-face
1183 (not (eq occur-excluded-properties t
))))))
1184 (let* ((bufcount (length active-bufs
))
1185 (diff (- (length bufs
) bufcount
)))
1186 (message "Searched %d buffer%s%s; %s match%s%s"
1187 bufcount
(if (= bufcount
1) "" "s")
1188 (if (zerop diff
) "" (format " (%d killed)" diff
))
1189 (if (zerop count
) "no" (format "%d" count
))
1190 (if (= count
1) "" "es")
1191 ;; Don't display regexp if with remaining text
1192 ;; it is longer than window-width.
1193 (if (> (+ (length regexp
) 42) (window-width))
1194 "" (format " for `%s'" (query-replace-descr regexp
)))))
1195 (setq occur-revert-arguments
(list regexp nlines bufs
))
1197 (kill-buffer occur-buf
)
1198 (display-buffer occur-buf
)
1199 (setq next-error-last-buffer occur-buf
)
1200 (setq buffer-read-only t
)
1201 (set-buffer-modified-p nil
)
1202 (run-hooks 'occur-hook
)))))))
1204 (defun occur-engine (regexp buffers out-buf nlines case-fold-search
1205 title-face prefix-face match-face keep-props
)
1206 (with-current-buffer out-buf
1207 (let ((globalcount 0)
1209 ;; Map over all the buffers
1210 (dolist (buf buffers
)
1211 (when (buffer-live-p buf
)
1212 (let ((matches 0) ;; count of matched lines
1213 (lines 1) ;; line count
1214 (prev-after-lines nil
) ;; context lines of prev match
1215 (prev-lines nil
) ;; line number of prev match endpt
1223 (inhibit-field-text-motion t
)
1224 (headerpt (with-current-buffer out-buf
(point))))
1225 (with-current-buffer buf
1227 ;; Set CODING only if the current buffer locally
1228 ;; binds buffer-file-coding-system.
1229 (not (local-variable-p 'buffer-file-coding-system
))
1230 (setq coding buffer-file-coding-system
))
1232 (goto-char (point-min)) ;; begin searching in the buffer
1234 (setq origpt
(point))
1235 (when (setq endpt
(re-search-forward regexp nil t
))
1236 (setq matches
(1+ matches
)) ;; increment match count
1237 (setq matchbeg
(match-beginning 0))
1238 ;; Get beginning of first match line and end of the last.
1240 (goto-char matchbeg
)
1241 (setq begpt
(line-beginning-position))
1243 (setq endpt
(line-end-position)))
1244 ;; Sum line numbers up to the first match line.
1245 (setq lines
(+ lines
(count-lines origpt begpt
)))
1246 (setq marker
(make-marker))
1247 (set-marker marker matchbeg
)
1248 (setq curstring
(occur-engine-line begpt endpt keep-props
))
1249 ;; Highlight the matches
1250 (let ((len (length curstring
))
1252 (while (and (< start len
)
1253 (string-match regexp curstring start
))
1254 (add-text-properties
1255 (match-beginning 0) (match-end 0)
1259 ;; Use `face' rather than `font-lock-face' here
1260 ;; so as to override faces copied from the buffer.
1261 `(face ,match-face
)))
1263 (setq start
(match-end 0))))
1264 ;; Generate the string to insert for this match
1265 (let* ((match-prefix
1266 ;; Using 7 digits aligns tabs properly.
1267 (apply #'propertize
(format "%7d:" lines
)
1270 `(font-lock-face prefix-face
))
1271 `(occur-prefix t mouse-face
(highlight)
1272 occur-target
,marker follow-link t
1273 help-echo
"mouse-2: go to this occurrence"))))
1275 ;; We don't put `mouse-face' on the newline,
1276 ;; because that loses. And don't put it
1277 ;; on context lines to reduce flicker.
1278 (propertize curstring
'mouse-face
(list 'highlight
)
1279 'occur-target marker
1282 "mouse-2: go to this occurrence"))
1286 ;; Add non-numeric prefix to all non-first lines
1287 ;; of multi-line matches.
1288 (replace-regexp-in-string
1292 ;; Add marker at eol, but no mouse props.
1293 (propertize "\n" 'occur-target marker
)))
1296 ;; The simple display style
1298 ;; The complex multi-line display style.
1299 (setq ret
(occur-context-lines
1300 out-line nlines keep-props begpt endpt
1301 lines prev-lines prev-after-lines
))
1302 ;; Set first elem of the returned list to `data',
1303 ;; and the second elem to `prev-after-lines'.
1304 (setq prev-after-lines
(nth 1 ret
))
1306 ;; Actually insert the match display data
1307 (with-current-buffer out-buf
1309 (end (progn (insert data
) (point)))))))
1313 ;; Sum line numbers between first and last match lines.
1314 (setq lines
(+ lines
(count-lines begpt endpt
)
1315 ;; Add 1 for empty last match line since
1316 ;; count-lines returns 1 line less.
1317 (if (and (bolp) (eolp)) 1 0)))
1318 ;; On to the next match...
1320 (goto-char (point-max)))
1321 (setq prev-lines
(1- lines
)))
1322 ;; Flush remaining context after-lines.
1323 (when prev-after-lines
1324 (with-current-buffer out-buf
1325 (insert (apply #'concat
(occur-engine-add-prefix
1326 prev-after-lines
)))))))
1327 (when (not (zerop matches
)) ;; is the count zero?
1328 (setq globalcount
(+ globalcount matches
))
1329 (with-current-buffer out-buf
1330 (goto-char headerpt
)
1333 (insert (format "%d match%s%s in buffer: %s\n"
1334 matches
(if (= matches
1) "" "es")
1335 ;; Don't display regexp for multi-buffer.
1336 (if (> (length buffers
) 1)
1337 "" (format " for \"%s\""
1338 (query-replace-descr regexp
)))
1341 (add-text-properties beg end
1344 `(font-lock-face ,title-face
))
1345 `(occur-title ,buf
))))
1346 (goto-char (point-min)))))))
1347 ;; Display total match count and regexp for multi-buffer.
1348 (when (and (not (zerop globalcount
)) (> (length buffers
) 1))
1349 (goto-char (point-min))
1352 (insert (format "%d match%s total for \"%s\":\n"
1353 globalcount
(if (= globalcount
1) "" "es")
1354 (query-replace-descr regexp
)))
1356 (add-text-properties beg end
(when title-face
1357 `(font-lock-face ,title-face
))))
1358 (goto-char (point-min)))
1360 ;; CODING is buffer-file-coding-system of the first buffer
1361 ;; that locally binds it. Let's use it also for the output
1363 (set-buffer-file-coding-system coding
))
1364 ;; Return the number of matches
1367 (defun occur-engine-line (beg end
&optional keep-props
)
1368 (if (and keep-props
(if (boundp 'jit-lock-mode
) jit-lock-mode
)
1369 (text-property-not-all beg end
'fontified t
))
1370 (if (fboundp 'jit-lock-fontify-now
)
1371 (jit-lock-fontify-now beg end
)))
1372 (if (and keep-props
(not (eq occur-excluded-properties t
)))
1373 (let ((str (buffer-substring beg end
)))
1374 (remove-list-of-text-properties
1375 0 (length str
) occur-excluded-properties str
)
1377 (buffer-substring-no-properties beg end
)))
1379 (defun occur-engine-add-prefix (lines)
1382 (concat " :" line
"\n"))
1385 (defun occur-accumulate-lines (count &optional keep-props pt
)
1389 (let ((forwardp (> count
0))
1390 result beg end moved
)
1391 (while (not (or (zerop count
)
1394 (and (bobp) (not moved
)))))
1395 (setq count
(+ count
(if forwardp -
1 1)))
1396 (setq beg
(line-beginning-position)
1397 end
(line-end-position))
1398 (push (occur-engine-line beg end keep-props
) result
)
1399 (setq moved
(= 0 (forward-line (if forwardp
1 -
1)))))
1400 (nreverse result
))))
1402 ;; Generate context display for occur.
1403 ;; OUT-LINE is the line where the match is.
1404 ;; NLINES and KEEP-PROPS are args to occur-engine.
1405 ;; LINES is line count of the current match,
1406 ;; PREV-LINES is line count of the previous match,
1407 ;; PREV-AFTER-LINES is a list of after-context lines of the previous match.
1408 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1409 ;; then concatenate them all together.
1410 (defun occur-context-lines (out-line nlines keep-props begpt endpt
1411 lines prev-lines prev-after-lines
)
1412 ;; Find after- and before-context lines of the current match.
1414 (nreverse (cdr (occur-accumulate-lines
1415 (- (1+ (abs nlines
))) keep-props begpt
))))
1417 (cdr (occur-accumulate-lines
1418 (1+ nlines
) keep-props endpt
)))
1421 ;; Combine after-lines of the previous match
1422 ;; with before-lines of the current match.
1424 (when prev-after-lines
1425 ;; Don't overlap prev after-lines with current before-lines.
1426 (if (>= (+ prev-lines
(length prev-after-lines
))
1427 (- lines
(length before-lines
)))
1428 (setq prev-after-lines
1429 (butlast prev-after-lines
1430 (- (length prev-after-lines
)
1431 (- lines prev-lines
(length before-lines
) 1))))
1432 ;; Separate non-overlapping context lines with a dashed line.
1433 (setq separator
"-------\n")))
1436 ;; Don't overlap current before-lines with previous match line.
1437 (if (<= (- lines
(length before-lines
))
1440 (nthcdr (- (length before-lines
)
1441 (- lines prev-lines
1))
1443 ;; Separate non-overlapping before-context lines.
1444 (unless (> nlines
0)
1445 (setq separator
"-------\n"))))
1448 ;; Return a list where the first element is the output line.
1451 (and prev-after-lines
1452 (occur-engine-add-prefix prev-after-lines
))
1453 (and separator
(list separator
))
1454 (occur-engine-add-prefix before-lines
)
1456 ;; And the second element is the list of context after-lines.
1457 (if (> nlines
0) after-lines
))))
1460 ;; It would be nice to use \\[...], but there is no reasonable way
1461 ;; to make that display both SPC and Y.
1462 (defconst query-replace-help
1463 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1464 RET or `q' to exit, Period to replace one match and exit,
1465 Comma to replace but not move point immediately,
1466 C-r to enter recursive edit (\\[exit-recursive-edit] to get out again),
1467 C-w to delete match and recursive edit,
1468 C-l to clear the screen, redisplay, and offer same replacement again,
1469 ! to replace all remaining matches with no more questions,
1470 ^ to move point back to previous match,
1471 E to edit the replacement string"
1472 "Help message while in `query-replace'.")
1474 (defvar query-replace-map
1475 (let ((map (make-sparse-keymap)))
1476 (define-key map
" " 'act
)
1477 (define-key map
"\d" 'skip
)
1478 (define-key map
[delete] 'skip)
1479 (define-key map [backspace] 'skip)
1480 (define-key map "y" 'act)
1481 (define-key map "n" 'skip)
1482 (define-key map "Y" 'act)
1483 (define-key map "N" 'skip)
1484 (define-key map "e" 'edit-replacement)
1485 (define-key map "E" 'edit-replacement)
1486 (define-key map "," 'act-and-show)
1487 (define-key map "q" 'exit)
1488 (define-key map "\r" 'exit)
1489 (define-key map [return] 'exit)
1490 (define-key map "." 'act-and-exit)
1491 (define-key map "\C-r" 'edit)
1492 (define-key map "\C-w" 'delete-and-edit)
1493 (define-key map "\C-l" 'recenter)
1494 (define-key map "!" 'automatic)
1495 (define-key map "^" 'backup)
1496 (define-key map "\C-h" 'help)
1497 (define-key map [f1] 'help)
1498 (define-key map [help] 'help)
1499 (define-key map "?" 'help)
1500 (define-key map "\C-g" 'quit)
1501 (define-key map "\C-]" 'quit)
1502 (define-key map "\e" 'exit-prefix)
1503 (define-key map [escape] 'exit-prefix)
1505 "Keymap that defines the responses to questions in `query-replace'.
1506 The \"bindings\" in this map are not commands; they are answers.
1507 The valid answers include `act', `skip', `act-and-show',
1508 `exit', `act-and-exit', `edit', `delete-and-edit', `recenter',
1509 `automatic', `backup', `exit-prefix', and `help'.")
1511 (defvar multi-query-replace-map
1512 (let ((map (make-sparse-keymap)))
1513 (set-keymap-parent map query-replace-map)
1514 (define-key map "Y" 'automatic-all)
1515 (define-key map "N" 'exit-current)
1517 "Keymap that defines additional bindings for multi-buffer replacements.
1518 It extends its parent map `query-replace-map' with new bindings to
1519 operate on a set of buffers/files. The difference with its parent map
1520 is the additional answers `automatic-all' to replace all remaining
1521 matches in all remaining buffers with no more questions, and
1522 `exit-current' to skip remaining matches in the current buffer
1523 and to continue with the next buffer in the sequence.")
1525 (defun replace-match-string-symbols (n)
1526 "Process a list (and any sub-lists), expanding certain symbols.
1528 N (match-string N) (where N is a string of digits)
1529 #N (string-to-number (match-string N))
1531 #& (string-to-number (match-string 0))
1534 Note that these symbols must be preceded by a backslash in order to
1535 type them using Lisp syntax."
1539 (replace-match-string-symbols (car n))) ;Process sub-list
1541 (let ((name (symbol-name (car n))))
1543 ((string-match "^[0-9]+$" name)
1544 (setcar n (list 'match-string (string-to-number name))))
1545 ((string-match "^#[0-9]+$" name)
1546 (setcar n (list 'string-to-number
1548 (string-to-number (substring name 1))))))
1550 (setcar n '(match-string 0)))
1551 ((string= "#&" name)
1552 (setcar n '(string-to-number (match-string 0))))
1554 (setcar n 'replace-count))))))
1557 (defun replace-eval-replacement (expression replace-count)
1558 (let ((replacement (eval expression)))
1559 (if (stringp replacement)
1561 (prin1-to-string replacement t))))
1563 (defun replace-quote (replacement)
1564 "Quote a replacement string.
1565 This just doubles all backslashes in REPLACEMENT and
1566 returns the resulting string. If REPLACEMENT is not
1567 a string, it is first passed through `prin1-to-string'
1568 with the `noescape' argument set.
1570 `match-data' is preserved across the call."
1572 (replace-regexp-in-string "\\\\" "\\\\"
1573 (if (stringp replacement)
1575 (prin1-to-string replacement t))
1578 (defun replace-loop-through-replacements (data replace-count)
1579 ;; DATA is a vector contaning the following values:
1580 ;; 0 next-rotate-count
1582 ;; 2 next-replacement
1584 (if (= (aref data 0) replace-count)
1586 (aset data 0 (+ replace-count (aref data 1)))
1587 (let ((next (cdr (aref data 2))))
1588 (aset data 2 (if (consp next) next (aref data 3))))))
1589 (car (aref data 2)))
1591 (defun replace-match-data (integers reuse &optional new)
1592 "Like `match-data', but markers in REUSE get invalidated.
1593 If NEW is non-nil, it is set and returned instead of fresh data,
1594 but coerced to the correct value of INTEGERS."
1597 (set-match-data new)
1599 (eq (null integers) (markerp (car reuse)))
1601 (match-data integers reuse t)))
1603 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data)
1604 "Make a replacement with `replace-match', editing `\\?'.
1605 NEWTEXT, FIXEDCASE, LITERAL are just passed on. If NOEDIT is true, no
1606 check for `\\?' is made to save time. MATCH-DATA is used for the
1607 replacement. In case editing is done, it is changed to use markers.
1609 The return value is non-nil if there has been no `\\?' or NOEDIT was
1610 passed in. If LITERAL is set, no checking is done, anyway."
1611 (unless (or literal noedit)
1613 (while (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\?\\)"
1616 (read-string "Edit replacement string: "
1619 (replace-match "" t t newtext 3)
1620 (1+ (match-beginning 3)))
1623 nil match-data match-data))))
1625 (set-match-data match-data)
1626 (replace-match newtext fixedcase literal)
1629 (defvar replace-search-function 'search-forward
1630 "Function to use when searching for strings to replace.
1631 It is used by `query-replace' and `replace-string', and is called
1632 with three arguments, as if it were `search-forward'.")
1634 (defvar replace-re-search-function 're-search-forward
1635 "Function to use when searching for regexps to replace.
1636 It is used by `query-replace-regexp', `replace-regexp',
1637 `query-replace-regexp-eval', and `map-query-replace-regexp'.
1638 It is called with three arguments, as if it were
1639 `re-search-forward'.")
1641 (defun perform-replace (from-string replacements
1642 query-flag regexp-flag delimited-flag
1643 &optional repeat-count map start end)
1644 "Subroutine of `query-replace'. Its complexity handles interactive queries.
1645 Don't use this in your own program unless you want to query and set the mark
1646 just as `query-replace' does. Instead, write a simple loop like this:
1648 (while (re-search-forward \"foo[ \\t]+bar\" nil t)
1649 (replace-match \"foobar\" nil nil))
1651 which will run faster and probably do exactly what you want. Please
1652 see the documentation of `replace-match' to find out how to simulate
1655 This function returns nil if and only if there were no matches to
1656 make, or the user didn't cancel the call."
1657 (or map (setq map query-replace-map))
1658 (and query-flag minibuffer-auto-raise
1659 (raise-frame (window-frame (minibuffer-window))))
1660 (let* ((case-fold-search
1661 (if (and case-fold-search search-upper-case)
1662 (isearch-no-upper-case-p from-string regexp-flag)
1664 (nocasify (not (and case-replace case-fold-search)))
1665 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
1668 replace-re-search-function
1669 replace-search-function))
1670 (search-string from-string)
1671 (real-match-data nil) ; The match data for the current match.
1672 (next-replacement nil)
1673 ;; This is non-nil if we know there is nothing for the user
1674 ;; to edit in the replacement.
1679 (nonempty-match nil)
1681 (recenter-last-op nil) ; Start cycling order with initial position.
1683 ;; If non-nil, it is marker saying where in the buffer to stop.
1686 ;; Data for the next match. If a cons, it has the same format as
1687 ;; (match-data); otherwise it is t if a match is possible at point.
1693 (substitute-command-keys
1694 "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) ")
1695 minibuffer-prompt-properties))))
1697 ;; If region is active, in Transient Mark mode, operate on region.
1699 (setq limit (copy-marker (max start end)))
1700 (goto-char (min start end))
1703 ;; If last typed key in previous call of multi-buffer perform-replace
1704 ;; was `automatic-all', don't ask more questions in next files
1705 (when (eq (lookup-key map (vector last-input-event)) 'automatic-all)
1706 (setq query-flag nil multi-buffer t))
1708 ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
1709 ;; containing a function and its first argument. The function is
1710 ;; called to generate each replacement like this:
1711 ;; (funcall (car replacements) (cdr replacements) replace-count)
1712 ;; It must return a string.
1714 ((stringp replacements)
1715 (setq next-replacement replacements
1717 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
1718 (or repeat-count (setq repeat-count 1))
1719 (setq replacements (cons 'replace-loop-through-replacements
1720 (vector repeat-count repeat-count
1721 replacements replacements)))))
1724 (setq search-function 're-search-forward
1725 search-string (concat "\\b"
1726 (if regexp-flag from-string
1727 (regexp-quote from-string))
1729 (when query-replace-lazy-highlight
1730 (setq isearch-lazy-highlight-last-string nil))
1735 ;; Loop finding occurrences that perhaps should be replaced.
1736 (while (and keep-going
1737 (not (or (eobp) (and limit (>= (point) limit))))
1738 ;; Use the next match if it is already known;
1739 ;; otherwise, search for a match after moving forward
1740 ;; one char if progress is required.
1741 (setq real-match-data
1742 (cond ((consp match-again)
1743 (goto-char (nth 1 match-again))
1745 t real-match-data match-again))
1746 ;; MATCH-AGAIN non-nil means accept an
1750 (funcall search-function search-string
1752 ;; For speed, use only integers and
1753 ;; reuse the list used last time.
1754 (replace-match-data t real-match-data)))
1755 ((and (< (1+ (point)) (point-max))
1757 (< (1+ (point)) limit)))
1758 ;; If not accepting adjacent matches,
1759 ;; move one char to the right before
1760 ;; searching again. Undo the motion
1761 ;; if the search fails.
1762 (let ((opoint (point)))
1765 search-function search-string
1772 ;; Record whether the match is nonempty, to avoid an infinite loop
1773 ;; repeatedly matching the same empty string.
1774 (setq nonempty-match
1775 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
1777 ;; If the match is empty, record that the next one can't be
1780 ;; Otherwise, if matching a regular expression, do the next
1781 ;; match now, since the replacement for this match may
1782 ;; affect whether the next match is adjacent to this one.
1783 ;; If that match is empty, don't use it.
1786 (or (not regexp-flag)
1787 (and (looking-at search-string)
1788 (let ((match (match-data)))
1789 (and (/= (nth 0 match) (nth 1 match))
1792 ;; Optionally ignore matches that have a read-only property.
1793 (unless (and query-replace-skip-read-only
1794 (text-property-not-all
1795 (nth 0 real-match-data) (nth 1 real-match-data)
1798 ;; Calculate the replacement string, if necessary.
1800 (set-match-data real-match-data)
1801 (setq next-replacement
1802 (funcall (car replacements) (cdr replacements)
1804 (if (not query-flag)
1806 (unless (or literal noedit)
1808 (nth 0 real-match-data) (nth 1 real-match-data)
1809 start end search-string
1810 (or delimited-flag regexp-flag) case-fold-search))
1812 (replace-match-maybe-edit
1813 next-replacement nocasify literal
1814 noedit real-match-data)
1815 replace-count (1+ replace-count)))
1817 (let (done replaced key def)
1818 ;; Loop reading commands until one of them sets done,
1819 ;; which means it has finished handling this
1820 ;; occurrence. Any command that sets `done' should
1821 ;; leave behind proper match data for the stack.
1822 ;; Commands not setting `done' need to adjust
1823 ;; `real-match-data'.
1825 (set-match-data real-match-data)
1827 (match-beginning 0) (match-end 0)
1828 start end search-string
1829 (or delimited-flag regexp-flag) case-fold-search)
1830 ;; Bind message-log-max so we don't fill up the message log
1831 ;; with a bunch of identical messages.
1832 (let ((message-log-max nil)
1833 (replacement-presentation
1834 (if query-replace-show-replacement
1836 (set-match-data real-match-data)
1837 (match-substitute-replacement next-replacement
1841 (query-replace-descr from-string)
1842 (query-replace-descr replacement-presentation)))
1843 (setq key (read-event))
1844 ;; Necessary in case something happens during read-event
1845 ;; that clobbers the match data.
1846 (set-match-data real-match-data)
1847 (setq key (vector key))
1848 (setq def (lookup-key map key))
1849 ;; Restore the match data while we process the command.
1850 (cond ((eq def 'help)
1851 (with-output-to-temp-buffer "*Help*"
1853 (concat "Query replacing "
1854 (if delimited-flag "word " "")
1855 (if regexp-flag "regexp " "")
1856 from-string " with "
1857 next-replacement ".\n\n"
1858 (substitute-command-keys
1859 query-replace-help)))
1860 (with-current-buffer standard-output
1863 (setq keep-going nil)
1865 ((eq def 'exit-current)
1866 (setq multi-buffer t keep-going nil done t))
1869 (let ((elt (pop stack)))
1870 (goto-char (nth 0 elt))
1871 (setq replaced (nth 1 elt)
1876 (message "No previous match")
1877 (ding 'no-terminate)
1882 (replace-match-maybe-edit
1883 next-replacement nocasify literal
1884 noedit real-match-data)
1885 replace-count (1+ replace-count)))
1886 (setq done t replaced t))
1887 ((eq def 'act-and-exit)
1890 (replace-match-maybe-edit
1891 next-replacement nocasify literal
1892 noedit real-match-data)
1893 replace-count (1+ replace-count)))
1894 (setq keep-going nil)
1895 (setq done t replaced t))
1896 ((eq def 'act-and-show)
1899 (replace-match-maybe-edit
1900 next-replacement nocasify literal
1901 noedit real-match-data)
1902 replace-count (1+ replace-count)
1903 real-match-data (replace-match-data
1906 ((or (eq def 'automatic) (eq def 'automatic-all))
1909 (replace-match-maybe-edit
1910 next-replacement nocasify literal
1911 noedit real-match-data)
1912 replace-count (1+ replace-count)))
1913 (setq done t query-flag nil replaced t)
1914 (if (eq def 'automatic-all) (setq multi-buffer t)))
1918 ;; `this-command' has the value `query-replace',
1919 ;; so we need to bind it to `recenter-top-bottom'
1920 ;; to allow it to detect a sequence of `C-l'.
1921 (let ((this-command 'recenter-top-bottom)
1922 (last-command 'recenter-top-bottom))
1923 (recenter-top-bottom)))
1925 (let ((opos (point-marker)))
1926 (setq real-match-data (replace-match-data
1929 (goto-char (match-beginning 0))
1931 (save-window-excursion
1934 (set-marker opos nil))
1935 ;; Before we make the replacement,
1936 ;; decide whether the search string
1937 ;; can match again just after this match.
1938 (if (and regexp-flag nonempty-match)
1939 (setq match-again (and (looking-at search-string)
1941 ;; Edit replacement.
1942 ((eq def 'edit-replacement)
1943 (setq real-match-data (replace-match-data
1947 (read-string "Edit replacement string: "
1951 (set-match-data real-match-data)
1953 (replace-match-maybe-edit
1954 next-replacement nocasify literal noedit
1959 ((eq def 'delete-and-edit)
1960 (replace-match "" t t)
1961 (setq real-match-data (replace-match-data
1962 nil real-match-data))
1963 (replace-dehighlight)
1964 (save-excursion (recursive-edit))
1966 ;; Note: we do not need to treat `exit-prefix'
1967 ;; specially here, since we reread
1968 ;; any unrecognized character.
1970 (setq this-command 'mode-exited)
1971 (setq keep-going nil)
1972 (setq unread-command-events
1973 (append (listify-key-sequence key)
1974 unread-command-events))
1976 (when query-replace-lazy-highlight
1977 ;; Force lazy rehighlighting only after replacements.
1978 (if (not (memq def '(skip backup)))
1979 (setq isearch-lazy-highlight-last-string nil)))
1980 (unless (eq def 'recenter)
1981 ;; Reset recenter cycling order to initial position.
1982 (setq recenter-last-op nil)))
1983 ;; Record previous position for ^ when we move on.
1984 ;; Change markers to numbers in the match data
1985 ;; since lots of markers slow down editing.
1986 (push (list (point) replaced
1987 ;;; If the replacement has already happened, all we need is the
1988 ;;; current match start and end. We could get this with a trivial
1990 ;;; (save-excursion (goto-char (match-beginning 0))
1991 ;;; (search-forward (match-string 0))
1993 ;;; if we really wanted to avoid manually constructing match data.
1994 ;;; Adding current-buffer is necessary so that match-data calls can
1995 ;;; return markers which are appropriate for editing.
2004 (replace-dehighlight))
2005 (or unread-command-events
2006 (message "Replaced %d occurrence%s"
2008 (if (= replace-count 1) "" "s")))
2009 (or (and keep-going stack) multi-buffer)))
2011 (defvar replace-overlay nil)
2013 (defun replace-highlight (match-beg match-end range-beg range-end
2014 string regexp case-fold)
2015 (if query-replace-highlight
2017 (move-overlay replace-overlay match-beg match-end (current-buffer))
2018 (setq replace-overlay (make-overlay match-beg match-end))
2019 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
2020 (overlay-put replace-overlay 'face 'query-replace)))
2021 (if query-replace-lazy-highlight
2022 (let ((isearch-string string)
2023 (isearch-regexp regexp)
2024 (search-whitespace-regexp nil)
2025 (isearch-case-fold-search case-fold)
2027 (isearch-error nil))
2028 ;; Set isearch-word to nil because word-replace is regexp-based,
2029 ;; so `isearch-search-fun' should not use `word-search-forward'.
2030 (if (and isearch-word isearch-regexp) (setq isearch-word nil))
2031 (isearch-lazy-highlight-new-loop range-beg range-end))))
2033 (defun replace-dehighlight ()
2034 (when replace-overlay
2035 (delete-overlay replace-overlay))
2036 (when query-replace-lazy-highlight
2037 (lazy-highlight-cleanup lazy-highlight-cleanup)
2038 (setq isearch-lazy-highlight-last-string nil)))
2040 ;;; replace.el ends here