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

3
;; Copyright (C) 1985, 86, 87, 92, 94, 96, 1997 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

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

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

34 35
(defvar query-replace-history nil)

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

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

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

58
(defun query-replace-read-args (string regexp-flag)
59
  (let (from to)
60 61 62 63
    (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
64 65
				       query-replace-from-history-variable
				       nil t)))
66 67
    (setq to (read-from-minibuffer (format "%s %s with: " string from)
				   nil nil nil
68
				   query-replace-to-history-variable from t))
69 70
    (list from to current-prefix-arg)))

Roland McGrath's avatar
Roland McGrath committed
71 72 73 74 75
(defun query-replace (from-string to-string &optional arg)
  "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.

76 77 78
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.

79 80 81 82
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.

83 84
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
85
are non-nil and FROM-STRING has no uppercase letters.
86 87 88
\(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
89
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
90 91 92
only matches surrounded by word boundaries.

To customize possible responses, change the \"bindings\" in `query-replace-map'."
93
  (interactive (query-replace-read-args "Query replace" nil))
94
  (perform-replace from-string to-string t nil arg))
95

Brian Preble's avatar
Brian Preble committed
96
(define-key esc-map "%" 'query-replace)
Roland McGrath's avatar
Roland McGrath committed
97 98 99 100 101 102

(defun query-replace-regexp (regexp to-string &optional arg)
  "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.

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

106 107 108 109
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
110
Preserves case in each replacement if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
111
are non-nil and REGEXP has no uppercase letters.
Richard M. Stallman's avatar
Richard M. Stallman committed
112
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
113
only matches surrounded by word boundaries.
Richard M. Stallman's avatar
Richard M. Stallman committed
114 115 116
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."
117
  (interactive (query-replace-read-args "Query replace regexp" t))
118
  (perform-replace regexp to-string t t arg))
119
(define-key esc-map [?\C-%] 'query-replace-regexp)
Roland McGrath's avatar
Roland McGrath committed
120

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
(defun query-replace-regexp-eval (regexp to-expr &optional arg)
  "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
`\\0'to stand for whatever matched the whole of REGEXP, and `\\=\\N' (where
N is a digit) stands for whatever what matched the Nth `\\(...\\)' in REGEXP.
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.
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
only matches surrounded by word boundaries."
  (interactive
   (let (from to)
     (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)
     (list from (car to) current-prefix-arg)))
  (perform-replace regexp (cons 'replace-eval-replacement to-expr) t t arg))

Roland McGrath's avatar
Roland McGrath committed
164 165 166 167 168 169 170
(defun map-query-replace-regexp (regexp to-strings &optional arg)
  "Replace some matches for REGEXP with various strings, in rotation.
The second argument TO-STRINGS contains the replacement strings, separated
by spaces.  This command works like `query-replace-regexp' except
that each successive replacement uses the next successive replacement string,
wrapping around from the last such string to the first.

171 172 173
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
174 175
Non-interactively, TO-STRINGS may be a list of replacement strings.

176 177 178
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
179 180
A prefix argument N says to use each replacement string N times
before rotating to the next."
181 182
  (interactive
   (let (from to)
183 184 185 186
     (setq from (if query-replace-interactive
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
187
					'query-replace-history nil t)))
188 189 190 191
     (setq to (read-from-minibuffer
	       (format "Query replace %s with (space-separated strings): "
		       from)
	       nil nil nil
192
	       'query-replace-history from t))
193
     (list from to current-prefix-arg)))
Roland McGrath's avatar
Roland McGrath committed
194 195 196 197 198 199 200 201 202 203 204 205 206
  (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 ""))))
207
    (perform-replace regexp replacements t t nil arg)))
Roland McGrath's avatar
Roland McGrath committed
208 209 210 211 212

(defun replace-string (from-string to-string &optional delimited)
  "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.
213 214 215
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

216 217 218
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
219
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
220 221
only matches surrounded by word boundaries.

222 223 224 225
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
226 227
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
228 229
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
230 231 232
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.)"
233
  (interactive (query-replace-read-args "Replace string" nil))
234
  (perform-replace from-string to-string nil nil delimited))
Roland McGrath's avatar
Roland McGrath committed
235 236 237

(defun replace-regexp (regexp to-string &optional delimited)
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
238
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
239
are non-nil and REGEXP has no uppercase letters.
Richard M. Stallman's avatar
Richard M. Stallman committed
240
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
241
only matches surrounded by word boundaries.
Richard M. Stallman's avatar
Richard M. Stallman committed
242 243
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
244
 whatever what matched the Nth `\\(...\\)' in REGEXP.
Roland McGrath's avatar
Roland McGrath committed
245

246 247 248
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.

249 250 251
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
252 253 254
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
255
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
256
which will run faster and will not set the mark or print anything."
257
  (interactive (query-replace-read-args "Replace regexp" t))
258
  (perform-replace regexp to-string nil t delimited))
259 260 261

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
262

263
(defalias 'delete-non-matching-lines 'keep-lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
264 265 266
(defun keep-lines (regexp)
  "Delete all lines except those containing matches for REGEXP.
A match split across lines preserves all the lines it lies in.
267 268 269 270
Applies to all lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
271
  (interactive (list (read-from-minibuffer
272
		      "Keep lines (containing match for regexp): "
273
		      nil nil nil 'regexp-history nil t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
274 275
  (save-excursion
    (or (bolp) (forward-line 1))
276 277 278
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
      (while (not (eobp))
	;; Start is first char not preserved by previous match.
	(if (not (re-search-forward regexp nil 'move))
	    (delete-region start (point-max))
	  (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))))
	(setq start (save-excursion (forward-line 1)
				    (point)))
	;; If the match was empty, avoid matching again at same place.
	(and (not (eobp)) (= (match-beginning 0) (match-end 0))
	     (forward-char 1))))))

295
(defalias 'delete-matching-lines 'flush-lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
296 297 298
(defun flush-lines (regexp)
  "Delete lines containing matches for REGEXP.
If a match is split across lines, all the lines it lies in are deleted.
299 300 301 302
Applies to lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
303
  (interactive (list (read-from-minibuffer
304
		      "Flush lines (containing match for regexp): "
305
		      nil nil nil 'regexp-history nil t)))
306 307 308 309 310 311 312 313 314
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
      (while (and (not (eobp))
		  (re-search-forward regexp nil t))
	(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
315

316
(defalias 'count-matches 'how-many)
Richard M. Stallman's avatar
Richard M. Stallman committed
317
(defun how-many (regexp)
318 319 320 321
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
Richard M. Stallman's avatar
Richard M. Stallman committed
322 323 324
  (interactive (list (read-from-minibuffer
		      "How many matches for (regexp): "
		      nil nil nil 'regexp-history nil t)))
325 326 327
  (let ((count 0) opoint
	(case-fold-search  (and case-fold-search
				(isearch-no-upper-case-p regexp t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
328 329 330 331 332 333 334 335
    (save-excursion
     (while (and (not (eobp))
		 (progn (setq opoint (point))
			(re-search-forward regexp nil t)))
       (if (= opoint (point))
	   (forward-char 1)
	 (setq count (1+ count))))
     (message "%d occurrences" count))))
336

Richard M. Stallman's avatar
Richard M. Stallman committed
337 338 339 340
(defvar occur-mode-map ())
(if occur-mode-map
    ()
  (setq occur-mode-map (make-sparse-keymap))
341
  (define-key occur-mode-map [mouse-2] 'occur-mode-mouse-goto)
342
  (define-key occur-mode-map "\C-c\C-c" 'occur-mode-goto-occurrence)
343
  (define-key occur-mode-map "\C-m" 'occur-mode-goto-occurrence)
344 345
  (define-key occur-mode-map "\M-n" 'occur-next)
  (define-key occur-mode-map "\M-p" 'occur-prev)
346
  (define-key occur-mode-map "g" 'revert-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
347

348 349 350 351 352 353 354 355

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


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

356 357
(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
358

359 360
(put 'occur-mode 'mode-class 'special)

Richard M. Stallman's avatar
Richard M. Stallman committed
361 362
(defun occur-mode ()
  "Major mode for output from \\[occur].
363 364 365 366
\\<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
367 368 369 370 371
\\{occur-mode-map}"
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
372 373
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'occur-revert-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
374 375
  (make-local-variable 'occur-buffer)
  (make-local-variable 'occur-nlines)
376
  (make-local-variable 'occur-command-arguments)
377
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
378

379 380 381 382 383 384 385
;; Handle revert-buffer for *Occur* buffers.
(defun occur-revert-function (ignore1 ignore2)
  (let ((args occur-command-arguments ))
    (save-excursion
      (set-buffer occur-buffer)
      (apply 'occur args))))

386 387 388 389 390 391 392 393 394 395 396 397 398 399
(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
400 401 402
  (if (or (null occur-buffer)
	  (null (buffer-name occur-buffer)))
      (progn
403
	(setq occur-buffer nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
404
	(error "Buffer in which occurrences were found is deleted")))
405 406 407 408
  (let ((pos (get-text-property (point) 'occur)))
    (if (null pos)
	(error "No occurrence on this line")
      pos)))
409 410 411 412 413

(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
414
    (pop-to-buffer occur-buffer)
415
    (goto-char (marker-position pos))))
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448

(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)
	(error "no more matches"))
      (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))
	(error "no earlier matches"))
      
      (setq n (1- n)))))
449

450
(defcustom list-matching-lines-default-context-lines 0
Roland McGrath's avatar
Roland McGrath committed
451
  "*Default number of context lines to include around a `list-matching-lines'
Richard M. Stallman's avatar
Richard M. Stallman committed
452
match.  A negative number means to include that many lines before the match.
453 454 455
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
456

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

459 460 461 462
(defvar list-matching-lines-face 'bold
  "*Face used by M-x list-matching-lines to show the text that matches.
If the value is nil, don't highlight the matching portions specially.")

Richard M. Stallman's avatar
Richard M. Stallman committed
463
(defun occur (regexp &optional nlines)
464
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
465 466

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

Roland McGrath's avatar
Roland McGrath committed
468 469 470
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
471 472
Interactively it is the prefix arg.

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

477 478
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
479 480 481 482 483 484 485 486
  (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: ")
487
		  nil nil nil 'regexp-history default t)))
488 489
	   (and (equal input "") default
		(setq input default))
490
	   input)
491 492 493 494 495
	 current-prefix-arg))
  (let ((nlines (if nlines
		    (prefix-numeric-value nlines)
		  list-matching-lines-default-context-lines))
	(first t)
496
	;;flag to prevent printing separator for first match
497
	(occur-num-matches 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
498
	(buffer (current-buffer))
499
	(dir default-directory)
Richard M. Stallman's avatar
Richard M. Stallman committed
500
	(linenum 1)
501 502 503
	(prevpos 
	 ;;position of most recent match
	 (point-min))
504 505
	(case-fold-search  (and case-fold-search
				(isearch-no-upper-case-p regexp t)))
506 507 508 509
	(final-context-start
	 ;; Marker to the start of context immediately following
	 ;; the matched text in *Occur*.
	 (make-marker)))
510 511 512 513
;;;	(save-excursion
;;;	  (beginning-of-line)
;;;	  (setq linenum (1+ (count-lines (point-min) (point))))
;;;	  (setq prevpos (point)))
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
    (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)
533 534
	    (setq occur-command-arguments
		  (list regexp nlines)))
535
	  (if (eq buffer standard-output)
536
	      (goto-char (point-max)))
537 538 539 540 541 542 543 544 545 546
	  (save-excursion
	    ;; Find next match, but give up if prev match was at end of buffer.
	    (while (and (not (= prevpos (point-max)))
			(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))
547 548 549 550
	      (let* ((start
		      ;;start point of text in source buffer to be put
		      ;;into *Occur*
		      (save-excursion
551
			      (goto-char (match-beginning 0))
552 553 554
			      (forward-line (if (< nlines 0)
						nlines
					      (- nlines)))
555
			      (point)))
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
		     (end	
		      ;; end point of text in source buffer to be put
		      ;; into *Occur*
		      (save-excursion 
			(goto-char (match-end 0))
			(if (> nlines 0)
			    (forward-line (1+ nlines))
			  (forward-line 1))
			(point)))
		     (match-beg
		      ;; Amount of context before matching text
		      (- (match-beginning 0) start))
		     (match-len		
		      ;; Length of matching text
		      (- (match-end 0) (match-beginning 0)))
571 572
		     (tag (format "%5d" linenum))
		     (empty (make-string (length tag) ?\ ))
573
		     tem		
574
		     insertion-start
575 576 577 578 579 580 581 582 583 584 585
		     ;; Number of lines of context to show for current match.
		     occur-marker	
		     ;; Marker pointing to end of match in source buffer.
		     (text-beg
		      ;; Marker pointing to start of text for one
		      ;; match in *Occur*.
		      (make-marker))
		     (text-end 
		      ;; Marker pointing to end of text for one match
		      ;; in *Occur*.
		      (make-marker))
586
		     )
587
		(save-excursion
588 589
		  (setq occur-marker (make-marker))
		  (set-marker occur-marker (point))
590
		  (set-buffer standard-output)
591
		  (setq occur-num-matches (1+ occur-num-matches))
592 593 594
		  (or first (zerop nlines)
		      (insert "--------\n"))
		  (setq first nil)
595 596 597

		  ;; Insert matching text including context lines from
		  ;; source buffer into *Occur*
598
		  (set-marker text-beg (point))
599
		  (setq insertion-start (point))
600
		  (insert-buffer-substring buffer start end)
601 602 603 604 605 606 607 608 609 610 611 612 613
		  (or (and (/= (+ start match-beg) end)
			   (with-current-buffer buffer
			     (eq (char-before end) ?\n)))
		      (insert "\n"))
		  (set-marker final-context-start 
			      (+ (- (point) (- end (match-end 0)))
				 (if (save-excursion
				       (set-buffer buffer)
				       (save-excursion
					 (goto-char (match-end 0))
					 (end-of-line)
					 (bolp)))
				     1 0)))
614
		  (set-marker text-end (point))
615 616
		  
		  ;; Highlight text that was matched.
617 618 619 620 621 622
		  (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))

623 624
		  ;; `occur-point' property is used by occur-next and
		  ;; occur-prev to move between matching lines.
625 626 627 628
		  (put-text-property
		   (+ (marker-position text-beg) match-beg match-len)
		   (+ (marker-position text-beg) match-beg match-len 1)
		   'occur-point t)
629 630 631
		  
		  ;; Now go back to the start of the matching text
		  ;; adding the space and colon to the start of each line.
632
		  (goto-char insertion-start)
633
		  ;; Insert space and colon for lines of context before match.
634 635 636
		  (setq tem (if (< linenum nlines)
				(- nlines linenum)
			      nlines))
637 638 639 640
		  (while (> tem 0)
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1- tem)))
641 642 643 644

		  ;; Insert line number and colon for the lines of
		  ;; matching text.
		  (let ((this-linenum linenum))
645 646 647 648 649 650 651
		    (while (< (point) final-context-start)
		      (if (null tag)
			  (setq tag (format "%5d" this-linenum)))
		      (insert tag ?:)
		      (forward-line 1)
		      (setq tag nil)
		      (setq this-linenum (1+ this-linenum)))
652
		    (while (and (not (eobp)) (<= (point) final-context-start))
653 654 655
		      (insert empty ?:)
		      (forward-line 1)
		      (setq this-linenum (1+ this-linenum))))
656 657

		  ;; Insert space and colon for lines of context after match.
658
		  (while (and (< (point) (point-max)) (< tem nlines))
659 660 661
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1+ tem)))
662 663 664 665 666 667 668 669
		  
		  ;; Add text properties.  The `occur' prop is used to
		  ;; store the marker of the matching text in the
		  ;; source buffer.
		  (put-text-property (marker-position text-beg)
				     (- (marker-position text-end) 1)
				     'mouse-face 'highlight)
		  (put-text-property (marker-position text-beg)
670
				     (marker-position text-end)
671
				     'occur occur-marker)
672 673 674
		  (goto-char (point-max)))
		(forward-line 1)))
	    (set-buffer standard-output)
675 676
	    ;; Go back to top of *Occur* and finish off by printing the
	    ;; number of matching lines.
677
	    (goto-char (point-min))
678
	    (let ((message-string
679
		   (if (= occur-num-matches 1)
680
		       "1 line"
681
		     (format "%d lines" occur-num-matches))))
682 683
	      (insert message-string)
	      (if (interactive-p)
Karl Heuer's avatar
Karl Heuer committed
684 685
		  (message "%s matched" message-string)))
	    (setq buffer-read-only t)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
686

687 688
;; 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
689 690
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
691
RET or `q' to exit, Period to replace one match and exit,
Richard M. Stallman's avatar
Richard M. Stallman committed
692 693 694 695 696 697 698 699
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,
^ to move point back to previous match."
  "Help message while in query-replace")

700 701 702 703 704
(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',
705
`automatic', `backup', `exit-prefix', and `help'.")
706 707 708 709

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
710
(define-key query-replace-map [backspace] 'skip)
711 712
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
713 714
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
715 716
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "q" 'exit)
717
(define-key query-replace-map "\r" 'exit)
718
(define-key query-replace-map [return] 'exit)
719 720 721 722 723 724 725
(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)
726 727
(define-key query-replace-map [f1] 'help)
(define-key query-replace-map [help] 'help)
728
(define-key query-replace-map "?" 'help)
729 730
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
731 732
(define-key query-replace-map "\e" 'exit-prefix)
(define-key query-replace-map [escape] 'exit-prefix)
733

734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
(defun replace-match-string-symbols (n)
  ;; 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.
  (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)))

Richard M. Stallman's avatar
Richard M. Stallman committed
782 783
(defun perform-replace (from-string replacements
		        query-flag regexp-flag delimited-flag
784
			&optional repeat-count map)
Richard M. Stallman's avatar
Richard M. Stallman committed
785 786 787 788 789
  "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:
  (while (re-search-forward \"foo[ \t]+bar\" nil t)
    (replace-match \"foobar\" nil nil))
790
which will run faster and probably do exactly what you want."
791
  (or map (setq map query-replace-map))
792 793
  (and query-flag minibuffer-auto-raise
       (raise-frame (window-frame (minibuffer-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
794 795 796
  (let ((nocasify (not (and case-fold-search case-replace
			    (string-equal from-string
					  (downcase from-string)))))
797 798 799
	(case-fold-search (and case-fold-search
			       (string-equal from-string
					     (downcase from-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
800 801 802
	(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
803
	(real-match-data nil)		; the match data for the current match
Richard M. Stallman's avatar
Richard M. Stallman committed
804 805 806 807
	(next-replacement nil)
	(keep-going t)
	(stack nil)
	(replace-count 0)
808 809
	(nonempty-match nil)

810 811 812
	;; If non-nil, it is marker saying where in the buffer to stop.
	(limit nil)

813 814
	;; 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.
815
	(match-again t)
816

817 818 819 820
	(message
	 (if query-flag
	     (substitute-command-keys
	      "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) "))))
821 822 823 824 825 826 827

    ;; If region is active, in Transient Mark mode, operate on region.
    (if (and transient-mark-mode mark-active)
	(progn
	  (setq limit (copy-marker (region-end)))
	  (goto-char (region-beginning))
	  (deactivate-mark)))
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843

    ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
    ;; containing a function and its first argument.  The function is
    ;; called to generate each replacement like this:
    ;;   (funcall (car replacements) (cdr replacements) replace-count)
    ;; It must return a string.
    (cond
     ((stringp replacements)
      (setq next-replacement replacements
            replacements     nil))
     ((stringp (car replacements)) ; If it isn't a string, it must be a cons
      (or repeat-count (setq repeat-count 1))
      (setq replacements (cons 'replace-loop-through-replacements
                               (vector repeat-count repeat-count
                                       replacements replacements)))))

Richard M. Stallman's avatar
Richard M. Stallman committed
844 845 846 847 848 849 850 851
    (if delimited-flag
	(setq search-function 're-search-forward
	      search-string (concat "\\b"
				    (if regexp-flag from-string
				      (regexp-quote from-string))
				    "\\b")))
    (push-mark)
    (undo-boundary)
852 853 854 855
    (unwind-protect
	;; Loop finding occurrences that perhaps should be replaced.
	(while (and keep-going
		    (not (eobp))
856 857 858 859 860 861 862 863 864 865 866
		    ;; Use the next match if it is already known;
		    ;; otherwise, search for a match after moving forward
		    ;; one char if progress is required.
		    (setq real-match-data
			  (if (consp match-again)
			      (progn (goto-char (nth 1 match-again))
				     match-again)
			    (and (or match-again
				     (progn
				       (forward-char 1)
				       (not (eobp))))
867
				 (funcall search-function search-string limit t)
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
				 ;; For speed, use only integers and
				 ;; reuse the list used last time.
				 (match-data t real-match-data)))))

	  ;; Record whether the match is nonempty, to avoid an infinite loop
	  ;; repeatedly matching the same empty string.
	  (setq nonempty-match
		(/= (nth 0 real-match-data) (nth 1 real-match-data)))

	  ;; If the match is empty, record that the next one can't be adjacent.
	  ;; Otherwise, if matching a regular expression, do the next
	  ;; match now, since the replacement for this match may
	  ;; affect whether the next match is adjacent to this one.
	  (setq match-again
		(and nonempty-match
		     (or (not regexp-flag)
			 (and (looking-at search-string)
885
			      (match-data)))))
886

887 888 889 890 891 892
	  ;; Calculate the replacement string, if necessary.
	  (when replacements
            (set-match-data real-match-data)
            (setq next-replacement
                  (funcall (car replacements) (cdr replacements)
                           replace-count)))
893 894
	  (if (not query-flag)
	      (progn
895
		(set-match-data real-match-data)
896 897 898 899 900 901 902
		(replace-match next-replacement nocasify literal)
		(setq replace-count (1+ replace-count)))
	    (undo-boundary)
	    (let (done replaced key def)
	      ;; Loop reading commands until one of them sets done,
	      ;; which means it has finished handling this occurrence.
	      (while (not done)
903
		(set-match-data real-match-data)
904
		(replace-highlight (match-beginning 0) (match-end 0))
905 906 907 908
		;; Bind message-log-max so we don't fill up the message log
		;; with a bunch of identical messages.
		(let ((message-log-max nil))
		  (message message from-string next-replacement))
909
		(setq key (read-event))
910 911
		;; Necessary in case something happens during read-event
		;; that clobbers the match data.
912
		(set-match-data real-match-data)
913 914 915 916 917 918 919 920 921 922 923
		(setq key (vector key))
		(setq def (lookup-key map key))
		;; Restore the match data while we process the command.
		(cond ((eq def 'help)
		       (with-output-to-temp-buffer "*Help*"
			 (princ
			  (concat "Query replacing "
				  (if regexp-flag "regexp " "")
				  from-string " with "
				  next-replacement ".\n\n"
				  (substitute-command-keys
924 925 926 927
				   query-replace-help)))
			 (save-excursion
			   (set-buffer standard-output)
			   (help-mode))))
928 929 930 931
		      ((eq def 'exit)
		       (setq keep-going nil)
		       (setq done t))
		      ((eq def 'backup)
932 933 934 935 936
		       (if stack
			   (let ((elt (car stack)))
			     (goto-char (car elt))
			     (setq replaced (eq t (cdr elt)))
			     (or replaced
937
				 (set-match-data (cdr elt)))
938 939 940 941
			     (setq stack (cdr stack)))
			 (message "No previous match")
			 (ding 'no-terminate)
			 (sit-for 1)))
942 943
		      ((eq def 'act)
		       (or replaced
944 945 946
			   (progn
			     (replace-match next-replacement nocasify literal)
			     (setq replace-count (1+ replace-count))))
947 948 949
		       (setq done t replaced t))
		      ((eq def 'act-and-exit)
		       (or replaced
950 951 952
			   (progn
			     (replace-match next-replacement nocasify literal)
			     (setq replace-count (1+ replace-count))))
953 954 955 956 957 958
		       (setq keep-going nil)
		       (setq done t replaced t))
		      ((eq def 'act-and-show)
		       (if (not replaced)
			   (progn
			     (replace-match next-replacement nocasify literal)
959
			     (setq replace-count (1+ replace-count))
960 961 962
			     (setq replaced t))))
		      ((eq def 'automatic)
		       (or replaced
963 964 965
			   (progn
			     (replace-match next-replacement nocasify literal)
			     (setq replace-count (1+ replace-count))))
966 967 968 969 970 971
		       (setq done t query-flag nil replaced t))
		      ((eq def 'skip)
		       (setq done t))
		      ((eq def 'recenter)
		       (recenter nil))
		      ((eq def 'edit)
972 973 974 975 976 977 978
		       (let ((opos (point-marker)))
			 (goto-char (match-beginning 0))
			 (save-excursion
			   (funcall search-function search-string limit t)
			   (setq real-match-data (match-data)))
			 (save-excursion (recursive-edit))
			 (goto-char opos))
979
		       (set-match-data real-match-data)
980 981 982
		       ;; Before we make the replacement,
		       ;; decide whether the search string
		       ;; can match again just after this match.
983 984
		       (if (and regexp-flag nonempty-match)
			   (setq match-again (and (looking-at search-string)
985
						  (match-data)))))
986 987
		      ((eq def 'delete-and-edit)
		       (delete-region (match-beginning 0) (match-end 0))
988
		       (set-match-data
989 990 991
			(prog1 (match-data)
			  (save-excursion (recursive-edit))))
		       (setq replaced t))
992 993 994
		      ;; Note: we do not need to treat `exit-prefix'
		      ;; specially here, since we reread
		      ;; any unrecognized character.
995
		      (t
996
		       (setq this-command 'mode-exited)
997 998 999 1000 1001 1002 1003 1004 1005 1006
		       (setq keep-going nil)
		       (setq unread-command-events
			     (append (listify-key-sequence key)
				     unread-command-events))
		       (setq done t))))
	      ;; Record previous position for ^ when we move on.
	      ;; Change markers to numbers in the match data
	      ;; since lots of markers slow down editing.
	      (setq stack
		    (cons (cons (point)
1007
				(or replaced (match-data t)))
1008
			  stack)))))
1009
      (replace-dehighlight))
1010 1011 1012 1013 1014
    (or unread-command-events
	(message "Replaced %d occurrence%s"
		 replace-count
		 (if (= replace-count 1) "" "s")))
    (and keep-going stack)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1015

1016
(defcustom query-replace-highlight t
1017 1018 1019
  "*Non-nil means to highlight words during query replacement."
  :type 'boolean
  :group 'matching)
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039

(defvar replace-overlay nil)

(defun replace-dehighlight ()
  (and replace-overlay
       (progn
	 (delete-overlay replace-overlay)
	 (setq replace-overlay nil))))

(defun replace-highlight (start end)
  (and query-replace-highlight
       (progn
	 (or replace-overlay
	     (progn
	       (setq replace-overlay (make-overlay start end))
	       (overlay-put replace-overlay 'face
			    (if (internal-find-face 'query-replace)
				'query-replace 'region))))
	 (move-overlay replace-overlay start end (current-buffer)))))

Eric S. Raymond's avatar
Eric S. Raymond committed
1040
;;; replace.el ends here