replace.el 44 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

Richard M. Stallman's avatar
Richard M. Stallman committed
6 7 8 9
;; 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
10
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
11 12 13 14 15 16 17 18
;; 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
19 20 21
;; 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
22

23 24 25 26 27
;;; 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
28
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
29

30
(defcustom case-replace t
31
  "*Non-nil means `query-replace' should preserve case in replacements."
32 33
  :type 'boolean
  :group 'matching)
Roland McGrath's avatar
Roland McGrath committed
34

35 36
(defvar query-replace-history nil)

37 38 39 40
(defvar query-replace-interactive nil
  "Non-nil means `query-replace' uses the last search string.
That becomes the \"string to replace\".")

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

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

59 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
  :version "21.3")

65 66 67
(defun query-replace-read-args (string regexp-flag &optional noerror)
  (unless noerror
    (barf-if-buffer-read-only))
68
  (let (from to)
69 70 71 72
    (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
73
				       query-replace-from-history-variable
74 75 76 77 78 79 80 81 82 83 84
				       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))))

85 86
    (setq to (read-from-minibuffer (format "%s %s with: " string from)
				   nil nil nil
87
				   query-replace-to-history-variable from t))
88 89 90
    (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))))
91

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

97 98 99
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.

100 101 102 103
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.

104 105
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
106
are non-nil and FROM-STRING has no uppercase letters.
107 108 109
\(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
110
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
111
only matches surrounded by word boundaries.
112
Fourth and fifth arg START and END specify the region to operate on.
113 114

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

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

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

125 126 127
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.

128 129 130 131
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
132
Preserves case in each replacement if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
133
are non-nil and REGEXP has no uppercase letters.
134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

305

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

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

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

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

328 329 330 331
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."

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

364 365

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
371 372 373 374
the matching is case-sensitive.

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

375 376 377 378
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."

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

399 400

(defun how-many (regexp &optional rstart rend)
401 402 403
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
404 405 406 407
the matching is case-sensitive.

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

408 409 410 411
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."

412 413
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
414 415 416
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
417 418 419 420 421 422
      (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))
423 424 425 426 427 428 429 430 431 432 433
    (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))))
434

435

436 437 438 439 440
(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)
441
    (define-key map "\o" 'occur-mode-goto-occurrence-other-window)
442
    (define-key map "\C-o" 'occur-mode-display-occurrence)
443 444 445 446 447
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
    (define-key map "g" 'revert-buffer)
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
448

449 450 451 452 453 454 455 456

(defvar occur-buffer nil
  "Name of buffer for last occur.")


(defvar occur-nlines nil
  "Number of lines of context to show around matching line.")

457 458
(defvar occur-command-arguments nil
  "Arguments that were given to `occur' when it made this buffer.")
Richard M. Stallman's avatar
Richard M. Stallman committed
459

460 461
(put 'occur-mode 'mode-class 'special)

462
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
463
  "Major mode for output from \\[occur].
464 465 466 467
\\<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
468
\\{occur-mode-map}"
469 470 471 472 473 474
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'occur-revert-function)
475
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
476 477
  (make-local-variable 'occur-buffer)
  (make-local-variable 'occur-nlines)
478 479
  (make-local-variable 'occur-command-arguments)
  (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* buffers."
483 484 485 486 487
  (let ((args occur-command-arguments ))
    (save-excursion
      (set-buffer occur-buffer)
      (apply 'occur args))))

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

(defun occur-mode-find-occurrence ()
Richard M. Stallman's avatar
Richard M. Stallman committed
502 503 504
  (if (or (null occur-buffer)
	  (null (buffer-name occur-buffer)))
      (progn
505
	(setq occur-buffer nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
506
	(error "Buffer in which occurrences were found is deleted")))
507 508 509 510
  (let ((pos (get-text-property (point) 'occur)))
    (if (null pos)
	(error "No occurrence on this line")
      pos)))
511 512 513 514 515

(defun occur-mode-goto-occurrence ()
  "Go to the occurrence the current line describes."
  (interactive)
  (let ((pos (occur-mode-find-occurrence)))
Richard M. Stallman's avatar
Richard M. Stallman committed
516
    (pop-to-buffer occur-buffer)
517
    (goto-char (marker-position pos))))
518

519 520 521 522 523 524 525
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window occur-buffer)
    (goto-char (marker-position pos))))

526 527 528 529 530 531 532 533 534 535 536 537 538
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
  (let ((pos (occur-mode-find-occurrence))
	same-window-buffer-names
	same-window-regexps
	window)
    (setq window (display-buffer occur-buffer))
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
      (goto-char (marker-position pos)))))

539 540 541 542 543 544 545 546 547 548 549
(defun occur-next (&optional n)
  "Move to the Nth (default 1) next match in the *Occur* buffer."
  (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
550
	(error "No more matches"))
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
      (setq n (1- n)))))



(defun occur-prev (&optional n)
  "Move to the Nth (default 1) previous match in the *Occur* buffer."
  (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
568
	(error "No earlier matches"))
569 570
      
      (setq n (1- n)))))
571

572
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
573 574
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
575 576 577
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
578

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

581
(defvar list-matching-lines-face 'bold
Dave Love's avatar
Dave Love committed
582
  "*Face used by \\[list-matching-lines] to show the text that matches.
583 584
If the value is nil, don't highlight the matching portions specially.")

Richard M. Stallman's avatar
Richard M. Stallman committed
585
(defun occur (regexp &optional nlines)
586
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
587 588

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

Roland McGrath's avatar
Roland McGrath committed
590 591 592
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
593 594
Interactively it is the prefix arg.

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

599 600
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
601 602 603 604 605 606 607 608
  (interactive
   (list (let* ((default (car regexp-history))
		(input
		 (read-from-minibuffer
		  (if default
		      (format "List lines matching regexp (default `%s'): "
			      default)
		    "List lines matching regexp: ")
609
		  nil nil nil 'regexp-history default t)))
610 611
	   (and (equal input "") default
		(setq input default))
612
	   input)
613
	 current-prefix-arg))
614 615 616 617
  (let* ((nlines (if nlines
		     (prefix-numeric-value nlines)
		   list-matching-lines-default-context-lines))
	 (current-tab-width tab-width)
618
	 (inhibit-read-only t)
619 620
	 ;; Minimum width of line number plus trailing colon.
	 (min-line-number-width 6)
621 622 623 624 625 626 627 628
	 ;; Width of line number prefix without the colon.  Choose a
	 ;; width that's a multiple of `tab-width' in the original
	 ;; buffer so that lines in *Occur* appear right.
	 (line-number-width (1- (* (/ (- (+ min-line-number-width
					    tab-width)
					 1)
				      tab-width)
				   tab-width)))
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
	 ;; Format string for line numbers.
	 (line-number-format (format "%%%dd" line-number-width))
	 (empty (make-string line-number-width ?\ ))
	 (first t)
	 ;;flag to prevent printing separator for first match
	 (occur-num-matches 0)
	 (buffer (current-buffer))
	 (dir default-directory)
	 (linenum 1)
	 (prevpos
	  ;;position of most recent match
	  (point-min))
	 (case-fold-search  (and case-fold-search
				 (isearch-no-upper-case-p regexp t)))
	 (final-context-start
	  ;; Marker to the start of context immediately following
	  ;; the matched text in *Occur*.
	  (make-marker)))
647 648 649 650
;;;	(save-excursion
;;;	  (beginning-of-line)
;;;	  (setq linenum (1+ (count-lines (point-min) (point))))
;;;	  (setq prevpos (point)))
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
    (save-excursion
      (goto-char (point-min))
      ;; Check first whether there are any matches at all.
      (if (not (re-search-forward regexp nil t))
	  (message "No matches for `%s'" regexp)
	;; Back up, so the search loop below will find the first match.
	(goto-char (match-beginning 0))
	(with-output-to-temp-buffer "*Occur*"
	  (save-excursion
	    (set-buffer standard-output)
	    (setq default-directory dir)
	    ;; We will insert the number of lines, and "lines", later.
	    (insert " matching ")
	    (let ((print-escape-newlines t))
	      (prin1 regexp))
	    (insert " in buffer " (buffer-name buffer) ?. ?\n)
	    (occur-mode)
	    (setq occur-buffer buffer)
	    (setq occur-nlines nlines)
670 671
	    (setq occur-command-arguments
		  (list regexp nlines)))
672
	  (if (eq buffer standard-output)
673
	      (goto-char (point-max)))
674 675
	  (save-excursion
	    ;; Find next match, but give up if prev match was at end of buffer.
676
	    (while (and (not (eobp))
677 678 679 680 681 682 683
			(re-search-forward regexp nil t))
	      (goto-char (match-beginning 0))
	      (beginning-of-line)
	      (save-match-data
		(setq linenum (+ linenum (count-lines prevpos (point)))))
	      (setq prevpos (point))
	      (goto-char (match-end 0))
684 685 686
	      (let* (;;start point of text in source buffer to be put
		     ;;into *Occur*
		     (start (save-excursion
687
			      (goto-char (match-beginning 0))
688 689 690
			      (forward-line (if (< nlines 0)
						nlines
					      (- nlines)))
691
			      (point)))
692 693
		      ;; end point of text in source buffer to be put
		      ;; into *Occur*
694 695 696 697 698 699
		     (end (save-excursion
			    (goto-char (match-end 0))
			    (if (> nlines 0)
				(forward-line (1+ nlines))
			      (forward-line 1))
			    (point)))
700
		      ;; Amount of context before matching text
701
		     (match-beg (- (match-beginning 0) start))
702
		      ;; Length of matching text
703 704
		     (match-len (- (match-end 0) (match-beginning 0)))
		     (tag (format line-number-format linenum))
Dave Love's avatar
Dave Love committed
705
		     tem
706
		     insertion-start
707
		     ;; Number of lines of context to show for current match.
Dave Love's avatar
Dave Love committed
708
		     occur-marker
709 710 711 712 713
		     ;; Marker pointing to end of match in source buffer.
		     (text-beg
		      ;; Marker pointing to start of text for one
		      ;; match in *Occur*.
		      (make-marker))
Dave Love's avatar
Dave Love committed
714
		     (text-end
715 716
		      ;; Marker pointing to end of text for one match
		      ;; in *Occur*.
717
		      (make-marker)))
718
		(save-excursion
719 720
		  (setq occur-marker (make-marker))
		  (set-marker occur-marker (point))
721
		  (set-buffer standard-output)
722
		  (setq occur-num-matches (1+ occur-num-matches))
723 724 725
		  (or first (zerop nlines)
		      (insert "--------\n"))
		  (setq first nil)
726 727 728
		  (save-excursion
		    (set-buffer "*Occur*")
		    (setq tab-width current-tab-width))
729 730 731

		  ;; Insert matching text including context lines from
		  ;; source buffer into *Occur*
732
		  (set-marker text-beg (point))
733
		  (setq insertion-start (point))
734
		  (insert-buffer-substring buffer start end)
735 736 737 738
		  (or (and (/= (+ start match-beg) end)
			   (with-current-buffer buffer
			     (eq (char-before end) ?\n)))
		      (insert "\n"))
Dave Love's avatar
Dave Love committed
739
		  (set-marker final-context-start
740 741 742 743 744 745 746 747
			      (+ (- (point) (- end (match-end 0)))
				 (if (save-excursion
				       (set-buffer buffer)
				       (save-excursion
					 (goto-char (match-end 0))
					 (end-of-line)
					 (bolp)))
				     1 0)))
748
		  (set-marker text-end (point))
749 750
		  
		  ;; Highlight text that was matched.
751 752 753 754 755 756
		  (if list-matching-lines-face
		      (put-text-property
		       (+ (marker-position text-beg) match-beg)
		       (+ (marker-position text-beg) match-beg match-len)
		       'face list-matching-lines-face))

757 758
		  ;; `occur-point' property is used by occur-next and
		  ;; occur-prev to move between matching lines.
759 760 761 762
		  (put-text-property
		   (+ (marker-position text-beg) match-beg match-len)
		   (+ (marker-position text-beg) match-beg match-len 1)
		   'occur-point t)
763 764 765
		  
		  ;; Now go back to the start of the matching text
		  ;; adding the space and colon to the start of each line.
766
		  (goto-char insertion-start)
767
		  ;; Insert space and colon for lines of context before match.
768 769 770
		  (setq tem (if (< linenum nlines)
				(- nlines linenum)
			      nlines))
771 772 773 774
		  (while (> tem 0)
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1- tem)))
775 776 777 778

		  ;; Insert line number and colon for the lines of
		  ;; matching text.
		  (let ((this-linenum linenum))
779 780
		    (while (< (point) final-context-start)
		      (if (null tag)
781
			  (setq tag (format line-number-format this-linenum)))
782 783 784 785
		      (insert tag ?:)
		      (forward-line 1)
		      (setq tag nil)
		      (setq this-linenum (1+ this-linenum)))
786
		    (while (and (not (eobp)) (<= (point) final-context-start))
787 788 789
		      (insert empty ?:)
		      (forward-line 1)
		      (setq this-linenum (1+ this-linenum))))
790 791

		  ;; Insert space and colon for lines of context after match.
792
		  (while (and (< (point) (point-max)) (< tem nlines))
793 794 795
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1+ tem)))
796 797 798 799
		  
		  ;; Add text properties.  The `occur' prop is used to
		  ;; store the marker of the matching text in the
		  ;; source buffer.
800 801 802
		  (add-text-properties
		   (marker-position text-beg) (- (marker-position text-end) 1)
		   '(mouse-face highlight
803
		     help-echo "mouse-2: go to this occurrence"))
804
		  (put-text-property (marker-position text-beg)
805
				     (marker-position text-end)
806
				     'occur occur-marker)
807 808 809
		  (goto-char (point-max)))
		(forward-line 1)))
	    (set-buffer standard-output)
810 811
	    ;; Go back to top of *Occur* and finish off by printing the
	    ;; number of matching lines.
812
	    (goto-char (point-min))
813
	    (let ((message-string
814
		   (if (= occur-num-matches 1)
815
		       "1 line"
816
		     (format "%d lines" occur-num-matches))))
817 818
	      (insert message-string)
	      (if (interactive-p)
Karl Heuer's avatar
Karl Heuer committed
819 820
		  (message "%s matched" message-string)))
	    (setq buffer-read-only t)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
821

822 823
;; 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
824 825
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
826
RET or `q' to exit, Period to replace one match and exit,
Richard M. Stallman's avatar
Richard M. Stallman committed
827 828 829 830 831
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,
832 833
^ to move point back to previous match,
E to edit the replacement string"
834
  "Help message while in `query-replace'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
835

836 837 838 839 840
(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',
841
`automatic', `backup', `exit-prefix', and `help'.")
842 843 844 845

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
846
(define-key query-replace-map [backspace] 'skip)
847 848
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
849 850
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
851
(define-key query-replace-map "e" 'edit-replacement)
852
(define-key query-replace-map "E" 'edit-replacement)
853 854
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "q" 'exit)
855
(define-key query-replace-map "\r" 'exit)
856
(define-key query-replace-map [return] 'exit)
857 858 859 860 861 862 863
(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)
864 865
(define-key query-replace-map [f1] 'help)
(define-key query-replace-map [help] 'help)
866
(define-key query-replace-map "?" 'help)
867 868
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
869 870
(define-key query-replace-map "\e" 'exit-prefix)
(define-key query-replace-map [escape] 'exit-prefix)
871

872
(defun replace-match-string-symbols (n)
Dave Love's avatar
Dave Love committed
873 874 875 876 877 878 879 880 881
  "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."
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
  (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)))

920
(defun perform-replace (from-string replacements 
Richard M. Stallman's avatar
Richard M. Stallman committed
921
		        query-flag regexp-flag delimited-flag
922
			&optional repeat-count map start end)
Richard M. Stallman's avatar
Richard M. Stallman committed
923 924 925
  "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
926 927

  (while (re-search-forward \"foo[ \\t]+bar\" nil t)
Richard M. Stallman's avatar
Richard M. Stallman committed
928
    (replace-match \"foobar\" nil nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
929 930 931 932

which will run faster and probably do exactly what you want.  Please
see the documentation of `replace-match' to find out how to simulate
`case-replace'."
933
  (or map (setq map query-replace-map))
934 935
  (and query-flag minibuffer-auto-raise
       (raise-frame (window-frame (minibuffer-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
936 937 938
  (let ((nocasify (not (and case-fold-search case-replace
			    (string-equal from-string
					  (downcase from-string)))))
939 940 941
	(case-fold-search (and case-fold-search
			       (string-equal from-string
					     (downcase from-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
942 943 944
	(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
945
	(real-match-data nil)		; the match data for the current match
Richard M. Stallman's avatar
Richard M. Stallman committed
946 947 948 949
	(next-replacement nil)
	(keep-going t)
	(stack nil)
	(replace-count 0)
950 951
	(nonempty-match nil)

952 953 954
	;; If non-nil, it is marker saying where in the buffer to stop.
	(limit nil)

955 956
	;; 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.
957
	(match-again t)
958

959 960 961 962
	(message
	 (if query-flag
	     (substitute-command-keys
	      "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) "))))