replace.el 81.8 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 40 41 42 43
(defcustom replace-lax-whitespace nil
  "Non-nil means `query-replace' matches a sequence of whitespace chars.
When you enter a space or spaces in the strings or regexps to be replaced,
it will match any sequence matched by the regexp `search-whitespace-regexp'."
  :type 'boolean
  :group 'matching
  :version "24.3")

44 45 46 47
(defvar query-replace-history nil
  "Default history list for query-replace commands.
See `query-replace-from-history-variable' and
`query-replace-to-history-variable'.")
48

49 50 51 52 53
(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.")

54
(defvar query-replace-interactive nil
55
  "Non-nil means `query-replace' uses the last search string.
56
That becomes the \"string to replace\".")
57

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

(defcustom query-replace-to-history-variable 'query-replace-history
68
  "History list to use for the TO argument of `query-replace' commands.
69 70 71 72
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
73 74
  :type 'symbol
  :version "20.3")
75

76
(defcustom query-replace-skip-read-only nil
Lute Kamstra's avatar
Lute Kamstra committed
77
  "Non-nil means `query-replace' and friends ignore read-only matches."
78 79
  :type 'boolean
  :group 'matching
80
  :version "22.1")
81

82
(defcustom query-replace-show-replacement t
Lute Kamstra's avatar
Lute Kamstra committed
83
  "Non-nil means to show what actual replacement text will be."
84 85 86 87
  :type 'boolean
  :group 'matching
  :version "23.1")

88
(defcustom query-replace-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
89
  "Non-nil means to highlight matches during query replacement."
90 91 92 93
  :type 'boolean
  :group 'matching)

(defcustom query-replace-lazy-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
94
  "Controls the lazy-highlighting during query replacements.
95 96 97 98 99 100
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
101
  :version "22.1")
102 103 104 105 106

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

109 110 111 112
(defvar replace-count 0
  "Number of replacements done so far.
See `replace-regexp' and `query-replace-regexp-eval'.")

113 114 115
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

116
(defun query-replace-read-from (prompt regexp-flag)
117 118 119
  "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."
120 121
  (if query-replace-interactive
      (car (if regexp-flag regexp-search-ring search-ring))
122 123
    (let* ((history-add-new-input nil)
	   (from
124 125 126 127 128
	    ;; 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
129
	       (if query-replace-defaults
130
		   (format "%s (default %s -> %s): " prompt
131 132
			   (query-replace-descr (car query-replace-defaults))
			   (query-replace-descr (cdr query-replace-defaults)))
133
		 (format "%s: " prompt))
134 135
	       nil nil nil
	       query-replace-from-history-variable
136
	       nil t))))
137
      (if (and (zerop (length from)) query-replace-defaults)
Chong Yidong's avatar
Chong Yidong committed
138 139 140
	  (cons (car query-replace-defaults)
		(query-replace-compile-replacement
		 (cdr query-replace-defaults) regexp-flag))
141
	(add-to-history query-replace-from-history-variable from nil t)
142 143 144 145 146 147 148 149 150 151 152
	;; 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))))
153

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

David Kastrup's avatar
David Kastrup committed
194

195
(defun query-replace-read-to (from prompt regexp-flag)
David Kastrup's avatar
David Kastrup committed
196 197 198
  "Query and return the `to' argument of a query-replace operation."
  (query-replace-compile-replacement
   (save-excursion
199 200 201 202 203 204
     (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)
205 206
       (setq query-replace-defaults (cons from to))
       to))
David Kastrup's avatar
David Kastrup committed
207 208
   regexp-flag))

209
(defun query-replace-read-args (prompt regexp-flag &optional noerror)
210 211
  (unless noerror
    (barf-if-buffer-read-only))
212
  (let* ((from (query-replace-read-from prompt regexp-flag))
213
	 (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
214
	       (query-replace-read-to from prompt regexp-flag))))
215
    (list from to current-prefix-arg)))
216

217
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
218 219 220 221
  "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.

222 223 224
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.

225 226 227 228
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.

229 230 231 232 233 234 235
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.)
236

237 238 239 240
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
241
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
242
only matches surrounded by word boundaries.
243
Fourth and fifth arg START and END specify the region to operate on.
244 245

To customize possible responses, change the \"bindings\" in `query-replace-map'."
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
  (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)))))
261
  (perform-replace from-string to-string t nil delimited nil nil start end))
262

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

265
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
266 267 268 269
  "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.

270 271 272
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.

273 274 275 276
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.

277 278 279 280 281 282 283
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.)
284

285 286 287 288
If `replace-lax-whitespace' is non-nil, a space or spaces in the regexp
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
289
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
290
only matches surrounded by word boundaries.
291 292
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
293 294
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
295
whatever what matched the Nth `\\(...\\)' in REGEXP.
296 297 298
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

299 300 301 302
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
303
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
304 305 306
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).
307

308 309
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
310 311 312 313

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."
314 315
  (interactive
   (let ((common
316
	  (query-replace-read-args
317 318 319 320
	   (concat "Query replace"
		   (if current-prefix-arg " word" "")
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
321
	   t)))
322 323 324 325 326 327 328 329
     (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)))))
330
  (perform-replace regexp to-string t t delimited nil nil start end))
331

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

334
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
335
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
336 337 338 339 340

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.

341 342 343 344 345 346 347 348 349
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
350 351
`\\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.
352
Use `\\#&' or `\\#N' if you want a number instead of a string.
353
In interactive use, `\\#' in itself stands for `replace-count'.
354 355 356 357 358 359 360 361 362 363

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

365 366 367 368
If `replace-lax-whitespace' is non-nil, a space or spaces in the regexp
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

369
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
370
only matches that are surrounded by word boundaries.
371
Fourth and fifth arg START and END specify the region to operate on."
372
  (interactive
373
   (progn
374 375 376 377 378 379 380
   (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)))
381
	  (to (list (read-from-minibuffer
382 383
		     (format "Query replace regexp %s with eval: "
			     (query-replace-descr from))
384
		     nil nil t query-replace-to-history-variable from t))))
385 386 387
     ;; 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)
388 389 390 391
     (list from (car to) current-prefix-arg
	   (if (and transient-mark-mode mark-active)
	       (region-beginning))
	   (if (and transient-mark-mode mark-active)
392
	       (region-end))))))
393
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
394
		   t 'literal delimited nil nil start end))
395

396 397 398 399 400
(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")

401
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
402
  "Replace some matches for REGEXP with various strings, in rotation.
403 404 405
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
406 407
wrapping around from the last such string to the first.

408 409 410
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
411 412
Non-interactively, TO-STRINGS may be a list of replacement strings.

413 414 415
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
416
A prefix argument N says to use each replacement string N times
417 418
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
419
  (interactive
420
   (let* ((from (if query-replace-interactive
421 422 423
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
424 425
					query-replace-from-history-variable
					nil t)))
426
	  (to (read-from-minibuffer
427
	       (format "Query replace %s with (space-separated strings): "
428
		       (query-replace-descr from))
429
	       nil nil nil
430
	       query-replace-to-history-variable from t)))
431 432 433
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
434 435 436 437
	   (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
438 439 440 441 442 443 444 445 446 447 448 449 450
  (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 ""))))
451
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
452

453
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
454 455 456
  "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.
457 458 459
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

460 461 462 463
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'.

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

471 472 473 474
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
475 476
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
477 478
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
479 480 481
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.)"
482 483
  (interactive
   (let ((common
484
	  (query-replace-read-args
485 486 487 488
	   (concat "Replace"
		   (if current-prefix-arg " word" "")
		   " string"
		   (if (and transient-mark-mode mark-active) " in region" ""))
489
	   nil)))
490 491 492 493 494
     (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)))))
495
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
496

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

502 503 504 505
If `replace-lax-whitespace' is non-nil, a space or spaces in the regexp
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

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

Richard M. Stallman's avatar
Richard M. Stallman committed
513 514
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
515 516 517 518 519 520 521
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
522 523 524
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.
525 526 527 528 529 530 531 532 533 534

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
535

536 537 538
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
539 540 541
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
542
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
543
which will run faster and will not set the mark or print anything."
544 545
  (interactive
   (let ((common
546
	  (query-replace-read-args
547 548 549 550
	   (concat "Replace"
		   (if current-prefix-arg " word" "")
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
551
	   t)))
552 553 554 555 556
     (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)))))
557
  (perform-replace regexp to-string nil t delimited nil nil start end))
558

559 560

(defvar regexp-history nil
561 562 563 564
  "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
565

566 567 568
(defvar occur-collect-regexp-history '("\\1")
  "History of regexp for occur's collect operation")

569
(defun read-regexp (prompt &optional default-value)
Juri Linkov's avatar
Juri Linkov committed
570
  "Read regexp as a string using the regexp history and some useful defaults.
571
Prompt for a regular expression with PROMPT (without a colon and
572 573 574 575 576
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."
577
  (let* ((defaults
Juri Linkov's avatar
Juri Linkov committed
578 579 580 581 582 583 584 585 586 587 588 589 590 591
	   (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
592 593 594
	   (if default-value
	       (format "%s (default %s): " prompt
		       (query-replace-descr default-value))
Juri Linkov's avatar
Juri Linkov committed
595 596 597
	     (format "%s: " prompt))
	   nil nil nil 'regexp-history defaults t)))
    (if (equal input "")
598
	(or default-value input)
Juri Linkov's avatar
Juri Linkov committed
599 600 601
      (prog1 input
	(add-to-history 'regexp-history input)))))

602

603
(defalias 'delete-non-matching-lines 'keep-lines)
604 605 606 607 608 609 610
(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.
611
Value is a list, (REGEXP)."
612
  (list (read-regexp prompt) nil nil t))
613

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

620 621
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
622 623

Second and third arg RSTART and REND specify the region to operate on.
624 625 626
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.)
627

628
Interactively, in Transient Mark mode when the mark is active, operate
629 630 631 632 633 634 635 636
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."
637

638
  (interactive
639 640
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
641
     (keep-lines-read-args "Keep lines containing match for regexp")))
642
  (if rstart
643 644
      (progn
	(goto-char (min rstart rend))
645 646 647 648 649 650 651 652
	(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)
653
	(setq rstart (region-beginning)
654 655 656 657 658
	      rend (progn
		     (goto-char (region-end))
		     (unless (or (bolp) (eobp))
		       (forward-line 0))
		     (point-marker)))
659 660 661
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
662 663
  (save-excursion
    (or (bolp) (forward-line 1))
664
    (let ((start (point))
665 666 667 668
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
669
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
670
	;; Start is first char not preserved by previous match.
671 672
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
673
	  (let ((end (save-excursion (goto-char (match-beginning 0))
674
				     (forward-line 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
675 676 677 678
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
679

680
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
681
	;; If the match was empty, avoid matching again at same place.
682 683
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
684 685 686
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
687

688

689 690 691 692 693 694
(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.
695

696 697
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
698 699

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

703 704
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
705 706 707 708 709 710 711
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."
712

713
  (interactive
714 715
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
716
     (keep-lines-read-args "Flush lines containing match for regexp")))
717
  (if rstart
718 719 720
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
721
    (if (and interactive transient-mark-mode mark-active)
722 723 724 725 726
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
727 728 729 730
  (let ((case-fold-search
	 (if (and case-fold-search search-upper-case)
	     (isearch-no-upper-case-p regexp t)
	   case-fold-search)))
731
    (save-excursion
732 733
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
734
	(delete-region (save-excursion (goto-char (match-beginning 0))
735
				       (forward-line 0)
736
				       (point))
737 738 739
		       (progn (forward-line 1) (point))))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
740

741

742 743 744 745
(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
746
in all respects as if it had been called interactively.
747

748 749
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
750 751 752

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

753 754
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
755 756 757 758 759
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."
760

761
  (interactive
Juri Linkov's avatar
Juri Linkov committed
762
   (keep-lines-read-args "How many matches for regexp"))
763 764
  (save-excursion
    (if rstart
765 766 767 768
	(progn
	  (goto-char (min rstart rend))
	  (setq rend (max rstart rend)))
      (if (and interactive transient-mark-mode mark-active)
769
	  (setq rstart (region-beginning)
770
		rend (region-end))
771
	(setq rstart (point)
772
	      rend (point-max)))
773
      (goto-char rstart))
774 775
    (let ((count 0)
	  opoint
776 777 778 779
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
780 781 782 783 784 785
      (while (and (< (point) rend)
		  (progn (setq opoint (point))
			 (re-search-forward regexp rend t)))
	(if (= opoint (point))
	    (forward-char 1)
	  (setq count (1+ count))))
786 787 788 789
      (when interactive (message "%d occurrence%s"
				 count
				 (if (= count 1) "" "s")))
      count)))
790

791

Leo Liu's avatar
Leo Liu committed
792
(defvar occur-menu-map
793
  (let ((map (make-sparse-keymap)))
794 795
    (bindings--define-key map [next-error-follow-minor-mode]
      '(menu-item "Auto Occurrence Display"
796
		  next-error-follow-minor-mode
797
		  :help "Display another occurrence when moving the cursor"
798 799
		  :button (:toggle . (and (boundp 'next-error-follow-minor-mode)
					  next-error-follow-minor-mode))))
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
    (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"))
835
    map)
Leo Liu's avatar
Leo Liu committed
836 837 838 839 840 841 842
  "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)
843
    (define-key map "e" 'occur-edit-mode)
Leo Liu's avatar
Leo Liu committed
844 845 846 847 848 849 850 851
    (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)
852
    (bindings--define-key map [menu-bar occur] (cons "Occur" occur-menu-map))
Leo Liu's avatar
Leo Liu committed
853
    map)
854
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
855

856 857 858
(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
859 860
(make-variable-buffer-local 'occur-revert-arguments)
(put 'occur-revert-arguments 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
861

862 863 864 865 866 867
(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
868
  "Hook run by Occur when there are any matches."
869 870 871
  :type 'hook
  :group 'matching)

872 873 874 875 876 877 878
(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)

879
(put 'occur-mode 'mode-class 'special)
880
(define-derived-mode occur-mode special-mode "Occur"
Richard M. Stallman's avatar
Richard M. Stallman committed
881
  "Major mode for output from \\[occur].
882 883 884 885
\\<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
886
\\{occur-mode-map}"
887
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
888 889
  (setq next-error-function 'occur-next-error))

Leo Liu's avatar
Leo Liu committed
890 891 892 893 894 895 896

;;; 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)
897 898
    (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
899
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
900
    (bindings--define-key map [menu-bar occur] (cons "Occur" occur-menu-map))
Leo Liu's avatar
Leo Liu committed
901 902 903 904 905 906 907 908
    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
909
To return to ordinary Occur mode, use \\[occur-cease-edit]."
Leo Liu's avatar
Leo Liu committed
910
  (setq buffer-read-only nil)
911 912 913 914 915 916 917 918 919 920
  (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
921 922 923 924

(defun occur-after-change-function (beg end length)
  (save-excursion
    (goto-char beg)
925 926
    (let* ((line-beg (line-beginning-position))
	   (m (get-text-property line-beg 'occur-target))
Leo Liu's avatar
Leo Liu committed
927
	   (buf (marker-buffer m))
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
	   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 (