replace.el 44.4 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
Replacement transfers the case of the old text to the new text,
if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
108
are non-nil and FROM-STRING has no uppercase letters.
109 110 111
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

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

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

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

127 128 129
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.

130 131 132 133
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.

Richard M. Stallman's avatar
Richard M. Stallman committed
134
Preserves case in each replacement if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
135
are non-nil and REGEXP has no uppercase letters.
136

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

Richard M. Stallman's avatar
Richard M. Stallman committed
141 142 143
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."
144
  (interactive (query-replace-read-args "Query replace regexp" t))
145
  (perform-replace regexp to-string t t delimited nil nil start end))
146
(define-key esc-map [?\C-%] 'query-replace-regexp)
Roland McGrath's avatar
Roland McGrath committed
147

148
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
149 150 151 152 153 154 155 156 157 158
  "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
159 160
`\\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.
161 162 163 164 165 166 167 168 169 170 171
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.
172

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

197
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
198
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
199 200 201 202 203
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
204 205
wrapping around from the last such string to the first.

206 207 208
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
209 210
Non-interactively, TO-STRINGS may be a list of replacement strings.

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

248
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
249 250 251
  "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.
252 253 254
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

262 263 264 265
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
266 267
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
268 269
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
270 271 272
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.)"
273
  (interactive (query-replace-read-args "Replace string" nil))
274
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
275

276
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
277
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
278
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
279
are non-nil and REGEXP has no uppercase letters.
280 281 282 283

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

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

292 293 294
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
295 296 297
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
298
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
299
which will run faster and will not set the mark or print anything."
300
  (interactive (query-replace-read-args "Replace regexp" t))
301
  (perform-replace regexp to-string nil t delimited nil nil start end))
302

303 304 305

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
306

307

308
(defalias 'delete-non-matching-lines 'keep-lines)
309 310 311 312 313 314 315
(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.
316 317 318
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
			      'regexp-history nil t)))
319 320

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
326 327 328 329
the matching is case-sensitive.

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

330 331 332 333
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."

334 335 336
  (interactive
   (keep-lines-read-args "Keep lines (containing match for regexp): "))
  (if rstart
337 338 339
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
340 341 342 343 344 345
    (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
346 347
  (save-excursion
    (or (bolp) (forward-line 1))
348 349 350
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
351
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
352
	;; Start is first char not preserved by previous match.
353 354
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
355 356 357 358 359 360
	  (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))))
361 362
	
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
363
	;; If the match was empty, avoid matching again at same place.
364 365
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
366 367
	     (forward-char 1))))))

368 369

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

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

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

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

383 384 385
  (interactive
   (keep-lines-read-args "Flush lines (containing match for regexp): "))
  (if rstart
386 387 388
      (progn
	(goto-char (min rstart rend))
	(setq rend (copy-marker (max rstart rend))))
389 390 391 392 393 394
    (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))
395 396 397
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
398 399
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
400 401 402 403
	(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
404

405 406

(defun how-many (regexp &optional rstart rend)
407 408 409
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
410 411 412 413
the matching is case-sensitive.

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

414 415 416 417
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."

418 419
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
420 421 422
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
423 424 425 426 427 428
      (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))
429 430 431 432 433 434 435 436 437 438 439
    (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))))
440

441

442 443 444 445 446
(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)
447
    (define-key map "o" 'occur-mode-goto-occurrence-other-window)
448
    (define-key map "\C-o" 'occur-mode-display-occurrence)
449 450 451
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
    (define-key map "g" 'revert-buffer)
452
    (define-key map "q" 'delete-window)
453 454
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
455

456 457 458
(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
459

460 461 462 463 464
(defcustom occur-mode-hook '(turn-on-font-lock)
  "Hooks run when `occur' is called."
  :type 'hook
  :group 'matching)

465
(put 'occur-mode 'mode-class 'special)
466
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
467
  "Major mode for output from \\[occur].
468 469 470 471
\\<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
472
\\{occur-mode-map}"
473 474 475 476
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
477
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
478
  (make-local-variable 'occur-revert-arguments)
479
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
480

481
(defun occur-revert-function (ignore1 ignore2)
482
  "Handle `revert-buffer' for Occur mode buffers."
483
  (apply 'occur-1 (append occur-revert-arguments (list (buffer-name)))))
484

485 486 487
(defun occur-mode-mouse-goto (event)
  "In Occur mode, go to the occurrence whose line you click on."
  (interactive "e")
488
  (let (pos)
489 490 491 492
    (save-excursion
      (set-buffer (window-buffer (posn-window (event-end event))))
      (save-excursion
	(goto-char (posn-point (event-end event)))
493 494 495
	(setq pos (occur-mode-find-occurrence))))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
496 497

(defun occur-mode-find-occurrence ()
498 499
  (let ((pos (get-text-property (point) 'occur-target)))
    (unless pos
500
      (error "No occurrence on this line"))
501 502 503
    (unless (buffer-live-p (marker-buffer pos))
      (error "Buffer for this occurrence was killed"))
    pos))
504 505 506 507

(defun occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
508 509 510
  (let ((pos (occur-mode-find-occurrence)))
    (pop-to-buffer (marker-buffer pos))
    (goto-char pos)))
511

512 513 514
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
515 516 517
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window (marker-buffer pos))
    (goto-char pos)))
518

519 520 521
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
522 523 524
  (let ((pos (occur-mode-find-occurrence))
	window
	;; Bind these to ensure `display-buffer' puts it in another window.
525
	same-window-buffer-names
526 527
	same-window-regexps)
    (setq window (display-buffer (marker-buffer pos)))
528 529 530
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
531
      (goto-char pos))))
532

533
(defun occur-next (&optional n)
534
  "Move to the Nth (default 1) next match in an Occur mode buffer."
535 536 537 538 539 540 541 542 543
  (interactive "p")
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
      (if (get-text-property (point) 'occur-point)
	  (forward-char 1))
      (setq r (next-single-property-change (point) 'occur-point))
      (if r
	  (goto-char r)
Dave Love's avatar
Dave Love committed
544
	(error "No more matches"))
545 546 547
      (setq n (1- n)))))

(defun occur-prev (&optional n)
548
  "Move to the Nth (default 1) previous match in an Occur mode buffer."
549 550 551 552 553 554 555 556 557 558 559
  (interactive "p")
  (if (not n) (setq n 1))
  (let ((r))
    (while (> n 0)
    
      (setq r (get-text-property (point) 'occur-point))
      (if r (forward-char -1))
      
      (setq r (previous-single-property-change (point) 'occur-point))
      (if r
	  (goto-char (- r 1))
Dave Love's avatar
Dave Love committed
560
	(error "No earlier matches"))
561 562
      
      (setq n (1- n)))))
563

564
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
565 566
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
567 568 569
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
570

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

573
(defcustom list-matching-lines-face 'bold
Dave Love's avatar
Dave Love committed
574
  "*Face used by \\[list-matching-lines] to show the text that matches.
575 576 577 578 579 580 581 582 583 584
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)

585
(defun occur-accumulate-lines (count &optional no-props)
586 587 588 589 590 591 592
  (save-excursion
    (let ((forwardp (> count 0))
	  (result nil))
      (while (not (or (zerop count)
		      (if forwardp
			  (eobp)
			(bobp))))
593
	(setq count (+ count (if forwardp -1 1)))
594
	(push
595 596 597
	 (funcall (if no-props
		      #'buffer-substring-no-properties
		    #'buffer-substring)
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
	  (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))
619 620
	(when current-prefix-arg
	  (prefix-numeric-value current-prefix-arg))))
621

Richard M. Stallman's avatar
Richard M. Stallman committed
622
(defun occur (regexp &optional nlines)
623
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
624 625

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

Roland McGrath's avatar
Roland McGrath committed
627 628 629
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
630 631
Interactively it is the prefix arg.

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

636 637
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
638 639 640 641 642 643 644
  (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'."
645
  (interactive
646 647 648 649 650 651 652 653 654 655 656 657 658 659
   (cons
    (let ((bufs (list (read-buffer "First buffer to search: "
				   (current-buffer) t)))
	  (buf nil))
      (while (not (string-equal
		   (setq buf (read-buffer "Next buffer to search (RET to end): "
					  nil t))
		   ""))
	(push buf bufs))
      (nreverse (mapcar #'get-buffer bufs)))
    (occur-read-primary-args)))
  (occur-1 regexp nlines bufs))

(defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines)
660
  "Show all lines matching REGEXP in buffers named by BUFREGEXP.
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
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))))))

686 687 688 689
(defun occur-1 (regexp nlines bufs &optional buf-name)
  (unless buf-name
    (setq buf-name "*Occur*"))
  (let ((occur-buf (get-buffer-create buf-name))
690 691 692 693 694 695 696 697 698 699
	(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))
700 701 702 703 704
    (with-current-buffer occur-buf
      (setq buffer-read-only nil)
      (occur-mode)
      (erase-buffer)
      (let ((count (occur-engine
705
		    regexp active-bufs occur-buf
706 707 708
		    (or nlines list-matching-lines-default-context-lines)
		    (and case-fold-search
			 (isearch-no-upper-case-p regexp t))
709 710
		    list-matching-lines-buffer-name-face
		    nil list-matching-lines-face nil)))
711 712 713 714 715 716 717 718
	(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))
719 720 721
	;; If we had to make a temporary buffer, make it the *Occur*
	;; buffer now.
	(when made-temp-buf
722 723 724
	  (with-current-buffer (get-buffer buf-name)
	    (kill-buffer (current-buffer)))
	  (rename-buffer buf-name))
725 726
	(setq occur-revert-arguments (list regexp nlines bufs)
	      buffer-read-only t)
727 728
	(if (> count 0)
	    (display-buffer occur-buf)
729
	  (kill-buffer occur-buf))))))
730

731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
(defun occur-engine-add-prefix (lines)
  (mapcar
   #'(lambda (line)
       (concat "      :" line "\n"))
   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)
    (let ((globalcount 0))
      ;; 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)
757
	      (save-excursion
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
		(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
784
					      `(occur-match t)
785
					      (when match-face
786
						`(font-lock-face ,match-face)))
787 788 789 790 791 792 793 794
					     curstring)
			(setq start (match-end 0))))
		    ;; Generate the string to insert for this match
		    (let* ((out-line
			    (concat
			     (apply #'propertize (format "%6d:" lines)
				    (append
				     (when prefix-face
795
				       `(font-lock-face prefix-face))
796 797 798 799 800 801 802 803 804 805 806 807
				     '(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
808
				      (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ nlines)) keep-props))))
809
				      (list out-line)
810
				      (occur-engine-add-prefix (cdr (occur-accumulate-lines (1+ nlines) keep-props))))))))
811 812 813 814 815 816 817
		      ;; 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
818 819 820 821 822
			   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)))))
823
		    (goto-char endpt))
824 825 826 827 828 829
		  (if endpt
		      (progn
			(setq lines (1+ lines))
			;; On to the next match...
			(forward-line 1))
		    (goto-char (point-max))))))
830
	    (when (not (zerop matches)) ;; is the count zero?
831
	      (setq globalcount (+ globalcount matches))
832 833 834 835 836 837 838 839 840 841
	      (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
842 843
					  `(font-lock-face ,title-face))
					`(occur-title ,buf))))
844 845 846
		(goto-char (point-min)))))))
      ;; Return the number of matches
      globalcount)))
847

Richard M. Stallman's avatar
Richard M. Stallman committed
848

849 850
;; 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
851 852
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
853
RET or `q' to exit, Period to replace one match and exit,
Richard M. Stallman's avatar
Richard M. Stallman committed
854 855 856 857 858
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,
859 860
^ to move point back to previous match,
E to edit the replacement string"
861
  "Help message while in `query-replace'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
862

863 864 865 866 867
(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',
868
`automatic', `backup', `exit-prefix', and `help'.")
869 870 871 872

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
873
(define-key query-replace-map [backspace] 'skip)
874 875
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
876 877
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
878
(define-key query-replace-map "e" 'edit-replacement)
879
(define-key query-replace-map "E" 'edit-replacement)
880 881
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "q" 'exit)
882
(define-key query-replace-map "\r" 'exit)
883
(define-key query-replace-map [return] 'exit)
884 885 886 887 888 889 890
(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)
891 892
(define-key query-replace-map [f1] 'help)
(define-key query-replace-map [help] 'help)
893
(define-key query-replace-map "?" 'help)
894 895
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
896 897
(define-key query-replace-map "\e" 'exit-prefix)
(define-key query-replace-map [escape] 'exit-prefix)
898

899
(defun replace-match-string-symbols (n)
Dave Love's avatar
Dave Love committed
900 901 902 903 904 905 906 907 908
  "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."
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
  (while n
    (cond
     ((consp (car n))
      (replace-match-string-symbols (car n))) ;Process sub-list
     ((symbolp (car n))
      (let ((name (symbol-name (car n))))
        (cond
         ((string-match "^[0-9]+$" name)
          (setcar n (list 'match-string (string-to-number name))))
         ((string-match "^#[0-9]+$" name)
          (setcar n (list 'string-to-number
                          (list 'match-string
                                (string-to-number (substring name 1))))))
         ((string= "&" name)
          (setcar n '(match-string 0)))
         ((string= "#&" name)
          (setcar n '(string-to-number (match-string 0))))))))
    (setq n (cdr n))))

(defun replace-eval-replacement (expression replace-count)
  (let ((replacement (eval expression)))
    (if (stringp replacement)
        replacement
      (prin1-to-string replacement t))))

(defun replace-loop-through-replacements (data replace-count)
  ;; DATA is a vector contaning the following values:
  ;;   0 next-rotate-count
  ;;   1 repeat-count
  ;;   2 next-replacement
  ;;   3 replacements
  (if (= (aref data 0) replace-count)
      (progn
        (aset data 0 (+ replace-count (aref data 1)))
        (let ((next (cdr (aref data 2))))
          (aset data 2 (if (consp next) next (aref data 3))))))
  (car (aref data 2)))

947
(defun perform-replace (from-string replacements 
Richard M. Stallman's avatar
Richard M. Stallman committed
948
		        query-flag regexp-flag delimited-flag
949
			&optional repeat-count map start end)
Richard M. Stallman's avatar
Richard M. Stallman committed
950 951 952
  "Subroutine of `query-replace'.  Its complexity handles interactive queries.
Don't use this in your own program unless you want to query and set the mark
just as `query-replace' does.  Instead, write a simple loop like this:
Gerd Moellmann's avatar
Gerd Moellmann committed
953 954

  (while (re-search-forward \"foo[ \\t]+bar\" nil t)
Richard M. Stallman's avatar
Richard M. Stallman committed
955
    (replace-match \"foobar\" nil nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
956 957 958

which will run faster and probably do exactly what you want.  Please
see the documentation of `replace-match' to find out how to simulate
959 960 961 962
`case-replace'.

This function returns nil if and only if there were no matches to
make, or the user didn't cancel the call."
963
  (or map (setq map query-replace-map))
964 965
  (and query-flag minibuffer-auto-raise
       (raise-frame (window-frame (minibuffer-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
966 967 968
  (let ((nocasify (not (and case-fold-search case-replace
			    (string-equal from-string
					  (downcase from-string)))))
969 970 971
	(case-fold-search (and case-fold-search
			       (string-equal from-string
					     (downcase from-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
972 973 974
	(literal (not regexp-flag))
	(search-function (if regexp-flag 're-search-forward 'search-forward))
	(search-string from-string)
Jim Blandy's avatar
Jim Blandy committed
975
	(real-match-data nil)		; the match data for the current match
Richard M. Stallman's avatar
Richard M. Stallman committed
976 977 978 979
	(next-replacement nil)
	(keep-going t)
	(stack nil)
	(replace-count 0)
980 981
	(nonempty-match nil)

982 983 984
	;; If non-nil, it is marker saying where in the buffer to stop.
	(limit nil)

985 986
	;; Data for the next match.  If a cons, it has the same format as
	;; (match-data); otherwise it is t if a match is possible at point.
987
	(match-again t)
988

989 990 991 992
	(message
	 (if query-flag
	     (substitute-command-keys
	      "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) "))))
993 994

    ;; If region is active, in Transient Mark mode, operate on region.
Gerd Moellmann's avatar