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

3
;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2011
4
;;   Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Pavel Janík's avatar
Pavel Janík committed
6
;; Maintainer: FSF
7
;; Package: emacs
Pavel Janík's avatar
Pavel Janík committed
8

Richard M. Stallman's avatar
Richard M. Stallman committed
9 10
;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
15 16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
23

24 25 26 27 28
;;; Commentary:

;; This package supplies the string and regular-expression replace functions
;; documented in the Emacs user's manual.

Eric S. Raymond's avatar
Eric S. Raymond committed
29
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
30

31
(defcustom case-replace t
Lute Kamstra's avatar
Lute Kamstra committed
32
  "Non-nil means `query-replace' should preserve case in replacements."
33 34
  :type 'boolean
  :group 'matching)
Roland McGrath's avatar
Roland McGrath committed
35

36 37 38 39
(defvar query-replace-history nil
  "Default history list for query-replace commands.
See `query-replace-from-history-variable' and
`query-replace-to-history-variable'.")
40

41 42 43 44 45
(defvar query-replace-defaults nil
  "Default values of FROM-STRING and TO-STRING for `query-replace'.
This is a cons cell (FROM-STRING . TO-STRING), or nil if there is
no default value.")

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

50
(defcustom query-replace-from-history-variable 'query-replace-history
51
  "History list to use for the FROM argument of `query-replace' commands.
52 53 54 55
The value of this variable should be a symbol; that symbol
is used as a variable to hold a history list for the strings
or patterns to be replaced."
  :group 'matching
Dan Nicolaescu's avatar
Dan Nicolaescu committed
56 57
  :type 'symbol
  :version "20.3")
58 59

(defcustom query-replace-to-history-variable 'query-replace-history
60
  "History list to use for the TO argument of `query-replace' commands.
61 62 63 64
The value of this variable should be a symbol; that symbol
is used as a variable to hold a history list for replacement
strings or patterns."
  :group 'matching
Dan Nicolaescu's avatar
Dan Nicolaescu committed
65 66
  :type 'symbol
  :version "20.3")
67

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

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

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

(defcustom query-replace-lazy-highlight t
Lute Kamstra's avatar
Lute Kamstra committed
86
  "Controls the lazy-highlighting during query replacements.
87 88 89 90 91 92
When non-nil, all text in the buffer matching the current match
is highlighted lazily using isearch lazy highlighting (see
`lazy-highlight-initial-delay' and `lazy-highlight-interval')."
  :type 'boolean
  :group 'lazy-highlight
  :group 'matching
93
  :version "22.1")
94 95 96 97 98

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

101 102 103
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

104
(defun query-replace-read-from (prompt regexp-flag)
105 106 107
  "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."
108 109
  (if query-replace-interactive
      (car (if regexp-flag regexp-search-ring search-ring))
110 111
    (let* ((history-add-new-input nil)
	   (from
112 113 114 115 116
	    ;; 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
117
	       (if query-replace-defaults
118
		   (format "%s (default %s -> %s): " prompt
119 120
			   (query-replace-descr (car query-replace-defaults))
			   (query-replace-descr (cdr query-replace-defaults)))
121
		 (format "%s: " prompt))
122 123
	       nil nil nil
	       query-replace-from-history-variable
124
	       nil t))))
125
      (if (and (zerop (length from)) query-replace-defaults)
Chong Yidong's avatar
Chong Yidong committed
126 127 128
	  (cons (car query-replace-defaults)
		(query-replace-compile-replacement
		 (cdr query-replace-defaults) regexp-flag))
129
	(add-to-history query-replace-from-history-variable from nil t)
130 131 132 133 134 135 136 137 138 139 140
	;; 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))))
141

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

David Kastrup's avatar
David Kastrup committed
182

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

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

205
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
206 207 208 209
  "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.

210 211 212
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.

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

217 218 219 220 221 222 223
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.)
224

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

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

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

249
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
250 251 252 253
  "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.

254 255 256
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.

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

261 262 263 264 265 266 267
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.)
268

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

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

279 280 281 282
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
283
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
284 285 286
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).
287

288 289
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
290 291 292 293

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

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

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

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.

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

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

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

372 373 374 375 376
(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")

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

384 385 386
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
387 388
Non-interactively, TO-STRINGS may be a list of replacement strings.

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

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

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

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

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

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

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

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
503

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

527 528

(defvar regexp-history nil
529 530 531 532
  "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
533

534 535 536
(defvar occur-collect-regexp-history '("\\1")
  "History of regexp for occur's collect operation")

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

570

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

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

588 589
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
590 591

Second and third arg RSTART and REND specify the region to operate on.
592 593 594
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.)
595

596
Interactively, in Transient Mark mode when the mark is active, operate
597 598 599 600 601 602 603 604
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."
605

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

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

656

657 658 659 660 661 662
(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.
663

664 665
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
666 667

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

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

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

709

710 711 712 713
(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
714
in all respects as if it had been called interactively.
715

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

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

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
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."
728

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

759

Richard M. Stallman's avatar
Richard M. Stallman committed
760

761 762 763
(defvar occur-revert-arguments nil
  "Arguments to pass to `occur-1' to revert an Occur mode buffer.
See `occur-revert-function'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
764

765 766 767 768 769 770
(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
771
  "Hook run by Occur when there are any matches."
772 773 774
  :type 'hook
  :group 'matching)

775 776 777 778 779 780 781
(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)

782
(put 'occur-mode 'mode-class 'special)
783
(define-derived-mode occur-mode special-mode "Occur"
Richard M. Stallman's avatar
Richard M. Stallman committed
784
  "Major mode for output from \\[occur].
785 786 787 788
\\<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
789
\\{occur-mode-map}"
790
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
791
  (make-local-variable 'occur-revert-arguments)
792
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
  (setq next-error-function 'occur-next-error))

(define-key occur-mode-map [mouse-2] 'occur-mode-mouse-goto)
(define-key occur-mode-map "\C-c\C-c" 'occur-mode-goto-occurrence)
(define-key occur-mode-map "\C-m" 'occur-mode-goto-occurrence)
(define-key occur-mode-map "o" 'occur-mode-goto-occurrence-other-window)
(define-key occur-mode-map "\C-o" 'occur-mode-display-occurrence)
(define-key occur-mode-map "\M-n" 'occur-next)
(define-key occur-mode-map "\M-p" 'occur-prev)
(define-key occur-mode-map "r" 'occur-rename-buffer)
(define-key occur-mode-map "c" 'clone-buffer)
(define-key occur-mode-map "\C-c\C-f" 'next-error-follow-minor-mode)
(define-key occur-mode-map [menu-bar] (make-sparse-keymap))
(define-key occur-mode-map [menu-bar occur] `(cons ,(purecopy "Occur") map))
(define-key occur-mode-map [next-error-follow-minor-mode]
  (menu-bar-make-mm-toggle next-error-follow-minor-mode
                           "Auto Occurrence Display"
                           "Display another occurrence when moving the cursor"))
(define-key occur-mode-map [separator-1] menu-bar-separator)
(define-key occur-mode-map [kill-this-buffer]
  `(menu-item ,(purecopy "Kill occur buffer") kill-this-buffer
              :help ,(purecopy "Kill the current *Occur* buffer")))
(define-key occur-mode-map [quit-window]
  `(menu-item ,(purecopy "Quit occur window") quit-window
              :help ,(purecopy "Quit the current *Occur* buffer.  Bury it, and maybe delete the selected frame")))
(define-key occur-mode-map [revert-buffer]
  `(menu-item ,(purecopy "Revert occur buffer") revert-buffer
              :help ,(purecopy "Replace the text in the *Occur* buffer with the results of rerunning occur")))
(define-key occur-mode-map [clone-buffer]
  `(menu-item ,(purecopy "Clone occur buffer") clone-buffer
              :help ,(purecopy "Create and return a twin copy of the current *Occur* buffer")))
(define-key occur-mode-map [occur-rename-buffer]
  `(menu-item ,(purecopy "Rename occur buffer") occur-rename-buffer
              :help ,(purecopy "Rename the current *Occur* buffer to *Occur: original-buffer-name*.")))
(define-key occur-mode-map [separator-2] menu-bar-separator)
(define-key occur-mode-map [occur-mode-goto-occurrence-other-window]
  `(menu-item ,(purecopy "Go To Occurrence Other Window") occur-mode-goto-occurrence-other-window
              :help ,(purecopy "Go to the occurrence the current line describes, in another window")))
(define-key occur-mode-map [occur-mode-goto-occurrence]
  `(menu-item ,(purecopy "Go To Occurrence") occur-mode-goto-occurrence
              :help ,(purecopy "Go to the occurrence the current line describes")))
(define-key occur-mode-map [occur-mode-display-occurrence]
  `(menu-item ,(purecopy "Display Occurrence") occur-mode-display-occurrence
              :help ,(purecopy "Display in another window the occurrence the current line describes")))
(define-key occur-mode-map [occur-next]
  `(menu-item ,(purecopy "Move to next match") occur-next
              :help ,(purecopy "Move to the Nth (default 1) next match in an Occur mode buffer")))
(define-key occur-mode-map [occur-prev]
  `(menu-item ,(purecopy "Move to previous match") occur-prev
              :help ,(purecopy "Move to the Nth (default 1) previous match in an Occur mode buffer")))
843
(defun occur-revert-function (ignore1 ignore2)
844
  "Handle `revert-buffer' for Occur mode buffers."
845
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
846

847
(defun occur-mode-find-occurrence ()
848 849
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
850
      (error "No occurrence on this line"))
851 852 853
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
854

855 856
(defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence)
(defun occur-mode-goto-occurrence (&optional event)
857
  "Go to the occurrence the current line describes."
858 859 860 861 862 863 864 865 866 867 868 869 870
  (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)))
               (occur-mode-find-occurrence)))))
        same-window-buffer-names
        same-window-regexps)
871
    (pop-to-buffer (marker-buffer pos))
872 873
    (goto-char pos)
    (run-hooks 'occur-mode-find-occurrence-hook)))
874

875 876 877
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
878 879
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
880 881
    (goto-char pos)
    (run-hooks 'occur-mode-find-occurrence-hook)))
882

883 884 885
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
886 887 888
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
889
	same-window-buffer-names
890 891
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
892 893 894
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
895 896
      (goto-char pos)
      (run-hooks 'occur-mode-find-occurrence-hook))))
897

898
(defun occur-find-match (n search message)
899 900 901
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
902 903 904 905
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
906
      (if r
907 908
          (goto-char r)
        (error message))
909 910
      (setq n (1- n)))))

911 912 913 914 915
(defun occur-next (&optional n)
  "Move to the Nth (default 1) next match in an Occur mode buffer."
  (interactive "p")
  (occur-find-match n #'next-single-property-change "No more matches"))

916
(defun occur-prev (&optional n)
917
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
918
  (interactive "p")