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

3
;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1996, 1997, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2002, 2003, 2004, 2005, 2006, 2007 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
12
;; the Free Software Foundation; either version 3, 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
22 23
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, 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 40 41 42 43
(defvar query-replace-defaults nil
  "Default values of FROM-STRING and TO-STRING for `query-replace'.
This is a cons cell (FROM-STRING . TO-STRING), or nil if there is
no default value.")

44
(defvar query-replace-interactive nil
45
  "Non-nil means `query-replace' uses the last search string.
46
That becomes the \"string to replace\".")
47

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

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

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

72 73 74 75 76 77 78 79 80 81 82 83 84
(defcustom query-replace-highlight t
  "*Non-nil means to highlight matches during query replacement."
  :type 'boolean
  :group 'matching)

(defcustom query-replace-lazy-highlight t
  "*Controls the lazy-highlighting during query replacements.
When non-nil, all text in the buffer matching the current match
is highlighted lazily using isearch lazy highlighting (see
`lazy-highlight-initial-delay' and `lazy-highlight-interval')."
  :type 'boolean
  :group 'lazy-highlight
  :group 'matching
85
  :version "22.1")
86 87 88 89 90

(defface query-replace
  '((t (:inherit isearch)))
  "Face for highlighting query replacement matches."
  :group 'matching
91
  :version "22.1")
92

93 94 95
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

96
(defun query-replace-read-from (prompt regexp-flag)
97 98 99
  "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."
100 101
  (if query-replace-interactive
      (car (if regexp-flag regexp-search-ring search-ring))
102 103
    (let* ((history-add-new-input nil)
	   (from
104 105 106 107 108
	    ;; 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
	      (read-from-minibuffer
109
	       (if query-replace-defaults
110
		   (format "%s (default %s -> %s): " prompt
111 112
			   (query-replace-descr (car query-replace-defaults))
			   (query-replace-descr (cdr query-replace-defaults)))
113
		 (format "%s: " prompt))
114 115
	       nil nil nil
	       query-replace-from-history-variable
116
	       nil t))))
117
      (if (and (zerop (length from)) query-replace-defaults)
Chong Yidong's avatar
Chong Yidong committed
118 119 120
	  (cons (car query-replace-defaults)
		(query-replace-compile-replacement
		 (cdr query-replace-defaults) regexp-flag))
121
	(add-to-history query-replace-from-history-variable from nil t)
122 123 124 125 126 127 128 129 130 131 132
	;; 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))))
133

David Kastrup's avatar
David Kastrup committed
134 135 136 137 138 139
(defun query-replace-compile-replacement (to regexp-flag)
  "Maybe convert a regexp replacement TO to Lisp.
Returns a list suitable for `perform-replace' if necessary,
the original string if not."
  (if (and regexp-flag
	   (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to))
140 141 142 143 144 145 146 147 148 149 150 151
      (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)
152 153 154 155 156 157 158
		     (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)
159 160 161
					      (not (= ?\( (aref to 0)))))
				     (eq (string-match " " to (cdr pos))
					 (cdr pos)))
162 163 164
				(1+ (cdr pos))
			      (cdr pos))))
		       (setq to (substring to end)))))
165
	      (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
David Kastrup's avatar
David Kastrup committed
166 167 168 169 170 171
	(setq to (nreverse (delete "" (cons to list))))
	(replace-match-string-symbols to)
	(cons 'replace-eval-replacement
	      (if (cdr to)
		  (cons 'concat to)
		(car to))))
172 173
    to))

David Kastrup's avatar
David Kastrup committed
174

175
(defun query-replace-read-to (from prompt regexp-flag)
David Kastrup's avatar
David Kastrup committed
176 177 178
  "Query and return the `to' argument of a query-replace operation."
  (query-replace-compile-replacement
   (save-excursion
179 180 181 182 183 184
     (let* ((history-add-new-input nil)
	    (to (read-from-minibuffer
		 (format "%s %s with: " prompt (query-replace-descr from))
		 nil nil nil
		 query-replace-to-history-variable from t)))
       (add-to-history query-replace-to-history-variable to nil t)
185 186
       (setq query-replace-defaults (cons from to))
       to))
David Kastrup's avatar
David Kastrup committed
187 188
   regexp-flag))

189
(defun query-replace-read-args (prompt regexp-flag &optional noerror)
190 191
  (unless noerror
    (barf-if-buffer-read-only))
192
  (let* ((from (query-replace-read-from prompt regexp-flag))
193
	 (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
194
	       (query-replace-read-to from prompt regexp-flag))))
195
    (list from to current-prefix-arg)))
196

197
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
198 199 200 201
  "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.

202 203 204
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.

205 206 207 208
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.

209 210 211 212 213 214 215
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.)
216

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

To customize possible responses, change the \"bindings\" in `query-replace-map'."
222
  (interactive (let ((common
223
		      (query-replace-read-args
224 225 226 227
		       (if (and transient-mark-mode mark-active)
			 "Query replace in region"
			 "Query replace")
			 nil)))
228 229 230 231 232 233 234 235
		 (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)))))
236
  (perform-replace from-string to-string t nil delimited nil nil start end))
237

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

240
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
241 242 243 244
  "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.

245 246 247
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.

248 249 250 251
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.

252 253 254 255 256 257 258
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.)
259

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

Richard M. Stallman's avatar
Richard M. Stallman committed
264 265
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
266
whatever what matched the Nth `\\(...\\)' in REGEXP.
267 268 269
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

270 271 272 273
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
274
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
275 276 277
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).
278

279 280
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
281 282 283 284

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."
285 286
  (interactive
   (let ((common
287
	  (query-replace-read-args
288 289 290 291
	   (if (and transient-mark-mode mark-active)
	       "Query replace regexp in region"
	     "Query replace regexp")
	   t)))
292 293 294 295 296 297 298 299
     (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)))))
300
  (perform-replace regexp to-string t t delimited nil nil start end))
301

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

304
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
305
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
306 307 308 309 310

Interactive use of this function is deprecated in favor of the
`\\,' feature of `query-replace-regexp'.  For non-interactive use, a loop
using `search-forward-regexp' and `replace-match' is preferred.

311 312 313 314 315 316 317 318 319
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
320 321
`\\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.
322
Use `\\#&' or `\\#N' if you want a number instead of a string.
323
In interactive use, `\\#' in itself stands for `replace-count'.
324 325 326 327 328 329 330 331 332 333

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

335
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
336
only matches that are surrounded by word boundaries.
337
Fourth and fifth arg START and END specify the region to operate on."
338
  (interactive
339
   (progn
340 341 342 343 344 345 346
   (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)))
347
	  (to (list (read-from-minibuffer
348 349
		     (format "Query replace regexp %s with eval: "
			     (query-replace-descr from))
350
		     nil nil t query-replace-to-history-variable from t))))
351 352 353
     ;; 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)
354 355 356 357
     (list from (car to) current-prefix-arg
	   (if (and transient-mark-mode mark-active)
	       (region-beginning))
	   (if (and transient-mark-mode mark-active)
358
	       (region-end))))))
359
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
360
		   t 'literal delimited nil nil start end))
361

362 363 364 365 366
(make-obsolete 'query-replace-regexp-eval
  "for interactive use, use the special `\\,' feature of
`query-replace-regexp' instead.  Non-interactively, a loop
using `search-forward-regexp' and `replace-match' is preferred." "22.1")

367
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
368
  "Replace some matches for REGEXP with various strings, in rotation.
369 370 371
The second argument TO-STRINGS contains the replacement strings, separated
by spaces.  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
372 373
wrapping around from the last such string to the first.

374 375 376
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
377 378
Non-interactively, TO-STRINGS may be a list of replacement strings.

379 380 381
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
382
A prefix argument N says to use each replacement string N times
383 384
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
385
  (interactive
386
   (let* ((from (if query-replace-interactive
387 388 389
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
390
					'query-replace-history nil t)))
391
	  (to (read-from-minibuffer
392
	       (format "Query replace %s with (space-separated strings): "
393
		       (query-replace-descr from))
394
	       nil nil nil
395
	       'query-replace-history from t)))
396 397 398
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
399 400 401 402
	   (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
403 404 405 406 407 408 409 410 411 412 413 414 415
  (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 ""))))
416
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
417

418
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
419 420 421
  "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.
422 423 424
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

432 433 434 435
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
436 437
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
438 439
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
440 441 442
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.)"
443 444
  (interactive
   (let ((common
445
	  (query-replace-read-args
446 447 448 449
	   (if (and transient-mark-mode mark-active)
	       "Replace string in region"
	     "Replace string")
	   nil)))
450 451 452 453 454
     (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)))))
455
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
456

457
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
458
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
459
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
460
are non-nil and REGEXP has no uppercase letters.
461 462 463 464

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

Richard M. Stallman's avatar
Richard M. Stallman committed
469 470
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
471 472 473 474 475 476 477
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
478 479 480
whole match, `\\N' a partial match, `\\#&' and `\\#N' the respective
numeric values from `string-to-number', and `\\#' itself for
`replace-count', the number of replacements occurred so far.
481 482 483 484 485 486 487 488 489 490

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
491

492 493 494
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
495 496 497
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
498
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
499
which will run faster and will not set the mark or print anything."
500 501
  (interactive
   (let ((common
502
	  (query-replace-read-args
503
	   (if (and transient-mark-mode mark-active)
504 505
	       "Replace regexp in region"
	     "Replace regexp")
506
	   t)))
507 508 509 510 511
     (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)))))
512
  (perform-replace regexp to-string nil t delimited nil nil start end))
513

514 515 516

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
517

518

519
(defalias 'delete-non-matching-lines 'keep-lines)
520 521 522 523 524 525 526
(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.
527 528
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
529 530
			      'regexp-history nil t)
	nil nil t))
531

532
(defun keep-lines (regexp &optional rstart rend interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
533 534
  "Delete all lines except those containing matches for REGEXP.
A match split across lines preserves all the lines it lies in.
535 536
When called from Lisp (and usually interactively as well, see below)
applies to all lines starting after point.
537 538

If REGEXP contains upper case characters (excluding those preceded by `\\'),
539 540 541
the matching is case-sensitive.

Second and third arg RSTART and REND specify the region to operate on.
542 543 544
This command operates on (the accessible part of) all lines whose
accessible part is entirely contained in the region determined by RSTART
and REND.  (A newline ending a line counts as part of that line.)
545

546
Interactively, in Transient Mark mode when the mark is active, operate
547 548 549 550 551 552 553 554
on all lines whose accessible part is entirely contained in the region.
Otherwise, the command applies to all lines starting after point.
When calling this function from Lisp, you can pretend that it was
called interactively by passing a non-nil INTERACTIVE argument.

This function starts looking for the next match from the end of
the previous match.  Hence, it ignores matches that overlap
a previously found match."
555

556
  (interactive
557 558 559
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
560
  (if rstart
561 562
      (progn
	(goto-char (min rstart rend))
563 564 565 566 567 568 569 570
	(setq rend
	      (progn
		(save-excursion
		  (goto-char (max rstart rend))
		  (unless (or (bolp) (eobp))
		    (forward-line 0))
		  (point-marker)))))
    (if (and interactive transient-mark-mode mark-active)
571
	(setq rstart (region-beginning)
572 573 574 575 576
	      rend (progn
		     (goto-char (region-end))
		     (unless (or (bolp) (eobp))
		       (forward-line 0))
		     (point-marker)))
577 578 579
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
580 581
  (save-excursion
    (or (bolp) (forward-line 1))
582 583 584
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
585
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
586
	;; Start is first char not preserved by previous match.
587 588
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
589
	  (let ((end (save-excursion (goto-char (match-beginning 0))
590
				     (forward-line 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
591 592 593 594
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
595

596
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
597
	;; If the match was empty, avoid matching again at same place.
598 599
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
600 601 602
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
603

604

605 606 607 608 609 610
(defun flush-lines (regexp &optional rstart rend interactive)
 "Delete lines containing matches for REGEXP.
When called from Lisp (and usually when called interactively as
well, see below), applies to the part of the buffer after point.
The line point is in is deleted if and only if it contains a
match for regexp starting after point.
611 612

If REGEXP contains upper case characters (excluding those preceded by `\\'),
613 614 615
the matching is case-sensitive.

Second and third arg RSTART and REND specify the region to operate on.
616 617
Lines partially contained in this region are deleted if and only if
they contain a match entirely contained in it.
618

619 620
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
621 622 623 624 625 626 627
end of (the accessible portion of) the buffer.  When calling this function
from Lisp, you can pretend that it was called interactively by passing
a non-nil INTERACTIVE argument.

If a match is split across lines, all the lines it lies in are deleted.
They are deleted _before_ looking for the next match.  Hence, a match
starting on the same line at which another match ended is ignored."
628

629
  (interactive
630 631 632
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
633
  (if rstart
634 635 636
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
637
    (if (and interactive transient-mark-mode mark-active)
638 639 640 641 642
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
643 644 645
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
646 647
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
648
	(delete-region (save-excursion (goto-char (match-beginning 0))
649
				       (forward-line 0)
650
				       (point))
651 652 653
		       (progn (forward-line 1) (point))))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
654

655

656 657 658 659 660
(defun how-many (regexp &optional rstart rend interactive)
  "Print and return number of matches for REGEXP following point.
When called from Lisp and INTERACTIVE is omitted or nil, just return
the number, do not print it; if INTERACTIVE is t, the function behaves
in all respects has if it had been called interactively.
661 662

If REGEXP contains upper case characters (excluding those preceded by `\\'),
663 664 665 666
the matching is case-sensitive.

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

667 668
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
669 670 671 672 673
end of (the accessible portion of) the buffer.

This function starts looking for the next match from the end of
the previous match.  Hence, it ignores matches that overlap
a previously found match."
674

675 676
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
677 678
  (save-excursion
    (if rstart
679 680 681 682
	(progn
	  (goto-char (min rstart rend))
	  (setq rend (max rstart rend)))
      (if (and interactive transient-mark-mode mark-active)
683
	  (setq rstart (region-beginning)
684
		rend (region-end))
685
	(setq rstart (point)
686
	      rend (point-max)))
687
      (goto-char rstart))
688 689 690 691 692 693 694 695 696 697
    (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))))
698 699 700 701
      (when interactive (message "%d occurrence%s"
				 count
				 (if (= count 1) "" "s")))
      count)))
702

703

704 705
(defvar occur-mode-map
  (let ((map (make-sparse-keymap)))
706
    ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
707 708 709
    (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)
710
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
711
    (define-key map "\C-o" 'occur-mode-display-occurrence)
712 713
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
714 715
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
716
    (define-key map "g" 'revert-buffer)
717 718
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
719
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
720 721
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
722

723 724 725
(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
726

727 728 729 730 731 732
(defcustom occur-mode-hook '(turn-on-font-lock)
  "Hook run when entering Occur mode."
  :type 'hook
  :group 'matching)

(defcustom occur-hook nil
Juanma Barranquero's avatar
Juanma Barranquero committed
733
  "Hook run by Occur when there are any matches."
734 735 736
  :type 'hook
  :group 'matching)

737
(put 'occur-mode 'mode-class 'special)
738
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
739
  "Major mode for output from \\[occur].
740 741 742 743
\\<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
744
\\{occur-mode-map}"
745
  (interactive)
746 747 748 749
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
750
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
751
  (make-local-variable 'occur-revert-arguments)
752
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
753
  (setq next-error-function 'occur-next-error)
754
  (run-mode-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
755

756
(defun occur-revert-function (ignore1 ignore2)
757
  "Handle `revert-buffer' for Occur mode buffers."
758
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
759

760
(defun occur-mode-find-occurrence ()
761 762
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
763
      (error "No occurrence on this line"))
764 765 766
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
767

768 769
(defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence)
(defun occur-mode-goto-occurrence (&optional event)
770
  "Go to the occurrence the current line describes."
771 772 773 774 775 776 777 778 779 780 781 782 783
  (interactive (list last-nonmenu-event))
  (let ((pos
         (if (null event)
             ;; Actually `event-end' works correctly with a nil argument as
             ;; well, so we could dispense with this test, but let's not
             ;; rely on this undocumented behavior.
             (occur-mode-find-occurrence)
           (with-current-buffer (window-buffer (posn-window (event-end event)))
             (save-excursion
               (goto-char (posn-point (event-end event)))
               (occur-mode-find-occurrence)))))
        same-window-buffer-names
        same-window-regexps)
784
    (pop-to-buffer (marker-buffer pos))
785
    (goto-char pos)))
786

787 788 789
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
790 791 792
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
793

794 795 796
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
797 798 799
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
800
	same-window-buffer-names
801 802
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
803 804 805
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
806
      (goto-char pos))))
807

808
(defun occur-find-match (n search message)
809 810 811
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
812 813 814 815
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
816
      (if r
817 818
          (goto-char r)
        (error message))
819 820
      (setq n (1- n)))))

821 822 823 824 825
(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"))

826
(defun occur-prev (&optional n)
827
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
828
  (interactive "p")
829
  (occur-find-match n #'previous-single-property-change "No earlier matches"))
830 831 832 833 834

(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")
835
  ;; we need to run occur-find-match from within the Occur buffer
836
  (with-current-buffer
837
      ;; Choose the buffer and make it current.
838 839
      (if (next-error-buffer-p (current-buffer))
	  (current-buffer)
840 841 842
	(next-error-find-buffer nil nil
				(lambda ()
				  (eq major-mode 'occur-mode))))
843 844 845

    (goto-char (cond (reset (point-min))
		     ((< argp 0) (line-beginning-position))
846 847
		     ((> argp 0) (line-end-position))
		     ((point))))
848
    (occur-find-match
849 850
     (abs argp)
     (if (> 0 argp)
851 852 853 854
	 #'previous-single-property-change
       #'next-single-property-change)
     "No more matches")
    ;; In case the *Occur* buffer is visible in a nonselected window.
855 856
    (let ((win (get-buffer-window (current-buffer) t)))
      (if win (set-window-point win (point))))
857
    (occur-mode-goto-occurrence)))
858

Juri Linkov's avatar
Juri Linkov committed
859 860
(defface match
  '((((class color) (min-colors 88) (background light))
861
     :background "yellow1")
Juri Linkov's avatar
Juri Linkov committed
862
    (((class color) (min-colors 88) (background dark))
863
     :background "RoyalBlue3")
864 865 866
    (((class color) (min-colors 8) (background light))
     :background "yellow" :foreground "black")
    (((class color) (min-colors 8) (background dark))
Juri Linkov's avatar
Juri Linkov committed
867 868 869 870 871 872
     :background "blue" :foreground "white")
    (((type tty) (class mono))
     :inverse-video t)
    (t :background "gray"))
  "Face used to highlight matches permanently."
  :group 'matching
873
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
874

875
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
876 877
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
878 879 880
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
881

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

Juri Linkov's avatar
Juri Linkov committed
884
(defcustom list-matching-lines-face 'match
Dave Love's avatar
Dave Love committed
885
  "*Face used by \\[list-matching-lines] to show the text that matches.
886 887 888 889 890 891 892 893 894