replace.el 70.7 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,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

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

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

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; 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
14 15 16 17 18 19 20

;; 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
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
22

23 24 25 26 27
;;; 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
28
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
29

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

35 36
(defvar query-replace-history nil)

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

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

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

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

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

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

76 77 78 79 80 81 82 83 84 85 86 87 88
(defcustom query-replace-highlight t
  "*Non-nil means to highlight matches during query replacement."
  :type 'boolean
  :group 'matching)

(defcustom query-replace-lazy-highlight t
  "*Controls the lazy-highlighting during query replacements.
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
89
  :version "22.1")
90 91 92 93 94

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

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

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

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

David Kastrup's avatar
David Kastrup committed
178

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

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

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

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

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

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

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

To customize possible responses, change the \"bindings\" in `query-replace-map'."
226
  (interactive (let ((common
227
		      (query-replace-read-args
228 229 230 231
		       (if (and transient-mark-mode mark-active)
			 "Query replace in region"
			 "Query replace")
			 nil)))
232 233 234 235 236 237 238 239
		 (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)))))
240
  (perform-replace from-string to-string t nil delimited nil nil start end))
241

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

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

249 250 251
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.

252 253 254 255
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.

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

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

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

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

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

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

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

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

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.

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

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

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

366 367 368 369 370
(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")

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

378 379 380
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
381 382
Non-interactively, TO-STRINGS may be a list of replacement strings.

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

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

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

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

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

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

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

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
495

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

518 519

(defvar regexp-history nil
520 521 522 523
  "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
524

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

558

559
(defalias 'delete-non-matching-lines 'keep-lines)
560 561 562 563 564 565 566
(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.
567
Value is a list, (REGEXP)."
Juri Linkov's avatar
Juri Linkov committed
568
  (list (read-regexp prompt) nil nil t))
569

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

576 577
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
578 579

Second and third arg RSTART and REND specify the region to operate on.
580 581 582
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.)
583

584
Interactively, in Transient Mark mode when the mark is active, operate
585 586 587 588 589 590 591 592
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."
593

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

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

644

645 646 647 648 649 650
(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.
651

652 653
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
654 655

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

659 660
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
661 662 663 664 665 666 667
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."
668

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

697

698 699 700 701 702
(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
in all respects has if it had been called interactively.
703

704 705
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
706 707 708

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

709 710
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
711 712 713 714 715
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."
716

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

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

806 807 808
(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
809

810 811 812 813 814 815
(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
816
  "Hook run by Occur when there are any matches."
817 818 819
  :type 'hook
  :group 'matching)

820 821 822 823 824 825 826
(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)

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

846
(defun occur-revert-function (ignore1 ignore2)
847
  "Handle `revert-buffer' for Occur mode buffers."
848
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
849

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

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

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

886 887 888
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
889 890 891
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
892
	same-window-buffer-names