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

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

Pavel Janík's avatar
Pavel Janík committed
6
;; Maintainer: FSF
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 59 60 61
(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.")

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
(defcustom query-replace-from-history-variable 'query-replace-history
71
  "History list to use for the FROM argument of `query-replace' commands.
72 73 74 75
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
76 77
  :type 'symbol
  :version "20.3")
78 79

(defcustom query-replace-to-history-variable 'query-replace-history
80
  "History list to use for the TO argument of `query-replace' commands.
81 82 83 84
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
85 86
  :type 'symbol
  :version "20.3")
87

88
(defcustom query-replace-skip-read-only nil
Lute Kamstra's avatar
Lute Kamstra committed
89
  "Non-nil means `query-replace' and friends ignore read-only matches."
90 91
  :type 'boolean
  :group 'matching
92
  :version "22.1")
93

94
(defcustom query-replace-show-replacement t
Lute Kamstra's avatar
Lute Kamstra committed
95
  "Non-nil means to show what actual replacement text will be."
96 97 98 99
  :type 'boolean
  :group 'matching
  :version "23.1")

100
(defcustom query-replace-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
101
  "Non-nil means to highlight matches during query replacement."
102 103 104 105
  :type 'boolean
  :group 'matching)

(defcustom query-replace-lazy-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
106
  "Controls the lazy-highlighting during query replacements.
107 108 109 110 111 112
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
113
  :version "22.1")
114 115 116 117 118

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

121 122 123 124
(defvar replace-count 0
  "Number of replacements done so far.
See `replace-regexp' and `query-replace-regexp-eval'.")

125 126 127
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

128
(defun query-replace-read-from (prompt regexp-flag)
129 130 131
  "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."
132 133
  (if query-replace-interactive
      (car (if regexp-flag regexp-search-ring search-ring))
134
    (let* ((history-add-new-input nil)
135 136 137 138 139 140
	   (prompt
	    (if query-replace-defaults
		(format "%s (default %s -> %s): " prompt
			(query-replace-descr (car query-replace-defaults))
			(query-replace-descr (cdr query-replace-defaults)))
	      (format "%s: " prompt)))
141
	   (from
142 143 144 145
	    ;; 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
146 147 148
	      (if regexp-flag
		  (read-regexp prompt nil query-replace-from-history-variable)
		(read-from-minibuffer
149 150
		 prompt nil nil nil query-replace-from-history-variable
		 (car (if regexp-flag regexp-search-ring search-ring)) t)))))
151
      (if (and (zerop (length from)) query-replace-defaults)
Chong Yidong's avatar
Chong Yidong committed
152 153 154
	  (cons (car query-replace-defaults)
		(query-replace-compile-replacement
		 (cdr query-replace-defaults) regexp-flag))
155
	(add-to-history query-replace-from-history-variable from nil t)
156 157 158 159 160 161 162 163 164 165 166
	;; 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))))
167

David Kastrup's avatar
David Kastrup committed
168 169 170 171 172 173
(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))
174 175 176 177 178 179 180 181 182 183 184 185
      (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)
186 187 188 189 190 191 192
		     (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)
193 194 195
					      (not (= ?\( (aref to 0)))))
				     (eq (string-match " " to (cdr pos))
					 (cdr pos)))
196 197 198
				(1+ (cdr pos))
			      (cdr pos))))
		       (setq to (substring to end)))))
199
	      (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
David Kastrup's avatar
David Kastrup committed
200 201 202 203 204 205
	(setq to (nreverse (delete "" (cons to list))))
	(replace-match-string-symbols to)
	(cons 'replace-eval-replacement
	      (if (cdr to)
		  (cons 'concat to)
		(car to))))
206 207
    to))

David Kastrup's avatar
David Kastrup committed
208

209
(defun query-replace-read-to (from prompt regexp-flag)
David Kastrup's avatar
David Kastrup committed
210 211 212
  "Query and return the `to' argument of a query-replace operation."
  (query-replace-compile-replacement
   (save-excursion
213 214 215 216 217 218
     (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)
219 220
       (setq query-replace-defaults (cons from to))
       to))
David Kastrup's avatar
David Kastrup committed
221 222
   regexp-flag))

223
(defun query-replace-read-args (prompt regexp-flag &optional noerror)
224 225
  (unless noerror
    (barf-if-buffer-read-only))
226
  (let* ((from (query-replace-read-from prompt regexp-flag))
227
	 (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
228
	       (query-replace-read-to from prompt regexp-flag))))
Juri Linkov's avatar
Juri Linkov committed
229 230 231
    (list from to
	  (and current-prefix-arg (not (eq current-prefix-arg '-)))
	  (and current-prefix-arg (eq current-prefix-arg '-)))))
232

Juri Linkov's avatar
Juri Linkov committed
233
(defun query-replace (from-string to-string &optional delimited start end backward)
Roland McGrath's avatar
Roland McGrath committed
234 235 236 237
  "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.

238 239 240
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.

241 242 243 244 245
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.
246

247 248 249 250
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
251
letters.  (Transferring the case pattern means that if the old text
252 253
matched is all caps, or capitalized, then its replacement is upcased
or capitalized.)
254

255 256
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
257
matches using `isearch-filter-predicate'.
258

259 260 261 262
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
263
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Juri Linkov's avatar
Juri Linkov committed
264 265 266
only matches surrounded by word boundaries.  A negative prefix arg means
replace backward.

267
Fourth and fifth arg START and END specify the region to operate on.
268 269

To customize possible responses, change the \"bindings\" in `query-replace-map'."
270 271 272 273
  (interactive
   (let ((common
	  (query-replace-read-args
	   (concat "Query replace"
Juri Linkov's avatar
Juri Linkov committed
274 275 276
		   (if current-prefix-arg
		       (if (eq current-prefix-arg '-) " backward" " word")
		     "")
277 278 279 280 281 282 283 284 285
		   (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
286 287 288
	       (region-end))
	   (nth 3 common))))
  (perform-replace from-string to-string t nil delimited nil nil start end backward))
289

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

Juri Linkov's avatar
Juri Linkov committed
292
(defun query-replace-regexp (regexp to-string &optional delimited start end backward)
Roland McGrath's avatar
Roland McGrath committed
293 294 295 296
  "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.

297 298 299
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.

300 301 302 303 304
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.
305

306 307 308 309 310 311 312
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.)
313

314 315
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
316
matches using `isearch-filter-predicate'.
317

318
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
319 320 321
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
322
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Juri Linkov's avatar
Juri Linkov committed
323 324 325
only matches surrounded by word boundaries.  A negative prefix arg means
replace backward.

326 327
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
328 329
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
330
whatever what matched the Nth `\\(...\\)' in REGEXP.
331 332 333
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

334 335 336 337
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
338
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
339 340 341
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).
342

343 344
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
345 346 347 348

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."
349 350
  (interactive
   (let ((common
351
	  (query-replace-read-args
352
	   (concat "Query replace"
Juri Linkov's avatar
Juri Linkov committed
353 354 355
		   (if current-prefix-arg
		       (if (eq current-prefix-arg '-) " backward" " word")
		     "")
356 357
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
358
	   t)))
359 360 361 362 363 364 365
     (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
366 367 368
	       (region-end))
	   (nth 3 common))))
  (perform-replace regexp to-string t t delimited nil nil start end backward))
369

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

372
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
373
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
374 375 376 377 378

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.

379 380 381 382 383 384 385 386 387
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
388 389
`\\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.
390
Use `\\#&' or `\\#N' if you want a number instead of a string.
391
In interactive use, `\\#' in itself stands for `replace-count'.
392 393 394 395

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.

396 397 398
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP.
399 400 401

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

403 404
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
405
matches using `isearch-filter-predicate'.
406

407
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
408 409 410
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

411
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
412
only matches that are surrounded by word boundaries.
413
Fourth and fifth arg START and END specify the region to operate on."
414 415 416
  (declare (obsolete "use the `\\,' feature of `query-replace-regexp'
for interactive calls, and `search-forward-regexp'/`replace-match'
for Lisp calls." "22.1"))
417
  (interactive
418
   (progn
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
     (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)))
	    (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))))))
438
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
439
		   t 'literal delimited nil nil start end))
440

441
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
442
  "Replace some matches for REGEXP with various strings, in rotation.
443 444 445
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
446 447
wrapping around from the last such string to the first.

448 449 450
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
451 452
Non-interactively, TO-STRINGS may be a list of replacement strings.

453 454 455
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP.
456

Roland McGrath's avatar
Roland McGrath committed
457
A prefix argument N says to use each replacement string N times
458 459
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
460
  (interactive
461 462
   (let* ((from (read-regexp "Map query replace (regexp): " nil
			     query-replace-from-history-variable))
463
	  (to (read-from-minibuffer
464
	       (format "Query replace %s with (space-separated strings): "
465
		       (query-replace-descr from))
466
	       nil nil nil
467
	       query-replace-to-history-variable from t)))
468 469 470
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
471 472 473 474
	   (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
475 476 477 478 479 480 481 482 483 484 485 486 487
  (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 ""))))
488
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
489

Juri Linkov's avatar
Juri Linkov committed
490
(defun replace-string (from-string to-string &optional delimited start end backward)
Roland McGrath's avatar
Roland McGrath committed
491 492 493
  "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.
494 495 496
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

497 498
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
499
matches using `isearch-filter-predicate'.
500

501 502 503 504
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
505
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Juri Linkov's avatar
Juri Linkov committed
506 507
only matches surrounded by word boundaries.  A negative prefix arg means
replace backward.
508 509 510 511 512

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
513

514 515 516
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search string to the minibuffer
that reads FROM-STRING.
517

Roland McGrath's avatar
Roland McGrath committed
518 519
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
520 521
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
522 523 524
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.)"
525 526
  (interactive
   (let ((common
527
	  (query-replace-read-args
528
	   (concat "Replace"
Juri Linkov's avatar
Juri Linkov committed
529 530 531
		   (if current-prefix-arg
		       (if (eq current-prefix-arg '-) " backward" " word")
		     "")
532 533
		   " string"
		   (if (and transient-mark-mode mark-active) " in region" ""))
534
	   nil)))
535 536 537 538
     (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
539 540 541
	       (region-end))
	   (nth 3 common))))
  (perform-replace from-string to-string nil nil delimited nil nil start end backward))
542
(put 'replace-string 'interactive-only
543
     "use `search-forward' and `replace-match' instead.")
Roland McGrath's avatar
Roland McGrath committed
544

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

550 551
Ignore read-only matches if `query-replace-skip-read-only' is non-nil,
ignore hidden matches if `search-invisible' is nil, and ignore more
552
matches using `isearch-filter-predicate'.
553

554
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
555 556 557
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

558 559 560
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
561
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Juri Linkov's avatar
Juri Linkov committed
562 563 564
only matches surrounded by word boundaries.  A negative prefix arg means
replace backward.

565 566
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
567 568
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
569 570 571 572 573 574 575
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
576 577 578
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.
579 580 581 582 583 584 585 586 587 588

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
589

590 591 592
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP.
593

Roland McGrath's avatar
Roland McGrath committed
594 595 596
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
597
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
598
which will run faster and will not set the mark or print anything."
599 600
  (interactive
   (let ((common
601
	  (query-replace-read-args
602
	   (concat "Replace"
Juri Linkov's avatar
Juri Linkov committed
603 604 605
		   (if current-prefix-arg
		       (if (eq current-prefix-arg '-) " backward" " word")
		     "")
606 607
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
608
	   t)))
609 610 611 612
     (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
613 614 615
	       (region-end))
	   (nth 3 common))))
  (perform-replace regexp to-string nil t delimited nil nil start end backward))
616
(put 'replace-regexp 'interactive-only
617
     "use `re-search-forward' and `replace-match' instead.")
618

619 620

(defvar regexp-history nil
621 622 623 624
  "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
625

626 627 628
(defvar occur-collect-regexp-history '("\\1")
  "History of regexp for occur's collect operation")

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
(defcustom read-regexp-defaults-function nil
  "Function that provides default regexp(s) for regexp reading commands.
This function should take no arguments and return one of nil, a
regexp or a list of regexps.  The return value of this function is used
as DEFAULTS param of `read-regexp'.  This function is called only during
interactive use.

If you need different defaults for different commands,
use `this-command' to identify the command under execution.

You can customize `read-regexp-defaults-function' to the value
`find-tag-default-as-regexp' to highlight a symbol at point."
  :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)
	  (function :tag "Function to provide default for read-regexp"))
  :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))))

667 668
(defun read-regexp (prompt &optional defaults history)
  "Read and return a regular expression as a string.
669
When PROMPT doesn't end with a colon and space, it adds a final \": \".
670 671 672 673 674 675 676 677
If the first element of DEFAULTS is non-nil, it's added to the prompt.

Optional arg DEFAULTS has the form (DEFAULT . SUGGESTIONS)
or simply DEFAULT where DEFAULT, if non-nil, should be a string that
is returned as the default value when the user enters empty input.
SUGGESTIONS is a list of strings that can be inserted into
the minibuffer using \\<minibuffer-local-map>\\[next-history-element].  \
The values supplied in SUGGESTIONS
678 679 680
are prepended to the list of standard suggestions returned by
`read-regexp-suggestions'.  The default values can be customized
by `read-regexp-defaults-function'.
681

682
Optional arg HISTORY is a symbol to use for the history list.
683
If HISTORY is nil, `regexp-history' is used."
684 685 686 687 688 689 690 691 692 693
  (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))
694
	 (suggestions (if (listp defaults) defaults (list defaults)))
695
	 (suggestions (append suggestions (read-regexp-suggestions)))
696
	 (suggestions (delete-dups (delq nil (delete "" suggestions))))
697
	 ;; Do not automatically add default to the history for empty input.
Juri Linkov's avatar
Juri Linkov committed
698
	 (history-add-new-input nil)
699 700 701
	 (input (read-from-minibuffer
		 (cond ((string-match-p ":[ \t]*\\'" prompt)
			prompt)
702
		       ((and default (> (length default) 0))
703
			 (format "%s (default %s): " prompt
704
				 (query-replace-descr default)))
705 706
		       (t
			(format "%s: " prompt)))
707
		 nil nil nil (or history 'regexp-history) suggestions t)))
Juri Linkov's avatar
Juri Linkov committed
708
    (if (equal input "")
709
	;; Return the default value when the user enters empty input.
710 711 712
	(prog1 (or default input)
	  (when default
	    (add-to-history (or history 'regexp-history) default)))
713
      ;; Otherwise, add non-empty input to the history and return input.
Juri Linkov's avatar
Juri Linkov committed
714
      (prog1 input
715
	(add-to-history (or history 'regexp-history) input)))))
Juri Linkov's avatar
Juri Linkov committed
716

717

718
(defalias 'delete-non-matching-lines 'keep-lines)
719 720 721 722 723 724 725
(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.
726
Value is a list, (REGEXP)."
727
  (list (read-regexp prompt) nil nil t))
728

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

735 736
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
737 738

Second and third arg RSTART and REND specify the region to operate on.
739 740 741
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.)
742

743
Interactively, in Transient Mark mode when the mark is active, operate
744 745 746 747 748 749 750 751
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."
752

753
  (interactive
754 755
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
756
     (keep-lines-read-args "Keep lines containing match for regexp")))
757
  (if rstart
758 759
      (progn
	(goto-char (min rstart rend))
760 761 762 763 764 765 766 767
	(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)
768
	(setq rstart (region-beginning)
769 770 771 772 773
	      rend (progn
		     (goto-char (region-end))
		     (unless (or (bolp) (eobp))
		       (forward-line 0))
		     (point-marker)))
774 775 776
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
777 778
  (save-excursion
    (or (bolp) (forward-line 1))
779
    (let ((start (point))
780 781 782 783
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
784
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
785
	;; Start is first char not preserved by previous match.
786 787
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
788
	  (let ((end (save-excursion (goto-char (match-beginning 0))
789
				     (forward-line 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
790 791 792 793
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
794

795
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
796
	;; If the match was empty, avoid matching again at same place.
797 798
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
799 800 801
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
802

803

804 805 806 807 808 809
(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.
810

811 812
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
813 814

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

818 819
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
820 821 822 823 824 825 826
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."
827

828
  (interactive
829 830
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
831
     (keep-lines-read-args "Flush lines containing match for regexp")))
832
  (if rstart
833 834 835
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
836
    (if (and interactive transient-mark-mode mark-active)
837 838 839 840 841
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
842 843 844 845
  (let ((case-fold-search
	 (if (and case-fold-search search-upper-case)
	     (isearch-no-upper-case-p regexp t)
	   case-fold-search)))
846
    (save-excursion
847 848
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
849
	(delete-region (save-excursion (goto-char (match-beginning 0))
850
				       (forward-line 0)
851
				       (point))
852 853 854
		       (progn (forward-line 1) (point))))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
855

856

857 858 859 860
(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
861
in all respects as if it had been called interactively.
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 867

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

868 869
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
870 871 872 873 874
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."
875

876
  (interactive
Juri Linkov's avatar
Juri Linkov committed
877
   (keep-lines-read-args "How many matches for regexp"))
878 879
  (save-excursion
    (if rstart