replace.el 32.7 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 46 47 48 49 50 51 52 53 54 55
(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
  :type 'symbol)

(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
  :type 'symbol)

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

Roland McGrath's avatar
Roland McGrath committed
69 70 71 72 73
(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.

74 75 76
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.

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

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

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

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

100 101 102
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.

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

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

124 125 126
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
127 128
Non-interactively, TO-STRINGS may be a list of replacement strings.

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

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

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

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

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

199 200 201
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.

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

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

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

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

286 287 288 289 290 291 292 293

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


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

294 295
(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
296

297 298
(put 'occur-mode 'mode-class 'special)

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

317 318 319 320 321 322 323
;; 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))))

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

(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
352
    (pop-to-buffer occur-buffer)
353
    (goto-char (marker-position pos))))
354 355 356 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

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

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

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

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

Roland McGrath's avatar
Roland McGrath committed
406 407 408
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
409 410
Interactively it is the prefix arg.

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

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

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

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

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

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

637 638 639 640 641
(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',
642
`automatic', `backup', `exit-prefix', and `help'.")
643 644 645 646

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

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

698 699 700
	;; If non-nil, it is marker saying where in the buffer to stop.
	(limit nil)

701 702
	;; 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.
703
	(match-again t)
704

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

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

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

890
(defcustom query-replace-highlight t
891 892 893
  "*Non-nil means to highlight words during query replacement."
  :type 'boolean
  :group 'matching)
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913

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