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

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

David Kastrup's avatar
David Kastrup committed
203

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
544

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

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

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

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

Non-nil optional arg DEFAULTS is a string or a list of strings that
are prepended to a list of standard default values, which include the
string at point, the last isearch regexp, the last isearch string, and
the last replacement regexp.
587 588 589

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

620

621
(defalias 'delete-non-matching-lines 'keep-lines)
622 623 624 625 626 627 628
(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.
629
Value is a list, (REGEXP)."
630
  (list (read-regexp prompt) nil nil t))
631

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

638 639
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
640 641

Second and third arg RSTART and REND specify the region to operate on.
642 643 644
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.)
645

646
Interactively, in Transient Mark mode when the mark is active, operate
647 648 649 650 651 652 653 654
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."
655

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

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

706

707 708 709 710 711 712
(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.
713

714 715
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
716 717

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

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

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

759

760 761 762 763
(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
764
in all respects as if it had been called interactively.
765

766 767
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
768 769 770

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

771 772
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
773 774 775 776 777
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."
778

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

809

Leo Liu's avatar
Leo Liu committed
810
(defvar occur-menu-map
811
  (let ((map (make-sparse-keymap)))
812 813
    (bindings--define-key map [next-error-follow-minor-mode]
      '(menu-item "Auto Occurrence Display"
814
		  next-error-follow-minor-mode
815
		  :help "Display another occurrence when moving the cursor"
816 817
		  :button (:toggle . (and (boundp 'next-error-follow-minor-mode)
					  next-error-follow-minor-mode))))
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 848 849 850 851 852
    (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"))
853
    map)
Leo Liu's avatar
Leo Liu committed
854 855 856 857 858 859 860
  "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)
861
    (define-key map "e" 'occur-edit-mode)
Leo Liu's avatar
Leo Liu committed
862 863 864 865 866 867 868 869
    (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)
870
    (bindings--define-key map [menu-bar occur] (cons "Occur" occur-menu-map))
Leo Liu's avatar
Leo Liu committed
871
    map)
872
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
873

874 875 876
(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
877 878
(make-variable-buffer-local 'occur-revert-arguments)
(put 'occur-revert-arguments 'permanent-local t)
Richard M. Stallman's avatar
Richard M. Stallman committed
879

880 881 882 883 884 885
(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
886
  "Hook run by Occur when there are any matches."
887 888 889
  :type 'hook
  :group 'matching)

890 891 892 893 894 895 896
(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)

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

Leo Liu's avatar
Leo Liu committed
908 909 910 911 912 913 914

;;; 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)
915 916
    (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
917
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
918
    (bindings--define-key map [menu-bar occur] (cons "Occur" occur-menu-map))
Leo Liu's avatar
Leo Liu committed
919 920 921 922 923 924 925 926
    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
927
To return to ordinary Occur mode, use \\[occur-cease-edit]."
Leo Liu's avatar
Leo Liu committed
928
  (setq buffer-read-only nil)
929 930 931 932 933 934 935 936 937 938
  (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
939 940 941 942

(defun occur-after-change-function (beg end length)
  (save-excursion
    (goto-char beg)
943 944
    (let* ((line-beg (line-beginning-position))
	   (m (get-text-property line-beg 'occur-target))
Leo Liu's avatar
Leo Liu committed
945
	   (buf (marker-buffer m))
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
	   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)
961 962 963
			(display-buffer buf
					'(nil (inhibit-same-window . t)
					      (inhibit-switch-frame . t)))))
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
	       (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
979 980


981
(defun occur-revert-function (_ignore1 _ignore2)
982
  "Handle `revert-buffer' for Occur mode buffers."
983
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
984

985
(defun occur-mode-find-occurrence ()
986 987
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
988
      (error "No occurrence on this line"))
989 990 991
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
992

993 994
(defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence)
(defun occur-mode-goto-occurrence (&optional event)
995
  "Go to the occurrence on the current line."
996 997 998 999 1000 1001 1002 1003 1004 1005
  (interactive (list last-nonmenu-event))
  (let ((pos
         (if (null event)
             ;; Actually `event-end' works correctly with a nil argument as
             ;; well, so we could dispense with this test, but let's not
             ;; rely on this undocumented behavior.
             (occur-mode-find-occurrence)
           (with-current-buffer (window-buffer (posn-window (event-end event)))
             (save-excursion
               (goto-char (posn-point (event-end event)))
1006
               (occur-mode-find-occurrence))))))
1007
    (pop-to-buffer (marker-buffer pos))
1008 1009
    (goto-char pos)
    (run-hooks 'occur-mode-find-occurrence-hook)))
1010

1011 1012 1013
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
1014 1015
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
Carsten Dominik's avatar