replace.el 43.9 KB
Newer Older
1
;;; replace.el --- replace commands for Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

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
(defcustom case-replace t
31
  "*Non-nil means `query-replace' should preserve case in replacements."
32 33
  :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
(defcustom query-replace-from-history-variable 'query-replace-history
42
  "History list to use for the FROM argument of `query-replace' commands.
43 44 45 46
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

(defcustom query-replace-to-history-variable 'query-replace-history
51
  "History list to use for the TO argument of `query-replace' commands.
52 53 54 55
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 60 61 62 63 64
(defcustom query-replace-skip-read-only nil
  "*Non-nil means `query-replace' and friends ignore read-only matches."
  :type 'boolean
  :group 'matching
  :version "21.3")

65
(defun query-replace-read-args (string regexp-flag)
66
  (barf-if-buffer-read-only)
67
  (let (from to)
68 69 70 71
    (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
72
				       query-replace-from-history-variable
73 74 75 76 77 78 79 80 81 82 83
				       nil t))
      ;; Warn if user types \n or \t, but don't reject the input.
      (if (string-match "\\\\[nt]" from)
	  (let ((match (match-string 0 from)))
	    (cond
	     ((string= match "\\n")
	      (message "Note: `\\n' here doesn't match a newline; to do that, type C-q C-j instead"))
	     ((string= match "\\t")
	      (message "Note: `\\t' here doesn't match a tab; to do that, just type TAB")))
	    (sit-for 2))))

84 85
    (setq to (read-from-minibuffer (format "%s %s with: " string from)
				   nil nil nil
86
				   query-replace-to-history-variable from t))
87 88 89
    (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))))
90

91
(defun query-replace (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
92 93 94 95
  "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.

96 97 98
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.

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

103 104
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
105
are non-nil and FROM-STRING has no uppercase letters.
106 107 108
\(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
109
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
110
only matches surrounded by word boundaries.
111
Fourth and fifth arg START and END specify the region to operate on.
112 113

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

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

119
(defun query-replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
120 121 122 123
  "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.

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.

127 128 129 130
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
131
Preserves case in each replacement if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
132
are non-nil and REGEXP has no uppercase letters.
133

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

Richard M. Stallman's avatar
Richard M. Stallman committed
138 139 140
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."
141
  (interactive (query-replace-read-args "Query replace regexp" t))
142
  (perform-replace regexp to-string t t delimited nil nil start end))
143
(define-key esc-map [?\C-%] 'query-replace-regexp)
Roland McGrath's avatar
Roland McGrath committed
144

145
(defun query-replace-regexp-eval (regexp to-expr &optional delimited start end)
146 147 148 149 150 151 152 153 154 155
  "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
156 157
`\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.
158 159 160 161 162 163 164 165 166 167 168
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.
169

170
Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace
171
only matches that are surrounded by word boundaries.
172
Fourth and fifth arg START and END specify the region to operate on."
173
  (interactive
174 175 176 177
   (let (from to start end)
     (when (and transient-mark-mode mark-active)
       (setq start (region-beginning)
	     end (region-end)))
178 179 180 181 182 183 184 185 186 187 188 189
     (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)
190
     (list from (car to) current-prefix-arg start end)))
191
  (perform-replace regexp (cons 'replace-eval-replacement to-expr)
192
		   t t delimited nil nil start end))
193

194
(defun map-query-replace-regexp (regexp to-strings &optional n start end)
Roland McGrath's avatar
Roland McGrath committed
195
  "Replace some matches for REGEXP with various strings, in rotation.
Dave Love's avatar
Dave Love committed
196 197 198 199 200
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
201 202
wrapping around from the last such string to the first.

203 204 205
In Transient Mark mode, if the mark is active, operate on the contents
of the region.  Otherwise, operate from point to the end of the buffer.

Roland McGrath's avatar
Roland McGrath committed
206 207
Non-interactively, TO-STRINGS may be a list of replacement strings.

208 209 210
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
211
A prefix argument N says to use each replacement string N times
212 213
before rotating to the next.
Fourth and fifth arg START and END specify the region to operate on."
214
  (interactive
215 216 217 218
   (let (from to start end)
     (when (and transient-mark-mode mark-active)
       (setq start (region-beginning)
	     end (region-end)))
219 220 221 222
     (setq from (if query-replace-interactive
		    (car regexp-search-ring)
		  (read-from-minibuffer "Map query replace (regexp): "
					nil nil nil
223
					'query-replace-history nil t)))
224 225 226 227
     (setq to (read-from-minibuffer
	       (format "Query replace %s with (space-separated strings): "
		       from)
	       nil nil nil
228
	       'query-replace-history from t))
229
     (list from to start end current-prefix-arg)))
Roland McGrath's avatar
Roland McGrath committed
230 231 232 233 234 235 236 237 238 239 240 241 242
  (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 ""))))
243
    (perform-replace regexp replacements t t nil n nil start end)))
Roland McGrath's avatar
Roland McGrath committed
244

245
(defun replace-string (from-string to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
246 247 248
  "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.
249 250 251
\(Preserving case means that if the string matched is all caps, or capitalized,
then its replacement is upcased or capitalized.)

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

259 260 261 262
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
263 264
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
265 266
  (while (search-forward FROM-STRING nil t)
    (replace-match TO-STRING nil t))
267 268 269
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.)"
270
  (interactive (query-replace-read-args "Replace string" nil))
271
  (perform-replace from-string to-string nil nil delimited nil nil start end))
Roland McGrath's avatar
Roland McGrath committed
272

273
(defun replace-regexp (regexp to-string &optional delimited start end)
Roland McGrath's avatar
Roland McGrath committed
274
  "Replace things after point matching REGEXP with TO-STRING.
Richard M. Stallman's avatar
Richard M. Stallman committed
275
Preserve case in each match if `case-replace' and `case-fold-search'
Roland McGrath's avatar
Roland McGrath committed
276
are non-nil and REGEXP has no uppercase letters.
277 278 279 280

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

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

289 290 291
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
292 293 294
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
295
    (replace-match TO-STRING nil nil))
Roland McGrath's avatar
Roland McGrath committed
296
which will run faster and will not set the mark or print anything."
297
  (interactive (query-replace-read-args "Replace regexp" t))
298
  (perform-replace regexp to-string nil t delimited nil nil start end))
299

300 301 302

(defvar regexp-history nil
  "History list for some commands that read regular expressions.")
Roland McGrath's avatar
Roland McGrath committed
303

304

305
(defalias 'delete-non-matching-lines 'keep-lines)
306 307 308 309 310 311 312
(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.
313 314 315
Value is a list, (REGEXP)."
  (list (read-from-minibuffer prompt nil nil nil
			      'regexp-history nil t)))
316 317

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
323 324 325 326
the matching is case-sensitive.

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

327 328 329 330
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
end of the buffer."

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

363 364

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

If REGEXP contains upper case characters (excluding those preceded by `\\'),
370 371 372 373
the matching is case-sensitive.

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

374 375 376 377
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
end of the buffer."

378 379 380 381
  (interactive
   (keep-lines-read-args "Flush lines (containing match for regexp): "))
  (if rstart
      (goto-char (min rstart rend))
382 383 384 385 386 387
    (if (and transient-mark-mode mark-active)
	(setq rstart (region-beginning)
	      rend (copy-marker (region-end)))
      (setq rstart (point)
	    rend (point-max-marker)))
    (goto-char rstart))
388 389 390
  (let ((case-fold-search (and case-fold-search
			       (isearch-no-upper-case-p regexp t))))
    (save-excursion
391 392
      (while (and (< (point) rend)
		  (re-search-forward regexp rend t))
393 394 395 396
	(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
397

398 399

(defun how-many (regexp &optional rstart rend)
400 401 402
  "Print number of matches for REGEXP following point.

If REGEXP contains upper case characters (excluding those preceded by `\\'),
403 404 405 406
the matching is case-sensitive.

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

407 408 409 410
Interactively, in Transient Mark mode when the mark is active, operate
on the contents of the region.  Otherwise, operate from point to the
end of the buffer."

411 412
  (interactive
   (keep-lines-read-args "How many matches for (regexp): "))
413 414 415
  (save-excursion
    (if rstart
	(goto-char (min rstart rend))
416 417 418 419 420 421
      (if (and transient-mark-mode mark-active)
	  (setq rstart (region-beginning)
		rend (copy-marker (region-end)))
	(setq rstart (point)
	      rend (point-max-marker)))
      (goto-char rstart))
422 423 424 425 426 427 428 429 430 431 432
    (let ((count 0)
	  opoint
	  (case-fold-search (and case-fold-search
				 (isearch-no-upper-case-p regexp t))))
      (while (and (< (point) rend)
		  (progn (setq opoint (point))
			 (re-search-forward regexp rend t)))
	(if (= opoint (point))
	    (forward-char 1)
	  (setq count (1+ count))))
      (message "%d occurrences" count))))
433

434

435 436 437 438 439
(defvar occur-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map [mouse-2] 'occur-mode-mouse-goto)
    (define-key map "\C-c\C-c" 'occur-mode-goto-occurrence)
    (define-key map "\C-m" 'occur-mode-goto-occurrence)
440
    (define-key map "\o" 'occur-mode-goto-occurrence-other-window)
441
    (define-key map "\C-o" 'occur-mode-display-occurrence)
442 443 444 445 446
    (define-key map "\M-n" 'occur-next)
    (define-key map "\M-p" 'occur-prev)
    (define-key map "g" 'revert-buffer)
    map)
  "Keymap for `occur-mode'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
447

448 449 450 451 452 453 454 455

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


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

456 457
(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
458

459 460
(put 'occur-mode 'mode-class 'special)

461
(defun occur-mode ()
Richard M. Stallman's avatar
Richard M. Stallman committed
462
  "Major mode for output from \\[occur].
463 464 465 466
\\<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
467
\\{occur-mode-map}"
468 469 470 471 472 473
  (kill-all-local-variables)
  (use-local-map occur-mode-map)
  (setq major-mode 'occur-mode)
  (setq mode-name "Occur")
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'occur-revert-function)
474
  (set (make-local-variable 'revert-buffer-function) 'occur-revert-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
475 476
  (make-local-variable 'occur-buffer)
  (make-local-variable 'occur-nlines)
477 478
  (make-local-variable 'occur-command-arguments)
  (run-hooks 'occur-mode-hook))
Richard M. Stallman's avatar
Richard M. Stallman committed
479

480
(defun occur-revert-function (ignore1 ignore2)
481
  "Handle `revert-buffer' for *Occur* buffers."
482 483 484 485 486
  (let ((args occur-command-arguments ))
    (save-excursion
      (set-buffer occur-buffer)
      (apply 'occur args))))

487 488 489 490 491 492 493 494 495 496 497 498 499 500
(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
501 502 503
  (if (or (null occur-buffer)
	  (null (buffer-name occur-buffer)))
      (progn
504
	(setq occur-buffer nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
505
	(error "Buffer in which occurrences were found is deleted")))
506 507 508 509
  (let ((pos (get-text-property (point) 'occur)))
    (if (null pos)
	(error "No occurrence on this line")
      pos)))
510 511 512 513 514

(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
515
    (pop-to-buffer occur-buffer)
516
    (goto-char (marker-position pos))))
517

518 519 520 521 522 523 524
(defun occur-mode-goto-occurrence-other-window ()
  "Go to the occurrence the current line describes, in another window."
  (interactive)
  (let ((pos (occur-mode-find-occurrence)))
    (switch-to-buffer-other-window occur-buffer)
    (goto-char (marker-position pos))))

525 526 527 528 529 530 531 532 533 534 535 536 537
(defun occur-mode-display-occurrence ()
  "Display in another window the occurrence the current line describes."
  (interactive)
  (let ((pos (occur-mode-find-occurrence))
	same-window-buffer-names
	same-window-regexps
	window)
    (setq window (display-buffer occur-buffer))
    ;; This is the way to set point in the proper window.
    (save-selected-window
      (select-window window)
      (goto-char (marker-position pos)))))

538 539 540 541 542 543 544 545 546 547 548
(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
549
	(error "No more matches"))
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
      (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
567
	(error "No earlier matches"))
568 569
      
      (setq n (1- n)))))
570

571
(defcustom list-matching-lines-default-context-lines 0
Dave Love's avatar
Dave Love committed
572 573
  "*Default number of context lines included around `list-matching-lines' matches.
A negative number means to include that many lines before the match.
574 575 576
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
577

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
584
(defun occur (regexp &optional nlines)
585
  "Show all lines in the current buffer containing a match for REGEXP.
Roland McGrath's avatar
Roland McGrath committed
586 587

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

Roland McGrath's avatar
Roland McGrath committed
589 590 591
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
592 593
Interactively it is the prefix arg.

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

598 599
If REGEXP contains upper case characters (excluding those preceded by `\\'),
the matching is case-sensitive."
600 601 602 603 604 605 606 607
  (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: ")
608
		  nil nil nil 'regexp-history default t)))
609 610
	   (and (equal input "") default
		(setq input default))
611
	   input)
612
	 current-prefix-arg))
613 614 615 616
  (let* ((nlines (if nlines
		     (prefix-numeric-value nlines)
		   list-matching-lines-default-context-lines))
	 (current-tab-width tab-width)
617
	 (inhibit-read-only t)
618 619
	 ;; Minimum width of line number plus trailing colon.
	 (min-line-number-width 6)
620 621 622 623 624 625 626 627
	 ;; 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)))
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
	 ;; 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)))
646 647 648 649
;;;	(save-excursion
;;;	  (beginning-of-line)
;;;	  (setq linenum (1+ (count-lines (point-min) (point))))
;;;	  (setq prevpos (point)))
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
    (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)
669 670
	    (setq occur-command-arguments
		  (list regexp nlines)))
671
	  (if (eq buffer standard-output)
672
	      (goto-char (point-max)))
673 674
	  (save-excursion
	    ;; Find next match, but give up if prev match was at end of buffer.
675
	    (while (and (not (eobp))
676 677 678 679 680 681 682
			(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))
683 684 685
	      (let* (;;start point of text in source buffer to be put
		     ;;into *Occur*
		     (start (save-excursion
686
			      (goto-char (match-beginning 0))
687 688 689
			      (forward-line (if (< nlines 0)
						nlines
					      (- nlines)))
690
			      (point)))
691 692
		      ;; end point of text in source buffer to be put
		      ;; into *Occur*
693 694 695 696 697 698
		     (end (save-excursion
			    (goto-char (match-end 0))
			    (if (> nlines 0)
				(forward-line (1+ nlines))
			      (forward-line 1))
			    (point)))
699
		      ;; Amount of context before matching text
700
		     (match-beg (- (match-beginning 0) start))
701
		      ;; Length of matching text
702 703
		     (match-len (- (match-end 0) (match-beginning 0)))
		     (tag (format line-number-format linenum))
Dave Love's avatar
Dave Love committed
704
		     tem
705
		     insertion-start
706
		     ;; Number of lines of context to show for current match.
Dave Love's avatar
Dave Love committed
707
		     occur-marker
708 709 710 711 712
		     ;; 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
713
		     (text-end
714 715
		      ;; Marker pointing to end of text for one match
		      ;; in *Occur*.
716
		      (make-marker)))
717
		(save-excursion
718 719
		  (setq occur-marker (make-marker))
		  (set-marker occur-marker (point))
720
		  (set-buffer standard-output)
721
		  (setq occur-num-matches (1+ occur-num-matches))
722 723 724
		  (or first (zerop nlines)
		      (insert "--------\n"))
		  (setq first nil)
725 726 727
		  (save-excursion
		    (set-buffer "*Occur*")
		    (setq tab-width current-tab-width))
728 729 730

		  ;; Insert matching text including context lines from
		  ;; source buffer into *Occur*
731
		  (set-marker text-beg (point))
732
		  (setq insertion-start (point))
733
		  (insert-buffer-substring buffer start end)
734 735 736 737
		  (or (and (/= (+ start match-beg) end)
			   (with-current-buffer buffer
			     (eq (char-before end) ?\n)))
		      (insert "\n"))
Dave Love's avatar
Dave Love committed
738
		  (set-marker final-context-start
739 740 741 742 743 744 745 746
			      (+ (- (point) (- end (match-end 0)))
				 (if (save-excursion
				       (set-buffer buffer)
				       (save-excursion
					 (goto-char (match-end 0))
					 (end-of-line)
					 (bolp)))
				     1 0)))
747
		  (set-marker text-end (point))
748 749
		  
		  ;; Highlight text that was matched.
750 751 752 753 754 755
		  (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))

756 757
		  ;; `occur-point' property is used by occur-next and
		  ;; occur-prev to move between matching lines.
758 759 760 761
		  (put-text-property
		   (+ (marker-position text-beg) match-beg match-len)
		   (+ (marker-position text-beg) match-beg match-len 1)
		   'occur-point t)
762 763 764
		  
		  ;; Now go back to the start of the matching text
		  ;; adding the space and colon to the start of each line.
765
		  (goto-char insertion-start)
766
		  ;; Insert space and colon for lines of context before match.
767 768 769
		  (setq tem (if (< linenum nlines)
				(- nlines linenum)
			      nlines))
770 771 772 773
		  (while (> tem 0)
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1- tem)))
774 775 776 777

		  ;; Insert line number and colon for the lines of
		  ;; matching text.
		  (let ((this-linenum linenum))
778 779
		    (while (< (point) final-context-start)
		      (if (null tag)
780
			  (setq tag (format line-number-format this-linenum)))
781 782 783 784
		      (insert tag ?:)
		      (forward-line 1)
		      (setq tag nil)
		      (setq this-linenum (1+ this-linenum)))
785
		    (while (and (not (eobp)) (<= (point) final-context-start))
786 787 788
		      (insert empty ?:)
		      (forward-line 1)
		      (setq this-linenum (1+ this-linenum))))
789 790

		  ;; Insert space and colon for lines of context after match.
791
		  (while (and (< (point) (point-max)) (< tem nlines))
792 793 794
		    (insert empty ?:)
		    (forward-line 1)
		    (setq tem (1+ tem)))
795 796 797 798
		  
		  ;; Add text properties.  The `occur' prop is used to
		  ;; store the marker of the matching text in the
		  ;; source buffer.
799 800 801
		  (add-text-properties
		   (marker-position text-beg) (- (marker-position text-end) 1)
		   '(mouse-face highlight
802
		     help-echo "mouse-2: go to this occurrence"))
803
		  (put-text-property (marker-position text-beg)
804
				     (marker-position text-end)
805
				     'occur occur-marker)
806 807 808
		  (goto-char (point-max)))
		(forward-line 1)))
	    (set-buffer standard-output)
809 810
	    ;; Go back to top of *Occur* and finish off by printing the
	    ;; number of matching lines.
811
	    (goto-char (point-min))
812
	    (let ((message-string
813
		   (if (= occur-num-matches 1)
814
		       "1 line"
815
		     (format "%d lines" occur-num-matches))))
816 817
	      (insert message-string)
	      (if (interactive-p)
Karl Heuer's avatar
Karl Heuer committed
818 819
		  (message "%s matched" message-string)))
	    (setq buffer-read-only t)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
820

821 822
;; 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
823 824
(defconst query-replace-help
  "Type Space or `y' to replace one match, Delete or `n' to skip to next,
825
RET or `q' to exit, Period to replace one match and exit,
Richard M. Stallman's avatar
Richard M. Stallman committed
826 827 828 829 830
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,
831 832
^ to move point back to previous match,
E to edit the replacement string"
833
  "Help message while in `query-replace'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
834

835 836 837 838 839
(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',
840
`automatic', `backup', `exit-prefix', and `help'.")
841 842 843 844

(define-key query-replace-map " " 'act)
(define-key query-replace-map "\d" 'skip)
(define-key query-replace-map [delete] 'skip)
845
(define-key query-replace-map [backspace] 'skip)
846 847
(define-key query-replace-map "y" 'act)
(define-key query-replace-map "n" 'skip)
848 849
(define-key query-replace-map "Y" 'act)
(define-key query-replace-map "N" 'skip)
850
(define-key query-replace-map "e" 'edit-replacement)
851
(define-key query-replace-map "E" 'edit-replacement)
852 853
(define-key query-replace-map "," 'act-and-show)
(define-key query-replace-map "q" 'exit)
854
(define-key query-replace-map "\r" 'exit)
855
(define-key query-replace-map [return] 'exit)
856 857 858 859 860 861 862
(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)
863 864
(define-key query-replace-map [f1] 'help)
(define-key query-replace-map [help] 'help)
865
(define-key query-replace-map "?" 'help)
866 867
(define-key query-replace-map "\C-g" 'quit)
(define-key query-replace-map "\C-]" 'quit)
868 869
(define-key query-replace-map "\e" 'exit-prefix)
(define-key query-replace-map [escape] 'exit-prefix)
870

871
(defun replace-match-string-symbols (n)
Dave Love's avatar
Dave Love committed
872 873 874 875 876 877 878 879 880
  "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."
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
  (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)))

919
(defun perform-replace (from-string replacements 
Richard M. Stallman's avatar
Richard M. Stallman committed
920
		        query-flag regexp-flag delimited-flag
921
			&optional repeat-count map start end)
Richard M. Stallman's avatar
Richard M. Stallman committed
922 923 924
  "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:
Gerd Moellmann's avatar
Gerd Moellmann committed
925 926

  (while (re-search-forward \"foo[ \\t]+bar\" nil t)
Richard M. Stallman's avatar
Richard M. Stallman committed
927
    (replace-match \"foobar\" nil nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
928 929 930 931

which will run faster and probably do exactly what you want.  Please
see the documentation of `replace-match' to find out how to simulate
`case-replace'."
932
  (or map (setq map query-replace-map))
933 934
  (and query-flag minibuffer-auto-raise
       (raise-frame (window-frame (minibuffer-window))))
Richard M. Stallman's avatar
Richard M. Stallman committed
935 936 937
  (let ((nocasify (not (and case-fold-search case-replace
			    (string-equal from-string
					  (downcase from-string)))))
938 939 940
	(case-fold-search (and case-fold-search
			       (string-equal from-string
					     (downcase from-string))))
Richard M. Stallman's avatar
Richard M. Stallman committed
941 942 943
	(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
944
	(real-match-data nil)		; the match data for the current match
Richard M. Stallman's avatar
Richard M. Stallman committed
945 946 947 948
	(next-replacement nil)
	(keep-going t)
	(stack nil)
	(replace-count 0)
949 950
	(nonempty-match nil)

951 952 953
	;; If non-nil, it is marker saying where in the buffer to stop.
	(limit nil)

954 955
	;; 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.
956
	(match-again t)
957

958 959 960 </