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

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

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

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

96
(defcustom query-replace-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
97
  "Non-nil means to highlight matches during query replacement."
98 99 100 101
  :type 'boolean
  :group 'matching)

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

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

117 118 119 120
(defvar replace-count 0
  "Number of replacements done so far.
See `replace-regexp' and `query-replace-regexp-eval'.")

121 122 123
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

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

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

David Kastrup's avatar
David Kastrup committed
202

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

217
(defun query-replace-read-args (prompt regexp-flag &optional noerror)
218 219
  (unless noerror
    (barf-if-buffer-read-only))
220
  (let* ((from (query-replace-read-from prompt regexp-flag))
221
	 (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
222
	       (query-replace-read-to from prompt regexp-flag))))
223
    (list from to current-prefix-arg)))
224

225
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
226 227 228 229
  "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.

230 231 232
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.

233 234 235 236
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.

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

245 246 247 248
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
249
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
250
only matches surrounded by word boundaries.
251
Fourth and fifth arg START and END specify the region to operate on.
252 253

To customize possible responses, change the \"bindings\" in `query-replace-map'."
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
  (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)))))
269
  (perform-replace from-string to-string t nil delimited nil nil start end))
270

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

273
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
274 275 276 277
  "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.

278 279 280
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.

281 282 283 284
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.

285 286 287 288 289 290 291
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.)
292

293
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
294 295 296
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
297
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
298
only matches surrounded by word boundaries.
299 300
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
301 302
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
303
whatever what matched the Nth `\\(...\\)' in REGEXP.
304 305 306
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

307 308 309 310
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
311
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
312 313 314
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).
315

316 317
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
318 319 320 321

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."
322 323
  (interactive
   (let ((common
324
	  (query-replace-read-args
325 326 327 328
	   (concat "Query replace"
		   (if current-prefix-arg " word" "")
		   " regexp"
		   (if (and transient-mark-mode mark-active) " in region" ""))
329
	   t)))
330 331 332 333 334 335 336 337
     (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)))))
338
  (perform-replace regexp to-string t t delimited nil nil start end))
339

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

342
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
343
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
344 345 346 347 348

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.

349 350 351 352 353 354 355 356 357
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
358 359
`\\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.
360
Use `\\#&' or `\\#N' if you want a number instead of a string.
361
In interactive use, `\\#' in itself stands for `replace-count'.
362 363 364 365 366 367 368 369 370 371

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

373
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
374 375 376
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

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

404 405 406 407 408
(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")

409
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
410
  "Replace some matches for REGEXP with various strings, in rotation.
411 412 413
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
414 415
wrapping around from the last such string to the first.

416 417 418
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
419 420
Non-interactively, TO-STRINGS may be a list of replacement strings.

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

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

468 469 470 471
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'.

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

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

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

510
If `replace-regexp-lax-whitespace' is non-nil, a space or spaces in the regexp
511 512 513
to be replaced will match a sequence of whitespace chars defined by the
regexp in `search-whitespace-regexp'.

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

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

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
543

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

567 568

(defvar regexp-history nil
569 570 571 572
  "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
573

574 575 576
(defvar occur-collect-regexp-history '("\\1")
  "History of regexp for occur's collect operation")

577
(defun read-regexp (prompt &optional default-value history)
Juri Linkov's avatar
Juri Linkov committed
578
  "Read regexp as a string using the regexp history and some useful defaults.
579 580 581 582
When PROMPT doesn't end with a colon and space, it adds a final \": \".
If DEFAULT-VALUE is non-nil, it displays the first default in the prompt.
The optional argument DEFAULT-VALUE provides the value to display
in the minibuffer prompt that is returned if the user just types RET.
583
Values available via M-n are the string at point, the last isearch
584 585 586 587
regexp, the last isearch string, and the last replacement regexp.

Non-nil HISTORY is a symbol to use for the history list.
If HISTORY is nil, `regexp-history' is used."
588
  (let* ((defaults
Juri Linkov's avatar
Juri Linkov committed
589 590 591 592 593 594 595 596 597 598 599 600
	   (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)
601 602 603 604 605 606 607 608
	 (input (read-from-minibuffer
		 (cond ((string-match-p ":[ \t]*\\'" prompt)
			prompt)
		       (default-value
			 (format "%s (default %s): " prompt
				 (query-replace-descr default-value)))
		       (t
			(format "%s: " prompt)))
609
		 nil nil nil (or history 'regexp-history) defaults t)))
Juri Linkov's avatar
Juri Linkov committed
610
    (if (equal input "")
611
	(or default-value input)
Juri Linkov's avatar
Juri Linkov committed
612
      (prog1 input
613
	(add-to-history (or history 'regexp-history) input)))))
Juri Linkov's avatar
Juri Linkov committed
614

615

616
(defalias 'delete-non-matching-lines 'keep-lines)
617 618 619 620 621 622 623
(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.
624
Value is a list, (REGEXP)."
625
  (list (read-regexp prompt) nil nil t))
626

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

633 634
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
635 636

Second and third arg RSTART and REND specify the region to operate on.
637 638 639
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.)
640

641
Interactively, in Transient Mark mode when the mark is active, operate
642 643 644 645 646 647 648 649
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."
650

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

693
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
694
	;; If the match was empty, avoid matching again at same place.
695 696
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
697 698 699
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
700

701

702 703 704 705 706 707
(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.
708

709 710
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
711 712

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

716 717
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
718 719 720 721 722 723 724
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."
725

726
  (interactive
727 728
   (progn
     (barf-if-buffer-read-only)
Juri Linkov's avatar
Juri Linkov committed
729
     (keep-lines-read-args "Flush lines containing match for regexp")))
730
  (if rstart
731 732 733
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
734
    (if (and interactive transient-mark-mode mark-active)
735 736 737 738 739
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
740 741 742 743
  (let ((case-fold-search
	 (if (and case-fold-search search-upper-case)
	     (isearch-no-upper-case-p regexp t)
	   case-fold-search)))
744
    (save-excursion
745 746
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
747
	(delete-region (save-excursion (goto-char (match-beginning 0))
748
				       (forward-line 0)
749
				       (point))
750 751 752
		       (progn (forward-line 1) (point))))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
753

754

755 756 757 758
(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
759
in all respects as if it had been called interactively.
760

761 762
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
763 764 765

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

766 767
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
768 769 770 771 772
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."
773

774
  (interactive
Juri Linkov's avatar
Juri Linkov committed
775
   (keep-lines-read-args "How many matches for regexp"))
776 777
  (save-excursion
    (if rstart
778 779 780 781
	(progn
	  (goto-char (min rstart rend))
	  (setq rend (max rstart rend)))
      (if (and interactive transient-mark-mode mark-active)
782
	  (setq rstart (region-beginning)
783
		rend (region-end))
784
	(setq rstart (point)
785
	      rend (point-max)))
786
      (goto-char rstart))
787 788
    (let ((count 0)
	  opoint
789 790 791 792
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
793 794 795 796 797 798
      (while (and (< (point) rend)
		  (progn (setq opoint (point))
			 (re-search-forward regexp rend t)))
	(if (= opoint (point))
	    (forward-char 1)
	  (setq count (1+ count))))
799 800 801 802
      (when interactive (message "%d occurrence%s"
				 count
				 (if (= count 1) "" "s")))
      count)))
803

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

869 870 871
(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
872 873
(make-variable-buffer-local 'occur-revert-arguments)
(put 'occur-revert-arguments 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
874

875 876 877 878 879 880
(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
881
  "Hook run by Occur when there are any matches."
882 883 884
  :type 'hook
  :group 'matching)

885 886 887 888 889 890 891
(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)

892
(put 'occur-mode 'mode-class 'special)
893
(define-derived-mode occur-mode special-mode "Occur"
Richard M. Stallman's avatar
Richard M. Stallman committed
894
  "Major mode for output from \\[occur].
895 896 897 898
\\<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
899
\\{occur-mode-map}"
900
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
901 902
  (setq next-error-function 'occur-next-error))

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