(tramp-completion-mode-p): Don't use char-equal for
[emacs.git] / lisp / replace.el
blob3680d574e8c55a1178b349b169446a80effacad6
1 ;;; replace.el --- replace commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1996, 1997, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Maintainer: FSF
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 3, or (at your option)
13 ;; any later version.
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.
25 ;;; Commentary:
27 ;; This package supplies the string and regular-expression replace functions
28 ;; documented in the Emacs user's manual.
30 ;;; Code:
32 (defcustom case-replace t
33 "*Non-nil means `query-replace' should preserve case in replacements."
34 :type 'boolean
35 :group 'matching)
37 (defvar query-replace-history nil)
39 (defvar query-replace-defaults nil
40 "Default values of FROM-STRING and TO-STRING for `query-replace'.
41 This is a cons cell (FROM-STRING . TO-STRING), or nil if there is
42 no default value.")
44 (defvar query-replace-interactive nil
45 "Non-nil means `query-replace' uses the last search string.
46 That becomes the \"string to replace\".")
48 (defcustom query-replace-from-history-variable 'query-replace-history
49 "History list to use for the FROM argument of `query-replace' commands.
50 The value of this variable should be a symbol; that symbol
51 is used as a variable to hold a history list for the strings
52 or patterns to be replaced."
53 :group 'matching
54 :type 'symbol
55 :version "20.3")
57 (defcustom query-replace-to-history-variable 'query-replace-history
58 "History list to use for the TO argument of `query-replace' commands.
59 The value of this variable should be a symbol; that symbol
60 is used as a variable to hold a history list for replacement
61 strings or patterns."
62 :group 'matching
63 :type 'symbol
64 :version "20.3")
66 (defcustom query-replace-skip-read-only nil
67 "*Non-nil means `query-replace' and friends ignore read-only matches."
68 :type 'boolean
69 :group 'matching
70 :version "22.1")
72 (defcustom query-replace-show-replacement t
73 "*Non-nil means to show what actual replacement text will be."
74 :type 'boolean
75 :group 'matching
76 :version "23.1")
78 (defcustom query-replace-highlight t
79 "*Non-nil means to highlight matches during query replacement."
80 :type 'boolean
81 :group 'matching)
83 (defcustom query-replace-lazy-highlight t
84 "*Controls the lazy-highlighting during query replacements.
85 When non-nil, all text in the buffer matching the current match
86 is highlighted lazily using isearch lazy highlighting (see
87 `lazy-highlight-initial-delay' and `lazy-highlight-interval')."
88 :type 'boolean
89 :group 'lazy-highlight
90 :group 'matching
91 :version "22.1")
93 (defface query-replace
94 '((t (:inherit isearch)))
95 "Face for highlighting query replacement matches."
96 :group 'matching
97 :version "22.1")
99 (defun query-replace-descr (string)
100 (mapconcat 'isearch-text-char-description string ""))
102 (defun query-replace-read-from (prompt regexp-flag)
103 "Query and return the `from' argument of a query-replace operation.
104 The return value can also be a pair (FROM . TO) indicating that the user
105 wants to replace FROM with TO."
106 (if query-replace-interactive
107 (car (if regexp-flag regexp-search-ring search-ring))
108 (let* ((history-add-new-input nil)
109 (from
110 ;; The save-excursion here is in case the user marks and copies
111 ;; a region in order to specify the minibuffer input.
112 ;; That should not clobber the region for the query-replace itself.
113 (save-excursion
114 (read-from-minibuffer
115 (if query-replace-defaults
116 (format "%s (default %s -> %s): " prompt
117 (query-replace-descr (car query-replace-defaults))
118 (query-replace-descr (cdr query-replace-defaults)))
119 (format "%s: " prompt))
120 nil nil nil
121 query-replace-from-history-variable
122 nil t))))
123 (if (and (zerop (length from)) query-replace-defaults)
124 (cons (car query-replace-defaults)
125 (query-replace-compile-replacement
126 (cdr query-replace-defaults) regexp-flag))
127 (add-to-history query-replace-from-history-variable from nil t)
128 ;; Warn if user types \n or \t, but don't reject the input.
129 (and regexp-flag
130 (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\[nt]\\)" from)
131 (let ((match (match-string 3 from)))
132 (cond
133 ((string= match "\\n")
134 (message "Note: `\\n' here doesn't match a newline; to do that, type C-q C-j instead"))
135 ((string= match "\\t")
136 (message "Note: `\\t' here doesn't match a tab; to do that, just type TAB")))
137 (sit-for 2)))
138 from))))
140 (defun query-replace-compile-replacement (to regexp-flag)
141 "Maybe convert a regexp replacement TO to Lisp.
142 Returns a list suitable for `perform-replace' if necessary,
143 the original string if not."
144 (if (and regexp-flag
145 (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to))
146 (let (pos list char)
147 (while
148 (progn
149 (setq pos (match-end 0))
150 (push (substring to 0 (- pos 2)) list)
151 (setq char (aref to (1- pos))
152 to (substring to pos))
153 (cond ((eq char ?\#)
154 (push '(number-to-string replace-count) list))
155 ((eq char ?\,)
156 (setq pos (read-from-string to))
157 (push `(replace-quote ,(car pos)) list)
158 (let ((end
159 ;; Swallow a space after a symbol
160 ;; if there is a space.
161 (if (and (or (symbolp (car pos))
162 ;; Swallow a space after 'foo
163 ;; but not after (quote foo).
164 (and (eq (car-safe (car pos)) 'quote)
165 (not (= ?\( (aref to 0)))))
166 (eq (string-match " " to (cdr pos))
167 (cdr pos)))
168 (1+ (cdr pos))
169 (cdr pos))))
170 (setq to (substring to end)))))
171 (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
172 (setq to (nreverse (delete "" (cons to list))))
173 (replace-match-string-symbols to)
174 (cons 'replace-eval-replacement
175 (if (cdr to)
176 (cons 'concat to)
177 (car to))))
178 to))
181 (defun query-replace-read-to (from prompt regexp-flag)
182 "Query and return the `to' argument of a query-replace operation."
183 (query-replace-compile-replacement
184 (save-excursion
185 (let* ((history-add-new-input nil)
186 (to (read-from-minibuffer
187 (format "%s %s with: " prompt (query-replace-descr from))
188 nil nil nil
189 query-replace-to-history-variable from t)))
190 (add-to-history query-replace-to-history-variable to nil t)
191 (setq query-replace-defaults (cons from to))
192 to))
193 regexp-flag))
195 (defun query-replace-read-args (prompt regexp-flag &optional noerror)
196 (unless noerror
197 (barf-if-buffer-read-only))
198 (let* ((from (query-replace-read-from prompt regexp-flag))
199 (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
200 (query-replace-read-to from prompt regexp-flag))))
201 (list from to current-prefix-arg)))
203 (defun query-replace (from-string to-string &optional delimited start end)
204 "Replace some occurrences of FROM-STRING with TO-STRING.
205 As each match is found, the user must type a character saying
206 what to do with it. For directions, type \\[help-command] at that time.
208 In Transient Mark mode, if the mark is active, operate on the contents
209 of the region. Otherwise, operate from point to the end of the buffer.
211 If `query-replace-interactive' is non-nil, the last incremental search
212 string is used as FROM-STRING--you don't have to specify it with the
213 minibuffer.
215 Matching is independent of case if `case-fold-search' is non-nil and
216 FROM-STRING has no uppercase letters. Replacement transfers the case
217 pattern of the old text to the new text, if `case-replace' and
218 `case-fold-search' are non-nil and FROM-STRING has no uppercase
219 letters. \(Transferring the case pattern means that if the old text
220 matched is all caps, or capitalized, then its replacement is upcased
221 or capitalized.)
223 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
224 only matches surrounded by word boundaries.
225 Fourth and fifth arg START and END specify the region to operate on.
227 To customize possible responses, change the \"bindings\" in `query-replace-map'."
228 (interactive (let ((common
229 (query-replace-read-args
230 (if (and transient-mark-mode mark-active)
231 "Query replace in region"
232 "Query replace")
233 nil)))
234 (list (nth 0 common) (nth 1 common) (nth 2 common)
235 ;; These are done separately here
236 ;; so that command-history will record these expressions
237 ;; rather than the values they had this time.
238 (if (and transient-mark-mode mark-active)
239 (region-beginning))
240 (if (and transient-mark-mode mark-active)
241 (region-end)))))
242 (perform-replace from-string to-string t nil delimited nil nil start end))
244 (define-key esc-map "%" 'query-replace)
246 (defun query-replace-regexp (regexp to-string &optional delimited start end)
247 "Replace some things after point matching REGEXP with TO-STRING.
248 As each match is found, the user must type a character saying
249 what to do with it. For directions, type \\[help-command] at that time.
251 In Transient Mark mode, if the mark is active, operate on the contents
252 of the region. Otherwise, operate from point to the end of the buffer.
254 If `query-replace-interactive' is non-nil, the last incremental search
255 regexp is used as REGEXP--you don't have to specify it with the
256 minibuffer.
258 Matching is independent of case if `case-fold-search' is non-nil and
259 REGEXP has no uppercase letters. Replacement transfers the case
260 pattern of the old text to the new text, if `case-replace' and
261 `case-fold-search' are non-nil and REGEXP has no uppercase letters.
262 \(Transferring the case pattern means that if the old text matched is
263 all caps, or capitalized, then its replacement is upcased or
264 capitalized.)
266 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
267 only matches surrounded by word boundaries.
268 Fourth and fifth arg START and END specify the region to operate on.
270 In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
271 and `\\=\\N' (where N is a digit) stands for
272 whatever what matched the Nth `\\(...\\)' in REGEXP.
273 `\\?' lets you edit the replacement text in the minibuffer
274 at the given position for each replacement.
276 In interactive calls, the replacement text can contain `\\,'
277 followed by a Lisp expression. Each
278 replacement evaluates that expression to compute the replacement
279 string. Inside of that expression, `\\&' is a string denoting the
280 whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
281 for the whole or a partial match converted to a number with
282 `string-to-number', and `\\#' itself for the number of replacements
283 done so far (starting with zero).
285 If the replacement expression is a symbol, write a space after it
286 to terminate it. One space there, if any, will be discarded.
288 When using those Lisp features interactively in the replacement
289 text, TO-STRING is actually made a list instead of a string.
290 Use \\[repeat-complex-command] after this command for details."
291 (interactive
292 (let ((common
293 (query-replace-read-args
294 (if (and transient-mark-mode mark-active)
295 "Query replace regexp in region"
296 "Query replace regexp")
297 t)))
298 (list (nth 0 common) (nth 1 common) (nth 2 common)
299 ;; These are done separately here
300 ;; so that command-history will record these expressions
301 ;; rather than the values they had this time.
302 (if (and transient-mark-mode mark-active)
303 (region-beginning))
304 (if (and transient-mark-mode mark-active)
305 (region-end)))))
306 (perform-replace regexp to-string t t delimited nil nil start end))
308 (define-key esc-map [?\C-%] 'query-replace-regexp)
310 (defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
311 "Replace some things after point matching REGEXP with the result of TO-EXPR.
313 Interactive use of this function is deprecated in favor of the
314 `\\,' feature of `query-replace-regexp'. For non-interactive use, a loop
315 using `search-forward-regexp' and `replace-match' is preferred.
317 As each match is found, the user must type a character saying
318 what to do with it. For directions, type \\[help-command] at that time.
320 TO-EXPR is a Lisp expression evaluated to compute each replacement. It may
321 reference `replace-count' to get the number of replacements already made.
322 If the result of TO-EXPR is not a string, it is converted to one using
323 `prin1-to-string' with the NOESCAPE argument (which see).
325 For convenience, when entering TO-EXPR interactively, you can use `\\&' or
326 `\\0' to stand for whatever matched the whole of REGEXP, and `\\N' (where
327 N is a digit) to stand for whatever matched the Nth `\\(...\\)' in REGEXP.
328 Use `\\#&' or `\\#N' if you want a number instead of a string.
329 In interactive use, `\\#' in itself stands for `replace-count'.
331 In Transient Mark mode, if the mark is active, operate on the contents
332 of the region. Otherwise, operate from point to the end of the buffer.
334 If `query-replace-interactive' is non-nil, the last incremental search
335 regexp is used as REGEXP--you don't have to specify it with the
336 minibuffer.
338 Preserves case in each replacement if `case-replace' and `case-fold-search'
339 are non-nil and REGEXP has no uppercase letters.
341 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
342 only matches that are surrounded by word boundaries.
343 Fourth and fifth arg START and END specify the region to operate on."
344 (interactive
345 (progn
346 (barf-if-buffer-read-only)
347 (let* ((from
348 ;; Let-bind the history var to disable the "foo -> bar" default.
349 ;; Maybe we shouldn't disable this default, but for now I'll
350 ;; leave it off. --Stef
351 (let ((query-replace-to-history-variable nil))
352 (query-replace-read-from "Query replace regexp" t)))
353 (to (list (read-from-minibuffer
354 (format "Query replace regexp %s with eval: "
355 (query-replace-descr from))
356 nil nil t query-replace-to-history-variable from t))))
357 ;; We make TO a list because replace-match-string-symbols requires one,
358 ;; and the user might enter a single token.
359 (replace-match-string-symbols to)
360 (list from (car to) current-prefix-arg
361 (if (and transient-mark-mode mark-active)
362 (region-beginning))
363 (if (and transient-mark-mode mark-active)
364 (region-end))))))
365 (perform-replace regexp (cons 'replace-eval-replacement to-expr)
366 t 'literal delimited nil nil start end))
368 (make-obsolete 'query-replace-regexp-eval
369 "for interactive use, use the special `\\,' feature of
370 `query-replace-regexp' instead. Non-interactively, a loop
371 using `search-forward-regexp' and `replace-match' is preferred." "22.1")
373 (defun map-query-replace-regexp (regexp to-strings &optional n start end)
374 "Replace some matches for REGEXP with various strings, in rotation.
375 The second argument TO-STRINGS contains the replacement strings, separated
376 by spaces. This command works like `query-replace-regexp' except that
377 each successive replacement uses the next successive replacement string,
378 wrapping around from the last such string to the first.
380 In Transient Mark mode, if the mark is active, operate on the contents
381 of the region. Otherwise, operate from point to the end of the buffer.
383 Non-interactively, TO-STRINGS may be a list of replacement strings.
385 If `query-replace-interactive' is non-nil, the last incremental search
386 regexp is used as REGEXP--you don't have to specify it with the minibuffer.
388 A prefix argument N says to use each replacement string N times
389 before rotating to the next.
390 Fourth and fifth arg START and END specify the region to operate on."
391 (interactive
392 (let* ((from (if query-replace-interactive
393 (car regexp-search-ring)
394 (read-from-minibuffer "Map query replace (regexp): "
395 nil nil nil
396 'query-replace-history nil t)))
397 (to (read-from-minibuffer
398 (format "Query replace %s with (space-separated strings): "
399 (query-replace-descr from))
400 nil nil nil
401 'query-replace-history from t)))
402 (list from to
403 (and current-prefix-arg
404 (prefix-numeric-value current-prefix-arg))
405 (if (and transient-mark-mode mark-active)
406 (region-beginning))
407 (if (and transient-mark-mode mark-active)
408 (region-end)))))
409 (let (replacements)
410 (if (listp to-strings)
411 (setq replacements to-strings)
412 (while (/= (length to-strings) 0)
413 (if (string-match " " to-strings)
414 (setq replacements
415 (append replacements
416 (list (substring to-strings 0
417 (string-match " " to-strings))))
418 to-strings (substring to-strings
419 (1+ (string-match " " to-strings))))
420 (setq replacements (append replacements (list to-strings))
421 to-strings ""))))
422 (perform-replace regexp replacements t t nil n nil start end)))
424 (defun replace-string (from-string to-string &optional delimited start end)
425 "Replace occurrences of FROM-STRING with TO-STRING.
426 Preserve case in each match if `case-replace' and `case-fold-search'
427 are non-nil and FROM-STRING has no uppercase letters.
428 \(Preserving case means that if the string matched is all caps, or capitalized,
429 then its replacement is upcased or capitalized.)
431 In Transient Mark mode, if the mark is active, operate on the contents
432 of the region. Otherwise, operate from point to the end of the buffer.
434 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
435 only matches surrounded by word boundaries.
436 Fourth and fifth arg START and END specify the region to operate on.
438 If `query-replace-interactive' is non-nil, the last incremental search
439 string is used as FROM-STRING--you don't have to specify it with the
440 minibuffer.
442 This function is usually the wrong thing to use in a Lisp program.
443 What you probably want is a loop like this:
444 (while (search-forward FROM-STRING nil t)
445 (replace-match TO-STRING nil t))
446 which will run faster and will not set the mark or print anything.
447 \(You may need a more complex loop if FROM-STRING can match the null string
448 and TO-STRING is also null.)"
449 (interactive
450 (let ((common
451 (query-replace-read-args
452 (if (and transient-mark-mode mark-active)
453 "Replace string in region"
454 "Replace string")
455 nil)))
456 (list (nth 0 common) (nth 1 common) (nth 2 common)
457 (if (and transient-mark-mode mark-active)
458 (region-beginning))
459 (if (and transient-mark-mode mark-active)
460 (region-end)))))
461 (perform-replace from-string to-string nil nil delimited nil nil start end))
463 (defun replace-regexp (regexp to-string &optional delimited start end)
464 "Replace things after point matching REGEXP with TO-STRING.
465 Preserve case in each match if `case-replace' and `case-fold-search'
466 are non-nil and REGEXP has no uppercase letters.
468 In Transient Mark mode, if the mark is active, operate on the contents
469 of the region. Otherwise, operate from point to the end of the buffer.
471 Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
472 only matches surrounded by word boundaries.
473 Fourth and fifth arg START and END specify the region to operate on.
475 In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
476 and `\\=\\N' (where N is a digit) stands for
477 whatever what matched the Nth `\\(...\\)' in REGEXP.
478 `\\?' lets you edit the replacement text in the minibuffer
479 at the given position for each replacement.
481 In interactive calls, the replacement text may contain `\\,'
482 followed by a Lisp expression used as part of the replacement
483 text. Inside of that expression, `\\&' is a string denoting the
484 whole match, `\\N' a partial match, `\\#&' and `\\#N' the respective
485 numeric values from `string-to-number', and `\\#' itself for
486 `replace-count', the number of replacements occurred so far.
488 If your Lisp expression is an identifier and the next letter in
489 the replacement string would be interpreted as part of it, you
490 can wrap it with an expression like `\\,(or \\#)'. Incidentally,
491 for this particular case you may also enter `\\#' in the
492 replacement text directly.
494 When using those Lisp features interactively in the replacement
495 text, TO-STRING is actually made a list instead of a string.
496 Use \\[repeat-complex-command] after this command for details.
498 If `query-replace-interactive' is non-nil, the last incremental search
499 regexp is used as REGEXP--you don't have to specify it with the minibuffer.
501 This function is usually the wrong thing to use in a Lisp program.
502 What you probably want is a loop like this:
503 (while (re-search-forward REGEXP nil t)
504 (replace-match TO-STRING nil nil))
505 which will run faster and will not set the mark or print anything."
506 (interactive
507 (let ((common
508 (query-replace-read-args
509 (if (and transient-mark-mode mark-active)
510 "Replace regexp in region"
511 "Replace regexp")
512 t)))
513 (list (nth 0 common) (nth 1 common) (nth 2 common)
514 (if (and transient-mark-mode mark-active)
515 (region-beginning))
516 (if (and transient-mark-mode mark-active)
517 (region-end)))))
518 (perform-replace regexp to-string nil t delimited nil nil start end))
521 (defvar regexp-history nil
522 "History list for some commands that read regular expressions.
524 Maximum length of the history list is determined by the value
525 of `history-length', which see.")
528 (defalias 'delete-non-matching-lines 'keep-lines)
529 (defalias 'delete-matching-lines 'flush-lines)
530 (defalias 'count-matches 'how-many)
533 (defun keep-lines-read-args (prompt)
534 "Read arguments for `keep-lines' and friends.
535 Prompt for a regexp with PROMPT.
536 Value is a list, (REGEXP)."
537 (let* ((default (list
538 (regexp-quote
539 (or (funcall (or find-tag-default-function
540 (get major-mode 'find-tag-default-function)
541 'find-tag-default))
542 ""))
543 (car regexp-search-ring)
544 (regexp-quote (or (car search-ring) ""))
545 (car (symbol-value
546 query-replace-from-history-variable))))
547 (default (delete-dups (delq nil (delete "" default)))))
548 (list (read-from-minibuffer prompt nil nil nil
549 'regexp-history default t)
550 nil nil t)))
552 (defun keep-lines (regexp &optional rstart rend interactive)
553 "Delete all lines except those containing matches for REGEXP.
554 A match split across lines preserves all the lines it lies in.
555 When called from Lisp (and usually interactively as well, see below)
556 applies to all lines starting after point.
558 If REGEXP contains upper case characters (excluding those preceded by `\\')
559 and `search-upper-case' is non-nil, the matching is case-sensitive.
561 Second and third arg RSTART and REND specify the region to operate on.
562 This command operates on (the accessible part of) all lines whose
563 accessible part is entirely contained in the region determined by RSTART
564 and REND. (A newline ending a line counts as part of that line.)
566 Interactively, in Transient Mark mode when the mark is active, operate
567 on all lines whose accessible part is entirely contained in the region.
568 Otherwise, the command applies to all lines starting after point.
569 When calling this function from Lisp, you can pretend that it was
570 called interactively by passing a non-nil INTERACTIVE argument.
572 This function starts looking for the next match from the end of
573 the previous match. Hence, it ignores matches that overlap
574 a previously found match."
576 (interactive
577 (progn
578 (barf-if-buffer-read-only)
579 (keep-lines-read-args "Keep lines (containing match for regexp): ")))
580 (if rstart
581 (progn
582 (goto-char (min rstart rend))
583 (setq rend
584 (progn
585 (save-excursion
586 (goto-char (max rstart rend))
587 (unless (or (bolp) (eobp))
588 (forward-line 0))
589 (point-marker)))))
590 (if (and interactive transient-mark-mode mark-active)
591 (setq rstart (region-beginning)
592 rend (progn
593 (goto-char (region-end))
594 (unless (or (bolp) (eobp))
595 (forward-line 0))
596 (point-marker)))
597 (setq rstart (point)
598 rend (point-max-marker)))
599 (goto-char rstart))
600 (save-excursion
601 (or (bolp) (forward-line 1))
602 (let ((start (point))
603 (case-fold-search
604 (if (and case-fold-search search-upper-case)
605 (isearch-no-upper-case-p regexp t)
606 case-fold-search)))
607 (while (< (point) rend)
608 ;; Start is first char not preserved by previous match.
609 (if (not (re-search-forward regexp rend 'move))
610 (delete-region start rend)
611 (let ((end (save-excursion (goto-char (match-beginning 0))
612 (forward-line 0)
613 (point))))
614 ;; Now end is first char preserved by the new match.
615 (if (< start end)
616 (delete-region start end))))
618 (setq start (save-excursion (forward-line 1) (point)))
619 ;; If the match was empty, avoid matching again at same place.
620 (and (< (point) rend)
621 (= (match-beginning 0) (match-end 0))
622 (forward-char 1)))))
623 (set-marker rend nil)
624 nil)
627 (defun flush-lines (regexp &optional rstart rend interactive)
628 "Delete lines containing matches for REGEXP.
629 When called from Lisp (and usually when called interactively as
630 well, see below), applies to the part of the buffer after point.
631 The line point is in is deleted if and only if it contains a
632 match for regexp starting after point.
634 If REGEXP contains upper case characters (excluding those preceded by `\\')
635 and `search-upper-case' is non-nil, the matching is case-sensitive.
637 Second and third arg RSTART and REND specify the region to operate on.
638 Lines partially contained in this region are deleted if and only if
639 they contain a match entirely contained in it.
641 Interactively, in Transient Mark mode when the mark is active, operate
642 on the contents of the region. Otherwise, operate from point to the
643 end of (the accessible portion of) the buffer. When calling this function
644 from Lisp, you can pretend that it was called interactively by passing
645 a non-nil INTERACTIVE argument.
647 If a match is split across lines, all the lines it lies in are deleted.
648 They are deleted _before_ looking for the next match. Hence, a match
649 starting on the same line at which another match ended is ignored."
651 (interactive
652 (progn
653 (barf-if-buffer-read-only)
654 (keep-lines-read-args "Flush lines (containing match for regexp): ")))
655 (if rstart
656 (progn
657 (goto-char (min rstart rend))
658 (setq rend (copy-marker (max rstart rend))))
659 (if (and interactive transient-mark-mode mark-active)
660 (setq rstart (region-beginning)
661 rend (copy-marker (region-end)))
662 (setq rstart (point)
663 rend (point-max-marker)))
664 (goto-char rstart))
665 (let ((case-fold-search
666 (if (and case-fold-search search-upper-case)
667 (isearch-no-upper-case-p regexp t)
668 case-fold-search)))
669 (save-excursion
670 (while (and (< (point) rend)
671 (re-search-forward regexp rend t))
672 (delete-region (save-excursion (goto-char (match-beginning 0))
673 (forward-line 0)
674 (point))
675 (progn (forward-line 1) (point))))))
676 (set-marker rend nil)
677 nil)
680 (defun how-many (regexp &optional rstart rend interactive)
681 "Print and return number of matches for REGEXP following point.
682 When called from Lisp and INTERACTIVE is omitted or nil, just return
683 the number, do not print it; if INTERACTIVE is t, the function behaves
684 in all respects has if it had been called interactively.
686 If REGEXP contains upper case characters (excluding those preceded by `\\')
687 and `search-upper-case' is non-nil, the matching is case-sensitive.
689 Second and third arg RSTART and REND specify the region to operate on.
691 Interactively, in Transient Mark mode when the mark is active, operate
692 on the contents of the region. Otherwise, operate from point to the
693 end of (the accessible portion of) the buffer.
695 This function starts looking for the next match from the end of
696 the previous match. Hence, it ignores matches that overlap
697 a previously found match."
699 (interactive
700 (keep-lines-read-args "How many matches for (regexp): "))
701 (save-excursion
702 (if rstart
703 (progn
704 (goto-char (min rstart rend))
705 (setq rend (max rstart rend)))
706 (if (and interactive transient-mark-mode mark-active)
707 (setq rstart (region-beginning)
708 rend (region-end))
709 (setq rstart (point)
710 rend (point-max)))
711 (goto-char rstart))
712 (let ((count 0)
713 opoint
714 (case-fold-search
715 (if (and case-fold-search search-upper-case)
716 (isearch-no-upper-case-p regexp t)
717 case-fold-search)))
718 (while (and (< (point) rend)
719 (progn (setq opoint (point))
720 (re-search-forward regexp rend t)))
721 (if (= opoint (point))
722 (forward-char 1)
723 (setq count (1+ count))))
724 (when interactive (message "%d occurrence%s"
725 count
726 (if (= count 1) "" "s")))
727 count)))
730 (defvar occur-mode-map
731 (let ((map (make-sparse-keymap)))
732 ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
733 (define-key map [mouse-2] 'occur-mode-mouse-goto)
734 (define-key map "\C-c\C-c" 'occur-mode-goto-occurrence)
735 (define-key map "\C-m" 'occur-mode-goto-occurrence)
736 (define-key map "o" 'occur-mode-goto-occurrence-other-window)
737 (define-key map "\C-o" 'occur-mode-display-occurrence)
738 (define-key map "\M-n" 'occur-next)
739 (define-key map "\M-p" 'occur-prev)
740 (define-key map "r" 'occur-rename-buffer)
741 (define-key map "c" 'clone-buffer)
742 (define-key map "g" 'revert-buffer)
743 (define-key map "q" 'quit-window)
744 (define-key map "z" 'kill-this-buffer)
745 (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
746 (define-key map [menu-bar] (make-sparse-keymap))
747 (define-key map [menu-bar occur]
748 (cons "Occur" map))
749 (define-key map [next-error-follow-minor-mode]
750 (menu-bar-make-mm-toggle next-error-follow-minor-mode
751 "Auto Occurrence Display"
752 "Display another occurrence when moving the cursor"))
753 (define-key map [separator-1] '("--"))
754 (define-key map [kill-this-buffer]
755 '("Kill occur buffer" . kill-this-buffer))
756 (define-key map [quit-window]
757 '("Quit occur window" . quit-window))
758 (define-key map [revert-buffer]
759 '("Revert occur buffer" . revert-buffer))
760 (define-key map [clone-buffer]
761 '("Clone occur buffer" . clone-buffer))
762 (define-key map [occur-rename-buffer]
763 '("Rename occur buffer" . occur-rename-buffer))
764 (define-key map [separator-2] '("--"))
765 (define-key map [occur-mode-goto-occurrence-other-window]
766 '("Go To Occurrence Other Window" . occur-mode-goto-occurrence-other-window))
767 (define-key map [occur-mode-goto-occurrence]
768 '("Go To Occurrence" . occur-mode-goto-occurrence))
769 (define-key map [occur-mode-display-occurrence]
770 '("Display Occurrence" . occur-mode-display-occurrence))
771 (define-key map [occur-next]
772 '("Move to next match" . occur-next))
773 (define-key map [occur-prev]
774 '("Move to previous match" . occur-prev))
775 map)
776 "Keymap for `occur-mode'.")
778 (defvar occur-revert-arguments nil
779 "Arguments to pass to `occur-1' to revert an Occur mode buffer.
780 See `occur-revert-function'.")
782 (defcustom occur-mode-hook '(turn-on-font-lock)
783 "Hook run when entering Occur mode."
784 :type 'hook
785 :group 'matching)
787 (defcustom occur-hook nil
788 "Hook run by Occur when there are any matches."
789 :type 'hook
790 :group 'matching)
792 (defcustom occur-mode-find-occurrence-hook nil
793 "Hook run by Occur after locating an occurrence.
794 This will be called with the cursor position at the occurrence. An application
795 for this is to reveal context in an outline-mode when the occurrence is hidden."
796 :type 'hook
797 :group 'matching)
799 (put 'occur-mode 'mode-class 'special)
800 (defun occur-mode ()
801 "Major mode for output from \\[occur].
802 \\<occur-mode-map>Move point to one of the items in this buffer, then use
803 \\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to.
804 Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it.
806 \\{occur-mode-map}"
807 (interactive)
808 (kill-all-local-variables)
809 (use-local-map occur-mode-map)
810 (setq major-mode 'occur-mode)
811 (setq mode-name "Occur")
812 (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
813 (make-local-variable 'occur-revert-arguments)
814 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
815 (setq next-error-function 'occur-next-error)
816 (run-mode-hooks 'occur-mode-hook))
818 (defun occur-revert-function (ignore1 ignore2)
819 "Handle `revert-buffer' for Occur mode buffers."
820 (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
822 (defun occur-mode-find-occurrence ()
823 (let ((pos (get-text-property (point) 'occur-target)))
824 (unless pos
825 (error "No occurrence on this line"))
826 (unless (buffer-live-p (marker-buffer pos))
827 (error "Buffer for this occurrence was killed"))
828 pos))
830 (defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence)
831 (defun occur-mode-goto-occurrence (&optional event)
832 "Go to the occurrence the current line describes."
833 (interactive (list last-nonmenu-event))
834 (let ((pos
835 (if (null event)
836 ;; Actually `event-end' works correctly with a nil argument as
837 ;; well, so we could dispense with this test, but let's not
838 ;; rely on this undocumented behavior.
839 (occur-mode-find-occurrence)
840 (with-current-buffer (window-buffer (posn-window (event-end event)))
841 (save-excursion
842 (goto-char (posn-point (event-end event)))
843 (occur-mode-find-occurrence)))))
844 same-window-buffer-names
845 same-window-regexps)
846 (pop-to-buffer (marker-buffer pos))
847 (goto-char pos)
848 (run-hooks 'occur-mode-find-occurrence-hook)))
850 (defun occur-mode-goto-occurrence-other-window ()
851 "Go to the occurrence the current line describes, in another window."
852 (interactive)
853 (let ((pos (occur-mode-find-occurrence)))
854 (switch-to-buffer-other-window (marker-buffer pos))
855 (goto-char pos)
856 (run-hooks 'occur-mode-find-occurrence-hook)))
858 (defun occur-mode-display-occurrence ()
859 "Display in another window the occurrence the current line describes."
860 (interactive)
861 (let ((pos (occur-mode-find-occurrence))
862 window
863 ;; Bind these to ensure `display-buffer' puts it in another window.
864 same-window-buffer-names
865 same-window-regexps)
866 (setq window (display-buffer (marker-buffer pos)))
867 ;; This is the way to set point in the proper window.
868 (save-selected-window
869 (select-window window)
870 (goto-char pos)
871 (run-hooks 'occur-mode-find-occurrence-hook))))
873 (defun occur-find-match (n search message)
874 (if (not n) (setq n 1))
875 (let ((r))
876 (while (> n 0)
877 (setq r (funcall search (point) 'occur-match))
878 (and r
879 (get-text-property r 'occur-match)
880 (setq r (funcall search r 'occur-match)))
881 (if r
882 (goto-char r)
883 (error message))
884 (setq n (1- n)))))
886 (defun occur-next (&optional n)
887 "Move to the Nth (default 1) next match in an Occur mode buffer."
888 (interactive "p")
889 (occur-find-match n #'next-single-property-change "No more matches"))
891 (defun occur-prev (&optional n)
892 "Move to the Nth (default 1) previous match in an Occur mode buffer."
893 (interactive "p")
894 (occur-find-match n #'previous-single-property-change "No earlier matches"))
896 (defun occur-next-error (&optional argp reset)
897 "Move to the Nth (default 1) next match in an Occur mode buffer.
898 Compatibility function for \\[next-error] invocations."
899 (interactive "p")
900 ;; we need to run occur-find-match from within the Occur buffer
901 (with-current-buffer
902 ;; Choose the buffer and make it current.
903 (if (next-error-buffer-p (current-buffer))
904 (current-buffer)
905 (next-error-find-buffer nil nil
906 (lambda ()
907 (eq major-mode 'occur-mode))))
909 (goto-char (cond (reset (point-min))
910 ((< argp 0) (line-beginning-position))
911 ((> argp 0) (line-end-position))
912 ((point))))
913 (occur-find-match
914 (abs argp)
915 (if (> 0 argp)
916 #'previous-single-property-change
917 #'next-single-property-change)
918 "No more matches")
919 ;; In case the *Occur* buffer is visible in a nonselected window.
920 (let ((win (get-buffer-window (current-buffer) t)))
921 (if win (set-window-point win (point))))
922 (occur-mode-goto-occurrence)))
924 (defface match
925 '((((class color) (min-colors 88) (background light))
926 :background "yellow1")
927 (((class color) (min-colors 88) (background dark))
928 :background "RoyalBlue3")
929 (((class color) (min-colors 8) (background light))
930 :background "yellow" :foreground "black")
931 (((class color) (min-colors 8) (background dark))
932 :background "blue" :foreground "white")
933 (((type tty) (class mono))
934 :inverse-video t)
935 (t :background "gray"))
936 "Face used to highlight matches permanently."
937 :group 'matching
938 :version "22.1")
940 (defcustom list-matching-lines-default-context-lines 0
941 "*Default number of context lines included around `list-matching-lines' matches.
942 A negative number means to include that many lines before the match.
943 A positive number means to include that many lines both before and after."
944 :type 'integer
945 :group 'matching)
947 (defalias 'list-matching-lines 'occur)
949 (defcustom list-matching-lines-face 'match
950 "*Face used by \\[list-matching-lines] to show the text that matches.
951 If the value is nil, don't highlight the matching portions specially."
952 :type 'face
953 :group 'matching)
955 (defcustom list-matching-lines-buffer-name-face 'underline
956 "*Face used by \\[list-matching-lines] to show the names of buffers.
957 If the value is nil, don't highlight the buffer names specially."
958 :type 'face
959 :group 'matching)
961 (defcustom occur-excluded-properties
962 '(read-only invisible intangible field mouse-face help-echo local-map keymap
963 yank-handler follow-link)
964 "*Text properties to discard when copying lines to the *Occur* buffer.
965 The value should be a list of text properties to discard or t,
966 which means to discard all text properties."
967 :type '(choice (const :tag "All" t) (repeat symbol))
968 :group 'matching
969 :version "22.1")
971 (defun occur-accumulate-lines (count &optional keep-props)
972 (save-excursion
973 (let ((forwardp (> count 0))
974 result beg end)
975 (while (not (or (zerop count)
976 (if forwardp
977 (eobp)
978 (bobp))))
979 (setq count (+ count (if forwardp -1 1)))
980 (setq beg (line-beginning-position)
981 end (line-end-position))
982 (if (and keep-props (if (boundp 'jit-lock-mode) jit-lock-mode)
983 (text-property-not-all beg end 'fontified t))
984 (if (fboundp 'jit-lock-fontify-now)
985 (jit-lock-fontify-now beg end)))
986 (push
987 (if (and keep-props (not (eq occur-excluded-properties t)))
988 (let ((str (buffer-substring beg end)))
989 (remove-list-of-text-properties
990 0 (length str) occur-excluded-properties str)
991 str)
992 (buffer-substring-no-properties beg end))
993 result)
994 (forward-line (if forwardp 1 -1)))
995 (nreverse result))))
997 (defun occur-read-primary-args ()
998 (let* ((default
999 (list (and transient-mark-mode mark-active
1000 (regexp-quote
1001 (buffer-substring-no-properties
1002 (region-beginning) (region-end))))
1003 (regexp-quote
1004 (or (funcall
1005 (or find-tag-default-function
1006 (get major-mode 'find-tag-default-function)
1007 'find-tag-default))
1008 ""))
1009 (car regexp-search-ring)
1010 (regexp-quote (or (car search-ring) ""))
1011 (car (symbol-value
1012 query-replace-from-history-variable))))
1013 (default (delete-dups (delq nil (delete "" default))))
1014 (input
1015 (read-from-minibuffer
1016 "List lines matching regexp: "
1017 nil nil nil 'regexp-history default)))
1018 (list input
1019 (when current-prefix-arg
1020 (prefix-numeric-value current-prefix-arg)))))
1022 (defun occur-rename-buffer (&optional unique-p interactive-p)
1023 "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
1024 Here `original-buffer-name' is the buffer name were Occur was originally run.
1025 When given the prefix argument, or called non-interactively, the renaming
1026 will not clobber the existing buffer(s) of that name, but use
1027 `generate-new-buffer-name' instead. You can add this to `occur-hook'
1028 if you always want a separate *Occur* buffer for each buffer where you
1029 invoke `occur'."
1030 (interactive "P\np")
1031 (with-current-buffer
1032 (if (eq major-mode 'occur-mode) (current-buffer) (get-buffer "*Occur*"))
1033 (rename-buffer (concat "*Occur: "
1034 (mapconcat #'buffer-name
1035 (car (cddr occur-revert-arguments)) "/")
1036 "*")
1037 (or unique-p (not interactive-p)))))
1039 (defun occur (regexp &optional nlines)
1040 "Show all lines in the current buffer containing a match for REGEXP.
1041 This function can not handle matches that span more than one line.
1043 Each line is displayed with NLINES lines before and after, or -NLINES
1044 before if NLINES is negative.
1045 NLINES defaults to `list-matching-lines-default-context-lines'.
1046 Interactively it is the prefix arg.
1048 The lines are shown in a buffer named `*Occur*'.
1049 It serves as a menu to find any of the occurrences in this buffer.
1050 \\<occur-mode-map>\\[describe-mode] in that buffer will explain how.
1052 If REGEXP contains upper case characters (excluding those preceded by `\\')
1053 and `search-upper-case' is non-nil, the matching is case-sensitive."
1054 (interactive (occur-read-primary-args))
1055 (occur-1 regexp nlines (list (current-buffer))))
1057 (defun multi-occur (bufs regexp &optional nlines)
1058 "Show all lines in buffers BUFS containing a match for REGEXP.
1059 This function acts on multiple buffers; otherwise, it is exactly like
1060 `occur'. When you invoke this command interactively, you must specify
1061 the buffer names that you want, one by one."
1062 (interactive
1063 (cons
1064 (let* ((bufs (list (read-buffer "First buffer to search: "
1065 (current-buffer) t)))
1066 (buf nil)
1067 (ido-ignore-item-temp-list bufs))
1068 (while (not (string-equal
1069 (setq buf (read-buffer
1070 (if (eq read-buffer-function 'ido-read-buffer)
1071 "Next buffer to search (C-j to end): "
1072 "Next buffer to search (RET to end): ")
1073 nil t))
1074 ""))
1075 (add-to-list 'bufs buf)
1076 (setq ido-ignore-item-temp-list bufs))
1077 (nreverse (mapcar #'get-buffer bufs)))
1078 (occur-read-primary-args)))
1079 (occur-1 regexp nlines bufs))
1081 (defun multi-occur-in-matching-buffers (bufregexp regexp &optional allbufs)
1082 "Show all lines matching REGEXP in buffers specified by BUFREGEXP.
1083 Normally BUFREGEXP matches against each buffer's visited file name,
1084 but if you specify a prefix argument, it matches against the buffer name.
1085 See also `multi-occur'."
1086 (interactive
1087 (cons
1088 (let* ((default (car regexp-history))
1089 (input
1090 (read-from-minibuffer
1091 (if current-prefix-arg
1092 "List lines in buffers whose names match regexp: "
1093 "List lines in buffers whose filenames match regexp: ")
1097 'regexp-history)))
1098 (if (equal input "")
1099 default
1100 input))
1101 (occur-read-primary-args)))
1102 (when bufregexp
1103 (occur-1 regexp nil
1104 (delq nil
1105 (mapcar (lambda (buf)
1106 (when (if allbufs
1107 (string-match bufregexp
1108 (buffer-name buf))
1109 (and (buffer-file-name buf)
1110 (string-match bufregexp
1111 (buffer-file-name buf))))
1112 buf))
1113 (buffer-list))))))
1115 (defun occur-1 (regexp nlines bufs &optional buf-name)
1116 (unless buf-name
1117 (setq buf-name "*Occur*"))
1118 (let (occur-buf
1119 (active-bufs (delq nil (mapcar #'(lambda (buf)
1120 (when (buffer-live-p buf) buf))
1121 bufs))))
1122 ;; Handle the case where one of the buffers we're searching is the
1123 ;; output buffer. Just rename it.
1124 (when (member buf-name (mapcar 'buffer-name active-bufs))
1125 (with-current-buffer (get-buffer buf-name)
1126 (rename-uniquely)))
1128 ;; Now find or create the output buffer.
1129 ;; If we just renamed that buffer, we will make a new one here.
1130 (setq occur-buf (get-buffer-create buf-name))
1132 (with-current-buffer occur-buf
1133 (occur-mode)
1134 (let ((inhibit-read-only t)
1135 ;; Don't generate undo entries for creation of the initial contents.
1136 (buffer-undo-list t))
1137 (erase-buffer)
1138 (let ((count (occur-engine
1139 regexp active-bufs occur-buf
1140 (or nlines list-matching-lines-default-context-lines)
1141 (if (and case-fold-search search-upper-case)
1142 (isearch-no-upper-case-p regexp t)
1143 case-fold-search)
1144 list-matching-lines-buffer-name-face
1145 nil list-matching-lines-face
1146 (not (eq occur-excluded-properties t)))))
1147 (let* ((bufcount (length active-bufs))
1148 (diff (- (length bufs) bufcount)))
1149 (message "Searched %d buffer%s%s; %s match%s for `%s'"
1150 bufcount (if (= bufcount 1) "" "s")
1151 (if (zerop diff) "" (format " (%d killed)" diff))
1152 (if (zerop count) "no" (format "%d" count))
1153 (if (= count 1) "" "es")
1154 regexp))
1155 (setq occur-revert-arguments (list regexp nlines bufs))
1156 (if (= count 0)
1157 (kill-buffer occur-buf)
1158 (display-buffer occur-buf)
1159 (setq next-error-last-buffer occur-buf)
1160 (setq buffer-read-only t)
1161 (set-buffer-modified-p nil)
1162 (run-hooks 'occur-hook)))))))
1164 (defun occur-engine-add-prefix (lines)
1165 (mapcar
1166 #'(lambda (line)
1167 (concat " :" line "\n"))
1168 lines))
1170 (defun occur-engine (regexp buffers out-buf nlines case-fold-search
1171 title-face prefix-face match-face keep-props)
1172 (with-current-buffer out-buf
1173 (let ((globalcount 0)
1174 (coding nil))
1175 ;; Map over all the buffers
1176 (dolist (buf buffers)
1177 (when (buffer-live-p buf)
1178 (let ((matches 0) ;; count of matched lines
1179 (lines 1) ;; line count
1180 (matchbeg 0)
1181 (origpt nil)
1182 (begpt nil)
1183 (endpt nil)
1184 (marker nil)
1185 (curstring "")
1186 (inhibit-field-text-motion t)
1187 (headerpt (with-current-buffer out-buf (point))))
1188 (with-current-buffer buf
1189 (or coding
1190 ;; Set CODING only if the current buffer locally
1191 ;; binds buffer-file-coding-system.
1192 (not (local-variable-p 'buffer-file-coding-system))
1193 (setq coding buffer-file-coding-system))
1194 (save-excursion
1195 (goto-char (point-min)) ;; begin searching in the buffer
1196 (while (not (eobp))
1197 (setq origpt (point))
1198 (when (setq endpt (re-search-forward regexp nil t))
1199 (setq matches (1+ matches)) ;; increment match count
1200 (setq matchbeg (match-beginning 0))
1201 (setq lines (+ lines (1- (count-lines origpt endpt))))
1202 (save-excursion
1203 (goto-char matchbeg)
1204 (setq begpt (line-beginning-position)
1205 endpt (line-end-position)))
1206 (setq marker (make-marker))
1207 (set-marker marker matchbeg)
1208 (if (and keep-props
1209 (if (boundp 'jit-lock-mode) jit-lock-mode)
1210 (text-property-not-all begpt endpt 'fontified t))
1211 (if (fboundp 'jit-lock-fontify-now)
1212 (jit-lock-fontify-now begpt endpt)))
1213 (if (and keep-props (not (eq occur-excluded-properties t)))
1214 (progn
1215 (setq curstring (buffer-substring begpt endpt))
1216 (remove-list-of-text-properties
1217 0 (length curstring) occur-excluded-properties curstring))
1218 (setq curstring (buffer-substring-no-properties begpt endpt)))
1219 ;; Highlight the matches
1220 (let ((len (length curstring))
1221 (start 0))
1222 (while (and (< start len)
1223 (string-match regexp curstring start))
1224 (add-text-properties
1225 (match-beginning 0) (match-end 0)
1226 (append
1227 `(occur-match t)
1228 (when match-face
1229 ;; Use `face' rather than `font-lock-face' here
1230 ;; so as to override faces copied from the buffer.
1231 `(face ,match-face)))
1232 curstring)
1233 (setq start (match-end 0))))
1234 ;; Generate the string to insert for this match
1235 (let* ((out-line
1236 (concat
1237 ;; Using 7 digits aligns tabs properly.
1238 (apply #'propertize (format "%7d:" lines)
1239 (append
1240 (when prefix-face
1241 `(font-lock-face prefix-face))
1242 `(occur-prefix t mouse-face (highlight)
1243 occur-target ,marker follow-link t
1244 help-echo "mouse-2: go to this occurrence")))
1245 ;; We don't put `mouse-face' on the newline,
1246 ;; because that loses. And don't put it
1247 ;; on context lines to reduce flicker.
1248 (propertize curstring 'mouse-face (list 'highlight)
1249 'occur-target marker
1250 'follow-link t
1251 'help-echo
1252 "mouse-2: go to this occurrence")
1253 ;; Add marker at eol, but no mouse props.
1254 (propertize "\n" 'occur-target marker)))
1255 (data
1256 (if (= nlines 0)
1257 ;; The simple display style
1258 out-line
1259 ;; The complex multi-line display style.
1260 (occur-context-lines out-line nlines keep-props)
1262 ;; Actually insert the match display data
1263 (with-current-buffer out-buf
1264 (let ((beg (point))
1265 (end (progn (insert data) (point))))
1266 (unless (= nlines 0)
1267 (insert "-------\n")))))
1268 (goto-char endpt))
1269 (if endpt
1270 (progn
1271 (setq lines (1+ lines))
1272 ;; On to the next match...
1273 (forward-line 1))
1274 (goto-char (point-max))))))
1275 (when (not (zerop matches)) ;; is the count zero?
1276 (setq globalcount (+ globalcount matches))
1277 (with-current-buffer out-buf
1278 (goto-char headerpt)
1279 (let ((beg (point))
1280 end)
1281 (insert (format "%d match%s for \"%s\" in buffer: %s\n"
1282 matches (if (= matches 1) "" "es")
1283 regexp (buffer-name buf)))
1284 (setq end (point))
1285 (add-text-properties beg end
1286 (append
1287 (when title-face
1288 `(font-lock-face ,title-face))
1289 `(occur-title ,buf))))
1290 (goto-char (point-min)))))))
1291 (if coding
1292 ;; CODING is buffer-file-coding-system of the first buffer
1293 ;; that locally binds it. Let's use it also for the output
1294 ;; buffer.
1295 (set-buffer-file-coding-system coding))
1296 ;; Return the number of matches
1297 globalcount)))
1299 ;; Generate context display for occur.
1300 ;; OUT-LINE is the line where the match is.
1301 ;; NLINES and KEEP-PROPS are args to occur-engine.
1302 ;; Generate a list of lines, add prefixes to all but OUT-LINE,
1303 ;; then concatenate them all together.
1304 (defun occur-context-lines (out-line nlines keep-props)
1305 (apply #'concat
1306 (nconc
1307 (occur-engine-add-prefix
1308 (nreverse (cdr (occur-accumulate-lines
1309 (- (1+ (abs nlines))) keep-props))))
1310 (list out-line)
1311 (if (> nlines 0)
1312 (occur-engine-add-prefix
1313 (cdr (occur-accumulate-lines (1+ nlines) keep-props)))))))
1315 ;; It would be nice to use \\[...], but there is no reasonable way
1316 ;; to make that display both SPC and Y.
1317 (defconst query-replace-help
1318 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
1319 RET or `q' to exit, Period to replace one match and exit,
1320 Comma to replace but not move point immediately,
1321 C-r to enter recursive edit (\\[exit-recursive-edit] to get out again),
1322 C-w to delete match and recursive edit,
1323 C-l to clear the screen, redisplay, and offer same replacement again,
1324 ! to replace all remaining matches with no more questions,
1325 ^ to move point back to previous match,
1326 E to edit the replacement string"
1327 "Help message while in `query-replace'.")
1329 (defvar query-replace-map
1330 (let ((map (make-sparse-keymap)))
1331 (define-key map " " 'act)
1332 (define-key map "\d" 'skip)
1333 (define-key map [delete] 'skip)
1334 (define-key map [backspace] 'skip)
1335 (define-key map "y" 'act)
1336 (define-key map "n" 'skip)
1337 (define-key map "Y" 'act)
1338 (define-key map "N" 'skip)
1339 (define-key map "e" 'edit-replacement)
1340 (define-key map "E" 'edit-replacement)
1341 (define-key map "," 'act-and-show)
1342 (define-key map "q" 'exit)
1343 (define-key map "\r" 'exit)
1344 (define-key map [return] 'exit)
1345 (define-key map "." 'act-and-exit)
1346 (define-key map "\C-r" 'edit)
1347 (define-key map "\C-w" 'delete-and-edit)
1348 (define-key map "\C-l" 'recenter)
1349 (define-key map "!" 'automatic)
1350 (define-key map "^" 'backup)
1351 (define-key map "\C-h" 'help)
1352 (define-key map [f1] 'help)
1353 (define-key map [help] 'help)
1354 (define-key map "?" 'help)
1355 (define-key map "\C-g" 'quit)
1356 (define-key map "\C-]" 'quit)
1357 (define-key map "\e" 'exit-prefix)
1358 (define-key map [escape] 'exit-prefix)
1359 map)
1360 "Keymap that defines the responses to questions in `query-replace'.
1361 The \"bindings\" in this map are not commands; they are answers.
1362 The valid answers include `act', `skip', `act-and-show',
1363 `exit', `act-and-exit', `edit', `delete-and-edit', `recenter',
1364 `automatic', `backup', `exit-prefix', and `help'.")
1366 (defun replace-match-string-symbols (n)
1367 "Process a list (and any sub-lists), expanding certain symbols.
1368 Symbol Expands To
1369 N (match-string N) (where N is a string of digits)
1370 #N (string-to-number (match-string N))
1371 & (match-string 0)
1372 #& (string-to-number (match-string 0))
1373 # replace-count
1375 Note that these symbols must be preceeded by a backslash in order to
1376 type them using Lisp syntax."
1377 (while (consp n)
1378 (cond
1379 ((consp (car n))
1380 (replace-match-string-symbols (car n))) ;Process sub-list
1381 ((symbolp (car n))
1382 (let ((name (symbol-name (car n))))
1383 (cond
1384 ((string-match "^[0-9]+$" name)
1385 (setcar n (list 'match-string (string-to-number name))))
1386 ((string-match "^#[0-9]+$" name)
1387 (setcar n (list 'string-to-number
1388 (list 'match-string
1389 (string-to-number (substring name 1))))))
1390 ((string= "&" name)
1391 (setcar n '(match-string 0)))
1392 ((string= "#&" name)
1393 (setcar n '(string-to-number (match-string 0))))
1394 ((string= "#" name)
1395 (setcar n 'replace-count))))))
1396 (setq n (cdr n))))
1398 (defun replace-eval-replacement (expression replace-count)
1399 (let ((replacement (eval expression)))
1400 (if (stringp replacement)
1401 replacement
1402 (prin1-to-string replacement t))))
1404 (defun replace-quote (replacement)
1405 "Quote a replacement string.
1406 This just doubles all backslashes in REPLACEMENT and
1407 returns the resulting string. If REPLACEMENT is not
1408 a string, it is first passed through `prin1-to-string'
1409 with the `noescape' argument set.
1411 `match-data' is preserved across the call."
1412 (save-match-data
1413 (replace-regexp-in-string "\\\\" "\\\\"
1414 (if (stringp replacement)
1415 replacement
1416 (prin1-to-string replacement t))
1417 t t)))
1419 (defun replace-loop-through-replacements (data replace-count)
1420 ;; DATA is a vector contaning the following values:
1421 ;; 0 next-rotate-count
1422 ;; 1 repeat-count
1423 ;; 2 next-replacement
1424 ;; 3 replacements
1425 (if (= (aref data 0) replace-count)
1426 (progn
1427 (aset data 0 (+ replace-count (aref data 1)))
1428 (let ((next (cdr (aref data 2))))
1429 (aset data 2 (if (consp next) next (aref data 3))))))
1430 (car (aref data 2)))
1432 (defun replace-match-data (integers reuse &optional new)
1433 "Like `match-data', but markers in REUSE get invalidated.
1434 If NEW is non-nil, it is set and returned instead of fresh data,
1435 but coerced to the correct value of INTEGERS."
1436 (or (and new
1437 (progn
1438 (set-match-data new)
1439 (and (eq new reuse)
1440 (eq (null integers) (markerp (car reuse)))
1441 new)))
1442 (match-data integers reuse t)))
1444 (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data)
1445 "Make a replacement with `replace-match', editing `\\?'.
1446 NEWTEXT, FIXEDCASE, LITERAL are just passed on. If NOEDIT is true, no
1447 check for `\\?' is made to save time. MATCH-DATA is used for the
1448 replacement. In case editing is done, it is changed to use markers.
1450 The return value is non-nil if there has been no `\\?' or NOEDIT was
1451 passed in. If LITERAL is set, no checking is done, anyway."
1452 (unless (or literal noedit)
1453 (setq noedit t)
1454 (while (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\?\\)"
1455 newtext)
1456 (setq newtext
1457 (read-string "Edit replacement string: "
1458 (prog1
1459 (cons
1460 (replace-match "" t t newtext 3)
1461 (1+ (match-beginning 3)))
1462 (setq match-data
1463 (replace-match-data
1464 nil match-data match-data))))
1465 noedit nil)))
1466 (set-match-data match-data)
1467 (replace-match newtext fixedcase literal)
1468 noedit)
1470 (defun perform-replace (from-string replacements
1471 query-flag regexp-flag delimited-flag
1472 &optional repeat-count map start end)
1473 "Subroutine of `query-replace'. Its complexity handles interactive queries.
1474 Don't use this in your own program unless you want to query and set the mark
1475 just as `query-replace' does. Instead, write a simple loop like this:
1477 (while (re-search-forward \"foo[ \\t]+bar\" nil t)
1478 (replace-match \"foobar\" nil nil))
1480 which will run faster and probably do exactly what you want. Please
1481 see the documentation of `replace-match' to find out how to simulate
1482 `case-replace'.
1484 This function returns nil if and only if there were no matches to
1485 make, or the user didn't cancel the call."
1486 (or map (setq map query-replace-map))
1487 (and query-flag minibuffer-auto-raise
1488 (raise-frame (window-frame (minibuffer-window))))
1489 (let* ((case-fold-search
1490 (if (and case-fold-search search-upper-case)
1491 (isearch-no-upper-case-p from-string regexp-flag)
1492 case-fold-search))
1493 (nocasify (not (and case-replace case-fold-search)))
1494 (literal (or (not regexp-flag) (eq regexp-flag 'literal)))
1495 (search-function (if regexp-flag 're-search-forward 'search-forward))
1496 (search-string from-string)
1497 (real-match-data nil) ; The match data for the current match.
1498 (next-replacement nil)
1499 ;; This is non-nil if we know there is nothing for the user
1500 ;; to edit in the replacement.
1501 (noedit nil)
1502 (keep-going t)
1503 (stack nil)
1504 (replace-count 0)
1505 (nonempty-match nil)
1507 ;; If non-nil, it is marker saying where in the buffer to stop.
1508 (limit nil)
1510 ;; Data for the next match. If a cons, it has the same format as
1511 ;; (match-data); otherwise it is t if a match is possible at point.
1512 (match-again t)
1514 (message
1515 (if query-flag
1516 (apply 'propertize
1517 (substitute-command-keys
1518 "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) ")
1519 minibuffer-prompt-properties))))
1521 ;; If region is active, in Transient Mark mode, operate on region.
1522 (when start
1523 (setq limit (copy-marker (max start end)))
1524 (goto-char (min start end))
1525 (deactivate-mark))
1527 ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
1528 ;; containing a function and its first argument. The function is
1529 ;; called to generate each replacement like this:
1530 ;; (funcall (car replacements) (cdr replacements) replace-count)
1531 ;; It must return a string.
1532 (cond
1533 ((stringp replacements)
1534 (setq next-replacement replacements
1535 replacements nil))
1536 ((stringp (car replacements)) ; If it isn't a string, it must be a cons
1537 (or repeat-count (setq repeat-count 1))
1538 (setq replacements (cons 'replace-loop-through-replacements
1539 (vector repeat-count repeat-count
1540 replacements replacements)))))
1542 (if delimited-flag
1543 (setq search-function 're-search-forward
1544 search-string (concat "\\b"
1545 (if regexp-flag from-string
1546 (regexp-quote from-string))
1547 "\\b")))
1548 (when query-replace-lazy-highlight
1549 (setq isearch-lazy-highlight-last-string nil))
1551 (push-mark)
1552 (undo-boundary)
1553 (unwind-protect
1554 ;; Loop finding occurrences that perhaps should be replaced.
1555 (while (and keep-going
1556 (not (or (eobp) (and limit (>= (point) limit))))
1557 ;; Use the next match if it is already known;
1558 ;; otherwise, search for a match after moving forward
1559 ;; one char if progress is required.
1560 (setq real-match-data
1561 (cond ((consp match-again)
1562 (goto-char (nth 1 match-again))
1563 (replace-match-data
1564 t real-match-data match-again))
1565 ;; MATCH-AGAIN non-nil means accept an
1566 ;; adjacent match.
1567 (match-again
1568 (and
1569 (funcall search-function search-string
1570 limit t)
1571 ;; For speed, use only integers and
1572 ;; reuse the list used last time.
1573 (replace-match-data t real-match-data)))
1574 ((and (< (1+ (point)) (point-max))
1575 (or (null limit)
1576 (< (1+ (point)) limit)))
1577 ;; If not accepting adjacent matches,
1578 ;; move one char to the right before
1579 ;; searching again. Undo the motion
1580 ;; if the search fails.
1581 (let ((opoint (point)))
1582 (forward-char 1)
1583 (if (funcall
1584 search-function search-string
1585 limit t)
1586 (replace-match-data
1587 t real-match-data)
1588 (goto-char opoint)
1589 nil))))))
1591 ;; Record whether the match is nonempty, to avoid an infinite loop
1592 ;; repeatedly matching the same empty string.
1593 (setq nonempty-match
1594 (/= (nth 0 real-match-data) (nth 1 real-match-data)))
1596 ;; If the match is empty, record that the next one can't be
1597 ;; adjacent.
1599 ;; Otherwise, if matching a regular expression, do the next
1600 ;; match now, since the replacement for this match may
1601 ;; affect whether the next match is adjacent to this one.
1602 ;; If that match is empty, don't use it.
1603 (setq match-again
1604 (and nonempty-match
1605 (or (not regexp-flag)
1606 (and (looking-at search-string)
1607 (let ((match (match-data)))
1608 (and (/= (nth 0 match) (nth 1 match))
1609 match))))))
1611 ;; Optionally ignore matches that have a read-only property.
1612 (unless (and query-replace-skip-read-only
1613 (text-property-not-all
1614 (nth 0 real-match-data) (nth 1 real-match-data)
1615 'read-only nil))
1617 ;; Calculate the replacement string, if necessary.
1618 (when replacements
1619 (set-match-data real-match-data)
1620 (setq next-replacement
1621 (funcall (car replacements) (cdr replacements)
1622 replace-count)))
1623 (if (not query-flag)
1624 (let ((inhibit-read-only
1625 query-replace-skip-read-only))
1626 (unless (or literal noedit)
1627 (replace-highlight
1628 (nth 0 real-match-data) (nth 1 real-match-data)
1629 start end search-string
1630 (or delimited-flag regexp-flag) case-fold-search))
1631 (setq noedit
1632 (replace-match-maybe-edit
1633 next-replacement nocasify literal
1634 noedit real-match-data)
1635 replace-count (1+ replace-count)))
1636 (undo-boundary)
1637 (let (done replaced key def)
1638 ;; Loop reading commands until one of them sets done,
1639 ;; which means it has finished handling this
1640 ;; occurrence. Any command that sets `done' should
1641 ;; leave behind proper match data for the stack.
1642 ;; Commands not setting `done' need to adjust
1643 ;; `real-match-data'.
1644 (while (not done)
1645 (set-match-data real-match-data)
1646 (replace-highlight
1647 (match-beginning 0) (match-end 0)
1648 start end search-string
1649 (or delimited-flag regexp-flag) case-fold-search)
1650 ;; Bind message-log-max so we don't fill up the message log
1651 ;; with a bunch of identical messages.
1652 (let ((message-log-max nil)
1653 (replacement-presentation
1654 (if query-replace-show-replacement
1655 (save-match-data
1656 (set-match-data real-match-data)
1657 (match-substitute-replacement next-replacement
1658 nocasify literal))
1659 next-replacement)))
1660 (message message
1661 (query-replace-descr from-string)
1662 (query-replace-descr replacement-presentation)))
1663 (setq key (read-event))
1664 ;; Necessary in case something happens during read-event
1665 ;; that clobbers the match data.
1666 (set-match-data real-match-data)
1667 (setq key (vector key))
1668 (setq def (lookup-key map key))
1669 ;; Restore the match data while we process the command.
1670 (cond ((eq def 'help)
1671 (with-output-to-temp-buffer "*Help*"
1672 (princ
1673 (concat "Query replacing "
1674 (if regexp-flag "regexp " "")
1675 from-string " with "
1676 next-replacement ".\n\n"
1677 (substitute-command-keys
1678 query-replace-help)))
1679 (with-current-buffer standard-output
1680 (help-mode))))
1681 ((eq def 'exit)
1682 (setq keep-going nil)
1683 (setq done t))
1684 ((eq def 'backup)
1685 (if stack
1686 (let ((elt (pop stack)))
1687 (goto-char (nth 0 elt))
1688 (setq replaced (nth 1 elt)
1689 real-match-data
1690 (replace-match-data
1691 t real-match-data
1692 (nth 2 elt))))
1693 (message "No previous match")
1694 (ding 'no-terminate)
1695 (sit-for 1)))
1696 ((eq def 'act)
1697 (or replaced
1698 (setq noedit
1699 (replace-match-maybe-edit
1700 next-replacement nocasify literal
1701 noedit real-match-data)
1702 replace-count (1+ replace-count)))
1703 (setq done t replaced t))
1704 ((eq def 'act-and-exit)
1705 (or replaced
1706 (setq noedit
1707 (replace-match-maybe-edit
1708 next-replacement nocasify literal
1709 noedit real-match-data)
1710 replace-count (1+ replace-count)))
1711 (setq keep-going nil)
1712 (setq done t replaced t))
1713 ((eq def 'act-and-show)
1714 (if (not replaced)
1715 (setq noedit
1716 (replace-match-maybe-edit
1717 next-replacement nocasify literal
1718 noedit real-match-data)
1719 replace-count (1+ replace-count)
1720 real-match-data (replace-match-data
1721 t real-match-data)
1722 replaced t)))
1723 ((eq def 'automatic)
1724 (or replaced
1725 (setq noedit
1726 (replace-match-maybe-edit
1727 next-replacement nocasify literal
1728 noedit real-match-data)
1729 replace-count (1+ replace-count)))
1730 (setq done t query-flag nil replaced t))
1731 ((eq def 'skip)
1732 (setq done t))
1733 ((eq def 'recenter)
1734 (recenter nil))
1735 ((eq def 'edit)
1736 (let ((opos (point-marker)))
1737 (setq real-match-data (replace-match-data
1738 nil real-match-data
1739 real-match-data))
1740 (goto-char (match-beginning 0))
1741 (save-excursion
1742 (save-window-excursion
1743 (recursive-edit)))
1744 (goto-char opos)
1745 (set-marker opos nil))
1746 ;; Before we make the replacement,
1747 ;; decide whether the search string
1748 ;; can match again just after this match.
1749 (if (and regexp-flag nonempty-match)
1750 (setq match-again (and (looking-at search-string)
1751 (match-data)))))
1752 ;; Edit replacement.
1753 ((eq def 'edit-replacement)
1754 (setq real-match-data (replace-match-data
1755 nil real-match-data
1756 real-match-data)
1757 next-replacement
1758 (read-string "Edit replacement string: "
1759 next-replacement)
1760 noedit nil)
1761 (if replaced
1762 (set-match-data real-match-data)
1763 (setq noedit
1764 (replace-match-maybe-edit
1765 next-replacement nocasify literal noedit
1766 real-match-data)
1767 replaced t))
1768 (setq done t))
1770 ((eq def 'delete-and-edit)
1771 (replace-match "" t t)
1772 (setq real-match-data (replace-match-data
1773 nil real-match-data))
1774 (replace-dehighlight)
1775 (save-excursion (recursive-edit))
1776 (setq replaced t))
1777 ;; Note: we do not need to treat `exit-prefix'
1778 ;; specially here, since we reread
1779 ;; any unrecognized character.
1781 (setq this-command 'mode-exited)
1782 (setq keep-going nil)
1783 (setq unread-command-events
1784 (append (listify-key-sequence key)
1785 unread-command-events))
1786 (setq done t)))
1787 (when query-replace-lazy-highlight
1788 ;; Force lazy rehighlighting only after replacements
1789 (if (not (memq def '(skip backup)))
1790 (setq isearch-lazy-highlight-last-string nil))))
1791 ;; Record previous position for ^ when we move on.
1792 ;; Change markers to numbers in the match data
1793 ;; since lots of markers slow down editing.
1794 (push (list (point) replaced
1795 ;;; If the replacement has already happened, all we need is the
1796 ;;; current match start and end. We could get this with a trivial
1797 ;;; match like
1798 ;;; (save-excursion (goto-char (match-beginning 0))
1799 ;;; (search-forward (match-string 0))
1800 ;;; (match-data t))
1801 ;;; if we really wanted to avoid manually constructing match data.
1802 ;;; Adding current-buffer is necessary so that match-data calls can
1803 ;;; return markers which are appropriate for editing.
1804 (if replaced
1805 (list
1806 (match-beginning 0)
1807 (match-end 0)
1808 (current-buffer))
1809 (match-data t)))
1810 stack)))))
1812 (replace-dehighlight))
1813 (or unread-command-events
1814 (message "Replaced %d occurrence%s"
1815 replace-count
1816 (if (= replace-count 1) "" "s")))
1817 (and keep-going stack)))
1819 (defvar replace-overlay nil)
1821 (defun replace-highlight (match-beg match-end range-beg range-end
1822 string regexp case-fold)
1823 (if query-replace-highlight
1824 (if replace-overlay
1825 (move-overlay replace-overlay match-beg match-end (current-buffer))
1826 (setq replace-overlay (make-overlay match-beg match-end))
1827 (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays
1828 (overlay-put replace-overlay 'face 'query-replace)))
1829 (if query-replace-lazy-highlight
1830 (let ((isearch-string string)
1831 (isearch-regexp regexp)
1832 (search-whitespace-regexp nil)
1833 (isearch-case-fold-search case-fold))
1834 (isearch-lazy-highlight-new-loop range-beg range-end))))
1836 (defun replace-dehighlight ()
1837 (when replace-overlay
1838 (delete-overlay replace-overlay))
1839 (when query-replace-lazy-highlight
1840 (lazy-highlight-cleanup lazy-highlight-cleanup)
1841 (setq isearch-lazy-highlight-last-string nil)))
1843 ;; arch-tag: 16b4cd61-fd40-497b-b86f-b667c4cf88e4
1844 ;;; replace.el ends here