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

3
;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2012
4
;;   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 38 39
(defvar query-replace-history nil
  "Default history list for query-replace commands.
See `query-replace-from-history-variable' and
`query-replace-to-history-variable'.")
40

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

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

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

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

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

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

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

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

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

101 102 103 104
(defvar replace-count 0
  "Number of replacements done so far.
See `replace-regexp' and `query-replace-regexp-eval'.")

105 106 107
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

108
(defun query-replace-read-from (prompt regexp-flag)
109 110 111
  "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."
112 113
  (if query-replace-interactive
      (car (if regexp-flag regexp-search-ring search-ring))
114 115
    (let* ((history-add-new-input nil)
	   (from
116 117 118 119 120
	    ;; The save-excursion here is in case the user marks and copies
	    ;; a region in order to specify the minibuffer input.
	    ;; That should not clobber the region for the query-replace itself.
	    (save-excursion
	      (read-from-minibuffer
121
	       (if query-replace-defaults
122
		   (format "%s (default %s -> %s): " prompt
123 124
			   (query-replace-descr (car query-replace-defaults))
			   (query-replace-descr (cdr query-replace-defaults)))
125
		 (format "%s: " prompt))
126 127
	       nil nil nil
	       query-replace-from-history-variable
128
	       nil t))))
129
      (if (and (zerop (length from)) query-replace-defaults)
Chong Yidong's avatar
Chong Yidong committed
130 131 132
	  (cons (car query-replace-defaults)
		(query-replace-compile-replacement
		 (cdr query-replace-defaults) regexp-flag))
133
	(add-to-history query-replace-from-history-variable from nil t)
134 135 136 137 138 139 140 141 142 143 144
	;; 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))))
145

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

David Kastrup's avatar
David Kastrup committed
186

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

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

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

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

217 218 219 220
If `query-replace-interactive' is non-nil, the last incremental search
string is used as FROM-STRING--you don't have to specify it with the
minibuffer.

221 222 223 224 225 226 227
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.)
228

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

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

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

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

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

261 262 263 264
If `query-replace-interactive' is non-nil, the last incremental search
regexp is used as REGEXP--you don't have to specify it with the
minibuffer.

265 266 267 268 269 270 271
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.)
272

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

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

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

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

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

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

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

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.

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

In Transient Mark mode, if the mark is active, operate on the contents
of the region.  Otherwise, operate from point to the end of the buffer.

If `query-replace-interactive' is non-nil, the last incremental search
regexp is used as REGEXP--you don't have to specify it with the
minibuffer.

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

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

376 377 378 379 380
(make-obsolete 'query-replace-regexp-eval
  "for interactive use, use the special `\\,' feature of
`query-replace-regexp' instead.  Non-interactively, a loop
using `search-forward-regexp' and `replace-match' is preferred." "22.1")

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

388 389 390
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
391 392
Non-interactively, TO-STRINGS may be a list of replacement strings.

393 394 395
If `query-replace-interactive' is non-nil, the last incremental search
regexp is used as REGEXP--you don't have to specify it with the minibuffer.

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

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

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

447 448 449 450
If `query-replace-interactive' is non-nil, the last incremental search
string is used as FROM-STRING--you don't have to specify it with the
minibuffer.

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

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

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

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

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
507

508 509 510
If `query-replace-interactive' is non-nil, the last incremental search
regexp is used as REGEXP--you don't have to specify it with the minibuffer.

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

531 532

(defvar regexp-history nil
533 534 535 536
  "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
537

538 539 540
(defvar occur-collect-regexp-history '("\\1")
  "History of regexp for occur's collect operation")

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

574

575
(defalias 'delete-non-matching-lines 'keep-lines)
576 577 578 579 580 581 582
(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.
583
Value is a list, (REGEXP)."
584
  (list (read-regexp prompt) nil nil t))
585

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

592 593
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
594 595

Second and third arg RSTART and REND specify the region to operate on.
596 597 598
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.)
599

600
Interactively, in Transient Mark mode when the mark is active, operate
601 602 603 604 605 606 607 608
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."
609

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

652
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
653
	;; If the match was empty, avoid matching again at same place.
654 655
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
656 657 658
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
659

660

661 662 663 664 665 666
(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.
667

668 669
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
670 671

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

675 676
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
677 678 679 680 681 682 683
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."
684

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

713

714 715 716 717
(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
718
in all respects as if it had been called interactively.
719

720 721
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
722 723 724

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

725 726
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
727 728 729 730 731
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."
732

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

763

Leo Liu's avatar
Leo Liu committed
764
(defvar occur-menu-map
765
  (let ((map (make-sparse-keymap)))
766 767
    (bindings--define-key map [next-error-follow-minor-mode]
      '(menu-item "Auto Occurrence Display"
768
		  next-error-follow-minor-mode
769
		  :help "Display another occurrence when moving the cursor"
770 771
		  :button (:toggle . (and (boundp 'next-error-follow-minor-mode)
					  next-error-follow-minor-mode))))
772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
    (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"))
807
    map)
Leo Liu's avatar
Leo Liu committed
808 809 810 811 812 813 814
  "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)
815
    (define-key map "e" 'occur-edit-mode)
Leo Liu's avatar
Leo Liu committed
816 817 818 819 820 821 822 823
    (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)
824
    (bindings--define-key map [menu-bar occur] (cons "Occur" occur-menu-map))
Leo Liu's avatar
Leo Liu committed
825
    map)
826
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
827

828 829 830
(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
831 832
(make-variable-buffer-local 'occur-revert-arguments)
(put 'occur-revert-arguments 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
833

834 835 836 837 838 839
(defcustom occur-mode-hook '(turn-on-font-lock)
  "Hook run when entering Occur mode."
  :type 'hook
  :group 'matching)

(defcustom occur-hook nil
Juanma Barranquero's avatar
Juanma Barranquero committed
840
  "Hook run by Occur when there are any matches."
841 842 843
  :type 'hook
  :group 'matching)

844 845 846 847 848 849 850
(defcustom occur-mode-find-occurrence-hook nil
  "Hook run by Occur after locating an occurrence.
This will be called with the cursor position at the occurrence.  An application
for this is to reveal context in an outline-mode when the occurrence is hidden."
  :type 'hook
  :group 'matching)

851
(put 'occur-mode 'mode-class 'special)
852
(define-derived-mode occur-mode special-mode "Occur"
Richard M. Stallman's avatar
Richard M. Stallman committed
853
  "Major mode for output from \\[occur].
854 855 856 857
\\<occur-mode-map>Move point to one of the items in this buffer, then use
\\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to.
Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it.

Richard M. Stallman's avatar
Richard M. Stallman committed
858
\\{occur-mode-map}"
859
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
860 861
  (setq next-error-function 'occur-next-error))

Leo Liu's avatar
Leo Liu committed
862 863 864 865 866 867 868

;;; Occur Edit mode

(defvar occur-edit-mode-map
  (let ((map (make-sparse-keymap)))
    (set-keymap-parent map text-mode-map)
    (define-key map [mouse-2] 'occur-mode-mouse-goto)
869 870
    (define-key map "\C-c\C-c" 'occur-cease-edit)
    (define-key map "\C-o" 'occur-mode-display-occurrence)
Leo Liu's avatar
Leo Liu committed
871
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
872
    (bindings--define-key map [menu-bar occur] (cons "Occur" occur-menu-map))
Leo Liu's avatar
Leo Liu committed
873 874 875 876 877 878 879 880
    map)
  "Keymap for `occur-edit-mode'.")

(define-derived-mode occur-edit-mode occur-mode "Occur-Edit"
  "Major mode for editing *Occur* buffers.
In this mode, changes to the *Occur* buffer are also applied to
the originating buffer.

Leo Liu's avatar
Leo Liu committed
881
To return to ordinary Occur mode, use \\[occur-cease-edit]."
Leo Liu's avatar
Leo Liu committed
882
  (setq buffer-read-only nil)
883 884 885 886 887 888 889 890 891 892
  (add-hook 'after-change-functions 'occur-after-change-function nil t)
  (message (substitute-command-keys
	    "Editing: Type \\[occur-cease-edit] to return to Occur mode.")))

(defun occur-cease-edit ()
  "Switch from Occur Edit mode to Occur mode."
  (interactive)
  (when (derived-mode-p 'occur-edit-mode)
    (occur-mode)
    (message "Switching to Occur mode.")))
Leo Liu's avatar
Leo Liu committed
893 894 895 896

(defun occur-after-change-function (beg end length)
  (save-excursion
    (goto-char beg)
897 898
    (let* ((line-beg (line-beginning-position))
	   (m (get-text-property line-beg 'occur-target))
Leo Liu's avatar
Leo Liu committed
899
	   (buf (marker-buffer m))
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
	   col)
      (when (and (get-text-property line-beg 'occur-prefix)
		 (not (get-text-property end 'occur-prefix)))
	(when (= length 0)
	  ;; Apply occur-target property to inserted (e.g. yanked) text.
	  (put-text-property beg end 'occur-target m)
	  ;; Did we insert a newline?  Occur Edit mode can't create new
	  ;; Occur entries; just discard everything after the newline.
	  (save-excursion
	    (and (search-forward "\n" end t)
		 (delete-region (1- (point)) end))))
	(let* ((line (- (line-number-at-pos)
			(line-number-at-pos (window-start))))
	       (readonly (with-current-buffer buf buffer-read-only))
	       (win (or (get-buffer-window buf)
915 916 917
			(display-buffer buf
					'(nil (inhibit-same-window . t)
					      (inhibit-switch-frame . t)))))
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
	       (line-end (line-end-position))
	       (text (save-excursion
		       (goto-char (next-single-property-change
				   line-beg 'occur-prefix nil
				   line-end))
		       (setq col (- (point) line-beg))
		       (buffer-substring-no-properties (point) line-end))))
	  (with-selected-window win
	    (goto-char m)
	    (recenter line)
	    (if readonly
		(message "Buffer `%s' is read only." buf)
	      (delete-region (line-beginning-position) (line-end-position))
	      (insert text))
	    (move-to-column col)))))))
Leo Liu's avatar
Leo Liu committed
933 934


935
(defun occur-revert-function (_ignore1 _ignore2)
936
  "Handle `revert-buffer' for Occur mode buffers."
937
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))