Commit | Line | Data |
---|---|---|
c88ab9ce ER |
1 | ;;; replace.el --- replace commands for Emacs. |
2 | ||
8f3ff96b GM |
3 | ;; Copyright (C) 1985, 86, 87, 92, 94, 96, 1997, 2000 |
4 | ;; Free Software Foundation, Inc. | |
3a801d0c | 5 | |
698e1804 RS |
6 | ;; This file is part of GNU Emacs. |
7 | ||
8 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
9 | ;; it under the terms of the GNU General Public License as published by | |
e5d77022 | 10 | ;; the Free Software Foundation; either version 2, or (at your option) |
698e1804 RS |
11 | ;; any later version. |
12 | ||
13 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | ;; GNU General Public License for more details. | |
17 | ||
18 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
19 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
20 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
21 | ;; Boston, MA 02111-1307, USA. | |
698e1804 | 22 | |
d9ecc911 ER |
23 | ;;; Commentary: |
24 | ||
25 | ;; This package supplies the string and regular-expression replace functions | |
26 | ;; documented in the Emacs user's manual. | |
27 | ||
4f4b8eff | 28 | ;;; Code: |
698e1804 | 29 | |
9d325ebf RS |
30 | (defcustom case-replace t |
31 | "*Non-nil means query-replace should preserve case in replacements." | |
32 | :type 'boolean | |
33 | :group 'matching) | |
77176e73 | 34 | |
770970cb RS |
35 | (defvar query-replace-history nil) |
36 | ||
151270f3 RS |
37 | (defvar query-replace-interactive nil |
38 | "Non-nil means `query-replace' uses the last search string. | |
39 | That becomes the \"string to replace\".") | |
40 | ||
bdb1c08f RS |
41 | (defcustom query-replace-from-history-variable 'query-replace-history |
42 | "History list to use for the FROM argument of query-replace commands. | |
43 | The value of this variable should be a symbol; that symbol | |
44 | is used as a variable to hold a history list for the strings | |
45 | or patterns to be replaced." | |
46 | :group 'matching | |
cd32a7ba DN |
47 | :type 'symbol |
48 | :version "20.3") | |
bdb1c08f RS |
49 | |
50 | (defcustom query-replace-to-history-variable 'query-replace-history | |
51 | "History list to use for the TO argument of query-replace commands. | |
52 | The value of this variable should be a symbol; that symbol | |
53 | is used as a variable to hold a history list for replacement | |
54 | strings or patterns." | |
55 | :group 'matching | |
cd32a7ba DN |
56 | :type 'symbol |
57 | :version "20.3") | |
bdb1c08f | 58 | |
151270f3 | 59 | (defun query-replace-read-args (string regexp-flag) |
770970cb | 60 | (let (from to) |
151270f3 RS |
61 | (if query-replace-interactive |
62 | (setq from (car (if regexp-flag regexp-search-ring search-ring))) | |
63 | (setq from (read-from-minibuffer (format "%s: " string) | |
64 | nil nil nil | |
bdb1c08f RS |
65 | query-replace-from-history-variable |
66 | nil t))) | |
770970cb RS |
67 | (setq to (read-from-minibuffer (format "%s %s with: " string from) |
68 | nil nil nil | |
4a8f3b3d | 69 | query-replace-to-history-variable from t)) |
47d72254 GM |
70 | (if (and transient-mark-mode mark-active) |
71 | (list from to current-prefix-arg (region-beginning) (region-end)) | |
72 | (list from to current-prefix-arg nil nil)))) | |
770970cb | 73 | |
47d72254 | 74 | (defun query-replace (from-string to-string &optional delimited start end) |
da44e784 RM |
75 | "Replace some occurrences of FROM-STRING with TO-STRING. |
76 | As each match is found, the user must type a character saying | |
77 | what to do with it. For directions, type \\[help-command] at that time. | |
78 | ||
7ef5c431 KH |
79 | In Transient Mark mode, if the mark is active, operate on the contents |
80 | of the region. Otherwise, operate from point to the end of the buffer. | |
81 | ||
151270f3 RS |
82 | If `query-replace-interactive' is non-nil, the last incremental search |
83 | string is used as FROM-STRING--you don't have to specify it with the | |
84 | minibuffer. | |
85 | ||
d2a0ee8b RS |
86 | Replacement transfers the case of the old text to the new text, |
87 | if `case-replace' and `case-fold-search' | |
da44e784 | 88 | are non-nil and FROM-STRING has no uppercase letters. |
9b0bf2b6 RS |
89 | \(Preserving case means that if the string matched is all caps, or capitalized, |
90 | then its replacement is upcased or capitalized.) | |
91 | ||
118a01c9 | 92 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
81bdc14d | 93 | only matches surrounded by word boundaries. |
47d72254 | 94 | Fourth and fifth arg START and END specify the region to operate on. |
81bdc14d RS |
95 | |
96 | To customize possible responses, change the \"bindings\" in `query-replace-map'." | |
151270f3 | 97 | (interactive (query-replace-read-args "Query replace" nil)) |
47d72254 | 98 | (perform-replace from-string to-string start end t nil delimited)) |
7ef5c431 | 99 | |
73fa8346 | 100 | (define-key esc-map "%" 'query-replace) |
da44e784 | 101 | |
47d72254 | 102 | (defun query-replace-regexp (regexp to-string &optional delimited start end) |
da44e784 RM |
103 | "Replace some things after point matching REGEXP with TO-STRING. |
104 | As each match is found, the user must type a character saying | |
105 | what to do with it. For directions, type \\[help-command] at that time. | |
106 | ||
7ef5c431 KH |
107 | In Transient Mark mode, if the mark is active, operate on the contents |
108 | of the region. Otherwise, operate from point to the end of the buffer. | |
109 | ||
151270f3 RS |
110 | If `query-replace-interactive' is non-nil, the last incremental search |
111 | regexp is used as REGEXP--you don't have to specify it with the | |
112 | minibuffer. | |
113 | ||
118a01c9 | 114 | Preserves case in each replacement if `case-replace' and `case-fold-search' |
da44e784 | 115 | are non-nil and REGEXP has no uppercase letters. |
47d72254 | 116 | |
118a01c9 | 117 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 118 | only matches surrounded by word boundaries. |
47d72254 GM |
119 | Fourth and fifth arg START and END specify the region to operate on. |
120 | ||
118a01c9 RS |
121 | In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP, |
122 | and `\\=\\N' (where N is a digit) stands for | |
123 | whatever what matched the Nth `\\(...\\)' in REGEXP." | |
151270f3 | 124 | (interactive (query-replace-read-args "Query replace regexp" t)) |
47d72254 | 125 | (perform-replace regexp to-string start end t t delimited)) |
cbc127de | 126 | (define-key esc-map [?\C-%] 'query-replace-regexp) |
da44e784 | 127 | |
47d72254 | 128 | (defun query-replace-regexp-eval (regexp to-expr &optional delimited start end) |
84482eb3 RS |
129 | "Replace some things after point matching REGEXP with the result of TO-EXPR. |
130 | As each match is found, the user must type a character saying | |
131 | what to do with it. For directions, type \\[help-command] at that time. | |
132 | ||
133 | TO-EXPR is a Lisp expression evaluated to compute each replacement. It may | |
134 | reference `replace-count' to get the number of replacements already made. | |
135 | If the result of TO-EXPR is not a string, it is converted to one using | |
136 | `prin1-to-string' with the NOESCAPE argument (which see). | |
137 | ||
138 | For convenience, when entering TO-EXPR interactively, you can use `\\&' or | |
139 | `\\0'to stand for whatever matched the whole of REGEXP, and `\\=\\N' (where | |
140 | N is a digit) stands for whatever what matched the Nth `\\(...\\)' in REGEXP. | |
141 | Use `\\#&' or `\\#N' if you want a number instead of a string. | |
142 | ||
143 | In Transient Mark mode, if the mark is active, operate on the contents | |
144 | of the region. Otherwise, operate from point to the end of the buffer. | |
145 | ||
146 | If `query-replace-interactive' is non-nil, the last incremental search | |
147 | regexp is used as REGEXP--you don't have to specify it with the | |
148 | minibuffer. | |
149 | ||
150 | Preserves case in each replacement if `case-replace' and `case-fold-search' | |
151 | are non-nil and REGEXP has no uppercase letters. | |
47d72254 | 152 | |
84482eb3 | 153 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
47d72254 GM |
154 | only matches surrounded by word boundaries. |
155 | Fourth and fifth arg START and END specify the region to operate on." | |
84482eb3 | 156 | (interactive |
47d72254 GM |
157 | (let (from to start end) |
158 | (when (and transient-mark-mode mark-active) | |
159 | (setq start (region-beginning) | |
160 | end (region-end))) | |
84482eb3 RS |
161 | (if query-replace-interactive |
162 | (setq from (car regexp-search-ring)) | |
163 | (setq from (read-from-minibuffer "Query replace regexp: " | |
164 | nil nil nil | |
165 | query-replace-from-history-variable | |
166 | nil t))) | |
167 | (setq to (list (read-from-minibuffer | |
168 | (format "Query replace regexp %s with eval: " from) | |
169 | nil nil t query-replace-to-history-variable from t))) | |
170 | ;; We make TO a list because replace-match-string-symbols requires one, | |
171 | ;; and the user might enter a single token. | |
172 | (replace-match-string-symbols to) | |
47d72254 | 173 | (list from (car to) start end current-prefix-arg))) |
d2ce3151 | 174 | (perform-replace regexp (cons 'replace-eval-replacement to-expr) |
47d72254 | 175 | start end t t delimited)) |
84482eb3 | 176 | |
47d72254 | 177 | (defun map-query-replace-regexp (regexp to-strings &optional n start end) |
da44e784 | 178 | "Replace some matches for REGEXP with various strings, in rotation. |
e730be7f DL |
179 | The second argument TO-STRINGS contains the replacement strings, |
180 | separated by spaces. Third arg DELIMITED (prefix arg if interactive), | |
181 | if non-nil, means replace only matches surrounded by word boundaries. | |
182 | This command works like `query-replace-regexp' except that each | |
183 | successive replacement uses the next successive replacement string, | |
da44e784 RM |
184 | wrapping around from the last such string to the first. |
185 | ||
7ef5c431 KH |
186 | In Transient Mark mode, if the mark is active, operate on the contents |
187 | of the region. Otherwise, operate from point to the end of the buffer. | |
188 | ||
da44e784 RM |
189 | Non-interactively, TO-STRINGS may be a list of replacement strings. |
190 | ||
151270f3 RS |
191 | If `query-replace-interactive' is non-nil, the last incremental search |
192 | regexp is used as REGEXP--you don't have to specify it with the minibuffer. | |
193 | ||
da44e784 | 194 | A prefix argument N says to use each replacement string N times |
47d72254 GM |
195 | before rotating to the next. |
196 | Fourth and fifth arg START and END specify the region to operate on." | |
770970cb | 197 | (interactive |
47d72254 GM |
198 | (let (from to start end) |
199 | (when (and transient-mark-mode mark-active) | |
200 | (setq start (region-beginning) | |
201 | end (region-end))) | |
151270f3 RS |
202 | (setq from (if query-replace-interactive |
203 | (car regexp-search-ring) | |
204 | (read-from-minibuffer "Map query replace (regexp): " | |
205 | nil nil nil | |
fce31d51 | 206 | 'query-replace-history nil t))) |
770970cb RS |
207 | (setq to (read-from-minibuffer |
208 | (format "Query replace %s with (space-separated strings): " | |
209 | from) | |
210 | nil nil nil | |
4a8f3b3d | 211 | 'query-replace-history from t)) |
47d72254 | 212 | (list from to start end current-prefix-arg))) |
da44e784 RM |
213 | (let (replacements) |
214 | (if (listp to-strings) | |
215 | (setq replacements to-strings) | |
216 | (while (/= (length to-strings) 0) | |
217 | (if (string-match " " to-strings) | |
218 | (setq replacements | |
219 | (append replacements | |
220 | (list (substring to-strings 0 | |
221 | (string-match " " to-strings)))) | |
222 | to-strings (substring to-strings | |
223 | (1+ (string-match " " to-strings)))) | |
224 | (setq replacements (append replacements (list to-strings)) | |
225 | to-strings "")))) | |
47d72254 | 226 | (perform-replace regexp replacements start end t t nil n))) |
da44e784 | 227 | |
47d72254 | 228 | (defun replace-string (from-string to-string &optional delimited start end) |
da44e784 RM |
229 | "Replace occurrences of FROM-STRING with TO-STRING. |
230 | Preserve case in each match if `case-replace' and `case-fold-search' | |
231 | are non-nil and FROM-STRING has no uppercase letters. | |
9b0bf2b6 RS |
232 | \(Preserving case means that if the string matched is all caps, or capitalized, |
233 | then its replacement is upcased or capitalized.) | |
234 | ||
7ef5c431 KH |
235 | In Transient Mark mode, if the mark is active, operate on the contents |
236 | of the region. Otherwise, operate from point to the end of the buffer. | |
237 | ||
118a01c9 | 238 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 239 | only matches surrounded by word boundaries. |
47d72254 | 240 | Fourth and fifth arg START and END specify the region to operate on. |
da44e784 | 241 | |
151270f3 RS |
242 | If `query-replace-interactive' is non-nil, the last incremental search |
243 | string is used as FROM-STRING--you don't have to specify it with the | |
244 | minibuffer. | |
245 | ||
da44e784 RM |
246 | This function is usually the wrong thing to use in a Lisp program. |
247 | What you probably want is a loop like this: | |
118a01c9 RS |
248 | (while (search-forward FROM-STRING nil t) |
249 | (replace-match TO-STRING nil t)) | |
87532fbe RS |
250 | which will run faster and will not set the mark or print anything. |
251 | \(You may need a more complex loop if FROM-STRING can match the null string | |
252 | and TO-STRING is also null.)" | |
151270f3 | 253 | (interactive (query-replace-read-args "Replace string" nil)) |
47d72254 | 254 | (perform-replace from-string to-string start end nil nil delimited)) |
da44e784 | 255 | |
47d72254 | 256 | (defun replace-regexp (regexp to-string &optional delimited start end) |
da44e784 | 257 | "Replace things after point matching REGEXP with TO-STRING. |
118a01c9 | 258 | Preserve case in each match if `case-replace' and `case-fold-search' |
da44e784 | 259 | are non-nil and REGEXP has no uppercase letters. |
47d72254 GM |
260 | |
261 | In Transient Mark mode, if the mark is active, operate on the contents | |
262 | of the region. Otherwise, operate from point to the end of the buffer. | |
263 | ||
118a01c9 | 264 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 265 | only matches surrounded by word boundaries. |
47d72254 GM |
266 | Fourth and fifth arg START and END specify the region to operate on. |
267 | ||
118a01c9 RS |
268 | In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP, |
269 | and `\\=\\N' (where N is a digit) stands for | |
880f22a1 | 270 | whatever what matched the Nth `\\(...\\)' in REGEXP. |
da44e784 | 271 | |
151270f3 RS |
272 | If `query-replace-interactive' is non-nil, the last incremental search |
273 | regexp is used as REGEXP--you don't have to specify it with the minibuffer. | |
274 | ||
da44e784 RM |
275 | This function is usually the wrong thing to use in a Lisp program. |
276 | What you probably want is a loop like this: | |
277 | (while (re-search-forward REGEXP nil t) | |
118a01c9 | 278 | (replace-match TO-STRING nil nil)) |
da44e784 | 279 | which will run faster and will not set the mark or print anything." |
151270f3 | 280 | (interactive (query-replace-read-args "Replace regexp" t)) |
47d72254 | 281 | (perform-replace regexp to-string start end nil t delimited)) |
e32eb3e6 | 282 | |
4c53bd2b RS |
283 | \f |
284 | (defvar regexp-history nil | |
285 | "History list for some commands that read regular expressions.") | |
da44e784 | 286 | |
e32eb3e6 | 287 | |
31e1d920 | 288 | (defalias 'delete-non-matching-lines 'keep-lines) |
e32eb3e6 GM |
289 | (defalias 'delete-matching-lines 'flush-lines) |
290 | (defalias 'count-matches 'how-many) | |
291 | ||
292 | ||
293 | (defun keep-lines-read-args (prompt) | |
294 | "Read arguments for `keep-lines' and friends. | |
295 | Prompt for a regexp with PROMPT. | |
296 | ||
297 | Value is a list (REGEXP START END). | |
298 | ||
299 | If in Transient Mark node, and the mark is active, START is the | |
300 | start of the region, and end is a marker for the end of the region. | |
301 | Otherwise, START is the current point, and END is `point-max-marker'." | |
302 | (let ((regexp (read-from-minibuffer prompt nil nil nil | |
303 | 'regexp-history nil t)) | |
304 | start end) | |
305 | (if (and transient-mark-mode mark-active) | |
306 | (setq start (region-beginning) | |
307 | end (save-excursion (goto-char (region-end)) (point-marker))) | |
308 | (setq start (point) | |
309 | end (point-max-marker))) | |
310 | (list regexp start end))) | |
311 | ||
312 | ||
313 | (defun keep-lines (regexp &optional rstart rend) | |
698e1804 RS |
314 | "Delete all lines except those containing matches for REGEXP. |
315 | A match split across lines preserves all the lines it lies in. | |
d2a0ee8b RS |
316 | Applies to all lines after point. |
317 | ||
318 | If REGEXP contains upper case characters (excluding those preceded by `\\'), | |
e32eb3e6 GM |
319 | the matching is case-sensitive. |
320 | ||
321 | Second and third arg RSTART and REND specify the region to operate on. | |
322 | ||
323 | In Transient Mark mode, if the mark is active, operate on the contents | |
324 | of the region. Otherwise, operate from point to the end of the buffer." | |
325 | (interactive | |
326 | (keep-lines-read-args "Keep lines (containing match for regexp): ")) | |
327 | (if rstart | |
328 | (goto-char (min rstart rend)) | |
329 | (setq rstart (point) rend (point-max-marker))) | |
698e1804 RS |
330 | (save-excursion |
331 | (or (bolp) (forward-line 1)) | |
d2a0ee8b RS |
332 | (let ((start (point)) |
333 | (case-fold-search (and case-fold-search | |
334 | (isearch-no-upper-case-p regexp t)))) | |
e32eb3e6 | 335 | (while (< (point) rend) |
698e1804 | 336 | ;; Start is first char not preserved by previous match. |
e32eb3e6 GM |
337 | (if (not (re-search-forward regexp rend 'move)) |
338 | (delete-region start rend) | |
698e1804 RS |
339 | (let ((end (save-excursion (goto-char (match-beginning 0)) |
340 | (beginning-of-line) | |
341 | (point)))) | |
342 | ;; Now end is first char preserved by the new match. | |
343 | (if (< start end) | |
344 | (delete-region start end)))) | |
e32eb3e6 GM |
345 | |
346 | (setq start (save-excursion (forward-line 1) (point))) | |
698e1804 | 347 | ;; If the match was empty, avoid matching again at same place. |
e32eb3e6 GM |
348 | (and (< (point) rend) |
349 | (= (match-beginning 0) (match-end 0)) | |
698e1804 RS |
350 | (forward-char 1)))))) |
351 | ||
e32eb3e6 GM |
352 | |
353 | (defun flush-lines (regexp &optional rstart rend) | |
698e1804 RS |
354 | "Delete lines containing matches for REGEXP. |
355 | If a match is split across lines, all the lines it lies in are deleted. | |
d2a0ee8b RS |
356 | Applies to lines after point. |
357 | ||
358 | If REGEXP contains upper case characters (excluding those preceded by `\\'), | |
e32eb3e6 GM |
359 | the matching is case-sensitive. |
360 | ||
361 | Second and third arg RSTART and REND specify the region to operate on. | |
362 | ||
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 | (interactive | |
366 | (keep-lines-read-args "Flush lines (containing match for regexp): ")) | |
367 | (if rstart | |
368 | (goto-char (min rstart rend)) | |
369 | (setq rstart (point) rend (point-max-marker))) | |
d2a0ee8b RS |
370 | (let ((case-fold-search (and case-fold-search |
371 | (isearch-no-upper-case-p regexp t)))) | |
372 | (save-excursion | |
e32eb3e6 GM |
373 | (while (and (< (point) rend) |
374 | (re-search-forward regexp rend t)) | |
d2a0ee8b RS |
375 | (delete-region (save-excursion (goto-char (match-beginning 0)) |
376 | (beginning-of-line) | |
377 | (point)) | |
378 | (progn (forward-line 1) (point))))))) | |
698e1804 | 379 | |
e32eb3e6 GM |
380 | |
381 | (defun how-many (regexp &optional rstart rend) | |
d2a0ee8b RS |
382 | "Print number of matches for REGEXP following point. |
383 | ||
384 | If REGEXP contains upper case characters (excluding those preceded by `\\'), | |
e32eb3e6 GM |
385 | the matching is case-sensitive. |
386 | ||
387 | Second and third arg RSTART and REND specify the region to operate on. | |
388 | ||
389 | In Transient Mark mode, if the mark is active, operate on the contents | |
390 | of the region. Otherwise, operate from point to the end of the buffer." | |
391 | (interactive | |
392 | (keep-lines-read-args "How many matches for (regexp): ")) | |
393 | (if rstart | |
394 | (goto-char (min rstart rend)) | |
395 | (setq rstart (point) rend (point-max-marker))) | |
396 | (let ((count 0) | |
397 | opoint | |
398 | (case-fold-search (and case-fold-search | |
399 | (isearch-no-upper-case-p regexp t)))) | |
698e1804 | 400 | (save-excursion |
e32eb3e6 | 401 | (while (and (< (point) rend) |
698e1804 | 402 | (progn (setq opoint (point)) |
e32eb3e6 | 403 | (re-search-forward regexp rend t))) |
698e1804 RS |
404 | (if (= opoint (point)) |
405 | (forward-char 1) | |
406 | (setq count (1+ count)))) | |
407 | (message "%d occurrences" count)))) | |
e32eb3e6 | 408 | |
4c53bd2b | 409 | \f |
698e1804 RS |
410 | (defvar occur-mode-map ()) |
411 | (if occur-mode-map | |
412 | () | |
413 | (setq occur-mode-map (make-sparse-keymap)) | |
78bead73 | 414 | (define-key occur-mode-map [mouse-2] 'occur-mode-mouse-goto) |
0081c8a1 | 415 | (define-key occur-mode-map "\C-c\C-c" 'occur-mode-goto-occurrence) |
a41284da | 416 | (define-key occur-mode-map "\C-m" 'occur-mode-goto-occurrence) |
8d15583f RS |
417 | (define-key occur-mode-map "\M-n" 'occur-next) |
418 | (define-key occur-mode-map "\M-p" 'occur-prev) | |
a41284da | 419 | (define-key occur-mode-map "g" 'revert-buffer)) |
698e1804 | 420 | |
e09d4033 RS |
421 | |
422 | (defvar occur-buffer nil | |
423 | "Name of buffer for last occur.") | |
424 | ||
425 | ||
426 | (defvar occur-nlines nil | |
427 | "Number of lines of context to show around matching line.") | |
428 | ||
a41284da RS |
429 | (defvar occur-command-arguments nil |
430 | "Arguments that were given to `occur' when it made this buffer.") | |
698e1804 | 431 | |
de3c9b09 RS |
432 | (put 'occur-mode 'mode-class 'special) |
433 | ||
698e1804 RS |
434 | (defun occur-mode () |
435 | "Major mode for output from \\[occur]. | |
0081c8a1 RS |
436 | \\<occur-mode-map>Move point to one of the items in this buffer, then use |
437 | \\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to. | |
438 | Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it. | |
439 | ||
698e1804 RS |
440 | \\{occur-mode-map}" |
441 | (kill-all-local-variables) | |
442 | (use-local-map occur-mode-map) | |
443 | (setq major-mode 'occur-mode) | |
444 | (setq mode-name "Occur") | |
a41284da RS |
445 | (make-local-variable 'revert-buffer-function) |
446 | (setq revert-buffer-function 'occur-revert-function) | |
698e1804 RS |
447 | (make-local-variable 'occur-buffer) |
448 | (make-local-variable 'occur-nlines) | |
a41284da | 449 | (make-local-variable 'occur-command-arguments) |
4baf5620 | 450 | (run-hooks 'occur-mode-hook)) |
698e1804 | 451 | |
a41284da | 452 | (defun occur-revert-function (ignore1 ignore2) |
e730be7f | 453 | "Handle revert-buffer for *Occur* buffers." |
a41284da RS |
454 | (let ((args occur-command-arguments )) |
455 | (save-excursion | |
456 | (set-buffer occur-buffer) | |
457 | (apply 'occur args)))) | |
458 | ||
78bead73 RS |
459 | (defun occur-mode-mouse-goto (event) |
460 | "In Occur mode, go to the occurrence whose line you click on." | |
461 | (interactive "e") | |
462 | (let (buffer pos) | |
463 | (save-excursion | |
464 | (set-buffer (window-buffer (posn-window (event-end event)))) | |
465 | (save-excursion | |
466 | (goto-char (posn-point (event-end event))) | |
467 | (setq pos (occur-mode-find-occurrence)) | |
468 | (setq buffer occur-buffer))) | |
469 | (pop-to-buffer buffer) | |
470 | (goto-char (marker-position pos)))) | |
471 | ||
472 | (defun occur-mode-find-occurrence () | |
698e1804 RS |
473 | (if (or (null occur-buffer) |
474 | (null (buffer-name occur-buffer))) | |
475 | (progn | |
8d15583f | 476 | (setq occur-buffer nil) |
698e1804 | 477 | (error "Buffer in which occurrences were found is deleted"))) |
8d15583f RS |
478 | (let ((pos (get-text-property (point) 'occur))) |
479 | (if (null pos) | |
480 | (error "No occurrence on this line") | |
481 | pos))) | |
78bead73 RS |
482 | |
483 | (defun occur-mode-goto-occurrence () | |
484 | "Go to the occurrence the current line describes." | |
485 | (interactive) | |
486 | (let ((pos (occur-mode-find-occurrence))) | |
698e1804 | 487 | (pop-to-buffer occur-buffer) |
121e2227 | 488 | (goto-char (marker-position pos)))) |
8d15583f RS |
489 | |
490 | (defun occur-next (&optional n) | |
491 | "Move to the Nth (default 1) next match in the *Occur* buffer." | |
492 | (interactive "p") | |
493 | (if (not n) (setq n 1)) | |
494 | (let ((r)) | |
495 | (while (> n 0) | |
496 | (if (get-text-property (point) 'occur-point) | |
497 | (forward-char 1)) | |
498 | (setq r (next-single-property-change (point) 'occur-point)) | |
499 | (if r | |
500 | (goto-char r) | |
e730be7f | 501 | (error "No more matches")) |
8d15583f RS |
502 | (setq n (1- n))))) |
503 | ||
504 | ||
505 | ||
506 | (defun occur-prev (&optional n) | |
507 | "Move to the Nth (default 1) previous match in the *Occur* buffer." | |
508 | (interactive "p") | |
509 | (if (not n) (setq n 1)) | |
510 | (let ((r)) | |
511 | (while (> n 0) | |
512 | ||
513 | (setq r (get-text-property (point) 'occur-point)) | |
514 | (if r (forward-char -1)) | |
515 | ||
516 | (setq r (previous-single-property-change (point) 'occur-point)) | |
517 | (if r | |
518 | (goto-char (- r 1)) | |
e730be7f | 519 | (error "No earlier matches")) |
8d15583f RS |
520 | |
521 | (setq n (1- n))))) | |
4c53bd2b | 522 | \f |
9d325ebf | 523 | (defcustom list-matching-lines-default-context-lines 0 |
e730be7f DL |
524 | "*Default number of context lines included around `list-matching-lines' matches. |
525 | A negative number means to include that many lines before the match. | |
9d325ebf RS |
526 | A positive number means to include that many lines both before and after." |
527 | :type 'integer | |
528 | :group 'matching) | |
698e1804 | 529 | |
31e1d920 | 530 | (defalias 'list-matching-lines 'occur) |
698e1804 | 531 | |
c9daced0 | 532 | (defvar list-matching-lines-face 'bold |
e730be7f | 533 | "*Face used by \\[list-matching-lines] to show the text that matches. |
c9daced0 RS |
534 | If the value is nil, don't highlight the matching portions specially.") |
535 | ||
698e1804 | 536 | (defun occur (regexp &optional nlines) |
99976f85 | 537 | "Show all lines in the current buffer containing a match for REGEXP. |
da44e784 RM |
538 | |
539 | If a match spreads across multiple lines, all those lines are shown. | |
698e1804 | 540 | |
da44e784 RM |
541 | Each line is displayed with NLINES lines before and after, or -NLINES |
542 | before if NLINES is negative. | |
543 | NLINES defaults to `list-matching-lines-default-context-lines'. | |
698e1804 RS |
544 | Interactively it is the prefix arg. |
545 | ||
4c53bd2b | 546 | The lines are shown in a buffer named `*Occur*'. |
698e1804 | 547 | It serves as a menu to find any of the occurrences in this buffer. |
de3c9b09 | 548 | \\<occur-mode-map>\\[describe-mode] in that buffer will explain how. |
9483d601 | 549 | |
de3c9b09 RS |
550 | If REGEXP contains upper case characters (excluding those preceded by `\\'), |
551 | the matching is case-sensitive." | |
a5dfed3e RS |
552 | (interactive |
553 | (list (let* ((default (car regexp-history)) | |
554 | (input | |
555 | (read-from-minibuffer | |
556 | (if default | |
557 | (format "List lines matching regexp (default `%s'): " | |
558 | default) | |
559 | "List lines matching regexp: ") | |
aeab5be0 | 560 | nil nil nil 'regexp-history default t))) |
4a8f3b3d RS |
561 | (and (equal input "") default |
562 | (setq input default)) | |
aeab5be0 | 563 | input) |
a5dfed3e | 564 | current-prefix-arg)) |
d79dfd47 GM |
565 | (let* ((nlines (if nlines |
566 | (prefix-numeric-value nlines) | |
567 | list-matching-lines-default-context-lines)) | |
568 | (current-tab-width tab-width) | |
569 | ;; Minimum width of line number plus trailing colon. | |
570 | (min-line-number-width 6) | |
571 | ;; Actual width of line number prefix. Choose a width that's | |
572 | ;; a multiple of `tab-width' in the original buffer so that | |
573 | ;; lines in *Occur* appear right. | |
574 | (line-number-width (* (/ (- (+ min-line-number-width | |
575 | tab-width) | |
576 | 1) | |
577 | tab-width) | |
578 | tab-width)) | |
579 | ;; Format string for line numbers. | |
580 | (line-number-format (format "%%%dd" line-number-width)) | |
581 | (empty (make-string line-number-width ?\ )) | |
582 | (first t) | |
583 | ;;flag to prevent printing separator for first match | |
584 | (occur-num-matches 0) | |
585 | (buffer (current-buffer)) | |
586 | (dir default-directory) | |
587 | (linenum 1) | |
588 | (prevpos | |
589 | ;;position of most recent match | |
590 | (point-min)) | |
591 | (case-fold-search (and case-fold-search | |
592 | (isearch-no-upper-case-p regexp t))) | |
593 | (final-context-start | |
594 | ;; Marker to the start of context immediately following | |
595 | ;; the matched text in *Occur*. | |
596 | (make-marker))) | |
99976f85 RS |
597 | ;;; (save-excursion |
598 | ;;; (beginning-of-line) | |
599 | ;;; (setq linenum (1+ (count-lines (point-min) (point)))) | |
600 | ;;; (setq prevpos (point))) | |
016c214f RS |
601 | (save-excursion |
602 | (goto-char (point-min)) | |
603 | ;; Check first whether there are any matches at all. | |
604 | (if (not (re-search-forward regexp nil t)) | |
605 | (message "No matches for `%s'" regexp) | |
606 | ;; Back up, so the search loop below will find the first match. | |
607 | (goto-char (match-beginning 0)) | |
608 | (with-output-to-temp-buffer "*Occur*" | |
609 | (save-excursion | |
610 | (set-buffer standard-output) | |
611 | (setq default-directory dir) | |
612 | ;; We will insert the number of lines, and "lines", later. | |
613 | (insert " matching ") | |
614 | (let ((print-escape-newlines t)) | |
615 | (prin1 regexp)) | |
616 | (insert " in buffer " (buffer-name buffer) ?. ?\n) | |
617 | (occur-mode) | |
618 | (setq occur-buffer buffer) | |
619 | (setq occur-nlines nlines) | |
a41284da RS |
620 | (setq occur-command-arguments |
621 | (list regexp nlines))) | |
016c214f | 622 | (if (eq buffer standard-output) |
91c6bdc0 | 623 | (goto-char (point-max))) |
016c214f RS |
624 | (save-excursion |
625 | ;; Find next match, but give up if prev match was at end of buffer. | |
626 | (while (and (not (= prevpos (point-max))) | |
627 | (re-search-forward regexp nil t)) | |
628 | (goto-char (match-beginning 0)) | |
629 | (beginning-of-line) | |
630 | (save-match-data | |
631 | (setq linenum (+ linenum (count-lines prevpos (point))))) | |
632 | (setq prevpos (point)) | |
633 | (goto-char (match-end 0)) | |
d79dfd47 GM |
634 | (let* (;;start point of text in source buffer to be put |
635 | ;;into *Occur* | |
636 | (start (save-excursion | |
016c214f | 637 | (goto-char (match-beginning 0)) |
e09d4033 RS |
638 | (forward-line (if (< nlines 0) |
639 | nlines | |
640 | (- nlines))) | |
016c214f | 641 | (point))) |
e09d4033 RS |
642 | ;; end point of text in source buffer to be put |
643 | ;; into *Occur* | |
d79dfd47 GM |
644 | (end (save-excursion |
645 | (goto-char (match-end 0)) | |
646 | (if (> nlines 0) | |
647 | (forward-line (1+ nlines)) | |
648 | (forward-line 1)) | |
649 | (point))) | |
e09d4033 | 650 | ;; Amount of context before matching text |
d79dfd47 | 651 | (match-beg (- (match-beginning 0) start)) |
e09d4033 | 652 | ;; Length of matching text |
d79dfd47 GM |
653 | (match-len (- (match-end 0) (match-beginning 0))) |
654 | (tag (format line-number-format linenum)) | |
e730be7f | 655 | tem |
0f0a7f7c | 656 | insertion-start |
e09d4033 | 657 | ;; Number of lines of context to show for current match. |
e730be7f | 658 | occur-marker |
e09d4033 RS |
659 | ;; Marker pointing to end of match in source buffer. |
660 | (text-beg | |
661 | ;; Marker pointing to start of text for one | |
662 | ;; match in *Occur*. | |
663 | (make-marker)) | |
e730be7f | 664 | (text-end |
e09d4033 RS |
665 | ;; Marker pointing to end of text for one match |
666 | ;; in *Occur*. | |
d79dfd47 | 667 | (make-marker))) |
016c214f | 668 | (save-excursion |
8d15583f RS |
669 | (setq occur-marker (make-marker)) |
670 | (set-marker occur-marker (point)) | |
016c214f | 671 | (set-buffer standard-output) |
8d15583f | 672 | (setq occur-num-matches (1+ occur-num-matches)) |
016c214f RS |
673 | (or first (zerop nlines) |
674 | (insert "--------\n")) | |
675 | (setq first nil) | |
d79dfd47 GM |
676 | (save-excursion |
677 | (set-buffer "*Occur*") | |
678 | (setq tab-width current-tab-width)) | |
e09d4033 RS |
679 | |
680 | ;; Insert matching text including context lines from | |
681 | ;; source buffer into *Occur* | |
8d15583f | 682 | (set-marker text-beg (point)) |
0f0a7f7c | 683 | (setq insertion-start (point)) |
016c214f | 684 | (insert-buffer-substring buffer start end) |
0f0a7f7c KH |
685 | (or (and (/= (+ start match-beg) end) |
686 | (with-current-buffer buffer | |
687 | (eq (char-before end) ?\n))) | |
688 | (insert "\n")) | |
e730be7f | 689 | (set-marker final-context-start |
0f0a7f7c KH |
690 | (+ (- (point) (- end (match-end 0))) |
691 | (if (save-excursion | |
692 | (set-buffer buffer) | |
693 | (save-excursion | |
694 | (goto-char (match-end 0)) | |
695 | (end-of-line) | |
696 | (bolp))) | |
697 | 1 0))) | |
8d15583f | 698 | (set-marker text-end (point)) |
e09d4033 RS |
699 | |
700 | ;; Highlight text that was matched. | |
8d15583f RS |
701 | (if list-matching-lines-face |
702 | (put-text-property | |
703 | (+ (marker-position text-beg) match-beg) | |
704 | (+ (marker-position text-beg) match-beg match-len) | |
705 | 'face list-matching-lines-face)) | |
706 | ||
e09d4033 RS |
707 | ;; `occur-point' property is used by occur-next and |
708 | ;; occur-prev to move between matching lines. | |
8d15583f RS |
709 | (put-text-property |
710 | (+ (marker-position text-beg) match-beg match-len) | |
711 | (+ (marker-position text-beg) match-beg match-len 1) | |
712 | 'occur-point t) | |
e09d4033 RS |
713 | |
714 | ;; Now go back to the start of the matching text | |
715 | ;; adding the space and colon to the start of each line. | |
0f0a7f7c | 716 | (goto-char insertion-start) |
e09d4033 | 717 | ;; Insert space and colon for lines of context before match. |
8d15583f RS |
718 | (setq tem (if (< linenum nlines) |
719 | (- nlines linenum) | |
720 | nlines)) | |
016c214f RS |
721 | (while (> tem 0) |
722 | (insert empty ?:) | |
723 | (forward-line 1) | |
724 | (setq tem (1- tem))) | |
e09d4033 RS |
725 | |
726 | ;; Insert line number and colon for the lines of | |
727 | ;; matching text. | |
728 | (let ((this-linenum linenum)) | |
016c214f RS |
729 | (while (< (point) final-context-start) |
730 | (if (null tag) | |
d79dfd47 | 731 | (setq tag (format line-number-format this-linenum))) |
016c214f | 732 | (insert tag ?:) |
016c214f RS |
733 | (forward-line 1) |
734 | (setq tag nil) | |
735 | (setq this-linenum (1+ this-linenum))) | |
0f0a7f7c | 736 | (while (and (not (eobp)) (<= (point) final-context-start)) |
016c214f RS |
737 | (insert empty ?:) |
738 | (forward-line 1) | |
739 | (setq this-linenum (1+ this-linenum)))) | |
e09d4033 RS |
740 | |
741 | ;; Insert space and colon for lines of context after match. | |
8d15583f | 742 | (while (and (< (point) (point-max)) (< tem nlines)) |
016c214f RS |
743 | (insert empty ?:) |
744 | (forward-line 1) | |
745 | (setq tem (1+ tem))) | |
8d15583f RS |
746 | |
747 | ;; Add text properties. The `occur' prop is used to | |
748 | ;; store the marker of the matching text in the | |
749 | ;; source buffer. | |
750 | (put-text-property (marker-position text-beg) | |
751 | (- (marker-position text-end) 1) | |
752 | 'mouse-face 'highlight) | |
753 | (put-text-property (marker-position text-beg) | |
e09d4033 | 754 | (marker-position text-end) |
8d15583f | 755 | 'occur occur-marker) |
016c214f RS |
756 | (goto-char (point-max))) |
757 | (forward-line 1))) | |
758 | (set-buffer standard-output) | |
e09d4033 RS |
759 | ;; Go back to top of *Occur* and finish off by printing the |
760 | ;; number of matching lines. | |
016c214f | 761 | (goto-char (point-min)) |
65b4665c | 762 | (let ((message-string |
8d15583f | 763 | (if (= occur-num-matches 1) |
65b4665c | 764 | "1 line" |
8d15583f | 765 | (format "%d lines" occur-num-matches)))) |
65b4665c RS |
766 | (insert message-string) |
767 | (if (interactive-p) | |
5ddf4bda KH |
768 | (message "%s matched" message-string))) |
769 | (setq buffer-read-only t))))))) | |
698e1804 | 770 | \f |
81bdc14d RS |
771 | ;; It would be nice to use \\[...], but there is no reasonable way |
772 | ;; to make that display both SPC and Y. | |
698e1804 RS |
773 | (defconst query-replace-help |
774 | "Type Space or `y' to replace one match, Delete or `n' to skip to next, | |
be44f62c | 775 | RET or `q' to exit, Period to replace one match and exit, |
698e1804 RS |
776 | Comma to replace but not move point immediately, |
777 | C-r to enter recursive edit (\\[exit-recursive-edit] to get out again), | |
778 | C-w to delete match and recursive edit, | |
779 | C-l to clear the screen, redisplay, and offer same replacement again, | |
780 | ! to replace all remaining matches with no more questions, | |
7ce278f3 GM |
781 | ^ to move point back to previous match, |
782 | E to edit the replacement string" | |
698e1804 RS |
783 | "Help message while in query-replace") |
784 | ||
81bdc14d RS |
785 | (defvar query-replace-map (make-sparse-keymap) |
786 | "Keymap that defines the responses to questions in `query-replace'. | |
787 | The \"bindings\" in this map are not commands; they are answers. | |
788 | The valid answers include `act', `skip', `act-and-show', | |
789 | `exit', `act-and-exit', `edit', `delete-and-edit', `recenter', | |
d9121bc0 | 790 | `automatic', `backup', `exit-prefix', and `help'.") |
81bdc14d RS |
791 | |
792 | (define-key query-replace-map " " 'act) | |
793 | (define-key query-replace-map "\d" 'skip) | |
794 | (define-key query-replace-map [delete] 'skip) | |
9275e5e3 | 795 | (define-key query-replace-map [backspace] 'skip) |
81bdc14d RS |
796 | (define-key query-replace-map "y" 'act) |
797 | (define-key query-replace-map "n" 'skip) | |
633a305a RS |
798 | (define-key query-replace-map "Y" 'act) |
799 | (define-key query-replace-map "N" 'skip) | |
34724fcb | 800 | (define-key query-replace-map "e" 'edit-replacement) |
7ce278f3 | 801 | (define-key query-replace-map "E" 'edit-replacement) |
81bdc14d | 802 | (define-key query-replace-map "," 'act-and-show) |
81bdc14d | 803 | (define-key query-replace-map "q" 'exit) |
919592c0 | 804 | (define-key query-replace-map "\r" 'exit) |
384c7da4 | 805 | (define-key query-replace-map [return] 'exit) |
81bdc14d RS |
806 | (define-key query-replace-map "." 'act-and-exit) |
807 | (define-key query-replace-map "\C-r" 'edit) | |
808 | (define-key query-replace-map "\C-w" 'delete-and-edit) | |
809 | (define-key query-replace-map "\C-l" 'recenter) | |
810 | (define-key query-replace-map "!" 'automatic) | |
811 | (define-key query-replace-map "^" 'backup) | |
812 | (define-key query-replace-map "\C-h" 'help) | |
e731045a KH |
813 | (define-key query-replace-map [f1] 'help) |
814 | (define-key query-replace-map [help] 'help) | |
81bdc14d | 815 | (define-key query-replace-map "?" 'help) |
bc6312e1 RS |
816 | (define-key query-replace-map "\C-g" 'quit) |
817 | (define-key query-replace-map "\C-]" 'quit) | |
d9121bc0 RS |
818 | (define-key query-replace-map "\e" 'exit-prefix) |
819 | (define-key query-replace-map [escape] 'exit-prefix) | |
81bdc14d | 820 | |
84482eb3 | 821 | (defun replace-match-string-symbols (n) |
e730be7f DL |
822 | "Process a list (and any sub-lists), expanding certain symbols. |
823 | Symbol Expands To | |
824 | N (match-string N) (where N is a string of digits) | |
825 | #N (string-to-number (match-string N)) | |
826 | & (match-string 0) | |
827 | #& (string-to-number (match-string 0)) | |
828 | ||
829 | Note that these symbols must be preceeded by a backslash in order to | |
830 | type them." | |
84482eb3 RS |
831 | (while n |
832 | (cond | |
833 | ((consp (car n)) | |
834 | (replace-match-string-symbols (car n))) ;Process sub-list | |
835 | ((symbolp (car n)) | |
836 | (let ((name (symbol-name (car n)))) | |
837 | (cond | |
838 | ((string-match "^[0-9]+$" name) | |
839 | (setcar n (list 'match-string (string-to-number name)))) | |
840 | ((string-match "^#[0-9]+$" name) | |
841 | (setcar n (list 'string-to-number | |
842 | (list 'match-string | |
843 | (string-to-number (substring name 1)))))) | |
844 | ((string= "&" name) | |
845 | (setcar n '(match-string 0))) | |
846 | ((string= "#&" name) | |
847 | (setcar n '(string-to-number (match-string 0)))))))) | |
848 | (setq n (cdr n)))) | |
849 | ||
850 | (defun replace-eval-replacement (expression replace-count) | |
851 | (let ((replacement (eval expression))) | |
852 | (if (stringp replacement) | |
853 | replacement | |
854 | (prin1-to-string replacement t)))) | |
855 | ||
856 | (defun replace-loop-through-replacements (data replace-count) | |
857 | ;; DATA is a vector contaning the following values: | |
858 | ;; 0 next-rotate-count | |
859 | ;; 1 repeat-count | |
860 | ;; 2 next-replacement | |
861 | ;; 3 replacements | |
862 | (if (= (aref data 0) replace-count) | |
863 | (progn | |
864 | (aset data 0 (+ replace-count (aref data 1))) | |
865 | (let ((next (cdr (aref data 2)))) | |
866 | (aset data 2 (if (consp next) next (aref data 3)))))) | |
867 | (car (aref data 2))) | |
868 | ||
47d72254 | 869 | (defun perform-replace (from-string replacements start end |
698e1804 | 870 | query-flag regexp-flag delimited-flag |
81bdc14d | 871 | &optional repeat-count map) |
698e1804 RS |
872 | "Subroutine of `query-replace'. Its complexity handles interactive queries. |
873 | Don't use this in your own program unless you want to query and set the mark | |
874 | just as `query-replace' does. Instead, write a simple loop like this: | |
875 | (while (re-search-forward \"foo[ \t]+bar\" nil t) | |
876 | (replace-match \"foobar\" nil nil)) | |
e782e9f2 | 877 | which will run faster and probably do exactly what you want." |
81bdc14d | 878 | (or map (setq map query-replace-map)) |
1c1dadab RS |
879 | (and query-flag minibuffer-auto-raise |
880 | (raise-frame (window-frame (minibuffer-window)))) | |
698e1804 RS |
881 | (let ((nocasify (not (and case-fold-search case-replace |
882 | (string-equal from-string | |
883 | (downcase from-string))))) | |
5a78b471 KH |
884 | (case-fold-search (and case-fold-search |
885 | (string-equal from-string | |
886 | (downcase from-string)))) | |
698e1804 RS |
887 | (literal (not regexp-flag)) |
888 | (search-function (if regexp-flag 're-search-forward 'search-forward)) | |
889 | (search-string from-string) | |
e5d77022 | 890 | (real-match-data nil) ; the match data for the current match |
698e1804 | 891 | (next-replacement nil) |
698e1804 RS |
892 | (keep-going t) |
893 | (stack nil) | |
698e1804 | 894 | (replace-count 0) |
5632eb27 PE |
895 | (nonempty-match nil) |
896 | ||
7ef5c431 KH |
897 | ;; If non-nil, it is marker saying where in the buffer to stop. |
898 | (limit nil) | |
899 | ||
5632eb27 PE |
900 | ;; Data for the next match. If a cons, it has the same format as |
901 | ;; (match-data); otherwise it is t if a match is possible at point. | |
ae4eb03c | 902 | (match-again t) |
5632eb27 | 903 | |
02d95a27 RS |
904 | (message |
905 | (if query-flag | |
906 | (substitute-command-keys | |
907 | "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) ")))) | |
7ef5c431 KH |
908 | |
909 | ;; If region is active, in Transient Mark mode, operate on region. | |
47d72254 GM |
910 | (when start |
911 | (setq limit (copy-marker (max start end))) | |
912 | (goto-char (min start end)) | |
913 | (deactivate-mark)) | |
84482eb3 RS |
914 | |
915 | ;; REPLACEMENTS is either a string, a list of strings, or a cons cell | |
916 | ;; containing a function and its first argument. The function is | |
917 | ;; called to generate each replacement like this: | |
918 | ;; (funcall (car replacements) (cdr replacements) replace-count) | |
919 | ;; It must return a string. | |
920 | (cond | |
921 | ((stringp replacements) | |
922 | (setq next-replacement replacements | |
923 | replacements nil)) | |
924 | ((stringp (car replacements)) ; If it isn't a string, it must be a cons | |
925 | (or repeat-count (setq repeat-count 1)) | |
926 | (setq replacements (cons 'replace-loop-through-replacements | |
927 | (vector repeat-count repeat-count | |
928 | replacements replacements))))) | |
929 | ||
698e1804 RS |
930 | (if delimited-flag |
931 | (setq search-function 're-search-forward | |
932 | search-string (concat "\\b" | |
933 | (if regexp-flag from-string | |
934 | (regexp-quote from-string)) | |
935 | "\\b"))) | |
936 | (push-mark) | |
937 | (undo-boundary) | |
e782e9f2 RS |
938 | (unwind-protect |
939 | ;; Loop finding occurrences that perhaps should be replaced. | |
940 | (while (and keep-going | |
941 | (not (eobp)) | |
5632eb27 PE |
942 | ;; Use the next match if it is already known; |
943 | ;; otherwise, search for a match after moving forward | |
944 | ;; one char if progress is required. | |
945 | (setq real-match-data | |
946 | (if (consp match-again) | |
947 | (progn (goto-char (nth 1 match-again)) | |
948 | match-again) | |
949 | (and (or match-again | |
889617de GM |
950 | ;; MATCH-AGAIN non-nil means we |
951 | ;; accept an adjacent match. If | |
952 | ;; we don't, move one char to the | |
953 | ;; right. This takes us a | |
954 | ;; character too far at the end, | |
955 | ;; but this is undone after the | |
956 | ;; while-loop. | |
8f3ff96b | 957 | (progn (forward-char 1) (not (eobp)))) |
7ef5c431 | 958 | (funcall search-function search-string limit t) |
5632eb27 PE |
959 | ;; For speed, use only integers and |
960 | ;; reuse the list used last time. | |
961 | (match-data t real-match-data))))) | |
962 | ||
963 | ;; Record whether the match is nonempty, to avoid an infinite loop | |
964 | ;; repeatedly matching the same empty string. | |
965 | (setq nonempty-match | |
966 | (/= (nth 0 real-match-data) (nth 1 real-match-data))) | |
967 | ||
968 | ;; If the match is empty, record that the next one can't be adjacent. | |
969 | ;; Otherwise, if matching a regular expression, do the next | |
970 | ;; match now, since the replacement for this match may | |
971 | ;; affect whether the next match is adjacent to this one. | |
972 | (setq match-again | |
973 | (and nonempty-match | |
974 | (or (not regexp-flag) | |
975 | (and (looking-at search-string) | |
937ab68f | 976 | (match-data))))) |
5632eb27 | 977 | |
84482eb3 RS |
978 | ;; Calculate the replacement string, if necessary. |
979 | (when replacements | |
980 | (set-match-data real-match-data) | |
981 | (setq next-replacement | |
982 | (funcall (car replacements) (cdr replacements) | |
983 | replace-count))) | |
e782e9f2 RS |
984 | (if (not query-flag) |
985 | (progn | |
ef4aaf5f | 986 | (set-match-data real-match-data) |
e782e9f2 RS |
987 | (replace-match next-replacement nocasify literal) |
988 | (setq replace-count (1+ replace-count))) | |
989 | (undo-boundary) | |
990 | (let (done replaced key def) | |
991 | ;; Loop reading commands until one of them sets done, | |
992 | ;; which means it has finished handling this occurrence. | |
993 | (while (not done) | |
ef4aaf5f | 994 | (set-match-data real-match-data) |
e782e9f2 | 995 | (replace-highlight (match-beginning 0) (match-end 0)) |
c006b215 KH |
996 | ;; Bind message-log-max so we don't fill up the message log |
997 | ;; with a bunch of identical messages. | |
998 | (let ((message-log-max nil)) | |
999 | (message message from-string next-replacement)) | |
e782e9f2 | 1000 | (setq key (read-event)) |
f5e52cd3 RS |
1001 | ;; Necessary in case something happens during read-event |
1002 | ;; that clobbers the match data. | |
ef4aaf5f | 1003 | (set-match-data real-match-data) |
e782e9f2 RS |
1004 | (setq key (vector key)) |
1005 | (setq def (lookup-key map key)) | |
1006 | ;; Restore the match data while we process the command. | |
e782e9f2 RS |
1007 | (cond ((eq def 'help) |
1008 | (with-output-to-temp-buffer "*Help*" | |
1009 | (princ | |
1010 | (concat "Query replacing " | |
1011 | (if regexp-flag "regexp " "") | |
1012 | from-string " with " | |
1013 | next-replacement ".\n\n" | |
1014 | (substitute-command-keys | |
b905ac33 KH |
1015 | query-replace-help))) |
1016 | (save-excursion | |
1017 | (set-buffer standard-output) | |
1018 | (help-mode)))) | |
e782e9f2 RS |
1019 | ((eq def 'exit) |
1020 | (setq keep-going nil) | |
1021 | (setq done t)) | |
1022 | ((eq def 'backup) | |
237e6ab0 KH |
1023 | (if stack |
1024 | (let ((elt (car stack))) | |
1025 | (goto-char (car elt)) | |
1026 | (setq replaced (eq t (cdr elt))) | |
1027 | (or replaced | |
ef4aaf5f | 1028 | (set-match-data (cdr elt))) |
237e6ab0 KH |
1029 | (setq stack (cdr stack))) |
1030 | (message "No previous match") | |
1031 | (ding 'no-terminate) | |
1032 | (sit-for 1))) | |
e782e9f2 RS |
1033 | ((eq def 'act) |
1034 | (or replaced | |
3043b0b4 RS |
1035 | (progn |
1036 | (replace-match next-replacement nocasify literal) | |
1037 | (setq replace-count (1+ replace-count)))) | |
e782e9f2 RS |
1038 | (setq done t replaced t)) |
1039 | ((eq def 'act-and-exit) | |
1040 | (or replaced | |
3043b0b4 RS |
1041 | (progn |
1042 | (replace-match next-replacement nocasify literal) | |
1043 | (setq replace-count (1+ replace-count)))) | |
e782e9f2 RS |
1044 | (setq keep-going nil) |
1045 | (setq done t replaced t)) | |
1046 | ((eq def 'act-and-show) | |
1047 | (if (not replaced) | |
1048 | (progn | |
1049 | (replace-match next-replacement nocasify literal) | |
3043b0b4 | 1050 | (setq replace-count (1+ replace-count)) |
e782e9f2 RS |
1051 | (setq replaced t)))) |
1052 | ((eq def 'automatic) | |
1053 | (or replaced | |
3043b0b4 RS |
1054 | (progn |
1055 | (replace-match next-replacement nocasify literal) | |
1056 | (setq replace-count (1+ replace-count)))) | |
e782e9f2 RS |
1057 | (setq done t query-flag nil replaced t)) |
1058 | ((eq def 'skip) | |
1059 | (setq done t)) | |
1060 | ((eq def 'recenter) | |
1061 | (recenter nil)) | |
1062 | ((eq def 'edit) | |
596235d6 KH |
1063 | (let ((opos (point-marker))) |
1064 | (goto-char (match-beginning 0)) | |
1065 | (save-excursion | |
1066 | (funcall search-function search-string limit t) | |
1067 | (setq real-match-data (match-data))) | |
1068 | (save-excursion (recursive-edit)) | |
1069 | (goto-char opos)) | |
a9c4c78a | 1070 | (set-match-data real-match-data) |
ae4eb03c RS |
1071 | ;; Before we make the replacement, |
1072 | ;; decide whether the search string | |
1073 | ;; can match again just after this match. | |
5632eb27 PE |
1074 | (if (and regexp-flag nonempty-match) |
1075 | (setq match-again (and (looking-at search-string) | |
937ab68f | 1076 | (match-data))))) |
7ce278f3 GM |
1077 | |
1078 | ;; Edit replacement. | |
1079 | ((eq def 'edit-replacement) | |
1080 | (setq next-replacement | |
1081 | (read-input "Edit replacement string: " | |
1082 | next-replacement)) | |
1083 | (or replaced | |
1084 | (replace-match next-replacement nocasify literal)) | |
1085 | (setq done t)) | |
1086 | ||
e782e9f2 RS |
1087 | ((eq def 'delete-and-edit) |
1088 | (delete-region (match-beginning 0) (match-end 0)) | |
ef4aaf5f | 1089 | (set-match-data |
e782e9f2 RS |
1090 | (prog1 (match-data) |
1091 | (save-excursion (recursive-edit)))) | |
1092 | (setq replaced t)) | |
d9121bc0 RS |
1093 | ;; Note: we do not need to treat `exit-prefix' |
1094 | ;; specially here, since we reread | |
1095 | ;; any unrecognized character. | |
e782e9f2 | 1096 | (t |
d9121bc0 | 1097 | (setq this-command 'mode-exited) |
e782e9f2 RS |
1098 | (setq keep-going nil) |
1099 | (setq unread-command-events | |
1100 | (append (listify-key-sequence key) | |
1101 | unread-command-events)) | |
1102 | (setq done t)))) | |
1103 | ;; Record previous position for ^ when we move on. | |
1104 | ;; Change markers to numbers in the match data | |
1105 | ;; since lots of markers slow down editing. | |
1106 | (setq stack | |
1107 | (cons (cons (point) | |
141aa68c | 1108 | (or replaced (match-data t))) |
5632eb27 | 1109 | stack))))) |
889617de GM |
1110 | |
1111 | ;; The code preventing adjacent regexp matches in the condition | |
1112 | ;; of the while-loop above will haven taken us one character | |
1113 | ;; beyond the last replacement. Undo that. | |
1114 | (when (and regexp-flag (not match-again) (> replace-count 0)) | |
1115 | (backward-char 1)) | |
1116 | ||
e782e9f2 | 1117 | (replace-dehighlight)) |
4d33492a RS |
1118 | (or unread-command-events |
1119 | (message "Replaced %d occurrence%s" | |
1120 | replace-count | |
1121 | (if (= replace-count 1) "" "s"))) | |
1122 | (and keep-going stack))) | |
698e1804 | 1123 | |
95807e68 | 1124 | (defcustom query-replace-highlight t |
9d325ebf RS |
1125 | "*Non-nil means to highlight words during query replacement." |
1126 | :type 'boolean | |
1127 | :group 'matching) | |
e782e9f2 RS |
1128 | |
1129 | (defvar replace-overlay nil) | |
1130 | ||
1131 | (defun replace-dehighlight () | |
1132 | (and replace-overlay | |
1133 | (progn | |
1134 | (delete-overlay replace-overlay) | |
1135 | (setq replace-overlay nil)))) | |
1136 | ||
1137 | (defun replace-highlight (start end) | |
1138 | (and query-replace-highlight | |
1139 | (progn | |
1140 | (or replace-overlay | |
1141 | (progn | |
1142 | (setq replace-overlay (make-overlay start end)) | |
1143 | (overlay-put replace-overlay 'face | |
e730be7f | 1144 | (if (facep 'query-replace) |
e782e9f2 RS |
1145 | 'query-replace 'region)))) |
1146 | (move-overlay replace-overlay start end (current-buffer))))) | |
1147 | ||
c88ab9ce | 1148 | ;;; replace.el ends here |