replace.el 75 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, 2009, 2010
5
;;   Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
6

Pavel Janík's avatar
Pavel Janík committed
7
;; Maintainer: FSF
8
;; Package: emacs
Pavel Janík's avatar
Pavel Janík committed
9

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

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; 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
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
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
Lute Kamstra's avatar
Lute Kamstra committed
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 39 40
(defvar query-replace-history nil
  "Default history list for query-replace commands.
See `query-replace-from-history-variable' and
`query-replace-to-history-variable'.")
41

42 43 44 45 46
(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.")

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

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

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

69
(defcustom query-replace-skip-read-only nil
Lute Kamstra's avatar
Lute Kamstra committed
70
  "Non-nil means `query-replace' and friends ignore read-only matches."
71 72
  :type 'boolean
  :group 'matching
73
  :version "22.1")
74

75
(defcustom query-replace-show-replacement t
Lute Kamstra's avatar
Lute Kamstra committed
76
  "Non-nil means to show what actual replacement text will be."
77 78 79 80
  :type 'boolean
  :group 'matching
  :version "23.1")

81
(defcustom query-replace-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
82
  "Non-nil means to highlight matches during query replacement."
83 84 85 86
  :type 'boolean
  :group 'matching)

(defcustom query-replace-lazy-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
87
  "Controls the lazy-highlighting during query replacements.
88 89 90 91 92 93
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
94
  :version "22.1")
95 96 97 98 99

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

102 103 104
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

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

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

David Kastrup's avatar
David Kastrup committed
183

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

198
(defun query-replace-read-args (prompt regexp-flag &optional noerror)
199 200
  (unless noerror
    (barf-if-buffer-read-only))
201
  (let* ((from (query-replace-read-from prompt regexp-flag))
202
	 (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
203
	       (query-replace-read-to from prompt regexp-flag))))
204
    (list from to current-prefix-arg)))
205

206
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
207 208 209 210
  "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.

211 212 213
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.

214 215 216 217
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.

218 219 220 221 222 223 224
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.)
225

Richard M. Stallman's avatar
Richard M. Stallman committed
226
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
227
only matches surrounded by word boundaries.
228
Fourth and fifth arg START and END specify the region to operate on.
229 230

To customize possible responses, change the \"bindings\" in `query-replace-map'."
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
  (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)))))
246
  (perform-replace from-string to-string t nil delimited nil nil start end))
247

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

250
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
251 252 253 254
  "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.

255 256 257
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.

258 259 260 261
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.

262 263 264 265 266 267 268
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.)
269

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

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

280 281 282 283
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
284
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
285 286 287
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).
288

289 290
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
291 292 293 294

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

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

315
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
316
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
317 318 319 320 321

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.

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

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

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

373 374 375 376 377
(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")

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

385 386 387
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
388 389
Non-interactively, TO-STRINGS may be a list of replacement strings.

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

430
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
431 432 433
  "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.
434 435 436
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

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

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

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

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

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
504

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

528 529

(defvar regexp-history nil
530 531 532 533
  "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
534

535
(defun read-regexp (prompt &optional default-value)
Juri Linkov's avatar
Juri Linkov committed
536
  "Read regexp as a string using the regexp history and some useful defaults.
537
Prompt for a regular expression with PROMPT (without a colon and
538 539 540 541 542
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."
543
  (let* ((defaults
Juri Linkov's avatar
Juri Linkov committed
544 545 546 547 548 549 550 551 552 553 554 555 556 557
	   (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
558 559 560
	   (if default-value
	       (format "%s (default %s): " prompt
		       (query-replace-descr default-value))
Juri Linkov's avatar
Juri Linkov committed
561 562 563
	     (format "%s: " prompt))
	   nil nil nil 'regexp-history defaults t)))
    (if (equal input "")
564
	(or default-value input)
Juri Linkov's avatar
Juri Linkov committed
565 566 567
      (prog1 input
	(add-to-history 'regexp-history input)))))

568

569
(defalias 'delete-non-matching-lines 'keep-lines)
570 571 572 573 574 575 576
(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.
577
Value is a list, (REGEXP)."
578
  (list (read-regexp prompt) nil nil t))
579

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

586 587
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
588 589

Second and third arg RSTART and REND specify the region to operate on.
590 591 592
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.)
593

594
Interactively, in Transient Mark mode when the mark is active, operate
595 596 597 598 599 600 601 602
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."
603

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

646
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
647
	;; If the match was empty, avoid matching again at same place.
648 649
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
650 651 652
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
653

654

655 656 657 658 659 660
(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.
661

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

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

669 670
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
671 672 673 674 675 676 677
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."
678

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

707

708 709 710 711
(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
712
in all respects as if it had been called interactively.
713

714 715
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
716 717 718

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

719 720
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
721 722 723 724 725
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."
726

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

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

816 817 818
(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
819

820 821 822 823 824 825
(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
826
  "Hook run by Occur when there are any matches."
827 828 829
  :type 'hook
  :group 'matching)

830 831 832 833 834 835 836
(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)

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

856
(defun occur-revert-function (ignore1 ignore2)
857
  "Handle `revert-buffer' for Occur mode buffers."
858
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
859

860
(defun occur-mode-find-occurrence ()
861 862
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
863
      (error "No occurrence on this line"))
864 865 866
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
867

868 869
(defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence)
(defun occur-mode-goto-occurrence (&optional event)
870
  "Go to the occurrence the current line describes."
871 872 873