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

3 4
;; Copyright (C) 1985, 86, 87, 92, 94, 96, 1997, 2000, 2001, 2002,
;;   2003, 2004 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
(defcustom query-replace-interactive nil
40
  "Non-nil means `query-replace' uses the last search string.
41 42 43 44 45 46
That becomes the \"string to replace\".
If value is `initial', the last search string is inserted into
the minibuffer as an initial value for \"string to replace\"."
  :type '(choice (const :tag "Off" nil)
                 (const :tag "Initial content" initial)
                 (other :tag "Use default value" t))
47
  :group 'matching)
48

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

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

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

73 74 75
(defun query-replace-read-args (string regexp-flag &optional noerror)
  (unless noerror
    (barf-if-buffer-read-only))
76
  (let (from to)
77 78 79
    (if (and query-replace-interactive
             (not (eq query-replace-interactive 'initial)))
        (setq from (car (if regexp-flag regexp-search-ring search-ring)))
80 81 82 83
      ;; 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
84 85 86 87 88 89 90
        (setq from (read-from-minibuffer
                    (format "%s: " string)
                    (if (eq query-replace-interactive 'initial)
                        (car (if regexp-flag regexp-search-ring search-ring)))
                    nil nil
                    query-replace-from-history-variable
                    nil t)))
91
      ;; Warn if user types \n or \t, but don't reject the input.
92 93 94 95 96 97 98 99 100
      (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))))
101

102
    (save-excursion
103 104 105 106
      (setq to (read-from-minibuffer
                (format "%s %s with: " string from)
                nil nil nil
                query-replace-to-history-variable from t)))
107 108 109 110 111 112 113 114 115 116 117 118 119 120
    (when (and regexp-flag
	       (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to))
      (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)
121 122 123 124 125 126 127 128 129 130 131 132
		     (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)
					      (= ?\( (aref to 0))))
				     (string-match " " to (cdr pos)))
				(1+ (cdr pos))
			      (cdr pos))))
		       (setq to (substring to end)))))
133 134 135
	      (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)))
	(setq to (nreverse (delete "" (cons to list)))))
      (replace-match-string-symbols to)
136
      (setq to (cons 'replace-eval-replacement
137 138 139
		     (if (> (length to) 1)
			 (cons 'concat to)
		       (car to)))))
140
    (list from to current-prefix-arg)))
141

142
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
143 144 145 146
  "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.

147 148 149
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.

150 151 152 153
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.

154 155 156 157 158 159 160
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.)
161

Richard M. Stallman's avatar
Richard M. Stallman committed
162
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
163
only matches surrounded by word boundaries.
164
Fourth and fifth arg START and END specify the region to operate on.
165 166

To customize possible responses, change the \"bindings\" in `query-replace-map'."
167 168 169 170 171 172 173 174 175 176
  (interactive (let ((common
		      (query-replace-read-args "Query replace" nil)))
		 (list (nth 0 common) (nth 1 common) (nth 2 common)
		       ;; These are done separately here
		       ;; so that command-history will record these expressions
		       ;; rather than the values they had this time.
		       (if (and transient-mark-mode mark-active)
			   (region-beginning))
		       (if (and transient-mark-mode mark-active)
			   (region-end)))))
177
  (perform-replace from-string to-string t nil delimited nil nil start end))
178

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

181
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
182 183 184 185
  "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.

186 187 188
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.

189 190 191 192
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.

193 194 195 196 197 198 199
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.)
200

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

Richard M. Stallman's avatar
Richard M. Stallman committed
205 206
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
207
whatever what matched the Nth `\\(...\\)' in REGEXP.
208 209 210
`\\?' lets you edit the replacement text in the minibuffer
at the given position for each replacement.

211 212 213 214 215 216 217 218
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
whole match as a sting, `\\N' for a partial match, `\\#&' and `\\#N'
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).
219

220 221
If the replacement expression is a symbol, write a space after it
to terminate it.  One space there, if any, will be discarded.
222 223 224 225

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."
226 227 228
  (interactive
   (let ((common
	  (query-replace-read-args "Query replace regexp" t)))
229 230 231 232 233 234 235 236
     (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)))))
237
  (perform-replace regexp to-string t t delimited nil nil start end))
238

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

241
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
242 243 244 245 246 247 248 249 250 251
  "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
252 253
`\\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.
254
Use `\\#&' or `\\#N' if you want a number instead of a string.
255
In interactive use, `\\#' in itself stands for `replace-count'.
256 257 258 259 260 261 262 263 264 265

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

267
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
268
only matches that are surrounded by word boundaries.
269
Fourth and fifth arg START and END specify the region to operate on."
270
  (interactive
271
   (let (from to)
272 273 274 275 276 277 278 279 280 281 282 283
     (if query-replace-interactive
         (setq from (car regexp-search-ring))
       (setq from (read-from-minibuffer "Query replace regexp: "
                                        nil nil nil
                                        query-replace-from-history-variable
                                        nil t)))
     (setq to (list (read-from-minibuffer
                     (format "Query replace regexp %s with eval: " from)
                     nil nil t query-replace-to-history-variable from t)))
     ;; 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)
284 285 286 287 288
     (list from (car to) current-prefix-arg
	   (if (and transient-mark-mode mark-active)
	       (region-beginning))
	   (if (and transient-mark-mode mark-active)
	       (region-end)))))
289
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
290
		   t 'literal delimited nil nil start end))
291

292
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
293
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
294 295 296 297 298
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
299 300
wrapping around from the last such string to the first.

301 302 303
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
304 305
Non-interactively, TO-STRINGS may be a list of replacement strings.

306 307 308
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
309
A prefix argument N says to use each replacement string N times
310 311
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
312
  (interactive
313
   (let (from to)
314 315 316 317
     (setq from (if query-replace-interactive
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
318
					'query-replace-history nil t)))
319 320 321 322
     (setq to (read-from-minibuffer
	       (format "Query replace %s with (space-separated strings): "
		       from)
	       nil nil nil
323
	       'query-replace-history from t))
324 325 326
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
327 328 329 330
	   (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
331 332 333 334 335 336 337 338 339 340 341 342 343
  (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 ""))))
344
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
345

346
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
347 348 349
  "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.
350 351 352
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

360 361 362 363
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
364 365
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
366 367
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
368 369 370
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.)"
371 372 373 374 375 376 377 378
  (interactive
   (let ((common
	  (query-replace-read-args "Replace string" nil)))
     (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)))))
379
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
380

381
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
382
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
383
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
384
are non-nil and REGEXP has no uppercase letters.
385 386 387 388

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

Richard M. Stallman's avatar
Richard M. Stallman committed
393 394
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
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
416

417 418 419
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
420 421 422
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
423
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
424
which will run faster and will not set the mark or print anything."
425 426 427 428 429 430 431 432
  (interactive
   (let ((common
	  (query-replace-read-args "Replace regexp" t)))
     (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)))))
433
  (perform-replace regexp to-string nil t delimited nil nil start end))
434

435 436 437

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
438

439

440
(defalias 'delete-non-matching-lines 'keep-lines)
441 442 443 444 445 446 447
(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.
448 449 450
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
			      'regexp-history nil t)))
451 452

(defun keep-lines (regexp &optional rstart rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
453 454
  "Delete all lines except those containing matches for REGEXP.
A match split across lines preserves all the lines it lies in.
455 456 457
Applies to all lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
458 459 460 461
the matching is case-sensitive.

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

462 463 464 465
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."

466
  (interactive
467 468 469
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
470
  (if rstart
471 472 473
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
474 475 476 477 478 479
    (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
480 481
  (save-excursion
    (or (bolp) (forward-line 1))
482 483 484
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
485
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
486
	;; Start is first char not preserved by previous match.
487 488
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
489 490 491 492 493 494
	  (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))))
495

496
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
497
	;; If the match was empty, avoid matching again at same place.
498 499
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
500 501
	     (forward-char 1))))))

502 503

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
509 510 511 512
the matching is case-sensitive.

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

513 514 515 516
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."

517
  (interactive
518 519 520
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
521
  (if rstart
522 523 524
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
525 526 527 528 529 530
    (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))
531 532 533
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
534 535
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
536 537 538 539
	(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
540

541 542

(defun how-many (regexp &optional rstart rend)
543 544 545
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
546 547 548 549
the matching is case-sensitive.

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

550 551 552 553
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."

554 555
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
556 557 558
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
559 560 561 562 563 564
      (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))
565 566 567 568 569 570 571 572 573 574 575
    (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))))
576

577

578 579 580 581 582
(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)
583
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
584
    (define-key map "\C-o" 'occur-mode-display-occurrence)
585 586
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
587 588
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
589
    (define-key map "g" 'revert-buffer)
590 591
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
592 593
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
594

595 596 597
(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
598

599 600 601 602 603 604 605
(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."
606 607 608
  :type 'hook
  :group 'matching)

609
(put 'occur-mode 'mode-class 'special)
610
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
611
  "Major mode for output from \\[occur].
612 613 614 615
\\<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
616
\\{occur-mode-map}"
617
  (interactive)
618 619 620 621
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
622
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
623
  (make-local-variable 'occur-revert-arguments)
624
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
625
  (setq next-error-function 'occur-next-error)
626
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
627

628
(defun occur-revert-function (ignore1 ignore2)
629
  "Handle `revert-buffer' for Occur mode buffers."
630
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
631

632 633 634
(defun occur-mode-mouse-goto (event)
  "In Occur mode, go to the occurrence whose line you click on."
  (interactive "e")
635
  (let (pos)
636 637 638 639
    (save-excursion
      (set-buffer (window-buffer (posn-window (event-end event))))
      (save-excursion
	(goto-char (posn-point (event-end event)))
640 641 642
	(setq pos (occur-mode-find-occurrence))))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
643 644

(defun occur-mode-find-occurrence ()
645 646
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
647
      (error "No occurrence on this line"))
648 649 650
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
651 652 653 654

(defun occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
655 656 657
  (let ((pos (occur-mode-find-occurrence)))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
658

659 660 661
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
662 663 664
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
665

666 667 668
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
669 670 671
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
672
	same-window-buffer-names
673 674
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
675 676 677
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
678
      (goto-char pos))))
679

680
(defun occur-find-match (n search message)
681 682 683
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
684 685 686 687
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
688
      (if r
689 690
          (goto-char r)
        (error message))
691 692
      (setq n (1- n)))))

693 694 695 696 697
(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"))

698
(defun occur-prev (&optional n)
699
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
700
  (interactive "p")
701
  (occur-find-match n #'previous-single-property-change "No earlier matches"))
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716

(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")
  (when reset
    (occur-find-match 0 #'next-single-property-change "No first match"))
  (occur-find-match
   (prefix-numeric-value argp)
   (if (> 0 (prefix-numeric-value argp))
       #'previous-single-property-change
     #'next-single-property-change)
   "No more matches")
  (occur-mode-goto-occurrence))

717

718
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
719 720
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
721 722 723
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
724

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

727
(defcustom list-matching-lines-face 'bold
Dave Love's avatar
Dave Love committed
728
  "*Face used by \\[list-matching-lines] to show the text that matches.
729 730 731 732 733 734 735 736 737 738
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)

739
(defun occur-accumulate-lines (count &optional no-props)
740 741 742 743 744 745 746
  (save-excursion
    (let ((forwardp (> count 0))
	  (result nil))
      (while (not (or (zerop count)
		      (if forwardp
			  (eobp)
			(bobp))))
747
	(setq count (+ count (if forwardp -1 1)))
748
	(push
749 750 751
	 (funcall (if no-props
		      #'buffer-substring-no-properties
		    #'buffer-substring)
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
	  (line-beginning-position)
	  (line-end-position))
	 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'): "
			     default)
		   "List lines matching regexp: ")
		 nil
		 nil
		 nil
		 'regexp-history)))
	  (if (equal input "")
	      default
	    input))
773 774
	(when current-prefix-arg
	  (prefix-numeric-value current-prefix-arg))))
775

776 777 778 779 780
(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.
781
You can add this to `occur-hook' if you always want a separate *Occur*
782 783 784 785 786 787 788 789 790 791
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
792
(defun occur (regexp &optional nlines)
793
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
794 795

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

Roland McGrath's avatar
Roland McGrath committed
797 798 799
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
800 801
Interactively it is the prefix arg.

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

806 807
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
808 809 810 811 812 813 814
  (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'."
815
  (interactive
816
   (cons
817 818 819 820
    (let* ((bufs (list (read-buffer "First buffer to search: "
				    (current-buffer) t)))
	   (buf nil)
	   (ido-ignore-item-temp-list bufs))
821
      (while (not (string-equal
822
		   (setq buf (read-buffer
823 824 825 826
			      (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))
827
		   ""))
828 829
	(add-to-list 'bufs buf)
	(setq ido-ignore-item-temp-list bufs))
830 831 832 833 834
      (nreverse (mapcar #'get-buffer bufs)))
    (occur-read-primary-args)))
  (occur-1 regexp nlines bufs))

(defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines)
835
  "Show all lines matching REGEXP in buffers named by BUFREGEXP.
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
See also `multi-occur'."
  (interactive
   (cons
    (let* ((default (car regexp-history))
	   (input
	    (read-from-minibuffer
	     "List lines in buffers whose filename matches regexp: "
	     nil
	     nil
	     nil
	     'regexp-history)))
      (if (equal input "")
	  default
	input))
    (occur-read-primary-args)))
  (when bufregexp
    (occur-1 regexp nlines
	     (delq nil
		   (mapcar (lambda (buf)
			     (when (and (buffer-file-name buf)
					(string-match bufregexp
						      (buffer-file-name buf)))
			       buf))
			   (buffer-list))))))

861 862 863 864
(defun occur-1 (regexp nlines bufs &optional buf-name)
  (unless buf-name
    (setq buf-name "*Occur*"))
  (let ((occur-buf (get-buffer-create buf-name))
865 866 867 868 869 870 871 872 873 874
	(made-temp-buf nil)
	(active-bufs (delq nil (mapcar #'(lambda (buf)
					   (when (buffer-live-p buf) buf))
				       bufs))))
    ;; Handle the case where one of the buffers we're searching is the
    ;; *Occur* buffer itself.
    (when (memq occur-buf bufs)
      (setq occur-buf (with-current-buffer occur-buf
			(clone-buffer "*Occur-temp*"))
	    made-temp-buf t))
875 876 877 878 879
    (with-current-buffer occur-buf
      (setq buffer-read-only nil)
      (occur-mode)
      (erase-buffer)
      (let ((count (occur-engine
880
		    regexp active-bufs occur-buf
881 882 883
		    (or nlines list-matching-lines-default-context-lines)
		    (and case-fold-search
			 (isearch-no-upper-case-p regexp t))
884 885
		    list-matching-lines-buffer-name-face
		    nil list-matching-lines-face nil)))
886 887 888 889 890 891 892 893
	(let* ((bufcount (length active-bufs))
	       (diff (- (length bufs) bufcount)))
	  (message "Searched %d buffer%s%s; %s match%s for `%s'"
		   bufcount (if (= bufcount 1) "" "s")
		   (if (zerop diff) "" (format " (%d killed)" diff))
		   (if (zerop count) "no" (format "%d" count))
		   (if (= count 1) "" "es")
		   regexp))
894 895 896
	;; If we had to make a temporary buffer, make it the *Occur*
	;; buffer now.
	(when made-temp-buf
897 898 899
	  (with-current-buffer (get-buffer buf-name)
	    (kill-buffer (current-buffer)))
	  (rename-buffer buf-name))
900 901
	(setq occur-revert-arguments (list regexp nlines bufs)
	      buffer-read-only t)
902
	(if (> count 0)
903 904 905
	    (progn
	      (display-buffer occur-buf)
	      (setq next-error-last-buffer occur-buf))
906 907
	  (kill-buffer occur-buf)))
      (run-hooks 'occur-hook))))
908

909 910 911
(defun occur-engine-add-prefix (lines)
  (mapcar
   #'(lambda (line)
912
       (concat "       :" line "\n"))
913 914 915 916 917 918
   lines))

(defun occur-engine (regexp buffers out-buf nlines case-fold-search
			    title-face prefix-face match-face keep-props)
  (with-current-buffer out-buf
    (setq buffer-read-only nil)
919 920
    (let ((globalcount 0)
	  (coding nil))
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
      ;; Map over all the buffers
      (dolist (buf buffers)
	(when (buffer-live-p buf)
	  (let ((matches 0)	;; count of matched lines
		(lines 1)	;; line count
		(matchbeg 0)
		(matchend 0)
		(origpt nil)
		(begpt nil)
		(endpt nil)
		(marker nil)
		(curstring "")
		(headerpt (with-current-buffer out-buf (point))))
	    (save-excursion
	      (set-buffer buf)
936 937 938 939 940
	      (or coding
		  ;; Set CODING only if the current buffer locally
		  ;; binds buffer-file-coding-system.
		  (not (local-variable-p 'buffer-file-coding-system))
		  (setq coding buffer-file-coding-system))
941
	      (save-excursion
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
		(goto-char (point-min)) ;; begin searching in the buffer
		(while (not (eobp))
		  (setq origpt (point))
		  (when (setq endpt (re-search-forward regexp nil t))
		    (setq matches (1+ matches)) ;; increment match count
		    (setq matchbeg (match-beginning 0)
			  matchend (match-end 0))
		    (setq begpt (save-excursion
				  (goto-char matchbeg)
				  (line-beginning-position)))
		    (setq lines (+ lines (1- (count-lines origpt endpt))))
		    (setq marker (make-marker))
		    (set-marker marker matchbeg)
		    (setq curstring (buffer-substring begpt
						      (line-end-position)))
		    ;; Depropertize the string, and maybe
		    ;; highlight the matches
		    (let ((len (length curstring))
			  (start 0))
		      (unless keep-props
			(set-text-properties 0 len nil curstring))
		      (while (and (< start len)
				  (string-match regexp curstring start))
			(add-text-properties (match-beginning 0)
					     (match-end 0)
					     (append
968
					      `(occur-match t)
969
					      (when match-face
970
						`(font-lock-face ,match-face)))
971 972 973 974 975
					     curstring)
			(setq start (match-end 0))))
		    ;; Generate the string to insert for this match
		    (let* ((out-line
			    (concat
976 977
			     ;; Using 7 digits aligns tabs properly.
			     (apply #'propertize (format "%7d:" lines)
978 979
				    (append
				     (when prefix-face
980
				       `(font-lock-face prefix-face))
981 982 983 984 985 986 987 988 989 990 991 992
				     '(occur-prefix t)))
			     curstring
			     "\n"))
			   (data
			    (if (= nlines 0)
				;; The simple display style
				out-line
			      ;; The complex multi-line display
			      ;; style.  Generate a list of lines,
			      ;; concatenate them all together.
			      (apply #'concat
				     (nconc
993
				      (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ nlines)) keep-props))))
994
				      (list out-line)
995
				      (occur-engine-add-prefix (cdr (occur-accumulate-lines (1+ nlines) keep-props))))))))
996 997 998 999 1000 1001 1002
		      ;; Actually insert the match display data
		      (with-current-buffer out-buf
			(let ((beg (point))
			      (end (progn (insert data) (point))))
			  (unless (= nlines 0)
			    (insert "-------\n"))
			  (add-text-properties
1003 1004 1005 1006 1007
			   beg end
			   `(occur-target ,marker help-echo "mouse-2: go to this occurrence"))
			  ;; We don't put `mouse-face' on the newline,
			  ;; because that loses.
			  (add-text-properties beg (1- end) '(mouse-face highlight)))))
1008
		    (goto-char endpt))