replace.el 56.3 KB
Newer Older
1
;;; replace.el --- replace commands for Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3 4
;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1996, 1997, 2000, 2001, 2002,
;;   2003, 2004  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Pavel Janík's avatar
Pavel Janík committed
6 7
;; Maintainer: FSF

Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
13 14 15 16 17 18 19 20
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

25 26 27 28 29
;;; Commentary:

;; This package supplies the string and regular-expression replace functions
;; documented in the Emacs user's manual.

Eric S. Raymond's avatar
Eric S. Raymond committed
30
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
31

32
(defcustom case-replace t
33
  "*Non-nil means `query-replace' should preserve case in replacements."
34 35
  :type 'boolean
  :group 'matching)
Roland McGrath's avatar
Roland McGrath committed
36

37 38
(defvar query-replace-history nil)

39
(defvar query-replace-interactive nil
40
  "Non-nil means `query-replace' uses the last search string.
41
That becomes the \"string to replace\".")
42

43
(defcustom query-replace-from-history-variable 'query-replace-history
44
  "History list to use for the FROM argument of `query-replace' commands.
45 46 47 48
The value of this variable should be a symbol; that symbol
is used as a variable to hold a history list for the strings
or patterns to be replaced."
  :group 'matching
Dan Nicolaescu's avatar
Dan Nicolaescu committed
49 50
  :type 'symbol
  :version "20.3")
51 52

(defcustom query-replace-to-history-variable 'query-replace-history
53
  "History list to use for the TO argument of `query-replace' commands.
54 55 56 57
The value of this variable should be a symbol; that symbol
is used as a variable to hold a history list for replacement
strings or patterns."
  :group 'matching
Dan Nicolaescu's avatar
Dan Nicolaescu committed
58 59
  :type 'symbol
  :version "20.3")
60

61 62 63 64
(defcustom query-replace-skip-read-only nil
  "*Non-nil means `query-replace' and friends ignore read-only matches."
  :type 'boolean
  :group 'matching
65
  :version "21.4")
66

67 68 69
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

70
(defun query-replace-read-from (string regexp-flag)
71 72 73
  "Query and return the `from' argument of a query-replace operation.
The return value can also be a pair (FROM . TO) indicating that the user
wants to replace FROM with TO."
74 75
  (if query-replace-interactive
      (car (if regexp-flag regexp-search-ring search-ring))
76 77 78
    (let* ((lastfrom (car (symbol-value query-replace-from-history-variable)))
	   (lastto (car (symbol-value query-replace-to-history-variable)))
	   (from
79 80 81 82
	    ;; The save-excursion here is in case the user marks and copies
	    ;; a region in order to specify the minibuffer input.
	    ;; That should not clobber the region for the query-replace itself.
	    (save-excursion
83 84 85 86
	      (when (equal lastfrom lastto)
		;; Typically, this is because the two histlists are shared.
		(setq lastfrom (cadr (symbol-value
				      query-replace-from-history-variable))))
87
	      (read-from-minibuffer
88 89 90 91 92
	       (if (and lastto lastfrom)
		   (format "%s (default %s -> %s): " string
			   (query-replace-descr lastfrom)
			   (query-replace-descr lastto))
		 (format "%s: " string))
93 94 95
	       nil nil nil
	       query-replace-from-history-variable
	       nil t))))
96 97 98 99 100 101 102 103 104 105 106 107 108
      (if (and (zerop (length from)) lastto lastfrom)
	  (cons lastfrom lastto)
	;; Warn if user types \n or \t, but don't reject the input.
	(and regexp-flag
	     (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\[nt]\\)" from)
	     (let ((match (match-string 3 from)))
	       (cond
		((string= match "\\n")
		 (message "Note: `\\n' here doesn't match a newline; to do that, type C-q C-j instead"))
		((string= match "\\t")
		 (message "Note: `\\t' here doesn't match a tab; to do that, just type TAB")))
	       (sit-for 2)))
	from))))
109 110 111 112 113

(defun query-replace-read-to (from string regexp-flag)
  "Query and return the `from' argument of a query-replace operation."
  (let ((to (save-excursion
	      (read-from-minibuffer
114
	       (format "%s %s with: " string (query-replace-descr from))
115 116
	       nil nil nil
	       query-replace-to-history-variable from t))))
117 118 119 120 121 122 123 124 125 126 127 128 129 130
    (when (and regexp-flag
	       (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to))
      (let (pos list char)
	(while
	    (progn
	      (setq pos (match-end 0))
	      (push (substring to 0 (- pos 2)) list)
	      (setq char (aref to (1- pos))
		    to (substring to pos))
	      (cond ((eq char ?\#)
		     (push '(number-to-string replace-count) list))
		    ((eq char ?\,)
		     (setq pos (read-from-string to))
		     (push `(replace-quote ,(car pos)) list)
131 132 133 134 135 136 137
		     (let ((end
			    ;; Swallow a space after a symbol
			    ;; if there is a space.
			    (if (and (or (symbolp (car pos))
					 ;; Swallow a space after 'foo
					 ;; but not after (quote foo).
					 (and (eq (car-safe (car pos)) 'quote)
138 139 140
					      (not (= ?\( (aref to 0)))))
				     (eq (string-match " " to (cdr pos))
					 (cdr pos)))
141 142 143
				(1+ (cdr pos))
			      (cdr pos))))
		       (setq to (substring to end)))))
144 145 146
	      (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
	(setq to (nreverse (delete "" (cons to list)))))
      (replace-match-string-symbols to)
147
      (setq to (cons 'replace-eval-replacement
148 149 150
		     (if (> (length to) 1)
			 (cons 'concat to)
		       (car to)))))
151 152 153 154 155 156
    to))

(defun query-replace-read-args (string regexp-flag &optional noerror)
  (unless noerror
    (barf-if-buffer-read-only))
  (let* ((from (query-replace-read-from string regexp-flag))
157 158
	 (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
	       (query-replace-read-to from string regexp-flag))))
159
    (list from to current-prefix-arg)))
160

161
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
162 163 164 165
  "Replace some occurrences of FROM-STRING with TO-STRING.
As each match is found, the user must type a character saying
what to do with it.  For directions, type \\[help-command] at that time.

166 167 168
In Transient Mark mode, if the mark is active, operate on the contents
of the region.  Otherwise, operate from point to the end of the buffer.

169 170 171 172
If `query-replace-interactive' is non-nil, the last incremental search
string is used as FROM-STRING--you don't have to specify it with the
minibuffer.

173 174 175 176 177 178 179
Matching is independent of case if `case-fold-search' is non-nil and
FROM-STRING has no uppercase letters.  Replacement transfers the case
pattern of the old text to the new text, if `case-replace' and
`case-fold-search' are non-nil and FROM-STRING has no uppercase
letters.  \(Transferring the case pattern means that if the old text
matched is all caps, or capitalized, then its replacement is upcased
or capitalized.)
180

Richard M. Stallman's avatar
Richard M. Stallman committed
181
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
182
only matches surrounded by word boundaries.
183
Fourth and fifth arg START and END specify the region to operate on.
184 185

To customize possible responses, change the \"bindings\" in `query-replace-map'."
186 187 188 189 190 191 192 193 194 195
  (interactive (let ((common
		      (query-replace-read-args "Query replace" nil)))
		 (list (nth 0 common) (nth 1 common) (nth 2 common)
		       ;; These are done separately here
		       ;; so that command-history will record these expressions
		       ;; rather than the values they had this time.
		       (if (and transient-mark-mode mark-active)
			   (region-beginning))
		       (if (and transient-mark-mode mark-active)
			   (region-end)))))
196
  (perform-replace from-string to-string t nil delimited nil nil start end))
197

Brian Preble's avatar
Brian Preble committed
198
(define-key esc-map "%" 'query-replace)
Roland McGrath's avatar
Roland McGrath committed
199

200
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
201 202 203 204
  "Replace some things after point matching REGEXP with TO-STRING.
As each match is found, the user must type a character saying
what to do with it.  For directions, type \\[help-command] at that time.

205 206 207
In Transient Mark mode, if the mark is active, operate on the contents
of the region.  Otherwise, operate from point to the end of the buffer.

208 209 210 211
If `query-replace-interactive' is non-nil, the last incremental search
regexp is used as REGEXP--you don't have to specify it with the
minibuffer.

212 213 214 215 216 217 218
Matching is independent of case if `case-fold-search' is non-nil and
REGEXP has no uppercase letters.  Replacement transfers the case
pattern of the old text to the new text, if `case-replace' and
`case-fold-search' are non-nil and REGEXP has no uppercase letters.
\(Transferring the case pattern means that if the old text matched is
all caps, or capitalized, then its replacement is upcased or
capitalized.)
219

Richard M. Stallman's avatar
Richard M. Stallman committed
220
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
221
only matches surrounded by word boundaries.
222 223
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
224 225
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
226
whatever what matched the Nth `\\(...\\)' in REGEXP.
227 228 229
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

230 231 232 233
In interactive calls, the replacement text can contain `\\,'
followed by a Lisp expression.  Each
replacement evaluates that expression to compute the replacement
string.  Inside of that expression, `\\&' is a string denoting the
234
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
235 236 237
for the whole or a partial match converted to a number with
`string-to-number', and `\\#' itself for the number of replacements
done so far (starting with zero).
238

239 240
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
241 242 243 244

When using those Lisp features interactively in the replacement
text, TO-STRING is actually made a list instead of a string.
Use \\[repeat-complex-command] after this command for details."
245 246 247
  (interactive
   (let ((common
	  (query-replace-read-args "Query replace regexp" t)))
248 249 250 251 252 253 254 255
     (list (nth 0 common) (nth 1 common) (nth 2 common)
	   ;; These are done separately here
	   ;; so that command-history will record these expressions
	   ;; rather than the values they had this time.
	   (if (and transient-mark-mode mark-active)
	       (region-beginning))
	   (if (and transient-mark-mode mark-active)
	       (region-end)))))
256
  (perform-replace regexp to-string t t delimited nil nil start end))
257

258
(define-key esc-map [?\C-%] 'query-replace-regexp)
Roland McGrath's avatar
Roland McGrath committed
259

260
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
261 262 263 264 265 266 267 268 269 270
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
As each match is found, the user must type a character saying
what to do with it.  For directions, type \\[help-command] at that time.

TO-EXPR is a Lisp expression evaluated to compute each replacement.  It may
reference `replace-count' to get the number of replacements already made.
If the result of TO-EXPR is not a string, it is converted to one using
`prin1-to-string' with the NOESCAPE argument (which see).

For convenience, when entering TO-EXPR interactively, you can use `\\&' or
271 272
`\\0' to stand for whatever matched the whole of REGEXP, and `\\N' (where
N is a digit) to stand for whatever matched the Nth `\\(...\\)' in REGEXP.
273
Use `\\#&' or `\\#N' if you want a number instead of a string.
274
In interactive use, `\\#' in itself stands for `replace-count'.
275 276 277 278 279 280 281 282 283 284

In Transient Mark mode, if the mark is active, operate on the contents
of the region.  Otherwise, operate from point to the end of the buffer.

If `query-replace-interactive' is non-nil, the last incremental search
regexp is used as REGEXP--you don't have to specify it with the
minibuffer.

Preserves case in each replacement if `case-replace' and `case-fold-search'
are non-nil and REGEXP has no uppercase letters.
285

286
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
287
only matches that are surrounded by word boundaries.
288
Fourth and fifth arg START and END specify the region to operate on."
289
  (interactive
290 291 292 293 294 295 296
   (barf-if-buffer-read-only)
   (let* ((from
	   ;; Let-bind the history var to disable the "foo -> bar" default.
	   ;; Maybe we shouldn't disable this default, but for now I'll
	   ;; leave it off.  --Stef
	   (let ((query-replace-to-history-variable nil))
	     (query-replace-read-from "Query replace regexp" t)))
297
	  (to (list (read-from-minibuffer
298 299
		     (format "Query replace regexp %s with eval: "
			     (query-replace-descr from))
300
		     nil nil t query-replace-to-history-variable from t))))
301 302 303
     ;; We make TO a list because replace-match-string-symbols requires one,
     ;; and the user might enter a single token.
     (replace-match-string-symbols to)
304 305 306 307 308
     (list from (car to) current-prefix-arg
	   (if (and transient-mark-mode mark-active)
	       (region-beginning))
	   (if (and transient-mark-mode mark-active)
	       (region-end)))))
309
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
310
		   t 'literal delimited nil nil start end))
311

312
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
313
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
314 315 316 317 318
The second argument TO-STRINGS contains the replacement strings,
separated by spaces.  Third arg DELIMITED (prefix arg if interactive),
if non-nil, means replace only matches surrounded by word boundaries.
This command works like `query-replace-regexp' except that each
successive replacement uses the next successive replacement string,
Roland McGrath's avatar
Roland McGrath committed
319 320
wrapping around from the last such string to the first.

321 322 323
In Transient Mark mode, if the mark is active, operate on the contents
of the region.  Otherwise, operate from point to the end of the buffer.

Roland McGrath's avatar
Roland McGrath committed
324 325
Non-interactively, TO-STRINGS may be a list of replacement strings.

326 327 328
If `query-replace-interactive' is non-nil, the last incremental search
regexp is used as REGEXP--you don't have to specify it with the minibuffer.

Roland McGrath's avatar
Roland McGrath committed
329
A prefix argument N says to use each replacement string N times
330 331
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
332
  (interactive
333
   (let* ((from (if query-replace-interactive
334 335 336
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
337
					'query-replace-history nil t)))
338
	  (to (read-from-minibuffer
339
	       (format "Query replace %s with (space-separated strings): "
340
		       (query-replace-descr from))
341
	       nil nil nil
342
	       'query-replace-history from t)))
343 344 345
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
346 347 348 349
	   (if (and transient-mark-mode mark-active)
	       (region-beginning))
	   (if (and transient-mark-mode mark-active)
	       (region-end)))))
Roland McGrath's avatar
Roland McGrath committed
350 351 352 353 354 355 356 357 358 359 360 361 362
  (let (replacements)
    (if (listp to-strings)
	(setq replacements to-strings)
      (while (/= (length to-strings) 0)
	(if (string-match " " to-strings)
	    (setq replacements
		  (append replacements
			  (list (substring to-strings 0
					   (string-match " " to-strings))))
		  to-strings (substring to-strings
				       (1+ (string-match " " to-strings))))
	  (setq replacements (append replacements (list to-strings))
		to-strings ""))))
363
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
364

365
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
366 367 368
  "Replace occurrences of FROM-STRING with TO-STRING.
Preserve case in each match if `case-replace' and `case-fold-search'
are non-nil and FROM-STRING has no uppercase letters.
369 370 371
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

372 373 374
In Transient Mark mode, if the mark is active, operate on the contents
of the region.  Otherwise, operate from point to the end of the buffer.

Richard M. Stallman's avatar
Richard M. Stallman committed
375
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
376
only matches surrounded by word boundaries.
377
Fourth and fifth arg START and END specify the region to operate on.
Roland McGrath's avatar
Roland McGrath committed
378

379 380 381 382
If `query-replace-interactive' is non-nil, the last incremental search
string is used as FROM-STRING--you don't have to specify it with the
minibuffer.

Roland McGrath's avatar
Roland McGrath committed
383 384
This function is usually the wrong thing to use in a Lisp program.
What you probably want is a loop like this:
Richard M. Stallman's avatar
Richard M. Stallman committed
385 386
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
387 388 389
which will run faster and will not set the mark or print anything.
\(You may need a more complex loop if FROM-STRING can match the null string
and TO-STRING is also null.)"
390 391 392 393 394 395 396 397
  (interactive
   (let ((common
	  (query-replace-read-args "Replace string" nil)))
     (list (nth 0 common) (nth 1 common) (nth 2 common)
	   (if (and transient-mark-mode mark-active)
	       (region-beginning))
	   (if (and transient-mark-mode mark-active)
	       (region-end)))))
398
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
399

400
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
401
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
402
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
403
are non-nil and REGEXP has no uppercase letters.
404 405 406 407

In Transient Mark mode, if the mark is active, operate on the contents
of the region.  Otherwise, operate from point to the end of the buffer.

Richard M. Stallman's avatar
Richard M. Stallman committed
408
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
409
only matches surrounded by word boundaries.
410 411
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
412 413
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
whatever what matched the Nth `\\(...\\)' in REGEXP.
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

In interactive calls, the replacement text may contain `\\,'
followed by a Lisp expression used as part of the replacement
text.  Inside of that expression, `\\&' is a string denoting the
whole match, `\\N' a partial matches, `\\#&' and `\\#N' the
respective numeric values from `string-to-number', and `\\#'
itself for `replace-count', the number of replacements occured so
far.

If your Lisp expression is an identifier and the next letter in
the replacement string would be interpreted as part of it, you
can wrap it with an expression like `\\,(or \\#)'.  Incidentally,
for this particular case you may also enter `\\#' in the
replacement text directly.

When using those Lisp features interactively in the replacement
text, TO-STRING is actually made a list instead of a string.
Use \\[repeat-complex-command] after this command for details.
Roland McGrath's avatar
Roland McGrath committed
435

436 437 438
If `query-replace-interactive' is non-nil, the last incremental search
regexp is used as REGEXP--you don't have to specify it with the minibuffer.

Roland McGrath's avatar
Roland McGrath committed
439 440 441
This function is usually the wrong thing to use in a Lisp program.
What you probably want is a loop like this:
  (while (re-search-forward REGEXP nil t)
Richard M. Stallman's avatar
Richard M. Stallman committed
442
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
443
which will run faster and will not set the mark or print anything."
444 445 446 447 448 449 450 451
  (interactive
   (let ((common
	  (query-replace-read-args "Replace regexp" t)))
     (list (nth 0 common) (nth 1 common) (nth 2 common)
	   (if (and transient-mark-mode mark-active)
	       (region-beginning))
	   (if (and transient-mark-mode mark-active)
	       (region-end)))))
452
  (perform-replace regexp to-string nil t delimited nil nil start end))
453

454 455 456

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
457

458

459
(defalias 'delete-non-matching-lines 'keep-lines)
460 461 462 463 464 465 466
(defalias 'delete-matching-lines 'flush-lines)
(defalias 'count-matches 'how-many)


(defun keep-lines-read-args (prompt)
  "Read arguments for `keep-lines' and friends.
Prompt for a regexp with PROMPT.
467 468 469
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
			      'regexp-history nil t)))
470 471

(defun keep-lines (regexp &optional rstart rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
472 473
  "Delete all lines except those containing matches for REGEXP.
A match split across lines preserves all the lines it lies in.
474 475 476
Applies to all lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
477 478 479 480
the matching is case-sensitive.

Second and third arg RSTART and REND specify the region to operate on.

481 482 483 484
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
end of the buffer."

485
  (interactive
486 487 488
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
489
  (if rstart
490 491 492
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
493 494 495 496 497 498
    (if (and transient-mark-mode mark-active)
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
499 500
  (save-excursion
    (or (bolp) (forward-line 1))
501 502 503
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
504
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
505
	;; Start is first char not preserved by previous match.
506 507
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
508 509 510 511 512 513
	  (let ((end (save-excursion (goto-char (match-beginning 0))
				     (beginning-of-line)
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
514

515
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
516
	;; If the match was empty, avoid matching again at same place.
517 518
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
519 520
	     (forward-char 1))))))

521 522

(defun flush-lines (regexp &optional rstart rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
523 524
  "Delete lines containing matches for REGEXP.
If a match is split across lines, all the lines it lies in are deleted.
525 526 527
Applies to lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
528 529 530 531
the matching is case-sensitive.

Second and third arg RSTART and REND specify the region to operate on.

532 533 534 535
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
end of the buffer."

536
  (interactive
537 538 539
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
540
  (if rstart
541 542 543
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
544 545 546 547 548 549
    (if (and transient-mark-mode mark-active)
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
550 551 552
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
553 554
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
555 556 557 558
	(delete-region (save-excursion (goto-char (match-beginning 0))
				       (beginning-of-line)
				       (point))
		       (progn (forward-line 1) (point)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
559

560 561

(defun how-many (regexp &optional rstart rend)
562 563 564
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
565 566 567 568
the matching is case-sensitive.

Second and third arg RSTART and REND specify the region to operate on.

569 570 571 572
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
end of the buffer."

573 574
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
575 576 577
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
578 579 580 581 582 583
      (if (and transient-mark-mode mark-active)
	  (setq rstart (region-beginning)
		rend (copy-marker (region-end)))
	(setq rstart (point)
	      rend (point-max-marker)))
      (goto-char rstart))
584 585 586 587 588 589 590 591 592 593 594
    (let ((count 0)
	  opoint
	  (case-fold-search (and case-fold-search
				 (isearch-no-upper-case-p regexp t))))
      (while (and (< (point) rend)
		  (progn (setq opoint (point))
			 (re-search-forward regexp rend t)))
	(if (= opoint (point))
	    (forward-char 1)
	  (setq count (1+ count))))
      (message "%d occurrences" count))))
595

596

597 598 599 600 601
(defvar occur-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map [mouse-2] 'occur-mode-mouse-goto)
    (define-key map "\C-c\C-c" 'occur-mode-goto-occurrence)
    (define-key map "\C-m" 'occur-mode-goto-occurrence)
602
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
603
    (define-key map "\C-o" 'occur-mode-display-occurrence)
604 605
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
606 607
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
608
    (define-key map "g" 'revert-buffer)
609 610
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
611 612
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
613

614 615 616
(defvar occur-revert-arguments nil
  "Arguments to pass to `occur-1' to revert an Occur mode buffer.
See `occur-revert-function'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
617

618 619 620 621 622 623 624
(defcustom occur-mode-hook '(turn-on-font-lock)
  "Hook run when entering Occur mode."
  :type 'hook
  :group 'matching)

(defcustom occur-hook nil
  "Hook run when `occur' is called."
625 626 627
  :type 'hook
  :group 'matching)

628
(put 'occur-mode 'mode-class 'special)
629
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
630
  "Major mode for output from \\[occur].
631 632 633 634
\\<occur-mode-map>Move point to one of the items in this buffer, then use
\\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to.
Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it.

Richard M. Stallman's avatar
Richard M. Stallman committed
635
\\{occur-mode-map}"
636
  (interactive)
637 638 639 640
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
641
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
642
  (make-local-variable 'occur-revert-arguments)
643
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
644
  (setq next-error-function 'occur-next-error)
645
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
646

647
(defun occur-revert-function (ignore1 ignore2)
648
  "Handle `revert-buffer' for Occur mode buffers."
649
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
650

651 652 653
(defun occur-mode-mouse-goto (event)
  "In Occur mode, go to the occurrence whose line you click on."
  (interactive "e")
654
  (let (pos)
655 656 657 658
    (save-excursion
      (set-buffer (window-buffer (posn-window (event-end event))))
      (save-excursion
	(goto-char (posn-point (event-end event)))
659 660 661
	(setq pos (occur-mode-find-occurrence))))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
662 663

(defun occur-mode-find-occurrence ()
664 665
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
666
      (error "No occurrence on this line"))
667 668 669
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
670 671 672 673

(defun occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
674 675 676
  (let ((pos (occur-mode-find-occurrence)))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
677

678 679 680
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
681 682 683
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
684

685 686 687
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
688 689 690
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
691
	same-window-buffer-names
692 693
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
694 695 696
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
697
      (goto-char pos))))
698

699
(defun occur-find-match (n search message)
700 701 702
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
703 704 705 706
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
707
      (if r
708 709
          (goto-char r)
        (error message))
710 711
      (setq n (1- n)))))

712 713 714 715 716
(defun occur-next (&optional n)
  "Move to the Nth (default 1) next match in an Occur mode buffer."
  (interactive "p")
  (occur-find-match n #'next-single-property-change "No more matches"))

717
(defun occur-prev (&optional n)
718
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
719
  (interactive "p")
720
  (occur-find-match n #'previous-single-property-change "No earlier matches"))
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735

(defun occur-next-error (&optional argp reset)
  "Move to the Nth (default 1) next match in an Occur mode buffer.
Compatibility function for \\[next-error] invocations."
  (interactive "p")
  (when reset
    (occur-find-match 0 #'next-single-property-change "No first match"))
  (occur-find-match
   (prefix-numeric-value argp)
   (if (> 0 (prefix-numeric-value argp))
       #'previous-single-property-change
     #'next-single-property-change)
   "No more matches")
  (occur-mode-goto-occurrence))

736

737
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
738 739
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
740 741 742
A positive number means to include that many lines both before and after."
  :type 'integer
  :group 'matching)
Richard M. Stallman's avatar
Richard M. Stallman committed
743

744
(defalias 'list-matching-lines 'occur)
Richard M. Stallman's avatar
Richard M. Stallman committed
745

746
(defcustom list-matching-lines-face 'bold
Dave Love's avatar
Dave Love committed
747
  "*Face used by \\[list-matching-lines] to show the text that matches.
748 749 750 751 752 753 754 755 756 757
If the value is nil, don't highlight the matching portions specially."
  :type 'face
  :group 'matching)

(defcustom list-matching-lines-buffer-name-face 'underline
  "*Face used by \\[list-matching-lines] to show the names of buffers.
If the value is nil, don't highlight the buffer names specially."
  :type 'face
  :group 'matching)

758
(defun occur-accumulate-lines (count &optional no-props)
759 760 761 762 763 764 765
  (save-excursion
    (let ((forwardp (> count 0))
	  (result nil))
      (while (not (or (zerop count)
		      (if forwardp
			  (eobp)
			(bobp))))
766
	(setq count (+ count (if forwardp -1 1)))
767
	(push
768 769 770
	 (funcall (if no-props
		      #'buffer-substring-no-properties
		    #'buffer-substring)
771 772 773 774 775 776 777 778 779 780 781 782
	  (line-beginning-position)
	  (line-end-position))
	 result)
	(forward-line (if forwardp 1 -1)))
      (nreverse result))))

(defun occur-read-primary-args ()
  (list (let* ((default (car regexp-history))
	       (input
		(read-from-minibuffer
		 (if default
		     (format "List lines matching regexp (default `%s'): "
783
			     (query-replace-descr default))
784 785 786 787 788 789 790 791
		   "List lines matching regexp: ")
		 nil
		 nil
		 nil
		 'regexp-history)))
	  (if (equal input "")
	      default
	    input))
792 793
	(when current-prefix-arg
	  (prefix-numeric-value current-prefix-arg))))
794

795 796 797 798 799
(defun occur-rename-buffer (&optional unique-p)
  "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
Here `original-buffer-name' is the buffer name were occur was originally run.
When given the prefix argument, the renaming will not clobber the existing
buffer(s) of that name, but use `generate-new-buffer-name' instead.
800
You can add this to `occur-hook' if you always want a separate *Occur*
801 802 803 804 805 806 807 808 809 810
buffer for each buffer where you invoke `occur'."
  (interactive "P")
  (with-current-buffer
      (if (eq major-mode 'occur-mode) (current-buffer) (get-buffer "*Occur*"))
    (rename-buffer (concat "*Occur: "
                           (mapconcat #'buffer-name
                                      (car (cddr occur-revert-arguments)) "/")
                           "*")
                   unique-p)))

Richard M. Stallman's avatar
Richard M. Stallman committed
811
(defun occur (regexp &optional nlines)
812
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
813 814

If a match spreads across multiple lines, all those lines are shown.
Richard M. Stallman's avatar
Richard M. Stallman committed
815

Roland McGrath's avatar
Roland McGrath committed
816 817 818
Each line is displayed with NLINES lines before and after, or -NLINES
before if NLINES is negative.
NLINES defaults to `list-matching-lines-default-context-lines'.
Richard M. Stallman's avatar
Richard M. Stallman committed
819 820
Interactively it is the prefix arg.

821
The lines are shown in a buffer named `*Occur*'.
Richard M. Stallman's avatar
Richard M. Stallman committed
822
It serves as a menu to find any of the occurrences in this buffer.
823
\\<occur-mode-map>\\[describe-mode] in that buffer will explain how.
824

825 826
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
827 828 829 830 831 832 833
  (interactive (occur-read-primary-args))
  (occur-1 regexp nlines (list (current-buffer))))

(defun multi-occur (bufs regexp &optional nlines)
  "Show all lines in buffers BUFS containing a match for REGEXP.
This function acts on multiple buffers; otherwise, it is exactly like
`occur'."
834
  (interactive
835
   (cons
836 837 838 839
    (let* ((bufs (list (read-buffer "First buffer to search: "
				    (current-buffer) t)))
	   (buf nil)
	   (ido-ignore-item-temp-list bufs))
840
      (while (not (string-equal
841
		   (setq buf (read-buffer
842 843 844 845
			      (if (eq read-buffer-function 'ido-read-buffer)
				  "Next buffer to search (C-j to end): "
				"Next buffer to search (RET to end): ")
			      nil t))
846
		   ""))
847 848
	(add-to-list 'bufs buf)
	(setq ido-ignore-item-temp-list bufs))
849 850 851 852 853
      (nreverse (mapcar #'get-buffer bufs)))
    (occur-read-primary-args)))
  (occur-1 regexp nlines bufs))

(defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines)
854
  "Show all lines matching REGEXP in buffers named by BUFREGEXP.
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
See also `multi-occur'."
  (interactive
   (cons
    (let* ((default (car regexp-history))
	   (input
	    (read-from-minibuffer
	     "List lines in buffers whose filename matches regexp: "
	     nil
	     nil
	     nil
	     'regexp-history)))
      (if (equal input "")
	  default
	input))
    (occur-read-primary-args)))
  (when bufregexp
    (occur-1 regexp nlines
	     (delq nil
		   (mapcar (lambda (buf)
			     (when (and (buffer-file-name buf)
					(string-match bufregexp
						      (buffer-file-name buf)))
			       buf))
			   (buffer-list))))))

880 881 882 883
(defun occur-1 (regexp nlines bufs &optional buf-name)
  (unless buf-name
    (setq buf-name "*Occur*"))
  (let ((occur-buf (get-buffer-create buf-name))
884 885 886 887 888 889 890 891 892 893
	(made-temp-buf nil)
	(active-bufs (delq nil (mapcar #'(lambda (buf)
					   (when (buffer-live-p buf) buf))
				       bufs))))
    ;; Handle the case where one of the buffers we're searching is the
    ;; *Occur* buffer itself.
    (when (memq occur-buf bufs)
      (setq occur-buf (with-current-buffer occur-buf
			(clone-buffer "*Occur-temp*"))
	    made-temp-buf t))
894 895 896 897 898
    (with-current-buffer occur-buf
      (setq buffer-read-only nil)
      (occur-mode)
      (erase-buffer)
      (let ((count (occur-engine
899
		    regexp active-bufs occur-buf
900 901 902
		    (or nlines list-matching-lines-default-context-lines)
		    (and case-fold-search
			 (isearch-no-upper-case-p regexp t))
903 904
		    list-matching-lines-buffer-name-face
		    nil list-matching-lines-face nil)))
905 906 907 908 909 910 911 912
	(let* ((bufcount (length active-bufs))
	       (diff (- (length bufs) bufcount)))
	  (message "Searched %d buffer%s%s; %s match%s for `%s'"
		   bufcount (if (= bufcount 1) "" "s")
		   (if (zerop diff) "" (format " (%d killed)" diff))
		   (if (zerop count) "no" (format "%d" count))
		   (if (= count 1) "" "es")
		   regexp))
913 914 915
	;; If we had to make a temporary buffer, make it the *Occur*
	;; buffer now.
	(when made-temp-buf
916 917 918
	  (with-current-buffer (get-buffer buf-name)
	    (kill-buffer (current-buffer)))
	  (rename-buffer buf-name))
919 920
	(setq occur-revert-arguments (list regexp nlines bufs)
	      buffer-read-only t)
921
	(if (> count 0)
922 923 924
	    (progn
	      (display-buffer occur-buf)
	      (setq next-error-last-buffer occur-buf))
925 926
	  (kill-buffer occur-buf)))
      (run-hooks 'occur-hook))))
927

928 929 930
(defun occur-engine-add-prefix (lines)
  (mapcar
   #'(lambda (line)
931
       (concat "       :" line "\n"))
932 933 934 935 936 937
   lines))

(defun occur-engine (regexp buffers out-buf nlines case-fold-search
			    title-face prefix-face match-face keep-props)
  (with-current-buffer out-buf
    (setq buffer-read-only nil)
938 939
    (let ((globalcount 0)
	  (coding nil))
940 941 942 943 944 945 946 947 948 949 950 951 952 953
      ;; Map over all the buffers
      (dolist (buf buffers)
	(when (buffer-live-p buf)
	  (let ((matches 0)	;; count of matched lines
		(lines 1)	;; line count
		(matchbeg 0)
		(origpt nil)
		(begpt nil)
		(endpt nil)
		(marker nil)
		(curstring "")
		(headerpt (with-current-buffer out-buf (point))))
	    (save-excursion
	      (set-buffer buf)
954 955 956 957 958
	      (or coding
		  ;; Set CODING only if the current buffer locally
		  ;; binds buffer-file-coding-system.
		  (not (local-variable-p 'buffer-file-coding-system))
		  (setq coding buffer-file-coding-system))
959
	      (save-excursion
960 961 962 963 964
		(goto-char (point-min)) ;; begin searching in the buffer
		(while (not (eobp))
		  (setq origpt (point))
		  (when (setq endpt (re-search-forward regexp nil t))
		    (setq matches (1+ matches)) ;; increment match count
965
		    (setq matchbeg (match-beginning 0))
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
		    (setq begpt (save-excursion
				  (goto-char matchbeg)
				  (line-beginning-position)))
		    (setq lines (+ lines (1- (count-lines origpt endpt))))
		    (setq marker (make-marker))
		    (set-marker marker matchbeg)
		    (setq curstring (buffer-substring begpt
						      (line-end-position)))
		    ;; Depropertize the string, and maybe
		    ;; highlight the matches
		    (let ((len (length curstring))
			  (start 0))
		      (unless keep-props
			(set-text-properties 0 len nil curstring))
		      (while (and (< start len)
				  (string-match regexp curstring start))
			(add-text-properties (match-beginning 0)
					     (match-end 0)
					     (append
985
					      `(occur-match t)
986
					      (when match-face