replace.el 83.6 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-2013 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))))
229
    (list from to current-prefix-arg)))
230

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

236 237 238
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.

239 240 241 242 243
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.
244

245 246 247 248 249 250 251
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.)
252

253 254 255 256
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
257
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
258
only matches surrounded by word boundaries.
259
Fourth and fifth arg START and END specify the region to operate on.
260 261

To customize possible responses, change the \"bindings\" in `query-replace-map'."
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
  (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)))))
277
  (perform-replace from-string to-string t nil delimited nil nil start end))
278

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

281
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
282 283 284 285
  "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.

286 287 288
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.

289 290 291 292 293
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.
294

295 296 297 298 299 300 301
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.)
302

303
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
304 305 306
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
307
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
308
only matches surrounded by word boundaries.
309 310
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
311 312
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
313
whatever what matched the Nth `\\(...\\)' in REGEXP.
314 315 316
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

317 318 319 320
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
321
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
322 323 324
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).
325

326 327
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
328 329 330 331

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."
332 333
  (interactive
   (let ((common
334
	  (query-replace-read-args
335 336 337 338
	   (concat "Query replace"
		   (if current-prefix-arg " word" "")
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
339
	   t)))
340 341 342 343 344 345 346 347
     (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)))))
348
  (perform-replace regexp to-string t t delimited nil nil start end))
349

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

352
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
353
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
354 355 356 357 358

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.

359 360 361 362 363 364 365 366 367
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
368 369
`\\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.
370
Use `\\#&' or `\\#N' if you want a number instead of a string.
371
In interactive use, `\\#' in itself stands for `replace-count'.
372 373 374 375

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.

376 377 378
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP.
379 380 381

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

383
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
384 385 386
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

387
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
388
only matches that are surrounded by word boundaries.
389
Fourth and fifth arg START and END specify the region to operate on."
390 391 392
  (declare (obsolete "use the `\\,' feature of `query-replace-regexp'
for interactive calls, and `search-forward-regexp'/`replace-match'
for Lisp calls." "22.1"))
393
  (interactive
394
   (progn
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
     (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))))))
414
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
415
		   t 'literal delimited nil nil start end))
416

417
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
418
  "Replace some matches for REGEXP with various strings, in rotation.
419 420 421
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
422 423
wrapping around from the last such string to the first.

424 425 426
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
427 428
Non-interactively, TO-STRINGS may be a list of replacement strings.

429 430 431
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP.
432

Roland McGrath's avatar
Roland McGrath committed
433
A prefix argument N says to use each replacement string N times
434 435
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
436
  (interactive
437 438
   (let* ((from (read-regexp "Map query replace (regexp): " nil
			     query-replace-from-history-variable))
439
	  (to (read-from-minibuffer
440
	       (format "Query replace %s with (space-separated strings): "
441
		       (query-replace-descr from))
442
	       nil nil nil
443
	       query-replace-to-history-variable from t)))
444 445 446
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
447 448 449 450
	   (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
451 452 453 454 455 456 457 458 459 460 461 462 463
  (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 ""))))
464
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
465

466
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
467 468 469
  "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.
470 471 472
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

473 474 475 476
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'.

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

484 485 486
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search string to the minibuffer
that reads FROM-STRING.
487

Roland McGrath's avatar
Roland McGrath committed
488 489
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
490 491
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
492 493 494
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.)"
495 496
  (interactive
   (let ((common
497
	  (query-replace-read-args
498 499 500 501
	   (concat "Replace"
		   (if current-prefix-arg " word" "")
		   " string"
		   (if (and transient-mark-mode mark-active) " in region" ""))
502
	   nil)))
503 504 505 506 507
     (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)))))
508
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
509

510
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
511
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
512
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
513
are non-nil and REGEXP has no uppercase letters.
514

515
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
516 517 518
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

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

Richard M. Stallman's avatar
Richard M. Stallman committed
526 527
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
528 529 530 531 532 533 534
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
535 536 537
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.
538 539 540 541 542 543 544 545 546 547

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
548

549 550 551
Use \\<minibuffer-local-map>\\[next-history-element] \
to pull the last incremental search regexp to the minibuffer
that reads REGEXP.
552

Roland McGrath's avatar
Roland McGrath committed
553 554 555
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
556
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
557
which will run faster and will not set the mark or print anything."
558 559
  (interactive
   (let ((common
560
	  (query-replace-read-args
561 562 563 564
	   (concat "Replace"
		   (if current-prefix-arg " word" "")
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
565
	   t)))
566 567 568 569 570
     (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)))))
571
  (perform-replace regexp to-string nil t delimited nil nil start end))
572

573 574

(defvar regexp-history nil
575 576 577 578
  "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
579

580 581 582
(defvar occur-collect-regexp-history '("\\1")
  "History of regexp for occur's collect operation")

583 584
(defun read-regexp (prompt &optional defaults history)
  "Read and return a regular expression as a string.
585
When PROMPT doesn't end with a colon and space, it adds a final \": \".
586 587
If DEFAULTS is non-nil, it displays the first default in the prompt.

588 589 590 591
Optional arg DEFAULTS is a string or a list of strings that are
prepended to a list of standard default values, which include the
tag at point, the last isearch regexp, the last isearch string,
and the last replacement regexp.
592 593 594

Non-nil HISTORY is a symbol to use for the history list.
If HISTORY is nil, `regexp-history' is used."
595
  (let* ((defaults
596 597
	   (append
	    (if (listp defaults) defaults (list defaults))
598 599 600
	    (list
	     ;; Regexp for tag at point.
	     (let* ((tagf (or find-tag-default-function
601 602
				    (get major-mode 'find-tag-default-function)
				    'find-tag-default))
603 604 605 606 607
		    (tag (funcall tagf)))
	       (cond ((not tag) "")
		     ((eq tagf 'find-tag-default)
		      (format "\\_<%s\\_>" (regexp-quote tag)))
		     (t (regexp-quote tag))))
608 609 610 611
		  (car regexp-search-ring)
		  (regexp-quote (or (car search-ring) ""))
		  (car (symbol-value
			query-replace-from-history-variable)))))
Juri Linkov's avatar
Juri Linkov committed
612
	 (defaults (delete-dups (delq nil (delete "" defaults))))
613
	 (default (car defaults))
614
	 ;; Do not automatically add default to the history for empty input.
Juri Linkov's avatar
Juri Linkov committed
615
	 (history-add-new-input nil)
616 617 618
	 (input (read-from-minibuffer
		 (cond ((string-match-p ":[ \t]*\\'" prompt)
			prompt)
619
		       (default
620
			 (format "%s (default %s): " prompt
621
				 (query-replace-descr default)))
622 623
		       (t
			(format "%s: " prompt)))
624
		 nil nil nil (or history 'regexp-history) defaults t)))
Juri Linkov's avatar
Juri Linkov committed
625
    (if (equal input "")
626
	(or default input)
Juri Linkov's avatar
Juri Linkov committed
627
      (prog1 input
628
	(add-to-history (or history 'regexp-history) input)))))
Juri Linkov's avatar
Juri Linkov committed
629

630

631
(defalias 'delete-non-matching-lines 'keep-lines)
632 633 634 635 636 637 638
(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.
639
Value is a list, (REGEXP)."
640
  (list (read-regexp prompt) nil nil t))
641

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

648 649
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
650 651

Second and third arg RSTART and REND specify the region to operate on.
652 653 654
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.)
655

656
Interactively, in Transient Mark mode when the mark is active, operate
657 658 659 660 661 662 663 664
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."
665

666
  (interactive
667 668
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
669
     (keep-lines-read-args "Keep lines containing match for regexp")))
670
  (if rstart
671 672
      (progn
	(goto-char (min rstart rend))
673 674 675 676 677 678 679 680
	(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)
681
	(setq rstart (region-beginning)
682 683 684 685 686
	      rend (progn
		     (goto-char (region-end))
		     (unless (or (bolp) (eobp))
		       (forward-line 0))
		     (point-marker)))
687 688 689
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
690 691
  (save-excursion
    (or (bolp) (forward-line 1))
692
    (let ((start (point))
693 694 695 696
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
697
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
698
	;; Start is first char not preserved by previous match.
699 700
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
701
	  (let ((end (save-excursion (goto-char (match-beginning 0))
702
				     (forward-line 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
703 704 705 706
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
707

708
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
709
	;; If the match was empty, avoid matching again at same place.
710 711
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
712 713 714
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
715

716

717 718 719 720 721 722
(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.
723

724 725
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
726 727

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

731 732
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
733 734 735 736 737 738 739
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."
740

741
  (interactive
742 743
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
744
     (keep-lines-read-args "Flush lines containing match for regexp")))
745
  (if rstart
746 747 748
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
749
    (if (and interactive transient-mark-mode mark-active)
750 751 752 753 754
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
755 756 757 758
  (let ((case-fold-search
	 (if (and case-fold-search search-upper-case)
	     (isearch-no-upper-case-p regexp t)
	   case-fold-search)))
759
    (save-excursion
760 761
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
762
	(delete-region (save-excursion (goto-char (match-beginning 0))
763
				       (forward-line 0)
764
				       (point))
765 766 767
		       (progn (forward-line 1) (point))))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
768

769

770 771 772 773
(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
774
in all respects as if it had been called interactively.
775

776 777
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
778 779 780

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

781 782
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
783 784 785 786 787
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."
788

789
  (interactive
Juri Linkov's avatar
Juri Linkov committed
790
   (keep-lines-read-args "How many matches for regexp"))
791 792
  (save-excursion
    (if rstart
793 794 795 796
	(progn
	  (goto-char (min rstart rend))
	  (setq rend (max rstart rend)))
      (if (and interactive transient-mark-mode mark-active)
797
	  (setq rstart (region-beginning)
798
		rend (region-end))
799
	(setq rstart (point)
800
	      rend (point-max)))
801
      (goto-char rstart))
802 803
    (let ((count 0)
	  opoint
804 805 806 807
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
808 809 810 811 812 813
      (while (and (< (point) rend)
		  (progn (setq opoint (point))
			 (re-search-forward regexp rend t)))
	(if (= opoint (point))
	    (forward-char 1)
	  (setq count (1+ count))))
814 815 816 817
      (when interactive (message "%d occurrence%s"
				 count
				 (if (= count 1) "" "s")))
      count)))
818

819

Leo Liu's avatar
Leo Liu committed
820
(defvar occur-menu-map
821
  (let ((map (make-sparse-keymap)))
822 823
    (bindings--define-key map [next-error-follow-minor-mode]
      '(menu-item "Auto Occurrence Display"
824
		  next-error-follow-minor-mode
825
		  :help "Display another occurrence when moving the cursor"
826 827
		  :button (:toggle . (and (boundp 'next-error-follow-minor-mode)
					  next-error-follow-minor-mode))))
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
    (bindings--define-key map [separator-1] menu-bar-separator)
    (bindings--define-key map [kill-this-buffer]
      '(menu-item "Kill Occur Buffer" kill-this-buffer
		  :help "Kill the current *Occur* buffer"))
    (bindings--define-key map [quit-window]
      '(menu-item "Quit Occur Window" quit-window
		  :help "Quit the current *Occur* buffer.  Bury it, and maybe delete the selected frame"))
    (bindings--define-key map [revert-buffer]
      '(menu-item "Revert Occur Buffer" revert-buffer
		  :help "Replace the text in the *Occur* buffer with the results of rerunning occur"))
    (bindings--define-key map [clone-buffer]
      '(menu-item "Clone Occur Buffer" clone-buffer
		  :help "Create and return a twin copy of the current *Occur* buffer"))
    (bindings--define-key map [occur-rename-buffer]
      '(menu-item "Rename Occur Buffer" occur-rename-buffer
		  :help "Rename the current *Occur* buffer to *Occur: original-buffer-name*."))
    (bindings--define-key map [occur-edit-buffer]
      '(menu-item "Edit Occur Buffer" occur-edit-mode
		  :help "Edit the *Occur* buffer and apply changes to the original buffers."))
    (bindings--define-key map [separator-2] menu-bar-separator)
    (bindings--define-key map [occur-mode-goto-occurrence-other-window]
      '(menu-item "Go To Occurrence Other Window" occur-mode-goto-occurrence-other-window
		  :help "Go to the occurrence the current line describes, in another window"))
    (bindings--define-key map [occur-mode-goto-occurrence]
      '(menu-item "Go To Occurrence" occur-mode-goto-occurrence
		  :help "Go to the occurrence the current line describes"))
    (bindings--define-key map [occur-mode-display-occurrence]
      '(menu-item "Display Occurrence" occur-mode-display-occurrence
		  :help "Display in another window the occurrence the current line describes"))
    (bindings--define-key map [occur-next]
      '(menu-item "Move to Next Match" occur-next
		  :help "Move to the Nth (default 1) next match in an Occur mode buffer"))
    (bindings--define-key map [occur-prev]
      '(menu-item "Move to Previous Match" occur-prev
		  :help "Move to the Nth (default 1) previous match in an Occur mode buffer"))
863
    map)
Leo Liu's avatar
Leo Liu committed
864 865 866 867 868 869 870
  "Menu keymap for `occur-mode'.")

(defvar occur-mode-map
  (let ((map (make-sparse-keymap)))
    ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
    (define-key map [mouse-2] 'occur-mode-mouse-goto)
    (define-key map "\C-c\C-c" 'occur-mode-goto-occurrence)
871
    (define-key map "e" 'occur-edit-mode)
Leo Liu's avatar
Leo Liu committed
872 873 874 875 876 877 878 879
    (define-key map "\C-m" 'occur-mode-goto-occurrence)
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
    (define-key map "\C-o" 'occur-mode-display-occurrence)
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
880
    (bindings--define-key map [menu-bar occur] (cons "Occur" occur-menu-map))
Leo Liu's avatar
Leo Liu committed
881
    map)
882
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
883

884 885 886
(defvar occur-revert-arguments nil
  "Arguments to pass to `occur-1' to revert an Occur mode buffer.
See `occur-revert-function'.")
Leo Liu's avatar
Leo Liu committed
887 888
(make-variable-buffer-local 'occur-revert-arguments)
(put 'occur-revert-arguments 'permanent-local t)