replace.el 46.6 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 40 41 42
(defvar query-replace-interactive nil
  "Non-nil means `query-replace' uses the last search string.
That becomes the \"string to replace\".")

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 "21.4")
66

67 68 69
(defun query-replace-read-args (string regexp-flag &optional noerror)
  (unless noerror
    (barf-if-buffer-read-only))
70
  (let (from to)
71 72 73 74
    (if query-replace-interactive
	(setq from (car (if regexp-flag regexp-search-ring search-ring)))
      (setq from (read-from-minibuffer (format "%s: " string)
				       nil nil nil
75
				       query-replace-from-history-variable
76 77 78 79 80 81 82 83 84 85 86
				       nil t))
      ;; 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))))

87 88
    (setq to (read-from-minibuffer (format "%s %s with: " string from)
				   nil nil nil
89
				   query-replace-to-history-variable from t))
90 91 92
    (if (and transient-mark-mode mark-active)
	(list from to current-prefix-arg (region-beginning) (region-end))
      (list from to current-prefix-arg nil nil))))
93

94
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
95 96 97 98
  "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.

99 100 101
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.

102 103 104 105
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.

106 107 108 109 110 111 112
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.)
113

Richard M. Stallman's avatar
Richard M. Stallman committed
114
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
115
only matches surrounded by word boundaries.
116
Fourth and fifth arg START and END specify the region to operate on.
117 118

To customize possible responses, change the \"bindings\" in `query-replace-map'."
119
  (interactive (query-replace-read-args "Query replace" nil))
120
  (perform-replace from-string to-string t nil delimited nil nil start end))
121

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

124
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
125 126 127 128
  "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.

129 130 131
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.

132 133 134 135
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.

136 137 138 139 140 141 142
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.)
143

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

Richard M. Stallman's avatar
Richard M. Stallman committed
148 149 150
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."
151
  (interactive (query-replace-read-args "Query replace regexp" t))
152
  (perform-replace regexp to-string t t delimited nil nil start end))
153
(define-key esc-map [?\C-%] 'query-replace-regexp)
Roland McGrath's avatar
Roland McGrath committed
154

155
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
156 157 158 159 160 161 162 163 164 165
  "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
166 167
`\\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.
168 169 170 171 172 173 174 175 176 177 178
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.
179

180
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
181
only matches that are surrounded by word boundaries.
182
Fourth and fifth arg START and END specify the region to operate on."
183
  (interactive
184 185 186 187
   (let (from to start end)
     (when (and transient-mark-mode mark-active)
       (setq start (region-beginning)
	     end (region-end)))
188 189 190 191 192 193 194 195 196 197 198 199
     (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)
200
     (list from (car to) current-prefix-arg start end)))
201
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
202
		   t t delimited nil nil start end))
203

204
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
205
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
206 207 208 209 210
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
211 212
wrapping around from the last such string to the first.

213 214 215
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
216 217
Non-interactively, TO-STRINGS may be a list of replacement strings.

218 219 220
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
221
A prefix argument N says to use each replacement string N times
222 223
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
224
  (interactive
225 226 227 228
   (let (from to start end)
     (when (and transient-mark-mode mark-active)
       (setq start (region-beginning)
	     end (region-end)))
229 230 231 232
     (setq from (if query-replace-interactive
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
233
					'query-replace-history nil t)))
234 235 236 237
     (setq to (read-from-minibuffer
	       (format "Query replace %s with (space-separated strings): "
		       from)
	       nil nil nil
238
	       'query-replace-history from t))
239
     (list from to start end current-prefix-arg)))
Roland McGrath's avatar
Roland McGrath committed
240 241 242 243 244 245 246 247 248 249 250 251 252
  (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 ""))))
253
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
254

255
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
256 257 258
  "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.
259 260 261
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

269 270 271 272
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
273 274
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
275 276
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
277 278 279
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.)"
280
  (interactive (query-replace-read-args "Replace string" nil))
281
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
282

283
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
284
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
285
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
286
are non-nil and REGEXP has no uppercase letters.
287 288 289 290

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

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

299 300 301
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
302 303 304
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
305
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
306
which will run faster and will not set the mark or print anything."
307
  (interactive (query-replace-read-args "Replace regexp" t))
308
  (perform-replace regexp to-string nil t delimited nil nil start end))
309

310 311 312

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
313

314

315
(defalias 'delete-non-matching-lines 'keep-lines)
316 317 318 319 320 321 322
(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.
323 324 325
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
			      'regexp-history nil t)))
326 327

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
333 334 335 336
the matching is case-sensitive.

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

337 338 339 340
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."

341
  (interactive
342 343 344
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Keep lines (containing match for regexp): ")))
345
  (if rstart
346 347 348
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
349 350 351 352 353 354
    (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
355 356
  (save-excursion
    (or (bolp) (forward-line 1))
357 358 359
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
360
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
361
	;; Start is first char not preserved by previous match.
362 363
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
364 365 366 367 368 369
	  (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))))
370

371
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
372
	;; If the match was empty, avoid matching again at same place.
373 374
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
375 376
	     (forward-char 1))))))

377 378

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
384 385 386 387
the matching is case-sensitive.

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

388 389 390 391
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."

392
  (interactive
393 394 395
   (progn
     (barf-if-buffer-read-only)
     (keep-lines-read-args "Flush lines (containing match for regexp): ")))
396
  (if rstart
397 398 399
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
400 401 402 403 404 405
    (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))
406 407 408
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
409 410
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
411 412 413 414
	(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
415

416 417

(defun how-many (regexp &optional rstart rend)
418 419 420
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
421 422 423 424
the matching is case-sensitive.

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

425 426 427 428
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."

429 430
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
431 432 433
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
434 435 436 437 438 439
      (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))
440 441 442 443 444 445 446 447 448 449 450
    (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))))
451

452

453 454 455 456 457
(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)
458
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
459
    (define-key map "\C-o" 'occur-mode-display-occurrence)
460 461
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
462 463
    (define-key map "r" 'occur-rename-buffer)
    (define-key map "c" 'clone-buffer)
464
    (define-key map "g" 'revert-buffer)
465 466
    (define-key map "q" 'quit-window)
    (define-key map "z" 'kill-this-buffer)
467 468
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
469

470 471 472
(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
473

474 475 476 477 478 479 480
(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."
481 482 483
  :type 'hook
  :group 'matching)

484
(put 'occur-mode 'mode-class 'special)
485
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
486
  "Major mode for output from \\[occur].
487 488 489 490
\\<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
491
\\{occur-mode-map}"
492
  (interactive)
493 494 495 496
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
497
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
498
  (make-local-variable 'occur-revert-arguments)
499
  (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
500
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
501

502
(defun occur-revert-function (ignore1 ignore2)
503
  "Handle `revert-buffer' for Occur mode buffers."
504
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
505

506 507 508
(defun occur-mode-mouse-goto (event)
  "In Occur mode, go to the occurrence whose line you click on."
  (interactive "e")
509
  (let (pos)
510 511 512 513
    (save-excursion
      (set-buffer (window-buffer (posn-window (event-end event))))
      (save-excursion
	(goto-char (posn-point (event-end event)))
514 515 516
	(setq pos (occur-mode-find-occurrence))))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
517 518

(defun occur-mode-find-occurrence ()
519 520
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
521
      (error "No occurrence on this line"))
522 523 524
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
525 526 527 528

(defun occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
529 530 531
  (let ((pos (occur-mode-find-occurrence)))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
532

533 534 535
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
536 537 538
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
539

540 541 542
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
543 544 545
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
546
	same-window-buffer-names
547 548
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
549 550 551
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
552
      (goto-char pos))))
553

554
(defun occur-find-match (n search message)
555 556 557
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
558 559 560 561
      (setq r (funcall search (point) 'occur-match))
      (and r
           (get-text-property r 'occur-match)
           (setq r (funcall search r 'occur-match)))
562
      (if r
563 564
          (goto-char r)
        (error message))
565 566
      (setq n (1- n)))))

567 568 569 570 571
(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"))

572
(defun occur-prev (&optional n)
573
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
574
  (interactive "p")
575
  (occur-find-match n #'previous-single-property-change "No earlier matches"))
576

577
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
578 579
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
580 581 582
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
583

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

586
(defcustom list-matching-lines-face 'bold
Dave Love's avatar
Dave Love committed
587
  "*Face used by \\[list-matching-lines] to show the text that matches.
588 589 590 591 592 593 594 595 596 597
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)

598
(defun occur-accumulate-lines (count &optional no-props)
599 600 601 602 603 604 605
  (save-excursion
    (let ((forwardp (> count 0))
	  (result nil))
      (while (not (or (zerop count)
		      (if forwardp
			  (eobp)
			(bobp))))
606
	(setq count (+ count (if forwardp -1 1)))
607
	(push
608 609 610
	 (funcall (if no-props
		      #'buffer-substring-no-properties
		    #'buffer-substring)
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
	  (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))
632 633
	(when current-prefix-arg
	  (prefix-numeric-value current-prefix-arg))))
634

635 636 637 638 639
(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.
640
You can add this to `occur-hook' if you always want a separate *Occur*
641 642 643 644 645 646 647 648 649 650
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
651
(defun occur (regexp &optional nlines)
652
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
653 654

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

Roland McGrath's avatar
Roland McGrath committed
656 657 658
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
659 660
Interactively it is the prefix arg.

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

665 666
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
667 668 669 670 671 672 673
  (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'."
674
  (interactive
675
   (cons
676 677 678 679
    (let* ((bufs (list (read-buffer "First buffer to search: "
				    (current-buffer) t)))
	   (buf nil)
	   (ido-ignore-item-temp-list bufs))
680
      (while (not (string-equal
681
		   (setq buf (read-buffer
682 683 684 685
			      (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))
686
		   ""))
687 688
	(add-to-list 'bufs buf)
	(setq ido-ignore-item-temp-list bufs))
689 690 691 692 693
      (nreverse (mapcar #'get-buffer bufs)))
    (occur-read-primary-args)))
  (occur-1 regexp nlines bufs))

(defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines)
694
  "Show all lines matching REGEXP in buffers named by BUFREGEXP.
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
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))))))

720 721 722 723
(defun occur-1 (regexp nlines bufs &optional buf-name)
  (unless buf-name
    (setq buf-name "*Occur*"))
  (let ((occur-buf (get-buffer-create buf-name))
724 725 726 727 728 729 730 731 732 733
	(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))
734 735 736 737 738
    (with-current-buffer occur-buf
      (setq buffer-read-only nil)
      (occur-mode)
      (erase-buffer)
      (let ((count (occur-engine
739
		    regexp active-bufs occur-buf
740 741 742
		    (or nlines list-matching-lines-default-context-lines)
		    (and case-fold-search
			 (isearch-no-upper-case-p regexp t))
743 744
		    list-matching-lines-buffer-name-face
		    nil list-matching-lines-face nil)))
745 746 747 748 749 750 751 752
	(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))
753 754 755
	;; If we had to make a temporary buffer, make it the *Occur*
	;; buffer now.
	(when made-temp-buf
756 757 758
	  (with-current-buffer (get-buffer buf-name)
	    (kill-buffer (current-buffer)))
	  (rename-buffer buf-name))
759 760
	(setq occur-revert-arguments (list regexp nlines bufs)
	      buffer-read-only t)
761 762
	(if (> count 0)
	    (display-buffer occur-buf)
763 764
	  (kill-buffer occur-buf)))
      (run-hooks 'occur-hook))))
765

766 767 768
(defun occur-engine-add-prefix (lines)
  (mapcar
   #'(lambda (line)
769
       (concat "       :" line "\n"))
770 771 772 773 774 775
   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)
776 777
    (let ((globalcount 0)
	  (coding nil))
778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
      ;; 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)
793 794 795 796 797
	      (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))
798
	      (save-excursion
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
		(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
825
					      `(occur-match t)
826
					      (when match-face
827
						`(font-lock-face ,match-face)))
828 829 830 831 832
					     curstring)
			(setq start (match-end 0))))
		    ;; Generate the string to insert for this match
		    (let* ((out-line
			    (concat
833 834
			     ;; Using 7 digits aligns tabs properly.
			     (apply #'propertize (format "%7d:" lines)
835 836
				    (append
				     (when prefix-face
837
				       `(font-lock-face prefix-face))
838 839 840 841 842 843 844 845 846 847 848 849
				     '(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
850
				      (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ nlines)) keep-props))))
851
				      (list out-line)
852
				      (occur-engine-add-prefix (cdr (occur-accumulate-lines (1+ nlines) keep-props))))))))
853 854 855 856 857 858 859
		      ;; 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
860 861 862 863 864
			   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)))))
865
		    (goto-char endpt))
866 867 868 869 870 871
		  (if endpt
		      (progn
			(setq lines (1+ lines))
			;; On to the next match...
			(forward-line 1))
		    (goto-char (point-max))))))
872
	    (when (not (zerop matches)) ;; is the count zero?
873
	      (setq globalcount (+ globalcount matches))
874 875 876 877 878 879 880 881 882 883
	      (with-current-buffer out-buf
		(goto-char headerpt)
		(let ((beg (point))
		      end)
		  (insert (format "%d lines matching \"%s\" in buffer: %s\n"
				  matches regexp (buffer-name buf)))
		  (setq end (point))
		  (add-text-properties beg end
				       (append
					(when title-face
884 885
					  `(font-lock-face ,title-face))
					`(occur-title ,buf))))
886
		(goto-char (point-min)))))))
887 888 889 890 891
      (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))
892 893
      ;; Return the number of matches
      globalcount)))
894

Richard M. Stallman's avatar
Richard M. Stallman committed
895

896 897
;; 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
898 899
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
900
RET or `q' to exit, Period to replace one match and exit,
Richard M. Stallman's avatar
Richard M. Stallman committed
901 902 903 904 905
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,
906 907
^ to move point back to previous match,
E to edit the replacement string"
908
  "Help message while in `query-replace'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
909

910 911 912 913 914
(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',
915
`automatic', `backup', `exit-prefix', and `help'.")
916 917 918 919

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
920
(define-key query-replace-map [backspace] 'skip)
921 922
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
923 924
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
925
(define-key query-replace-map "e" 'edit-replacement)
926
(define-key query-replace-map "E" 'edit-replacement)
927 928
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "q" 'exit)
929
(define-key query-replace-map "\r" 'exit)
930
(define-key query-replace-map [return] 'exit)
931 932 933 934 935 936 937
(define-key query-replace-map "." 'act-and-exit)
(define-key query-replace-map "\C-r" 'edit)
(define-key query-replace-map "\C-w" 'delete-and-edit)
(define-key query-replace-map "\C-l" 'recenter)
(define-key query-replace-map "!" 'automatic)
(define-key query-replace-map "^" 'backup)
(define-key query-replace-map "\C-h" 'help)
938 939
(define-key query-replace-map [f1] 'help)
(define-key query-replace-map [help] 'help)
940
(define-key query-replace-map "?" 'help)
941 942
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
943 944
(define-key query-replace-map "\e" 'exit-prefix)
(define-key query-replace-map [escape] 'exit-prefix)
945

946
(defun replace-match-string-symbols (n)
Dave Love's avatar
Dave Love committed
947 948 949 950 951 952 953 954 955
  "Process a list (and any sub-lists), expanding certain symbols.
Symbol  Expands To
N     (match-string N)           (where N is a string of digits)
#N    (string-to-number (match-string N))
&     (match-string 0)
#&    (string-to-number (match-string 0))

Note that these symbols must be preceeded by a backslash in order to
type them."
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987