replace.el 42.2 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, 2000, 2001
4
;;  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Richard M. Stallman's avatar
Richard M. Stallman committed
6 7 8 9
;; 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
10
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
11 12 13 14 15 16 17 18
;; 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
19 20 21
;; 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
22

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

30 31 32 33
(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
34

35 36
(defvar query-replace-history nil)

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

41 42 43 44 45 46
(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
47 48
  :type 'symbol
  :version "20.3")
49 50 51 52 53 54 55

(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
56 57
  :type 'symbol
  :version "20.3")
58

59
(defun query-replace-read-args (string regexp-flag)
60
  (let (from to)
61 62 63 64
    (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
65 66
				       query-replace-from-history-variable
				       nil t)))
67 68
    (setq to (read-from-minibuffer (format "%s %s with: " string from)
				   nil nil nil
69
				   query-replace-to-history-variable from t))
70 71 72
    (if (and transient-mark-mode mark-active)
	(list from to current-prefix-arg (region-beginning) (region-end))
      (list from to current-prefix-arg nil nil))))
73

74
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
75 76 77 78
  "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.

79 80 81
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.

82 83 84 85
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.

86 87
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
88
are non-nil and FROM-STRING has no uppercase letters.
89 90 91
\(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
92
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
93
only matches surrounded by word boundaries.
94
Fourth and fifth arg START and END specify the region to operate on.
95 96

To customize possible responses, change the \"bindings\" in `query-replace-map'."
97
  (interactive (query-replace-read-args "Query replace" nil))
98
  (perform-replace from-string to-string start end t nil delimited))
99

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

102
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
103 104 105 106
  "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.

107 108 109
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.

110 111 112 113
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
114
Preserves case in each replacement if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
115
are non-nil and REGEXP has no uppercase letters.
116

Richard M. Stallman's avatar
Richard M. Stallman committed
117
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
118
only matches surrounded by word boundaries.
119 120
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
121 122 123
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."
124
  (interactive (query-replace-read-args "Query replace regexp" t))
125
  (perform-replace regexp to-string start end t t delimited))
126
(define-key esc-map [?\C-%] 'query-replace-regexp)
Roland McGrath's avatar
Roland McGrath committed
127

128
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
129 130 131 132 133 134 135 136 137 138
  "Replace some things after point matching REGEXP with the result of TO-EXPR.
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.

TO-EXPR is a Lisp expression evaluated to compute each replacement.  It may
reference `replace-count' to get the number of replacements already made.
If the result of TO-EXPR is not a string, it is converted to one using
`prin1-to-string' with the NOESCAPE argument (which see).

For convenience, when entering TO-EXPR interactively, you can use `\\&' or
139 140
`\0' to stand for whatever matched the whole of REGEXP, and `\N' (where
N is a digit) to stand for whatever matched the Nth `\(...\)' in REGEXP.
141 142 143 144 145 146 147 148 149 150 151
Use `\\#&' or `\\#N' if you want a number instead of a string.

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.

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.

Preserves case in each replacement if `case-replace' and `case-fold-search'
are non-nil and REGEXP has no uppercase letters.
152

153
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
154
only matches that are surrounded by word boundaries.
155
Fourth and fifth arg START and END specify the region to operate on."
156
  (interactive
157 158 159 160
   (let (from to start end)
     (when (and transient-mark-mode mark-active)
       (setq start (region-beginning)
	     end (region-end)))
161 162 163 164 165 166 167 168 169 170 171 172
     (if query-replace-interactive
         (setq from (car regexp-search-ring))
       (setq from (read-from-minibuffer "Query replace regexp: "
                                        nil nil nil
                                        query-replace-from-history-variable
                                        nil t)))
     (setq to (list (read-from-minibuffer
                     (format "Query replace regexp %s with eval: " from)
                     nil nil t query-replace-to-history-variable from t)))
     ;; We make TO a list because replace-match-string-symbols requires one,
     ;; and the user might enter a single token.
     (replace-match-string-symbols to)
173
     (list from (car to) start end current-prefix-arg)))
174
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
175
		   start end t t delimited))
176

177
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
178
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
179 180 181 182 183
The second argument TO-STRINGS contains the replacement strings,
separated by spaces.  Third arg DELIMITED (prefix arg if interactive),
if non-nil, means replace only matches surrounded by word boundaries.
This command works like `query-replace-regexp' except that each
successive replacement uses the next successive replacement string,
Roland McGrath's avatar
Roland McGrath committed
184 185
wrapping around from the last such string to the first.

186 187 188
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
189 190
Non-interactively, TO-STRINGS may be a list of replacement strings.

191 192 193
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
194
A prefix argument N says to use each replacement string N times
195 196
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
197
  (interactive
198 199 200 201
   (let (from to start end)
     (when (and transient-mark-mode mark-active)
       (setq start (region-beginning)
	     end (region-end)))
202 203 204 205
     (setq from (if query-replace-interactive
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
206
					'query-replace-history nil t)))
207 208 209 210
     (setq to (read-from-minibuffer
	       (format "Query replace %s with (space-separated strings): "
		       from)
	       nil nil nil
211
	       'query-replace-history from t))
212
     (list from to start end current-prefix-arg)))
Roland McGrath's avatar
Roland McGrath committed
213 214 215 216 217 218 219 220 221 222 223 224 225
  (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 ""))))
226
    (perform-replace regexp replacements start end t t nil n)))
Roland McGrath's avatar
Roland McGrath committed
227

228
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
229 230 231
  "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.
232 233 234
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

235 236 237
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
238
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
239
only matches surrounded by word boundaries.
240
Fourth and fifth arg START and END specify the region to operate on.
Roland McGrath's avatar
Roland McGrath committed
241

242 243 244 245
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
246 247
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
248 249
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
250 251 252
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.)"
253
  (interactive (query-replace-read-args "Replace string" nil))
254
  (perform-replace from-string to-string start end nil nil delimited))
Roland McGrath's avatar
Roland McGrath committed
255

256
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
257
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
258
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
259
are non-nil and REGEXP has no uppercase letters.
260 261 262 263

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
264
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
Roland McGrath's avatar
Roland McGrath committed
265
only matches surrounded by word boundaries.
266 267
Fourth and fifth arg START and END specify the region to operate on.

Richard M. Stallman's avatar
Richard M. Stallman committed
268 269
In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP,
and `\\=\\N' (where N is a digit) stands for
270
 whatever what matched the Nth `\\(...\\)' in REGEXP.
Roland McGrath's avatar
Roland McGrath committed
271

272 273 274
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
275 276 277
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
278
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
279
which will run faster and will not set the mark or print anything."
280
  (interactive (query-replace-read-args "Replace regexp" t))
281
  (perform-replace regexp to-string start end nil t delimited))
282

283 284 285

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
286

287

288
(defalias 'delete-non-matching-lines 'keep-lines)
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
(defalias 'delete-matching-lines 'flush-lines)
(defalias 'count-matches 'how-many)


(defun keep-lines-read-args (prompt)
  "Read arguments for `keep-lines' and friends.
Prompt for a regexp with PROMPT.

Value is a list (REGEXP START END).

If in Transient Mark node, and the mark is active, START is the
start of the region, and end is a marker for the end of the region.
Otherwise, START is the current point, and END is `point-max-marker'."
  (let ((regexp (read-from-minibuffer prompt nil nil nil
				      'regexp-history nil t))
	start end)
    (if (and transient-mark-mode mark-active)
	(setq start (region-beginning)
	      end (save-excursion (goto-char (region-end)) (point-marker)))
      (setq start (point)
	    end (point-max-marker)))
    (list regexp start end)))


(defun keep-lines (regexp &optional rstart rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
314 315
  "Delete all lines except those containing matches for REGEXP.
A match split across lines preserves all the lines it lies in.
316 317 318
Applies to all lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
319 320 321 322 323 324 325 326 327 328 329
the matching is case-sensitive.

Second and third arg RSTART and REND specify the region to operate on.

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."
  (interactive
   (keep-lines-read-args "Keep lines (containing match for regexp): "))
  (if rstart
      (goto-char (min rstart rend))
    (setq rstart (point) rend (point-max-marker)))
Richard M. Stallman's avatar
Richard M. Stallman committed
330 331
  (save-excursion
    (or (bolp) (forward-line 1))
332 333 334
    (let ((start (point))
	  (case-fold-search  (and case-fold-search
				  (isearch-no-upper-case-p regexp t))))
335
      (while (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
336
	;; Start is first char not preserved by previous match.
337 338
	(if (not (re-search-forward regexp rend 'move))
	    (delete-region start rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
339 340 341 342 343 344
	  (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))))
345 346
	
	(setq start (save-excursion (forward-line 1) (point)))
Richard M. Stallman's avatar
Richard M. Stallman committed
347
	;; If the match was empty, avoid matching again at same place.
348 349
	(and (< (point) rend)
	     (= (match-beginning 0) (match-end 0))
Richard M. Stallman's avatar
Richard M. Stallman committed
350 351
	     (forward-char 1))))))

352 353

(defun flush-lines (regexp &optional rstart rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
354 355
  "Delete lines containing matches for REGEXP.
If a match is split across lines, all the lines it lies in are deleted.
356 357 358
Applies to lines after point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
359 360 361 362 363 364 365 366 367 368 369
the matching is case-sensitive.

Second and third arg RSTART and REND specify the region to operate on.

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."
  (interactive
   (keep-lines-read-args "Flush lines (containing match for regexp): "))
  (if rstart
      (goto-char (min rstart rend))
    (setq rstart (point) rend (point-max-marker)))
370 371 372
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
373 374
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
375 376 377 378
	(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
379

380 381

(defun how-many (regexp &optional rstart rend)
382 383 384
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
the matching is case-sensitive.

Second and third arg RSTART and REND specify the region to operate on.

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."
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
  (if rstart
      (goto-char (min rstart rend))
    (setq rstart (point) rend (point-max-marker)))
  (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
400
    (save-excursion
401
     (while (and (< (point) rend)
Richard M. Stallman's avatar
Richard M. Stallman committed
402
		 (progn (setq opoint (point))
403
			(re-search-forward regexp rend t)))
Richard M. Stallman's avatar
Richard M. Stallman committed
404 405 406 407
       (if (= opoint (point))
	   (forward-char 1)
	 (setq count (1+ count))))
     (message "%d occurrences" count))))
408

409

Richard M. Stallman's avatar
Richard M. Stallman committed
410 411 412 413
(defvar occur-mode-map ())
(if occur-mode-map
    ()
  (setq occur-mode-map (make-sparse-keymap))
414
  (define-key occur-mode-map [mouse-2] 'occur-mode-mouse-goto)
415
  (define-key occur-mode-map "\C-c\C-c" 'occur-mode-goto-occurrence)
416
  (define-key occur-mode-map "\C-m" 'occur-mode-goto-occurrence)
417 418
  (define-key occur-mode-map "\M-n" 'occur-next)
  (define-key occur-mode-map "\M-p" 'occur-prev)
419
  (define-key occur-mode-map "g" 'revert-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
420

421 422 423 424 425 426 427 428

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


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

429 430
(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
431

432 433
(put 'occur-mode 'mode-class 'special)

Richard M. Stallman's avatar
Richard M. Stallman committed
434 435
(defun occur-mode ()
  "Major mode for output from \\[occur].
436 437 438 439
\\<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
440 441 442 443 444
\\{occur-mode-map}"
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
445 446
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'occur-revert-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
447 448
  (make-local-variable 'occur-buffer)
  (make-local-variable 'occur-nlines)
449
  (make-local-variable 'occur-command-arguments)
450
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
451

452
(defun occur-revert-function (ignore1 ignore2)
Dave Love's avatar
Dave Love committed
453
  "Handle revert-buffer for *Occur* buffers."
454 455 456 457 458
  (let ((args occur-command-arguments ))
    (save-excursion
      (set-buffer occur-buffer)
      (apply 'occur args))))

459 460 461 462 463 464 465 466 467 468 469 470 471 472
(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
473 474 475
  (if (or (null occur-buffer)
	  (null (buffer-name occur-buffer)))
      (progn
476
	(setq occur-buffer nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
477
	(error "Buffer in which occurrences were found is deleted")))
478 479 480 481
  (let ((pos (get-text-property (point) 'occur)))
    (if (null pos)
	(error "No occurrence on this line")
      pos)))
482 483 484 485 486

(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
487
    (pop-to-buffer occur-buffer)
488
    (goto-char (marker-position pos))))
489 490 491 492 493 494 495 496 497 498 499 500

(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)
Dave Love's avatar
Dave Love committed
501
	(error "No more matches"))
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
      (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))
Dave Love's avatar
Dave Love committed
519
	(error "No earlier matches"))
520 521
      
      (setq n (1- n)))))
522

523
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
524 525
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
526 527 528
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
529

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

532
(defvar list-matching-lines-face 'bold
Dave Love's avatar
Dave Love committed
533
  "*Face used by \\[list-matching-lines] to show the text that matches.
534 535
If the value is nil, don't highlight the matching portions specially.")

Richard M. Stallman's avatar
Richard M. Stallman committed
536
(defun occur (regexp &optional nlines)
537
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
538 539

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

Roland McGrath's avatar
Roland McGrath committed
541 542 543
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
544 545
Interactively it is the prefix arg.

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

550 551
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
552 553 554 555 556 557 558 559
  (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: ")
560
		  nil nil nil 'regexp-history default t)))
561 562
	   (and (equal input "") default
		(setq input default))
563
	   input)
564
	 current-prefix-arg))
565 566 567 568 569 570
  (let* ((nlines (if nlines
		     (prefix-numeric-value nlines)
		   list-matching-lines-default-context-lines))
	 (current-tab-width tab-width)
	 ;; Minimum width of line number plus trailing colon.
	 (min-line-number-width 6)
571 572 573 574 575 576 577 578
	 ;; Width of line number prefix without the colon.  Choose a
	 ;; width that's a multiple of `tab-width' in the original
	 ;; buffer so that lines in *Occur* appear right.
	 (line-number-width (1- (* (/ (- (+ min-line-number-width
					    tab-width)
					 1)
				      tab-width)
				   tab-width)))
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
	 ;; Format string for line numbers.
	 (line-number-format (format "%%%dd" line-number-width))
	 (empty (make-string line-number-width ?\ ))
	 (first t)
	 ;;flag to prevent printing separator for first match
	 (occur-num-matches 0)
	 (buffer (current-buffer))
	 (dir default-directory)
	 (linenum 1)
	 (prevpos
	  ;;position of most recent match
	  (point-min))
	 (case-fold-search  (and case-fold-search
				 (isearch-no-upper-case-p regexp t)))
	 (final-context-start
	  ;; Marker to the start of context immediately following
	  ;; the matched text in *Occur*.
	  (make-marker)))
597 598 599 600
;;;	(save-excursion
;;;	  (beginning-of-line)
;;;	  (setq linenum (1+ (count-lines (point-min) (point))))
;;;	  (setq prevpos (point)))
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
    (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)
620 621
	    (setq occur-command-arguments
		  (list regexp nlines)))
622
	  (if (eq buffer standard-output)
623
	      (goto-char (point-max)))
624 625
	  (save-excursion
	    ;; Find next match, but give up if prev match was at end of buffer.
626
	    (while (and (not (eobp))
627 628 629 630 631 632 633
			(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))
634 635 636
	      (let* (;;start point of text in source buffer to be put
		     ;;into *Occur*
		     (start (save-excursion
637
			      (goto-char (match-beginning 0))
638 639 640
			      (forward-line (if (< nlines 0)
						nlines
					      (- nlines)))
641
			      (point)))
642 643
		      ;; end point of text in source buffer to be put
		      ;; into *Occur*
644 645 646 647 648 649
		     (end (save-excursion
			    (goto-char (match-end 0))
			    (if (> nlines 0)
				(forward-line (1+ nlines))
			      (forward-line 1))
			    (point)))
650
		      ;; Amount of context before matching text
651
		     (match-beg (- (match-beginning 0) start))
652
		      ;; Length of matching text
653 654
		     (match-len (- (match-end 0) (match-beginning 0)))
		     (tag (format line-number-format linenum))
Dave Love's avatar
Dave Love committed
655
		     tem
656
		     insertion-start
657
		     ;; Number of lines of context to show for current match.
Dave Love's avatar
Dave Love committed
658
		     occur-marker
659 660 661 662 663
		     ;; Marker pointing to end of match in source buffer.
		     (text-beg
		      ;; Marker pointing to start of text for one
		      ;; match in *Occur*.
		      (make-marker))
Dave Love's avatar
Dave Love committed
664
		     (text-end
665 666
		      ;; Marker pointing to end of text for one match
		      ;; in *Occur*.
667
		      (make-marker)))
668
		(save-excursion
669 670
		  (setq occur-marker (make-marker))
		  (set-marker occur-marker (point))
671
		  (set-buffer standard-output)
672
		  (setq occur-num-matches (1+ occur-num-matches))
673 674 675
		  (or first (zerop nlines)
		      (insert "--------\n"))
		  (setq first nil)
676 677 678
		  (save-excursion
		    (set-buffer "*Occur*")
		    (setq tab-width current-tab-width))
679 680 681

		  ;; Insert matching text including context lines from
		  ;; source buffer into *Occur*
682
		  (set-marker text-beg (point))
683
		  (setq insertion-start (point))
684
		  (insert-buffer-substring buffer start end)
685 686 687 688
		  (or (and (/= (+ start match-beg) end)
			   (with-current-buffer buffer
			     (eq (char-before end) ?\n)))
		      (insert "\n"))
Dave Love's avatar
Dave Love committed
689
		  (set-marker final-context-start
690 691 692 693 694 695 696 697
			      (+ (- (point) (- end (match-end 0)))
				 (if (save-excursion
				       (set-buffer buffer)
				       (save-excursion
					 (goto-char (match-end 0))
					 (end-of-line)
					 (bolp)))
				     1 0)))
698
		  (set-marker text-end (point))
699 700
		  
		  ;; Highlight text that was matched.
701 702 703 704 705 706
		  (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))

707 708
		  ;; `occur-point' property is used by occur-next and
		  ;; occur-prev to move between matching lines.
709 710 711 712
		  (put-text-property
		   (+ (marker-position text-beg) match-beg match-len)
		   (+ (marker-position text-beg) match-beg match-len 1)
		   'occur-point t)
713 714 715
		  
		  ;; Now go back to the start of the matching text
		  ;; adding the space and colon to the start of each line.
716
		  (goto-char insertion-start)
717
		  ;; Insert space and colon for lines of context before match.
718 719 720
		  (setq tem (if (< linenum nlines)
				(- nlines linenum)
			      nlines))
721 722 723 724
		  (while (> tem 0)
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1- tem)))
725 726 727 728

		  ;; Insert line number and colon for the lines of
		  ;; matching text.
		  (let ((this-linenum linenum))
729 730
		    (while (< (point) final-context-start)
		      (if (null tag)
731
			  (setq tag (format line-number-format this-linenum)))
732 733 734 735
		      (insert tag ?:)
		      (forward-line 1)
		      (setq tag nil)
		      (setq this-linenum (1+ this-linenum)))
736
		    (while (and (not (eobp)) (<= (point) final-context-start))
737 738 739
		      (insert empty ?:)
		      (forward-line 1)
		      (setq this-linenum (1+ this-linenum))))
740 741

		  ;; Insert space and colon for lines of context after match.
742
		  (while (and (< (point) (point-max)) (< tem nlines))
743 744 745
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1+ tem)))
746 747 748 749 750 751 752 753
		  
		  ;; 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)
754
				     (marker-position text-end)
755
				     'occur occur-marker)
756 757 758
		  (goto-char (point-max)))
		(forward-line 1)))
	    (set-buffer standard-output)
759 760
	    ;; Go back to top of *Occur* and finish off by printing the
	    ;; number of matching lines.
761
	    (goto-char (point-min))
762
	    (let ((message-string
763
		   (if (= occur-num-matches 1)
764
		       "1 line"
765
		     (format "%d lines" occur-num-matches))))
766 767
	      (insert message-string)
	      (if (interactive-p)
Karl Heuer's avatar
Karl Heuer committed
768 769
		  (message "%s matched" message-string)))
	    (setq buffer-read-only t)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
770

771 772
;; 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
773 774
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
775
RET or `q' to exit, Period to replace one match and exit,
Richard M. Stallman's avatar
Richard M. Stallman committed
776 777 778 779 780
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,
781 782
^ to move point back to previous match,
E to edit the replacement string"
Richard M. Stallman's avatar
Richard M. Stallman committed
783 784
  "Help message while in query-replace")

785 786 787 788 789
(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',
790
`automatic', `backup', `exit-prefix', and `help'.")
791 792 793 794

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
795
(define-key query-replace-map [backspace] 'skip)
796 797
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
798 799
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
800
(define-key query-replace-map "e" 'edit-replacement)
801
(define-key query-replace-map "E" 'edit-replacement)
802 803
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "q" 'exit)
804
(define-key query-replace-map "\r" 'exit)
805
(define-key query-replace-map [return] 'exit)
806 807 808 809 810 811 812
(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)
813 814
(define-key query-replace-map [f1] 'help)
(define-key query-replace-map [help] 'help)
815
(define-key query-replace-map "?" 'help)
816 817
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
818 819
(define-key query-replace-map "\e" 'exit-prefix)
(define-key query-replace-map [escape] 'exit-prefix)
820

821
(defun replace-match-string-symbols (n)
Dave Love's avatar
Dave Love committed
822 823 824 825 826 827 828 829 830
  "Process a list (and any sub-lists), expanding certain symbols.
Symbol  Expands To
N     (match-string N)           (where N is a string of digits)
#N    (string-to-number (match-string N))
&     (match-string 0)
#&    (string-to-number (match-string 0))

Note that these symbols must be preceeded by a backslash in order to
type them."
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
  (while n
    (cond
     ((consp (car n))
      (replace-match-string-symbols (car n))) ;Process sub-list
     ((symbolp (car n))
      (let ((name (symbol-name (car n))))
        (cond
         ((string-match "^[0-9]+$" name)
          (setcar n (list 'match-string (string-to-number name))))
         ((string-match "^#[0-9]+$" name)
          (setcar n (list 'string-to-number
                          (list 'match-string
                                (string-to-number (substring name 1))))))
         ((string= "&" name)
          (setcar n '(match-string 0)))
         ((string= "#&" name)
          (setcar n '(string-to-number (match-string 0))))))))
    (setq n (cdr n))))

(defun replace-eval-replacement (expression replace-count)
  (let ((replacement (eval expression)))
    (if (stringp replacement)
        replacement
      (prin1-to-string replacement t))))

(defun replace-loop-through-replacements (data replace-count)
  ;; DATA is a vector contaning the following values:
  ;;   0 next-rotate-count
  ;;   1 repeat-count
  ;;   2 next-replacement
  ;;   3 replacements
  (if (= (aref data 0) replace-count)
      (progn
        (aset data 0 (+ replace-count (aref data 1)))
        (let ((next (cdr (aref data 2))))
          (aset data 2 (if (consp next) next (aref data 3))))))
  (car (aref data 2)))

869
(defun perform-replace (from-string replacements start end
Richard M. Stallman's avatar
Richard M. Stallman committed
870
		        query-flag regexp-flag delimited-flag
871
			&optional repeat-count map)
Richard M. Stallman's avatar
Richard M. Stallman committed
872 873 874 875 876
  "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))
877
which will run faster and probably do exactly what you want."
878
  (or map (setq map query-replace-map))
879 880
  (and query-flag minibuffer-auto-raise
       (raise-frame (window-frame (minibuffer-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
881 882 883
  (let ((nocasify (not (and case-fold-search case-replace
			    (string-equal from-string
					  (downcase from-string)))))
884 885 886
	(case-fold-search (and case-fold-search
			       (string-equal from-string
					     (downcase from-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
887 888 889
	(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
890
	(real-match-data nil)		; the match data for the current match
Richard M. Stallman's avatar
Richard M. Stallman committed
891 892 893 894
	(next-replacement nil)
	(keep-going t)
	(stack nil)
	(replace-count 0)
895 896
	(nonempty-match nil)

897 898 899
	;; If non-nil, it is marker saying where in the buffer to stop.
	(limit nil)

900 901
	;; 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.
902
	(match-again t)
903

904 905 906 907
	(message
	 (if query-flag
	     (substitute-command-keys
	      "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) "))))
908 909

    ;; If region is active, in Transient Mark mode, operate on region.
910 911 912 913
    (when start
      (setq limit (copy-marker (max start end)))
      (goto-char (min start end))
      (deactivate-mark))
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929

    ;; REPLACEMENTS is either a string, a list of strings, or a cons cell
    ;; containing a function and its first argument.  The function is
    ;; called to generate each replacement like this:
    ;;   (funcall (car replacements) (cdr replacements) replace-count)
    ;; It must return a string.
    (cond
     ((stringp replacements)
      (setq next-replacement replacements
            replacements     nil))
     ((stringp (car replacements)) ; If it isn't a string, it must be a cons
      (or repeat-count (setq repeat-count 1))
      (setq replacements (cons 'replace-loop-through-replacements
                               (vector repeat-count repeat-count
                                       replacements replacements)))))

Richard M. Stallman's avatar
Richard M. Stallman committed
930 931 932 933 934 935 936 937
    (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)
938 939 940 941
    (unwind-protect
	;; Loop finding occurrences that perhaps should be replaced.
	(while (and keep-going
		    (not (eobp))
942 943 944 945 946 947 948 949
		    ;; 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
950 951 952 953 954 955 956
				     ;; MATCH-AGAIN non-nil means we
				     ;; accept an adjacent match.  If
				     ;; we don't, move one char to the
				     ;; right.  This takes us a
				     ;; character too far at the end,
				     ;; but this is undone after the
				     ;; while-loop.
957
				     (progn (forward-char 1) (not (eobp))))
958
				 (funcall search-function search-string limit t)
959 960 961 962 963 964 965 966 967
				 ;; 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)))

968 969 970
	  ;; If the match is empty, record that the next one can't be
	  ;; adjacent.

971 972 973
	  ;; 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.
974
	  ;; If that match is empty, don't use it.
975 976 977 978
	  (setq match-again
		(and nonempty-match
		     (or (not regexp-flag)
			 (and (looking-at search-string)
979 980 981
			      (let ((match (match-data)))
				(and (/= (nth 0 match) (nth 1 match))
				     match))))))
982

983 984 985 986 987 988
	  ;; Calculate the replacement string, if necessary.
	  (when replacements
            (set-match-data real-match-data)
            (setq next-replacement
                  (funcall (car replacements) (cdr replacements)
                           replace-count)))
989 990
	  (if (not query-flag)
	      (progn