1 ;;; replace.el --- replace commands for Emacs.
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1994 Free Software Foundation, Inc.
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to
19 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 ;; This package supplies the string and regular-expression replace functions
24 ;; documented in the Emacs user's manual.
28 (defconst case-replace t
"\
29 *Non-nil means query-replace should preserve case in replacements.")
31 (defvar query-replace-history nil
)
33 (defun query-replace-read-args (string)
35 (setq from
(read-from-minibuffer (format "%s: " string
)
37 'query-replace-history
))
38 (setq to
(read-from-minibuffer (format "%s %s with: " string from
)
40 'query-replace-history
))
41 (list from to current-prefix-arg
)))
43 (defun query-replace (from-string to-string
&optional arg
)
44 "Replace some occurrences of FROM-STRING with TO-STRING.
45 As each match is found, the user must type a character saying
46 what to do with it. For directions, type \\[help-command] at that time.
48 Preserves case in each replacement if case-replace and case-fold-search
49 are non-nil and FROM-STRING has no uppercase letters.
50 Third arg DELIMITED (prefix arg if interactive) non-nil means replace
51 only matches surrounded by word boundaries.
53 To customize possible responses, change the \"bindings\" in `query-replace-map'."
54 (interactive (query-replace-read-args "Query replace"))
55 (perform-replace from-string to-string t nil arg
)
56 (or unread-command-events
(message "Done")))
57 (define-key esc-map
"%" 'query-replace
)
59 (defun query-replace-regexp (regexp to-string
&optional arg
)
60 "Replace some things after point matching REGEXP with TO-STRING.
61 As each match is found, the user must type a character saying
62 what to do with it. For directions, type \\[help-command] at that time.
64 Preserves case in each replacement if case-replace and case-fold-search
65 are non-nil and REGEXP has no uppercase letters.
66 Third arg DELIMITED (prefix arg if interactive) non-nil means replace
67 only matches surrounded by word boundaries.
68 In TO-STRING, \\& means insert what matched REGEXP,
69 and \\=\\<n> means insert what matched <n>th \\(...\\) in REGEXP."
70 (interactive (query-replace-read-args "Query replace regexp"))
71 (perform-replace regexp to-string t t arg
)
72 (or unread-command-events
(message "Done")))
74 (defun map-query-replace-regexp (regexp to-strings
&optional arg
)
75 "Replace some matches for REGEXP with various strings, in rotation.
76 The second argument TO-STRINGS contains the replacement strings, separated
77 by spaces. This command works like `query-replace-regexp' except
78 that each successive replacement uses the next successive replacement string,
79 wrapping around from the last such string to the first.
81 Non-interactively, TO-STRINGS may be a list of replacement strings.
83 A prefix argument N says to use each replacement string N times
84 before rotating to the next."
87 (setq from
(read-from-minibuffer "Map query replace (regexp): "
89 'query-replace-history
))
90 (setq to
(read-from-minibuffer
91 (format "Query replace %s with (space-separated strings): "
94 'query-replace-history
))
95 (list from to current-prefix-arg
)))
97 (if (listp to-strings
)
98 (setq replacements to-strings
)
99 (while (/= (length to-strings
) 0)
100 (if (string-match " " to-strings
)
103 (list (substring to-strings
0
104 (string-match " " to-strings
))))
105 to-strings
(substring to-strings
106 (1+ (string-match " " to-strings
))))
107 (setq replacements
(append replacements
(list to-strings
))
109 (perform-replace regexp replacements t t nil arg
))
110 (or unread-command-events
(message "Done")))
112 (defun replace-string (from-string to-string
&optional delimited
)
113 "Replace occurrences of FROM-STRING with TO-STRING.
114 Preserve case in each match if `case-replace' and `case-fold-search'
115 are non-nil and FROM-STRING has no uppercase letters.
116 Third arg DELIMITED (prefix arg if interactive) non-nil means replace
117 only matches surrounded by word boundaries.
119 This function is usually the wrong thing to use in a Lisp program.
120 What you probably want is a loop like this:
121 (while (search-forward OLD-STRING nil t)
122 (replace-match REPLACEMENT nil t))
123 which will run faster and will not set the mark or print anything."
124 (interactive (query-replace-read-args "Replace string"))
125 (perform-replace from-string to-string nil nil delimited
)
126 (or unread-command-events
(message "Done")))
128 (defun replace-regexp (regexp to-string
&optional delimited
)
129 "Replace things after point matching REGEXP with TO-STRING.
130 Preserve case in each match if case-replace and case-fold-search
131 are non-nil and REGEXP has no uppercase letters.
132 Third arg DELIMITED (prefix arg if interactive) non-nil means replace
133 only matches surrounded by word boundaries.
134 In TO-STRING, \\& means insert what matched REGEXP,
135 and \\=\\<n> means insert what matched <n>th \\(...\\) in REGEXP.
137 This function is usually the wrong thing to use in a Lisp program.
138 What you probably want is a loop like this:
139 (while (re-search-forward REGEXP nil t)
140 (replace-match REPLACEMENT nil nil))
141 which will run faster and will not set the mark or print anything."
142 (interactive (query-replace-read-args "Replace regexp"))
143 (perform-replace regexp to-string nil t delimited
)
144 (or unread-command-events
(message "Done")))
146 (defvar regexp-history nil
147 "History list for some commands that read regular expressions.")
149 (defalias 'delete-non-matching-lines
'keep-lines
)
150 (defun keep-lines (regexp)
151 "Delete all lines except those containing matches for REGEXP.
152 A match split across lines preserves all the lines it lies in.
153 Applies to all lines after point."
154 (interactive (list (read-from-minibuffer
155 "Keep lines (containing match for regexp): "
156 nil nil nil
'regexp-history
)))
158 (or (bolp) (forward-line 1))
159 (let ((start (point)))
161 ;; Start is first char not preserved by previous match.
162 (if (not (re-search-forward regexp nil
'move
))
163 (delete-region start
(point-max))
164 (let ((end (save-excursion (goto-char (match-beginning 0))
167 ;; Now end is first char preserved by the new match.
169 (delete-region start end
))))
170 (setq start
(save-excursion (forward-line 1)
172 ;; If the match was empty, avoid matching again at same place.
173 (and (not (eobp)) (= (match-beginning 0) (match-end 0))
174 (forward-char 1))))))
176 (defalias 'delete-matching-lines
'flush-lines
)
177 (defun flush-lines (regexp)
178 "Delete lines containing matches for REGEXP.
179 If a match is split across lines, all the lines it lies in are deleted.
180 Applies to lines after point."
181 (interactive (list (read-from-minibuffer
182 "Flush lines (containing match for regexp): "
183 nil nil nil
'regexp-history
)))
185 (while (and (not (eobp))
186 (re-search-forward regexp nil t
))
187 (delete-region (save-excursion (goto-char (match-beginning 0))
190 (progn (forward-line 1) (point))))))
192 (defalias 'count-matches
'how-many
)
193 (defun how-many (regexp)
194 "Print number of matches for REGEXP following point."
195 (interactive (list (read-from-minibuffer
196 "How many matches for (regexp): "
197 nil nil nil
'regexp-history
)))
198 (let ((count 0) opoint
)
200 (while (and (not (eobp))
201 (progn (setq opoint
(point))
202 (re-search-forward regexp nil t
)))
203 (if (= opoint
(point))
205 (setq count
(1+ count
))))
206 (message "%d occurrences" count
))))
208 (defvar occur-mode-map
())
211 (setq occur-mode-map
(make-sparse-keymap))
212 (define-key occur-mode-map
"\C-c\C-c" 'occur-mode-goto-occurrence
))
214 (defvar occur-buffer nil
)
215 (defvar occur-nlines nil
)
216 (defvar occur-pos-list nil
)
219 "Major mode for output from \\[occur].
220 Move point to one of the occurrences in this buffer,
221 then use \\[occur-mode-goto-occurrence] to go to the same occurrence
222 in the buffer that the occurrences were found in.
224 (kill-all-local-variables)
225 (use-local-map occur-mode-map
)
226 (setq major-mode
'occur-mode
)
227 (setq mode-name
"Occur")
228 (make-local-variable 'occur-buffer
)
229 (make-local-variable 'occur-nlines
)
230 (make-local-variable 'occur-pos-list
)
231 (run-hooks 'occur-mode-hook
))
233 (defun occur-mode-goto-occurrence ()
234 "Go to the line this occurrence was found in, in the buffer it was found in."
236 (if (or (null occur-buffer
)
237 (null (buffer-name occur-buffer
)))
239 (setq occur-buffer nil
241 (error "Buffer in which occurrences were found is deleted")))
242 (let* ((occur-number (save-excursion
244 (/ (1- (count-lines (point-min)
248 (cond ((< occur-nlines
0)
251 (+ 2 (* 2 occur-nlines
)))
253 (pos (nth occur-number occur-pos-list
)))
255 (error "No occurrence on this line"))
256 (pop-to-buffer occur-buffer
)
257 (goto-char (marker-position pos
))))
259 (defvar list-matching-lines-default-context-lines
0
260 "*Default number of context lines to include around a `list-matching-lines'
261 match. A negative number means to include that many lines before the match.
262 A positive number means to include that many lines both before and after.")
264 (defalias 'list-matching-lines
'occur
)
266 (defun occur (regexp &optional nlines
)
267 "Show all lines in the current buffer containing a match for REGEXP.
269 If a match spreads across multiple lines, all those lines are shown.
271 Each line is displayed with NLINES lines before and after, or -NLINES
272 before if NLINES is negative.
273 NLINES defaults to `list-matching-lines-default-context-lines'.
274 Interactively it is the prefix arg.
276 The lines are shown in a buffer named `*Occur*'.
277 It serves as a menu to find any of the occurrences in this buffer.
278 \\[describe-mode] in that buffer will explain how."
279 (interactive (list (let* ((default (car regexp-history
))
281 (read-from-minibuffer
283 (format "List lines matching regexp (default `%s'): " default
)
284 "List lines matching regexp: ")
287 (if (> (length input
) 0) input
288 (setcar regexp-history default
)))
290 (setq nlines
(if nlines
(prefix-numeric-value nlines
)
291 list-matching-lines-default-context-lines
))
293 (buffer (current-buffer))
295 (prevpos (point-min))
296 (final-context-start (make-marker)))
298 ;;; (beginning-of-line)
299 ;;; (setq linenum (1+ (count-lines (point-min) (point))))
300 ;;; (setq prevpos (point)))
301 (with-output-to-temp-buffer "*Occur*"
303 (set-buffer standard-output
)
304 (insert "Lines matching ")
306 (insert " in buffer " (buffer-name buffer
) ?. ?
\n)
308 (setq occur-buffer buffer
)
309 (setq occur-nlines nlines
)
310 (setq occur-pos-list
()))
311 (if (eq buffer standard-output
)
312 (goto-char (point-max)))
314 (beginning-of-buffer)
315 ;; Find next match, but give up if prev match was at end of buffer.
316 (while (and (not (= prevpos
(point-max)))
317 (re-search-forward regexp nil t
))
318 (goto-char (match-beginning 0))
321 (setq linenum
(+ linenum
(count-lines prevpos
(point)))))
322 (setq prevpos
(point))
323 (goto-char (match-end 0))
324 (let* ((start (save-excursion
325 (goto-char (match-beginning 0))
326 (forward-line (if (< nlines
0) nlines
(- nlines
)))
329 (goto-char (match-end 0))
331 (forward-line (1+ nlines
))
334 (tag (format "%3d" linenum
))
335 (empty (make-string (length tag
) ?\
))
338 (setq tem
(make-marker))
339 (set-marker tem
(point))
340 (set-buffer standard-output
)
341 (setq occur-pos-list
(cons tem occur-pos-list
))
342 (or first
(zerop nlines
)
343 (insert "--------\n"))
345 (insert-buffer-substring buffer start end
)
346 (backward-char (- end start
))
352 (let ((this-linenum linenum
))
353 (set-marker final-context-start
354 (+ (point) (- (match-end 0) (match-beginning 0))))
355 (while (< (point) final-context-start
)
357 (setq tag
(format "%3d" this-linenum
)))
361 (setq this-linenum
(1+ this-linenum
))))
362 (while (< tem nlines
)
365 (setq tem
(1+ tem
))))
367 (set-buffer standard-output
)
368 ;; Put positions in increasing order to go with buffer.
369 (setq occur-pos-list
(nreverse occur-pos-list
))
371 (message "%d matching lines." (length occur-pos-list
)))))))
373 ;; It would be nice to use \\[...], but there is no reasonable way
374 ;; to make that display both SPC and Y.
375 (defconst query-replace-help
376 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
377 RET or `q' to exit, Period to replace one match and exit,
378 Comma to replace but not move point immediately,
379 C-r to enter recursive edit (\\[exit-recursive-edit] to get out again),
380 C-w to delete match and recursive edit,
381 C-l to clear the screen, redisplay, and offer same replacement again,
382 ! to replace all remaining matches with no more questions,
383 ^ to move point back to previous match."
384 "Help message while in query-replace")
386 (defvar query-replace-map
(make-sparse-keymap)
387 "Keymap that defines the responses to questions in `query-replace'.
388 The \"bindings\" in this map are not commands; they are answers.
389 The valid answers include `act', `skip', `act-and-show',
390 `exit', `act-and-exit', `edit', `delete-and-edit', `recenter',
391 `automatic', `backup', and `help'.")
393 (define-key query-replace-map
" " 'act
)
394 (define-key query-replace-map
"\d" 'skip
)
395 (define-key query-replace-map
[delete] 'skip)
396 (define-key query-replace-map [backspace] 'skip)
397 (define-key query-replace-map "y" 'act)
398 (define-key query-replace-map "n" 'skip)
399 (define-key query-replace-map "," 'act-and-show)
400 (define-key query-replace-map "q" 'exit)
401 (define-key query-replace-map "\r" 'exit)
402 (define-key query-replace-map [return] 'exit)
403 (define-key query-replace-map "." 'act-and-exit)
404 (define-key query-replace-map "\C-r" 'edit)
405 (define-key query-replace-map "\C-w" 'delete-and-edit)
406 (define-key query-replace-map "\C-l" 'recenter)
407 (define-key query-replace-map "!" 'automatic)
408 (define-key query-replace-map "^" 'backup)
409 (define-key query-replace-map "\C-h" 'help)
410 (define-key query-replace-map "?" 'help)
411 (define-key query-replace-map "\C-g" 'quit)
412 (define-key query-replace-map "\C-]" 'quit)
414 (defun perform-replace (from-string replacements
415 query-flag regexp-flag delimited-flag
416 &optional repeat-count map)
417 "Subroutine of `query-replace'. Its complexity handles interactive queries.
418 Don't use this in your own program unless you want to query and set the mark
419 just as `query-replace' does. Instead, write a simple loop like this:
420 (while (re-search-forward \"foo[ \t]+bar\" nil t)
421 (replace-match \"foobar\" nil nil))
422 which will run faster and probably do exactly what you want."
423 (or map (setq map query-replace-map))
424 (let ((nocasify (not (and case-fold-search case-replace
425 (string-equal from-string
426 (downcase from-string)))))
427 (literal (not regexp-flag))
428 (search-function (if regexp-flag 're-search-forward 'search-forward))
429 (search-string from-string)
430 (real-match-data nil) ; the match data for the current match
431 (next-replacement nil)
432 (replacement-index 0)
435 (next-rotate-count 0)
437 (lastrepl nil) ;Position after last match considered.
439 (if (stringp replacements)
440 (setq next-replacement replacements)
441 (or repeat-count (setq repeat-count 1)))
443 (setq search-function 're-search-forward
444 search-string (concat "\\b"
445 (if regexp-flag from-string
446 (regexp-quote from-string))
451 ;; Loop finding occurrences that perhaps should be replaced.
452 (while (and keep-going
454 (funcall search-function search-string nil t)
455 ;; If the search string matches immediately after
456 ;; the previous match, but it did not match there
457 ;; before the replacement was done, ignore the match.
458 (if (or (eq lastrepl (point))
460 (eq lastrepl (match-beginning 0))
464 ;; Don't replace the null string
465 ;; right after end of previous replacement.
467 (funcall search-function search-string nil t))
470 ;; Save the data associated with the real match.
471 (setq real-match-data (match-data))
473 ;; Before we make the replacement, decide whether the search string
474 ;; can match again just after this match.
476 (setq match-again (looking-at search-string)))
477 ;; If time for a change, advance to next replacement string.
478 (if (and (listp replacements)
479 (= next-rotate-count replace-count))
481 (setq next-rotate-count
482 (+ next-rotate-count repeat-count))
483 (setq next-replacement (nth replacement-index replacements))
484 (setq replacement-index (% (1+ replacement-index) (length replacements)))))
487 (store-match-data real-match-data)
488 (replace-match next-replacement nocasify literal)
489 (setq replace-count (1+ replace-count)))
491 (let (done replaced key def)
492 ;; Loop reading commands until one of them sets done,
493 ;; which means it has finished handling this occurrence.
495 (replace-highlight (match-beginning 0) (match-end 0))
496 (message (substitute-command-keys
497 "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) ")
498 from-string next-replacement)
499 (setq key (read-event))
500 (setq key (vector key))
501 (setq def (lookup-key map key))
502 ;; Restore the match data while we process the command.
503 (store-match-data real-match-data)
504 (cond ((eq def 'help)
505 (with-output-to-temp-buffer "*Help*"
507 (concat "Query replacing "
508 (if regexp-flag "regexp " "")
510 next-replacement ".\n\n"
511 (substitute-command-keys
512 query-replace-help)))))
514 (setq keep-going nil)
518 (let ((elt (car stack)))
519 (goto-char (car elt))
520 (setq replaced (eq t (cdr elt)))
522 (store-match-data (cdr elt)))
523 (setq stack (cdr stack)))
524 (message "No previous match")
529 (replace-match next-replacement nocasify literal))
530 (setq done t replaced t))
531 ((eq def 'act-and-exit)
533 (replace-match next-replacement nocasify literal))
534 (setq keep-going nil)
535 (setq done t replaced t))
536 ((eq def 'act-and-show)
539 (replace-match next-replacement nocasify literal)
543 (replace-match next-replacement nocasify literal))
544 (setq done t query-flag nil replaced t))
552 (save-excursion (recursive-edit))))
553 ;; Before we make the replacement,
554 ;; decide whether the search string
555 ;; can match again just after this match.
557 (setq match-again (looking-at search-string))))
558 ((eq def 'delete-and-edit)
559 (delete-region (match-beginning 0) (match-end 0))
562 (save-excursion (recursive-edit))))
565 (setq keep-going nil)
566 (setq unread-command-events
567 (append (listify-key-sequence key)
568 unread-command-events))
570 ;; Record previous position for ^ when we move on.
571 ;; Change markers to numbers in the match data
572 ;; since lots of markers slow down editing.
576 (mapcar (lambda (elt)
578 (prog1 (marker-position elt)
579 (set-marker elt nil))))
582 (if replaced (setq replace-count (1+ replace-count)))))
583 (setq lastrepl (point)))
584 (replace-dehighlight))
585 (and keep-going stack)))
587 (defvar query-replace-highlight nil
588 "*Non-nil means to highlight words during query replacement.")
590 (defvar replace-overlay nil)
592 (defun replace-dehighlight ()
595 (delete-overlay replace-overlay)
596 (setq replace-overlay nil))))
598 (defun replace-highlight (start end)
599 (and query-replace-highlight
603 (setq replace-overlay (make-overlay start end))
604 (overlay-put replace-overlay 'face
605 (if (internal-find-face 'query-replace)
606 'query-replace 'region))))
607 (move-overlay replace-overlay start end (current-buffer)))))
609 ;;; replace.el ends here