replace.el 63.5 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
;;   2002, 2003, 2004, 2005, 2006 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
Jim Blandy's avatar
Jim Blandy committed
12
;; the Free Software Foundation; either version 2, 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 78 79 80 81 82 83 84
(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
85
  :version "22.1")
86 87 88 89 90

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

93 94 95
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

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

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

David Kastrup's avatar
David Kastrup committed
172

173
(defun query-replace-read-to (from prompt regexp-flag)
David Kastrup's avatar
David Kastrup committed
174 175 176
  "Query and return the `to' argument of a query-replace operation."
  (query-replace-compile-replacement
   (save-excursion
177 178 179 180 181 182
     (let ((to (read-from-minibuffer
		(format "%s %s with: " prompt (query-replace-descr from))
		nil nil nil
		query-replace-to-history-variable from t)))
       (setq query-replace-defaults (cons from to))
       to))
David Kastrup's avatar
David Kastrup committed
183 184
   regexp-flag))

185
(defun query-replace-read-args (prompt regexp-flag &optional noerror)
186 187
  (unless noerror
    (barf-if-buffer-read-only))
188
  (let* ((from (query-replace-read-from prompt regexp-flag))
189
	 (to (if (consp from) (prog1 (cdr from) (setq from (car from)))
190
	       (query-replace-read-to from prompt regexp-flag))))
191
    (list from to current-prefix-arg)))
192

193
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
194 195 196 197
  "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.

198 199 200
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.

201 202 203 204
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.

205 206 207 208 209 210 211
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.)
212

Richard M. Stallman's avatar
Richard M. Stallman committed
213
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
214
only matches surrounded by word boundaries.
215
Fourth and fifth arg START and END specify the region to operate on.
216 217

To customize possible responses, change the \"bindings\" in `query-replace-map'."
218
  (interactive (let ((common
219
		      (query-replace-read-args
220 221 222 223
		       (if (and transient-mark-mode mark-active)
			 "Query replace in region"
			 "Query replace")
			 nil)))
224 225 226 227 228 229 230 231
		 (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)))))
232
  (perform-replace from-string to-string t nil delimited nil nil start end))
233

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

236
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
237 238 239 240
  "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.

241 242 243
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.

244 245 246 247
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.

248 249 250 251 252 253 254
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.)
255

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

Richard M. Stallman's avatar
Richard M. Stallman committed
260 261
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
262
whatever what matched the Nth `\\(...\\)' in REGEXP.
263 264 265
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

266 267 268 269
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
270
whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N'
271 272 273
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).
274

275 276
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
277 278 279 280

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."
281 282
  (interactive
   (let ((common
283
	  (query-replace-read-args
284 285 286 287
	   (if (and transient-mark-mode mark-active)
	       "Query replace regexp in region"
	     "Query replace regexp")
	   t)))
288 289 290 291 292 293 294 295
     (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)))))
296
  (perform-replace regexp to-string t t delimited nil nil start end))
297

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

300
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
301 302 303 304 305 306 307 308 309 310
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
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
311 312
`\\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.
313
Use `\\#&' or `\\#N' if you want a number instead of a string.
314
In interactive use, `\\#' in itself stands for `replace-count'.
315 316 317 318 319 320 321 322 323 324

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

326
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
327
only matches that are surrounded by word boundaries.
328
Fourth and fifth arg START and END specify the region to operate on."
329
  (interactive
330
   (progn
331 332 333 334 335 336 337
   (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)))
338
	  (to (list (read-from-minibuffer
339 340
		     (format "Query replace regexp %s with eval: "
			     (query-replace-descr from))
341
		     nil nil t query-replace-to-history-variable from t))))
342 343 344
     ;; 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)
345 346 347 348
     (list from (car to) current-prefix-arg
	   (if (and transient-mark-mode mark-active)
	       (region-beginning))
	   (if (and transient-mark-mode mark-active)
349
	       (region-end))))))
350
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
351
		   t 'literal delimited nil nil start end))
352

353
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
354
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
355 356 357 358 359
The second argument TO-STRINGS contains the replacement strings,
separated by spaces.  Third arg DELIMITED (prefix arg if interactive),
if non-nil, means replace only matches surrounded by word boundaries.
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
360 361
wrapping around from the last such string to the first.

362 363 364
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
365 366
Non-interactively, TO-STRINGS may be a list of replacement strings.

367 368 369
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
370
A prefix argument N says to use each replacement string N times
371 372
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
373
  (interactive
374
   (let* ((from (if query-replace-interactive
375 376 377
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
378
					'query-replace-history nil t)))
379
	  (to (read-from-minibuffer
380
	       (format "Query replace %s with (space-separated strings): "
381
		       (query-replace-descr from))
382
	       nil nil nil
383
	       'query-replace-history from t)))
384 385 386
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
387 388 389 390
	   (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
391 392 393 394 395 396 397 398 399 400 401 402 403
  (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 ""))))
404
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
405

406
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
407 408 409
  "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.
410 411 412
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

420 421 422 423
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
424 425
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
426 427
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
428 429 430
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.)"
431 432
  (interactive
   (let ((common
433
	  (query-replace-read-args
434 435 436 437
	   (if (and transient-mark-mode mark-active)
	       "Replace string in region"
	     "Replace string")
	   nil)))
438 439 440 441 442
     (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)))))
443
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
444

445
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
446
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
447
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
448
are non-nil and REGEXP has no uppercase letters.
449 450 451 452

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

Richard M. Stallman's avatar
Richard M. Stallman committed
457 458
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
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
whole match, `\\N' a partial matches, `\\#&' and `\\#N' the
respective numeric values from `string-to-number', and `\\#'
itself for `replace-count', the number of replacements occured so
far.

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
480

481 482 483
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
484 485 486
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
487
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
488
which will run faster and will not set the mark or print anything."
489 490
  (interactive
   (let ((common
491
	  (query-replace-read-args
492
	   (if (and transient-mark-mode mark-active)
493 494
	       "Replace regexp in region"
	     "Replace regexp")
495
	   t)))
496 497 498 499 500
     (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)))))
501
  (perform-replace regexp to-string nil t delimited nil nil start end))
502

503 504 505

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
506

507

508
(defalias 'delete-non-matching-lines 'keep-lines)
509 510 511 512 513 514 515
(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.
516 517
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
518 519
			      'regexp-history nil t)
	nil nil t))
520

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
528 529 530
the matching is case-sensitive.

Second and third arg RSTART and REND specify the region to operate on.
531 532 533
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.)
534

535
Interactively, in Transient Mark mode when the mark is active, operate
536 537 538 539 540 541 542 543
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."
544

545
  (interactive
546 547 548
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
549
  (if rstart
550 551
      (progn
	(goto-char (min rstart rend))
552 553 554 555 556 557 558 559
	(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)
560
	(setq rstart (region-beginning)
561 562 563 564 565
	      rend (progn
		     (goto-char (region-end))
		     (unless (or (bolp) (eobp))
		       (forward-line 0))
		     (point-marker)))
566 567 568
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
569 570
  (save-excursion
    (or (bolp) (forward-line 1))
571 572 573
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
574
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
575
	;; Start is first char not preserved by previous match.
576 577
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
578
	  (let ((end (save-excursion (goto-char (match-beginning 0))
579
				     (forward-line 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
580 581 582 583
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
584

585
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
586
	;; If the match was empty, avoid matching again at same place.
587 588
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
589 590 591
	     (forward-char 1)))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
592

593

594 595 596 597 598 599
(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.
600 601

If REGEXP contains upper case characters (excluding those preceded by `\\'),
602 603 604
the matching is case-sensitive.

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

608 609
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
610 611 612 613 614 615 616
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."
617

618
  (interactive
619 620 621
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
622
  (if rstart
623 624 625
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
626
    (if (and interactive transient-mark-mode mark-active)
627 628 629 630 631
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
632 633 634
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
635 636
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
637
	(delete-region (save-excursion (goto-char (match-beginning 0))
638
				       (forward-line 0)
639
				       (point))
640 641 642
		       (progn (forward-line 1) (point))))))
  (set-marker rend nil)
  nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
643

644

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

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

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

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

664 665
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
666 667
  (save-excursion
    (if rstart
668 669 670 671
	(progn
	  (goto-char (min rstart rend))
	  (setq rend (max rstart rend)))
      (if (and interactive transient-mark-mode mark-active)
672
	  (setq rstart (region-beginning)
673
		rend (region-end))
674
	(setq rstart (point)
675
	      rend (point-max)))
676
      (goto-char rstart))
677 678 679 680 681 682 683 684 685 686
    (let ((count 0)
	  opoint
	  (case-fold-search (and case-fold-search
				 (isearch-no-upper-case-p regexp t))))
      (while (and (< (point) rend)
		  (progn (setq opoint (point))
			 (re-search-forward regexp rend t)))
	(if (= opoint (point))
	    (forward-char 1)
	  (setq count (1+ count))))
687 688 689 690
      (when interactive (message "%d occurrence%s"
				 count
				 (if (= count 1) "" "s")))
      count)))
691

692

693 694
(defvar occur-mode-map
  (let ((map (make-sparse-keymap)))
695
    ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto].
696 697 698
    (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)
699
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
700
    (define-key map "\C-o" 'occur-mode-display-occurrence)
701 702
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
703 704
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
705
    (define-key map "g" 'revert-buffer)
706 707
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
708
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
709 710
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
711

712 713 714
(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
715

716 717 718 719 720 721
(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
722
  "Hook run by Occur when there are any matches."
723 724 725
  :type 'hook
  :group 'matching)

726
(put 'occur-mode 'mode-class 'special)
727
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
728
  "Major mode for output from \\[occur].
729 730 731 732
\\<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
733
\\{occur-mode-map}"
734
  (interactive)
735 736 737 738
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
739
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
740
  (make-local-variable 'occur-revert-arguments)
741
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
742
  (setq next-error-function 'occur-next-error)
743
  (run-mode-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
744

745
(defun occur-revert-function (ignore1 ignore2)
746
  "Handle `revert-buffer' for Occur mode buffers."
747
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
748

749
(defun occur-mode-find-occurrence ()
750 751
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
752
      (error "No occurrence on this line"))
753 754 755
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
756

757 758
(defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence)
(defun occur-mode-goto-occurrence (&optional event)
759
  "Go to the occurrence the current line describes."
760 761 762 763 764 765 766 767 768 769 770 771 772
  (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)
773
    (pop-to-buffer (marker-buffer pos))
774
    (goto-char pos)))
775

776 777 778
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
779 780 781
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
782

783 784 785
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
786 787 788
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
789
	same-window-buffer-names
790 791
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
792 793 794
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
795
      (goto-char pos))))
796

797
(defun occur-find-match (n search message)
798 799 800
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
801 802 803 804
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
805
      (if r
806 807
          (goto-char r)
        (error message))
808 809
      (setq n (1- n)))))

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

815
(defun occur-prev (&optional n)
816
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
817
  (interactive "p")
818
  (occur-find-match n #'previous-single-property-change "No earlier matches"))
819 820 821 822 823

(defun occur-next-error (&optional argp reset)
  "Move to the Nth (default 1) next match in an Occur mode buffer.
Compatibility function for \\[next-error] invocations."
  (interactive "p")
824
  ;; we need to run occur-find-match from within the Occur buffer
825
  (with-current-buffer
826
      ;; Choose the buffer and make it current.
827 828
      (if (next-error-buffer-p (current-buffer))
	  (current-buffer)
829 830 831
	(next-error-find-buffer nil nil
				(lambda ()
				  (eq major-mode 'occur-mode))))
832 833 834

    (goto-char (cond (reset (point-min))
		     ((< argp 0) (line-beginning-position))
835 836
		     ((> argp 0) (line-end-position))
		     ((point))))
837
    (occur-find-match
838 839
     (abs argp)
     (if (> 0 argp)
840 841 842 843 844 845
	 #'previous-single-property-change
       #'next-single-property-change)
     "No more matches")
    ;; In case the *Occur* buffer is visible in a nonselected window.
    (set-window-point (get-buffer-window (current-buffer)) (point))
    (occur-mode-goto-occurrence)))
846

Juri Linkov's avatar
Juri Linkov committed
847 848 849 850
(defface match
  '((((class color) (min-colors 88) (background light))
     :background "Tan")
    (((class color) (min-colors 88) (background dark))
851
     :background "RoyalBlue3")
Juri Linkov's avatar
Juri Linkov committed
852 853 854 855 856 857 858
    (((class color) (min-colors 8))
     :background "blue" :foreground "white")
    (((type tty) (class mono))
     :inverse-video t)
    (t :background "gray"))
  "Face used to highlight matches permanently."
  :group 'matching
859
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
860

861
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
862 863
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
864 865 866
A positive number means to include that many lines both before and after."
  :type 'integer
  :group 'matching)
Richard M. Stallman's avatar
Richard M. Stallman committed
867

868
(defalias 'list-matching-lines 'occur)
Richard M. Stallman's avatar
Richard M. Stallman committed
869

Juri Linkov's avatar
Juri Linkov committed
870
(defcustom list-matching-lines-face 'match
Dave Love's avatar
Dave Love committed
871
  "*Face used by \\[list-matching-lines] to show the text that matches.
872 873 874 875 876 877 878 879 880 881
If the value is nil, don't highlight the matching portions specially."
  :type 'face
  :group 'matching)

(defcustom list-matching-lines-buffer-name-face 'underline
  "*Face used by \\[list-matching-lines] to show the names of buffers.
If the value is nil, don't highlight the buffer names specially."
  :type 'face
  :group 'matching)

882 883 884 885 886 887 888 889 890 891
(defcustom occur-excluded-properties
  '(read-only invisible intangible field mouse-face help-echo local-map keymap
    yank-handler follow-link)
  "*Text properties to discard when copying lines to the *Occur* buffer.
The value should be a list of text properties to discard or t,
which means to discard all text properties."
  :type '(choice (const :tag "All" t) (repeat symbol))
  :group 'matching
  :version "22.1")

892
(defun occur-accumulate-lines (count &optional keep-props)
893 894
  (save-excursion
    (let ((forwardp (> count 0))
895
	  result beg end)
896 897 898 899
      (while (not (or (zerop count)
		      (if forwardp
			  (eobp)
			(bobp))))
900
	(setq count (+ count (if forwardp -1 1)))
901 902
	(setq beg (line-beginning-position)
	      end (line-end-position))
903
	(if (and keep-props (if (boundp 'jit-lock-mode) jit-lock-mode)
Juri Linkov's avatar