replace.el 70.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, 1986, 1987, 1992, 1994, 1996, 1997, 2000, 2001,
4 5
;;   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
;;   Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
6

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

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
(defvar query-replace-history nil)

38 39 40 41 42
(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.")

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

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

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

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

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

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

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

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

98 99 100
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

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

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

David Kastrup's avatar
David Kastrup committed
179

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

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

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

207 208 209
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.

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

214 215 216 217 218 219 220
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.)
221

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

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

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

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

251 252 253
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.

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

258 259 260 261 262 263 264
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.)
265

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

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

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

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

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

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

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

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.

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

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

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

369 370 371 372 373
(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")

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

381 382 383
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
384 385
Non-interactively, TO-STRINGS may be a list of replacement strings.

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

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

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

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

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

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

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

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
499

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

523 524

(defvar regexp-history nil
525 526 527 528
  "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
529

530
(defun read-regexp (prompt &optional default-value)
Juri Linkov's avatar
Juri Linkov committed
531
  "Read regexp as a string using the regexp history and some useful defaults.
532
Prompt for a regular expression with PROMPT (without a colon and
533 534 535 536 537
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."
538
  (let* ((defaults
Juri Linkov's avatar
Juri Linkov committed
539 540 541 542 543 544 545 546 547 548 549 550 551 552
	   (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
553 554 555
	   (if default-value
	       (format "%s (default %s): " prompt
		       (query-replace-descr default-value))
Juri Linkov's avatar
Juri Linkov committed
556 557 558
	     (format "%s: " prompt))
	   nil nil nil 'regexp-history defaults t)))
    (if (equal input "")
559
	default-value
Juri Linkov's avatar
Juri Linkov committed
560 561 562
      (prog1 input
	(add-to-history 'regexp-history input)))))

563

564
(defalias 'delete-non-matching-lines 'keep-lines)
565 566 567 568 569 570 571
(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.
572
Value is a list, (REGEXP)."
573
  (list (read-regexp prompt "") nil nil t))
574

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

581 582
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
583 584

Second and third arg RSTART and REND specify the region to operate on.
585 586 587
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.)
588

589
Interactively, in Transient Mark mode when the mark is active, operate
590 591 592 593 594 595 596 597
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."
598

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

641
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
642
	;; If the match was empty, avoid matching again at same place.
643 644
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
645 646 647
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
648

649

650 651 652 653 654 655
(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.
656

657 658
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
659 660

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

664 665
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
666 667 668 669 670 671 672
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."
673

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

702

703 704 705 706
(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
707
in all respects as if it had been called interactively.
708

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

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

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

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

752

753 754
(defvar occur-mode-map
  (let ((map (make-sparse-keymap)))
755
    ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
756 757 758
    (define-key map [mouse-2] 'occur-mode-mouse-goto)
    (define-key map "\C-c\C-c" 'occur-mode-goto-occurrence)
    (define-key map "\C-m" 'occur-mode-goto-occurrence)
759
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
760
    (define-key map "\C-o" 'occur-mode-display-occurrence)
761 762
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
763 764
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
765
    (define-key map "g" 'revert-buffer)
766 767
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
768
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
769 770 771 772 773 774 775 776
    (define-key map [menu-bar] (make-sparse-keymap))
    (define-key map [menu-bar occur]
      (cons "Occur" map))
    (define-key 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 map [separator-1] '("--"))
Lute Kamstra's avatar
Lute Kamstra committed
777
    (define-key map [kill-this-buffer]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
778 779
      '(menu-item "Kill occur buffer" kill-this-buffer
		  :help "Kill the current *Occur* buffer"))
Lute Kamstra's avatar
Lute Kamstra committed
780
    (define-key map [quit-window]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
781 782
      '(menu-item "Quit occur window" quit-window
		  :help "Quit the current *Occur* buffer.  Bury it, and maybe delete the selected frame"))
Lute Kamstra's avatar
Lute Kamstra committed
783
    (define-key map [revert-buffer]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
784 785
      '(menu-item "Revert occur buffer" revert-buffer
		  :help "Replace the text in the *Occur* buffer with the results of rerunning occur"))
Lute Kamstra's avatar
Lute Kamstra committed
786
    (define-key map [clone-buffer]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
787 788
      '(menu-item "Clone occur buffer" clone-buffer
		  :help "Create and return a twin copy of the current *Occur* buffer"))
Lute Kamstra's avatar
Lute Kamstra committed
789
    (define-key map [occur-rename-buffer]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
790 791
      '(menu-item "Rename occur buffer" occur-rename-buffer
		  :help "Rename the current *Occur* buffer to *Occur: original-buffer-name*."))
792 793
    (define-key map [separator-2] '("--"))
    (define-key map [occur-mode-goto-occurrence-other-window]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
794 795
      '(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"))
796
    (define-key map [occur-mode-goto-occurrence]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
797 798
      '(menu-item "Go To Occurrence" occur-mode-goto-occurrence
		  :help "Go to the occurrence the current line describes"))
799
    (define-key map [occur-mode-display-occurrence]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
800 801
      '(menu-item "Display Occurrence" occur-mode-display-occurrence
		  :help "Display in another window the occurrence the current line describes"))
Lute Kamstra's avatar
Lute Kamstra committed
802
    (define-key map [occur-next]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
803 804
      '(menu-item "Move to next match" occur-next
		  :help "Move to the Nth (default 1) next match in an Occur mode buffer"))
Lute Kamstra's avatar
Lute Kamstra committed
805
    (define-key map [occur-prev]
Dan Nicolaescu's avatar
Dan Nicolaescu committed
806 807
      '(menu-item "Move to previous match" occur-prev
		  :help "Move to the Nth (default 1) previous match in an Occur mode buffer"))
808 809
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
810

811 812 813
(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
814

815 816 817 818 819 820
(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
821
  "Hook run by Occur when there are any matches."
822 823 824
  :type 'hook
  :group 'matching)

825 826 827 828 829 830 831
(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)

832
(put 'occur-mode 'mode-class 'special)
833
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
834
  "Major mode for output from \\[occur].
835 836 837 838
\\<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
839
\\{occur-mode-map}"
840
  (interactive)
841 842 843 844
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
845
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
846
  (make-local-variable 'occur-revert-arguments)
847
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
848
  (setq next-error-function 'occur-next-error)
849
  (run-mode-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
850

851
(defun occur-revert-function (ignore1 ignore2)
852
  "Handle `revert-buffer' for Occur mode buffers."
853
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
854

855
(defun occur-mode-find-occurrence ()
856 857
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
858
      (error "No occurrence on this line"))
859 860 861
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
862

863 864
(defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence)
(defun occur-mode-goto-occurrence (&optional event)
865
  "Go to the occurrence the current line describes."
866 867 868 869 870 871 872 873 874 875 876 877 878
  (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)
879
    (pop-to-buffer (marker-buffer pos))
880 881
    (goto-char pos)
    (run-hooks 'occur-mode-find-occurrence-hook)))
882

883 884 885
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
886