replace.el 32.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, 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.

Richard M. Stallman's avatar
Richard M. Stallman committed
83
Preserves case in each replacement if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
84
are non-nil and FROM-STRING has no uppercase letters.
85 86 87
\(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
88
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
89 90 91
only matches surrounded by word boundaries.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

219
(defalias 'delete-non-matching-lines 'keep-lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
220 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.
Applies to all lines after point."
224
  (interactive (list (read-from-minibuffer
225
		      "Keep lines (containing match for regexp): "
226
		      nil nil nil 'regexp-history nil t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
  (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))))))

246
(defalias 'delete-matching-lines 'flush-lines)
Richard M. Stallman's avatar
Richard M. Stallman committed
247 248 249 250
(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."
251
  (interactive (list (read-from-minibuffer
252
		      "Flush lines (containing match for regexp): "
253
		      nil nil nil 'regexp-history nil t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
254 255 256 257 258 259 260 261
  (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))))))

262
(defalias 'count-matches 'how-many)
Richard M. Stallman's avatar
Richard M. Stallman committed
263 264
(defun how-many (regexp)
  "Print number of matches for REGEXP following point."
Richard M. Stallman's avatar
Richard M. Stallman committed
265 266 267
  (interactive (list (read-from-minibuffer
		      "How many matches for (regexp): "
		      nil nil nil 'regexp-history nil t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
268 269 270 271 272 273 274 275 276
  (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))))
277

Richard M. Stallman's avatar
Richard M. Stallman committed
278 279 280 281
(defvar occur-mode-map ())
(if occur-mode-map
    ()
  (setq occur-mode-map (make-sparse-keymap))
282
  (define-key occur-mode-map [mouse-2] 'occur-mode-mouse-goto)
283
  (define-key occur-mode-map "\C-c\C-c" 'occur-mode-goto-occurrence)
284
  (define-key occur-mode-map "\C-m" 'occur-mode-goto-occurrence)
285 286
  (define-key occur-mode-map "\M-n" 'occur-next)
  (define-key occur-mode-map "\M-p" 'occur-prev)
287
  (define-key occur-mode-map "g" 'revert-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
288

289 290 291 292 293 294 295 296

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


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

297 298
(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
299

300 301
(put 'occur-mode 'mode-class 'special)

Richard M. Stallman's avatar
Richard M. Stallman committed
302 303
(defun occur-mode ()
  "Major mode for output from \\[occur].
304 305 306 307
\\<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
308 309 310 311 312
\\{occur-mode-map}"
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
313 314
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'occur-revert-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
315 316
  (make-local-variable 'occur-buffer)
  (make-local-variable 'occur-nlines)
317
  (make-local-variable 'occur-command-arguments)
318
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
319

320 321 322 323 324 325 326
;; 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))))

327 328 329 330 331 332 333 334 335 336 337 338 339 340
(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
341 342 343
  (if (or (null occur-buffer)
	  (null (buffer-name occur-buffer)))
      (progn
344
	(setq occur-buffer nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
345
	(error "Buffer in which occurrences were found is deleted")))
346 347 348 349
  (let ((pos (get-text-property (point) 'occur)))
    (if (null pos)
	(error "No occurrence on this line")
      pos)))
350 351 352 353 354

(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
355
    (pop-to-buffer occur-buffer)
356
    (goto-char (marker-position pos))))
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389

(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)))))
390

391
(defcustom list-matching-lines-default-context-lines 0
Roland McGrath's avatar
Roland McGrath committed
392
  "*Default number of context lines to include around a `list-matching-lines'
Richard M. Stallman's avatar
Richard M. Stallman committed
393
match.  A negative number means to include that many lines before the match.
394 395 396
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
397

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

400 401 402 403
(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
404
(defun occur (regexp &optional nlines)
405
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
406 407

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

Roland McGrath's avatar
Roland McGrath committed
409 410 411
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
412 413
Interactively it is the prefix arg.

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

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

		  ;; Insert matching text including context lines from
		  ;; source buffer into *Occur*
539
		  (set-marker text-beg (point))
540
		  (setq insertion-start (point))
541
		  (insert-buffer-substring buffer start end)
542 543 544 545 546 547 548 549 550 551 552 553 554
		  (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)))
555
		  (set-marker text-end (point))
556 557
		  
		  ;; Highlight text that was matched.
558 559 560 561 562 563
		  (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))

564 565
		  ;; `occur-point' property is used by occur-next and
		  ;; occur-prev to move between matching lines.
566 567 568 569
		  (put-text-property
		   (+ (marker-position text-beg) match-beg match-len)
		   (+ (marker-position text-beg) match-beg match-len 1)
		   'occur-point t)
570 571 572
		  
		  ;; Now go back to the start of the matching text
		  ;; adding the space and colon to the start of each line.
573
		  (goto-char insertion-start)
574
		  ;; Insert space and colon for lines of context before match.
575 576 577
		  (setq tem (if (< linenum nlines)
				(- nlines linenum)
			      nlines))
578 579 580 581
		  (while (> tem 0)
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1- tem)))
582 583 584 585

		  ;; Insert line number and colon for the lines of
		  ;; matching text.
		  (let ((this-linenum linenum))
586 587 588 589 590 591 592
		    (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)))
593
		    (while (and (not (eobp)) (<= (point) final-context-start))
594 595 596
		      (insert empty ?:)
		      (forward-line 1)
		      (setq this-linenum (1+ this-linenum))))
597 598

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

641 642 643 644 645
(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',
646
`automatic', `backup', `exit-prefix', and `help'.")
647 648 649 650

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
651
(define-key query-replace-map [backspace] 'skip)
652 653
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
654 655
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
656 657
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "q" 'exit)
658
(define-key query-replace-map "\r" 'exit)
659
(define-key query-replace-map [return] 'exit)
660 661 662 663 664 665 666
(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)
667 668
(define-key query-replace-map [f1] 'help)
(define-key query-replace-map [help] 'help)
669
(define-key query-replace-map "?" 'help)
670 671
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
672 673
(define-key query-replace-map "\e" 'exit-prefix)
(define-key query-replace-map [escape] 'exit-prefix)
674

Richard M. Stallman's avatar
Richard M. Stallman committed
675 676
(defun perform-replace (from-string replacements
		        query-flag regexp-flag delimited-flag
677
			&optional repeat-count map)
Richard M. Stallman's avatar
Richard M. Stallman committed
678 679 680 681 682
  "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))
683
which will run faster and probably do exactly what you want."
684
  (or map (setq map query-replace-map))
685 686
  (and query-flag minibuffer-auto-raise
       (raise-frame (window-frame (minibuffer-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
687 688 689 690 691 692
  (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
693
	(real-match-data nil)		; the match data for the current match
Richard M. Stallman's avatar
Richard M. Stallman committed
694 695 696 697 698 699
	(next-replacement nil)
	(replacement-index 0)
	(keep-going t)
	(stack nil)
	(next-rotate-count 0)
	(replace-count 0)
700 701
	(nonempty-match nil)

702 703 704
	;; If non-nil, it is marker saying where in the buffer to stop.
	(limit nil)

705 706
	;; 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.
707
	(match-again t)
708

709 710 711 712
	(message
	 (if query-flag
	     (substitute-command-keys
	      "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) "))))
713 714 715 716 717 718 719

    ;; 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
720 721 722 723 724 725 726 727 728 729 730
    (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)
731 732 733 734
    (unwind-protect
	;; Loop finding occurrences that perhaps should be replaced.
	(while (and keep-going
		    (not (eobp))
735 736 737 738 739 740 741 742 743 744 745
		    ;; 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))))
746
				 (funcall search-function search-string limit t)
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
				 ;; 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)
764
			      (match-data)))))
765

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

897
(defcustom query-replace-highlight t
898 899 900
  "*Non-nil means to highlight words during query replacement."
  :type 'boolean
  :group 'matching)
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920

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