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

3
;; Copyright (C) 1985, 1986, 1987, 1992 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 18 19 20
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

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

Brian Preble's avatar
Brian Preble committed
28 29
(defconst case-replace t "\
*Non-nil means query-replace should preserve case in replacements.")
Roland McGrath's avatar
Roland McGrath committed
30

31 32 33 34 35 36 37 38 39 40 41 42
(defvar query-replace-history nil)

(defun query-replace-read-args (string)
  (let (from to)
    (setq from (read-from-minibuffer (format "%s: " string)
				     nil nil nil
				     'query-replace-history))
    (setq to (read-from-minibuffer (format "%s %s with: " string from)
				   nil nil nil
				   'query-replace-history))
    (list from to current-prefix-arg)))

Roland McGrath's avatar
Roland McGrath committed
43 44 45 46 47 48 49 50
(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.

Preserves case in each replacement if  case-replace  and  case-fold-search
are non-nil and FROM-STRING has no uppercase letters.
Third arg DELIMITED (prefix arg if interactive) non-nil means replace
51 52 53
only matches surrounded by word boundaries.

To customize possible responses, change the \"bindings\" in `query-replace-map'."
54
  (interactive (query-replace-read-args "Query replace"))
Roland McGrath's avatar
Roland McGrath committed
55
  (perform-replace from-string to-string t nil arg)
56
  (or unread-command-events (message "Done")))
Brian Preble's avatar
Brian Preble committed
57
(define-key esc-map "%" 'query-replace)
Roland McGrath's avatar
Roland McGrath committed
58 59 60 61 62 63 64 65 66 67 68 69

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

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) non-nil means replace
only matches surrounded by word boundaries.
In TO-STRING, \\& means insert what matched REGEXP,
and \\=\\<n> means insert what matched <n>th \\(...\\) in REGEXP."
70
  (interactive (query-replace-read-args "Query replace regexp"))
Roland McGrath's avatar
Roland McGrath committed
71
  (perform-replace regexp to-string t t arg)
72
  (or unread-command-events (message "Done")))
Roland McGrath's avatar
Roland McGrath committed
73 74 75 76 77 78 79 80 81 82 83 84

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

Non-interactively, TO-STRINGS may be a list of replacement strings.

A prefix argument N says to use each replacement string N times
before rotating to the next."
85 86 87 88 89 90 91 92 93 94 95
  (interactive
   (let (from to)
     (setq from (read-from-minibuffer "Map query replace (regexp): "
				      nil nil nil
				      'query-replace-history))
     (setq to (read-from-minibuffer
	       (format "Query replace %s with (space-separated strings): "
		       from)
	       nil nil nil
	       'query-replace-history))
     (list from to current-prefix-arg)))
Roland McGrath's avatar
Roland McGrath committed
96 97 98 99 100 101 102 103 104 105 106 107 108 109
  (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 ""))))
    (perform-replace regexp replacements t t nil arg))
110
  (or unread-command-events (message "Done")))
Roland McGrath's avatar
Roland McGrath committed
111 112 113 114 115 116 117 118 119 120 121 122 123

(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.
Third arg DELIMITED (prefix arg if interactive) non-nil means replace
only matches surrounded by word boundaries.

This function is usually the wrong thing to use in a Lisp program.
What you probably want is a loop like this:
  (while (search-forward OLD-STRING nil t)
    (replace-match REPLACEMENT nil t))
which will run faster and will not set the mark or print anything."
124
  (interactive (query-replace-read-args "Replace string"))
Roland McGrath's avatar
Roland McGrath committed
125
  (perform-replace from-string to-string nil nil delimited)
126
  (or unread-command-events (message "Done")))
Roland McGrath's avatar
Roland McGrath committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141

(defun replace-regexp (regexp to-string &optional delimited)
  "Replace things after point matching REGEXP with TO-STRING.
Preserve case in each match if case-replace and case-fold-search
are non-nil and REGEXP has no uppercase letters.
Third arg DELIMITED (prefix arg if interactive) non-nil means replace
only matches surrounded by word boundaries.
In TO-STRING, \\& means insert what matched REGEXP,
and \\=\\<n> means insert what matched <n>th \\(...\\) in REGEXP.

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)
    (replace-match REPLACEMENT nil nil))
which will run faster and will not set the mark or print anything."
142
  (interactive (query-replace-read-args "Replace regexp"))
Roland McGrath's avatar
Roland McGrath committed
143
  (perform-replace regexp to-string nil t delimited)
144
  (or unread-command-events (message "Done")))
145 146 147

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
148

Richard M. Stallman's avatar
Richard M. Stallman committed
149 150 151 152 153
(fset 'delete-non-matching-lines 'keep-lines)
(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.
Applies to all lines after point."
154 155 156
  (interactive (list (read-from-minibuffer
		      "sKeep lines (containing match for regexp): "
		      nil nil nil 'regexp-history)))
Richard M. Stallman's avatar
Richard M. Stallman committed
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  (save-excursion
    (or (bolp) (forward-line 1))
    (let ((start (point)))
      (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))))))

(fset 'delete-matching-lines 'flush-lines)
(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.
Applies to lines after point."
181 182 183
  (interactive (list (read-from-minibuffer
		      "sFlush lines (containing match for regexp): "
		      nil nil nil 'regexp-history)))
Richard M. Stallman's avatar
Richard M. Stallman committed
184 185 186 187 188 189 190 191 192 193 194
  (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))))))

(fset 'count-matches 'how-many)
(defun how-many (regexp)
  "Print number of matches for REGEXP following point."
195 196 197
  (interactive (list (read-from-minibuffer
		      "sHow many matches for (regexp): "
		      nil nil nil 'regexp-history)))
Richard M. Stallman's avatar
Richard M. Stallman committed
198 199 200 201 202 203 204 205 206
  (let ((count 0) opoint)
    (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))))
207

Richard M. Stallman's avatar
Richard M. Stallman committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
(defvar occur-mode-map ())
(if occur-mode-map
    ()
  (setq occur-mode-map (make-sparse-keymap))
  (define-key occur-mode-map "\C-c\C-c" 'occur-mode-goto-occurrence))

(defvar occur-buffer nil)
(defvar occur-nlines nil)
(defvar occur-pos-list nil)

(defun occur-mode ()
  "Major mode for output from \\[occur].
Move point to one of the occurrences in this buffer,
then use \\[occur-mode-goto-occurrence] to go to the same occurrence
in the buffer that the occurrences were found in.
\\{occur-mode-map}"
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
  (make-local-variable 'occur-buffer)
  (make-local-variable 'occur-nlines)
  (make-local-variable 'occur-pos-list))

(defun occur-mode-goto-occurrence ()
  "Go to the line this occurrence was found in, in the buffer it was found in."
  (interactive)
  (if (or (null occur-buffer)
	  (null (buffer-name occur-buffer)))
      (progn
	(setq occur-buffer nil
	      occur-pos-list nil)
	(error "Buffer in which occurrences were found is deleted")))
  (let* ((occur-number (save-excursion
			 (beginning-of-line)
			 (/ (1- (count-lines (point-min)
					     (save-excursion
					       (beginning-of-line)
					       (point))))
			    (cond ((< occur-nlines 0)
				   (- 2 occur-nlines))
				  ((> occur-nlines 0)
				   (+ 2 (* 2 occur-nlines)))
				  (t 1)))))
	 (pos (nth occur-number occur-pos-list)))
    (pop-to-buffer occur-buffer)
    (goto-char (marker-position pos))))
255

Richard M. Stallman's avatar
Richard M. Stallman committed
256
(defvar list-matching-lines-default-context-lines 0
Roland McGrath's avatar
Roland McGrath committed
257
  "*Default number of context lines to include around a `list-matching-lines'
Richard M. Stallman's avatar
Richard M. Stallman committed
258 259 260 261 262 263
match.  A negative number means to include that many lines before the match.
A positive number means to include that many lines both before and after.")

(fset 'list-matching-lines 'occur)

(defun occur (regexp &optional nlines)
264
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
265 266

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

Roland McGrath's avatar
Roland McGrath committed
268 269 270
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
271 272
Interactively it is the prefix arg.

273
The lines are shown in a buffer named `*Occur*'.
Richard M. Stallman's avatar
Richard M. Stallman committed
274 275
It serves as a menu to find any of the occurrences in this buffer.
\\[describe-mode] in that buffer will explain how."
276 277 278 279 280 281 282 283
  (interactive (list (let* ((default (car regexp-history))
			    (input 
			     (read-from-minibuffer
			      (format "List lines matching regexp (default `%s'): " default)
			      nil nil nil
			      'regexp-history)))
		       (if (> (length input) 0) input
			 (setcar regexp-history default)))
root's avatar
root committed
284
		     current-prefix-arg))
Richard M. Stallman's avatar
Richard M. Stallman committed
285 286 287 288 289
  (setq nlines (if nlines (prefix-numeric-value nlines)
		 list-matching-lines-default-context-lines))
  (let ((first t)
	(buffer (current-buffer))
	(linenum 1)
Jim Blandy's avatar
Jim Blandy committed
290 291
	(prevpos (point-min))
	(final-context-start (make-marker)))
292 293 294 295
;;;	(save-excursion
;;;	  (beginning-of-line)
;;;	  (setq linenum (1+ (count-lines (point-min) (point))))
;;;	  (setq prevpos (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
296 297 298 299 300 301 302 303 304 305 306 307 308
    (with-output-to-temp-buffer "*Occur*"
      (save-excursion
	(set-buffer standard-output)
	(insert "Lines matching ")
	(prin1 regexp)
	(insert " in buffer " (buffer-name buffer) ?. ?\n)
	(occur-mode)
	(setq occur-buffer buffer)
	(setq occur-nlines nlines)
	(setq occur-pos-list ()))
      (if (eq buffer standard-output)
	  (goto-char (point-max)))
      (save-excursion
309
	(beginning-of-buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
310 311 312
	;; 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))
Roland McGrath's avatar
Roland McGrath committed
313
	  (goto-char (match-beginning 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
314
	  (beginning-of-line)
315 316
	  (save-match-data
	    (setq linenum (+ linenum (count-lines prevpos (point)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
317
	  (setq prevpos (point))
Roland McGrath's avatar
Roland McGrath committed
318
	  (goto-char (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
319
	  (let* ((start (save-excursion
Roland McGrath's avatar
Roland McGrath committed
320
			  (goto-char (match-beginning 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
321 322 323
			  (forward-line (if (< nlines 0) nlines (- nlines)))
			  (point)))
		 (end (save-excursion
Roland McGrath's avatar
Roland McGrath committed
324
			(goto-char (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
325 326 327 328 329 330 331 332
			(if (> nlines 0)
			    (forward-line (1+ nlines))
			    (forward-line 1))
			(point)))
		 (tag (format "%3d" linenum))
		 (empty (make-string (length tag) ?\ ))
		 tem)
	    (save-excursion
Jim Blandy's avatar
Jim Blandy committed
333 334
	      (setq tem (make-marker))
	      (set-marker tem (point))
Richard M. Stallman's avatar
Richard M. Stallman committed
335 336 337 338 339 340 341
	      (set-buffer standard-output)
	      (setq occur-pos-list (cons tem occur-pos-list))
	      (or first (zerop nlines)
		  (insert "--------\n"))
	      (setq first nil)
	      (insert-buffer-substring buffer start end)
	      (backward-char (- end start))
Roland McGrath's avatar
Roland McGrath committed
342
	      (setq tem nlines)
Richard M. Stallman's avatar
Richard M. Stallman committed
343 344 345 346
	      (while (> tem 0)
		(insert empty ?:)
		(forward-line 1)
		(setq tem (1- tem)))
Jim Blandy's avatar
Jim Blandy committed
347
	      (let ((this-linenum linenum))
Roland McGrath's avatar
Roland McGrath committed
348 349 350 351 352 353 354 355 356
		(set-marker final-context-start
			    (+ (point) (- (match-end 0) (match-beginning 0))))
		(while (< (point) final-context-start)
		  (if (null tag)
		      (setq tag (format "%3d" this-linenum)))
		  (insert tag ?:)
		  (setq tag nil)
		  (forward-line 1)
		  (setq this-linenum (1+ this-linenum))))
Richard M. Stallman's avatar
Richard M. Stallman committed
357 358 359 360 361 362 363 364 365 366 367
	      (while (< tem nlines)
		(insert empty ?:)
		(forward-line 1)
		(setq tem (1+ tem))))				
	    (forward-line 1)))
	(set-buffer standard-output)
	;; Put positions in increasing order to go with buffer.
	(setq occur-pos-list (nreverse occur-pos-list))
	(if (interactive-p)
	    (message "%d matching lines." (length occur-pos-list)))))))

368 369
;; 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
370 371 372 373 374 375 376 377 378 379 380
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
ESC or `q' to exit, Period to replace one match and exit,
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")

381 382 383 384 385 386 387 388 389 390
(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',
`automatic', `backup', and `help'.")

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
391
(define-key query-replace-map [backspace] 'skip)
392 393 394 395 396 397 398 399 400 401 402 403 404
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "\e" 'exit)
(define-key query-replace-map "q" 'exit)
(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)
(define-key query-replace-map "?" 'help)
405 406
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
407

Richard M. Stallman's avatar
Richard M. Stallman committed
408 409
(defun perform-replace (from-string replacements
		        query-flag regexp-flag delimited-flag
410
			&optional repeat-count map)
Richard M. Stallman's avatar
Richard M. Stallman committed
411 412 413 414 415 416
  "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))
which will run faster and do exactly what you probably want."
417
  (or map (setq map query-replace-map))
Richard M. Stallman's avatar
Richard M. Stallman committed
418 419 420 421 422 423
  (let ((nocasify (not (and case-fold-search case-replace
			    (string-equal from-string
					  (downcase from-string)))))
	(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
424
	(real-match-data nil)		; the match data for the current match
Richard M. Stallman's avatar
Richard M. Stallman committed
425 426 427 428 429 430
	(next-replacement nil)
	(replacement-index 0)
	(keep-going t)
	(stack nil)
	(next-rotate-count 0)
	(replace-count 0)
Roland McGrath's avatar
Roland McGrath committed
431
	(lastrepl nil)			;Position after last match considered.
432
	(match-again t))
Richard M. Stallman's avatar
Richard M. Stallman committed
433 434 435 436 437 438 439 440 441 442 443
    (if (stringp replacements)
	(setq next-replacement replacements)
      (or repeat-count (setq repeat-count 1)))
    (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)
444
    ;; Loop finding occurrences that perhaps should be replaced.
Richard M. Stallman's avatar
Richard M. Stallman committed
445 446 447
    (while (and keep-going
		(not (eobp))
		(funcall search-function search-string nil t)
Roland McGrath's avatar
Roland McGrath committed
448 449 450 451 452 453 454 455 456
		;; If the search string matches immediately after
		;; the previous match, but it did not match there
		;; before the replacement was done, ignore the match.
		(if (or (eq lastrepl (point))
			(and regexp-flag
			     (eq lastrepl (match-beginning 0))
			     (not match-again)))
		    (if (eobp)
			nil
Richard M. Stallman's avatar
Richard M. Stallman committed
457 458 459 460 461
		      ;; Don't replace the null string 
		      ;; right after end of previous replacement.
		      (forward-char 1)
		      (funcall search-function search-string nil t))
		  t))
Jim Blandy's avatar
Jim Blandy committed
462 463 464 465

      ;; Save the data associated with the real match.
      (setq real-match-data (match-data))

Roland McGrath's avatar
Roland McGrath committed
466 467 468 469
      ;; Before we make the replacement, decide whether the search string
      ;; can match again just after this match.
      (if regexp-flag
	  (setq match-again (looking-at search-string)))
Richard M. Stallman's avatar
Richard M. Stallman committed
470 471 472 473 474 475 476 477 478 479
      ;; If time for a change, advance to next replacement string.
      (if (and (listp replacements)
	       (= next-rotate-count replace-count))
	  (progn
	    (setq next-rotate-count
		  (+ next-rotate-count repeat-count))
	    (setq next-replacement (nth replacement-index replacements))
	    (setq replacement-index (% (1+ replacement-index) (length replacements)))))
      (if (not query-flag)
	  (progn
Jim Blandy's avatar
Jim Blandy committed
480
	    (store-match-data real-match-data)
Richard M. Stallman's avatar
Richard M. Stallman committed
481 482 483
	    (replace-match next-replacement nocasify literal)
	    (setq replace-count (1+ replace-count)))
	(undo-boundary)
484
	(let (done replaced key def)
485 486
	  ;; Loop reading commands until one of them sets done,
	  ;; which means it has finished handling this occurrence.
Richard M. Stallman's avatar
Richard M. Stallman committed
487
	  (while (not done)
488 489
	    (message "Query replacing %s with %s: "
		     from-string next-replacement)
490 491
	    (setq key (read-event))
	    (setq key (vector key))
492
	    (setq def (lookup-key map key))
Jim Blandy's avatar
Jim Blandy committed
493 494
	    ;; Restore the match data while we process the command.
	    (store-match-data real-match-data)
495 496 497 498 499 500 501 502 503 504
	    (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
			       query-replace-help)))))
		  ((eq def 'exit)
Richard M. Stallman's avatar
Richard M. Stallman committed
505 506
		   (setq keep-going nil)
		   (setq done t))
507
		  ((eq def 'backup)
Richard M. Stallman's avatar
Richard M. Stallman committed
508 509 510 511 512 513
		   (let ((elt (car stack)))
		     (goto-char (car elt))
		     (setq replaced (eq t (cdr elt)))
		     (or replaced
			 (store-match-data (cdr elt)))
		     (setq stack (cdr stack))))		     
514
		  ((eq def 'act)
Richard M. Stallman's avatar
Richard M. Stallman committed
515 516 517
		   (or replaced
		       (replace-match next-replacement nocasify literal))
		   (setq done t replaced t))
518
		  ((eq def 'act-and-exit)
Richard M. Stallman's avatar
Richard M. Stallman committed
519 520 521 522
		   (or replaced
		       (replace-match next-replacement nocasify literal))
		   (setq keep-going nil)
		   (setq done t replaced t))
523
		  ((eq def 'act-and-show)
Richard M. Stallman's avatar
Richard M. Stallman committed
524 525 526 527
		   (if (not replaced)
		       (progn
			 (replace-match next-replacement nocasify literal)
			 (setq replaced t))))
528
		  ((eq def 'automatic)
Richard M. Stallman's avatar
Richard M. Stallman committed
529 530 531
		   (or replaced
		       (replace-match next-replacement nocasify literal))
		   (setq done t query-flag nil replaced t))
532
		  ((eq def 'skip)
Richard M. Stallman's avatar
Richard M. Stallman committed
533
		   (setq done t))
534
		  ((eq def 'recenter)
Richard M. Stallman's avatar
Richard M. Stallman committed
535
		   (recenter nil))
536
		  ((eq def 'edit)
Richard M. Stallman's avatar
Richard M. Stallman committed
537 538
		   (store-match-data
		    (prog1 (match-data)
Roland McGrath's avatar
Roland McGrath committed
539 540 541 542 543 544
		      (save-excursion (recursive-edit))))
		   ;; Before we make the replacement,
		   ;; decide whether the search string
		   ;; can match again just after this match.
		   (if regexp-flag
		       (setq match-again (looking-at search-string))))
545
		  ((eq def 'delete-and-edit)
Richard M. Stallman's avatar
Richard M. Stallman committed
546 547 548 549 550 551 552
		   (delete-region (match-beginning 0) (match-end 0))
		   (store-match-data
		    (prog1 (match-data)
		      (save-excursion (recursive-edit))))
		   (setq replaced t))
		  (t
		   (setq keep-going nil)
553 554 555
		   (setq unread-command-events
			 (append (listify-key-sequence key)
				 unread-command-events))
Richard M. Stallman's avatar
Richard M. Stallman committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
		   (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)
			    (or replaced
				(mapcar
				 (function (lambda (elt)
					     (and elt
						  (marker-position elt))))
				 (match-data))))
		      stack))
	  (if replaced (setq replace-count (1+ replace-count)))))
      (setq lastrepl (point)))
571
  (and keep-going stack)))
Richard M. Stallman's avatar
Richard M. Stallman committed
572

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