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

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

128 129 130
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
131 132
Non-interactively, TO-STRINGS may be a list of replacement strings.

133 134 135
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
136 137
A prefix argument N says to use each replacement string N times
before rotating to the next."
138 139
  (interactive
   (let (from to)
140 141 142 143
     (setq from (if query-replace-interactive
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
144
					'query-replace-history nil t)))
145 146 147 148
     (setq to (read-from-minibuffer
	       (format "Query replace %s with (space-separated strings): "
		       from)
	       nil nil nil
149
	       'query-replace-history from t))
150
     (list from to current-prefix-arg)))
Roland McGrath's avatar
Roland McGrath committed
151 152 153 154 155 156 157 158 159 160 161 162 163
  (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 ""))))
164
    (perform-replace regexp replacements t t nil arg)))
Roland McGrath's avatar
Roland McGrath committed
165 166 167 168 169

(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.
170 171 172
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

173 174 175
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
176
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
177 178
only matches surrounded by word boundaries.

179 180 181 182
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
183 184
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
185 186
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
187 188 189
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.)"
190
  (interactive (query-replace-read-args "Replace string" nil))
191
  (perform-replace from-string to-string nil nil delimited))
Roland McGrath's avatar
Roland McGrath committed
192 193 194

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

203 204 205
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.

206 207 208
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
209 210 211
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
212
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
213
which will run faster and will not set the mark or print anything."
214
  (interactive (query-replace-read-args "Replace regexp" t))
215
  (perform-replace regexp to-string nil t delimited))
216 217 218

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
219

220
(defalias 'delete-non-matching-lines 'keep-lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
221 222 223
(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.
224 225 226 227
Applies to all lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
228
  (interactive (list (read-from-minibuffer
229
		      "Keep lines (containing match for regexp): "
230
		      nil nil nil 'regexp-history nil t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
231 232
  (save-excursion
    (or (bolp) (forward-line 1))
233 234 235
    (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
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
      (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))))))

252
(defalias 'delete-matching-lines 'flush-lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
253 254 255
(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.
256 257 258 259
Applies to lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
260
  (interactive (list (read-from-minibuffer
261
		      "Flush lines (containing match for regexp): "
262
		      nil nil nil 'regexp-history nil t)))
263 264 265 266 267 268 269 270 271
  (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
272

273
(defalias 'count-matches 'how-many)
Richard M. Stallman's avatar
Richard M. Stallman committed
274
(defun how-many (regexp)
275 276 277 278
  "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
279 280 281
  (interactive (list (read-from-minibuffer
		      "How many matches for (regexp): "
		      nil nil nil 'regexp-history nil t)))
282 283 284
  (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
285 286 287 288 289 290 291 292
    (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))))
293

Richard M. Stallman's avatar
Richard M. Stallman committed
294 295 296 297
(defvar occur-mode-map ())
(if occur-mode-map
    ()
  (setq occur-mode-map (make-sparse-keymap))
298
  (define-key occur-mode-map [mouse-2] 'occur-mode-mouse-goto)
299
  (define-key occur-mode-map "\C-c\C-c" 'occur-mode-goto-occurrence)
300
  (define-key occur-mode-map "\C-m" 'occur-mode-goto-occurrence)
301 302
  (define-key occur-mode-map "\M-n" 'occur-next)
  (define-key occur-mode-map "\M-p" 'occur-prev)
303
  (define-key occur-mode-map "g" 'revert-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
304

305 306 307 308 309 310 311 312

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


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

313 314
(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
315

316 317
(put 'occur-mode 'mode-class 'special)

Richard M. Stallman's avatar
Richard M. Stallman committed
318 319
(defun occur-mode ()
  "Major mode for output from \\[occur].
320 321 322 323
\\<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
324 325 326 327 328
\\{occur-mode-map}"
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
329 330
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'occur-revert-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
331 332
  (make-local-variable 'occur-buffer)
  (make-local-variable 'occur-nlines)
333
  (make-local-variable 'occur-command-arguments)
334
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
335

336 337 338 339 340 341 342
;; 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))))

343 344 345 346 347 348 349 350 351 352 353 354 355 356
(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
357 358 359
  (if (or (null occur-buffer)
	  (null (buffer-name occur-buffer)))
      (progn
360
	(setq occur-buffer nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
361
	(error "Buffer in which occurrences were found is deleted")))
362 363 364 365
  (let ((pos (get-text-property (point) 'occur)))
    (if (null pos)
	(error "No occurrence on this line")
      pos)))
366 367 368 369 370

(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
371
    (pop-to-buffer occur-buffer)
372
    (goto-char (marker-position pos))))
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405

(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)))))
406

407
(defcustom list-matching-lines-default-context-lines 0
Roland McGrath's avatar
Roland McGrath committed
408
  "*Default number of context lines to include around a `list-matching-lines'
Richard M. Stallman's avatar
Richard M. Stallman committed
409
match.  A negative number means to include that many lines before the match.
410 411 412
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
413

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

416 417 418 419
(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
420
(defun occur (regexp &optional nlines)
421
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
422 423

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

Roland McGrath's avatar
Roland McGrath committed
425 426 427
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
428 429
Interactively it is the prefix arg.

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

434 435
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
436 437 438 439 440 441 442 443
  (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: ")
444
		  nil nil nil 'regexp-history default t)))
445 446
	   (and (equal input "") default
		(setq input default))
447
	   input)
448 449 450 451 452
	 current-prefix-arg))
  (let ((nlines (if nlines
		    (prefix-numeric-value nlines)
		  list-matching-lines-default-context-lines))
	(first t)
453
	;;flag to prevent printing separator for first match
454
	(occur-num-matches 0)
Richard M. Stallman's avatar
Richard M. Stallman committed
455
	(buffer (current-buffer))
456
	(dir default-directory)
Richard M. Stallman's avatar
Richard M. Stallman committed
457
	(linenum 1)
458 459 460
	(prevpos 
	 ;;position of most recent match
	 (point-min))
461 462
	(case-fold-search  (and case-fold-search
				(isearch-no-upper-case-p regexp t)))
463 464 465 466
	(final-context-start
	 ;; Marker to the start of context immediately following
	 ;; the matched text in *Occur*.
	 (make-marker)))
467 468 469 470
;;;	(save-excursion
;;;	  (beginning-of-line)
;;;	  (setq linenum (1+ (count-lines (point-min) (point))))
;;;	  (setq prevpos (point)))
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
    (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)
490 491
	    (setq occur-command-arguments
		  (list regexp nlines)))
492
	  (if (eq buffer standard-output)
493
	      (goto-char (point-max)))
494 495 496 497 498 499 500 501 502 503
	  (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))
504 505 506 507
	      (let* ((start
		      ;;start point of text in source buffer to be put
		      ;;into *Occur*
		      (save-excursion
508
			      (goto-char (match-beginning 0))
509 510 511
			      (forward-line (if (< nlines 0)
						nlines
					      (- nlines)))
512
			      (point)))
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
		     (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)))
528 529
		     (tag (format "%5d" linenum))
		     (empty (make-string (length tag) ?\ ))
530
		     tem		
531
		     insertion-start
532 533 534 535 536 537 538 539 540 541 542
		     ;; 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))
543
		     )
544
		(save-excursion
545 546
		  (setq occur-marker (make-marker))
		  (set-marker occur-marker (point))
547
		  (set-buffer standard-output)
548
		  (setq occur-num-matches (1+ occur-num-matches))
549 550 551
		  (or first (zerop nlines)
		      (insert "--------\n"))
		  (setq first nil)
552 553 554

		  ;; Insert matching text including context lines from
		  ;; source buffer into *Occur*
555
		  (set-marker text-beg (point))
556
		  (setq insertion-start (point))
557
		  (insert-buffer-substring buffer start end)
558 559 560 561 562 563 564 565 566 567 568 569 570
		  (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)))
571
		  (set-marker text-end (point))
572 573
		  
		  ;; Highlight text that was matched.
574 575 576 577 578 579
		  (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))

580 581
		  ;; `occur-point' property is used by occur-next and
		  ;; occur-prev to move between matching lines.
582 583 584 585
		  (put-text-property
		   (+ (marker-position text-beg) match-beg match-len)
		   (+ (marker-position text-beg) match-beg match-len 1)
		   'occur-point t)
586 587 588
		  
		  ;; Now go back to the start of the matching text
		  ;; adding the space and colon to the start of each line.
589
		  (goto-char insertion-start)
590
		  ;; Insert space and colon for lines of context before match.
591 592 593
		  (setq tem (if (< linenum nlines)
				(- nlines linenum)
			      nlines))
594 595 596 597
		  (while (> tem 0)
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1- tem)))
598 599 600 601

		  ;; Insert line number and colon for the lines of
		  ;; matching text.
		  (let ((this-linenum linenum))
602 603 604 605 606 607 608
		    (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)))
609
		    (while (and (not (eobp)) (<= (point) final-context-start))
610 611 612
		      (insert empty ?:)
		      (forward-line 1)
		      (setq this-linenum (1+ this-linenum))))
613 614

		  ;; Insert space and colon for lines of context after match.
615
		  (while (and (< (point) (point-max)) (< tem nlines))
616 617 618
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1+ tem)))
619 620 621 622 623 624 625 626
		  
		  ;; 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)
627
				     (marker-position text-end)
628
				     'occur occur-marker)
629 630 631
		  (goto-char (point-max)))
		(forward-line 1)))
	    (set-buffer standard-output)
632 633
	    ;; Go back to top of *Occur* and finish off by printing the
	    ;; number of matching lines.
634
	    (goto-char (point-min))
635
	    (let ((message-string
636
		   (if (= occur-num-matches 1)
637
		       "1 line"
638
		     (format "%d lines" occur-num-matches))))
639 640
	      (insert message-string)
	      (if (interactive-p)
Karl Heuer's avatar
Karl Heuer committed
641 642
		  (message "%s matched" message-string)))
	    (setq buffer-read-only t)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
643

644 645
;; 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
646 647
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
648
RET or `q' to exit, Period to replace one match and exit,
Richard M. Stallman's avatar
Richard M. Stallman committed
649 650 651 652 653 654 655 656
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")

657 658 659 660 661
(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',
662
`automatic', `backup', `exit-prefix', and `help'.")
663 664 665 666

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
667
(define-key query-replace-map [backspace] 'skip)
668 669
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
670 671
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
672 673
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "q" 'exit)
674
(define-key query-replace-map "\r" 'exit)
675
(define-key query-replace-map [return] 'exit)
676 677 678 679 680 681 682
(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)
683 684
(define-key query-replace-map [f1] 'help)
(define-key query-replace-map [help] 'help)
685
(define-key query-replace-map "?" 'help)
686 687
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
688 689
(define-key query-replace-map "\e" 'exit-prefix)
(define-key query-replace-map [escape] 'exit-prefix)
690

Richard M. Stallman's avatar
Richard M. Stallman committed
691 692
(defun perform-replace (from-string replacements
		        query-flag regexp-flag delimited-flag
693
			&optional repeat-count map)
Richard M. Stallman's avatar
Richard M. Stallman committed
694 695 696 697 698
  "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))
699
which will run faster and probably do exactly what you want."
700
  (or map (setq map query-replace-map))
701 702
  (and query-flag minibuffer-auto-raise
       (raise-frame (window-frame (minibuffer-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
703 704 705
  (let ((nocasify (not (and case-fold-search case-replace
			    (string-equal from-string
					  (downcase from-string)))))
706 707 708
	(case-fold-search (and case-fold-search
			       (string-equal from-string
					     (downcase from-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
709 710 711
	(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
712
	(real-match-data nil)		; the match data for the current match
Richard M. Stallman's avatar
Richard M. Stallman committed
713 714 715 716 717 718
	(next-replacement nil)
	(replacement-index 0)
	(keep-going t)
	(stack nil)
	(next-rotate-count 0)
	(replace-count 0)
719 720
	(nonempty-match nil)

721 722 723
	;; If non-nil, it is marker saying where in the buffer to stop.
	(limit nil)

724 725
	;; 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.
726
	(match-again t)
727

728 729 730 731
	(message
	 (if query-flag
	     (substitute-command-keys
	      "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) "))))
732 733 734 735 736 737 738

    ;; 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)))
Richard M. Stallman's avatar
Richard M. Stallman committed
739 740 741 742 743 744 745 746 747 748 749
    (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)
750 751 752 753
    (unwind-protect
	;; Loop finding occurrences that perhaps should be replaced.
	(while (and keep-going
		    (not (eobp))
754 755 756 757 758 759 760 761 762 763 764
		    ;; 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))))
765
				 (funcall search-function search-string limit t)
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
				 ;; 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)
783
			      (match-data)))))
784

785 786 787 788 789 790 791 792 793 794
	  ;; 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
795
		(set-match-data real-match-data)
796 797 798 799 800 801 802
		(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)
803
		(set-match-data real-match-data)
804
		(replace-highlight (match-beginning 0) (match-end 0))
805 806 807 808
		;; 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))
809
		(setq key (read-event))
810 811
		;; Necessary in case something happens during read-event
		;; that clobbers the match data.
812
		(set-match-data real-match-data)
813 814 815 816 817 818 819 820 821 822 823
		(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
824 825 826 827
				   query-replace-help)))
			 (save-excursion
			   (set-buffer standard-output)
			   (help-mode))))
828 829 830 831
		      ((eq def 'exit)
		       (setq keep-going nil)
		       (setq done t))
		      ((eq def 'backup)
832 833 834 835 836
		       (if stack
			   (let ((elt (car stack)))
			     (goto-char (car elt))
			     (setq replaced (eq t (cdr elt)))
			     (or replaced
837
				 (set-match-data (cdr elt)))
838 839 840 841
			     (setq stack (cdr stack)))
			 (message "No previous match")
			 (ding 'no-terminate)
			 (sit-for 1)))
842 843
		      ((eq def 'act)
		       (or replaced
844 845 846
			   (progn
			     (replace-match next-replacement nocasify literal)
			     (setq replace-count (1+ replace-count))))
847 848 849
		       (setq done t replaced t))
		      ((eq def 'act-and-exit)
		       (or replaced
850 851 852
			   (progn
			     (replace-match next-replacement nocasify literal)
			     (setq replace-count (1+ replace-count))))
853 854 855 856 857 858
		       (setq keep-going nil)
		       (setq done t replaced t))
		      ((eq def 'act-and-show)
		       (if (not replaced)
			   (progn
			     (replace-match next-replacement nocasify literal)
859
			     (setq replace-count (1+ replace-count))
860 861 862
			     (setq replaced t))))
		      ((eq def 'automatic)
		       (or replaced
863 864 865
			   (progn
			     (replace-match next-replacement nocasify literal)
			     (setq replace-count (1+ replace-count))))
866 867 868 869 870 871
		       (setq done t query-flag nil replaced t))
		      ((eq def 'skip)
		       (setq done t))
		      ((eq def 'recenter)
		       (recenter nil))
		      ((eq def 'edit)
872 873 874 875 876 877 878
		       (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))
879
		       (set-match-data real-match-data)
880 881 882
		       ;; Before we make the replacement,
		       ;; decide whether the search string
		       ;; can match again just after this match.
883 884
		       (if (and regexp-flag nonempty-match)
			   (setq match-again (and (looking-at search-string)
885
						  (match-data)))))
886 887
		      ((eq def 'delete-and-edit)
		       (delete-region (match-beginning 0) (match-end 0))
888
		       (set-match-data
889 890 891
			(prog1 (match-data)
			  (save-excursion (recursive-edit))))
		       (setq replaced t))
892 893 894
		      ;; Note: we do not need to treat `exit-prefix'
		      ;; specially here, since we reread
		      ;; any unrecognized character.
895
		      (t
896
		       (setq this-command 'mode-exited)
897 898 899 900 901 902 903 904 905 906
		       (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)
907
				(or replaced (match-data t)))
908
			  stack)))))
909
      (replace-dehighlight))
910 911 912 913 914
    (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
915

916
(defcustom query-replace-highlight t
917 918 919
  "*Non-nil means to highlight words during query replacement."
  :type 'boolean
  :group 'matching)
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939

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