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

3
;; Copyright (C) 1985, 86, 87, 92, 94, 96, 1997, 2000, 2001, 2002
4
;;  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
That becomes the \"string to replace\"."
  :type 'boolean
  :group 'matching)
44

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

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

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

69 70 71
(defun query-replace-read-args (string regexp-flag &optional noerror)
  (unless noerror
    (barf-if-buffer-read-only))
72
  (let (from to)
73 74
    (if query-replace-interactive
	(setq from (car (if regexp-flag regexp-search-ring search-ring)))
75 76 77 78 79 80 81 82
      ;; 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
	(setq from (read-from-minibuffer (format "%s: " string)
					 nil nil nil
					 query-replace-from-history-variable
					 nil t)))
83 84 85 86 87 88 89 90 91 92
      ;; Warn if user types \n or \t, but don't reject the input.
      (if (string-match "\\\\[nt]" from)
	  (let ((match (match-string 0 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))))

93 94 95 96
    (save-excursion
      (setq to (read-from-minibuffer (format "%s %s with: " string from)
				     nil nil nil
				     query-replace-to-history-variable from t)))
97
    (list from to current-prefix-arg)))
98

99
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
100 101 102 103
  "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.

104 105 106
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.

107 108 109 110
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.

111 112 113 114 115 116 117
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.)
118

Richard M. Stallman's avatar
Richard M. Stallman committed
119
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
120
only matches surrounded by word boundaries.
121
Fourth and fifth arg START and END specify the region to operate on.
122 123

To customize possible responses, change the \"bindings\" in `query-replace-map'."
124 125 126 127 128 129 130 131 132 133
  (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)))))
134
  (perform-replace from-string to-string t nil delimited nil nil start end))
135

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

138
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
139 140 141 142
  "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.

143 144 145
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.

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

150 151 152 153 154 155 156
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.)
157

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

Richard M. Stallman's avatar
Richard M. Stallman committed
162 163 164
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
 whatever what matched the Nth `\\(...\\)' in REGEXP."
165 166 167 168 169 170 171 172 173 174 175 176
  (interactive
   (let ((common
	  (query-replace-read-args "Query replace regexp" t)))
     (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 regexp to-string t t delimited nil nil start end))
178
(define-key esc-map [?\C-%] 'query-replace-regexp)
Roland McGrath's avatar
Roland McGrath committed
179

180
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
181 182 183 184 185 186 187 188 189 190
  "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
191 192
`\\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.
193 194 195 196 197 198 199 200 201 202 203
Use `\\#&' or `\\#N' if you want a number instead of a string.

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

205
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
206
only matches that are surrounded by word boundaries.
207
Fourth and fifth arg START and END specify the region to operate on."
208
  (interactive
209
   (let (from to)
210 211 212 213 214 215 216 217 218 219 220 221
     (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)
222 223 224 225 226
     (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)))))
227
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
228
		   t 'literal delimited nil nil start end))
229

230
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
231
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
232 233 234 235 236
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
237 238
wrapping around from the last such string to the first.

239 240 241
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
242 243
Non-interactively, TO-STRINGS may be a list of replacement strings.

244 245 246
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
247
A prefix argument N says to use each replacement string N times
248 249
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
250
  (interactive
251
   (let (from to)
252 253 254 255
     (setq from (if query-replace-interactive
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
256
					'query-replace-history nil t)))
257 258 259 260
     (setq to (read-from-minibuffer
	       (format "Query replace %s with (space-separated strings): "
		       from)
	       nil nil nil
261
	       'query-replace-history from t))
262 263 264
     (list from to
	   (and current-prefix-arg
		(prefix-numeric-value current-prefix-arg))
265 266 267 268
	   (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
269 270 271 272 273 274 275 276 277 278 279 280 281
  (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 ""))))
282
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
283

284
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
285 286 287
  "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.
288 289 290
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

298 299 300 301
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
302 303
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
304 305
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
306 307 308
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.)"
309 310 311 312 313 314 315 316
  (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)))))
317
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
318

319
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
320
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
321
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
322
are non-nil and REGEXP has no uppercase letters.
323 324 325 326

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

Richard M. Stallman's avatar
Richard M. Stallman committed
331 332
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
333
 whatever what matched the Nth `\\(...\\)' in REGEXP.
Roland McGrath's avatar
Roland McGrath committed
334

335 336 337
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
338 339 340
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
341
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
342
which will run faster and will not set the mark or print anything."
343 344 345 346 347 348 349 350
  (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)))))
351
  (perform-replace regexp to-string nil t delimited nil nil start end))
352

353 354 355

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
356

357

358
(defalias 'delete-non-matching-lines 'keep-lines)
359 360 361 362 363 364 365
(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.
366 367 368
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
			      'regexp-history nil t)))
369 370

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
376 377 378 379
the matching is case-sensitive.

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

380 381 382 383
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."

384
  (interactive
385 386 387
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
388
  (if rstart
389 390 391
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
392 393 394 395 396 397
    (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
398 399
  (save-excursion
    (or (bolp) (forward-line 1))
400 401 402
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
403
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
404
	;; Start is first char not preserved by previous match.
405 406
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
407 408 409 410 411 412
	  (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))))
413

414
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
415
	;; If the match was empty, avoid matching again at same place.
416 417
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
418 419
	     (forward-char 1))))))

420 421

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
427 428 429 430
the matching is case-sensitive.

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

431 432 433 434
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."

435
  (interactive
436 437 438
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
439
  (if rstart
440 441 442
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
443 444 445 446 447 448
    (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))
449 450 451
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
452 453
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
454 455 456 457
	(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
458

459 460

(defun how-many (regexp &optional rstart rend)
461 462 463
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
464 465 466 467
the matching is case-sensitive.

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

468 469 470 471
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."

472 473
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
474 475 476
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
477 478 479 480 481 482
      (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))
483 484 485 486 487 488 489 490 491 492 493
    (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))))
494

495

496 497 498 499 500
(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)
501
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
502
    (define-key map "\C-o" 'occur-mode-display-occurrence)
503 504
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
505 506
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
507
    (define-key map "g" 'revert-buffer)
508 509
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
510 511
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
512

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

517 518 519 520 521 522 523
(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."
524 525 526
  :type 'hook
  :group 'matching)

527
(put 'occur-mode 'mode-class 'special)
528
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
529
  "Major mode for output from \\[occur].
530 531 532 533
\\<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
534
\\{occur-mode-map}"
535
  (interactive)
536 537 538 539
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
540
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
541
  (make-local-variable 'occur-revert-arguments)
542
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
543
  (setq next-error-function 'occur-next-error)
544
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
545

546
(defun occur-revert-function (ignore1 ignore2)
547
  "Handle `revert-buffer' for Occur mode buffers."
548
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
549

550 551 552
(defun occur-mode-mouse-goto (event)
  "In Occur mode, go to the occurrence whose line you click on."
  (interactive "e")
553
  (let (pos)
554 555 556 557
    (save-excursion
      (set-buffer (window-buffer (posn-window (event-end event))))
      (save-excursion
	(goto-char (posn-point (event-end event)))
558 559 560
	(setq pos (occur-mode-find-occurrence))))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
561 562

(defun occur-mode-find-occurrence ()
563 564
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
565
      (error "No occurrence on this line"))
566 567 568
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
569 570 571 572

(defun occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
573 574 575
  (let ((pos (occur-mode-find-occurrence)))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
576

577 578 579
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
580 581 582
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
583

584 585 586
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
587 588 589
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
590
	same-window-buffer-names
591 592
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
593 594 595
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
596
      (goto-char pos))))
597

598
(defun occur-find-match (n search message)
599 600 601
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
602 603 604 605
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
606
      (if r
607 608
          (goto-char r)
        (error message))
609 610
      (setq n (1- n)))))

611 612 613 614 615
(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"))

616
(defun occur-prev (&optional n)
617
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
618
  (interactive "p")
619
  (occur-find-match n #'previous-single-property-change "No earlier matches"))
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634

(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))

635

636
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
637 638
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
639 640 641
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
642

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

645
(defcustom list-matching-lines-face 'bold
Dave Love's avatar
Dave Love committed
646
  "*Face used by \\[list-matching-lines] to show the text that matches.
647 648 649 650 651 652 653 654 655 656
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)

657
(defun occur-accumulate-lines (count &optional no-props)
658 659 660 661 662 663 664
  (save-excursion
    (let ((forwardp (> count 0))
	  (result nil))
      (while (not (or (zerop count)
		      (if forwardp
			  (eobp)
			(bobp))))
665
	(setq count (+ count (if forwardp -1 1)))
666
	(push
667 668 669
	 (funcall (if no-props
		      #'buffer-substring-no-properties
		    #'buffer-substring)
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
	  (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))
691 692
	(when current-prefix-arg
	  (prefix-numeric-value current-prefix-arg))))
693

694 695 696 697 698
(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.
699
You can add this to `occur-hook' if you always want a separate *Occur*
700 701 702 703 704 705 706 707 708 709
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
710
(defun occur (regexp &optional nlines)
711
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
712 713

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

Roland McGrath's avatar
Roland McGrath committed
715 716 717
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
718 719
Interactively it is the prefix arg.

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

724 725
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
726 727 728 729 730 731 732
  (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'."
733
  (interactive
734
   (cons
735 736 737 738
    (let* ((bufs (list (read-buffer "First buffer to search: "
				    (current-buffer) t)))
	   (buf nil)
	   (ido-ignore-item-temp-list bufs))
739
      (while (not (string-equal
740
		   (setq buf (read-buffer
741 742 743 744
			      (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))
745
		   ""))
746 747
	(add-to-list 'bufs buf)
	(setq ido-ignore-item-temp-list bufs))
748 749 750 751 752
      (nreverse (mapcar #'get-buffer bufs)))
    (occur-read-primary-args)))
  (occur-1 regexp nlines bufs))

(defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines)
753
  "Show all lines matching REGEXP in buffers named by BUFREGEXP.
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
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))))))

779 780 781 782
(defun occur-1 (regexp nlines bufs &optional buf-name)
  (unless buf-name
    (setq buf-name "*Occur*"))
  (let ((occur-buf (get-buffer-create buf-name))
783 784 785 786 787 788 789 790 791 792
	(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))
793 794 795 796 797
    (with-current-buffer occur-buf
      (setq buffer-read-only nil)
      (occur-mode)
      (erase-buffer)
      (let ((count (occur-engine
798
		    regexp active-bufs occur-buf
799 800 801
		    (or nlines list-matching-lines-default-context-lines)
		    (and case-fold-search
			 (isearch-no-upper-case-p regexp t))
802 803
		    list-matching-lines-buffer-name-face
		    nil list-matching-lines-face nil)))
804 805 806 807 808 809 810 811
	(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))
812 813 814
	;; If we had to make a temporary buffer, make it the *Occur*
	;; buffer now.
	(when made-temp-buf
815 816 817
	  (with-current-buffer (get-buffer buf-name)
	    (kill-buffer (current-buffer)))
	  (rename-buffer buf-name))
818 819
	(setq occur-revert-arguments (list regexp nlines bufs)
	      buffer-read-only t)
820
	(if (> count 0)
821 822 823
	    (progn
	      (display-buffer occur-buf)
	      (setq next-error-last-buffer occur-buf))
824 825
	  (kill-buffer occur-buf)))
      (run-hooks 'occur-hook))))
826

827 828 829
(defun occur-engine-add-prefix (lines)
  (mapcar
   #'(lambda (line)
830
       (concat "       :" line "\n"))
831 832 833 834 835 836
   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)
837 838
    (let ((globalcount 0)
	  (coding nil))
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
      ;; 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)
854 855 856 857 858
	      (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))
859
	      (save-excursion
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
		(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
886
					      `(occur-match t)
887
					      (when match-face
888
						`(font-lock-face ,match-face)))
889 890 891 892 893
					     curstring)
			(setq start (match-end 0))))
		    ;; Generate the string to insert for this match
		    (let* ((out-line
			    (concat
894 895
			     ;; Using 7 digits aligns tabs properly.
			     (apply #'propertize (format "%7d:" lines)
896 897
				    (append
				     (when prefix-face
898
				       `(font-lock-face prefix-face))
899 900 901 902 903 904 905 906 907 908 909 910
				     '(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
911
				      (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ nlines)) keep-props))))
912
				      (list out-line)
913
				      (occur-engine-add-prefix (cdr (occur-accumulate-lines (1+ nlines) keep-props))))))))
914 915 916 917 918 919 920
		      ;; 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
921 922 923 924 925
			   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)))))
926
		    (goto-char endpt))
927 928 929 930 931 932
		  (if endpt
		      (progn
			(setq lines (1+ lines))
			;; On to the next match...
			(forward-line 1))
		    (goto-char (point-max))))))
933
	    (when (not (zerop matches)) ;; is the count zero?
934
	      (setq globalcount (+ globalcount matches))
935 936 937 938
	      (with-current-buffer out-buf
		(goto-char headerpt)
		(let ((beg (point))
		      end)
939 940 941
		  (insert (format "%d match%s for \"%s\" in buffer: %s\n"
				  matches (if (= matches 1) "" "es")
				  regexp (buffer-name buf)))
942 943 944 945
		  (setq end (point))
		  (add-text-properties beg end
				       (append
					(when title-face
946 947
					  `(font-lock-face ,title-face))
					`(occur-title ,buf))))
948
		(goto-char (point-min)))))))
949 950 951 952 953
      (if coding
	  ;; CODING is buffer-file-coding-system of the first buffer
	  ;; that locally binds it.  Let's use it also for the output
	  ;; buffer.
	  (set-buffer-file-coding-system coding))
954 955
      ;; Return the number of matches
      globalcount)))
956

Richard M. Stallman's avatar
Richard M. Stallman committed
957

958 959
;; It would be nice to use \\[...], but there is no reasonable way
;; to make that display both SPC and Y.
Richard M. Stallman's avatar
Richard M. Stallman committed
960 961
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
962
RET or `q' to exit, Period to replace one match and exit,
Richard M. Stallman's avatar
Richard M. Stallman committed
963 964 965 966 967
Comma to replace but not move point immediately,
C-r to enter recursive edit (\\[exit-recursive-edit] to get out again),
C-w to delete match and recursive edit,
C-l to clear the screen, redisplay, and offer same replacement again,
! to replace all remaining matches with no more questions,
968 969
^ to move point back to previous match,
E to edit the replacement string"
970
  "Help message while in `query-replace'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
971

972 973 974 975 976
(defvar query-replace-map (make-sparse-keymap)
  "Keymap that defines the responses to questions in `query-replace'.
The \"bindings\" in this map are not commands; they are answers.
The valid answers include `act', `skip', `act-and-show',
`exit', `act-and-exit', `edit', `delete-and-edit', `recenter',
977
`automatic', `backup', `exit-prefix', and `help'.")
978 979 980 981

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
982
(define-key query-replace-map [backspace] 'skip)
983 984
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
985 986
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
987
(define-key query-replace-map "e" 'edit-replacement)
988
(define-key query-replace-map "E" 'edit-replacement)