1 ;;; replace.el --- replace commands for Emacs.
3 ;; Copyright (C) 1985-1991 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 1, 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 (defconst case-replace t
"\
24 *Non-nil means query-replace should preserve case in replacements.")
27 (defun query-replace (from-string to-string
&optional arg
)
28 "Replace some occurrences of FROM-STRING with TO-STRING.
29 As each match is found, the user must type a character saying
30 what to do with it. For directions, type \\[help-command] at that time.
32 Preserves case in each replacement if case-replace and case-fold-search
33 are non-nil and FROM-STRING has no uppercase letters.
34 Third arg DELIMITED (prefix arg if interactive) non-nil means replace
35 only matches surrounded by word boundaries."
36 (interactive "sQuery replace: \nsQuery replace %s with: \nP")
37 (perform-replace from-string to-string t nil arg
)
40 (define-key esc-map
"%" 'query-replace
)
43 (defun query-replace-regexp (regexp to-string
&optional arg
)
44 "Replace some things after point matching REGEXP 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 REGEXP has no uppercase letters.
50 Third arg DELIMITED (prefix arg if interactive) non-nil means replace
51 only matches surrounded by word boundaries.
52 In TO-STRING, \\& means insert what matched REGEXP,
53 and \\=\\<n> means insert what matched <n>th \\(...\\) in REGEXP."
54 (interactive "sQuery replace regexp: \nsQuery replace regexp %s with: \nP")
55 (perform-replace regexp to-string t t arg
)
59 (defun map-query-replace-regexp (regexp to-strings
&optional arg
)
60 "Replace some matches for REGEXP with various strings, in rotation.
61 The second argument TO-STRINGS contains the replacement strings, separated
62 by spaces. This command works like `query-replace-regexp' except
63 that each successive replacement uses the next successive replacement string,
64 wrapping around from the last such string to the first.
66 Non-interactively, TO-STRINGS may be a list of replacement strings.
68 A prefix argument N says to use each replacement string N times
69 before rotating to the next."
70 (interactive "sMap query replace (regexp): \nsQuery replace %s with (space-separated strings): \nP")
72 (if (listp to-strings
)
73 (setq replacements to-strings
)
74 (while (/= (length to-strings
) 0)
75 (if (string-match " " to-strings
)
78 (list (substring to-strings
0
79 (string-match " " to-strings
))))
80 to-strings
(substring to-strings
81 (1+ (string-match " " to-strings
))))
82 (setq replacements
(append replacements
(list to-strings
))
84 (perform-replace regexp replacements t t nil arg
))
88 (defun replace-string (from-string to-string
&optional delimited
)
89 "Replace occurrences of FROM-STRING with TO-STRING.
90 Preserve case in each match if `case-replace' and `case-fold-search'
91 are non-nil and FROM-STRING has no uppercase letters.
92 Third arg DELIMITED (prefix arg if interactive) non-nil means replace
93 only matches surrounded by word boundaries.
95 This function is usually the wrong thing to use in a Lisp program.
96 What you probably want is a loop like this:
97 (while (search-forward OLD-STRING nil t)
98 (replace-match REPLACEMENT nil t))
99 which will run faster and will not set the mark or print anything."
100 (interactive "sReplace string: \nsReplace string %s with: \nP")
101 (perform-replace from-string to-string nil nil delimited
)
105 (defun replace-regexp (regexp to-string
&optional delimited
)
106 "Replace things after point matching REGEXP with TO-STRING.
107 Preserve case in each match if case-replace and case-fold-search
108 are non-nil and REGEXP has no uppercase letters.
109 Third arg DELIMITED (prefix arg if interactive) non-nil means replace
110 only matches surrounded by word boundaries.
111 In TO-STRING, \\& means insert what matched REGEXP,
112 and \\=\\<n> means insert what matched <n>th \\(...\\) in REGEXP.
114 This function is usually the wrong thing to use in a Lisp program.
115 What you probably want is a loop like this:
116 (while (re-search-forward REGEXP nil t)
117 (replace-match REPLACEMENT nil nil))
118 which will run faster and will not set the mark or print anything."
119 (interactive "sReplace regexp: \nsReplace regexp %s with: \nP")
120 (perform-replace regexp to-string nil t delimited
)
123 (fset 'delete-non-matching-lines
'keep-lines
)
124 (defun keep-lines (regexp)
125 "Delete all lines except those containing matches for REGEXP.
126 A match split across lines preserves all the lines it lies in.
127 Applies to all lines after point."
128 (interactive "sKeep lines (containing match for regexp): ")
130 (or (bolp) (forward-line 1))
131 (let ((start (point)))
133 ;; Start is first char not preserved by previous match.
134 (if (not (re-search-forward regexp nil
'move
))
135 (delete-region start
(point-max))
136 (let ((end (save-excursion (goto-char (match-beginning 0))
139 ;; Now end is first char preserved by the new match.
141 (delete-region start end
))))
142 (setq start
(save-excursion (forward-line 1)
144 ;; If the match was empty, avoid matching again at same place.
145 (and (not (eobp)) (= (match-beginning 0) (match-end 0))
146 (forward-char 1))))))
148 (fset 'delete-matching-lines
'flush-lines
)
149 (defun flush-lines (regexp)
150 "Delete lines containing matches for REGEXP.
151 If a match is split across lines, all the lines it lies in are deleted.
152 Applies to lines after point."
153 (interactive "sFlush lines (containing match for regexp): ")
155 (while (and (not (eobp))
156 (re-search-forward regexp nil t
))
157 (delete-region (save-excursion (goto-char (match-beginning 0))
160 (progn (forward-line 1) (point))))))
162 (fset 'count-matches
'how-many
)
163 (defun how-many (regexp)
164 "Print number of matches for REGEXP following point."
165 (interactive "sHow many matches for (regexp): ")
166 (let ((count 0) opoint
)
168 (while (and (not (eobp))
169 (progn (setq opoint
(point))
170 (re-search-forward regexp nil t
)))
171 (if (= opoint
(point))
173 (setq count
(1+ count
))))
174 (message "%d occurrences" count
))))
176 (defvar occur-mode-map
())
179 (setq occur-mode-map
(make-sparse-keymap))
180 (define-key occur-mode-map
"\C-c\C-c" 'occur-mode-goto-occurrence
))
182 (defvar occur-buffer nil
)
183 (defvar occur-nlines nil
)
184 (defvar occur-pos-list nil
)
185 (defvar occur-last-string
"")
188 "Major mode for output from \\[occur].
189 Move point to one of the occurrences in this buffer,
190 then use \\[occur-mode-goto-occurrence] to go to the same occurrence
191 in the buffer that the occurrences were found in.
193 (kill-all-local-variables)
194 (use-local-map occur-mode-map
)
195 (setq major-mode
'occur-mode
)
196 (setq mode-name
"Occur")
197 (make-local-variable 'occur-buffer
)
198 (make-local-variable 'occur-nlines
)
199 (make-local-variable 'occur-pos-list
))
201 (defun occur-mode-goto-occurrence ()
202 "Go to the line this occurrence was found in, in the buffer it was found in."
204 (if (or (null occur-buffer
)
205 (null (buffer-name occur-buffer
)))
207 (setq occur-buffer nil
209 (error "Buffer in which occurrences were found is deleted")))
210 (let* ((occur-number (save-excursion
212 (/ (1- (count-lines (point-min)
216 (cond ((< occur-nlines
0)
219 (+ 2 (* 2 occur-nlines
)))
221 (pos (nth occur-number occur-pos-list
)))
222 (pop-to-buffer occur-buffer
)
223 (goto-char (marker-position pos
))))
225 (defvar list-matching-lines-default-context-lines
0
226 "*Default number of context lines to include around a `list-matching-lines'
227 match. A negative number means to include that many lines before the match.
228 A positive number means to include that many lines both before and after.")
230 (defvar occur-whole-buffer nil
231 "If t, occur operates on whole buffer, otherwise occur starts from point.
234 (fset 'list-matching-lines
'occur
)
236 (defun occur (regexp &optional nlines
)
237 "Show lines containing a match for REGEXP. If the global variable
238 `occur-whole-buffer' is non-nil, the entire buffer is searched, otherwise
239 search begins at point. Interactively, REGEXP defaults to the last REGEXP
240 used interactively with \\[occur].
242 If a match spreads across multiple lines, all those lines are shown.
244 Each line is displayed with NLINES lines before and after, or -NLINES
245 before if NLINES is negative.
246 NLINES defaults to `list-matching-lines-default-context-lines'.
247 Interactively it is the prefix arg.
249 The lines are shown in a buffer named *Occur*.
250 It serves as a menu to find any of the occurrences in this buffer.
251 \\[describe-mode] in that buffer will explain how."
252 (interactive (list (setq occur-last-string
253 (read-string "List lines matching regexp: "
256 (setq nlines
(if nlines
(prefix-numeric-value nlines
)
257 list-matching-lines-default-context-lines
))
259 (buffer (current-buffer))
261 (prevpos (point-min))
262 (final-context-start (make-marker)))
263 (if (not occur-whole-buffer
)
266 (setq linenum
(1+ (count-lines (point-min) (point))))
267 (setq prevpos
(point))))
268 (with-output-to-temp-buffer "*Occur*"
270 (set-buffer standard-output
)
271 (insert "Lines matching ")
273 (insert " in buffer " (buffer-name buffer
) ?. ?
\n)
275 (setq occur-buffer buffer
)
276 (setq occur-nlines nlines
)
277 (setq occur-pos-list
()))
278 (if (eq buffer standard-output
)
279 (goto-char (point-max)))
281 (if occur-whole-buffer
282 (beginning-of-buffer))
283 ;; Find next match, but give up if prev match was at end of buffer.
284 (while (and (not (= prevpos
(point-max)))
285 (re-search-forward regexp nil t
))
286 (goto-char (match-beginning 0))
288 (setq linenum
(+ linenum
(count-lines prevpos
(point))))
289 (setq prevpos
(point))
290 (goto-char (match-end 0))
291 (let* ((start (save-excursion
292 (goto-char (match-beginning 0))
293 (forward-line (if (< nlines
0) nlines
(- nlines
)))
296 (goto-char (match-end 0))
298 (forward-line (1+ nlines
))
301 (tag (format "%3d" linenum
))
302 (empty (make-string (length tag
) ?\
))
305 (setq tem
(make-marker))
306 (set-marker tem
(point))
307 (set-buffer standard-output
)
308 (setq occur-pos-list
(cons tem occur-pos-list
))
309 (or first
(zerop nlines
)
310 (insert "--------\n"))
312 (insert-buffer-substring buffer start end
)
313 (backward-char (- end start
))
319 (let ((this-linenum linenum
))
320 (set-marker final-context-start
321 (+ (point) (- (match-end 0) (match-beginning 0))))
322 (while (< (point) final-context-start
)
324 (setq tag
(format "%3d" this-linenum
)))
328 (setq this-linenum
(1+ this-linenum
))))
329 (while (< tem nlines
)
332 (setq tem
(1+ tem
))))
334 (set-buffer standard-output
)
335 ;; Put positions in increasing order to go with buffer.
336 (setq occur-pos-list
(nreverse occur-pos-list
))
338 (message "%d matching lines." (length occur-pos-list
)))))))
340 (defconst query-replace-help
341 "Type Space or `y' to replace one match, Delete or `n' to skip to next,
342 ESC or `q' to exit, Period to replace one match and exit,
343 Comma to replace but not move point immediately,
344 C-r to enter recursive edit (\\[exit-recursive-edit] to get out again),
345 C-w to delete match and recursive edit,
346 C-l to clear the screen, redisplay, and offer same replacement again,
347 ! to replace all remaining matches with no more questions,
348 ^ to move point back to previous match."
349 "Help message while in query-replace")
352 (defun perform-replace (from-string replacements
353 query-flag regexp-flag delimited-flag
354 &optional repeat-count
)
355 "Subroutine of `query-replace'. Its complexity handles interactive queries.
356 Don't use this in your own program unless you want to query and set the mark
357 just as `query-replace' does. Instead, write a simple loop like this:
358 (while (re-search-forward \"foo[ \t]+bar\" nil t)
359 (replace-match \"foobar\" nil nil))
360 which will run faster and do exactly what you probably want."
361 (let ((nocasify (not (and case-fold-search case-replace
362 (string-equal from-string
363 (downcase from-string
)))))
364 (literal (not regexp-flag
))
365 (search-function (if regexp-flag
're-search-forward
'search-forward
))
366 (search-string from-string
)
367 (next-replacement nil
)
368 (replacement-index 0)
371 (next-rotate-count 0)
373 (lastrepl nil
) ;Position after last match considered.
375 (if (stringp replacements
)
376 (setq next-replacement replacements
)
377 (or repeat-count
(setq repeat-count
1)))
379 (setq search-function
're-search-forward
380 search-string
(concat "\\b"
381 (if regexp-flag from-string
382 (regexp-quote from-string
))
386 (while (and keep-going
388 (funcall search-function search-string nil t
)
389 ;; If the search string matches immediately after
390 ;; the previous match, but it did not match there
391 ;; before the replacement was done, ignore the match.
392 (if (or (eq lastrepl
(point))
394 (eq lastrepl
(match-beginning 0))
398 ;; Don't replace the null string
399 ;; right after end of previous replacement.
401 (funcall search-function search-string nil t
))
403 ;; Before we make the replacement, decide whether the search string
404 ;; can match again just after this match.
406 (setq match-again
(looking-at search-string
)))
407 ;; If time for a change, advance to next replacement string.
408 (if (and (listp replacements
)
409 (= next-rotate-count replace-count
))
411 (setq next-rotate-count
412 (+ next-rotate-count repeat-count
))
413 (setq next-replacement
(nth replacement-index replacements
))
414 (setq replacement-index
(%
(1+ replacement-index
) (length replacements
)))))
417 (replace-match next-replacement nocasify literal
)
418 (setq replace-count
(1+ replace-count
)))
422 ;; Preserve the match data. Process filters and sentinels
423 ;; could run inside read-char..
424 (let ((data (match-data))
426 '(concat "Query replacing "
427 (if regexp-flag
"regexp " "")
428 from-string
" with " next-replacement
".\n\n"
429 (substitute-command-keys query-replace-help
))))
430 (setq char help-char
)
431 (while (or (not (numberp char
)) (= char help-char
))
432 (message "Query replacing %s with %s: " from-string next-replacement
)
433 (setq char
(read-event))
434 (if (and (numberp char
) (= char ??
))
435 (setq unread-command-char help-char char help-char
)))
436 (store-match-data data
))
437 (cond ((or (= char ?\e
)
439 (setq keep-going nil
)
442 (let ((elt (car stack
)))
443 (goto-char (car elt
))
444 (setq replaced
(eq t
(cdr elt
)))
446 (store-match-data (cdr elt
)))
447 (setq stack
(cdr stack
))))
451 (replace-match next-replacement nocasify literal
))
452 (setq done t replaced t
))
455 (replace-match next-replacement nocasify literal
))
456 (setq keep-going nil
)
457 (setq done t replaced t
))
461 (replace-match next-replacement nocasify literal
)
465 (replace-match next-replacement nocasify literal
))
466 (setq done t query-flag nil replaced t
))
475 (save-excursion (recursive-edit))))
476 ;; Before we make the replacement,
477 ;; decide whether the search string
478 ;; can match again just after this match.
480 (setq match-again
(looking-at search-string
))))
482 (delete-region (match-beginning 0) (match-end 0))
485 (save-excursion (recursive-edit))))
488 (setq keep-going nil
)
489 (setq unread-command-char char
)
491 ;; Record previous position for ^ when we move on.
492 ;; Change markers to numbers in the match data
493 ;; since lots of markers slow down editing.
498 (function (lambda (elt)
500 (marker-position elt
))))
503 (if replaced
(setq replace-count
(1+ replace-count
)))))
504 (setq lastrepl
(point)))
505 (and keep-going stack
)))
507 (defun map-query-replace-regexp (regexp to-strings
&optional arg
)
508 "Replace some matches for REGEXP with various strings, in rotation.
509 The second argument TO-STRINGS contains the replacement strings, separated
510 by spaces. This command works like `query-replace-regexp' except
511 that each successive replacement uses the next successive replacement
512 string, wrapping around from the last such string to the first.
514 Non-interactively, TO-STRINGS may be a list of replacement strings.
516 A prefix argument N says to use each replacement string N times
517 before rotating to the next."
518 (interactive "sMap query replace (regexp): \nsQuery replace %s with (space-separated strings): \nP")
520 (if (listp to-strings
)
521 (setq replacements to-strings
)
522 (while (/= (length to-strings
) 0)
523 (if (string-match " " to-strings
)
526 (list (substring to-strings
0
527 (string-match " " to-strings
))))
528 to-strings
(substring to-strings
529 (1+ (string-match " " to-strings
))))
530 (setq replacements
(append replacements
(list to-strings
))
532 (perform-replace regexp replacements t t nil arg
))
535 ;;; replace.el ends here