replace.el 27.4 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, 1994, 1996 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
(defvar case-replace t "\
Brian Preble's avatar
Brian Preble committed
30
*Non-nil means query-replace should preserve case in replacements.")
Roland McGrath's avatar
Roland McGrath committed
31

32 33
(defvar query-replace-history nil)

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

(defun query-replace-read-args (string regexp-flag)
39
  (let (from to)
40 41 42 43 44
    (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
				       'query-replace-history)))
45 46 47 48 49
    (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
50 51 52 53 54
(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.

55 56 57 58
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.

Richard M. Stallman's avatar
Richard M. Stallman committed
59
Preserves case in each replacement if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
60
are non-nil and FROM-STRING has no uppercase letters.
61 62 63
\(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
64
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
65 66 67
only matches surrounded by word boundaries.

To customize possible responses, change the \"bindings\" in `query-replace-map'."
68
  (interactive (query-replace-read-args "Query replace" nil))
69
  (perform-replace from-string to-string t nil arg))
Brian Preble's avatar
Brian Preble committed
70
(define-key esc-map "%" 'query-replace)
Roland McGrath's avatar
Roland McGrath committed
71 72 73 74 75 76

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

77 78 79 80
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
81
Preserves case in each replacement if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
82
are non-nil and REGEXP has no uppercase letters.
Richard M. Stallman's avatar
Richard M. Stallman committed
83
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
84
only matches surrounded by word boundaries.
Richard M. Stallman's avatar
Richard M. Stallman committed
85 86 87
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."
88
  (interactive (query-replace-read-args "Query replace regexp" t))
89
  (perform-replace regexp to-string t t arg))
Roland McGrath's avatar
Roland McGrath committed
90 91 92 93 94 95 96 97 98 99

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

100 101 102
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
103 104
A prefix argument N says to use each replacement string N times
before rotating to the next."
105 106
  (interactive
   (let (from to)
107 108 109 110 111
     (setq from (if query-replace-interactive
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
					'query-replace-history)))
112 113 114 115 116 117
     (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
118 119 120 121 122 123 124 125 126 127 128 129 130
  (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 ""))))
131
    (perform-replace regexp replacements t t nil arg)))
Roland McGrath's avatar
Roland McGrath committed
132 133 134 135 136

(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.
137 138 139
\(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
140
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
141 142
only matches surrounded by word boundaries.

143 144 145 146
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
147 148
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
149 150
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
Roland McGrath's avatar
Roland McGrath committed
151
which will run faster and will not set the mark or print anything."
152
  (interactive (query-replace-read-args "Replace string" nil))
153
  (perform-replace from-string to-string nil nil delimited))
Roland McGrath's avatar
Roland McGrath committed
154 155 156

(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
157
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
158
are non-nil and REGEXP has no uppercase letters.
Richard M. Stallman's avatar
Richard M. Stallman committed
159
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
160
only matches surrounded by word boundaries.
Richard M. Stallman's avatar
Richard M. Stallman committed
161 162
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
163
 whatever what matched the Nth `\\(...\\)' in REGEXP.
Roland McGrath's avatar
Roland McGrath committed
164

165 166 167
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
168 169 170
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
171
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
172
which will run faster and will not set the mark or print anything."
173
  (interactive (query-replace-read-args "Replace regexp" t))
174
  (perform-replace regexp to-string nil t delimited))
175 176 177

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
178

179
(defalias 'delete-non-matching-lines 'keep-lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
180 181 182 183
(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."
184
  (interactive (list (read-from-minibuffer
185
		      "Keep lines (containing match for regexp): "
186
		      nil nil nil 'regexp-history)))
Richard M. Stallman's avatar
Richard M. Stallman committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
  (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))))))

206
(defalias 'delete-matching-lines 'flush-lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
207 208 209 210
(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."
211
  (interactive (list (read-from-minibuffer
212
		      "Flush lines (containing match for regexp): "
213
		      nil nil nil 'regexp-history)))
Richard M. Stallman's avatar
Richard M. Stallman committed
214 215 216 217 218 219 220 221
  (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))))))

222
(defalias 'count-matches 'how-many)
Richard M. Stallman's avatar
Richard M. Stallman committed
223 224
(defun how-many (regexp)
  "Print number of matches for REGEXP following point."
225
  (interactive (list (read-from-minibuffer
226
		      "How many matches for (regexp): "
227
		      nil nil nil 'regexp-history)))
Richard M. Stallman's avatar
Richard M. Stallman committed
228 229 230 231 232 233 234 235 236
  (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))))
237

Richard M. Stallman's avatar
Richard M. Stallman committed
238 239 240 241
(defvar occur-mode-map ())
(if occur-mode-map
    ()
  (setq occur-mode-map (make-sparse-keymap))
242
  (define-key occur-mode-map [mouse-2] 'occur-mode-mouse-goto)
243
  (define-key occur-mode-map "\C-c\C-c" 'occur-mode-goto-occurrence)
244 245
  (define-key occur-mode-map "\C-m" 'occur-mode-goto-occurrence)
  (define-key occur-mode-map "g" 'revert-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
246 247 248 249

(defvar occur-buffer nil)
(defvar occur-nlines nil)
(defvar occur-pos-list nil)
250 251
(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
252 253 254

(defun occur-mode ()
  "Major mode for output from \\[occur].
255 256 257 258
\\<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
259 260 261 262 263
\\{occur-mode-map}"
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
264 265
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'occur-revert-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
266 267
  (make-local-variable 'occur-buffer)
  (make-local-variable 'occur-nlines)
268
  (make-local-variable 'occur-pos-list)
269
  (make-local-variable 'occur-command-arguments)
270
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
271

272 273 274 275 276 277 278
;; 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))))

279 280 281 282 283 284 285 286 287 288 289 290 291 292
(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
293 294 295 296 297 298
  (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")))
299 300 301 302 303 304
  (let* ((line-count
	  (count-lines (point-min)
		       (save-excursion
			 (beginning-of-line)
			 (point))))
	 (occur-number (save-excursion
Richard M. Stallman's avatar
Richard M. Stallman committed
305
			 (beginning-of-line)
306
			 (/ (1- line-count)
Richard M. Stallman's avatar
Richard M. Stallman committed
307 308 309 310 311 312
			    (cond ((< occur-nlines 0)
				   (- 2 occur-nlines))
				  ((> occur-nlines 0)
				   (+ 2 (* 2 occur-nlines)))
				  (t 1)))))
	 (pos (nth occur-number occur-pos-list)))
313 314
    (if (< line-count 1)
	(error "No occurrence on this line"))
315 316
    (or pos
	(error "No occurrence on this line"))
317 318 319 320 321 322
    pos))

(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
323
    (pop-to-buffer occur-buffer)
324
    (goto-char (marker-position pos))))
325

Richard M. Stallman's avatar
Richard M. Stallman committed
326
(defvar list-matching-lines-default-context-lines 0
Roland McGrath's avatar
Roland McGrath committed
327
  "*Default number of context lines to include around a `list-matching-lines'
Richard M. Stallman's avatar
Richard M. Stallman committed
328 329 330
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.")

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

333 334 335 336
(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
337
(defun occur (regexp &optional nlines)
338
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
339 340

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

Roland McGrath's avatar
Roland McGrath committed
342 343 344
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
345 346
Interactively it is the prefix arg.

347
The lines are shown in a buffer named `*Occur*'.
Richard M. Stallman's avatar
Richard M. Stallman committed
348 349
It serves as a menu to find any of the occurrences in this buffer.
\\[describe-mode] in that buffer will explain how."
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
  (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: ")
		  nil nil nil 'regexp-history)))
	   (if (string-equal input "")
	       default
	     (set-text-properties 0 (length input) nil input)
	     input))
	 current-prefix-arg))
  (let ((nlines (if nlines
		    (prefix-numeric-value nlines)
		  list-matching-lines-default-context-lines))
	(first t)
Richard M. Stallman's avatar
Richard M. Stallman committed
368
	(buffer (current-buffer))
369
	(dir default-directory)
Richard M. Stallman's avatar
Richard M. Stallman committed
370
	(linenum 1)
Jim Blandy's avatar
Jim Blandy committed
371 372
	(prevpos (point-min))
	(final-context-start (make-marker)))
373 374 375 376
;;;	(save-excursion
;;;	  (beginning-of-line)
;;;	  (setq linenum (1+ (count-lines (point-min) (point))))
;;;	  (setq prevpos (point)))
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
    (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)
396 397 398
	    (setq occur-pos-list ())
	    (setq occur-command-arguments
		  (list regexp nlines)))
399
	  (if (eq buffer standard-output)
400
	      (goto-char (point-max)))
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
	  (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))
	      (let* ((start (save-excursion
			      (goto-char (match-beginning 0))
			      (forward-line (if (< nlines 0) nlines (- nlines)))
			      (point)))
		     (end (save-excursion
			    (goto-char (match-end 0))
			    (if (> nlines 0)
				(forward-line (1+ nlines))
				(forward-line 1))
			    (point)))
421 422 423 424 425 426 427 428
		     ;; Record where the actual match 
		     (match-offset
		      (save-excursion
			(goto-char (match-beginning 0))
			(beginning-of-line)
			;; +6 to skip over line number
			(+ 6 (- (match-beginning 0) (point)))))
		     (match-len (- (match-end 0) (match-beginning 0)))
429 430 431 432 433 434 435 436 437 438 439 440 441 442
		     (tag (format "%5d" linenum))
		     (empty (make-string (length tag) ?\ ))
		     tem)
		(save-excursion
		  (setq tem (make-marker))
		  (set-marker tem (point))
		  (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)
		  (set-marker final-context-start 
			      (- (point) (- end (match-end 0))))
443
		  (goto-char (- (point) (- end start)))
444 445 446 447 448
		  (setq tem nlines)
		  (while (> tem 0)
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1- tem)))
Erik Naggum's avatar
Erik Naggum committed
449 450
		  (let ((this-linenum linenum)
			line-start)
451 452 453 454
		    (while (< (point) final-context-start)
		      (if (null tag)
			  (setq tag (format "%5d" this-linenum)))
		      (insert tag ?:)
455 456 457 458 459
		      (setq line-start
			    (save-excursion
			      (beginning-of-line)
			      (point)))
		      (put-text-property line-start
460 461 462 463
					 (save-excursion
					   (end-of-line)
					   (point))
					 'mouse-face 'highlight)
464 465 466 467 468
		      (if list-matching-lines-face
			  (put-text-property
			   (+ line-start match-offset)
			   (+ line-start match-offset match-len)
			   'face list-matching-lines-face))
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
		      (forward-line 1)
		      (setq tag nil)
		      (setq this-linenum (1+ this-linenum)))
		    (while (<= (point) final-context-start)
		      (insert empty ?:)
		      (forward-line 1)
		      (setq this-linenum (1+ this-linenum))))
		  (while (< tem nlines)
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1+ tem)))
		  (goto-char (point-max)))
		(forward-line 1)))
	    (set-buffer standard-output)
	    ;; Put positions in increasing order to go with buffer.
	    (setq occur-pos-list (nreverse occur-pos-list))
	    (goto-char (point-min))
486 487 488 489 490 491 492
	    (let ((message-string
		   (if (= (length occur-pos-list) 1)
		       "1 line"
		     (format "%d lines" (length occur-pos-list)))))
	      (insert message-string)
	      (if (interactive-p)
		  (message "%s matched" message-string)))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
493

494 495
;; 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
496 497
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
498
RET or `q' to exit, Period to replace one match and exit,
Richard M. Stallman's avatar
Richard M. Stallman committed
499 500 501 502 503 504 505 506
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")

507 508 509 510 511
(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',
512
`automatic', `backup', `exit-prefix', and `help'.")
513 514 515 516

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
517
(define-key query-replace-map [backspace] 'skip)
518 519
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
520 521
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
522 523
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "q" 'exit)
524
(define-key query-replace-map "\r" 'exit)
525
(define-key query-replace-map [return] 'exit)
526 527 528 529 530 531 532
(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)
533 534
(define-key query-replace-map [f1] 'help)
(define-key query-replace-map [help] 'help)
535
(define-key query-replace-map "?" 'help)
536 537
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
538 539
(define-key query-replace-map "\e" 'exit-prefix)
(define-key query-replace-map [escape] 'exit-prefix)
540

Richard M. Stallman's avatar
Richard M. Stallman committed
541 542
(defun perform-replace (from-string replacements
		        query-flag regexp-flag delimited-flag
543
			&optional repeat-count map)
Richard M. Stallman's avatar
Richard M. Stallman committed
544 545 546 547 548
  "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))
549
which will run faster and probably do exactly what you want."
550
  (or map (setq map query-replace-map))
551 552
  (and query-flag minibuffer-auto-raise
       (raise-frame (window-frame (minibuffer-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
553 554 555 556 557 558
  (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
559
	(real-match-data nil)		; the match data for the current match
Richard M. Stallman's avatar
Richard M. Stallman committed
560 561 562 563 564 565
	(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
566
	(lastrepl nil)			;Position after last match considered.
567
	(match-again t)
568 569 570 571
	(message
	 (if query-flag
	     (substitute-command-keys
	      "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) "))))
Richard M. Stallman's avatar
Richard M. Stallman committed
572 573 574 575 576 577 578 579 580 581 582
    (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)
583 584 585 586 587 588 589 590 591 592 593
    (unwind-protect
	;; Loop finding occurrences that perhaps should be replaced.
	(while (and keep-going
		    (not (eobp))
		    (funcall search-function search-string nil t)
		    ;; 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))
594
				 (not match-again)))
595 596 597 598 599 600 601 602
			(if (eobp)
			    nil
			  ;; Don't replace the null string 
			  ;; right after end of previous replacement.
			  (forward-char 1)
			  (funcall search-function search-string nil t))
		      t))

603 604 605 606 607 608 609 610
	  ;; Save the data associated with the real match.
	  ;; For speed, use only integers and reuse the list used last time.
	  (setq real-match-data (match-data t real-match-data))

	  ;; 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)))
611 612 613 614 615 616 617 618 619 620
	  ;; 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
621
		(store-match-data real-match-data)
622 623 624 625 626 627 628
		(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)
629
		(store-match-data real-match-data)
630
		(replace-highlight (match-beginning 0) (match-end 0))
631 632 633 634
		;; 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))
635 636 637 638 639 640 641 642 643 644 645 646
		(setq key (read-event))
		(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
647 648 649 650
				   query-replace-help)))
			 (save-excursion
			   (set-buffer standard-output)
			   (help-mode))))
651 652 653 654
		      ((eq def 'exit)
		       (setq keep-going nil)
		       (setq done t))
		      ((eq def 'backup)
655 656 657 658 659 660 661 662 663 664
		       (if stack
			   (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)))
			 (message "No previous match")
			 (ding 'no-terminate)
			 (sit-for 1)))
665 666
		      ((eq def 'act)
		       (or replaced
667 668 669
			   (progn
			     (replace-match next-replacement nocasify literal)
			     (setq replace-count (1+ replace-count))))
670 671 672
		       (setq done t replaced t))
		      ((eq def 'act-and-exit)
		       (or replaced
673 674 675
			   (progn
			     (replace-match next-replacement nocasify literal)
			     (setq replace-count (1+ replace-count))))
676 677 678 679 680 681
		       (setq keep-going nil)
		       (setq done t replaced t))
		      ((eq def 'act-and-show)
		       (if (not replaced)
			   (progn
			     (replace-match next-replacement nocasify literal)
682
			     (setq replace-count (1+ replace-count))
683 684 685
			     (setq replaced t))))
		      ((eq def 'automatic)
		       (or replaced
686 687 688
			   (progn
			     (replace-match next-replacement nocasify literal)
			     (setq replace-count (1+ replace-count))))
689 690 691 692 693 694 695 696
		       (setq done t query-flag nil replaced t))
		      ((eq def 'skip)
		       (setq done t))
		      ((eq def 'recenter)
		       (recenter nil))
		      ((eq def 'edit)
		       (store-match-data
			(prog1 (match-data)
697 698 699 700 701 702
			  (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))))
703 704 705 706 707 708
		      ((eq def 'delete-and-edit)
		       (delete-region (match-beginning 0) (match-end 0))
		       (store-match-data
			(prog1 (match-data)
			  (save-excursion (recursive-edit))))
		       (setq replaced t))
709 710 711
		      ;; Note: we do not need to treat `exit-prefix'
		      ;; specially here, since we reread
		      ;; any unrecognized character.
712
		      (t
713
		       (setq this-command 'mode-exited)
714 715 716 717 718 719 720 721 722 723
		       (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)
724
				(or replaced (match-data t)))
725
			  stack))))
726 727
	  (setq lastrepl (point)))
      (replace-dehighlight))
728 729 730 731 732
    (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
733

734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
(defvar query-replace-highlight nil
  "*Non-nil means to highlight words during query replacement.")

(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
756
;;; replace.el ends here