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

3
;; Copyright (C) 1985, 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 10 11
;; This file is part of GNU Emacs.

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

;; 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
Erik Naggum's avatar
Erik Naggum committed
21
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
22 23
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

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

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

37 38
(defvar query-replace-history nil)

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

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

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

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

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

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

78 79 80 81 82 83 84 85 86 87 88 89 90
(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
91
  :version "22.1")
92 93 94 95 96

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

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

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

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

David Kastrup's avatar
David Kastrup committed
180

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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
497

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

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

527

528
(defalias 'delete-non-matching-lines 'keep-lines)
529 530 531 532 533 534 535
(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.
536
Value is a list, (REGEXP)."
537 538 539 540 541 542 543 544 545 546 547 548 549 550
  (let* ((default (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))))
	 (default (delete-dups (delq nil (delete "" default)))))
    (list (read-from-minibuffer prompt nil nil nil
				'regexp-history default t)
	  nil nil t)))
551

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

558 559
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
560 561

Second and third arg RSTART and REND specify the region to operate on.
562 563 564
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.)
565

566
Interactively, in Transient Mark mode when the mark is active, operate
567 568 569 570 571 572 573 574
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."
575

576
  (interactive
577 578 579
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
580
  (if rstart
581 582
      (progn
	(goto-char (min rstart rend))
583 584 585 586 587 588 589 590
	(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)
591
	(setq rstart (region-beginning)
592 593 594 595 596
	      rend (progn
		     (goto-char (region-end))
		     (unless (or (bolp) (eobp))
		       (forward-line 0))
		     (point-marker)))
597 598 599
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
600 601
  (save-excursion
    (or (bolp) (forward-line 1))
602
    (let ((start (point))
603 604 605 606
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
607
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
608
	;; Start is first char not preserved by previous match.
609 610
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
611
	  (let ((end (save-excursion (goto-char (match-beginning 0))
612
				     (forward-line 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
613 614 615 616
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
617

618
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
619
	;; If the match was empty, avoid matching again at same place.
620 621
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
622 623 624
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
625

626

627 628 629 630 631 632
(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.
633

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

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

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

651
  (interactive
652 653 654
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
655
  (if rstart
656 657 658
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
659
    (if (and interactive transient-mark-mode mark-active)
660 661 662 663 664
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
665 666 667 668
  (let ((case-fold-search
	 (if (and case-fold-search search-upper-case)
	     (isearch-no-upper-case-p regexp t)
	   case-fold-search)))
669
    (save-excursion
670 671
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
672
	(delete-region (save-excursion (goto-char (match-beginning 0))
673
				       (forward-line 0)
674
				       (point))
675 676 677
		       (progn (forward-line 1) (point))))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
678

679

680 681 682 683 684
(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.
685

686 687
If REGEXP contains upper case characters (excluding those preceded by `\\')
and `search-upper-case' is non-nil, the matching is case-sensitive.
688 689 690

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

691 692
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
693 694 695 696 697
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."
698

699 700
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
701 702
  (save-excursion
    (if rstart
703 704 705 706
	(progn
	  (goto-char (min rstart rend))
	  (setq rend (max rstart rend)))
      (if (and interactive transient-mark-mode mark-active)
707
	  (setq rstart (region-beginning)
708
		rend (region-end))
709
	(setq rstart (point)
710
	      rend (point-max)))
711
      (goto-char rstart))
712 713
    (let ((count 0)
	  opoint
714 715 716 717
	  (case-fold-search
	   (if (and case-fold-search search-upper-case)
	       (isearch-no-upper-case-p regexp t)
	     case-fold-search)))
718 719 720 721 722 723
      (while (and (< (point) rend)
		  (progn (setq opoint (point))
			 (re-search-forward regexp rend t)))
	(if (= opoint (point))
	    (forward-char 1)
	  (setq count (1+ count))))
724 725 726 727
      (when interactive (message "%d occurrence%s"
				 count
				 (if (= count 1) "" "s")))
      count)))
728

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

788 789 790
(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
791

792 793 794 795 796 797
(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
798
  "Hook run by Occur when there are any matches."
799 800 801
  :type 'hook
  :group 'matching)

802 803 804 805 806 807 808
(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)

809
(put 'occur-mode 'mode-class 'special)
810
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
811
  "Major mode for output from \\[occur].
812 813 814 815
\\<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
816
\\{occur-mode-map}"
817
  (interactive)
818 819 820 821
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
822
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
823
  (make-local-variable 'occur-revert-arguments)
824
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
825
  (setq next-error-function 'occur-next-error)
826
  (run-mode-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
827

828
(defun occur-revert-function (ignore1 ignore2)
829
  "Handle `revert-buffer' for Occur mode buffers."
830
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
831

832
(defun occur-mode-find-occurrence ()
833 834
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
835
      (error "No occurrence on this line"))
836 837 838
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
839

840 841
(defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence)
(defun occur-mode-goto-occurrence (&optional event)
842
  "Go to the occurrence the current line describes."
843 844 845 846 847 848 849 850 851 852 853 854 855
  (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)
856
    (pop-to-buffer (marker-buffer pos))
857 858
    (goto-char pos)
    (run-hooks 'occur-mode-find-occurrence-hook)))
859

860 861 862
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
863 864
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
865 866
    (goto-char pos)
    (run-hooks 'occur-mode-find-occurrence-hook)))
867

868 869 870
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
871 872 873
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
874
	same-window-buffer-names
875 876
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
877 878 879
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
880 881
      (goto-char pos)
      (run-hooks 'occur-mode-find-occurrence-hook))))
882

883
(defun occur-find-match (n search message)
884 885 886
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
887 888 889 890
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
891
      (if r
892 893
          (goto-char r)
        (error message))
894 895
      (setq n (1- n)))))

896 897 898 899 900
(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"))