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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2015 Free
4
;; Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6
;; Maintainer: emacs-devel@gnu.org
7
;; Package: emacs
Pavel Janík's avatar
Pavel Janík committed
8

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

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

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

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

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

36 37
(defcustom replace-lax-whitespace nil
  "Non-nil means `query-replace' matches a sequence of whitespace chars.
38 39 40 41 42 43 44 45 46
When you enter a space or spaces in the strings to be replaced,
it will match any sequence matched by the regexp `search-whitespace-regexp'."
  :type 'boolean
  :group 'matching
  :version "24.3")

(defcustom replace-regexp-lax-whitespace nil
  "Non-nil means `query-replace-regexp' matches a sequence of whitespace chars.
When you enter a space or spaces in the regexps to be replaced,
47 48 49 50 51
it will match any sequence matched by the regexp `search-whitespace-regexp'."
  :type 'boolean
  :group 'matching
  :version "24.3")

52 53 54 55
(defvar query-replace-history nil
  "Default history list for query-replace commands.
See `query-replace-from-history-variable' and
`query-replace-to-history-variable'.")
56

57 58
(defvar query-replace-defaults nil
  "Default values of FROM-STRING and TO-STRING for `query-replace'.
59 60
This is a list of cons cells (FROM-STRING . TO-STRING), or nil
if there are no default values.")
61

62
(defvar query-replace-interactive nil
63
  "Non-nil means `query-replace' uses the last search string.
64
That becomes the \"string to replace\".")
65 66 67 68
(make-obsolete-variable 'query-replace-interactive
			"use `M-n' to pull the last incremental search string
to the minibuffer that reads the string to replace, or invoke replacements
from Isearch by using a key sequence like `C-s C-s M-%'." "24.3")
69

70 71 72
(defcustom query-replace-from-to-separator
  (propertize
   (or (ignore-errors
73 74
	 ;; Ignore errors when attempt to autoload char-displayable-p
	 ;; fails while preparing to dump.
75 76 77 78 79 80 81
	 (if (char-displayable-p ?\u2192) " \u2192 " " -> "))
       " -> ")
   'face 'minibuffer-prompt)
  "String that separates FROM and TO in the history of replacement pairs."
  :group 'matching
  :type 'sexp
  :version "25.1")
82

83
(defcustom query-replace-from-history-variable 'query-replace-history
84
  "History list to use for the FROM argument of `query-replace' commands.
85 86 87 88
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
89 90
  :type 'symbol
  :version "20.3")
91 92

(defcustom query-replace-to-history-variable 'query-replace-history
93
  "History list to use for the TO argument of `query-replace' commands.
94 95 96 97
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
98 99
  :type 'symbol
  :version "20.3")
100

101
(defcustom query-replace-skip-read-only nil
Lute Kamstra's avatar
Lute Kamstra committed
102
  "Non-nil means `query-replace' and friends ignore read-only matches."
103 104
  :type 'boolean
  :group 'matching
105
  :version "22.1")
106

107
(defcustom query-replace-show-replacement t
Lute Kamstra's avatar
Lute Kamstra committed
108
  "Non-nil means to show what actual replacement text will be."
109 110 111 112
  :type 'boolean
  :group 'matching
  :version "23.1")

113
(defcustom query-replace-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
114
  "Non-nil means to highlight matches during query replacement."
115 116 117 118
  :type 'boolean
  :group 'matching)

(defcustom query-replace-lazy-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
119
  "Controls the lazy-highlighting during query replacements.
120 121 122 123 124 125
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
126
  :version "22.1")
127 128 129 130 131

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

134 135 136 137
(defvar replace-count 0
  "Number of replacements done so far.
See `replace-regexp' and `query-replace-regexp-eval'.")

138 139 140
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

141
(defun query-replace-read-from (prompt regexp-flag)
142 143 144
  "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."
145 146
  (if query-replace-interactive
      (car (if regexp-flag regexp-search-ring search-ring))
147 148
    ;; Reevaluating will check char-displayable-p that is
    ;; unavailable while preparing to dump.
149
    (custom-reevaluate-setting 'query-replace-from-to-separator)
150
    (let* ((history-add-new-input nil)
151 152 153 154 155
	   (separator
	    (when query-replace-from-to-separator
	      (propertize "\0"
			  'display query-replace-from-to-separator
			  'separator t)))
156 157
	   (query-replace-from-to-history
	    (append
158
	     (when separator
159 160
	       (mapcar (lambda (from-to)
			 (concat (query-replace-descr (car from-to))
161
				 separator
162 163 164 165
				 (query-replace-descr (cdr from-to))))
		       query-replace-defaults))
	     (symbol-value query-replace-from-history-variable)))
	   (minibuffer-allow-text-properties t) ; separator uses text-properties
166
	   (prompt
167
	    (if (and query-replace-defaults separator)
168
		(format "%s (default %s): " prompt (car query-replace-from-to-history))
169
	      (format "%s: " prompt)))
170
	   (from
171 172 173 174
	    ;; 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
175
	      (if regexp-flag
176
		  (read-regexp prompt nil 'query-replace-from-to-history)
177
		(read-from-minibuffer
178
		 prompt nil nil nil 'query-replace-from-to-history
179
		 (car (if regexp-flag regexp-search-ring search-ring)) t)))))
180
      (if (and (zerop (length from)) query-replace-defaults)
181
	  (cons (caar query-replace-defaults)
Chong Yidong's avatar
Chong Yidong committed
182
		(query-replace-compile-replacement
183
		 (cdar query-replace-defaults) regexp-flag))
184
	(let* ((to (if (and (string-match separator from)
185
			    (get-text-property (match-beginning 0) 'separator from))
186
		       (substring-no-properties from (match-end 0))))
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
	       (from (if to (substring-no-properties from 0 (match-beginning 0))
		       (substring-no-properties from))))
	  (add-to-history query-replace-from-history-variable from nil t)
	  ;; 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)))
	  (if (not to)
	      from
	    (add-to-history query-replace-to-history-variable to nil t)
	    (add-to-history 'query-replace-defaults (cons from to) nil t)
204
	    (cons from (query-replace-compile-replacement to regexp-flag))))))))
205

David Kastrup's avatar
David Kastrup committed
206 207 208 209 210 211
(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))
212 213 214 215 216 217 218 219 220 221 222 223
      (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)
224 225 226 227 228 229 230
		     (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)
231 232 233
					      (not (= ?\( (aref to 0)))))
				     (eq (string-match " " to (cdr pos))
					 (cdr pos)))
234 235 236
				(1+ (cdr pos))
			      (cdr pos))))
		       (setq to (substring to end)))))
237
	      (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
David Kastrup's avatar
David Kastrup committed
238 239 240 241 242 243
	(setq to (nreverse (delete "" (cons to list))))
	(replace-match-string-symbols to)
	(cons 'replace-eval-replacement
	      (if (cdr to)
		  (cons 'concat to)
		(car to))))
244 245
    to))

David Kastrup's avatar
David Kastrup committed
246

247
(defun query-replace-read-to (from prompt regexp-flag)
David Kastrup's avatar
David Kastrup committed
248 249 250
  "Query and return the `to' argument of a query-replace operation."
  (query-replace-compile-replacement
   (save-excursion
251 252 253 254 255 256
     (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)
257
       (add-to-history 'query-replace-defaults (cons from to) nil t)
258
       to))
David Kastrup's avatar
David Kastrup committed
259 260
   regexp-flag))

261
(defun query-replace-read-args (prompt regexp-flag &optional noerror)
262 263
  (unless noerror
    (barf-if-buffer-read-only))
264
  (let* ((from (query-replace-read-from prompt regexp-flag))
265
	 (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
266
	       (query-replace-read-to from prompt regexp-flag))))
Juri Linkov's avatar
Juri Linkov committed
267 268 269
    (list from to
	  (and current-prefix-arg (not (eq current-prefix-arg '-)))
	  (and current-prefix-arg (eq current-prefix-arg '-)))))
270

Juri Linkov's avatar
Juri Linkov committed
271
(defun query-replace (from-string to-string &optional delimited start end backward)
Roland McGrath's avatar
Roland McGrath committed
272 273 274 275
  "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.

276 277 278
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.

279 280 281 282 283
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search string to the minibuffer
that reads FROM-STRING, or invoke replacements from
incremental search with a key sequence like `C-s C-s M-%'
to use its current search string as the string to replace.
284

285 286 287 288
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
Juanma Barranquero's avatar
Juanma Barranquero committed
289
letters.  (Transferring the case pattern means that if the old text
290 291
matched is all caps, or capitalized, then its replacement is upcased
or capitalized.)
292

293 294
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
295
matches using `isearch-filter-predicate'.
296

297 298 299 300
If `replace-lax-whitespace' is non-nil, a space or spaces in the string
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

Richard M. Stallman's avatar
Richard M. Stallman committed
301
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Juri Linkov's avatar
Juri Linkov committed
302 303 304
only matches surrounded by word boundaries.  A negative prefix arg means
replace backward.

305
Fourth and fifth arg START and END specify the region to operate on.
306

307
To customize possible responses, change the bindings in `query-replace-map'."
308 309 310 311
  (interactive
   (let ((common
	  (query-replace-read-args
	   (concat "Query replace"
Juri Linkov's avatar
Juri Linkov committed
312 313 314
		   (if current-prefix-arg
		       (if (eq current-prefix-arg '-) " backward" " word")
		     "")
315 316 317 318 319 320 321 322 323
		   (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)
Juri Linkov's avatar
Juri Linkov committed
324 325 326
	       (region-end))
	   (nth 3 common))))
  (perform-replace from-string to-string t nil delimited nil nil start end backward))
327

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

Juri Linkov's avatar
Juri Linkov committed
330
(defun query-replace-regexp (regexp to-string &optional delimited start end backward)
Roland McGrath's avatar
Roland McGrath committed
331 332 333 334
  "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.

335 336 337
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.

338 339 340 341 342
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP, or invoke replacements from
incremental search with a key sequence like `C-M-s C-M-s C-M-%'
to use its current search regexp as the regexp to replace.
343

344 345 346 347 348 349 350
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.)
351

352 353
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
354
matches using `isearch-filter-predicate'.
355

356
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
357 358 359
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

Richard M. Stallman's avatar
Richard M. Stallman committed
360
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Juri Linkov's avatar
Juri Linkov committed
361 362 363
only matches surrounded by word boundaries.  A negative prefix arg means
replace backward.

364 365
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
366 367
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
368
whatever what matched the Nth `\\(...\\)' in REGEXP.
369 370 371
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

372 373 374 375
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
376
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
377 378 379
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).
380

381 382
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
383 384 385 386

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."
387 388
  (interactive
   (let ((common
389
	  (query-replace-read-args
390
	   (concat "Query replace"
Juri Linkov's avatar
Juri Linkov committed
391 392 393
		   (if current-prefix-arg
		       (if (eq current-prefix-arg '-) " backward" " word")
		     "")
394 395
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
396
	   t)))
397 398 399 400 401 402 403
     (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)
Juri Linkov's avatar
Juri Linkov committed
404 405 406
	       (region-end))
	   (nth 3 common))))
  (perform-replace regexp to-string t t delimited nil nil start end backward))
407

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

410
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
411
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
412 413 414 415 416

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.

417 418 419 420 421 422 423 424 425
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
426 427
`\\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.
428
Use `\\#&' or `\\#N' if you want a number instead of a string.
429
In interactive use, `\\#' in itself stands for `replace-count'.
430 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.

434 435 436
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP.
437 438 439

Preserves case in each replacement if `case-replace' and `case-fold-search'
are non-nil and REGEXP has no uppercase letters.
440

441 442
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
443
matches using `isearch-filter-predicate'.
444

445
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
446 447 448
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

449
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
450
only matches that are surrounded by word boundaries.
451
Fourth and fifth arg START and END specify the region to operate on."
452 453 454
  (declare (obsolete "use the `\\,' feature of `query-replace-regexp'
for interactive calls, and `search-forward-regexp'/`replace-match'
for Lisp calls." "22.1"))
455
  (interactive
456
   (progn
457 458 459 460 461
     (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
462
	     (let ((query-replace-defaults nil))
463 464 465 466 467 468 469 470 471 472 473 474 475
	       (query-replace-read-from "Query replace regexp" t)))
	    (to (list (read-from-minibuffer
		       (format "Query replace regexp %s with eval: "
			       (query-replace-descr from))
		       nil nil t query-replace-to-history-variable from t))))
       ;; We make TO a list because replace-match-string-symbols requires one,
       ;; and the user might enter a single token.
       (replace-match-string-symbols to)
       (list from (car to) current-prefix-arg
	     (if (and transient-mark-mode mark-active)
		 (region-beginning))
	     (if (and transient-mark-mode mark-active)
		 (region-end))))))
476
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
477
		   t 'literal delimited nil nil start end))
478

479
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
480
  "Replace some matches for REGEXP with various strings, in rotation.
481 482 483
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
484 485
wrapping around from the last such string to the first.

486 487 488
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
489 490
Non-interactively, TO-STRINGS may be a list of replacement strings.

Glenn Morris's avatar
Glenn Morris committed
491
Interactively, reads the regexp using `read-regexp'.
492 493 494
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP.
495

Roland McGrath's avatar
Roland McGrath committed
496
A prefix argument N says to use each replacement string N times
497 498
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
499
  (interactive
500 501
   (let* ((from (read-regexp "Map query replace (regexp): " nil
			     query-replace-from-history-variable))
502
	  (to (read-from-minibuffer
503
	       (format "Query replace %s with (space-separated strings): "
504
		       (query-replace-descr from))
505
	       nil nil nil
506
	       query-replace-to-history-variable from t)))
507 508 509
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
510 511 512 513
	   (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
514 515 516 517 518 519 520 521 522 523 524 525 526
  (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 ""))))
527
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
528

Juri Linkov's avatar
Juri Linkov committed
529
(defun replace-string (from-string to-string &optional delimited start end backward)
Roland McGrath's avatar
Roland McGrath committed
530 531 532
  "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.
533 534 535
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

536 537
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
538
matches using `isearch-filter-predicate'.
539

540 541 542 543
If `replace-lax-whitespace' is non-nil, a space or spaces in the string
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

Richard M. Stallman's avatar
Richard M. Stallman committed
544
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Juri Linkov's avatar
Juri Linkov committed
545 546
only matches surrounded by word boundaries.  A negative prefix arg means
replace backward.
547 548 549 550 551

Operates on the region between START and END (if both are nil, from point
to the end of the buffer).  Interactively, if Transient Mark mode is
enabled and the mark is active, operates on the contents of the region;
otherwise from point to the end of the buffer.
Roland McGrath's avatar
Roland McGrath committed
552

553 554 555
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search string to the minibuffer
that reads FROM-STRING.
556

Roland McGrath's avatar
Roland McGrath committed
557 558
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
559 560
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
561 562 563
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.)"
564 565
  (declare (interactive-only
	    "use `search-forward' and `replace-match' instead."))
566 567
  (interactive
   (let ((common
568
	  (query-replace-read-args
569
	   (concat "Replace"
Juri Linkov's avatar
Juri Linkov committed
570 571 572
		   (if current-prefix-arg
		       (if (eq current-prefix-arg '-) " backward" " word")
		     "")
573 574
		   " string"
		   (if (and transient-mark-mode mark-active) " in region" ""))
575
	   nil)))
576 577 578 579
     (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)
Juri Linkov's avatar
Juri Linkov committed
580 581 582
	       (region-end))
	   (nth 3 common))))
  (perform-replace from-string to-string nil nil delimited nil nil start end backward))
Roland McGrath's avatar
Roland McGrath committed
583

Juri Linkov's avatar
Juri Linkov committed
584
(defun replace-regexp (regexp to-string &optional delimited start end backward)
Roland McGrath's avatar
Roland McGrath committed
585
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
586
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
587
are non-nil and REGEXP has no uppercase letters.
588

589 590
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
591
matches using `isearch-filter-predicate'.
592

593
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
594 595 596
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

597 598 599
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
600
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Juri Linkov's avatar
Juri Linkov committed
601 602 603
only matches surrounded by word boundaries.  A negative prefix arg means
replace backward.

604 605
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
606 607
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
608 609 610 611 612 613 614
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
615 616 617
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.
618 619 620 621 622 623 624 625 626 627

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
628

629 630 631
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP.
632

Roland McGrath's avatar
Roland McGrath committed
633 634 635
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
636
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
637
which will run faster and will not set the mark or print anything."
638 639
  (declare (interactive-only
	    "use `re-search-forward' and `replace-match' instead."))
640 641
  (interactive
   (let ((common
642
	  (query-replace-read-args
643
	   (concat "Replace"
Juri Linkov's avatar
Juri Linkov committed
644 645 646
		   (if current-prefix-arg
		       (if (eq current-prefix-arg '-) " backward" " word")
		     "")
647 648
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
649
	   t)))
650 651 652 653
     (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)
Juri Linkov's avatar
Juri Linkov committed
654 655 656
	       (region-end))
	   (nth 3 common))))
  (perform-replace regexp to-string nil t delimited nil nil start end backward))
657

658 659

(defvar regexp-history nil
660 661 662 663
  "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
664

665 666 667
(defvar occur-collect-regexp-history '("\\1")
  "History of regexp for occur's collect operation")

668
(defcustom read-regexp-defaults-function nil
Glenn Morris's avatar
Glenn Morris committed
669 670 671 672
  "Function that provides default regexp(s) for `read-regexp'.
This function should take no arguments and return one of: nil, a
regexp, or a list of regexps.  Interactively, `read-regexp' uses
the return value of this function for its DEFAULT argument.
673

Glenn Morris's avatar
Glenn Morris committed
674 675
As an example, set this variable to `find-tag-default-as-regexp'
to default to the symbol at point.
676

Glenn Morris's avatar
Glenn Morris committed
677 678
To provide different default regexps for different commands,
the function that you set this to can check `this-command'."
679 680 681 682 683 684 685 686 687
  :type '(choice
	  (const :tag "No default regexp reading function" nil)
	  (const :tag "Latest regexp history" regexp-history-last)
	  (function-item :tag "Tag at point"
			 find-tag-default)
	  (function-item :tag "Tag at point as regexp"
			 find-tag-default-as-regexp)
	  (function-item :tag "Tag at point as symbol regexp"
			 find-tag-default-as-symbol-regexp)
Glenn Morris's avatar
Glenn Morris committed
688
	  (function :tag "Your choice of function"))
689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
  :group 'matching
  :version "24.4")

(defun read-regexp-suggestions ()
  "Return a list of standard suggestions for `read-regexp'.
By default, the list includes the tag at point, the last isearch regexp,
the last isearch string, and the last replacement regexp.  `read-regexp'
appends the list returned by this function to the end of values available
via \\<minibuffer-local-map>\\[next-history-element]."
  (list
   (find-tag-default-as-regexp)
   (find-tag-default-as-symbol-regexp)
   (car regexp-search-ring)
   (regexp-quote (or (car search-ring) ""))
   (car (symbol-value query-replace-from-history-variable))))

705 706
(defun read-regexp (prompt &optional defaults history)
  "Read and return a regular expression as a string.
Glenn Morris's avatar
Glenn Morris committed
707 708
Prompt with the string PROMPT.  If PROMPT ends in \":\" (followed by
optional whitespace), use it as-is.  Otherwise, add \": \" to the end,
709
possibly preceded by the default result (see below).
Glenn Morris's avatar
Glenn Morris committed
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735

The optional argument DEFAULTS can be either: nil, a string, a list
of strings, or a symbol.  We use DEFAULTS to construct the default
return value in case of empty input.

If DEFAULTS is a string, we use it as-is.

If DEFAULTS is a list of strings, the first element is the
default return value, but all the elements are accessible
using the history command \\<minibuffer-local-map>\\[next-history-element].

If DEFAULTS is a non-nil symbol, then if `read-regexp-defaults-function'
is non-nil, we use that in place of DEFAULTS in the following:
  If DEFAULTS is the symbol `regexp-history-last', we use the first
  element of HISTORY (if specified) or `regexp-history'.
  If DEFAULTS is a function, we call it with no arguments and use
  what it returns, which should be either nil, a string, or a list of strings.

We append the standard values from `read-regexp-suggestions' to DEFAULTS
before using it.

If the first element of DEFAULTS is non-nil (and if PROMPT does not end
in \":\", followed by optional whitespace), we add it to the prompt.

The optional argument HISTORY is a symbol to use for the history list.
If nil, uses `regexp-history'."
736 737 738 739 740 741 742 743 744 745
  (let* ((defaults
	   (if (and defaults (symbolp defaults))
	       (cond
		((eq (or read-regexp-defaults-function defaults)
		     'regexp-history-last)
		 (car (symbol-value (or history 'regexp-history))))
		((functionp (or read-regexp-defaults-function defaults))
		 (funcall (or read-regexp-defaults-function defaults))))
	     defaults))
	 (default     (if (consp defaults) (car defaults) defaults))
746
	 (suggestions (if (listp defaults) defaults (list defaults)))
747
	 (suggestions (append suggestions (read-regexp-suggestions)))
748
	 (suggestions (delete-dups (delq nil (delete "" suggestions))))
749
	 ;; Do not automatically add default to the history for empty input.
Juri Linkov's avatar
Juri Linkov committed
750
	 (history-add-new-input nil)
751 752 753
	 (input (read-from-minibuffer
		 (cond ((string-match-p ":[ \t]*\\'" prompt)
			prompt)
754
		       ((and default (> (length default) 0))
755
			 (format "%s (default %s): " prompt
756
				 (query-replace-descr default)))
757 758
		       (t
			(format "%s: " prompt)))
759
		 nil nil nil (or history 'regexp-history) suggestions t)))
Juri Linkov's avatar
Juri Linkov committed
760
    (if (equal input "")
761
	;; Return the default value when the user enters empty input.
762 763 764
	(prog1 (or default input)
	  (when default
	    (add-to-history (or history 'regexp-history) default)))
765
      ;; Otherwise, add non-empty input to the history and return input.
Juri Linkov's avatar
Juri Linkov committed
766
      (prog1 input
767
	(add-to-history (or history 'regexp-history) input)))))
Juri Linkov's avatar
Juri Linkov committed
768

769

770
(defalias 'delete-non-matching-lines 'keep-lines)
771 772 773 774 775 776 777
(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.
778
Value is a list, (REGEXP)."
779
  (list (read-regexp prompt) nil nil t))
780

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

787 788
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
789 790

Second and third arg RSTART and REND specify the region to operate on.
791 792 793
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.)
794

795
Interactively, in Transient Mark mode when the mark is active, operate
796 797 798 799 800 801 802 803
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."
804

805
  (interactive
806 807
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
808
     (keep-lines-read-args "Keep lines containing match for regexp")))
809
  (if rstart
810 811
      (progn
	(goto-char (min rstart rend))
812 813 814 815 816 817 818 819
	(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)
820
	(setq rstart (region-beginning)
821 822 823 824 825
	      rend (progn
		     (goto-char (region-end))
		     (unless (or (bolp) (eobp))
		       (forward-line 0))
		     (point-marker)))
826 827 828
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
829 830
  (save-excursion
    (or (bolp) (forward-line 1))
831
    (let ((start (point))
832 833 834 835
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
836
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
837
	;; Start is first char not preserved by previous match.
838 839
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
840
	  (let ((end (save-excursion (goto-char (match-beginning 0))
841
				     (forward-line 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
842 843 844 845
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
846

847
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
848
	;; If the match was empty, avoid matching again at same place.
849 850
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
851 852 853
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
854

855

856 857 858 859 860 861
(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.
862

863 864
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
865 866

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