Commit | Line | Data |
---|---|---|
60370d40 | 1 | ;;; replace.el --- replace commands for Emacs |
c88ab9ce | 2 | |
653479ad | 3 | ;; Copyright (C) 1985, 86, 87, 92, 94, 96, 1997, 2000, 2001, 2002 |
8f3ff96b | 4 | ;; 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 EN |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, 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 | ||
151270f3 RS |
39 | (defvar query-replace-interactive nil |
40 | "Non-nil means `query-replace' uses the last search string. | |
41 | That becomes the \"string to replace\".") | |
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 | |
89e7ad59 | 65 | :version "21.4") |
1c4fe319 | 66 | |
86914dcc RS |
67 | (defun query-replace-read-args (string regexp-flag &optional noerror) |
68 | (unless noerror | |
69 | (barf-if-buffer-read-only)) | |
770970cb | 70 | (let (from to) |
151270f3 RS |
71 | (if query-replace-interactive |
72 | (setq from (car (if regexp-flag regexp-search-ring search-ring))) | |
73 | (setq from (read-from-minibuffer (format "%s: " string) | |
74 | nil nil nil | |
bdb1c08f | 75 | query-replace-from-history-variable |
d9291fa3 RS |
76 | nil t)) |
77 | ;; Warn if user types \n or \t, but don't reject the input. | |
78 | (if (string-match "\\\\[nt]" from) | |
79 | (let ((match (match-string 0 from))) | |
80 | (cond | |
81 | ((string= match "\\n") | |
82 | (message "Note: `\\n' here doesn't match a newline; to do that, type C-q C-j instead")) | |
83 | ((string= match "\\t") | |
84 | (message "Note: `\\t' here doesn't match a tab; to do that, just type TAB"))) | |
85 | (sit-for 2)))) | |
86 | ||
770970cb RS |
87 | (setq to (read-from-minibuffer (format "%s %s with: " string from) |
88 | nil nil nil | |
4a8f3b3d | 89 | query-replace-to-history-variable from t)) |
47d72254 GM |
90 | (if (and transient-mark-mode mark-active) |
91 | (list from to current-prefix-arg (region-beginning) (region-end)) | |
92 | (list from to current-prefix-arg nil nil)))) | |
770970cb | 93 | |
47d72254 | 94 | (defun query-replace (from-string to-string &optional delimited start end) |
da44e784 RM |
95 | "Replace some occurrences of FROM-STRING with TO-STRING. |
96 | As each match is found, the user must type a character saying | |
97 | what to do with it. For directions, type \\[help-command] at that time. | |
98 | ||
7ef5c431 KH |
99 | In Transient Mark mode, if the mark is active, operate on the contents |
100 | of the region. Otherwise, operate from point to the end of the buffer. | |
101 | ||
151270f3 RS |
102 | If `query-replace-interactive' is non-nil, the last incremental search |
103 | string is used as FROM-STRING--you don't have to specify it with the | |
104 | minibuffer. | |
105 | ||
446d9629 RS |
106 | Matching is independent of case if `case-fold-search' is non-nil and |
107 | FROM-STRING has no uppercase letters. Replacement transfers the case | |
108 | pattern of the old text to the new text, if `case-replace' and | |
109 | `case-fold-search' are non-nil and FROM-STRING has no uppercase | |
110 | letters. \(Transferring the case pattern means that if the old text | |
111 | matched is all caps, or capitalized, then its replacement is upcased | |
112 | or capitalized.) | |
9b0bf2b6 | 113 | |
118a01c9 | 114 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
81bdc14d | 115 | only matches surrounded by word boundaries. |
47d72254 | 116 | Fourth and fifth arg START and END specify the region to operate on. |
81bdc14d RS |
117 | |
118 | To customize possible responses, change the \"bindings\" in `query-replace-map'." | |
151270f3 | 119 | (interactive (query-replace-read-args "Query replace" nil)) |
99a7559f | 120 | (perform-replace from-string to-string t nil delimited nil nil start end)) |
7ef5c431 | 121 | |
73fa8346 | 122 | (define-key esc-map "%" 'query-replace) |
da44e784 | 123 | |
47d72254 | 124 | (defun query-replace-regexp (regexp to-string &optional delimited start end) |
da44e784 RM |
125 | "Replace some things after point matching REGEXP with TO-STRING. |
126 | As each match is found, the user must type a character saying | |
127 | what to do with it. For directions, type \\[help-command] at that time. | |
128 | ||
7ef5c431 KH |
129 | In Transient Mark mode, if the mark is active, operate on the contents |
130 | of the region. Otherwise, operate from point to the end of the buffer. | |
131 | ||
151270f3 RS |
132 | If `query-replace-interactive' is non-nil, the last incremental search |
133 | regexp is used as REGEXP--you don't have to specify it with the | |
134 | minibuffer. | |
135 | ||
446d9629 RS |
136 | Matching is independent of case if `case-fold-search' is non-nil and |
137 | REGEXP has no uppercase letters. Replacement transfers the case | |
138 | pattern of the old text to the new text, if `case-replace' and | |
139 | `case-fold-search' are non-nil and REGEXP has no uppercase letters. | |
140 | \(Transferring the case pattern means that if the old text matched is | |
141 | all caps, or capitalized, then its replacement is upcased or | |
142 | capitalized.) | |
47d72254 | 143 | |
118a01c9 | 144 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 145 | only matches surrounded by word boundaries. |
47d72254 GM |
146 | Fourth and fifth arg START and END specify the region to operate on. |
147 | ||
118a01c9 RS |
148 | In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP, |
149 | and `\\=\\N' (where N is a digit) stands for | |
150 | whatever what matched the Nth `\\(...\\)' in REGEXP." | |
151270f3 | 151 | (interactive (query-replace-read-args "Query replace regexp" t)) |
99a7559f | 152 | (perform-replace regexp to-string t t delimited nil nil start end)) |
cbc127de | 153 | (define-key esc-map [?\C-%] 'query-replace-regexp) |
da44e784 | 154 | |
47d72254 | 155 | (defun query-replace-regexp-eval (regexp to-expr &optional delimited start end) |
84482eb3 RS |
156 | "Replace some things after point matching REGEXP with the result of TO-EXPR. |
157 | As each match is found, the user must type a character saying | |
158 | what to do with it. For directions, type \\[help-command] at that time. | |
159 | ||
160 | TO-EXPR is a Lisp expression evaluated to compute each replacement. It may | |
161 | reference `replace-count' to get the number of replacements already made. | |
162 | If the result of TO-EXPR is not a string, it is converted to one using | |
163 | `prin1-to-string' with the NOESCAPE argument (which see). | |
164 | ||
165 | For convenience, when entering TO-EXPR interactively, you can use `\\&' or | |
653479ad AS |
166 | `\\0' to stand for whatever matched the whole of REGEXP, and `\\N' (where |
167 | N is a digit) to stand for whatever matched the Nth `\\(...\\)' in REGEXP. | |
84482eb3 RS |
168 | Use `\\#&' or `\\#N' if you want a number instead of a string. |
169 | ||
170 | In Transient Mark mode, if the mark is active, operate on the contents | |
171 | of the region. Otherwise, operate from point to the end of the buffer. | |
172 | ||
173 | If `query-replace-interactive' is non-nil, the last incremental search | |
174 | regexp is used as REGEXP--you don't have to specify it with the | |
175 | minibuffer. | |
176 | ||
177 | Preserves case in each replacement if `case-replace' and `case-fold-search' | |
178 | are non-nil and REGEXP has no uppercase letters. | |
47d72254 | 179 | |
84482eb3 | 180 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
470bbe9b | 181 | only matches that are surrounded by word boundaries. |
47d72254 | 182 | Fourth and fifth arg START and END specify the region to operate on." |
84482eb3 | 183 | (interactive |
47d72254 GM |
184 | (let (from to start end) |
185 | (when (and transient-mark-mode mark-active) | |
186 | (setq start (region-beginning) | |
187 | end (region-end))) | |
84482eb3 RS |
188 | (if query-replace-interactive |
189 | (setq from (car regexp-search-ring)) | |
190 | (setq from (read-from-minibuffer "Query replace regexp: " | |
191 | nil nil nil | |
192 | query-replace-from-history-variable | |
193 | nil t))) | |
194 | (setq to (list (read-from-minibuffer | |
195 | (format "Query replace regexp %s with eval: " from) | |
196 | nil nil t query-replace-to-history-variable from t))) | |
197 | ;; We make TO a list because replace-match-string-symbols requires one, | |
198 | ;; and the user might enter a single token. | |
199 | (replace-match-string-symbols to) | |
43744cb9 | 200 | (list from (car to) current-prefix-arg start end))) |
d2ce3151 | 201 | (perform-replace regexp (cons 'replace-eval-replacement to-expr) |
99a7559f | 202 | t t delimited nil nil start end)) |
84482eb3 | 203 | |
47d72254 | 204 | (defun map-query-replace-regexp (regexp to-strings &optional n start end) |
da44e784 | 205 | "Replace some matches for REGEXP with various strings, in rotation. |
e730be7f DL |
206 | The second argument TO-STRINGS contains the replacement strings, |
207 | separated by spaces. Third arg DELIMITED (prefix arg if interactive), | |
208 | if non-nil, means replace only matches surrounded by word boundaries. | |
209 | This command works like `query-replace-regexp' except that each | |
210 | successive replacement uses the next successive replacement string, | |
da44e784 RM |
211 | wrapping around from the last such string to the first. |
212 | ||
7ef5c431 KH |
213 | In Transient Mark mode, if the mark is active, operate on the contents |
214 | of the region. Otherwise, operate from point to the end of the buffer. | |
215 | ||
da44e784 RM |
216 | Non-interactively, TO-STRINGS may be a list of replacement strings. |
217 | ||
151270f3 RS |
218 | If `query-replace-interactive' is non-nil, the last incremental search |
219 | regexp is used as REGEXP--you don't have to specify it with the minibuffer. | |
220 | ||
da44e784 | 221 | A prefix argument N says to use each replacement string N times |
47d72254 GM |
222 | before rotating to the next. |
223 | Fourth and fifth arg START and END specify the region to operate on." | |
770970cb | 224 | (interactive |
47d72254 GM |
225 | (let (from to start end) |
226 | (when (and transient-mark-mode mark-active) | |
227 | (setq start (region-beginning) | |
228 | end (region-end))) | |
151270f3 RS |
229 | (setq from (if query-replace-interactive |
230 | (car regexp-search-ring) | |
231 | (read-from-minibuffer "Map query replace (regexp): " | |
232 | nil nil nil | |
fce31d51 | 233 | 'query-replace-history nil t))) |
770970cb RS |
234 | (setq to (read-from-minibuffer |
235 | (format "Query replace %s with (space-separated strings): " | |
236 | from) | |
237 | nil nil nil | |
4a8f3b3d | 238 | 'query-replace-history from t)) |
47d72254 | 239 | (list from to start end current-prefix-arg))) |
da44e784 RM |
240 | (let (replacements) |
241 | (if (listp to-strings) | |
242 | (setq replacements to-strings) | |
243 | (while (/= (length to-strings) 0) | |
244 | (if (string-match " " to-strings) | |
245 | (setq replacements | |
246 | (append replacements | |
247 | (list (substring to-strings 0 | |
248 | (string-match " " to-strings)))) | |
249 | to-strings (substring to-strings | |
250 | (1+ (string-match " " to-strings)))) | |
251 | (setq replacements (append replacements (list to-strings)) | |
252 | to-strings "")))) | |
99a7559f | 253 | (perform-replace regexp replacements t t nil n nil start end))) |
da44e784 | 254 | |
47d72254 | 255 | (defun replace-string (from-string to-string &optional delimited start end) |
da44e784 RM |
256 | "Replace occurrences of FROM-STRING with TO-STRING. |
257 | Preserve case in each match if `case-replace' and `case-fold-search' | |
258 | are non-nil and FROM-STRING has no uppercase letters. | |
9b0bf2b6 RS |
259 | \(Preserving case means that if the string matched is all caps, or capitalized, |
260 | then its replacement is upcased or capitalized.) | |
261 | ||
7ef5c431 KH |
262 | In Transient Mark mode, if the mark is active, operate on the contents |
263 | of the region. Otherwise, operate from point to the end of the buffer. | |
264 | ||
118a01c9 | 265 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 266 | only matches surrounded by word boundaries. |
47d72254 | 267 | Fourth and fifth arg START and END specify the region to operate on. |
da44e784 | 268 | |
151270f3 RS |
269 | If `query-replace-interactive' is non-nil, the last incremental search |
270 | string is used as FROM-STRING--you don't have to specify it with the | |
271 | minibuffer. | |
272 | ||
da44e784 RM |
273 | This function is usually the wrong thing to use in a Lisp program. |
274 | What you probably want is a loop like this: | |
118a01c9 RS |
275 | (while (search-forward FROM-STRING nil t) |
276 | (replace-match TO-STRING nil t)) | |
87532fbe RS |
277 | which will run faster and will not set the mark or print anything. |
278 | \(You may need a more complex loop if FROM-STRING can match the null string | |
279 | and TO-STRING is also null.)" | |
151270f3 | 280 | (interactive (query-replace-read-args "Replace string" nil)) |
99a7559f | 281 | (perform-replace from-string to-string nil nil delimited nil nil start end)) |
da44e784 | 282 | |
47d72254 | 283 | (defun replace-regexp (regexp to-string &optional delimited start end) |
da44e784 | 284 | "Replace things after point matching REGEXP with TO-STRING. |
118a01c9 | 285 | Preserve case in each match if `case-replace' and `case-fold-search' |
da44e784 | 286 | are non-nil and REGEXP has no uppercase letters. |
47d72254 GM |
287 | |
288 | In Transient Mark mode, if the mark is active, operate on the contents | |
289 | of the region. Otherwise, operate from point to the end of the buffer. | |
290 | ||
118a01c9 | 291 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 292 | only matches surrounded by word boundaries. |
47d72254 GM |
293 | Fourth and fifth arg START and END specify the region to operate on. |
294 | ||
118a01c9 RS |
295 | In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP, |
296 | and `\\=\\N' (where N is a digit) stands for | |
880f22a1 | 297 | whatever what matched the Nth `\\(...\\)' in REGEXP. |
da44e784 | 298 | |
151270f3 RS |
299 | If `query-replace-interactive' is non-nil, the last incremental search |
300 | regexp is used as REGEXP--you don't have to specify it with the minibuffer. | |
301 | ||
da44e784 RM |
302 | This function is usually the wrong thing to use in a Lisp program. |
303 | What you probably want is a loop like this: | |
304 | (while (re-search-forward REGEXP nil t) | |
118a01c9 | 305 | (replace-match TO-STRING nil nil)) |
da44e784 | 306 | which will run faster and will not set the mark or print anything." |
151270f3 | 307 | (interactive (query-replace-read-args "Replace regexp" t)) |
99a7559f | 308 | (perform-replace regexp to-string nil t delimited nil nil start end)) |
e32eb3e6 | 309 | |
4c53bd2b RS |
310 | \f |
311 | (defvar regexp-history nil | |
312 | "History list for some commands that read regular expressions.") | |
da44e784 | 313 | |
e32eb3e6 | 314 | |
31e1d920 | 315 | (defalias 'delete-non-matching-lines 'keep-lines) |
e32eb3e6 GM |
316 | (defalias 'delete-matching-lines 'flush-lines) |
317 | (defalias 'count-matches 'how-many) | |
318 | ||
319 | ||
320 | (defun keep-lines-read-args (prompt) | |
321 | "Read arguments for `keep-lines' and friends. | |
322 | Prompt for a regexp with PROMPT. | |
2ced751f RS |
323 | Value is a list, (REGEXP)." |
324 | (list (read-from-minibuffer prompt nil nil nil | |
325 | 'regexp-history nil t))) | |
e32eb3e6 GM |
326 | |
327 | (defun keep-lines (regexp &optional rstart rend) | |
698e1804 RS |
328 | "Delete all lines except those containing matches for REGEXP. |
329 | A match split across lines preserves all the lines it lies in. | |
d2a0ee8b RS |
330 | Applies to all lines after point. |
331 | ||
332 | If REGEXP contains upper case characters (excluding those preceded by `\\'), | |
e32eb3e6 GM |
333 | the matching is case-sensitive. |
334 | ||
335 | Second and third arg RSTART and REND specify the region to operate on. | |
336 | ||
2ced751f RS |
337 | Interactively, in Transient Mark mode when the mark is active, operate |
338 | on the contents of the region. Otherwise, operate from point to the | |
339 | end of the buffer." | |
340 | ||
e32eb3e6 | 341 | (interactive |
98faf1bb RS |
342 | (progn |
343 | (barf-if-buffer-read-only) | |
344 | (keep-lines-read-args "Keep lines (containing match for regexp): "))) | |
e32eb3e6 | 345 | (if rstart |
119831da RS |
346 | (progn |
347 | (goto-char (min rstart rend)) | |
348 | (setq rend (copy-marker (max rstart rend)))) | |
2ced751f RS |
349 | (if (and transient-mark-mode mark-active) |
350 | (setq rstart (region-beginning) | |
351 | rend (copy-marker (region-end))) | |
352 | (setq rstart (point) | |
353 | rend (point-max-marker))) | |
354 | (goto-char rstart)) | |
698e1804 RS |
355 | (save-excursion |
356 | (or (bolp) (forward-line 1)) | |
d2a0ee8b RS |
357 | (let ((start (point)) |
358 | (case-fold-search (and case-fold-search | |
359 | (isearch-no-upper-case-p regexp t)))) | |
e32eb3e6 | 360 | (while (< (point) rend) |
698e1804 | 361 | ;; Start is first char not preserved by previous match. |
e32eb3e6 GM |
362 | (if (not (re-search-forward regexp rend 'move)) |
363 | (delete-region start rend) | |
698e1804 RS |
364 | (let ((end (save-excursion (goto-char (match-beginning 0)) |
365 | (beginning-of-line) | |
366 | (point)))) | |
367 | ;; Now end is first char preserved by the new match. | |
368 | (if (< start end) | |
369 | (delete-region start end)))) | |
d99118b0 | 370 | |
e32eb3e6 | 371 | (setq start (save-excursion (forward-line 1) (point))) |
698e1804 | 372 | ;; If the match was empty, avoid matching again at same place. |
e32eb3e6 GM |
373 | (and (< (point) rend) |
374 | (= (match-beginning 0) (match-end 0)) | |
698e1804 RS |
375 | (forward-char 1)))))) |
376 | ||
e32eb3e6 GM |
377 | |
378 | (defun flush-lines (regexp &optional rstart rend) | |
698e1804 RS |
379 | "Delete lines containing matches for REGEXP. |
380 | If a match is split across lines, all the lines it lies in are deleted. | |
d2a0ee8b RS |
381 | Applies to lines after point. |
382 | ||
383 | If REGEXP contains upper case characters (excluding those preceded by `\\'), | |
e32eb3e6 GM |
384 | the matching is case-sensitive. |
385 | ||
386 | Second and third arg RSTART and REND specify the region to operate on. | |
387 | ||
2ced751f RS |
388 | Interactively, in Transient Mark mode when the mark is active, operate |
389 | on the contents of the region. Otherwise, operate from point to the | |
390 | end of the buffer." | |
391 | ||
e32eb3e6 | 392 | (interactive |
98faf1bb RS |
393 | (progn |
394 | (barf-if-buffer-read-only) | |
395 | (keep-lines-read-args "Flush lines (containing match for regexp): "))) | |
e32eb3e6 | 396 | (if rstart |
119831da RS |
397 | (progn |
398 | (goto-char (min rstart rend)) | |
399 | (setq rend (copy-marker (max rstart rend)))) | |
2ced751f RS |
400 | (if (and transient-mark-mode mark-active) |
401 | (setq rstart (region-beginning) | |
402 | rend (copy-marker (region-end))) | |
403 | (setq rstart (point) | |
404 | rend (point-max-marker))) | |
405 | (goto-char rstart)) | |
d2a0ee8b RS |
406 | (let ((case-fold-search (and case-fold-search |
407 | (isearch-no-upper-case-p regexp t)))) | |
408 | (save-excursion | |
e32eb3e6 GM |
409 | (while (and (< (point) rend) |
410 | (re-search-forward regexp rend t)) | |
d2a0ee8b RS |
411 | (delete-region (save-excursion (goto-char (match-beginning 0)) |
412 | (beginning-of-line) | |
413 | (point)) | |
414 | (progn (forward-line 1) (point))))))) | |
698e1804 | 415 | |
e32eb3e6 GM |
416 | |
417 | (defun how-many (regexp &optional rstart rend) | |
d2a0ee8b RS |
418 | "Print number of matches for REGEXP following point. |
419 | ||
420 | If REGEXP contains upper case characters (excluding those preceded by `\\'), | |
e32eb3e6 GM |
421 | the matching is case-sensitive. |
422 | ||
423 | Second and third arg RSTART and REND specify the region to operate on. | |
424 | ||
2ced751f RS |
425 | Interactively, in Transient Mark mode when the mark is active, operate |
426 | on the contents of the region. Otherwise, operate from point to the | |
427 | end of the buffer." | |
428 | ||
e32eb3e6 GM |
429 | (interactive |
430 | (keep-lines-read-args "How many matches for (regexp): ")) | |
f601efb0 SM |
431 | (save-excursion |
432 | (if rstart | |
433 | (goto-char (min rstart rend)) | |
2ced751f RS |
434 | (if (and transient-mark-mode mark-active) |
435 | (setq rstart (region-beginning) | |
436 | rend (copy-marker (region-end))) | |
437 | (setq rstart (point) | |
438 | rend (point-max-marker))) | |
439 | (goto-char rstart)) | |
f601efb0 SM |
440 | (let ((count 0) |
441 | opoint | |
442 | (case-fold-search (and case-fold-search | |
443 | (isearch-no-upper-case-p regexp t)))) | |
444 | (while (and (< (point) rend) | |
445 | (progn (setq opoint (point)) | |
446 | (re-search-forward regexp rend t))) | |
447 | (if (= opoint (point)) | |
448 | (forward-char 1) | |
449 | (setq count (1+ count)))) | |
450 | (message "%d occurrences" count)))) | |
e32eb3e6 | 451 | |
4c53bd2b | 452 | \f |
f601efb0 SM |
453 | (defvar occur-mode-map |
454 | (let ((map (make-sparse-keymap))) | |
455 | (define-key map [mouse-2] 'occur-mode-mouse-goto) | |
456 | (define-key map "\C-c\C-c" 'occur-mode-goto-occurrence) | |
457 | (define-key map "\C-m" 'occur-mode-goto-occurrence) | |
daae70bf | 458 | (define-key map "o" 'occur-mode-goto-occurrence-other-window) |
365486d6 | 459 | (define-key map "\C-o" 'occur-mode-display-occurrence) |
f601efb0 SM |
460 | (define-key map "\M-n" 'occur-next) |
461 | (define-key map "\M-p" 'occur-prev) | |
d99118b0 SS |
462 | (define-key map "r" 'occur-rename-buffer) |
463 | (define-key map "c" 'clone-buffer) | |
f601efb0 | 464 | (define-key map "g" 'revert-buffer) |
d99118b0 SS |
465 | (define-key map "q" 'quit-window) |
466 | (define-key map "z" 'kill-this-buffer) | |
f601efb0 SM |
467 | map) |
468 | "Keymap for `occur-mode'.") | |
698e1804 | 469 | |
46b3d18e RS |
470 | (defvar occur-revert-arguments nil |
471 | "Arguments to pass to `occur-1' to revert an Occur mode buffer. | |
472 | See `occur-revert-function'.") | |
698e1804 | 473 | |
c9ae8cbb JB |
474 | (defcustom occur-mode-hook '(turn-on-font-lock) |
475 | "Hook run when entering Occur mode." | |
476 | :type 'hook | |
477 | :group 'matching) | |
478 | ||
479 | (defcustom occur-hook nil | |
480 | "Hook run when `occur' is called." | |
daae70bf CW |
481 | :type 'hook |
482 | :group 'matching) | |
483 | ||
de3c9b09 | 484 | (put 'occur-mode 'mode-class 'special) |
505847d4 | 485 | (defun occur-mode () |
698e1804 | 486 | "Major mode for output from \\[occur]. |
0081c8a1 RS |
487 | \\<occur-mode-map>Move point to one of the items in this buffer, then use |
488 | \\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to. | |
489 | Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it. | |
490 | ||
698e1804 | 491 | \\{occur-mode-map}" |
ce8b7b9f | 492 | (interactive) |
505847d4 RS |
493 | (kill-all-local-variables) |
494 | (use-local-map occur-mode-map) | |
495 | (setq major-mode 'occur-mode) | |
496 | (setq mode-name "Occur") | |
f601efb0 | 497 | (set (make-local-variable 'revert-buffer-function) 'occur-revert-function) |
c9ae8cbb | 498 | (make-local-variable 'occur-revert-arguments) |
fbefbe33 | 499 | (add-hook 'change-major-mode-hook 'font-lock-defontify nil t) |
c9ae8cbb | 500 | (run-hooks 'occur-mode-hook)) |
698e1804 | 501 | |
a41284da | 502 | (defun occur-revert-function (ignore1 ignore2) |
46b3d18e | 503 | "Handle `revert-buffer' for Occur mode buffers." |
e1690783 | 504 | (apply 'occur-1 (append occur-revert-arguments (list (buffer-name))))) |
a41284da | 505 | |
78bead73 RS |
506 | (defun occur-mode-mouse-goto (event) |
507 | "In Occur mode, go to the occurrence whose line you click on." | |
508 | (interactive "e") | |
46b3d18e | 509 | (let (pos) |
78bead73 RS |
510 | (save-excursion |
511 | (set-buffer (window-buffer (posn-window (event-end event)))) | |
512 | (save-excursion | |
513 | (goto-char (posn-point (event-end event))) | |
46b3d18e RS |
514 | (setq pos (occur-mode-find-occurrence)))) |
515 | (pop-to-buffer (marker-buffer pos)) | |
516 | (goto-char pos))) | |
78bead73 RS |
517 | |
518 | (defun occur-mode-find-occurrence () | |
46b3d18e RS |
519 | (let ((pos (get-text-property (point) 'occur-target))) |
520 | (unless pos | |
68608d9c | 521 | (error "No occurrence on this line")) |
46b3d18e RS |
522 | (unless (buffer-live-p (marker-buffer pos)) |
523 | (error "Buffer for this occurrence was killed")) | |
524 | pos)) | |
78bead73 RS |
525 | |
526 | (defun occur-mode-goto-occurrence () | |
527 | "Go to the occurrence the current line describes." | |
528 | (interactive) | |
46b3d18e RS |
529 | (let ((pos (occur-mode-find-occurrence))) |
530 | (pop-to-buffer (marker-buffer pos)) | |
531 | (goto-char pos))) | |
8d15583f | 532 | |
029024e2 RS |
533 | (defun occur-mode-goto-occurrence-other-window () |
534 | "Go to the occurrence the current line describes, in another window." | |
535 | (interactive) | |
46b3d18e RS |
536 | (let ((pos (occur-mode-find-occurrence))) |
537 | (switch-to-buffer-other-window (marker-buffer pos)) | |
538 | (goto-char pos))) | |
029024e2 | 539 | |
365486d6 RS |
540 | (defun occur-mode-display-occurrence () |
541 | "Display in another window the occurrence the current line describes." | |
542 | (interactive) | |
46b3d18e RS |
543 | (let ((pos (occur-mode-find-occurrence)) |
544 | window | |
545 | ;; Bind these to ensure `display-buffer' puts it in another window. | |
365486d6 | 546 | same-window-buffer-names |
46b3d18e RS |
547 | same-window-regexps) |
548 | (setq window (display-buffer (marker-buffer pos))) | |
365486d6 RS |
549 | ;; This is the way to set point in the proper window. |
550 | (save-selected-window | |
551 | (select-window window) | |
46b3d18e | 552 | (goto-char pos)))) |
365486d6 | 553 | |
123d5548 | 554 | (defun occur-find-match (n search message) |
8d15583f RS |
555 | (if (not n) (setq n 1)) |
556 | (let ((r)) | |
557 | (while (> n 0) | |
123d5548 JB |
558 | (setq r (funcall search (point) 'occur-match)) |
559 | (and r | |
560 | (get-text-property r 'occur-match) | |
561 | (setq r (funcall search r 'occur-match))) | |
8d15583f | 562 | (if r |
123d5548 JB |
563 | (goto-char r) |
564 | (error message)) | |
8d15583f RS |
565 | (setq n (1- n))))) |
566 | ||
123d5548 JB |
567 | (defun occur-next (&optional n) |
568 | "Move to the Nth (default 1) next match in an Occur mode buffer." | |
569 | (interactive "p") | |
570 | (occur-find-match n #'next-single-property-change "No more matches")) | |
571 | ||
8d15583f | 572 | (defun occur-prev (&optional n) |
46b3d18e | 573 | "Move to the Nth (default 1) previous match in an Occur mode buffer." |
8d15583f | 574 | (interactive "p") |
123d5548 | 575 | (occur-find-match n #'previous-single-property-change "No earlier matches")) |
4c53bd2b | 576 | \f |
9d325ebf | 577 | (defcustom list-matching-lines-default-context-lines 0 |
e730be7f DL |
578 | "*Default number of context lines included around `list-matching-lines' matches. |
579 | A negative number means to include that many lines before the match. | |
9d325ebf RS |
580 | A positive number means to include that many lines both before and after." |
581 | :type 'integer | |
582 | :group 'matching) | |
698e1804 | 583 | |
31e1d920 | 584 | (defalias 'list-matching-lines 'occur) |
698e1804 | 585 | |
68608d9c | 586 | (defcustom list-matching-lines-face 'bold |
e730be7f | 587 | "*Face used by \\[list-matching-lines] to show the text that matches. |
68608d9c CW |
588 | If the value is nil, don't highlight the matching portions specially." |
589 | :type 'face | |
590 | :group 'matching) | |
591 | ||
592 | (defcustom list-matching-lines-buffer-name-face 'underline | |
593 | "*Face used by \\[list-matching-lines] to show the names of buffers. | |
594 | If the value is nil, don't highlight the buffer names specially." | |
595 | :type 'face | |
596 | :group 'matching) | |
597 | ||
9e2b2e30 | 598 | (defun occur-accumulate-lines (count &optional no-props) |
68608d9c CW |
599 | (save-excursion |
600 | (let ((forwardp (> count 0)) | |
601 | (result nil)) | |
602 | (while (not (or (zerop count) | |
603 | (if forwardp | |
604 | (eobp) | |
605 | (bobp)))) | |
b0523087 | 606 | (setq count (+ count (if forwardp -1 1))) |
68608d9c | 607 | (push |
9e2b2e30 CW |
608 | (funcall (if no-props |
609 | #'buffer-substring-no-properties | |
610 | #'buffer-substring) | |
68608d9c CW |
611 | (line-beginning-position) |
612 | (line-end-position)) | |
613 | result) | |
614 | (forward-line (if forwardp 1 -1))) | |
615 | (nreverse result)))) | |
616 | ||
617 | (defun occur-read-primary-args () | |
618 | (list (let* ((default (car regexp-history)) | |
619 | (input | |
620 | (read-from-minibuffer | |
621 | (if default | |
622 | (format "List lines matching regexp (default `%s'): " | |
623 | default) | |
624 | "List lines matching regexp: ") | |
625 | nil | |
626 | nil | |
627 | nil | |
628 | 'regexp-history))) | |
629 | (if (equal input "") | |
630 | default | |
631 | input)) | |
bda1925e CW |
632 | (when current-prefix-arg |
633 | (prefix-numeric-value current-prefix-arg)))) | |
c9daced0 | 634 | |
d99118b0 SS |
635 | (defun occur-rename-buffer (&optional unique-p) |
636 | "Rename the current *Occur* buffer to *Occur: original-buffer-name*. | |
637 | Here `original-buffer-name' is the buffer name were occur was originally run. | |
638 | When given the prefix argument, the renaming will not clobber the existing | |
639 | buffer(s) of that name, but use `generate-new-buffer-name' instead. | |
2fb79329 | 640 | You can add this to `occur-hook' if you always want a separate *Occur* |
d99118b0 SS |
641 | buffer for each buffer where you invoke `occur'." |
642 | (interactive "P") | |
643 | (with-current-buffer | |
644 | (if (eq major-mode 'occur-mode) (current-buffer) (get-buffer "*Occur*")) | |
645 | (rename-buffer (concat "*Occur: " | |
646 | (mapconcat #'buffer-name | |
647 | (car (cddr occur-revert-arguments)) "/") | |
648 | "*") | |
649 | unique-p))) | |
650 | ||
698e1804 | 651 | (defun occur (regexp &optional nlines) |
99976f85 | 652 | "Show all lines in the current buffer containing a match for REGEXP. |
da44e784 RM |
653 | |
654 | If a match spreads across multiple lines, all those lines are shown. | |
698e1804 | 655 | |
da44e784 RM |
656 | Each line is displayed with NLINES lines before and after, or -NLINES |
657 | before if NLINES is negative. | |
658 | NLINES defaults to `list-matching-lines-default-context-lines'. | |
698e1804 RS |
659 | Interactively it is the prefix arg. |
660 | ||
4c53bd2b | 661 | The lines are shown in a buffer named `*Occur*'. |
698e1804 | 662 | It serves as a menu to find any of the occurrences in this buffer. |
de3c9b09 | 663 | \\<occur-mode-map>\\[describe-mode] in that buffer will explain how. |
9483d601 | 664 | |
de3c9b09 RS |
665 | If REGEXP contains upper case characters (excluding those preceded by `\\'), |
666 | the matching is case-sensitive." | |
68608d9c CW |
667 | (interactive (occur-read-primary-args)) |
668 | (occur-1 regexp nlines (list (current-buffer)))) | |
669 | ||
670 | (defun multi-occur (bufs regexp &optional nlines) | |
671 | "Show all lines in buffers BUFS containing a match for REGEXP. | |
672 | This function acts on multiple buffers; otherwise, it is exactly like | |
673 | `occur'." | |
a5dfed3e | 674 | (interactive |
68608d9c | 675 | (cons |
52698d45 KS |
676 | (let* ((bufs (list (read-buffer "First buffer to search: " |
677 | (current-buffer) t))) | |
678 | (buf nil) | |
679 | (ido-ignore-item-temp-list bufs)) | |
68608d9c | 680 | (while (not (string-equal |
52698d45 KS |
681 | (setq buf (read-buffer |
682 | (if (eq read-buffer-function 'ido-read-buffer) | |
683 | "Next buffer to search (C-j to end): " | |
684 | "Next buffer to search (RET to end): ") | |
685 | nil t)) | |
68608d9c | 686 | "")) |
52698d45 KS |
687 | (add-to-list 'bufs buf) |
688 | (setq ido-ignore-item-temp-list bufs)) | |
68608d9c CW |
689 | (nreverse (mapcar #'get-buffer bufs))) |
690 | (occur-read-primary-args))) | |
691 | (occur-1 regexp nlines bufs)) | |
692 | ||
693 | (defun multi-occur-by-filename-regexp (bufregexp regexp &optional nlines) | |
04fe158a | 694 | "Show all lines matching REGEXP in buffers named by BUFREGEXP. |
68608d9c CW |
695 | See also `multi-occur'." |
696 | (interactive | |
697 | (cons | |
698 | (let* ((default (car regexp-history)) | |
699 | (input | |
700 | (read-from-minibuffer | |
701 | "List lines in buffers whose filename matches regexp: " | |
702 | nil | |
703 | nil | |
704 | nil | |
705 | 'regexp-history))) | |
706 | (if (equal input "") | |
707 | default | |
708 | input)) | |
709 | (occur-read-primary-args))) | |
710 | (when bufregexp | |
711 | (occur-1 regexp nlines | |
712 | (delq nil | |
713 | (mapcar (lambda (buf) | |
714 | (when (and (buffer-file-name buf) | |
715 | (string-match bufregexp | |
716 | (buffer-file-name buf))) | |
717 | buf)) | |
718 | (buffer-list)))))) | |
719 | ||
e1690783 CW |
720 | (defun occur-1 (regexp nlines bufs &optional buf-name) |
721 | (unless buf-name | |
722 | (setq buf-name "*Occur*")) | |
723 | (let ((occur-buf (get-buffer-create buf-name)) | |
70ed2a76 CW |
724 | (made-temp-buf nil) |
725 | (active-bufs (delq nil (mapcar #'(lambda (buf) | |
726 | (when (buffer-live-p buf) buf)) | |
727 | bufs)))) | |
728 | ;; Handle the case where one of the buffers we're searching is the | |
729 | ;; *Occur* buffer itself. | |
730 | (when (memq occur-buf bufs) | |
731 | (setq occur-buf (with-current-buffer occur-buf | |
732 | (clone-buffer "*Occur-temp*")) | |
733 | made-temp-buf t)) | |
68608d9c CW |
734 | (with-current-buffer occur-buf |
735 | (setq buffer-read-only nil) | |
736 | (occur-mode) | |
737 | (erase-buffer) | |
738 | (let ((count (occur-engine | |
70ed2a76 | 739 | regexp active-bufs occur-buf |
68608d9c CW |
740 | (or nlines list-matching-lines-default-context-lines) |
741 | (and case-fold-search | |
742 | (isearch-no-upper-case-p regexp t)) | |
506a6d7e CW |
743 | list-matching-lines-buffer-name-face |
744 | nil list-matching-lines-face nil))) | |
b2043e7b AS |
745 | (let* ((bufcount (length active-bufs)) |
746 | (diff (- (length bufs) bufcount))) | |
747 | (message "Searched %d buffer%s%s; %s match%s for `%s'" | |
748 | bufcount (if (= bufcount 1) "" "s") | |
749 | (if (zerop diff) "" (format " (%d killed)" diff)) | |
750 | (if (zerop count) "no" (format "%d" count)) | |
751 | (if (= count 1) "" "es") | |
752 | regexp)) | |
70ed2a76 CW |
753 | ;; If we had to make a temporary buffer, make it the *Occur* |
754 | ;; buffer now. | |
755 | (when made-temp-buf | |
e1690783 CW |
756 | (with-current-buffer (get-buffer buf-name) |
757 | (kill-buffer (current-buffer))) | |
758 | (rename-buffer buf-name)) | |
70ed2a76 CW |
759 | (setq occur-revert-arguments (list regexp nlines bufs) |
760 | buffer-read-only t) | |
68608d9c CW |
761 | (if (> count 0) |
762 | (display-buffer occur-buf) | |
2fb79329 JB |
763 | (kill-buffer occur-buf))) |
764 | (run-hooks 'occur-hook)))) | |
68608d9c | 765 | |
46b3d18e RS |
766 | (defun occur-engine-add-prefix (lines) |
767 | (mapcar | |
768 | #'(lambda (line) | |
261cca88 | 769 | (concat " :" line "\n")) |
46b3d18e RS |
770 | lines)) |
771 | ||
772 | (defun occur-engine (regexp buffers out-buf nlines case-fold-search | |
773 | title-face prefix-face match-face keep-props) | |
774 | (with-current-buffer out-buf | |
775 | (setq buffer-read-only nil) | |
776 | (let ((globalcount 0)) | |
777 | ;; Map over all the buffers | |
778 | (dolist (buf buffers) | |
779 | (when (buffer-live-p buf) | |
780 | (let ((matches 0) ;; count of matched lines | |
781 | (lines 1) ;; line count | |
782 | (matchbeg 0) | |
783 | (matchend 0) | |
784 | (origpt nil) | |
785 | (begpt nil) | |
786 | (endpt nil) | |
787 | (marker nil) | |
788 | (curstring "") | |
789 | (headerpt (with-current-buffer out-buf (point)))) | |
790 | (save-excursion | |
791 | (set-buffer buf) | |
68608d9c | 792 | (save-excursion |
46b3d18e RS |
793 | (goto-char (point-min)) ;; begin searching in the buffer |
794 | (while (not (eobp)) | |
795 | (setq origpt (point)) | |
796 | (when (setq endpt (re-search-forward regexp nil t)) | |
797 | (setq matches (1+ matches)) ;; increment match count | |
46b3d18e RS |
798 | (setq matchbeg (match-beginning 0) |
799 | matchend (match-end 0)) | |
800 | (setq begpt (save-excursion | |
801 | (goto-char matchbeg) | |
802 | (line-beginning-position))) | |
803 | (setq lines (+ lines (1- (count-lines origpt endpt)))) | |
804 | (setq marker (make-marker)) | |
805 | (set-marker marker matchbeg) | |
806 | (setq curstring (buffer-substring begpt | |
807 | (line-end-position))) | |
808 | ;; Depropertize the string, and maybe | |
809 | ;; highlight the matches | |
810 | (let ((len (length curstring)) | |
811 | (start 0)) | |
812 | (unless keep-props | |
813 | (set-text-properties 0 len nil curstring)) | |
814 | (while (and (< start len) | |
815 | (string-match regexp curstring start)) | |
816 | (add-text-properties (match-beginning 0) | |
817 | (match-end 0) | |
818 | (append | |
506a6d7e | 819 | `(occur-match t) |
46b3d18e | 820 | (when match-face |
506a6d7e | 821 | `(font-lock-face ,match-face))) |
46b3d18e RS |
822 | curstring) |
823 | (setq start (match-end 0)))) | |
824 | ;; Generate the string to insert for this match | |
825 | (let* ((out-line | |
826 | (concat | |
261cca88 RS |
827 | ;; Using 7 digits aligns tabs properly. |
828 | (apply #'propertize (format "%7d:" lines) | |
46b3d18e RS |
829 | (append |
830 | (when prefix-face | |
506a6d7e | 831 | `(font-lock-face prefix-face)) |
46b3d18e RS |
832 | '(occur-prefix t))) |
833 | curstring | |
834 | "\n")) | |
835 | (data | |
836 | (if (= nlines 0) | |
837 | ;; The simple display style | |
838 | out-line | |
839 | ;; The complex multi-line display | |
840 | ;; style. Generate a list of lines, | |
841 | ;; concatenate them all together. | |
842 | (apply #'concat | |
843 | (nconc | |
b0523087 | 844 | (occur-engine-add-prefix (nreverse (cdr (occur-accumulate-lines (- (1+ nlines)) keep-props)))) |
46b3d18e | 845 | (list out-line) |
b0523087 | 846 | (occur-engine-add-prefix (cdr (occur-accumulate-lines (1+ nlines) keep-props)))))))) |
46b3d18e RS |
847 | ;; Actually insert the match display data |
848 | (with-current-buffer out-buf | |
849 | (let ((beg (point)) | |
850 | (end (progn (insert data) (point)))) | |
851 | (unless (= nlines 0) | |
852 | (insert "-------\n")) | |
853 | (add-text-properties | |
e8e2a88c CW |
854 | beg end |
855 | `(occur-target ,marker help-echo "mouse-2: go to this occurrence")) | |
856 | ;; We don't put `mouse-face' on the newline, | |
857 | ;; because that loses. | |
858 | (add-text-properties beg (1- end) '(mouse-face highlight))))) | |
46b3d18e | 859 | (goto-char endpt)) |
e1690783 CW |
860 | (if endpt |
861 | (progn | |
862 | (setq lines (1+ lines)) | |
863 | ;; On to the next match... | |
864 | (forward-line 1)) | |
865 | (goto-char (point-max)))))) | |
46b3d18e | 866 | (when (not (zerop matches)) ;; is the count zero? |
daae70bf | 867 | (setq globalcount (+ globalcount matches)) |
46b3d18e RS |
868 | (with-current-buffer out-buf |
869 | (goto-char headerpt) | |
870 | (let ((beg (point)) | |
871 | end) | |
872 | (insert (format "%d lines matching \"%s\" in buffer: %s\n" | |
873 | matches regexp (buffer-name buf))) | |
874 | (setq end (point)) | |
875 | (add-text-properties beg end | |
876 | (append | |
877 | (when title-face | |
506a6d7e CW |
878 | `(font-lock-face ,title-face)) |
879 | `(occur-title ,buf)))) | |
46b3d18e RS |
880 | (goto-char (point-min))))))) |
881 | ;; Return the number of matches | |
882 | globalcount))) | |
68608d9c | 883 | |
698e1804 | 884 | \f |
81bdc14d RS |
885 | ;; It would be nice to use \\[...], but there is no reasonable way |
886 | ;; to make that display both SPC and Y. | |
698e1804 RS |
887 | (defconst query-replace-help |
888 | "Type Space or `y' to replace one match, Delete or `n' to skip to next, | |
be44f62c | 889 | RET or `q' to exit, Period to replace one match and exit, |
698e1804 RS |
890 | Comma to replace but not move point immediately, |
891 | C-r to enter recursive edit (\\[exit-recursive-edit] to get out again), | |
892 | C-w to delete match and recursive edit, | |
893 | C-l to clear the screen, redisplay, and offer same replacement again, | |
894 | ! to replace all remaining matches with no more questions, | |
7ce278f3 GM |
895 | ^ to move point back to previous match, |
896 | E to edit the replacement string" | |
f54701d1 | 897 | "Help message while in `query-replace'.") |
698e1804 | 898 | |
81bdc14d RS |
899 | (defvar query-replace-map (make-sparse-keymap) |
900 | "Keymap that defines the responses to questions in `query-replace'. | |
901 | The \"bindings\" in this map are not commands; they are answers. | |
902 | The valid answers include `act', `skip', `act-and-show', | |
903 | `exit', `act-and-exit', `edit', `delete-and-edit', `recenter', | |
d9121bc0 | 904 | `automatic', `backup', `exit-prefix', and `help'.") |
81bdc14d RS |
905 | |
906 | (define-key query-replace-map " " 'act) | |
907 | (define-key query-replace-map "\d" 'skip) | |
908 | (define-key query-replace-map [delete] 'skip) | |
9275e5e3 | 909 | (define-key query-replace-map [backspace] 'skip) |
81bdc14d RS |
910 | (define-key query-replace-map "y" 'act) |
911 | (define-key query-replace-map "n" 'skip) | |
633a305a RS |
912 | (define-key query-replace-map "Y" 'act) |
913 | (define-key query-replace-map "N" 'skip) | |
34724fcb | 914 | (define-key query-replace-map "e" 'edit-replacement) |
7ce278f3 | 915 | (define-key query-replace-map "E" 'edit-replacement) |
81bdc14d | 916 | (define-key query-replace-map "," 'act-and-show) |
81bdc14d | 917 | (define-key query-replace-map "q" 'exit) |
919592c0 | 918 | (define-key query-replace-map "\r" 'exit) |
384c7da4 | 919 | (define-key query-replace-map [return] 'exit) |
81bdc14d RS |
920 | (define-key query-replace-map "." 'act-and-exit) |
921 | (define-key query-replace-map "\C-r" 'edit) | |
922 | (define-key query-replace-map "\C-w" 'delete-and-edit) | |
923 | (define-key query-replace-map "\C-l" 'recenter) | |
924 | (define-key query-replace-map "!" 'automatic) | |
925 | (define-key query-replace-map "^" 'backup) | |
926 | (define-key query-replace-map "\C-h" 'help) | |
e731045a KH |
927 | (define-key query-replace-map [f1] 'help) |
928 | (define-key query-replace-map [help] 'help) | |
81bdc14d | 929 | (define-key query-replace-map "?" 'help) |
bc6312e1 RS |
930 | (define-key query-replace-map "\C-g" 'quit) |
931 | (define-key query-replace-map "\C-]" 'quit) | |
d9121bc0 RS |
932 | (define-key query-replace-map "\e" 'exit-prefix) |
933 | (define-key query-replace-map [escape] 'exit-prefix) | |
81bdc14d | 934 | |
84482eb3 | 935 | (defun replace-match-string-symbols (n) |
e730be7f DL |
936 | "Process a list (and any sub-lists), expanding certain symbols. |
937 | Symbol Expands To | |
938 | N (match-string N) (where N is a string of digits) | |
939 | #N (string-to-number (match-string N)) | |
940 | & (match-string 0) | |
941 | #& (string-to-number (match-string 0)) | |
942 | ||
943 | Note that these symbols must be preceeded by a backslash in order to | |
944 | type them." | |
84482eb3 RS |
945 | (while n |
946 | (cond | |
947 | ((consp (car n)) | |
948 | (replace-match-string-symbols (car n))) ;Process sub-list | |
949 | ((symbolp (car n)) | |
950 | (let ((name (symbol-name (car n)))) | |
951 | (cond | |
952 | ((string-match "^[0-9]+$" name) | |
953 | (setcar n (list 'match-string (string-to-number name)))) | |
954 | ((string-match "^#[0-9]+$" name) | |
955 | (setcar n (list 'string-to-number | |
956 | (list 'match-string | |
957 | (string-to-number (substring name 1)))))) | |
958 | ((string= "&" name) | |
959 | (setcar n '(match-string 0))) | |
960 | ((string= "#&" name) | |
961 | (setcar n '(string-to-number (match-string 0)))))))) | |
962 | (setq n (cdr n)))) | |
963 | ||
964 | (defun replace-eval-replacement (expression replace-count) | |
965 | (let ((replacement (eval expression))) | |
966 | (if (stringp replacement) | |
967 | replacement | |
968 | (prin1-to-string replacement t)))) | |
969 | ||
970 | (defun replace-loop-through-replacements (data replace-count) | |
971 | ;; DATA is a vector contaning the following values: | |
972 | ;; 0 next-rotate-count | |
973 | ;; 1 repeat-count | |
974 | ;; 2 next-replacement | |
975 | ;; 3 replacements | |
976 | (if (= (aref data 0) replace-count) | |
977 | (progn | |
978 | (aset data 0 (+ replace-count (aref data 1))) | |
979 | (let ((next (cdr (aref data 2)))) | |
980 | (aset data 2 (if (consp next) next (aref data 3)))))) | |
981 | (car (aref data 2))) | |
982 | ||
d99118b0 | 983 | (defun perform-replace (from-string replacements |
698e1804 | 984 | query-flag regexp-flag delimited-flag |
99a7559f | 985 | &optional repeat-count map start end) |
698e1804 RS |
986 | "Subroutine of `query-replace'. Its complexity handles interactive queries. |
987 | Don't use this in your own program unless you want to query and set the mark | |
988 | just as `query-replace' does. Instead, write a simple loop like this: | |
698665d1 GM |
989 | |
990 | (while (re-search-forward \"foo[ \\t]+bar\" nil t) | |
698e1804 | 991 | (replace-match \"foobar\" nil nil)) |
698665d1 GM |
992 | |
993 | which will run faster and probably do exactly what you want. Please | |
994 | see the documentation of `replace-match' to find out how to simulate | |
588c915a CW |
995 | `case-replace'. |
996 | ||
997 | This function returns nil if and only if there were no matches to | |
998 | make, or the user didn't cancel the call." | |
81bdc14d | 999 | (or map (setq map query-replace-map)) |
1c1dadab RS |
1000 | (and query-flag minibuffer-auto-raise |
1001 | (raise-frame (window-frame (minibuffer-window)))) | |
698e1804 RS |
1002 | (let ((nocasify (not (and case-fold-search case-replace |
1003 | (string-equal from-string | |
1004 | (downcase from-string))))) | |
5a78b471 KH |
1005 | (case-fold-search (and case-fold-search |
1006 | (string-equal from-string | |
1007 | (downcase from-string)))) | |
698e1804 RS |
1008 | (literal (not regexp-flag)) |
1009 | (search-function (if regexp-flag 're-search-forward 'search-forward)) | |
1010 | (search-string from-string) | |
e5d77022 | 1011 | (real-match-data nil) ; the match data for the current match |
698e1804 | 1012 | (next-replacement nil) |
698e1804 RS |
1013 | (keep-going t) |
1014 | (stack nil) | |
698e1804 | 1015 | (replace-count 0) |
5632eb27 PE |
1016 | (nonempty-match nil) |
1017 | ||
7ef5c431 KH |
1018 | ;; If non-nil, it is marker saying where in the buffer to stop. |
1019 | (limit nil) | |
1020 | ||
5632eb27 PE |
1021 | ;; Data for the next match. If a cons, it has the same format as |
1022 | ;; (match-data); otherwise it is t if a match is possible at point. | |
ae4eb03c | 1023 | (match-again t) |
5632eb27 | 1024 | |
02d95a27 RS |
1025 | (message |
1026 | (if query-flag | |
1027 | (substitute-command-keys | |
1028 | "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) ")))) | |
7ef5c431 KH |
1029 | |
1030 | ;; If region is active, in Transient Mark mode, operate on region. | |
47d72254 GM |
1031 | (when start |
1032 | (setq limit (copy-marker (max start end))) | |
1033 | (goto-char (min start end)) | |
1034 | (deactivate-mark)) | |
84482eb3 RS |
1035 | |
1036 | ;; REPLACEMENTS is either a string, a list of strings, or a cons cell | |
1037 | ;; containing a function and its first argument. The function is | |
1038 | ;; called to generate each replacement like this: | |
1039 | ;; (funcall (car replacements) (cdr replacements) replace-count) | |
1040 | ;; It must return a string. | |
1041 | (cond | |
1042 | ((stringp replacements) | |
1043 | (setq next-replacement replacements | |
1044 | replacements nil)) | |
1045 | ((stringp (car replacements)) ; If it isn't a string, it must be a cons | |
1046 | (or repeat-count (setq repeat-count 1)) | |
1047 | (setq replacements (cons 'replace-loop-through-replacements | |
1048 | (vector repeat-count repeat-count | |
1049 | replacements replacements))))) | |
1050 | ||
698e1804 RS |
1051 | (if delimited-flag |
1052 | (setq search-function 're-search-forward | |
1053 | search-string (concat "\\b" | |
1054 | (if regexp-flag from-string | |
1055 | (regexp-quote from-string)) | |
1056 | "\\b"))) | |
1057 | (push-mark) | |
1058 | (undo-boundary) | |
e782e9f2 RS |
1059 | (unwind-protect |
1060 | ;; Loop finding occurrences that perhaps should be replaced. | |
1061 | (while (and keep-going | |
1062 | (not (eobp)) | |
5632eb27 PE |
1063 | ;; Use the next match if it is already known; |
1064 | ;; otherwise, search for a match after moving forward | |
1065 | ;; one char if progress is required. | |
1066 | (setq real-match-data | |
1067 | (if (consp match-again) | |
1068 | (progn (goto-char (nth 1 match-again)) | |
1069 | match-again) | |
1070 | (and (or match-again | |
889617de GM |
1071 | ;; MATCH-AGAIN non-nil means we |
1072 | ;; accept an adjacent match. If | |
1073 | ;; we don't, move one char to the | |
1074 | ;; right. This takes us a | |
1075 | ;; character too far at the end, | |
1076 | ;; but this is undone after the | |
1077 | ;; while-loop. | |
8f3ff96b | 1078 | (progn (forward-char 1) (not (eobp)))) |
7ef5c431 | 1079 | (funcall search-function search-string limit t) |
5632eb27 PE |
1080 | ;; For speed, use only integers and |
1081 | ;; reuse the list used last time. | |
1082 | (match-data t real-match-data))))) | |
1c4fe319 RS |
1083 | ;; Optionally ignore matches that have a read-only property. |
1084 | (unless (and query-replace-skip-read-only | |
1085 | (text-property-not-all | |
1086 | (match-beginning 0) (match-end 0) | |
1087 | 'read-only nil)) | |
1088 | ||
1089 | ;; Record whether the match is nonempty, to avoid an infinite loop | |
1090 | ;; repeatedly matching the same empty string. | |
1091 | (setq nonempty-match | |
1092 | (/= (nth 0 real-match-data) (nth 1 real-match-data))) | |
1093 | ||
1094 | ;; If the match is empty, record that the next one can't be | |
1095 | ;; adjacent. | |
1096 | ||
1097 | ;; Otherwise, if matching a regular expression, do the next | |
1098 | ;; match now, since the replacement for this match may | |
1099 | ;; affect whether the next match is adjacent to this one. | |
1100 | ;; If that match is empty, don't use it. | |
1101 | (setq match-again | |
1102 | (and nonempty-match | |
1103 | (or (not regexp-flag) | |
1104 | (and (looking-at search-string) | |
1105 | (let ((match (match-data))) | |
1106 | (and (/= (nth 0 match) (nth 1 match)) | |
1107 | match)))))) | |
1108 | ||
1109 | ;; Calculate the replacement string, if necessary. | |
1110 | (when replacements | |
1111 | (set-match-data real-match-data) | |
1112 | (setq next-replacement | |
1113 | (funcall (car replacements) (cdr replacements) | |
1114 | replace-count))) | |
1115 | (if (not query-flag) | |
1116 | (let ((inhibit-read-only query-replace-skip-read-only)) | |
1117 | (set-match-data real-match-data) | |
1118 | (replace-match next-replacement nocasify literal) | |
1119 | (setq replace-count (1+ replace-count))) | |
1120 | (undo-boundary) | |
1121 | (let (done replaced key def) | |
1122 | ;; Loop reading commands until one of them sets done, | |
1123 | ;; which means it has finished handling this occurrence. | |
1124 | (while (not done) | |
1125 | (set-match-data real-match-data) | |
1126 | (replace-highlight (match-beginning 0) (match-end 0)) | |
1127 | ;; Bind message-log-max so we don't fill up the message log | |
1128 | ;; with a bunch of identical messages. | |
1129 | (let ((message-log-max nil)) | |
1130 | (message message from-string next-replacement)) | |
1131 | (setq key (read-event)) | |
1132 | ;; Necessary in case something happens during read-event | |
1133 | ;; that clobbers the match data. | |
1134 | (set-match-data real-match-data) | |
1135 | (setq key (vector key)) | |
1136 | (setq def (lookup-key map key)) | |
1137 | ;; Restore the match data while we process the command. | |
1138 | (cond ((eq def 'help) | |
1139 | (with-output-to-temp-buffer "*Help*" | |
1140 | (princ | |
1141 | (concat "Query replacing " | |
1142 | (if regexp-flag "regexp " "") | |
1143 | from-string " with " | |
1144 | next-replacement ".\n\n" | |
1145 | (substitute-command-keys | |
1146 | query-replace-help))) | |
1147 | (with-current-buffer standard-output | |
1148 | (help-mode)))) | |
1149 | ((eq def 'exit) | |
1150 | (setq keep-going nil) | |
1151 | (setq done t)) | |
1152 | ((eq def 'backup) | |
1153 | (if stack | |
588c915a | 1154 | (let ((elt (pop stack))) |
1c4fe319 RS |
1155 | (goto-char (car elt)) |
1156 | (setq replaced (eq t (cdr elt))) | |
1157 | (or replaced | |
588c915a | 1158 | (set-match-data (cdr elt)))) |
1c4fe319 RS |
1159 | (message "No previous match") |
1160 | (ding 'no-terminate) | |
1161 | (sit-for 1))) | |
1162 | ((eq def 'act) | |
1163 | (or replaced | |
1164 | (progn | |
1165 | (replace-match next-replacement nocasify literal) | |
1166 | (setq replace-count (1+ replace-count)))) | |
1167 | (setq done t replaced t)) | |
1168 | ((eq def 'act-and-exit) | |
1169 | (or replaced | |
1170 | (progn | |
1171 | (replace-match next-replacement nocasify literal) | |
1172 | (setq replace-count (1+ replace-count)))) | |
1173 | (setq keep-going nil) | |
1174 | (setq done t replaced t)) | |
1175 | ((eq def 'act-and-show) | |
1176 | (if (not replaced) | |
1177 | (progn | |
1178 | (replace-match next-replacement nocasify literal) | |
1179 | (setq replace-count (1+ replace-count)) | |
1180 | (setq replaced t)))) | |
1181 | ((eq def 'automatic) | |
1182 | (or replaced | |
1183 | (progn | |
1184 | (replace-match next-replacement nocasify literal) | |
1185 | (setq replace-count (1+ replace-count)))) | |
1186 | (setq done t query-flag nil replaced t)) | |
1187 | ((eq def 'skip) | |
1188 | (setq done t)) | |
1189 | ((eq def 'recenter) | |
1190 | (recenter nil)) | |
1191 | ((eq def 'edit) | |
1192 | (let ((opos (point-marker))) | |
1193 | (goto-char (match-beginning 0)) | |
1194 | (save-excursion | |
1195 | (funcall search-function search-string limit t) | |
1196 | (setq real-match-data (match-data))) | |
86914dcc RS |
1197 | (save-excursion |
1198 | (save-window-excursion | |
1199 | (recursive-edit))) | |
1c4fe319 RS |
1200 | (goto-char opos)) |
1201 | (set-match-data real-match-data) | |
1202 | ;; Before we make the replacement, | |
1203 | ;; decide whether the search string | |
1204 | ;; can match again just after this match. | |
1205 | (if (and regexp-flag nonempty-match) | |
1206 | (setq match-again (and (looking-at search-string) | |
1207 | (match-data))))) | |
d99118b0 | 1208 | |
1c4fe319 RS |
1209 | ;; Edit replacement. |
1210 | ((eq def 'edit-replacement) | |
1211 | (setq next-replacement | |
1212 | (read-input "Edit replacement string: " | |
1213 | next-replacement)) | |
1214 | (or replaced | |
1215 | (replace-match next-replacement nocasify literal)) | |
1216 | (setq done t)) | |
d99118b0 | 1217 | |
1c4fe319 RS |
1218 | ((eq def 'delete-and-edit) |
1219 | (delete-region (match-beginning 0) (match-end 0)) | |
1220 | (set-match-data | |
1221 | (prog1 (match-data) | |
1222 | (save-excursion (recursive-edit)))) | |
1223 | (setq replaced t)) | |
1224 | ;; Note: we do not need to treat `exit-prefix' | |
1225 | ;; specially here, since we reread | |
1226 | ;; any unrecognized character. | |
1227 | (t | |
1228 | (setq this-command 'mode-exited) | |
1229 | (setq keep-going nil) | |
1230 | (setq unread-command-events | |
1231 | (append (listify-key-sequence key) | |
1232 | unread-command-events)) | |
1233 | (setq done t)))) | |
1234 | ;; Record previous position for ^ when we move on. | |
1235 | ;; Change markers to numbers in the match data | |
1236 | ;; since lots of markers slow down editing. | |
1237 | (setq stack | |
1238 | (cons (cons (point) | |
1239 | (or replaced (match-data t))) | |
1240 | stack)))))) | |
889617de GM |
1241 | |
1242 | ;; The code preventing adjacent regexp matches in the condition | |
1243 | ;; of the while-loop above will haven taken us one character | |
1244 | ;; beyond the last replacement. Undo that. | |
1245 | (when (and regexp-flag (not match-again) (> replace-count 0)) | |
1246 | (backward-char 1)) | |
d99118b0 | 1247 | |
e782e9f2 | 1248 | (replace-dehighlight)) |
4d33492a RS |
1249 | (or unread-command-events |
1250 | (message "Replaced %d occurrence%s" | |
1251 | replace-count | |
1252 | (if (= replace-count 1) "" "s"))) | |
1253 | (and keep-going stack))) | |
698e1804 | 1254 | |
95807e68 | 1255 | (defcustom query-replace-highlight t |
9d325ebf RS |
1256 | "*Non-nil means to highlight words during query replacement." |
1257 | :type 'boolean | |
1258 | :group 'matching) | |
e782e9f2 RS |
1259 | |
1260 | (defvar replace-overlay nil) | |
1261 | ||
1262 | (defun replace-dehighlight () | |
1263 | (and replace-overlay | |
1264 | (progn | |
1265 | (delete-overlay replace-overlay) | |
1266 | (setq replace-overlay nil)))) | |
1267 | ||
1268 | (defun replace-highlight (start end) | |
1269 | (and query-replace-highlight | |
1270 | (progn | |
1271 | (or replace-overlay | |
1272 | (progn | |
1273 | (setq replace-overlay (make-overlay start end)) | |
1274 | (overlay-put replace-overlay 'face | |
e730be7f | 1275 | (if (facep 'query-replace) |
e782e9f2 RS |
1276 | 'query-replace 'region)))) |
1277 | (move-overlay replace-overlay start end (current-buffer))))) | |
1278 | ||
c88ab9ce | 1279 | ;;; replace.el ends here |