Commit | Line | Data |
---|---|---|
60370d40 | 1 | ;;; replace.el --- replace commands for Emacs |
c88ab9ce | 2 | |
0d30b337 TTN |
3 | ;; Copyright (C) 1985, 1986, 1987, 1992, 1994, 1996, 1997, 2000, 2001, |
4 | ;; 2002, 2003, 2004, 2005 Free Software Foundation, Inc. | |
3a801d0c | 5 | |
30764597 PJ |
6 | ;; Maintainer: FSF |
7 | ||
698e1804 RS |
8 | ;; This file is part of GNU Emacs. |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
e5d77022 | 12 | ;; the Free Software Foundation; either version 2, or (at your option) |
698e1804 RS |
13 | ;; any later version. |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
22 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
23 | ;; Boston, MA 02110-1301, USA. | |
698e1804 | 24 | |
d9ecc911 ER |
25 | ;;; Commentary: |
26 | ||
27 | ;; This package supplies the string and regular-expression replace functions | |
28 | ;; documented in the Emacs user's manual. | |
29 | ||
4f4b8eff | 30 | ;;; Code: |
698e1804 | 31 | |
9d325ebf | 32 | (defcustom case-replace t |
f54701d1 | 33 | "*Non-nil means `query-replace' should preserve case in replacements." |
9d325ebf RS |
34 | :type 'boolean |
35 | :group 'matching) | |
77176e73 | 36 | |
770970cb RS |
37 | (defvar query-replace-history nil) |
38 | ||
5291cbca | 39 | (defvar query-replace-interactive nil |
151270f3 | 40 | "Non-nil means `query-replace' uses the last search string. |
5291cbca | 41 | That becomes the \"string to replace\".") |
151270f3 | 42 | |
bdb1c08f | 43 | (defcustom query-replace-from-history-variable 'query-replace-history |
f54701d1 | 44 | "History list to use for the FROM argument of `query-replace' commands. |
bdb1c08f RS |
45 | The value of this variable should be a symbol; that symbol |
46 | is used as a variable to hold a history list for the strings | |
47 | or patterns to be replaced." | |
48 | :group 'matching | |
cd32a7ba DN |
49 | :type 'symbol |
50 | :version "20.3") | |
bdb1c08f RS |
51 | |
52 | (defcustom query-replace-to-history-variable 'query-replace-history | |
f54701d1 | 53 | "History list to use for the TO argument of `query-replace' commands. |
bdb1c08f RS |
54 | The value of this variable should be a symbol; that symbol |
55 | is used as a variable to hold a history list for replacement | |
56 | strings or patterns." | |
57 | :group 'matching | |
cd32a7ba DN |
58 | :type 'symbol |
59 | :version "20.3") | |
bdb1c08f | 60 | |
1c4fe319 RS |
61 | (defcustom query-replace-skip-read-only nil |
62 | "*Non-nil means `query-replace' and friends ignore read-only matches." | |
63 | :type 'boolean | |
64 | :group 'matching | |
bf247b6e | 65 | :version "22.1") |
1c4fe319 | 66 | |
afd33362 JL |
67 | (defcustom query-replace-highlight t |
68 | "*Non-nil means to highlight matches during query replacement." | |
69 | :type 'boolean | |
70 | :group 'matching) | |
71 | ||
72 | (defcustom query-replace-lazy-highlight t | |
73 | "*Controls the lazy-highlighting during query replacements. | |
74 | When non-nil, all text in the buffer matching the current match | |
75 | is highlighted lazily using isearch lazy highlighting (see | |
76 | `lazy-highlight-initial-delay' and `lazy-highlight-interval')." | |
77 | :type 'boolean | |
78 | :group 'lazy-highlight | |
79 | :group 'matching | |
bf247b6e | 80 | :version "22.1") |
afd33362 JL |
81 | |
82 | (defface query-replace | |
83 | '((t (:inherit isearch))) | |
84 | "Face for highlighting query replacement matches." | |
85 | :group 'matching | |
bf247b6e | 86 | :version "22.1") |
afd33362 | 87 | |
6f1df6d9 SM |
88 | (defun query-replace-descr (string) |
89 | (mapconcat 'isearch-text-char-description string "")) | |
90 | ||
90c9fc2a | 91 | (defun query-replace-read-from (prompt regexp-flag) |
6f1df6d9 SM |
92 | "Query and return the `from' argument of a query-replace operation. |
93 | The return value can also be a pair (FROM . TO) indicating that the user | |
94 | wants to replace FROM with TO." | |
1606466a SM |
95 | (if query-replace-interactive |
96 | (car (if regexp-flag regexp-search-ring search-ring)) | |
6f1df6d9 SM |
97 | (let* ((lastfrom (car (symbol-value query-replace-from-history-variable))) |
98 | (lastto (car (symbol-value query-replace-to-history-variable))) | |
99 | (from | |
1606466a SM |
100 | ;; The save-excursion here is in case the user marks and copies |
101 | ;; a region in order to specify the minibuffer input. | |
102 | ;; That should not clobber the region for the query-replace itself. | |
103 | (save-excursion | |
6f1df6d9 SM |
104 | (when (equal lastfrom lastto) |
105 | ;; Typically, this is because the two histlists are shared. | |
106 | (setq lastfrom (cadr (symbol-value | |
107 | query-replace-from-history-variable)))) | |
1606466a | 108 | (read-from-minibuffer |
6f1df6d9 | 109 | (if (and lastto lastfrom) |
90c9fc2a | 110 | (format "%s (default %s -> %s): " prompt |
6f1df6d9 SM |
111 | (query-replace-descr lastfrom) |
112 | (query-replace-descr lastto)) | |
90c9fc2a | 113 | (format "%s: " prompt)) |
1606466a SM |
114 | nil nil nil |
115 | query-replace-from-history-variable | |
bbe9f175 | 116 | nil t t)))) |
6f1df6d9 | 117 | (if (and (zerop (length from)) lastto lastfrom) |
2511035d | 118 | (progn |
2511035d | 119 | (set query-replace-from-history-variable |
a0b497c5 LK |
120 | (cdr (symbol-value query-replace-from-history-variable))) |
121 | (cons lastfrom | |
122 | (query-replace-compile-replacement lastto regexp-flag))) | |
6f1df6d9 SM |
123 | ;; Warn if user types \n or \t, but don't reject the input. |
124 | (and regexp-flag | |
125 | (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\[nt]\\)" from) | |
126 | (let ((match (match-string 3 from))) | |
127 | (cond | |
128 | ((string= match "\\n") | |
129 | (message "Note: `\\n' here doesn't match a newline; to do that, type C-q C-j instead")) | |
130 | ((string= match "\\t") | |
131 | (message "Note: `\\t' here doesn't match a tab; to do that, just type TAB"))) | |
132 | (sit-for 2))) | |
133 | from)))) | |
1606466a | 134 | |
78629844 DK |
135 | (defun query-replace-compile-replacement (to regexp-flag) |
136 | "Maybe convert a regexp replacement TO to Lisp. | |
137 | Returns a list suitable for `perform-replace' if necessary, | |
138 | the original string if not." | |
139 | (if (and regexp-flag | |
140 | (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)) | |
7c1c02ac DK |
141 | (let (pos list char) |
142 | (while | |
143 | (progn | |
144 | (setq pos (match-end 0)) | |
145 | (push (substring to 0 (- pos 2)) list) | |
146 | (setq char (aref to (1- pos)) | |
147 | to (substring to pos)) | |
148 | (cond ((eq char ?\#) | |
149 | (push '(number-to-string replace-count) list)) | |
150 | ((eq char ?\,) | |
151 | (setq pos (read-from-string to)) | |
152 | (push `(replace-quote ,(car pos)) list) | |
9e5d1b63 RS |
153 | (let ((end |
154 | ;; Swallow a space after a symbol | |
155 | ;; if there is a space. | |
156 | (if (and (or (symbolp (car pos)) | |
157 | ;; Swallow a space after 'foo | |
158 | ;; but not after (quote foo). | |
159 | (and (eq (car-safe (car pos)) 'quote) | |
f1f6079c JL |
160 | (not (= ?\( (aref to 0))))) |
161 | (eq (string-match " " to (cdr pos)) | |
162 | (cdr pos))) | |
9e5d1b63 RS |
163 | (1+ (cdr pos)) |
164 | (cdr pos)))) | |
165 | (setq to (substring to end))))) | |
7c1c02ac | 166 | (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to))) |
78629844 DK |
167 | (setq to (nreverse (delete "" (cons to list)))) |
168 | (replace-match-string-symbols to) | |
169 | (cons 'replace-eval-replacement | |
170 | (if (cdr to) | |
171 | (cons 'concat to) | |
172 | (car to)))) | |
1606466a SM |
173 | to)) |
174 | ||
78629844 | 175 | |
90c9fc2a | 176 | (defun query-replace-read-to (from prompt regexp-flag) |
78629844 DK |
177 | "Query and return the `to' argument of a query-replace operation." |
178 | (query-replace-compile-replacement | |
179 | (save-excursion | |
180 | (read-from-minibuffer | |
90c9fc2a | 181 | (format "%s %s with: " prompt (query-replace-descr from)) |
78629844 | 182 | nil nil nil |
bbe9f175 | 183 | query-replace-to-history-variable from t t)) |
78629844 DK |
184 | regexp-flag)) |
185 | ||
90c9fc2a | 186 | (defun query-replace-read-args (prompt regexp-flag &optional noerror) |
1606466a SM |
187 | (unless noerror |
188 | (barf-if-buffer-read-only)) | |
90c9fc2a | 189 | (let* ((from (query-replace-read-from prompt regexp-flag)) |
6f1df6d9 | 190 | (to (if (consp from) (prog1 (cdr from) (setq from (car from))) |
90c9fc2a | 191 | (query-replace-read-to from prompt regexp-flag)))) |
10784bac | 192 | (list from to current-prefix-arg))) |
770970cb | 193 | |
47d72254 | 194 | (defun query-replace (from-string to-string &optional delimited start end) |
da44e784 RM |
195 | "Replace some occurrences of FROM-STRING with TO-STRING. |
196 | As each match is found, the user must type a character saying | |
197 | what to do with it. For directions, type \\[help-command] at that time. | |
198 | ||
7ef5c431 KH |
199 | In Transient Mark mode, if the mark is active, operate on the contents |
200 | of the region. Otherwise, operate from point to the end of the buffer. | |
201 | ||
151270f3 RS |
202 | If `query-replace-interactive' is non-nil, the last incremental search |
203 | string is used as FROM-STRING--you don't have to specify it with the | |
204 | minibuffer. | |
205 | ||
446d9629 RS |
206 | Matching is independent of case if `case-fold-search' is non-nil and |
207 | FROM-STRING has no uppercase letters. Replacement transfers the case | |
208 | pattern of the old text to the new text, if `case-replace' and | |
209 | `case-fold-search' are non-nil and FROM-STRING has no uppercase | |
210 | letters. \(Transferring the case pattern means that if the old text | |
211 | matched is all caps, or capitalized, then its replacement is upcased | |
212 | or capitalized.) | |
9b0bf2b6 | 213 | |
118a01c9 | 214 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
81bdc14d | 215 | only matches surrounded by word boundaries. |
47d72254 | 216 | Fourth and fifth arg START and END specify the region to operate on. |
81bdc14d RS |
217 | |
218 | To customize possible responses, change the \"bindings\" in `query-replace-map'." | |
10784bac | 219 | (interactive (let ((common |
10ddc30e | 220 | (query-replace-read-args |
f79bdb3a DN |
221 | (if (and transient-mark-mode mark-active) |
222 | "Query replace in region" | |
223 | "Query replace") | |
224 | nil))) | |
10784bac RS |
225 | (list (nth 0 common) (nth 1 common) (nth 2 common) |
226 | ;; These are done separately here | |
227 | ;; so that command-history will record these expressions | |
228 | ;; rather than the values they had this time. | |
229 | (if (and transient-mark-mode mark-active) | |
230 | (region-beginning)) | |
231 | (if (and transient-mark-mode mark-active) | |
232 | (region-end))))) | |
99a7559f | 233 | (perform-replace from-string to-string t nil delimited nil nil start end)) |
7ef5c431 | 234 | |
73fa8346 | 235 | (define-key esc-map "%" 'query-replace) |
da44e784 | 236 | |
47d72254 | 237 | (defun query-replace-regexp (regexp to-string &optional delimited start end) |
da44e784 RM |
238 | "Replace some things after point matching REGEXP with TO-STRING. |
239 | As each match is found, the user must type a character saying | |
240 | what to do with it. For directions, type \\[help-command] at that time. | |
241 | ||
7ef5c431 KH |
242 | In Transient Mark mode, if the mark is active, operate on the contents |
243 | of the region. Otherwise, operate from point to the end of the buffer. | |
244 | ||
151270f3 RS |
245 | If `query-replace-interactive' is non-nil, the last incremental search |
246 | regexp is used as REGEXP--you don't have to specify it with the | |
247 | minibuffer. | |
248 | ||
446d9629 RS |
249 | Matching is independent of case if `case-fold-search' is non-nil and |
250 | REGEXP has no uppercase letters. Replacement transfers the case | |
251 | pattern of the old text to the new text, if `case-replace' and | |
252 | `case-fold-search' are non-nil and REGEXP has no uppercase letters. | |
253 | \(Transferring the case pattern means that if the old text matched is | |
254 | all caps, or capitalized, then its replacement is upcased or | |
255 | capitalized.) | |
47d72254 | 256 | |
118a01c9 | 257 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 258 | only matches surrounded by word boundaries. |
47d72254 GM |
259 | Fourth and fifth arg START and END specify the region to operate on. |
260 | ||
118a01c9 RS |
261 | In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP, |
262 | and `\\=\\N' (where N is a digit) stands for | |
2f57bf85 | 263 | whatever what matched the Nth `\\(...\\)' in REGEXP. |
7c1c02ac DK |
264 | `\\?' lets you edit the replacement text in the minibuffer |
265 | at the given position for each replacement. | |
266 | ||
ba8d15f9 RS |
267 | In interactive calls, the replacement text can contain `\\,' |
268 | followed by a Lisp expression. Each | |
269 | replacement evaluates that expression to compute the replacement | |
270 | string. Inside of that expression, `\\&' is a string denoting the | |
f1f6079c | 271 | whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N' |
ba8d15f9 RS |
272 | for the whole or a partial match converted to a number with |
273 | `string-to-number', and `\\#' itself for the number of replacements | |
274 | done so far (starting with zero). | |
7c1c02ac | 275 | |
ba8d15f9 RS |
276 | If the replacement expression is a symbol, write a space after it |
277 | to terminate it. One space there, if any, will be discarded. | |
7c1c02ac DK |
278 | |
279 | When using those Lisp features interactively in the replacement | |
280 | text, TO-STRING is actually made a list instead of a string. | |
281 | Use \\[repeat-complex-command] after this command for details." | |
10784bac RS |
282 | (interactive |
283 | (let ((common | |
10ddc30e | 284 | (query-replace-read-args |
f79bdb3a DN |
285 | (if (and transient-mark-mode mark-active) |
286 | "Query replace regexp in region" | |
287 | "Query replace regexp") | |
288 | t))) | |
7c1c02ac DK |
289 | (list (nth 0 common) (nth 1 common) (nth 2 common) |
290 | ;; These are done separately here | |
291 | ;; so that command-history will record these expressions | |
292 | ;; rather than the values they had this time. | |
293 | (if (and transient-mark-mode mark-active) | |
294 | (region-beginning)) | |
295 | (if (and transient-mark-mode mark-active) | |
296 | (region-end))))) | |
99a7559f | 297 | (perform-replace regexp to-string t t delimited nil nil start end)) |
2f57bf85 | 298 | |
cbc127de | 299 | (define-key esc-map [?\C-%] 'query-replace-regexp) |
da44e784 | 300 | |
47d72254 | 301 | (defun query-replace-regexp-eval (regexp to-expr &optional delimited start end) |
84482eb3 RS |
302 | "Replace some things after point matching REGEXP with the result of TO-EXPR. |
303 | As each match is found, the user must type a character saying | |
304 | what to do with it. For directions, type \\[help-command] at that time. | |
305 | ||
306 | TO-EXPR is a Lisp expression evaluated to compute each replacement. It may | |
307 | reference `replace-count' to get the number of replacements already made. | |
308 | If the result of TO-EXPR is not a string, it is converted to one using | |
309 | `prin1-to-string' with the NOESCAPE argument (which see). | |
310 | ||
311 | For convenience, when entering TO-EXPR interactively, you can use `\\&' or | |
653479ad AS |
312 | `\\0' to stand for whatever matched the whole of REGEXP, and `\\N' (where |
313 | N is a digit) to stand for whatever matched the Nth `\\(...\\)' in REGEXP. | |
84482eb3 | 314 | Use `\\#&' or `\\#N' if you want a number instead of a string. |
2f57bf85 | 315 | In interactive use, `\\#' in itself stands for `replace-count'. |
84482eb3 RS |
316 | |
317 | In Transient Mark mode, if the mark is active, operate on the contents | |
318 | of the region. Otherwise, operate from point to the end of the buffer. | |
319 | ||
320 | If `query-replace-interactive' is non-nil, the last incremental search | |
321 | regexp is used as REGEXP--you don't have to specify it with the | |
322 | minibuffer. | |
323 | ||
324 | Preserves case in each replacement if `case-replace' and `case-fold-search' | |
325 | are non-nil and REGEXP has no uppercase letters. | |
47d72254 | 326 | |
84482eb3 | 327 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
470bbe9b | 328 | only matches that are surrounded by word boundaries. |
47d72254 | 329 | Fourth and fifth arg START and END specify the region to operate on." |
84482eb3 | 330 | (interactive |
cc0aea1a | 331 | (progn |
6f1df6d9 SM |
332 | (barf-if-buffer-read-only) |
333 | (let* ((from | |
334 | ;; Let-bind the history var to disable the "foo -> bar" default. | |
335 | ;; Maybe we shouldn't disable this default, but for now I'll | |
336 | ;; leave it off. --Stef | |
337 | (let ((query-replace-to-history-variable nil)) | |
338 | (query-replace-read-from "Query replace regexp" t))) | |
5291cbca | 339 | (to (list (read-from-minibuffer |
6f1df6d9 SM |
340 | (format "Query replace regexp %s with eval: " |
341 | (query-replace-descr from)) | |
5291cbca | 342 | nil nil t query-replace-to-history-variable from t)))) |
84482eb3 RS |
343 | ;; We make TO a list because replace-match-string-symbols requires one, |
344 | ;; and the user might enter a single token. | |
345 | (replace-match-string-symbols to) | |
10784bac RS |
346 | (list from (car to) current-prefix-arg |
347 | (if (and transient-mark-mode mark-active) | |
348 | (region-beginning)) | |
349 | (if (and transient-mark-mode mark-active) | |
cc0aea1a | 350 | (region-end)))))) |
d2ce3151 | 351 | (perform-replace regexp (cons 'replace-eval-replacement to-expr) |
d83a97ab | 352 | t 'literal delimited nil nil start end)) |
84482eb3 | 353 | |
47d72254 | 354 | (defun map-query-replace-regexp (regexp to-strings &optional n start end) |
da44e784 | 355 | "Replace some matches for REGEXP with various strings, in rotation. |
e730be7f DL |
356 | The second argument TO-STRINGS contains the replacement strings, |
357 | separated by spaces. Third arg DELIMITED (prefix arg if interactive), | |
358 | if non-nil, means replace only matches surrounded by word boundaries. | |
359 | This command works like `query-replace-regexp' except that each | |
360 | successive replacement uses the next successive replacement string, | |
da44e784 RM |
361 | wrapping around from the last such string to the first. |
362 | ||
7ef5c431 KH |
363 | In Transient Mark mode, if the mark is active, operate on the contents |
364 | of the region. Otherwise, operate from point to the end of the buffer. | |
365 | ||
da44e784 RM |
366 | Non-interactively, TO-STRINGS may be a list of replacement strings. |
367 | ||
151270f3 RS |
368 | If `query-replace-interactive' is non-nil, the last incremental search |
369 | regexp is used as REGEXP--you don't have to specify it with the minibuffer. | |
370 | ||
da44e784 | 371 | A prefix argument N says to use each replacement string N times |
47d72254 GM |
372 | before rotating to the next. |
373 | Fourth and fifth arg START and END specify the region to operate on." | |
770970cb | 374 | (interactive |
5291cbca | 375 | (let* ((from (if query-replace-interactive |
151270f3 RS |
376 | (car regexp-search-ring) |
377 | (read-from-minibuffer "Map query replace (regexp): " | |
378 | nil nil nil | |
fce31d51 | 379 | 'query-replace-history nil t))) |
5291cbca | 380 | (to (read-from-minibuffer |
770970cb | 381 | (format "Query replace %s with (space-separated strings): " |
6f1df6d9 | 382 | (query-replace-descr from)) |
770970cb | 383 | nil nil nil |
5291cbca | 384 | 'query-replace-history from t))) |
2f2f7e58 RS |
385 | (list from to |
386 | (and current-prefix-arg | |
387 | (prefix-numeric-value current-prefix-arg)) | |
10784bac RS |
388 | (if (and transient-mark-mode mark-active) |
389 | (region-beginning)) | |
390 | (if (and transient-mark-mode mark-active) | |
391 | (region-end))))) | |
da44e784 RM |
392 | (let (replacements) |
393 | (if (listp to-strings) | |
394 | (setq replacements to-strings) | |
395 | (while (/= (length to-strings) 0) | |
396 | (if (string-match " " to-strings) | |
397 | (setq replacements | |
398 | (append replacements | |
399 | (list (substring to-strings 0 | |
400 | (string-match " " to-strings)))) | |
401 | to-strings (substring to-strings | |
402 | (1+ (string-match " " to-strings)))) | |
403 | (setq replacements (append replacements (list to-strings)) | |
404 | to-strings "")))) | |
99a7559f | 405 | (perform-replace regexp replacements t t nil n nil start end))) |
da44e784 | 406 | |
47d72254 | 407 | (defun replace-string (from-string to-string &optional delimited start end) |
da44e784 RM |
408 | "Replace occurrences of FROM-STRING with TO-STRING. |
409 | Preserve case in each match if `case-replace' and `case-fold-search' | |
410 | are non-nil and FROM-STRING has no uppercase letters. | |
9b0bf2b6 RS |
411 | \(Preserving case means that if the string matched is all caps, or capitalized, |
412 | then its replacement is upcased or capitalized.) | |
413 | ||
7ef5c431 KH |
414 | In Transient Mark mode, if the mark is active, operate on the contents |
415 | of the region. Otherwise, operate from point to the end of the buffer. | |
416 | ||
118a01c9 | 417 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 418 | only matches surrounded by word boundaries. |
47d72254 | 419 | Fourth and fifth arg START and END specify the region to operate on. |
da44e784 | 420 | |
151270f3 RS |
421 | If `query-replace-interactive' is non-nil, the last incremental search |
422 | string is used as FROM-STRING--you don't have to specify it with the | |
423 | minibuffer. | |
424 | ||
da44e784 RM |
425 | This function is usually the wrong thing to use in a Lisp program. |
426 | What you probably want is a loop like this: | |
118a01c9 RS |
427 | (while (search-forward FROM-STRING nil t) |
428 | (replace-match TO-STRING nil t)) | |
87532fbe RS |
429 | which will run faster and will not set the mark or print anything. |
430 | \(You may need a more complex loop if FROM-STRING can match the null string | |
431 | and TO-STRING is also null.)" | |
10784bac RS |
432 | (interactive |
433 | (let ((common | |
10ddc30e | 434 | (query-replace-read-args |
f79bdb3a DN |
435 | (if (and transient-mark-mode mark-active) |
436 | "Replace string in region" | |
437 | "Replace string") | |
438 | nil))) | |
10784bac RS |
439 | (list (nth 0 common) (nth 1 common) (nth 2 common) |
440 | (if (and transient-mark-mode mark-active) | |
441 | (region-beginning)) | |
442 | (if (and transient-mark-mode mark-active) | |
443 | (region-end))))) | |
99a7559f | 444 | (perform-replace from-string to-string nil nil delimited nil nil start end)) |
da44e784 | 445 | |
47d72254 | 446 | (defun replace-regexp (regexp to-string &optional delimited start end) |
da44e784 | 447 | "Replace things after point matching REGEXP with TO-STRING. |
118a01c9 | 448 | Preserve case in each match if `case-replace' and `case-fold-search' |
da44e784 | 449 | are non-nil and REGEXP has no uppercase letters. |
47d72254 GM |
450 | |
451 | In Transient Mark mode, if the mark is active, operate on the contents | |
452 | of the region. Otherwise, operate from point to the end of the buffer. | |
453 | ||
118a01c9 | 454 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 455 | only matches surrounded by word boundaries. |
47d72254 GM |
456 | Fourth and fifth arg START and END specify the region to operate on. |
457 | ||
118a01c9 RS |
458 | In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP, |
459 | and `\\=\\N' (where N is a digit) stands for | |
7c1c02ac DK |
460 | whatever what matched the Nth `\\(...\\)' in REGEXP. |
461 | `\\?' lets you edit the replacement text in the minibuffer | |
462 | at the given position for each replacement. | |
463 | ||
464 | In interactive calls, the replacement text may contain `\\,' | |
465 | followed by a Lisp expression used as part of the replacement | |
466 | text. Inside of that expression, `\\&' is a string denoting the | |
467 | whole match, `\\N' a partial matches, `\\#&' and `\\#N' the | |
468 | respective numeric values from `string-to-number', and `\\#' | |
469 | itself for `replace-count', the number of replacements occured so | |
470 | far. | |
471 | ||
472 | If your Lisp expression is an identifier and the next letter in | |
473 | the replacement string would be interpreted as part of it, you | |
474 | can wrap it with an expression like `\\,(or \\#)'. Incidentally, | |
475 | for this particular case you may also enter `\\#' in the | |
476 | replacement text directly. | |
477 | ||
478 | When using those Lisp features interactively in the replacement | |
479 | text, TO-STRING is actually made a list instead of a string. | |
480 | Use \\[repeat-complex-command] after this command for details. | |
da44e784 | 481 | |
151270f3 RS |
482 | If `query-replace-interactive' is non-nil, the last incremental search |
483 | regexp is used as REGEXP--you don't have to specify it with the minibuffer. | |
484 | ||
da44e784 RM |
485 | This function is usually the wrong thing to use in a Lisp program. |
486 | What you probably want is a loop like this: | |
487 | (while (re-search-forward REGEXP nil t) | |
118a01c9 | 488 | (replace-match TO-STRING nil nil)) |
da44e784 | 489 | which will run faster and will not set the mark or print anything." |
10784bac RS |
490 | (interactive |
491 | (let ((common | |
10ddc30e | 492 | (query-replace-read-args |
f79bdb3a | 493 | (if (and transient-mark-mode mark-active) |
10ddc30e KS |
494 | "Replace regexp in region" |
495 | "Replace regexp") | |
f79bdb3a | 496 | t))) |
10784bac RS |
497 | (list (nth 0 common) (nth 1 common) (nth 2 common) |
498 | (if (and transient-mark-mode mark-active) | |
499 | (region-beginning)) | |
500 | (if (and transient-mark-mode mark-active) | |
501 | (region-end))))) | |
99a7559f | 502 | (perform-replace regexp to-string nil t delimited nil nil start end)) |
e32eb3e6 | 503 | |
4c53bd2b RS |
504 | \f |
505 | (defvar regexp-history nil | |
506 | "History list for some commands that read regular expressions.") | |
da44e784 | 507 | |
e32eb3e6 | 508 | |
31e1d920 | 509 | (defalias 'delete-non-matching-lines 'keep-lines) |
e32eb3e6 GM |
510 | (defalias 'delete-matching-lines 'flush-lines) |
511 | (defalias 'count-matches 'how-many) | |
512 | ||
513 | ||
514 | (defun keep-lines-read-args (prompt) | |
515 | "Read arguments for `keep-lines' and friends. | |
516 | Prompt for a regexp with PROMPT. | |
2ced751f RS |
517 | Value is a list, (REGEXP)." |
518 | (list (read-from-minibuffer prompt nil nil nil | |
bace7209 LT |
519 | 'regexp-history nil t) |
520 | nil nil t)) | |
e32eb3e6 | 521 | |
bace7209 | 522 | (defun keep-lines (regexp &optional rstart rend interactive) |
698e1804 RS |
523 | "Delete all lines except those containing matches for REGEXP. |
524 | A match split across lines preserves all the lines it lies in. | |
bace7209 LT |
525 | When called from Lisp (and usually interactively as well, see below) |
526 | applies to all lines starting after point. | |
d2a0ee8b RS |
527 | |
528 | If REGEXP contains upper case characters (excluding those preceded by `\\'), | |
e32eb3e6 GM |
529 | the matching is case-sensitive. |
530 | ||
531 | Second and third arg RSTART and REND specify the region to operate on. | |
bace7209 LT |
532 | This command operates on (the accessible part of) all lines whose |
533 | accessible part is entirely contained in the region determined by RSTART | |
534 | and REND. (A newline ending a line counts as part of that line.) | |
e32eb3e6 | 535 | |
2ced751f | 536 | Interactively, in Transient Mark mode when the mark is active, operate |
bace7209 LT |
537 | on all lines whose accessible part is entirely contained in the region. |
538 | Otherwise, the command applies to all lines starting after point. | |
539 | When calling this function from Lisp, you can pretend that it was | |
540 | called interactively by passing a non-nil INTERACTIVE argument. | |
541 | ||
542 | This function starts looking for the next match from the end of | |
543 | the previous match. Hence, it ignores matches that overlap | |
544 | a previously found match." | |
2ced751f | 545 | |
e32eb3e6 | 546 | (interactive |
98faf1bb RS |
547 | (progn |
548 | (barf-if-buffer-read-only) | |
549 | (keep-lines-read-args "Keep lines (containing match for regexp): "))) | |
e32eb3e6 | 550 | (if rstart |
119831da RS |
551 | (progn |
552 | (goto-char (min rstart rend)) | |
bace7209 LT |
553 | (setq rend |
554 | (progn | |
555 | (save-excursion | |
556 | (goto-char (max rstart rend)) | |
557 | (unless (or (bolp) (eobp)) | |
558 | (forward-line 0)) | |
559 | (point-marker))))) | |
560 | (if (and interactive transient-mark-mode mark-active) | |
2ced751f | 561 | (setq rstart (region-beginning) |
bace7209 LT |
562 | rend (progn |
563 | (goto-char (region-end)) | |
564 | (unless (or (bolp) (eobp)) | |
565 | (forward-line 0)) | |
566 | (point-marker))) | |
2ced751f RS |
567 | (setq rstart (point) |
568 | rend (point-max-marker))) | |
569 | (goto-char rstart)) | |
698e1804 RS |
570 | (save-excursion |
571 | (or (bolp) (forward-line 1)) | |
d2a0ee8b RS |
572 | (let ((start (point)) |
573 | (case-fold-search (and case-fold-search | |
574 | (isearch-no-upper-case-p regexp t)))) | |
e32eb3e6 | 575 | (while (< (point) rend) |
698e1804 | 576 | ;; Start is first char not preserved by previous match. |
e32eb3e6 GM |
577 | (if (not (re-search-forward regexp rend 'move)) |
578 | (delete-region start rend) | |
698e1804 | 579 | (let ((end (save-excursion (goto-char (match-beginning 0)) |
bace7209 | 580 | (forward-line 0) |
698e1804 RS |
581 | (point)))) |
582 | ;; Now end is first char preserved by the new match. | |
583 | (if (< start end) | |
584 | (delete-region start end)))) | |
d99118b0 | 585 | |
e32eb3e6 | 586 | (setq start (save-excursion (forward-line 1) (point))) |
698e1804 | 587 | ;; If the match was empty, avoid matching again at same place. |
e32eb3e6 GM |
588 | (and (< (point) rend) |
589 | (= (match-beginning 0) (match-end 0)) | |
bace7209 LT |
590 | (forward-char 1))))) |
591 | (set-marker rend nil) | |
592 | nil) | |
698e1804 | 593 | |
e32eb3e6 | 594 | |
bace7209 LT |
595 | (defun flush-lines (regexp &optional rstart rend interactive) |
596 | "Delete lines containing matches for REGEXP. | |
597 | When called from Lisp (and usually when called interactively as | |
598 | well, see below), applies to the part of the buffer after point. | |
599 | The line point is in is deleted if and only if it contains a | |
600 | match for regexp starting after point. | |
d2a0ee8b RS |
601 | |
602 | If REGEXP contains upper case characters (excluding those preceded by `\\'), | |
e32eb3e6 GM |
603 | the matching is case-sensitive. |
604 | ||
605 | Second and third arg RSTART and REND specify the region to operate on. | |
bace7209 LT |
606 | Lines partially contained in this region are deleted if and only if |
607 | they contain a match entirely contained in it. | |
e32eb3e6 | 608 | |
2ced751f RS |
609 | Interactively, in Transient Mark mode when the mark is active, operate |
610 | on the contents of the region. Otherwise, operate from point to the | |
bace7209 LT |
611 | end of (the accessible portion of) the buffer. When calling this function |
612 | from Lisp, you can pretend that it was called interactively by passing | |
613 | a non-nil INTERACTIVE argument. | |
614 | ||
615 | If a match is split across lines, all the lines it lies in are deleted. | |
616 | They are deleted _before_ looking for the next match. Hence, a match | |
617 | starting on the same line at which another match ended is ignored." | |
2ced751f | 618 | |
e32eb3e6 | 619 | (interactive |
98faf1bb RS |
620 | (progn |
621 | (barf-if-buffer-read-only) | |
622 | (keep-lines-read-args "Flush lines (containing match for regexp): "))) | |
e32eb3e6 | 623 | (if rstart |
119831da RS |
624 | (progn |
625 | (goto-char (min rstart rend)) | |
626 | (setq rend (copy-marker (max rstart rend)))) | |
bace7209 | 627 | (if (and interactive transient-mark-mode mark-active) |
2ced751f RS |
628 | (setq rstart (region-beginning) |
629 | rend (copy-marker (region-end))) | |
630 | (setq rstart (point) | |
631 | rend (point-max-marker))) | |
632 | (goto-char rstart)) | |
d2a0ee8b RS |
633 | (let ((case-fold-search (and case-fold-search |
634 | (isearch-no-upper-case-p regexp t)))) | |
635 | (save-excursion | |
e32eb3e6 GM |
636 | (while (and (< (point) rend) |
637 | (re-search-forward regexp rend t)) | |
d2a0ee8b | 638 | (delete-region (save-excursion (goto-char (match-beginning 0)) |
bace7209 | 639 | (forward-line 0) |
d2a0ee8b | 640 | (point)) |
bace7209 LT |
641 | (progn (forward-line 1) (point)))))) |
642 | (set-marker rend nil) | |
643 | nil) | |
698e1804 | 644 | |
e32eb3e6 | 645 | |
bace7209 LT |
646 | (defun how-many (regexp &optional rstart rend interactive) |
647 | "Print and return number of matches for REGEXP following point. | |
648 | When called from Lisp and INTERACTIVE is omitted or nil, just return | |
649 | the number, do not print it; if INTERACTIVE is t, the function behaves | |
650 | in all respects has if it had been called interactively. | |
d2a0ee8b RS |
651 | |
652 | If REGEXP contains upper case characters (excluding those preceded by `\\'), | |
e32eb3e6 GM |
653 | the matching is case-sensitive. |
654 | ||
655 | Second and third arg RSTART and REND specify the region to operate on. | |
656 | ||
2ced751f RS |
657 | Interactively, in Transient Mark mode when the mark is active, operate |
658 | on the contents of the region. Otherwise, operate from point to the | |
bace7209 LT |
659 | end of (the accessible portion of) the buffer. |
660 | ||
661 | This function starts looking for the next match from the end of | |
662 | the previous match. Hence, it ignores matches that overlap | |
663 | a previously found match." | |
2ced751f | 664 | |
e32eb3e6 GM |
665 | (interactive |
666 | (keep-lines-read-args "How many matches for (regexp): ")) | |
f601efb0 SM |
667 | (save-excursion |
668 | (if rstart | |
bace7209 LT |
669 | (progn |
670 | (goto-char (min rstart rend)) | |
671 | (setq rend (max rstart rend))) | |
672 | (if (and interactive transient-mark-mode mark-active) | |
2ced751f | 673 | (setq rstart (region-beginning) |
bace7209 | 674 | rend (region-end)) |
2ced751f | 675 | (setq rstart (point) |
bace7209 | 676 | rend (point-max))) |
2ced751f | 677 | (goto-char rstart)) |
f601efb0 SM |
678 | (let ((count 0) |
679 | opoint | |
680 | (case-fold-search (and case-fold-search | |
681 | (isearch-no-upper-case-p regexp t)))) | |
682 | (while (and (< (point) rend) | |
683 | (progn (setq opoint (point)) | |
684 | (re-search-forward regexp rend t))) | |
685 | (if (= opoint (point)) | |
686 | (forward-char 1) | |
687 | (setq count (1+ count)))) | |
bace7209 LT |
688 | (when interactive (message "%d occurrence%s" |
689 | count | |
690 | (if (= count 1) "" "s"))) | |
691 | count))) | |
e32eb3e6 | 692 | |
4c53bd2b | 693 | \f |
f601efb0 SM |
694 | (defvar occur-mode-map |
695 | (let ((map (make-sparse-keymap))) | |
696 | (define-key map [mouse-2] 'occur-mode-mouse-goto) | |
697 | (define-key map "\C-c\C-c" 'occur-mode-goto-occurrence) | |
698 | (define-key map "\C-m" 'occur-mode-goto-occurrence) | |
daae70bf | 699 | (define-key map "o" 'occur-mode-goto-occurrence-other-window) |
365486d6 | 700 | (define-key map "\C-o" 'occur-mode-display-occurrence) |
f601efb0 SM |
701 | (define-key map "\M-n" 'occur-next) |
702 | (define-key map "\M-p" 'occur-prev) | |
d99118b0 SS |
703 | (define-key map "r" 'occur-rename-buffer) |
704 | (define-key map "c" 'clone-buffer) | |
f601efb0 | 705 | (define-key map "g" 'revert-buffer) |
d99118b0 SS |
706 | (define-key map "q" 'quit-window) |
707 | (define-key map "z" 'kill-this-buffer) | |
b938735a | 708 | (define-key map "\C-c\C-f" 'next-error-follow-minor-mode) |
f601efb0 SM |
709 | map) |
710 | "Keymap for `occur-mode'.") | |
698e1804 | 711 | |
46b3d18e RS |
712 | (defvar occur-revert-arguments nil |
713 | "Arguments to pass to `occur-1' to revert an Occur mode buffer. | |
714 | See `occur-revert-function'.") | |
698e1804 | 715 | |
c9ae8cbb JB |
716 | (defcustom occur-mode-hook '(turn-on-font-lock) |
717 | "Hook run when entering Occur mode." | |
718 | :type 'hook | |
719 | :group 'matching) | |
720 | ||
721 | (defcustom occur-hook nil | |
c7d2f2cc | 722 | "Hook run by Occur when there are any matches." |
daae70bf CW |
723 | :type 'hook |
724 | :group 'matching) | |
725 | ||
de3c9b09 | 726 | (put 'occur-mode 'mode-class 'special) |
505847d4 | 727 | (defun occur-mode () |
698e1804 | 728 | "Major mode for output from \\[occur]. |
0081c8a1 RS |
729 | \\<occur-mode-map>Move point to one of the items in this buffer, then use |
730 | \\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to. | |
731 | Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it. | |
732 | ||
698e1804 | 733 | \\{occur-mode-map}" |
ce8b7b9f | 734 | (interactive) |
505847d4 RS |
735 | (kill-all-local-variables) |
736 | (use-local-map occur-mode-map) | |
737 | (setq major-mode 'occur-mode) | |
738 | (setq mode-name "Occur") | |
f601efb0 | 739 | (set (make-local-variable 'revert-buffer-function) 'occur-revert-function) |
c9ae8cbb | 740 | (make-local-variable 'occur-revert-arguments) |
fbefbe33 | 741 | (add-hook 'change-major-mode-hook 'font-lock-defontify nil t) |
423e4de7 | 742 | (setq next-error-function 'occur-next-error) |
92e9557c | 743 | (run-mode-hooks 'occur-mode-hook)) |
698e1804 | 744 | |
a41284da | 745 | (defun occur-revert-function (ignore1 ignore2) |
46b3d18e | 746 | "Handle `revert-buffer' for Occur mode buffers." |
e1690783 | 747 | (apply 'occur-1 (append occur-revert-arguments (list (buffer-name))))) |
a41284da | 748 | |
78bead73 RS |
749 | (defun occur-mode-mouse-goto (event) |
750 | "In Occur mode, go to the occurrence whose line you click on." | |
751 | (interactive "e") | |
46b3d18e | 752 | (let (pos) |
78bead73 RS |
753 | (save-excursion |
754 | (set-buffer (window-buffer (posn-window (event-end event)))) | |
755 | (save-excursion | |
756 | (goto-char (posn-point (event-end event))) | |
46b3d18e | 757 | (setq pos (occur-mode-find-occurrence)))) |
932af01b | 758 | (switch-to-buffer-other-window (marker-buffer pos)) |
46b3d18e | 759 | (goto-char pos))) |
78bead73 RS |
760 | |
761 | (defun occur-mode-find-occurrence () | |
46b3d18e RS |
762 | (let ((pos (get-text-property (point) 'occur-target))) |
763 | (unless pos | |
68608d9c | 764 | (error "No occurrence on this line")) |
46b3d18e RS |
765 | (unless (buffer-live-p (marker-buffer pos)) |
766 | (error "Buffer for this occurrence was killed")) | |
767 | pos)) | |
78bead73 RS |
768 | |
769 | (defun occur-mode-goto-occurrence () | |
770 | "Go to the occurrence the current line describes." | |
771 | (interactive) | |
46b3d18e | 772 | (let ((pos (occur-mode-find-occurrence))) |
932af01b | 773 | (switch-to-buffer (marker-buffer pos)) |
46b3d18e | 774 | (goto-char pos))) |
8d15583f | 775 | |
029024e2 RS |
776 | (defun occur-mode-goto-occurrence-other-window () |
777 | "Go to the occurrence the current line describes, in another window." | |
778 | (interactive) | |
46b3d18e RS |
779 | (let ((pos (occur-mode-find-occurrence))) |
780 | (switch-to-buffer-other-window (marker-buffer pos)) | |
781 | (goto-char pos))) | |
029024e2 | 782 | |
365486d6 RS |
783 | (defun occur-mode-display-occurrence () |
784 | "Display in another window the occurrence the current line describes." | |
785 | (interactive) | |
46b3d18e RS |
786 | (let ((pos (occur-mode-find-occurrence)) |
787 | window | |
788 | ;; Bind these to ensure `display-buffer' puts it in another window. | |
365486d6 | 789 | same-window-buffer-names |
46b3d18e RS |
790 | same-window-regexps) |
791 | (setq window (display-buffer (marker-buffer pos))) | |
365486d6 RS |
792 | ;; This is the way to set point in the proper window. |
793 | (save-selected-window | |
794 | (select-window window) | |
46b3d18e | 795 | (goto-char pos)))) |
365486d6 | 796 | |
123d5548 | 797 | (defun occur-find-match (n search message) |
8d15583f RS |
798 | (if (not n) (setq n 1)) |
799 | (let ((r)) | |
800 | (while (> n 0) | |
123d5548 JB |
801 | (setq r (funcall search (point) 'occur-match)) |
802 | (and r | |
803 | (get-text-property r 'occur-match) | |
804 | (setq r (funcall search r 'occur-match))) | |
8d15583f | 805 | (if r |
123d5548 JB |
806 | (goto-char r) |
807 | (error message)) | |
8d15583f RS |
808 | (setq n (1- n))))) |
809 | ||
123d5548 JB |
810 | (defun occur-next (&optional n) |
811 | "Move to the Nth (default 1) next match in an Occur mode buffer." | |
812 | (interactive "p") | |
813 | (occur-find-match n #'next-single-property-change "No more matches")) | |
814 | ||
8d15583f | 815 | (defun occur-prev (&optional n) |
46b3d18e | 816 | "Move to the Nth (default 1) previous match in an Occur mode buffer." |
8d15583f | 817 | (interactive "p") |
123d5548 | 818 | (occur-find-match n #'previous-single-property-change "No earlier matches")) |
423e4de7 KS |
819 | |
820 | (defun occur-next-error (&optional argp reset) | |
821 | "Move to the Nth (default 1) next match in an Occur mode buffer. | |
822 | Compatibility function for \\[next-error] invocations." | |
823 | (interactive "p") | |
5f9e0ca5 | 824 | ;; we need to run occur-find-match from within the Occur buffer |
f1f007dc | 825 | (with-current-buffer |
f42a241b | 826 | ;; Choose the buffer and make it current. |
5f9e0ca5 TZ |
827 | (if (next-error-buffer-p (current-buffer)) |
828 | (current-buffer) | |
f42a241b RS |
829 | (next-error-find-buffer nil nil |
830 | (lambda () | |
831 | (eq major-mode 'occur-mode)))) | |
f1f007dc JL |
832 | |
833 | (goto-char (cond (reset (point-min)) | |
834 | ((< argp 0) (line-beginning-position)) | |
835 | ((line-end-position)))) | |
5f9e0ca5 | 836 | (occur-find-match |
f1f007dc JL |
837 | (abs argp) |
838 | (if (> 0 argp) | |
5f9e0ca5 TZ |
839 | #'previous-single-property-change |
840 | #'next-single-property-change) | |
841 | "No more matches") | |
842 | ;; In case the *Occur* buffer is visible in a nonselected window. | |
843 | (set-window-point (get-buffer-window (current-buffer)) (point)) | |
844 | (occur-mode-goto-occurrence))) | |
4c53bd2b | 845 | \f |
aaaecfcd JL |
846 | (defface match |
847 | '((((class color) (min-colors 88) (background light)) | |
848 | :background "Tan") | |
849 | (((class color) (min-colors 88) (background dark)) | |
4bc30b74 | 850 | :background "RoyalBlue3") |
aaaecfcd JL |
851 | (((class color) (min-colors 8)) |
852 | :background "blue" :foreground "white") | |
853 | (((type tty) (class mono)) | |
854 | :inverse-video t) | |
855 | (t :background "gray")) | |
856 | "Face used to highlight matches permanently." | |
857 | :group 'matching | |
bf247b6e | 858 | :version "22.1") |
aaaecfcd | 859 | |
9d325ebf | 860 | (defcustom list-matching-lines-default-context-lines 0 |
e730be7f DL |
861 | "*Default number of context lines included around `list-matching-lines' matches. |
862 | A negative number means to include that many lines before the match. | |
9d325ebf RS |
863 | A positive number means to include that many lines both before and after." |
864 | :type 'integer | |
865 | :group 'matching) | |
698e1804 | 866 | |
31e1d920 | 867 | (defalias 'list-matching-lines 'occur) |
698e1804 | 868 | |
aaaecfcd | 869 | (defcustom list-matching-lines-face 'match |
e730be7f | 870 | "*Face used by \\[list-matching-lines] to show the text that matches. |
68608d9c CW |
871 | If the value is nil, don't highlight the matching portions specially." |
872 | :type 'face | |
873 | :group 'matching) | |
874 | ||
875 | (defcustom list-matching-lines-buffer-name-face 'underline | |
876 | "*Face used by \\[list-matching-lines] to show the names of buffers. | |
877 | If the value is nil, don't highlight the buffer names specially." | |
878 | :type 'face | |
879 | :group 'matching) | |
880 | ||
8b363e6f JL |
881 | (defcustom occur-excluded-properties |
882 | '(read-only invisible intangible field mouse-face help-echo local-map keymap | |
883 | yank-handler follow-link) | |
884 | "*Text properties to discard when copying lines to the *Occur* buffer. | |
885 | The value should be a list of text properties to discard or t, | |
886 | which means to discard all text properties." | |
887 | :type '(choice (const :tag "All" t) (repeat symbol)) | |
888 | :group 'matching | |
889 | :version "22.1") | |
890 | ||
2f4e3f7a | 891 | (defun occur-accumulate-lines (count &optional keep-props) |
68608d9c CW |
892 | (save-excursion |
893 | (let ((forwardp (> count 0)) | |
f1f007dc | 894 | result beg end) |
68608d9c CW |
895 | (while (not (or (zerop count) |
896 | (if forwardp | |
897 | (eobp) | |
898 | (bobp)))) | |
b0523087 | 899 | (setq count (+ count (if forwardp -1 1))) |
f1f007dc JL |
900 | (setq beg (line-beginning-position) |
901 | end (line-end-position)) | |
99769096 | 902 | (if (and keep-props (if (boundp 'jit-lock-mode) jit-lock-mode) |
f1f007dc | 903 | (text-property-not-all beg end 'fontified t)) |
99769096 RS |
904 | (if (fboundp 'jit-lock-fontify-now) |
905 | (jit-lock-fontify-now beg end))) | |
68608d9c | 906 | (push |
8b363e6f JL |
907 | (if (and keep-props (not (eq occur-excluded-properties t))) |
908 | (let ((str (buffer-substring beg end))) | |
909 | (remove-list-of-text-properties | |
910 | 0 (length str) occur-excluded-properties str) | |
911 | str) | |
912 | (buffer-substring-no-properties beg end)) | |
68608d9c CW |
913 | result) |
914 | (forward-line (if forwardp 1 -1))) | |
915 | (nreverse result)))) | |
916 | ||
917 | (defun occur-read-primary-args () | |
918 | (list (let* ((default (car regexp-history)) | |
919 | (input | |
920 | (read-from-minibuffer | |
921 | (if default | |
5b76833f | 922 | (format "List lines matching regexp (default %s): " |
6f1df6d9 | 923 | (query-replace-descr default)) |
68608d9c CW |
924 | "List lines matching regexp: ") |
925 | nil | |
926 | nil | |
927 | nil | |
442a68c7 RS |
928 | 'regexp-history |
929 | default))) | |
68608d9c CW |
930 | (if (equal input "") |
931 | default | |
932 | input)) | |
bda1925e CW |
933 | (when current-prefix-arg |
934 | (prefix-numeric-value current-prefix-arg)))) | |
c9daced0 | 935 | |
a653724b | 936 | (defun occur-rename-buffer (&optional unique-p interactive-p) |
d99118b0 | 937 | "Rename the current *Occur* buffer to *Occur: original-buffer-name*. |
a653724b JB |
938 | Here `original-buffer-name' is the buffer name were Occur was originally run. |
939 | When given the prefix argument, or called non-interactively, the renaming | |
940 | will not clobber the existing buffer(s) of that name, but use | |
941 | `generate-new-buffer-name' instead. You can add this to `occur-hook' | |
942 | if you always want a separate *Occur* buffer for each buffer where you | |
943 | invoke `occur'." | |
944 | (interactive "P\np") | |
d99118b0 SS |
945 | (with-current-buffer |
946 | (if (eq major-mode 'occur-mode) (current-buffer) (get-buffer "*Occur*")) | |
947 | (rename-buffer (concat "*Occur: " | |
948 | (mapconcat #'buffer-name | |
949 | (car (cddr occur-revert-arguments)) "/") | |
950 | "*") | |
a653724b | 951 | (or unique-p (not interactive-p))))) |
d99118b0 | 952 | |
698e1804 | 953 | (defun occur (regexp &optional nlines) |
99976f85 | 954 | "Show all lines in the current buffer containing a match for REGEXP. |
bace7209 | 955 | This function can not handle matches that span more than one line. |
698e1804 | 956 | |
da44e784 RM |
957 | Each line is displayed with NLINES lines before and after, or -NLINES |
958 | before if NLINES is negative. | |
959 | NLINES defaults to `list-matching-lines-default-context-lines'. | |
698e1804 RS |
960 | Interactively it is the prefix arg. |
961 | ||
4c53bd2b | 962 | The lines are shown in a buffer named `*Occur*'. |
698e1804 | 963 | It serves as a menu to find any of the occurrences in this buffer. |
de3c9b09 | 964 | \\<occur-mode-map>\\[describe-mode] in that buffer will explain how. |
9483d601 | 965 | |
de3c9b09 RS |
966 | If REGEXP contains upper case characters (excluding those preceded by `\\'), |
967 | the matching is case-sensitive." | |
68608d9c CW |
968 | (interactive (occur-read-primary-args)) |
969 | (occur-1 regexp nlines (list (current-buffer)))) | |
970 | ||
971 | (defun multi-occur (bufs regexp &optional nlines) | |
972 | "Show all lines in buffers BUFS containing a match for REGEXP. | |
973 | This function acts on multiple buffers; otherwise, it is exactly like | |
974 | `occur'." | |
a5dfed3e | 975 | (interactive |
68608d9c | 976 | (cons |
52698d45 KS |
977 | (let* ((bufs (list (read-buffer "First buffer to search: " |
978 | (current-buffer) t))) | |
979 | (buf nil) | |
980 | (ido-ignore-item-temp-list bufs)) | |
68608d9c | 981 | (while (not (string-equal |
f1180544 | 982 | (setq buf (read-buffer |
52698d45 KS |
983 | (if (eq read-buffer-function 'ido-read-buffer) |
984 | "Next buffer to search (C-j to end): " | |
985 | "Next buffer to search (RET to end): ") | |
986 | nil t)) | |
68608d9c | 987 | "")) |
52698d45 KS |
988 | (add-to-list 'bufs buf) |
989 | (setq ido-ignore-item-temp-list bufs)) | |
68608d9c CW |
990 | (nreverse (mapcar #'get-buffer bufs))) |
991 | (occur-read-primary-args))) | |
992 | (occur-1 regexp nlines bufs)) | |
993 | ||
994 | (defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines) | |
04fe158a | 995 | "Show all lines matching REGEXP in buffers named by BUFREGEXP. |
68608d9c CW |
996 | See also `multi-occur'." |
997 | (interactive | |
998 | (cons | |
999 | (let* ((default (car regexp-history)) | |
1000 | (input | |
1001 | (read-from-minibuffer | |
1002 | "List lines in buffers whose filename matches regexp: " | |
1003 | nil | |
1004 | nil | |
1005 | nil | |
1006 | 'regexp-history))) | |
1007 | (if (equal input "") | |
1008 | default | |
1009 | input)) | |
1010 | (occur-read-primary-args))) | |
1011 | (when bufregexp | |
1012 | (occur-1 regexp nlines | |
1013 | (delq nil | |
1014 | (mapcar (lambda (buf) | |
1015 | (when (and (buffer-file-name buf) | |
1016 | (string-match bufregexp | |
1017 | (buffer-file-name buf))) | |
1018 | buf)) | |
1019 | (buffer-list)))))) | |
1020 | ||
e1690783 CW |
1021 | (defun occur-1 (regexp nlines bufs &optional buf-name) |
1022 | (unless buf-name | |
1023 | (setq buf-name "*Occur*")) | |
f42a241b | 1024 | (let (occur-buf |
70ed2a76 CW |
1025 | (active-bufs (delq nil (mapcar #'(lambda (buf) |
1026 | (when (buffer-live-p buf) buf)) | |
1027 | bufs)))) | |
1028 | ;; Handle the case where one of the buffers we're searching is the | |
f42a241b RS |
1029 | ;; output buffer. Just rename it. |
1030 | (when (member buf-name (mapcar 'buffer-name active-bufs)) | |
1031 | (with-current-buffer (get-buffer buf-name) | |
1032 | (rename-uniquely))) | |
1033 | ||
1034 | ;; Now find or create the output buffer. | |
1035 | ;; If we just renamed that buffer, we will make a new one here. | |
1036 | (setq occur-buf (get-buffer-create buf-name)) | |
1037 | ||
68608d9c | 1038 | (with-current-buffer occur-buf |
68608d9c | 1039 | (occur-mode) |
06df7f87 EZ |
1040 | (let ((inhibit-read-only t)) |
1041 | (erase-buffer) | |
1042 | (let ((count (occur-engine | |
1043 | regexp active-bufs occur-buf | |
1044 | (or nlines list-matching-lines-default-context-lines) | |
1045 | (and case-fold-search | |
1046 | (isearch-no-upper-case-p regexp t)) | |
1047 | list-matching-lines-buffer-name-face | |
8b363e6f JL |
1048 | nil list-matching-lines-face |
1049 | (not (eq occur-excluded-properties t))))) | |
06df7f87 EZ |
1050 | (let* ((bufcount (length active-bufs)) |
1051 | (diff (- (length bufs) bufcount))) | |
1052 | (message "Searched %d buffer%s%s; %s match%s for `%s'" | |
1053 | bufcount (if (= bufcount 1) "" "s") | |
1054 | (if (zerop diff) "" (format " (%d killed)" diff)) | |
1055 | (if (zerop count) "no" (format "%d" count)) | |
1056 | (if (= count 1) "" "es") | |
1057 | regexp)) | |
1058 | (setq occur-revert-arguments (list regexp nlines bufs)) | |
c7d2f2cc JB |
1059 | (if (= count 0) |
1060 | (kill-buffer occur-buf) | |
1061 | (display-buffer occur-buf) | |
1062 | (setq next-error-last-buffer occur-buf) | |
1063 | (setq buffer-read-only t) | |
1064 | (set-buffer-modified-p nil) | |
1065 | (run-hooks 'occur-hook))))))) | |
68608d9c | 1066 | |
46b3d18e RS |
1067 | (defun occur-engine-add-prefix (lines) |
1068 | (mapcar | |
1069 | #'(lambda (line) | |
261cca88 | 1070 | (concat " :" line "\n")) |
46b3d18e RS |
1071 | lines)) |
1072 | ||
1073 | (defun occur-engine (regexp buffers out-buf nlines case-fold-search | |
1074 | title-face prefix-face match-face keep-props) | |
1075 | (with-current-buffer out-buf | |
5cb4031d | 1076 | (let ((globalcount 0) |
882effdb RS |
1077 | ;; Don't generate undo entries for creation of the initial contents. |
1078 | (buffer-undo-list t) | |
5cb4031d | 1079 | (coding nil)) |
46b3d18e RS |
1080 | ;; Map over all the buffers |
1081 | (dolist (buf buffers) | |
1082 | (when (buffer-live-p buf) | |
1083 | (let ((matches 0) ;; count of matched lines | |
1084 | (lines 1) ;; line count | |
1085 | (matchbeg 0) | |
46b3d18e RS |
1086 | (origpt nil) |
1087 | (begpt nil) | |
1088 | (endpt nil) | |
1089 | (marker nil) | |
1090 | (curstring "") | |
1091 | (headerpt (with-current-buffer out-buf (point)))) | |
1092 | (save-excursion | |
1093 | (set-buffer buf) | |
5cb4031d KH |
1094 | (or coding |
1095 | ;; Set CODING only if the current buffer locally | |
1096 | ;; binds buffer-file-coding-system. | |
1097 | (not (local-variable-p 'buffer-file-coding-system)) | |
1098 | (setq coding buffer-file-coding-system)) | |
68608d9c | 1099 | (save-excursion |
46b3d18e RS |
1100 | (goto-char (point-min)) ;; begin searching in the buffer |
1101 | (while (not (eobp)) | |
1102 | (setq origpt (point)) | |
1103 | (when (setq endpt (re-search-forward regexp nil t)) | |
1104 | (setq matches (1+ matches)) ;; increment match count | |
5291cbca | 1105 | (setq matchbeg (match-beginning 0)) |
46b3d18e | 1106 | (setq lines (+ lines (1- (count-lines origpt endpt)))) |
f1f007dc JL |
1107 | (save-excursion |
1108 | (goto-char matchbeg) | |
1109 | (setq begpt (line-beginning-position) | |
1110 | endpt (line-end-position))) | |
46b3d18e RS |
1111 | (setq marker (make-marker)) |
1112 | (set-marker marker matchbeg) | |
99769096 RS |
1113 | (if (and keep-props |
1114 | (if (boundp 'jit-lock-mode) jit-lock-mode) | |
f1f007dc | 1115 | (text-property-not-all begpt endpt 'fontified t)) |
99769096 RS |
1116 | (if (fboundp 'jit-lock-fontify-now) |
1117 | (jit-lock-fontify-now begpt endpt))) | |
8b363e6f JL |
1118 | (if (and keep-props (not (eq occur-excluded-properties t))) |
1119 | (progn | |
1120 | (setq curstring (buffer-substring begpt endpt)) | |
1121 | (remove-list-of-text-properties | |
1122 | 0 (length curstring) occur-excluded-properties curstring)) | |
1123 | (setq curstring (buffer-substring-no-properties begpt endpt))) | |
1124 | ;; Highlight the matches | |
46b3d18e RS |
1125 | (let ((len (length curstring)) |
1126 | (start 0)) | |
46b3d18e RS |
1127 | (while (and (< start len) |
1128 | (string-match regexp curstring start)) | |
f1f007dc JL |
1129 | (add-text-properties |
1130 | (match-beginning 0) (match-end 0) | |
1131 | (append | |
1132 | `(occur-match t) | |
1133 | (when match-face | |
1134 | ;; Use `face' rather than `font-lock-face' here | |
1135 | ;; so as to override faces copied from the buffer. | |
1136 | `(face ,match-face))) | |
1137 | curstring) | |
46b3d18e RS |
1138 | (setq start (match-end 0)))) |
1139 | ;; Generate the string to insert for this match | |
1140 | (let* ((out-line | |
1141 | (concat | |
261cca88 | 1142 | ;; Using 7 digits aligns tabs properly. |
1e0ab2f0 | 1143 | (apply #'propertize (format "%7d:" lines) |
46b3d18e RS |
1144 | (append |
1145 | (when prefix-face | |
506a6d7e | 1146 | `(font-lock-face prefix-face)) |
1e0ab2f0 | 1147 | `(occur-prefix t mouse-face (highlight) |
c7cad90c RF |
1148 | occur-target ,marker follow-link t |
1149 | help-echo "mouse-2: go to this occurrence"))) | |
f1f007dc JL |
1150 | ;; We don't put `mouse-face' on the newline, |
1151 | ;; because that loses. And don't put it | |
1152 | ;; on context lines to reduce flicker. | |
1e0ab2f0 | 1153 | (propertize curstring 'mouse-face (list 'highlight) |
c7cad90c RF |
1154 | 'occur-target marker |
1155 | 'follow-link t | |
1156 | 'help-echo | |
1157 | "mouse-2: go to this occurrence") | |
61f570e2 RF |
1158 | ;; Add marker at eol, but no mouse props. |
1159 | (propertize "\n" 'occur-target marker))) | |
46b3d18e RS |
1160 | (data |
1161 | (if (= nlines 0) | |
1162 | ;; The simple display style | |
1163 | out-line | |
1164 | ;; The complex multi-line display | |
1165 | ;; style. Generate a list of lines, | |
1166 | ;; concatenate them all together. | |
1167 | (apply #'concat | |
1168 | (nconc | |
f22a7406 | 1169 | (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ (abs nlines))) keep-props)))) |
46b3d18e | 1170 | (list out-line) |
f22a7406 RS |
1171 | (if (> nlines 0) |
1172 | (occur-engine-add-prefix | |
1173 | (cdr (occur-accumulate-lines (1+ nlines) keep-props))))))))) | |
46b3d18e RS |
1174 | ;; Actually insert the match display data |
1175 | (with-current-buffer out-buf | |
1176 | (let ((beg (point)) | |
1177 | (end (progn (insert data) (point)))) | |
1178 | (unless (= nlines 0) | |
c7cad90c | 1179 | (insert "-------\n"))))) |
46b3d18e | 1180 | (goto-char endpt)) |
e1690783 CW |
1181 | (if endpt |
1182 | (progn | |
1183 | (setq lines (1+ lines)) | |
1184 | ;; On to the next match... | |
1185 | (forward-line 1)) | |
1186 | (goto-char (point-max)))))) | |
46b3d18e | 1187 | (when (not (zerop matches)) ;; is the count zero? |
daae70bf | 1188 | (setq globalcount (+ globalcount matches)) |
46b3d18e RS |
1189 | (with-current-buffer out-buf |
1190 | (goto-char headerpt) | |
1191 | (let ((beg (point)) | |
1192 | end) | |
dbed3cd3 JPW |
1193 | (insert (format "%d match%s for \"%s\" in buffer: %s\n" |
1194 | matches (if (= matches 1) "" "es") | |
1195 | regexp (buffer-name buf))) | |
46b3d18e RS |
1196 | (setq end (point)) |
1197 | (add-text-properties beg end | |
1198 | (append | |
1199 | (when title-face | |
506a6d7e CW |
1200 | `(font-lock-face ,title-face)) |
1201 | `(occur-title ,buf)))) | |
46b3d18e | 1202 | (goto-char (point-min))))))) |
5cb4031d KH |
1203 | (if coding |
1204 | ;; CODING is buffer-file-coding-system of the first buffer | |
1205 | ;; that locally binds it. Let's use it also for the output | |
1206 | ;; buffer. | |
1207 | (set-buffer-file-coding-system coding)) | |
46b3d18e RS |
1208 | ;; Return the number of matches |
1209 | globalcount))) | |
68608d9c | 1210 | |
698e1804 | 1211 | \f |
81bdc14d RS |
1212 | ;; It would be nice to use \\[...], but there is no reasonable way |
1213 | ;; to make that display both SPC and Y. | |
698e1804 RS |
1214 | (defconst query-replace-help |
1215 | "Type Space or `y' to replace one match, Delete or `n' to skip to next, | |
be44f62c | 1216 | RET or `q' to exit, Period to replace one match and exit, |
698e1804 RS |
1217 | Comma to replace but not move point immediately, |
1218 | C-r to enter recursive edit (\\[exit-recursive-edit] to get out again), | |
1219 | C-w to delete match and recursive edit, | |
1220 | C-l to clear the screen, redisplay, and offer same replacement again, | |
1221 | ! to replace all remaining matches with no more questions, | |
7ce278f3 GM |
1222 | ^ to move point back to previous match, |
1223 | E to edit the replacement string" | |
f54701d1 | 1224 | "Help message while in `query-replace'.") |
698e1804 | 1225 | |
81bdc14d RS |
1226 | (defvar query-replace-map (make-sparse-keymap) |
1227 | "Keymap that defines the responses to questions in `query-replace'. | |
1228 | The \"bindings\" in this map are not commands; they are answers. | |
1229 | The valid answers include `act', `skip', `act-and-show', | |
1230 | `exit', `act-and-exit', `edit', `delete-and-edit', `recenter', | |
d9121bc0 | 1231 | `automatic', `backup', `exit-prefix', and `help'.") |
81bdc14d RS |
1232 | |
1233 | (define-key query-replace-map " " 'act) | |
1234 | (define-key query-replace-map "\d" 'skip) | |
1235 | (define-key query-replace-map [delete] 'skip) | |
9275e5e3 | 1236 | (define-key query-replace-map [backspace] 'skip) |
81bdc14d RS |
1237 | (define-key query-replace-map "y" 'act) |
1238 | (define-key query-replace-map "n" 'skip) | |
633a305a RS |
1239 | (define-key query-replace-map "Y" 'act) |
1240 | (define-key query-replace-map "N" 'skip) | |
34724fcb | 1241 | (define-key query-replace-map "e" 'edit-replacement) |
7ce278f3 | 1242 | (define-key query-replace-map "E" 'edit-replacement) |
81bdc14d | 1243 | (define-key query-replace-map "," 'act-and-show) |
81bdc14d | 1244 | (define-key query-replace-map "q" 'exit) |
919592c0 | 1245 | (define-key query-replace-map "\r" 'exit) |
384c7da4 | 1246 | (define-key query-replace-map [return] 'exit) |
81bdc14d RS |
1247 | (define-key query-replace-map "." 'act-and-exit) |
1248 | (define-key query-replace-map "\C-r" 'edit) | |
1249 | (define-key query-replace-map "\C-w" 'delete-and-edit) | |
1250 | (define-key query-replace-map "\C-l" 'recenter) | |
1251 | (define-key query-replace-map "!" 'automatic) | |
1252 | (define-key query-replace-map "^" 'backup) | |
1253 | (define-key query-replace-map "\C-h" 'help) | |
e731045a KH |
1254 | (define-key query-replace-map [f1] 'help) |
1255 | (define-key query-replace-map [help] 'help) | |
81bdc14d | 1256 | (define-key query-replace-map "?" 'help) |
bc6312e1 RS |
1257 | (define-key query-replace-map "\C-g" 'quit) |
1258 | (define-key query-replace-map "\C-]" 'quit) | |
d9121bc0 RS |
1259 | (define-key query-replace-map "\e" 'exit-prefix) |
1260 | (define-key query-replace-map [escape] 'exit-prefix) | |
81bdc14d | 1261 | |
84482eb3 | 1262 | (defun replace-match-string-symbols (n) |
e730be7f DL |
1263 | "Process a list (and any sub-lists), expanding certain symbols. |
1264 | Symbol Expands To | |
1265 | N (match-string N) (where N is a string of digits) | |
1266 | #N (string-to-number (match-string N)) | |
1267 | & (match-string 0) | |
1268 | #& (string-to-number (match-string 0)) | |
2f57bf85 | 1269 | # replace-count |
e730be7f DL |
1270 | |
1271 | Note that these symbols must be preceeded by a backslash in order to | |
1272 | type them." | |
84482eb3 RS |
1273 | (while n |
1274 | (cond | |
1275 | ((consp (car n)) | |
1276 | (replace-match-string-symbols (car n))) ;Process sub-list | |
1277 | ((symbolp (car n)) | |
1278 | (let ((name (symbol-name (car n)))) | |
1279 | (cond | |
1280 | ((string-match "^[0-9]+$" name) | |
1281 | (setcar n (list 'match-string (string-to-number name)))) | |
1282 | ((string-match "^#[0-9]+$" name) | |
1283 | (setcar n (list 'string-to-number | |
1284 | (list 'match-string | |
1285 | (string-to-number (substring name 1)))))) | |
1286 | ((string= "&" name) | |
1287 | (setcar n '(match-string 0))) | |
1288 | ((string= "#&" name) | |
2f57bf85 DK |
1289 | (setcar n '(string-to-number (match-string 0)))) |
1290 | ((string= "#" name) | |
1291 | (setcar n 'replace-count)))))) | |
84482eb3 RS |
1292 | (setq n (cdr n)))) |
1293 | ||
1294 | (defun replace-eval-replacement (expression replace-count) | |
1295 | (let ((replacement (eval expression))) | |
1296 | (if (stringp replacement) | |
1297 | replacement | |
1298 | (prin1-to-string replacement t)))) | |
1299 | ||
2f57bf85 DK |
1300 | (defun replace-quote (replacement) |
1301 | "Quote a replacement string. | |
1302 | This just doubles all backslashes in REPLACEMENT and | |
1303 | returns the resulting string. If REPLACEMENT is not | |
1304 | a string, it is first passed through `prin1-to-string' | |
1305 | with the `noescape' argument set. | |
1306 | ||
1307 | `match-data' is preserved across the call." | |
1308 | (save-match-data | |
1309 | (replace-regexp-in-string "\\\\" "\\\\" | |
1310 | (if (stringp replacement) | |
1311 | replacement | |
1312 | (prin1-to-string replacement t)) | |
1313 | t t))) | |
1314 | ||
84482eb3 RS |
1315 | (defun replace-loop-through-replacements (data replace-count) |
1316 | ;; DATA is a vector contaning the following values: | |
1317 | ;; 0 next-rotate-count | |
1318 | ;; 1 repeat-count | |
1319 | ;; 2 next-replacement | |
1320 | ;; 3 replacements | |
1321 | (if (= (aref data 0) replace-count) | |
1322 | (progn | |
1323 | (aset data 0 (+ replace-count (aref data 1))) | |
1324 | (let ((next (cdr (aref data 2)))) | |
1325 | (aset data 2 (if (consp next) next (aref data 3)))))) | |
1326 | (car (aref data 2))) | |
1327 | ||
7c1c02ac DK |
1328 | (defun replace-match-data (integers reuse &optional new) |
1329 | "Like `match-data', but markers in REUSE get invalidated. | |
1330 | If NEW is non-NIL, it is set and returned instead of fresh data, | |
1331 | but coerced to the correct value of INTEGERS." | |
1332 | (or (and new | |
1333 | (progn | |
1334 | (set-match-data new) | |
1335 | (and (eq new reuse) | |
1336 | (eq (null integers) (markerp (car reuse))) | |
1337 | new))) | |
10ddc30e | 1338 | (match-data integers reuse t))) |
7c1c02ac DK |
1339 | |
1340 | (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data) | |
1341 | "Make a replacement with `replace-match', editing `\\?'. | |
15fd7d5d | 1342 | NEWTEXT, FIXEDCASE, LITERAL are just passed on. If NOEDIT is true, no |
7c1c02ac DK |
1343 | check for `\\?' is made to save time. MATCH-DATA is used for the |
1344 | replacement. In case editing is done, it is changed to use markers. | |
1345 | ||
1346 | The return value is non-NIL if there has been no `\\?' or NOEDIT was | |
1347 | passed in. If LITERAL is set, no checking is done, anyway." | |
1348 | (unless (or literal noedit) | |
1349 | (setq noedit t) | |
1350 | (while (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\?\\)" | |
1351 | newtext) | |
1352 | (setq newtext | |
3981e5b5 JB |
1353 | (read-string "Edit replacement string: " |
1354 | (prog1 | |
1355 | (cons | |
1356 | (replace-match "" t t newtext 3) | |
1357 | (1+ (match-beginning 3))) | |
1358 | (setq match-data | |
1359 | (replace-match-data | |
1360 | nil match-data match-data)))) | |
7c1c02ac DK |
1361 | noedit nil))) |
1362 | (set-match-data match-data) | |
1363 | (replace-match newtext fixedcase literal) | |
1364 | noedit) | |
1365 | ||
d99118b0 | 1366 | (defun perform-replace (from-string replacements |
698e1804 | 1367 | query-flag regexp-flag delimited-flag |
99a7559f | 1368 | &optional repeat-count map start end) |
698e1804 RS |
1369 | "Subroutine of `query-replace'. Its complexity handles interactive queries. |
1370 | Don't use this in your own program unless you want to query and set the mark | |
1371 | just as `query-replace' does. Instead, write a simple loop like this: | |
698665d1 GM |
1372 | |
1373 | (while (re-search-forward \"foo[ \\t]+bar\" nil t) | |
698e1804 | 1374 | (replace-match \"foobar\" nil nil)) |
698665d1 GM |
1375 | |
1376 | which will run faster and probably do exactly what you want. Please | |
1377 | see the documentation of `replace-match' to find out how to simulate | |
588c915a CW |
1378 | `case-replace'. |
1379 | ||
1380 | This function returns nil if and only if there were no matches to | |
1381 | make, or the user didn't cancel the call." | |
81bdc14d | 1382 | (or map (setq map query-replace-map)) |
1c1dadab RS |
1383 | (and query-flag minibuffer-auto-raise |
1384 | (raise-frame (window-frame (minibuffer-window)))) | |
698e1804 RS |
1385 | (let ((nocasify (not (and case-fold-search case-replace |
1386 | (string-equal from-string | |
1387 | (downcase from-string))))) | |
5a78b471 KH |
1388 | (case-fold-search (and case-fold-search |
1389 | (string-equal from-string | |
1390 | (downcase from-string)))) | |
d83a97ab | 1391 | (literal (or (not regexp-flag) (eq regexp-flag 'literal))) |
698e1804 RS |
1392 | (search-function (if regexp-flag 're-search-forward 'search-forward)) |
1393 | (search-string from-string) | |
e5d77022 | 1394 | (real-match-data nil) ; the match data for the current match |
698e1804 | 1395 | (next-replacement nil) |
7c1c02ac | 1396 | (noedit nil) |
698e1804 RS |
1397 | (keep-going t) |
1398 | (stack nil) | |
698e1804 | 1399 | (replace-count 0) |
5632eb27 PE |
1400 | (nonempty-match nil) |
1401 | ||
7ef5c431 KH |
1402 | ;; If non-nil, it is marker saying where in the buffer to stop. |
1403 | (limit nil) | |
1404 | ||
5632eb27 PE |
1405 | ;; Data for the next match. If a cons, it has the same format as |
1406 | ;; (match-data); otherwise it is t if a match is possible at point. | |
ae4eb03c | 1407 | (match-again t) |
5632eb27 | 1408 | |
02d95a27 RS |
1409 | (message |
1410 | (if query-flag | |
1411 | (substitute-command-keys | |
1412 | "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) ")))) | |
7ef5c431 KH |
1413 | |
1414 | ;; If region is active, in Transient Mark mode, operate on region. | |
47d72254 GM |
1415 | (when start |
1416 | (setq limit (copy-marker (max start end))) | |
1417 | (goto-char (min start end)) | |
1418 | (deactivate-mark)) | |
84482eb3 RS |
1419 | |
1420 | ;; REPLACEMENTS is either a string, a list of strings, or a cons cell | |
1421 | ;; containing a function and its first argument. The function is | |
1422 | ;; called to generate each replacement like this: | |
1423 | ;; (funcall (car replacements) (cdr replacements) replace-count) | |
1424 | ;; It must return a string. | |
1425 | (cond | |
1426 | ((stringp replacements) | |
1427 | (setq next-replacement replacements | |
1428 | replacements nil)) | |
1429 | ((stringp (car replacements)) ; If it isn't a string, it must be a cons | |
1430 | (or repeat-count (setq repeat-count 1)) | |
1431 | (setq replacements (cons 'replace-loop-through-replacements | |
1432 | (vector repeat-count repeat-count | |
1433 | replacements replacements))))) | |
1434 | ||
698e1804 RS |
1435 | (if delimited-flag |
1436 | (setq search-function 're-search-forward | |
1437 | search-string (concat "\\b" | |
1438 | (if regexp-flag from-string | |
1439 | (regexp-quote from-string)) | |
1440 | "\\b"))) | |
ccec9764 | 1441 | (when query-replace-lazy-highlight |
444697a1 | 1442 | (setq isearch-lazy-highlight-last-string nil)) |
35d59c0f | 1443 | |
698e1804 RS |
1444 | (push-mark) |
1445 | (undo-boundary) | |
e782e9f2 RS |
1446 | (unwind-protect |
1447 | ;; Loop finding occurrences that perhaps should be replaced. | |
1448 | (while (and keep-going | |
22a76778 | 1449 | (not (or (eobp) (and limit (>= (point) limit)))) |
5632eb27 PE |
1450 | ;; Use the next match if it is already known; |
1451 | ;; otherwise, search for a match after moving forward | |
1452 | ;; one char if progress is required. | |
1453 | (setq real-match-data | |
1454 | (if (consp match-again) | |
1455 | (progn (goto-char (nth 1 match-again)) | |
7c1c02ac DK |
1456 | (replace-match-data t |
1457 | real-match-data | |
1458 | match-again)) | |
5632eb27 | 1459 | (and (or match-again |
889617de GM |
1460 | ;; MATCH-AGAIN non-nil means we |
1461 | ;; accept an adjacent match. If | |
1462 | ;; we don't, move one char to the | |
1463 | ;; right. This takes us a | |
1464 | ;; character too far at the end, | |
1465 | ;; but this is undone after the | |
1466 | ;; while-loop. | |
22a76778 JL |
1467 | (progn |
1468 | (forward-char 1) | |
1469 | (not (or (eobp) | |
1470 | (and limit (>= (point) limit)))))) | |
7ef5c431 | 1471 | (funcall search-function search-string limit t) |
5632eb27 PE |
1472 | ;; For speed, use only integers and |
1473 | ;; reuse the list used last time. | |
7c1c02ac | 1474 | (replace-match-data t real-match-data))))) |
1c4fe319 RS |
1475 | ;; Optionally ignore matches that have a read-only property. |
1476 | (unless (and query-replace-skip-read-only | |
1477 | (text-property-not-all | |
1478 | (match-beginning 0) (match-end 0) | |
1479 | 'read-only nil)) | |
1480 | ||
1481 | ;; Record whether the match is nonempty, to avoid an infinite loop | |
1482 | ;; repeatedly matching the same empty string. | |
1483 | (setq nonempty-match | |
1484 | (/= (nth 0 real-match-data) (nth 1 real-match-data))) | |
1485 | ||
1486 | ;; If the match is empty, record that the next one can't be | |
1487 | ;; adjacent. | |
1488 | ||
1489 | ;; Otherwise, if matching a regular expression, do the next | |
1490 | ;; match now, since the replacement for this match may | |
1491 | ;; affect whether the next match is adjacent to this one. | |
1492 | ;; If that match is empty, don't use it. | |
1493 | (setq match-again | |
1494 | (and nonempty-match | |
1495 | (or (not regexp-flag) | |
1496 | (and (looking-at search-string) | |
1497 | (let ((match (match-data))) | |
1498 | (and (/= (nth 0 match) (nth 1 match)) | |
1499 | match)))))) | |
1500 | ||
1501 | ;; Calculate the replacement string, if necessary. | |
1502 | (when replacements | |
1503 | (set-match-data real-match-data) | |
1504 | (setq next-replacement | |
1505 | (funcall (car replacements) (cdr replacements) | |
7c1c02ac DK |
1506 | replace-count) |
1507 | noedit nil)) | |
1c4fe319 | 1508 | (if (not query-flag) |
cb05ca25 DK |
1509 | (let ((inhibit-read-only |
1510 | query-replace-skip-read-only)) | |
15fd7d5d | 1511 | (unless (or literal noedit) |
444697a1 JL |
1512 | (replace-highlight |
1513 | (nth 0 real-match-data) (nth 1 real-match-data) | |
1514 | start end search-string | |
1515 | (or delimited-flag regexp-flag) case-fold-search)) | |
7c1c02ac DK |
1516 | (setq noedit |
1517 | (replace-match-maybe-edit | |
1518 | next-replacement nocasify literal | |
1519 | noedit real-match-data) | |
1520 | replace-count (1+ replace-count))) | |
1c4fe319 RS |
1521 | (undo-boundary) |
1522 | (let (done replaced key def) | |
1523 | ;; Loop reading commands until one of them sets done, | |
7c1c02ac DK |
1524 | ;; which means it has finished handling this |
1525 | ;; occurrence. Any command that sets `done' should | |
1526 | ;; leave behind proper match data for the stack. | |
1527 | ;; Commands not setting `done' need to adjust | |
1528 | ;; `real-match-data'. | |
1c4fe319 RS |
1529 | (while (not done) |
1530 | (set-match-data real-match-data) | |
444697a1 JL |
1531 | (replace-highlight |
1532 | (match-beginning 0) (match-end 0) | |
1533 | start end search-string | |
1534 | (or delimited-flag regexp-flag) case-fold-search) | |
1c4fe319 RS |
1535 | ;; Bind message-log-max so we don't fill up the message log |
1536 | ;; with a bunch of identical messages. | |
1537 | (let ((message-log-max nil)) | |
b938735a JL |
1538 | (message message |
1539 | (query-replace-descr from-string) | |
1540 | (query-replace-descr next-replacement))) | |
1c4fe319 RS |
1541 | (setq key (read-event)) |
1542 | ;; Necessary in case something happens during read-event | |
1543 | ;; that clobbers the match data. | |
1544 | (set-match-data real-match-data) | |
1545 | (setq key (vector key)) | |
1546 | (setq def (lookup-key map key)) | |
1547 | ;; Restore the match data while we process the command. | |
1548 | (cond ((eq def 'help) | |
1549 | (with-output-to-temp-buffer "*Help*" | |
1550 | (princ | |
1551 | (concat "Query replacing " | |
1552 | (if regexp-flag "regexp " "") | |
1553 | from-string " with " | |
1554 | next-replacement ".\n\n" | |
1555 | (substitute-command-keys | |
1556 | query-replace-help))) | |
1557 | (with-current-buffer standard-output | |
1558 | (help-mode)))) | |
1559 | ((eq def 'exit) | |
1560 | (setq keep-going nil) | |
1561 | (setq done t)) | |
1562 | ((eq def 'backup) | |
1563 | (if stack | |
588c915a | 1564 | (let ((elt (pop stack))) |
7c1c02ac DK |
1565 | (goto-char (nth 0 elt)) |
1566 | (setq replaced (nth 1 elt) | |
1567 | real-match-data | |
1568 | (replace-match-data | |
1569 | t real-match-data | |
1570 | (nth 2 elt)))) | |
1c4fe319 RS |
1571 | (message "No previous match") |
1572 | (ding 'no-terminate) | |
1573 | (sit-for 1))) | |
1574 | ((eq def 'act) | |
1575 | (or replaced | |
7c1c02ac DK |
1576 | (setq noedit |
1577 | (replace-match-maybe-edit | |
1578 | next-replacement nocasify literal | |
1579 | noedit real-match-data) | |
1580 | replace-count (1+ replace-count))) | |
1c4fe319 RS |
1581 | (setq done t replaced t)) |
1582 | ((eq def 'act-and-exit) | |
1583 | (or replaced | |
7c1c02ac | 1584 | (setq noedit |
da6eb51c | 1585 | (replace-match-maybe-edit |
7c1c02ac DK |
1586 | next-replacement nocasify literal |
1587 | noedit real-match-data) | |
1588 | replace-count (1+ replace-count))) | |
1c4fe319 RS |
1589 | (setq keep-going nil) |
1590 | (setq done t replaced t)) | |
1591 | ((eq def 'act-and-show) | |
1592 | (if (not replaced) | |
7c1c02ac DK |
1593 | (setq noedit |
1594 | (replace-match-maybe-edit | |
1595 | next-replacement nocasify literal | |
1596 | noedit real-match-data) | |
1597 | replace-count (1+ replace-count) | |
1598 | real-match-data (replace-match-data | |
1599 | t real-match-data) | |
1600 | replaced t))) | |
1c4fe319 RS |
1601 | ((eq def 'automatic) |
1602 | (or replaced | |
7c1c02ac DK |
1603 | (setq noedit |
1604 | (replace-match-maybe-edit | |
1605 | next-replacement nocasify literal | |
1606 | noedit real-match-data) | |
1607 | replace-count (1+ replace-count))) | |
1c4fe319 RS |
1608 | (setq done t query-flag nil replaced t)) |
1609 | ((eq def 'skip) | |
1610 | (setq done t)) | |
1611 | ((eq def 'recenter) | |
1612 | (recenter nil)) | |
1613 | ((eq def 'edit) | |
1614 | (let ((opos (point-marker))) | |
7c1c02ac DK |
1615 | (setq real-match-data (replace-match-data |
1616 | nil real-match-data | |
1617 | real-match-data)) | |
1c4fe319 | 1618 | (goto-char (match-beginning 0)) |
86914dcc RS |
1619 | (save-excursion |
1620 | (save-window-excursion | |
1621 | (recursive-edit))) | |
7c1c02ac DK |
1622 | (goto-char opos) |
1623 | (set-marker opos nil)) | |
1c4fe319 RS |
1624 | ;; Before we make the replacement, |
1625 | ;; decide whether the search string | |
1626 | ;; can match again just after this match. | |
1627 | (if (and regexp-flag nonempty-match) | |
1628 | (setq match-again (and (looking-at search-string) | |
1629 | (match-data))))) | |
1c4fe319 RS |
1630 | ;; Edit replacement. |
1631 | ((eq def 'edit-replacement) | |
7c1c02ac DK |
1632 | (setq real-match-data (replace-match-data |
1633 | nil real-match-data | |
1634 | real-match-data) | |
1635 | next-replacement | |
3981e5b5 JB |
1636 | (read-string "Edit replacement string: " |
1637 | next-replacement) | |
7c1c02ac DK |
1638 | noedit nil) |
1639 | (if replaced | |
1640 | (set-match-data real-match-data) | |
1641 | (setq noedit | |
1642 | (replace-match-maybe-edit | |
1643 | next-replacement nocasify literal noedit | |
1644 | real-match-data) | |
1645 | replaced t)) | |
1c4fe319 | 1646 | (setq done t)) |
d99118b0 | 1647 | |
1c4fe319 | 1648 | ((eq def 'delete-and-edit) |
7c1c02ac DK |
1649 | (replace-match "" t t) |
1650 | (setq real-match-data (replace-match-data | |
1651 | nil real-match-data)) | |
1652 | (replace-dehighlight) | |
1653 | (save-excursion (recursive-edit)) | |
1c4fe319 RS |
1654 | (setq replaced t)) |
1655 | ;; Note: we do not need to treat `exit-prefix' | |
1656 | ;; specially here, since we reread | |
1657 | ;; any unrecognized character. | |
1658 | (t | |
1659 | (setq this-command 'mode-exited) | |
1660 | (setq keep-going nil) | |
1661 | (setq unread-command-events | |
1662 | (append (listify-key-sequence key) | |
1663 | unread-command-events)) | |
35d59c0f | 1664 | (setq done t))) |
ccec9764 | 1665 | (when query-replace-lazy-highlight |
ccec9764 JL |
1666 | ;; Force lazy rehighlighting only after replacements |
1667 | (if (not (memq def '(skip backup))) | |
1668 | (setq isearch-lazy-highlight-last-string nil)))) | |
1c4fe319 RS |
1669 | ;; Record previous position for ^ when we move on. |
1670 | ;; Change markers to numbers in the match data | |
1671 | ;; since lots of markers slow down editing. | |
7c1c02ac | 1672 | (push (list (point) replaced |
bace7209 LT |
1673 | ;;; If the replacement has already happened, all we need is the |
1674 | ;;; current match start and end. We could get this with a trivial | |
1675 | ;;; match like | |
1676 | ;;; (save-excursion (goto-char (match-beginning 0)) | |
1677 | ;;; (search-forward (match-string 0)) | |
1678 | ;;; (match-data t)) | |
1679 | ;;; if we really wanted to avoid manually constructing match data. | |
1680 | ;;; Adding current-buffer is necessary so that match-data calls can | |
1681 | ;;; return markers which are appropriate for editing. | |
7c1c02ac DK |
1682 | (if replaced |
1683 | (list | |
1684 | (match-beginning 0) | |
1685 | (match-end 0) | |
1686 | (current-buffer)) | |
1687 | (match-data t))) | |
1688 | stack))))) | |
889617de GM |
1689 | |
1690 | ;; The code preventing adjacent regexp matches in the condition | |
1691 | ;; of the while-loop above will haven taken us one character | |
1692 | ;; beyond the last replacement. Undo that. | |
1693 | (when (and regexp-flag (not match-again) (> replace-count 0)) | |
1694 | (backward-char 1)) | |
d99118b0 | 1695 | |
e782e9f2 | 1696 | (replace-dehighlight)) |
4d33492a RS |
1697 | (or unread-command-events |
1698 | (message "Replaced %d occurrence%s" | |
1699 | replace-count | |
1700 | (if (= replace-count 1) "" "s"))) | |
1701 | (and keep-going stack))) | |
698e1804 | 1702 | |
e782e9f2 RS |
1703 | (defvar replace-overlay nil) |
1704 | ||
444697a1 JL |
1705 | (defun replace-highlight (match-beg match-end range-beg range-end |
1706 | string regexp case-fold) | |
ccec9764 JL |
1707 | (if query-replace-highlight |
1708 | (if replace-overlay | |
d532160f RS |
1709 | (move-overlay replace-overlay match-beg match-end (current-buffer)) |
1710 | (setq replace-overlay (make-overlay match-beg match-end)) | |
ccec9764 JL |
1711 | (overlay-put replace-overlay 'priority 1) ;higher than lazy overlays |
1712 | (overlay-put replace-overlay 'face 'query-replace))) | |
444697a1 JL |
1713 | (if query-replace-lazy-highlight |
1714 | (let ((isearch-string string) | |
1715 | (isearch-regexp regexp) | |
1716 | (isearch-case-fold-search case-fold)) | |
1717 | (isearch-lazy-highlight-new-loop range-beg range-end)))) | |
ccec9764 | 1718 | |
e782e9f2 | 1719 | (defun replace-dehighlight () |
ccec9764 JL |
1720 | (when replace-overlay |
1721 | (delete-overlay replace-overlay)) | |
1722 | (when query-replace-lazy-highlight | |
444697a1 | 1723 | (lazy-highlight-cleanup lazy-highlight-cleanup) |
ccec9764 | 1724 | (setq isearch-lazy-highlight-last-string nil))) |
e782e9f2 | 1725 | |
6f1df6d9 | 1726 | ;; arch-tag: 16b4cd61-fd40-497b-b86f-b667c4cf88e4 |
c88ab9ce | 1727 | ;;; replace.el ends here |