replace.el 55.6 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, 86, 87, 92, 94, 96, 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
(defcustom query-replace-interactive nil
40
  "Non-nil means `query-replace' uses the last search string.
41 42 43 44 45 46
That becomes the \"string to replace\".
If value is `initial', the last search string is inserted into
the minibuffer as an initial value for \"string to replace\"."
  :type '(choice (const :tag "Off" nil)
                 (const :tag "Initial content" initial)
                 (other :tag "Use default value" t))
47
  :group 'matching)
48

49
(defcustom query-replace-from-history-variable 'query-replace-history
50
  "History list to use for the FROM argument of `query-replace' commands.
51 52 53 54
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
55 56
  :type 'symbol
  :version "20.3")
57 58

(defcustom query-replace-to-history-variable 'query-replace-history
59
  "History list to use for the TO argument of `query-replace' commands.
60 61 62 63
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
64 65
  :type 'symbol
  :version "20.3")
66

67 68 69 70
(defcustom query-replace-skip-read-only nil
  "*Non-nil means `query-replace' and friends ignore read-only matches."
  :type 'boolean
  :group 'matching
71
  :version "21.4")
72

73 74 75
(defun query-replace-read-args (string regexp-flag &optional noerror)
  (unless noerror
    (barf-if-buffer-read-only))
76
  (let (from to)
77 78 79
    (if (and query-replace-interactive
             (not (eq query-replace-interactive 'initial)))
        (setq from (car (if regexp-flag regexp-search-ring search-ring)))
80 81 82 83
      ;; 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
84 85 86 87 88 89 90
        (setq from (read-from-minibuffer
                    (format "%s: " string)
                    (if (eq query-replace-interactive 'initial)
                        (car (if regexp-flag regexp-search-ring search-ring)))
                    nil nil
                    query-replace-from-history-variable
                    nil t)))
91
      ;; Warn if user types \n or \t, but don't reject the input.
92 93 94 95 96 97 98 99 100
      (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))))
101

102
    (save-excursion
103 104 105 106
      (setq to (read-from-minibuffer
                (format "%s %s with: " string from)
                nil nil nil
                query-replace-to-history-variable from t)))
107 108 109 110 111 112 113 114 115 116 117 118 119 120
    (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)
121 122 123 124 125 126 127 128
		     (setq to (substring
			       to (+ (cdr pos)
				     ;; Swallow a space after a symbol
				     ;; if there is a space.
				     (if (string-match
                                          "^[^])\"] "
                                          (substring to (1- (cdr pos))))
					 1 0))))))
129 130 131
	      (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
	(setq to (nreverse (delete "" (cons to list)))))
      (replace-match-string-symbols to)
132
      (setq to (cons 'replace-eval-replacement
133 134 135
		     (if (> (length to) 1)
			 (cons 'concat to)
		       (car to)))))
136
    (list from to current-prefix-arg)))
137

138
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
139 140 141 142
  "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.

143 144 145
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.

146 147 148 149
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.

150 151 152 153 154 155 156
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.)
157

Richard M. Stallman's avatar
Richard M. Stallman committed
158
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
159
only matches surrounded by word boundaries.
160
Fourth and fifth arg START and END specify the region to operate on.
161 162

To customize possible responses, change the \"bindings\" in `query-replace-map'."
163 164 165 166 167 168 169 170 171 172
  (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)))))
173
  (perform-replace from-string to-string t nil delimited nil nil start end))
174

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

177
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
178 179 180 181
  "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.

182 183 184
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.

185 186 187 188
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.

189 190 191 192 193 194 195
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.)
196

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

Richard M. Stallman's avatar
Richard M. Stallman committed
201 202
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
203
whatever what matched the Nth `\\(...\\)' in REGEXP.
204 205 206
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

207 208 209 210 211 212 213 214
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
whole match as a sting, `\\N' for a partial match, `\\#&' and `\\#N'
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).
215

216 217
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
218 219 220 221

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."
222 223 224
  (interactive
   (let ((common
	  (query-replace-read-args "Query replace regexp" t)))
225 226 227 228 229 230 231 232
     (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)))))
233
  (perform-replace regexp to-string t t delimited nil nil start end))
234

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

237
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
238 239 240 241 242 243 244 245 246 247
  "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
248 249
`\\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.
250
Use `\\#&' or `\\#N' if you want a number instead of a string.
251
In interactive use, `\\#' in itself stands for `replace-count'.
252 253 254 255 256 257 258 259 260 261

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.
262

263
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
264
only matches that are surrounded by word boundaries.
265
Fourth and fifth arg START and END specify the region to operate on."
266
  (interactive
267
   (let (from to)
268 269 270 271 272 273 274 275 276 277 278 279
     (if query-replace-interactive
         (setq from (car regexp-search-ring))
       (setq from (read-from-minibuffer "Query replace regexp: "
                                        nil nil nil
                                        query-replace-from-history-variable
                                        nil t)))
     (setq to (list (read-from-minibuffer
                     (format "Query replace regexp %s with eval: " from)
                     nil nil t query-replace-to-history-variable from t)))
     ;; 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)
280 281 282 283 284
     (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)))))
285
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
286
		   t 'literal delimited nil nil start end))
287

288
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
289
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
290 291 292 293 294
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
295 296
wrapping around from the last such string to the first.

297 298 299
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
300 301
Non-interactively, TO-STRINGS may be a list of replacement strings.

302 303 304
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
305
A prefix argument N says to use each replacement string N times
306 307
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
308
  (interactive
309
   (let (from to)
310 311 312 313
     (setq from (if query-replace-interactive
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
314
					'query-replace-history nil t)))
315 316 317 318
     (setq to (read-from-minibuffer
	       (format "Query replace %s with (space-separated strings): "
		       from)
	       nil nil nil
319
	       'query-replace-history from t))
320 321 322
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
323 324 325 326
	   (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
327 328 329 330 331 332 333 334 335 336 337 338 339
  (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 ""))))
340
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
341

342
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
343 344 345
  "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.
346 347 348
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

349 350 351
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
352
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
353
only matches surrounded by word boundaries.
354
Fourth and fifth arg START and END specify the region to operate on.
Roland McGrath's avatar
Roland McGrath committed
355

356 357 358 359
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
360 361
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
362 363
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
364 365 366
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.)"
367 368 369 370 371 372 373 374
  (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)))))
375
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
376

377
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
378
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
379
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
380
are non-nil and REGEXP has no uppercase letters.
381 382 383 384

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
385
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
386
only matches surrounded by word boundaries.
387 388
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
389 390
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
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
412

413 414 415
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
416 417 418
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
419
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
420
which will run faster and will not set the mark or print anything."
421 422 423 424 425 426 427 428
  (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)))))
429
  (perform-replace regexp to-string nil t delimited nil nil start end))
430

431 432 433

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
434

435

436
(defalias 'delete-non-matching-lines 'keep-lines)
437 438 439 440 441 442 443
(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.
444 445 446
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
			      'regexp-history nil t)))
447 448

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
454 455 456 457
the matching is case-sensitive.

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

458 459 460 461
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."

462
  (interactive
463 464 465
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
466
  (if rstart
467 468 469
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
470 471 472 473 474 475
    (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
476 477
  (save-excursion
    (or (bolp) (forward-line 1))
478 479 480
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
481
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
482
	;; Start is first char not preserved by previous match.
483 484
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
485 486 487 488 489 490
	  (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))))
491

492
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
493
	;; If the match was empty, avoid matching again at same place.
494 495
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
496 497
	     (forward-char 1))))))

498 499

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
505 506 507 508
the matching is case-sensitive.

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

509 510 511 512
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."

513
  (interactive
514 515 516
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
517
  (if rstart
518 519 520
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
521 522 523 524 525 526
    (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))
527 528 529
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
530 531
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
532 533 534 535
	(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
536

537 538

(defun how-many (regexp &optional rstart rend)
539 540 541
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
542 543 544 545
the matching is case-sensitive.

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

546 547 548 549
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."

550 551
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
552 553 554
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
555 556 557 558 559 560
      (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))
561 562 563 564 565 566 567 568 569 570 571
    (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))))
572

573

574 575 576 577 578
(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)
579
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
580
    (define-key map "\C-o" 'occur-mode-display-occurrence)
581 582
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
583 584
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
585
    (define-key map "g" 'revert-buffer)
586 587
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
588 589
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
590

591 592 593
(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
594

595 596 597 598 599 600 601
(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."
602 603 604
  :type 'hook
  :group 'matching)

605
(put 'occur-mode 'mode-class 'special)
606
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
607
  "Major mode for output from \\[occur].
608 609 610 611
\\<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
612
\\{occur-mode-map}"
613
  (interactive)
614 615 616 617
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
618
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
619
  (make-local-variable 'occur-revert-arguments)
620
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
621
  (setq next-error-function 'occur-next-error)
622
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
623

624
(defun occur-revert-function (ignore1 ignore2)
625
  "Handle `revert-buffer' for Occur mode buffers."
626
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
627

628 629 630
(defun occur-mode-mouse-goto (event)
  "In Occur mode, go to the occurrence whose line you click on."
  (interactive "e")
631
  (let (pos)
632 633 634 635
    (save-excursion
      (set-buffer (window-buffer (posn-window (event-end event))))
      (save-excursion
	(goto-char (posn-point (event-end event)))
636 637 638
	(setq pos (occur-mode-find-occurrence))))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
639 640

(defun occur-mode-find-occurrence ()
641 642
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
643
      (error "No occurrence on this line"))
644 645 646
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
647 648 649 650

(defun occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
651 652 653
  (let ((pos (occur-mode-find-occurrence)))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
654

655 656 657
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
658 659 660
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
661

662 663 664
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
665 666 667
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
668
	same-window-buffer-names
669 670
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
671 672 673
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
674
      (goto-char pos))))
675

676
(defun occur-find-match (n search message)
677 678 679
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
680 681 682 683
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
684
      (if r
685 686
          (goto-char r)
        (error message))
687 688
      (setq n (1- n)))))

689 690 691 692 693
(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"))

694
(defun occur-prev (&optional n)
695
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
696
  (interactive "p")
697
  (occur-find-match n #'previous-single-property-change "No earlier matches"))
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712

(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))

713

714
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
715 716
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
717 718 719
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
720

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

723
(defcustom list-matching-lines-face 'bold
Dave Love's avatar
Dave Love committed
724
  "*Face used by \\[list-matching-lines] to show the text that matches.
725 726 727 728 729 730 731 732 733 734
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)

735
(defun occur-accumulate-lines (count &optional no-props)
736 737 738 739 740 741 742
  (save-excursion
    (let ((forwardp (> count 0))
	  (result nil))
      (while (not (or (zerop count)
		      (if forwardp
			  (eobp)
			(bobp))))
743
	(setq count (+ count (if forwardp -1 1)))
744
	(push
745 746 747
	 (funcall (if no-props
		      #'buffer-substring-no-properties
		    #'buffer-substring)
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
	  (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'): "
			     default)
		   "List lines matching regexp: ")
		 nil
		 nil
		 nil
		 'regexp-history)))
	  (if (equal input "")
	      default
	    input))
769 770
	(when current-prefix-arg
	  (prefix-numeric-value current-prefix-arg))))
771

772 773 774 775 776
(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.
777
You can add this to `occur-hook' if you always want a separate *Occur*
778 779 780 781 782 783 784 785 786 787
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
788
(defun occur (regexp &optional nlines)
789
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
790 791

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

Roland McGrath's avatar
Roland McGrath committed
793 794 795
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
796 797
Interactively it is the prefix arg.

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

802 803
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
804 805 806 807 808 809 810
  (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'."
811
  (interactive
812
   (cons
813 814 815 816
    (let* ((bufs (list (read-buffer "First buffer to search: "
				    (current-buffer) t)))
	   (buf nil)
	   (ido-ignore-item-temp-list bufs))
817
      (while (not (string-equal
818
		   (setq buf (read-buffer
819 820 821 822
			      (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))
823
		   ""))
824 825
	(add-to-list 'bufs buf)
	(setq ido-ignore-item-temp-list bufs))
826 827 828 829 830
      (nreverse (mapcar #'get-buffer bufs)))
    (occur-read-primary-args)))
  (occur-1 regexp nlines bufs))

(defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines)
831
  "Show all lines matching REGEXP in buffers named by BUFREGEXP.
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
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))))))

857 858 859 860
(defun occur-1 (regexp nlines bufs &optional buf-name)
  (unless buf-name
    (setq buf-name "*Occur*"))
  (let ((occur-buf (get-buffer-create buf-name))
861 862 863 864 865 866 867 868 869 870
	(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))
871 872 873 874 875
    (with-current-buffer occur-buf
      (setq buffer-read-only nil)
      (occur-mode)
      (erase-buffer)
      (let ((count (occur-engine
876
		    regexp active-bufs occur-buf
877 878 879
		    (or nlines list-matching-lines-default-context-lines)
		    (and case-fold-search
			 (isearch-no-upper-case-p regexp t))
880 881
		    list-matching-lines-buffer-name-face
		    nil list-matching-lines-face nil)))
882 883 884 885 886 887 888 889
	(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))
890 891 892
	;; If we had to make a temporary buffer, make it the *Occur*
	;; buffer now.
	(when made-temp-buf
893 894 895
	  (with-current-buffer (get-buffer buf-name)
	    (kill-buffer (current-buffer)))
	  (rename-buffer buf-name))
896 897
	(setq occur-revert-arguments (list regexp nlines bufs)
	      buffer-read-only t)
898
	(if (> count 0)
899 900 901
	    (progn
	      (display-buffer occur-buf)
	      (setq next-error-last-buffer occur-buf))
902 903
	  (kill-buffer occur-buf)))
      (run-hooks 'occur-hook))))
904

905 906 907
(defun occur-engine-add-prefix (lines)
  (mapcar
   #'(lambda (line)
908
       (concat "       :" line "\n"))
909 910 911 912 913 914
   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)
915 916
    (let ((globalcount 0)
	  (coding nil))
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
      ;; 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)
		(matchend 0)
		(origpt nil)
		(begpt nil)
		(endpt nil)
		(marker nil)
		(curstring "")
		(headerpt (with-current-buffer out-buf (point))))
	    (save-excursion
	      (set-buffer buf)
932 933 934 935 936
	      (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))
937
	      (save-excursion
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
		(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
		    (setq matchbeg (match-beginning 0)
			  matchend (match-end 0))
		    (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
964
					      `(occur-match t)
965
					      (when match-face
966
						`(font-lock-face ,match-face)))
967 968 969 970 971
					     curstring)
			(setq start (match-end 0))))
		    ;; Generate the string to insert for this match
		    (let* ((out-line
			    (concat
972 973
			     ;; Using 7 digits aligns tabs properly.
			     (apply #'propertize (format "%7d:" lines)
974 975
				    (append
				     (when prefix-face
976
				       `(font-lock-face prefix-face))
977 978 979 980 981 982 983 984 985 986 987 988
				     '(occur-prefix t)))
			     curstring
			     "\n"))
			   (data
			    (if (= nlines 0)
				;; The simple display style
				out-line
			      ;; The complex multi-line display
			      ;; style.  Generate a list of lines,
			      ;; concatenate them all together.
			      (apply #'concat
				     (nconc
989
				      (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ nlines)) keep-props))))
990
				      (list out-line)
991
				      (occur-engine-add-prefix (cdr (occur-accumulate-lines (1+ nlines) keep-props))))))))
992 993 994 995 996 997 998
		      ;; Actually insert the match display data
		      (with-current-buffer out-buf
			(let ((beg (point))
			      (end (progn (insert data) (point))))
			  (unless (= nlines 0)
			    (insert "-------\n"))
			  (add-text-properties
999 1000 1001 1002 1003
			   beg end
			   `(occur-target ,marker help-echo "mouse-2: go to this occurrence"))
			  ;; We don't put `mouse-face' on the newline,
			  ;; because that loses.
			  (add-text-properties beg (1- end) '(mouse-face highlight)))))
1004
		    (goto-char endpt))
1005 1006 1007 1008 1009 1010
		  (if endpt
		      (progn
			(setq lines (1+ lines))
			;; On to the next match...