replace.el 54.8 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
That becomes the \"string to replace\"."
  :type 'boolean
  :group 'matching)
44

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

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

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

69 70 71
(defun query-replace-read-args (string regexp-flag &optional noerror)
  (unless noerror
    (barf-if-buffer-read-only))
72
  (let (from to)
73 74
    (if query-replace-interactive
	(setq from (car (if regexp-flag regexp-search-ring search-ring)))
75 76 77 78 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
	(setq from (read-from-minibuffer (format "%s: " string)
					 nil nil nil
					 query-replace-from-history-variable
					 nil t)))
83
      ;; Warn if user types \n or \t, but don't reject the input.
84 85 86 87 88 89 90 91 92
      (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))))
93

94 95 96 97
    (save-excursion
      (setq to (read-from-minibuffer (format "%s %s with: " string from)
				     nil nil nil
				     query-replace-to-history-variable from t)))
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
    (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)
		     (setq to (substring to (cdr pos)))))
	      (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
	(setq to (nreverse (delete "" (cons to list)))))
      (replace-match-string-symbols to)
      (setq to (cons 'replace-eval-replacement 
		     (if (> (length to) 1)
			 (cons 'concat to)
		       (car to)))))
120
    (list from to current-prefix-arg)))
121

122
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
123 124 125 126
  "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.

127 128 129
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.

130 131 132 133
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.

134 135 136 137 138 139 140
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.)
141

Richard M. Stallman's avatar
Richard M. Stallman committed
142
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
143
only matches surrounded by word boundaries.
144
Fourth and fifth arg START and END specify the region to operate on.
145 146

To customize possible responses, change the \"bindings\" in `query-replace-map'."
147 148 149 150 151 152 153 154 155 156
  (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)))))
157
  (perform-replace from-string to-string t nil delimited nil nil start end))
158

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

161
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
162 163 164 165
  "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.

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
regexp is used as REGEXP--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
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.)
180

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

Richard M. Stallman's avatar
Richard M. Stallman committed
185 186
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
187
whatever what matched the Nth `\\(...\\)' in REGEXP.
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
`\\?' 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."
208 209 210
  (interactive
   (let ((common
	  (query-replace-read-args "Query replace regexp" t)))
211 212 213 214 215 216 217 218 219
     (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)))))

220
  (perform-replace regexp to-string t t delimited nil nil start end))
221

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

224
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
225 226 227 228 229 230 231 232 233 234
  "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
235 236
`\\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.
237
Use `\\#&' or `\\#N' if you want a number instead of a string.
238
In interactive use, `\\#' in itself stands for `replace-count'.
239 240 241 242 243 244 245 246 247 248

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

250
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
251
only matches that are surrounded by word boundaries.
252
Fourth and fifth arg START and END specify the region to operate on."
253
  (interactive
254
   (let (from to)
255 256 257 258 259 260 261 262 263 264 265 266
     (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)
267 268 269 270 271
     (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)))))
272
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
273
		   t 'literal delimited nil nil start end))
274

275
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
276
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
277 278 279 280 281
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
282 283
wrapping around from the last such string to the first.

284 285 286
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
287 288
Non-interactively, TO-STRINGS may be a list of replacement strings.

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

329
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
330 331 332
  "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.
333 334 335
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

343 344 345 346
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
347 348
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
349 350
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
351 352 353
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.)"
354 355 356 357 358 359 360 361
  (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)))))
362
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
363

364
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
365
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
366
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
367
are non-nil and REGEXP has no uppercase letters.
368 369 370 371

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

Richard M. Stallman's avatar
Richard M. Stallman committed
376 377
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
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
399

400 401 402
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
403 404 405
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
406
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
407
which will run faster and will not set the mark or print anything."
408 409 410 411 412 413 414 415
  (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)))))
416
  (perform-replace regexp to-string nil t delimited nil nil start end))
417

418 419 420

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
421

422

423
(defalias 'delete-non-matching-lines 'keep-lines)
424 425 426 427 428 429 430
(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.
431 432 433
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
			      'regexp-history nil t)))
434 435

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
441 442 443 444
the matching is case-sensitive.

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

445 446 447 448
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."

449
  (interactive
450 451 452
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
453
  (if rstart
454 455 456
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
457 458 459 460 461 462
    (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
463 464
  (save-excursion
    (or (bolp) (forward-line 1))
465 466 467
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
468
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
469
	;; Start is first char not preserved by previous match.
470 471
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
472 473 474 475 476 477
	  (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))))
478

479
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
480
	;; If the match was empty, avoid matching again at same place.
481 482
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
483 484
	     (forward-char 1))))))

485 486

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
492 493 494 495
the matching is case-sensitive.

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

496 497 498 499
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."

500
  (interactive
501 502 503
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
504
  (if rstart
505 506 507
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
508 509 510 511 512 513
    (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))
514 515 516
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
517 518
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
519 520 521 522
	(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
523

524 525

(defun how-many (regexp &optional rstart rend)
526 527 528
  "Print number of matches for REGEXP following point.

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

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

533 534 535 536
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."

537 538
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
539 540 541
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
542 543 544 545 546 547
      (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))
548 549 550 551 552 553 554 555 556 557 558
    (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))))
559

560

561 562 563 564 565
(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)
566
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
567
    (define-key map "\C-o" 'occur-mode-display-occurrence)
568 569
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
570 571
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
572
    (define-key map "g" 'revert-buffer)
573 574
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
575 576
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
577

578 579 580
(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
581

582 583 584 585 586 587 588
(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."
589 590 591
  :type 'hook
  :group 'matching)

592
(put 'occur-mode 'mode-class 'special)
593
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
594
  "Major mode for output from \\[occur].
595 596 597 598
\\<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
599
\\{occur-mode-map}"
600
  (interactive)
601 602 603 604
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
605
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
606
  (make-local-variable 'occur-revert-arguments)
607
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
608
  (setq next-error-function 'occur-next-error)
609
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
610

611
(defun occur-revert-function (ignore1 ignore2)
612
  "Handle `revert-buffer' for Occur mode buffers."
613
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
614

615 616 617
(defun occur-mode-mouse-goto (event)
  "In Occur mode, go to the occurrence whose line you click on."
  (interactive "e")
618
  (let (pos)
619 620 621 622
    (save-excursion
      (set-buffer (window-buffer (posn-window (event-end event))))
      (save-excursion
	(goto-char (posn-point (event-end event)))
623 624 625
	(setq pos (occur-mode-find-occurrence))))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
626 627

(defun occur-mode-find-occurrence ()
628 629
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
630
      (error "No occurrence on this line"))
631 632 633
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
634 635 636 637

(defun occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
638 639 640
  (let ((pos (occur-mode-find-occurrence)))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
641

642 643 644
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
645 646 647
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
648

649 650 651
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
652 653 654
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
655
	same-window-buffer-names
656 657
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
658 659 660
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
661
      (goto-char pos))))
662

663
(defun occur-find-match (n search message)
664 665 666
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
667 668 669 670
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
671
      (if r
672 673
          (goto-char r)
        (error message))
674 675
      (setq n (1- n)))))

676 677 678 679 680
(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"))

681
(defun occur-prev (&optional n)
682
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
683
  (interactive "p")
684
  (occur-find-match n #'previous-single-property-change "No earlier matches"))
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699

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

700

701
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
702 703
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
704 705 706
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
707

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

710
(defcustom list-matching-lines-face 'bold
Dave Love's avatar
Dave Love committed
711
  "*Face used by \\[list-matching-lines] to show the text that matches.
712 713 714 715 716 717 718 719 720 721
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)

722
(defun occur-accumulate-lines (count &optional no-props)
723 724 725 726 727 728 729
  (save-excursion
    (let ((forwardp (> count 0))
	  (result nil))
      (while (not (or (zerop count)
		      (if forwardp
			  (eobp)
			(bobp))))
730
	(setq count (+ count (if forwardp -1 1)))
731
	(push
732 733 734
	 (funcall (if no-props
		      #'buffer-substring-no-properties
		    #'buffer-substring)
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
	  (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))
756 757
	(when current-prefix-arg
	  (prefix-numeric-value current-prefix-arg))))
758

759 760 761 762 763
(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.
764
You can add this to `occur-hook' if you always want a separate *Occur*
765 766 767 768 769 770 771 772 773 774
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
775
(defun occur (regexp &optional nlines)
776
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
777 778

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

Roland McGrath's avatar
Roland McGrath committed
780 781 782
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
783 784
Interactively it is the prefix arg.

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

789 790
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
791 792 793 794 795 796 797
  (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'."
798
  (interactive
799
   (cons
800 801 802 803
    (let* ((bufs (list (read-buffer "First buffer to search: "
				    (current-buffer) t)))
	   (buf nil)
	   (ido-ignore-item-temp-list bufs))
804
      (while (not (string-equal
805
		   (setq buf (read-buffer
806 807 808 809
			      (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))
810
		   ""))
811 812
	(add-to-list 'bufs buf)
	(setq ido-ignore-item-temp-list bufs))
813 814 815 816 817
      (nreverse (mapcar #'get-buffer bufs)))
    (occur-read-primary-args)))
  (occur-1 regexp nlines bufs))

(defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines)
818
  "Show all lines matching REGEXP in buffers named by BUFREGEXP.
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
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))))))

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

892 893 894
(defun occur-engine-add-prefix (lines)
  (mapcar
   #'(lambda (line)
895
       (concat "       :" line "\n"))
896 897 898 899 900 901
   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)
902 903
    (let ((globalcount 0)
	  (coding nil))
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
      ;; 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)
919 920 921 922 923
	      (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))
924
	      (save-excursion
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
		(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
951
					      `(occur-match t)
952
					      (when match-face
953
						`(font-lock-face ,match-face)))
954 955 956 957 958
					     curstring)
			(setq start (match-end 0))))
		    ;; Generate the string to insert for this match
		    (let* ((out-line
			    (concat
959 960
			     ;; Using 7 digits aligns tabs properly.
			     (apply #'propertize (format "%7d:" lines)
961 962
				    (append
				     (when prefix-face
963
				       `(font-lock-face prefix-face))
964 965 966 967 968 969 970 971 972 973 974 975
				     '(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
976
				      (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ nlines)) keep-props))))
977
				      (list out-line)
978
				      (occur-engine-add-prefix (cdr (occur-accumulate-lines (1+ nlines) keep-props))))))))
979 980 981 982 983 984 985
		      ;; 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
986 987 988 989 990
			   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)))))
991
		    (goto-char endpt))
992 993 994 995 996 997
		  (if endpt
		      (progn
			(setq lines (1+ lines))
			;; On to the next match...
			(forward-line 1))
		    (goto-char (point-max))))))
998
	    (when (not (zerop matches)) ;; is the count zero?
999
	      (setq globalcount (+ globalcount matches))
1000 1001 1002 1003
	      (with-current-buffer out-buf
		(goto-char headerpt)
		(let ((beg (point))
		      end)
1004 1005 1006
		  (insert (format "%d match%s for \"%s\" in buffer: %s\n"
				  matches (if (= matches 1) "" "es")
				  regexp (buffer-name buf)))
1007 1008 1009 1010
		  (setq end (point))
		  (add-text-properties beg end
				       (append
					(when title-face
1011 1012
					  `(font-lock-face ,title-face))
					`(occur-title ,buf))))
1013
		(goto-char (point-min)))))))
1014 1015 1016 1017 1018
      (if coding
	  ;; CODING is buffer-file-coding-system of the first buffer
	  ;; that locally binds it.  Let's use it also for the output
	  ;; buffer.
	  (set-buffer-file-coding-system coding))