-;; Replace commands for Emacs.
-;; Copyright (C) 1985, 1986 Free Software Foundation, Inc.
+;;; replace.el --- replace commands for Emacs.
+
+;; Copyright (C) 1985, 1986, 1987, 1992 Free Software Foundation, Inc.
;; 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
-;; the Free Software Foundation; either version 1, or (at your option)
+;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;;; Commentary:
+
+;; This package supplies the string and regular-expression replace functions
+;; documented in the Emacs user's manual.
+
+;;; Code:
+
+(defconst case-replace t "\
+*Non-nil means query-replace should preserve case in replacements.")
+
+(defvar query-replace-history nil)
+
+(defun query-replace-read-args (string)
+ (let (from to)
+ (setq from (read-from-minibuffer (format "%s: " string)
+ nil nil nil
+ 'query-replace-history))
+ (setq to (read-from-minibuffer (format "%s %s with: " string from)
+ nil nil nil
+ 'query-replace-history))
+ (list from to current-prefix-arg)))
+
+(defun query-replace (from-string to-string &optional arg)
+ "Replace some occurrences of FROM-STRING with TO-STRING.
+As each match is found, the user must type a character saying
+what to do with it. For directions, type \\[help-command] at that time.
+
+Preserves case in each replacement if case-replace and case-fold-search
+are non-nil and FROM-STRING has no uppercase letters.
+Third arg DELIMITED (prefix arg if interactive) non-nil means replace
+only matches surrounded by word boundaries.
+
+To customize possible responses, change the \"bindings\" in `query-replace-map'."
+ (interactive (query-replace-read-args "Query replace"))
+ (perform-replace from-string to-string t nil arg)
+ (or unread-command-events (message "Done")))
+(define-key esc-map "%" 'query-replace)
+
+(defun query-replace-regexp (regexp to-string &optional arg)
+ "Replace some things after point matching REGEXP with TO-STRING.
+As each match is found, the user must type a character saying
+what to do with it. For directions, type \\[help-command] at that time.
+
+Preserves case in each replacement if case-replace and case-fold-search
+are non-nil and REGEXP has no uppercase letters.
+Third arg DELIMITED (prefix arg if interactive) non-nil means replace
+only matches surrounded by word boundaries.
+In TO-STRING, \\& means insert what matched REGEXP,
+and \\=\\<n> means insert what matched <n>th \\(...\\) in REGEXP."
+ (interactive (query-replace-read-args "Query replace regexp"))
+ (perform-replace regexp to-string t t arg)
+ (or unread-command-events (message "Done")))
+
+(defun map-query-replace-regexp (regexp to-strings &optional arg)
+ "Replace some matches for REGEXP with various strings, in rotation.
+The second argument TO-STRINGS contains the replacement strings, separated
+by spaces. This command works like `query-replace-regexp' except
+that each successive replacement uses the next successive replacement string,
+wrapping around from the last such string to the first.
+
+Non-interactively, TO-STRINGS may be a list of replacement strings.
+
+A prefix argument N says to use each replacement string N times
+before rotating to the next."
+ (interactive
+ (let (from to)
+ (setq from (read-from-minibuffer "Map query replace (regexp): "
+ nil nil nil
+ 'query-replace-history))
+ (setq to (read-from-minibuffer
+ (format "Query replace %s with (space-separated strings): "
+ from)
+ nil nil nil
+ 'query-replace-history))
+ (list from to current-prefix-arg)))
+ (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 ""))))
+ (perform-replace regexp replacements t t nil arg))
+ (or unread-command-events (message "Done")))
+
+(defun replace-string (from-string to-string &optional delimited)
+ "Replace occurrences of FROM-STRING with TO-STRING.
+Preserve case in each match if `case-replace' and `case-fold-search'
+are non-nil and FROM-STRING has no uppercase letters.
+Third arg DELIMITED (prefix arg if interactive) non-nil means replace
+only matches surrounded by word boundaries.
+
+This function is usually the wrong thing to use in a Lisp program.
+What you probably want is a loop like this:
+ (while (search-forward OLD-STRING nil t)
+ (replace-match REPLACEMENT nil t))
+which will run faster and will not set the mark or print anything."
+ (interactive (query-replace-read-args "Replace string"))
+ (perform-replace from-string to-string nil nil delimited)
+ (or unread-command-events (message "Done")))
+
+(defun replace-regexp (regexp to-string &optional delimited)
+ "Replace things after point matching REGEXP with TO-STRING.
+Preserve case in each match if case-replace and case-fold-search
+are non-nil and REGEXP has no uppercase letters.
+Third arg DELIMITED (prefix arg if interactive) non-nil means replace
+only matches surrounded by word boundaries.
+In TO-STRING, \\& means insert what matched REGEXP,
+and \\=\\<n> means insert what matched <n>th \\(...\\) in REGEXP.
-(fset 'delete-non-matching-lines 'keep-lines)
+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)
+ (replace-match REPLACEMENT nil nil))
+which will run faster and will not set the mark or print anything."
+ (interactive (query-replace-read-args "Replace regexp"))
+ (perform-replace regexp to-string nil t delimited)
+ (or unread-command-events (message "Done")))
+\f
+(defvar regexp-history nil
+ "History list for some commands that read regular expressions.")
+
+(defalias 'delete-non-matching-lines 'keep-lines)
(defun keep-lines (regexp)
"Delete all lines except those containing matches for REGEXP.
A match split across lines preserves all the lines it lies in.
Applies to all lines after point."
- (interactive "sKeep lines (containing match for regexp): ")
+ (interactive (list (read-from-minibuffer
+ "Keep lines (containing match for regexp): "
+ nil nil nil 'regexp-history)))
(save-excursion
(or (bolp) (forward-line 1))
(let ((start (point)))
(and (not (eobp)) (= (match-beginning 0) (match-end 0))
(forward-char 1))))))
-(fset 'delete-matching-lines 'flush-lines)
+(defalias 'delete-matching-lines 'flush-lines)
(defun flush-lines (regexp)
"Delete lines containing matches for REGEXP.
If a match is split across lines, all the lines it lies in are deleted.
Applies to lines after point."
- (interactive "sFlush lines (containing match for regexp): ")
+ (interactive (list (read-from-minibuffer
+ "Flush lines (containing match for regexp): "
+ nil nil nil 'regexp-history)))
(save-excursion
(while (and (not (eobp))
(re-search-forward regexp nil t))
(point))
(progn (forward-line 1) (point))))))
-(fset 'count-matches 'how-many)
+(defalias 'count-matches 'how-many)
(defun how-many (regexp)
"Print number of matches for REGEXP following point."
- (interactive "sHow many matches for (regexp): ")
+ (interactive (list (read-from-minibuffer
+ "How many matches for (regexp): "
+ nil nil nil 'regexp-history)))
(let ((count 0) opoint)
(save-excursion
(while (and (not (eobp))
(forward-char 1)
(setq count (1+ count))))
(message "%d occurrences" count))))
-
+\f
(defvar occur-mode-map ())
(if occur-mode-map
()
(pos (nth occur-number occur-pos-list)))
(pop-to-buffer occur-buffer)
(goto-char (marker-position pos))))
-
+\f
(defvar list-matching-lines-default-context-lines 0
- "*Default number of context lines to include around a list-matching-lines
+ "*Default number of context lines to include around a `list-matching-lines'
match. A negative number means to include that many lines before the match.
A positive number means to include that many lines both before and after.")
-(defvar occur-whole-buffer nil
- "If t, occur operates on whole buffer, otherwise occur starts from point.
-default is nil.")
-
-(fset 'list-matching-lines 'occur)
+(defalias 'list-matching-lines 'occur)
(defun occur (regexp &optional nlines)
- "Show lines containing a match for REGEXP. If the global variable
-occur-whole-buffer is non-nil, the entire buffer is searched, otherwise
-search begins at point.
+ "Show all lines in the current buffer containing a match for REGEXP.
+
+If a match spreads across multiple lines, all those lines are shown.
-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.
+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'.
Interactively it is the prefix arg.
-The lines are shown in a buffer named *Occur*.
+The lines are shown in a buffer named `*Occur*'.
It serves as a menu to find any of the occurrences in this buffer.
\\[describe-mode] in that buffer will explain how."
- (interactive "sList lines matching regexp: \nP")
+ (interactive (list (let* ((default (car regexp-history))
+ (input
+ (read-from-minibuffer
+ (format "List lines matching regexp (default `%s'): " default)
+ nil nil nil
+ 'regexp-history)))
+ (if (> (length input) 0) input
+ (setcar regexp-history default)))
+ current-prefix-arg))
(setq nlines (if nlines (prefix-numeric-value nlines)
list-matching-lines-default-context-lines))
(let ((first t)
(buffer (current-buffer))
(linenum 1)
- (prevpos (point-min)))
- (if (not occur-whole-buffer)
- (save-excursion
- (beginning-of-line)
- (setq linenum (1+ (count-lines (point-min) (point))))
- (setq prevpos (point))))
+ (prevpos (point-min))
+ (final-context-start (make-marker)))
+;;; (save-excursion
+;;; (beginning-of-line)
+;;; (setq linenum (1+ (count-lines (point-min) (point))))
+;;; (setq prevpos (point)))
(with-output-to-temp-buffer "*Occur*"
(save-excursion
(set-buffer standard-output)
(if (eq buffer standard-output)
(goto-char (point-max)))
(save-excursion
- (if occur-whole-buffer
- (beginning-of-buffer))
+ (beginning-of-buffer)
;; Find next match, but give up if prev match was at end of buffer.
(while (and (not (= prevpos (point-max)))
(re-search-forward regexp nil t))
+ (goto-char (match-beginning 0))
(beginning-of-line)
- (setq linenum (+ linenum (count-lines prevpos (point))))
+ (save-match-data
+ (setq linenum (+ linenum (count-lines prevpos (point)))))
(setq prevpos (point))
+ (goto-char (match-end 0))
(let* ((start (save-excursion
+ (goto-char (match-beginning 0))
(forward-line (if (< nlines 0) nlines (- nlines)))
(point)))
(end (save-excursion
+ (goto-char (match-end 0))
(if (> nlines 0)
(forward-line (1+ nlines))
(forward-line 1))
(setq first nil)
(insert-buffer-substring buffer start end)
(backward-char (- end start))
- (setq tem (if (< nlines 0) (- nlines) nlines))
+ (setq tem nlines)
(while (> tem 0)
(insert empty ?:)
(forward-line 1)
(setq tem (1- tem)))
- (insert tag ?:)
- (forward-line 1)
+ (let ((this-linenum linenum))
+ (set-marker final-context-start
+ (+ (point) (- (match-end 0) (match-beginning 0))))
+ (while (< (point) final-context-start)
+ (if (null tag)
+ (setq tag (format "%3d" this-linenum)))
+ (insert tag ?:)
+ (setq tag nil)
+ (forward-line 1)
+ (setq this-linenum (1+ this-linenum))))
(while (< tem nlines)
(insert empty ?:)
(forward-line 1)
(if (interactive-p)
(message "%d matching lines." (length occur-pos-list)))))))
\f
+;; It would be nice to use \\[...], but there is no reasonable way
+;; to make that display both SPC and Y.
(defconst query-replace-help
"Type Space or `y' to replace one match, Delete or `n' to skip to next,
ESC or `q' to exit, Period to replace one match and exit,
^ to move point back to previous match."
"Help message while in query-replace")
+(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',
+`automatic', `backup', and `help'.")
+
+(define-key query-replace-map " " 'act)
+(define-key query-replace-map "\d" 'skip)
+(define-key query-replace-map [delete] 'skip)
+(define-key query-replace-map [backspace] 'skip)
+(define-key query-replace-map "y" 'act)
+(define-key query-replace-map "n" 'skip)
+(define-key query-replace-map "," 'act-and-show)
+(define-key query-replace-map "\e" 'exit)
+(define-key query-replace-map [escape] 'exit)
+(define-key query-replace-map "q" 'exit)
+(define-key query-replace-map "\r" 'exit)
+(define-key query-replace-map [return] 'exit)
+(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)
+(define-key query-replace-map "?" 'help)
+(define-key query-replace-map "\C-g" 'quit)
+(define-key query-replace-map "\C-]" 'quit)
+
(defun perform-replace (from-string replacements
query-flag regexp-flag delimited-flag
- &optional repeat-count)
+ &optional repeat-count map)
"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))
which will run faster and do exactly what you probably want."
+ (or map (setq map query-replace-map))
(let ((nocasify (not (and case-fold-search case-replace
(string-equal from-string
(downcase from-string)))))
(literal (not regexp-flag))
(search-function (if regexp-flag 're-search-forward 'search-forward))
(search-string from-string)
+ (real-match-data nil) ; the match data for the current match
(next-replacement nil)
(replacement-index 0)
(keep-going t)
(stack nil)
(next-rotate-count 0)
(replace-count 0)
- (lastrepl nil)) ;Position after last match considered.
+ (lastrepl nil) ;Position after last match considered.
+ (match-again t))
(if (stringp replacements)
(setq next-replacement replacements)
(or repeat-count (setq repeat-count 1)))
"\\b")))
(push-mark)
(undo-boundary)
+ ;; Loop finding occurrences that perhaps should be replaced.
(while (and keep-going
(not (eobp))
(funcall search-function search-string nil t)
- (if (eq lastrepl (point))
- (progn
+ ;; If the search string matches immediately after
+ ;; the previous match, but it did not match there
+ ;; before the replacement was done, ignore the match.
+ (if (or (eq lastrepl (point))
+ (and regexp-flag
+ (eq lastrepl (match-beginning 0))
+ (not match-again)))
+ (if (eobp)
+ nil
;; Don't replace the null string
;; right after end of previous replacement.
(forward-char 1)
(funcall search-function search-string nil t))
t))
+
+ ;; Save the data associated with the real match.
+ (setq real-match-data (match-data))
+
+ ;; Before we make the replacement, decide whether the search string
+ ;; can match again just after this match.
+ (if regexp-flag
+ (setq match-again (looking-at search-string)))
;; If time for a change, advance to next replacement string.
(if (and (listp replacements)
(= next-rotate-count replace-count))
(setq replacement-index (% (1+ replacement-index) (length replacements)))))
(if (not query-flag)
(progn
+ (store-match-data real-match-data)
(replace-match next-replacement nocasify literal)
(setq replace-count (1+ replace-count)))
(undo-boundary)
- (let (done replaced)
+ (let (done replaced key def)
+ ;; Loop reading commands until one of them sets done,
+ ;; which means it has finished handling this occurrence.
(while (not done)
- ;; Preserve the match data. Process filters and sentinels
- ;; could run inside read-char..
- (let ((data (match-data))
- (help-form
- '(concat "Query replacing "
- (if regexp-flag "regexp " "")
- from-string " with " next-replacement ".\n\n"
- (substitute-command-keys query-replace-help))))
- (setq char help-char)
- (while (or (not (numberp char)) (= char help-char))
- (message "Query replacing %s with %s: " from-string next-replacement)
- (setq char (read-event))
- (if (and (numberp char) (= char ??))
- (setq unread-command-char help-char char help-char)))
- (store-match-data data))
- (cond ((or (= char ?\e)
- (= char ?q))
+ (message "Query replacing %s with %s: "
+ from-string next-replacement)
+ (setq key (read-event))
+ (setq key (vector key))
+ (setq def (lookup-key map key))
+ ;; Restore the match data while we process the command.
+ (store-match-data real-match-data)
+ (cond ((eq def 'help)
+ (with-output-to-temp-buffer "*Help*"
+ (princ
+ (concat "Query replacing "
+ (if regexp-flag "regexp " "")
+ from-string " with "
+ next-replacement ".\n\n"
+ (substitute-command-keys
+ query-replace-help)))))
+ ((eq def 'exit)
(setq keep-going nil)
(setq done t))
- ((= char ?^)
+ ((eq def 'backup)
(let ((elt (car stack)))
(goto-char (car elt))
(setq replaced (eq t (cdr elt)))
(or replaced
(store-match-data (cdr elt)))
(setq stack (cdr stack))))
- ((or (= char ?\ )
- (= char ?y))
+ ((eq def 'act)
(or replaced
(replace-match next-replacement nocasify literal))
(setq done t replaced t))
- ((= char ?\.)
+ ((eq def 'act-and-exit)
(or replaced
(replace-match next-replacement nocasify literal))
(setq keep-going nil)
(setq done t replaced t))
- ((= char ?\,)
+ ((eq def 'act-and-show)
(if (not replaced)
(progn
(replace-match next-replacement nocasify literal)
(setq replaced t))))
- ((= char ?!)
+ ((eq def 'automatic)
(or replaced
(replace-match next-replacement nocasify literal))
(setq done t query-flag nil replaced t))
- ((or (= char ?\177)
- (= char ?n))
+ ((eq def 'skip)
(setq done t))
- ((= char ?\C-l)
+ ((eq def 'recenter)
(recenter nil))
- ((= char ?\C-r)
+ ((eq def 'edit)
(store-match-data
(prog1 (match-data)
- (save-excursion (recursive-edit)))))
- ((= char ?\C-w)
+ (save-excursion (recursive-edit))))
+ ;; Before we make the replacement,
+ ;; decide whether the search string
+ ;; can match again just after this match.
+ (if regexp-flag
+ (setq match-again (looking-at search-string))))
+ ((eq def 'delete-and-edit)
(delete-region (match-beginning 0) (match-end 0))
(store-match-data
(prog1 (match-data)
(setq replaced t))
(t
(setq keep-going nil)
- (setq unread-command-char char)
+ (setq unread-command-events
+ (append (listify-key-sequence key)
+ unread-command-events))
(setq done t))))
;; Record previous position for ^ when we move on.
;; Change markers to numbers in the match data
stack))
(if replaced (setq replace-count (1+ replace-count)))))
(setq lastrepl (point)))
- (and keep-going stack)))
-\f
-(defun map-query-replace-regexp (regexp to-strings &optional arg)
- "Replace some matches for REGEXP with various strings, in rotation.
-The second argument TO-STRINGS contains the replacement strings, separated
-by spaces. This command works like `query-replace-regexp' except
-that each successive replacement uses the next successive replacement string,
-wrapping around from the last such string to the first.
-
-Non-interactively, TO-STRINGS may be a list of replacement strings.
-
-A prefix argument N says to use each replacement string N times
-before rotating to the next."
- (interactive "sMap query replace (regexp): \nsQuery replace %s with (space-separated strings): \nP")
- (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 ""))))
- (perform-replace regexp replacements t t nil arg))
- (message "Done"))
+ (and keep-going stack)))
+;;; replace.el ends here