replace.el 60.1 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, 2002,
4
;;   2003, 2004, 2005  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 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, 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
(defvar query-replace-interactive nil
40
  "Non-nil means `query-replace' uses the last search string.
41
That becomes the \"string to replace\".")
42

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

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

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

67 68 69 70 71 72 73 74 75 76 77 78 79
(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
80
  :version "22.1")
81 82 83 84 85

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

88 89 90
(defun query-replace-descr (string)
  (mapconcat 'isearch-text-char-description string ""))

91
(defun query-replace-read-from (string regexp-flag)
92 93 94
  "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."
95 96
  (if query-replace-interactive
      (car (if regexp-flag regexp-search-ring search-ring))
97 98 99
    (let* ((lastfrom (car (symbol-value query-replace-from-history-variable)))
	   (lastto (car (symbol-value query-replace-to-history-variable)))
	   (from
100 101 102 103
	    ;; 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
104 105 106 107
	      (when (equal lastfrom lastto)
		;; Typically, this is because the two histlists are shared.
		(setq lastfrom (cadr (symbol-value
				      query-replace-from-history-variable))))
108
	      (read-from-minibuffer
109 110 111 112 113
	       (if (and lastto lastfrom)
		   (format "%s (default %s -> %s): " string
			   (query-replace-descr lastfrom)
			   (query-replace-descr lastto))
		 (format "%s: " string))
114 115
	       nil nil nil
	       query-replace-from-history-variable
116
	       nil t t))))
117
      (if (and (zerop (length from)) lastto lastfrom)
118 119
	  (progn
	    (set query-replace-from-history-variable
120 121 122
		 (cdr (symbol-value query-replace-from-history-variable)))
	    (cons lastfrom
		  (query-replace-compile-replacement lastto regexp-flag)))
123 124 125 126 127 128 129 130 131 132 133
	;; 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))))
134

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

David Kastrup's avatar
David Kastrup committed
175 176 177 178 179 180 181 182

(defun query-replace-read-to (from string regexp-flag)
  "Query and return the `to' argument of a query-replace operation."
  (query-replace-compile-replacement
   (save-excursion
     (read-from-minibuffer
      (format "%s %s with: " string (query-replace-descr from))
      nil nil nil
183
      query-replace-to-history-variable from t t))
David Kastrup's avatar
David Kastrup committed
184 185
   regexp-flag))

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

354
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
355
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
356 357 358 359 360
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
361 362
wrapping around from the last such string to the first.

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

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

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

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

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
458 459
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
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
481

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

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

508

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

(defun keep-lines (regexp &optional rstart rend)
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 526
Applies to all lines after point.

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

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

531 532 533 534
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
end of the buffer."

535
  (interactive
536 537 538
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
539
  (if rstart
540 541 542
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
543 544 545 546 547 548
    (if (and transient-mark-mode mark-active)
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
Richard M. Stallman's avatar
Richard M. Stallman committed
549 550
  (save-excursion
    (or (bolp) (forward-line 1))
551 552 553
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
554
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
555
	;; Start is first char not preserved by previous match.
556 557
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
558 559 560 561 562 563
	  (let ((end (save-excursion (goto-char (match-beginning 0))
				     (beginning-of-line)
				     (point))))
	    ;; Now end is first char preserved by the new match.
	    (if (< start end)
		(delete-region start end))))
564

565
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
566
	;; If the match was empty, avoid matching again at same place.
567 568
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
569 570
	     (forward-char 1))))))

571 572

(defun flush-lines (regexp &optional rstart rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
573 574
  "Delete lines containing matches for REGEXP.
If a match is split across lines, all the lines it lies in are deleted.
575 576 577
Applies to lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
578 579 580 581
the matching is case-sensitive.

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

582 583 584 585
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
end of the buffer."

586
  (interactive
587 588 589
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
590
  (if rstart
591 592 593
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
594 595 596 597 598 599
    (if (and transient-mark-mode mark-active)
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
600 601 602
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
603 604
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
605 606 607 608
	(delete-region (save-excursion (goto-char (match-beginning 0))
				       (beginning-of-line)
				       (point))
		       (progn (forward-line 1) (point)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
609

610 611

(defun how-many (regexp &optional rstart rend)
612 613 614
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
615 616 617 618
the matching is case-sensitive.

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

619 620 621 622
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
end of the buffer."

623 624
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
625 626 627
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
628 629 630 631 632 633
      (if (and transient-mark-mode mark-active)
	  (setq rstart (region-beginning)
		rend (copy-marker (region-end)))
	(setq rstart (point)
	      rend (point-max-marker)))
      (goto-char rstart))
634 635 636 637 638 639 640 641 642 643 644
    (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))))
      (message "%d occurrences" count))))
645

646

647 648 649 650 651
(defvar occur-mode-map
  (let ((map (make-sparse-keymap)))
    (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)
652
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
653
    (define-key map "\C-o" 'occur-mode-display-occurrence)
654 655
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
656 657
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
658
    (define-key map "g" 'revert-buffer)
659 660
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
661
    (define-key map "\C-c\C-f" 'next-error-follow-minor-mode)
662 663
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
664

665 666 667
(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
668

669 670 671 672 673 674 675
(defcustom occur-mode-hook '(turn-on-font-lock)
  "Hook run when entering Occur mode."
  :type 'hook
  :group 'matching)

(defcustom occur-hook nil
  "Hook run when `occur' is called."
676 677 678
  :type 'hook
  :group 'matching)

679
(put 'occur-mode 'mode-class 'special)
680
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
681
  "Major mode for output from \\[occur].
682 683 684 685
\\<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
686
\\{occur-mode-map}"
687
  (interactive)
688 689 690 691
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
692
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
693
  (make-local-variable 'occur-revert-arguments)
694
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
695
  (setq next-error-function 'occur-next-error)
696
  (run-mode-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
697

698
(defun occur-revert-function (ignore1 ignore2)
699
  "Handle `revert-buffer' for Occur mode buffers."
700
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
701

702 703 704
(defun occur-mode-mouse-goto (event)
  "In Occur mode, go to the occurrence whose line you click on."
  (interactive "e")
705
  (let (pos)
706 707 708 709
    (save-excursion
      (set-buffer (window-buffer (posn-window (event-end event))))
      (save-excursion
	(goto-char (posn-point (event-end event)))
710 711 712
	(setq pos (occur-mode-find-occurrence))))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
713 714

(defun occur-mode-find-occurrence ()
715 716
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
717
      (error "No occurrence on this line"))
718 719 720
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
721 722 723 724

(defun occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
725 726 727
  (let ((pos (occur-mode-find-occurrence)))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
728

729 730 731
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
732 733 734
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
735

736 737 738
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
739 740 741
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
742
	same-window-buffer-names
743 744
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
745 746 747
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
748
      (goto-char pos))))
749

750
(defun occur-find-match (n search message)
751 752 753
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
754 755 756 757
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
758
      (if r
759 760
          (goto-char r)
        (error message))
761 762
      (setq n (1- n)))))

763 764 765 766 767
(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"))

768
(defun occur-prev (&optional n)
769
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
770
  (interactive "p")
771
  (occur-find-match n #'previous-single-property-change "No earlier matches"))
772 773 774 775 776

(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")
777
  ;; we need to run occur-find-match from within the Occur buffer
778
  (with-current-buffer
779
      ;; Choose the buffer and make it current.
780 781
      (if (next-error-buffer-p (current-buffer))
	  (current-buffer)
782 783 784
	(next-error-find-buffer nil nil
				(lambda ()
				  (eq major-mode 'occur-mode))))
785 786 787 788

    (goto-char (cond (reset (point-min))
		     ((< argp 0) (line-beginning-position))
		     ((line-end-position))))
789
    (occur-find-match
790 791
     (abs argp)
     (if (> 0 argp)
792 793 794 795 796 797
	 #'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)))
798

Juri Linkov's avatar
Juri Linkov committed
799 800 801 802 803 804 805 806 807 808 809 810
(defface match
  '((((class color) (min-colors 88) (background light))
     :background "Tan")
    (((class color) (min-colors 88) (background dark))
     :background "RoyalBlue4")
    (((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
811
  :version "22.1")
Juri Linkov's avatar
Juri Linkov committed
812

813
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
814 815
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
816 817 818
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
819

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

Juri Linkov's avatar
Juri Linkov committed
822
(defcustom list-matching-lines-face 'match
Dave Love's avatar
Dave Love committed
823
  "*Face used by \\[list-matching-lines] to show the text that matches.
824 825 826 827 828 829 830 831 832 833
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)

834
(defun occur-accumulate-lines (count &optional keep-props)
835 836
  (save-excursion
    (let ((forwardp (> count 0))
837
	  result beg end)
838 839 840 841
      (while (not (or (zerop count)
		      (if forwardp
			  (eobp)
			(bobp))))
842
	(setq count (+ count (if forwardp -1 1)))
843 844
	(setq beg (line-beginning-position)
	      end (line-end-position))
845
	(if (and keep-props (if (boundp 'jit-lock-mode) jit-lock-mode)
846
		 (text-property-not-all beg end 'fontified t))
847 848
	    (if (fboundp 'jit-lock-fontify-now)
		(jit-lock-fontify-now beg end)))
849
	(push
850 851 852
	 (funcall (if keep-props
		      #'buffer-substring
		    #'buffer-substring-no-properties)
853
		  beg end)
854 855 856 857 858 859 860 861 862 863
	 result)
	(forward-line (if forwardp 1 -1)))
      (nreverse result))))

(defun occur-read-primary-args ()
  (list (let* ((default (car regexp-history))
	       (input
		(read-from-minibuffer
		 (if default
		     (format "List lines matching regexp (default `%s'): "
864
			     (query-replace-descr default))
865 866 867 868
		   "List lines matching regexp: ")
		 nil
		 nil
		 nil
869 870
		 'regexp-history
		 default)))
871 872 873
	  (if (equal input "")
	      default
	    input))
874 875
	(when current-prefix-arg
	  (prefix-numeric-value current-prefix-arg))))
876

877 878 879 880 881
(defun occur-rename-buffer (&optional unique-p)
  "Rename the current *Occur* buffer to *Occur: original-buffer-name*.
Here `original-buffer-name' is the buffer name were occur was originally run.
When given the prefix argument, the renaming will not clobber the existing
buffer(s) of that name, but use `generate-new-buffer-name' instead.
882
You can add this to `occur-hook' if you always want a separate *Occur*
883 884 885 886 887 888 889 890 891 892
buffer for each buffer where you invoke `occur'."
  (interactive "P")
  (with-current-buffer
      (if (eq major-mode 'occur-mode) (current-buffer) (get-buffer "*Occur*"))
    (rename-buffer (concat "*Occur: "
                           (mapconcat #'buffer-name
                                      (car (cddr occur-revert-arguments)) "/")
                           "*")
                   unique-p)))

Richard M. Stallman's avatar
Richard M. Stallman committed
893
(defun occur (regexp &optional nlines)
894
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
895 896

If a match spreads across multiple lines, all those lines are shown.
Richard M. Stallman's avatar
Richard M. Stallman committed
897

Roland McGrath's avatar
Roland McGrath committed
898 899 900
Each line is displayed with NLINES lines before and after, or -NLINES
before if NLINES is negative.
NLINES defaults to `list-matching-lines-default-context-lines'.
Richard M. Stallman's avatar
Richard M. Stallman committed
901 902
Interactively it is the prefix arg.

903
The lines are shown in a buffer named `*Occur*'.
Richard M. Stallman's avatar
Richard M. Stallman committed
904
It serves as a menu to find any of the occurrences in this buffer.
905
\\<occur-mode-map>\\[describe-mode] in that buffer will explain how.
906

907 908
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
909 910 911 912 913 914 915
  (interactive (occur-read-primary-args))
  (occur-1 regexp nlines (list (current-buffer))))

(defun multi-occur (bufs regexp &optional nlines)
  "Show all lines in buffers BUFS containing a match for REGEXP.
This function acts on multiple buffers; otherwise, it is exactly like
`occur'."
916
  (interactive
917
   (cons
918 919 920 921
    (let* ((bufs (list (read-buffer "First buffer to search: "
				    (current-buffer) t)))
	   (buf nil)
	   (ido-ignore-item-temp-list bufs))
922
      (while (not (string-equal
923
		   (setq buf (read-buffer
924 925 926 927
			      (if (eq read-buffer-function 'ido-read-buffer)
				  "Next buffer to search (C-j to end): "
				"Next buffer to search (RET to end): ")
			      nil t))
928
		   ""))
929 930
	(add-to-list 'bufs buf)
	(setq ido-ignore-item-temp-list bufs))
931 932 933 934 935
      (nreverse (mapcar #'get-buffer bufs)))
    (occur-read-primary-args)))
  (occur-1 regexp nlines bufs))

(defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines)
936
  "Show all lines matching REGEXP in buffers named by BUFREGEXP.
937 938 939 940 941 942 943 944 945 946