replace.el 70.8 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, 2008 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
;; This file is part of GNU Emacs.

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

;; 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
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
22

23 24 25 26 27
;;; 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
28
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
29

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

35 36
(defvar query-replace-history nil)

37 38 39 40 41
(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.")

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

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

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

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

70 71 72 73 74 75
(defcustom query-replace-show-replacement t
  "*Non-nil means to show what actual replacement text will be."
  :type 'boolean
  :group 'matching
  :version "23.1")

76 77 78 79 80 81 82 83 84 85 86 87 88
(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
89
  :version "22.1")
90 91 92 93 94

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

97 98 99
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

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

David Kastrup's avatar
David Kastrup committed
138 139 140 141 142 143
(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))
144 145 146 147 148 149 150 151 152 153 154 155
      (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)
156 157 158 159 160 161 162
		     (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)
163 164 165
					      (not (= ?\( (aref to 0)))))
				     (eq (string-match " " to (cdr pos))
					 (cdr pos)))
166 167 168
				(1+ (cdr pos))
			      (cdr pos))))
		       (setq to (substring to end)))))
169
	      (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
David Kastrup's avatar
David Kastrup committed
170 171 172 173 174 175
	(setq to (nreverse (delete "" (cons to list))))
	(replace-match-string-symbols to)
	(cons 'replace-eval-replacement
	      (if (cdr to)
		  (cons 'concat to)
		(car to))))
176 177
    to))

David Kastrup's avatar
David Kastrup committed
178

179
(defun query-replace-read-to (from prompt regexp-flag)
David Kastrup's avatar
David Kastrup committed
180 181 182
  "Query and return the `to' argument of a query-replace operation."
  (query-replace-compile-replacement
   (save-excursion
183 184 185 186 187 188
     (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)
189 190
       (setq query-replace-defaults (cons from to))
       to))
David Kastrup's avatar
David Kastrup committed
191 192
   regexp-flag))

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

201
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
202 203 204 205
  "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.

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

209 210 211 212
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.

213 214 215 216 217 218 219
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.)
220

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

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

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

245
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
246 247 248 249
  "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.

250 251 252
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.

253 254 255 256
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.

257 258 259 260 261 262 263
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.)
264

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

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

275 276 277 278
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
279
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
280 281 282
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).
283

284 285
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
286 287 288 289

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."
290 291
  (interactive
   (let ((common
292
	  (query-replace-read-args
293 294 295 296
	   (concat "Query replace"
		   (if current-prefix-arg " word" "")
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
297
	   t)))
298 299 300 301 302 303 304 305
     (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)))))
306
  (perform-replace regexp to-string t t delimited nil nil start end))
307

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

310
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
311
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
312 313 314 315 316

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.

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

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

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

368 369 370 371 372
(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")

373
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
374
  "Replace some matches for REGEXP with various strings, in rotation.
375 376 377
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
378 379
wrapping around from the last such string to the first.

380 381 382
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
383 384
Non-interactively, TO-STRINGS may be a list of replacement strings.

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

424
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
425 426 427
  "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.
428 429 430
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

438 439 440 441
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
442 443
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
444 445
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
446 447 448
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.)"
449 450
  (interactive
   (let ((common
451
	  (query-replace-read-args
452 453 454 455
	   (concat "Replace"
		   (if current-prefix-arg " word" "")
		   " string"
		   (if (and transient-mark-mode mark-active) " in region" ""))
456
	   nil)))
457 458 459 460 461
     (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)))))
462
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
463

464
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
465
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
466
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
467
are non-nil and REGEXP has no uppercase letters.
468 469 470 471

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

Richard M. Stallman's avatar
Richard M. Stallman committed
476 477
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
478 479 480 481 482 483 484
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
485 486 487
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.
488 489 490 491 492 493 494 495 496 497

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
498

499 500 501
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
502 503 504
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
505
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
506
which will run faster and will not set the mark or print anything."
507 508
  (interactive
   (let ((common
509
	  (query-replace-read-args
510 511 512 513
	   (concat "Replace"
		   (if current-prefix-arg " word" "")
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
514
	   t)))
515 516 517 518 519
     (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)))))
520
  (perform-replace regexp to-string nil t delimited nil nil start end))
521

522 523

(defvar regexp-history nil
524 525 526 527
  "History list for some commands that read regular expressions.

Maximum length of the history list is determined by the value
of `history-length', which see.")
Roland McGrath's avatar
Roland McGrath committed
528

529
(defun read-regexp (prompt &optional default-value)
Juri Linkov's avatar
Juri Linkov committed
530
  "Read regexp as a string using the regexp history and some useful defaults.
531
Prompt for a regular expression with PROMPT (without a colon and
532 533 534 535 536
space) in the minibuffer.  The optional argument DEFAULT-VALUE
provides the value to display in the minibuffer prompt that is
returned if the user just types RET.
Values available via M-n are the string at point, the last isearch
regexp, the last isearch string, and the last replacement regexp."
537
  (let* ((defaults
Juri Linkov's avatar
Juri Linkov committed
538 539 540 541 542 543 544 545 546 547 548 549 550 551
	   (list (regexp-quote
		  (or (funcall (or find-tag-default-function
				   (get major-mode 'find-tag-default-function)
				   'find-tag-default))
		      ""))
		 (car regexp-search-ring)
		 (regexp-quote (or (car search-ring) ""))
		 (car (symbol-value
		       query-replace-from-history-variable))))
	 (defaults (delete-dups (delq nil (delete "" defaults))))
	 ;; Don't add automatically the car of defaults for empty input
	 (history-add-new-input nil)
	 (input
	  (read-from-minibuffer
552 553 554
	   (if default-value
	       (format "%s (default %s): " prompt
		       (query-replace-descr default-value))
Juri Linkov's avatar
Juri Linkov committed
555 556 557
	     (format "%s: " prompt))
	   nil nil nil 'regexp-history defaults t)))
    (if (equal input "")
558
	default-value
Juri Linkov's avatar
Juri Linkov committed
559 560 561
      (prog1 input
	(add-to-history 'regexp-history input)))))

562

563
(defalias 'delete-non-matching-lines 'keep-lines)
564 565 566 567 568 569 570
(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.
571
Value is a list, (REGEXP)."
Juri Linkov's avatar
Juri Linkov committed
572
  (list (read-regexp prompt) nil nil t))
573

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

580 581
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
582 583

Second and third arg RSTART and REND specify the region to operate on.
584 585 586
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.)
587

588
Interactively, in Transient Mark mode when the mark is active, operate
589 590 591 592 593 594 595 596
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."
597

598
  (interactive
599 600
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
601
     (keep-lines-read-args "Keep lines containing match for regexp")))
602
  (if rstart
603 604
      (progn
	(goto-char (min rstart rend))
605 606 607 608 609 610 611 612
	(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)
613
	(setq rstart (region-beginning)
614 615 616 617 618
	      rend (progn
		     (goto-char (region-end))
		     (unless (or (bolp) (eobp))
		       (forward-line 0))
		     (point-marker)))
619 620 621
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
622 623
  (save-excursion
    (or (bolp) (forward-line 1))
624
    (let ((start (point))
625 626 627 628
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
629
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
630
	;; Start is first char not preserved by previous match.
631 632
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
633
	  (let ((end (save-excursion (goto-char (match-beginning 0))
634
				     (forward-line 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
635 636 637 638
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
639

640
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
641
	;; If the match was empty, avoid matching again at same place.
642 643
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
644 645 646
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
647

648

649 650 651 652 653 654
(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.
655

656 657
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
658 659

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

663 664
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
665 666 667 668 669 670 671
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."
672

673
  (interactive
674 675
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
676
     (keep-lines-read-args "Flush lines containing match for regexp")))
677
  (if rstart
678 679 680
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
681
    (if (and interactive transient-mark-mode mark-active)
682 683 684 685 686
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
687 688 689 690
  (let ((case-fold-search
	 (if (and case-fold-search search-upper-case)
	     (isearch-no-upper-case-p regexp t)
	   case-fold-search)))
691
    (save-excursion
692 693
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
694
	(delete-region (save-excursion (goto-char (match-beginning 0))
695
				       (forward-line 0)
696
				       (point))
697 698 699
		       (progn (forward-line 1) (point))))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
700

701

702 703 704 705
(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
706
in all respects as if it had been called interactively.
707

708 709
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
710 711 712

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

713 714
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
715 716 717 718 719
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."
720

721
  (interactive
Juri Linkov's avatar
Juri Linkov committed
722
   (keep-lines-read-args "How many matches for regexp"))
723 724
  (save-excursion
    (if rstart
725 726 727 728
	(progn
	  (goto-char (min rstart rend))
	  (setq rend (max rstart rend)))
      (if (and interactive transient-mark-mode mark-active)
729
	  (setq rstart (region-beginning)
730
		rend (region-end))
731
	(setq rstart (point)
732
	      rend (point-max)))
733
      (goto-char rstart))
734 735
    (let ((count 0)
	  opoint
736 737 738 739
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
740 741 742 743 744 745
      (while (and (< (point) rend)
		  (progn (setq opoint (point))
			 (re-search-forward regexp rend t)))
	(if (= opoint (point))
	    (forward-char 1)
	  (setq count (1+ count))))
746 747 748 749
      (when interactive (message "%d occurrence%s"
				 count
				 (if (= count 1) "" "s")))
      count)))
750

751

752 753
(defvar occur-mode-map
  (let ((map (make-sparse-keymap)))
754
    ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
755 756 757
    (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)
758
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
759
    (define-key map "\C-o" 'occur-mode-display-occurrence)
760 761
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
762 763
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
764
    (define-key map "g" 'revert-buffer)
765 766
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
767
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
768 769 770 771 772 773 774 775 776
    (define-key map [menu-bar] (make-sparse-keymap))
    (define-key map [menu-bar occur]
      (cons "Occur" map))
    (define-key map [next-error-follow-minor-mode]
      (menu-bar-make-mm-toggle next-error-follow-minor-mode
			       "Auto Occurrence Display"
			       "Display another occurrence when moving the cursor"))
    (define-key map [separator-1] '("--"))
    (define-key map [kill-this-buffer] 
Dan Nicolaescu's avatar
Dan Nicolaescu committed
777 778
      '(menu-item "Kill occur buffer" kill-this-buffer
		  :help "Kill the current *Occur* buffer"))
779
    (define-key map [quit-window] 
Dan Nicolaescu's avatar
Dan Nicolaescu committed
780 781
      '(menu-item "Quit occur window" quit-window
		  :help "Quit the current *Occur* buffer.  Bury it, and maybe delete the selected frame"))
782
    (define-key map [revert-buffer] 
Dan Nicolaescu's avatar
Dan Nicolaescu committed
783 784
      '(menu-item "Revert occur buffer" revert-buffer
		  :help "Replace the text in the *Occur* buffer with the results of rerunning occur"))
785
    (define-key map [clone-buffer] 
Dan Nicolaescu's avatar
Dan Nicolaescu committed
786 787
      '(menu-item "Clone occur buffer" clone-buffer
		  :help "Create and return a twin copy of the current *Occur* buffer"))
788
    (define-key map [occur-rename-buffer] 
Dan Nicolaescu's avatar
Dan Nicolaescu committed
789 790
      '(menu-item "Rename occur buffer" occur-rename-buffer
		  :help "Rename the current *Occur* buffer to *Occur: original-buffer-name*."))
791 792
    (define-key map [separator-2] '("--"))
    (define-key map [occur-mode-goto-occurrence-other-window]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
793 794
      '(menu-item "Go To Occurrence Other Window" occur-mode-goto-occurrence-other-window
		  :help "Go to the occurrence the current line describes, in another window"))
795
    (define-key map [occur-mode-goto-occurrence]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
796 797
      '(menu-item "Go To Occurrence" occur-mode-goto-occurrence
		  :help "Go to the occurrence the current line describes"))
798
    (define-key map [occur-mode-display-occurrence]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
799 800
      '(menu-item "Display Occurrence" occur-mode-display-occurrence
		  :help "Display in another window the occurrence the current line describes"))
801
    (define-key map [occur-next] 
Dan Nicolaescu's avatar
Dan Nicolaescu committed
802 803
      '(menu-item "Move to next match" occur-next
		  :help "Move to the Nth (default 1) next match in an Occur mode buffer"))
804
    (define-key map [occur-prev] 
Dan Nicolaescu's avatar
Dan Nicolaescu committed
805 806
      '(menu-item "Move to previous match" occur-prev
		  :help "Move to the Nth (default 1) previous match in an Occur mode buffer"))
807 808
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
809

810 811 812
(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
813

814 815 816 817 818 819
(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
820
  "Hook run by Occur when there are any matches."
821 822 823
  :type 'hook
  :group 'matching)

824 825 826 827 828 829 830
(defcustom occur-mode-find-occurrence-hook nil
  "Hook run by Occur after locating an occurrence.
This will be called with the cursor position at the occurrence.  An application
for this is to reveal context in an outline-mode when the occurrence is hidden."
  :type 'hook
  :group 'matching)

831
(put 'occur-mode 'mode-class 'special)
832
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
833
  "Major mode for output from \\[occur].
834 835 836 837
\\<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
838
\\{occur-mode-map}"
839
  (interactive)
840 841 842 843
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
844
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
845
  (make-local-variable 'occur-revert-arguments)
846
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
847
  (setq next-error-function 'occur-next-error)
848
  (run-mode-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
849

850
(defun occur-revert-function (ignore1 ignore2)
851
  "Handle `revert-buffer' for Occur mode buffers."
852
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
853

854
(defun occur-mode-find-occurrence ()
855 856
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
857
      (error "No occurrence on this line"))
858 859 860
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
861

862 863
(defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence)
(defun occur-mode-goto-occurrence (&optional event)
864
  "Go to the occurrence the current line describes."
865 866 867 868 869 870 871 872 873 874 875 876 877
  (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)
878
    (pop-to-buffer (marker-buffer pos))
879 880
    (goto-char pos)
    (run-hooks 'occur-mode-find-occurrence-hook)))
881

882 883 884
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
885 886
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
887 888
    (goto-char pos)
    (run-hooks 'occur-mode-find-occurrence-hook)))
889

890 891 892
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
893 894 895
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
896
	same-window-buffer-names