Commit | Line | Data |
---|---|---|
60370d40 | 1 | ;;; replace.el --- replace commands for Emacs |
c88ab9ce | 2 | |
acaf905b | 3 | ;; Copyright (C) 1985-1987, 1992, 1994, 1996-1997, 2000-2012 |
1e4bd40d | 4 | ;; Free Software Foundation, Inc. |
3a801d0c | 5 | |
30764597 | 6 | ;; Maintainer: FSF |
bd78fa1d | 7 | ;; Package: emacs |
30764597 | 8 | |
698e1804 RS |
9 | ;; This file is part of GNU Emacs. |
10 | ||
eb3fa2cf | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
698e1804 | 12 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
698e1804 RS |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
698e1804 | 23 | |
d9ecc911 ER |
24 | ;;; Commentary: |
25 | ||
26 | ;; This package supplies the string and regular-expression replace functions | |
27 | ;; documented in the Emacs user's manual. | |
28 | ||
4f4b8eff | 29 | ;;; Code: |
698e1804 | 30 | |
9d325ebf | 31 | (defcustom case-replace t |
9201cc28 | 32 | "Non-nil means `query-replace' should preserve case in replacements." |
9d325ebf RS |
33 | :type 'boolean |
34 | :group 'matching) | |
77176e73 | 35 | |
84d0a5f8 GM |
36 | (defvar query-replace-history nil |
37 | "Default history list for query-replace commands. | |
38 | See `query-replace-from-history-variable' and | |
39 | `query-replace-to-history-variable'.") | |
770970cb | 40 | |
6b59b130 CY |
41 | (defvar query-replace-defaults nil |
42 | "Default values of FROM-STRING and TO-STRING for `query-replace'. | |
43 | This is a cons cell (FROM-STRING . TO-STRING), or nil if there is | |
44 | no default value.") | |
45 | ||
5291cbca | 46 | (defvar query-replace-interactive nil |
151270f3 | 47 | "Non-nil means `query-replace' uses the last search string. |
5291cbca | 48 | That becomes the \"string to replace\".") |
151270f3 | 49 | |
bdb1c08f | 50 | (defcustom query-replace-from-history-variable 'query-replace-history |
f54701d1 | 51 | "History list to use for the FROM argument of `query-replace' commands. |
bdb1c08f RS |
52 | The value of this variable should be a symbol; that symbol |
53 | is used as a variable to hold a history list for the strings | |
54 | or patterns to be replaced." | |
55 | :group 'matching | |
cd32a7ba DN |
56 | :type 'symbol |
57 | :version "20.3") | |
bdb1c08f RS |
58 | |
59 | (defcustom query-replace-to-history-variable 'query-replace-history | |
f54701d1 | 60 | "History list to use for the TO argument of `query-replace' commands. |
bdb1c08f RS |
61 | The value of this variable should be a symbol; that symbol |
62 | is used as a variable to hold a history list for replacement | |
63 | strings or patterns." | |
64 | :group 'matching | |
cd32a7ba DN |
65 | :type 'symbol |
66 | :version "20.3") | |
bdb1c08f | 67 | |
1c4fe319 | 68 | (defcustom query-replace-skip-read-only nil |
9201cc28 | 69 | "Non-nil means `query-replace' and friends ignore read-only matches." |
1c4fe319 RS |
70 | :type 'boolean |
71 | :group 'matching | |
bf247b6e | 72 | :version "22.1") |
1c4fe319 | 73 | |
7abe68aa | 74 | (defcustom query-replace-show-replacement t |
9201cc28 | 75 | "Non-nil means to show what actual replacement text will be." |
7abe68aa JL |
76 | :type 'boolean |
77 | :group 'matching | |
78 | :version "23.1") | |
79 | ||
afd33362 | 80 | (defcustom query-replace-highlight t |
9201cc28 | 81 | "Non-nil means to highlight matches during query replacement." |
afd33362 JL |
82 | :type 'boolean |
83 | :group 'matching) | |
84 | ||
85 | (defcustom query-replace-lazy-highlight t | |
9201cc28 | 86 | "Controls the lazy-highlighting during query replacements. |
afd33362 JL |
87 | When non-nil, all text in the buffer matching the current match |
88 | is highlighted lazily using isearch lazy highlighting (see | |
89 | `lazy-highlight-initial-delay' and `lazy-highlight-interval')." | |
90 | :type 'boolean | |
91 | :group 'lazy-highlight | |
92 | :group 'matching | |
bf247b6e | 93 | :version "22.1") |
afd33362 JL |
94 | |
95 | (defface query-replace | |
96 | '((t (:inherit isearch))) | |
97 | "Face for highlighting query replacement matches." | |
98 | :group 'matching | |
bf247b6e | 99 | :version "22.1") |
afd33362 | 100 | |
06b60517 JB |
101 | (defvar replace-count 0 |
102 | "Number of replacements done so far. | |
103 | See `replace-regexp' and `query-replace-regexp-eval'.") | |
104 | ||
6f1df6d9 SM |
105 | (defun query-replace-descr (string) |
106 | (mapconcat 'isearch-text-char-description string "")) | |
107 | ||
90c9fc2a | 108 | (defun query-replace-read-from (prompt regexp-flag) |
6f1df6d9 SM |
109 | "Query and return the `from' argument of a query-replace operation. |
110 | The return value can also be a pair (FROM . TO) indicating that the user | |
111 | wants to replace FROM with TO." | |
1606466a SM |
112 | (if query-replace-interactive |
113 | (car (if regexp-flag regexp-search-ring search-ring)) | |
2bf2b947 JL |
114 | (let* ((history-add-new-input nil) |
115 | (from | |
1606466a SM |
116 | ;; The save-excursion here is in case the user marks and copies |
117 | ;; a region in order to specify the minibuffer input. | |
118 | ;; That should not clobber the region for the query-replace itself. | |
119 | (save-excursion | |
120 | (read-from-minibuffer | |
6b59b130 | 121 | (if query-replace-defaults |
90c9fc2a | 122 | (format "%s (default %s -> %s): " prompt |
6b59b130 CY |
123 | (query-replace-descr (car query-replace-defaults)) |
124 | (query-replace-descr (cdr query-replace-defaults))) | |
90c9fc2a | 125 | (format "%s: " prompt)) |
1606466a SM |
126 | nil nil nil |
127 | query-replace-from-history-variable | |
311f8bac | 128 | nil t)))) |
6b59b130 | 129 | (if (and (zerop (length from)) query-replace-defaults) |
5dae4b11 CY |
130 | (cons (car query-replace-defaults) |
131 | (query-replace-compile-replacement | |
132 | (cdr query-replace-defaults) regexp-flag)) | |
2bf2b947 | 133 | (add-to-history query-replace-from-history-variable from nil t) |
6f1df6d9 SM |
134 | ;; Warn if user types \n or \t, but don't reject the input. |
135 | (and regexp-flag | |
136 | (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\[nt]\\)" from) | |
137 | (let ((match (match-string 3 from))) | |
138 | (cond | |
139 | ((string= match "\\n") | |
140 | (message "Note: `\\n' here doesn't match a newline; to do that, type C-q C-j instead")) | |
141 | ((string= match "\\t") | |
142 | (message "Note: `\\t' here doesn't match a tab; to do that, just type TAB"))) | |
143 | (sit-for 2))) | |
144 | from)))) | |
1606466a | 145 | |
78629844 DK |
146 | (defun query-replace-compile-replacement (to regexp-flag) |
147 | "Maybe convert a regexp replacement TO to Lisp. | |
148 | Returns a list suitable for `perform-replace' if necessary, | |
149 | the original string if not." | |
150 | (if (and regexp-flag | |
151 | (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to)) | |
7c1c02ac DK |
152 | (let (pos list char) |
153 | (while | |
154 | (progn | |
155 | (setq pos (match-end 0)) | |
156 | (push (substring to 0 (- pos 2)) list) | |
157 | (setq char (aref to (1- pos)) | |
158 | to (substring to pos)) | |
159 | (cond ((eq char ?\#) | |
160 | (push '(number-to-string replace-count) list)) | |
161 | ((eq char ?\,) | |
162 | (setq pos (read-from-string to)) | |
163 | (push `(replace-quote ,(car pos)) list) | |
9e5d1b63 RS |
164 | (let ((end |
165 | ;; Swallow a space after a symbol | |
166 | ;; if there is a space. | |
167 | (if (and (or (symbolp (car pos)) | |
168 | ;; Swallow a space after 'foo | |
169 | ;; but not after (quote foo). | |
170 | (and (eq (car-safe (car pos)) 'quote) | |
f1f6079c JL |
171 | (not (= ?\( (aref to 0))))) |
172 | (eq (string-match " " to (cdr pos)) | |
173 | (cdr pos))) | |
9e5d1b63 RS |
174 | (1+ (cdr pos)) |
175 | (cdr pos)))) | |
176 | (setq to (substring to end))))) | |
7c1c02ac | 177 | (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\\\[,#]" to))) |
78629844 DK |
178 | (setq to (nreverse (delete "" (cons to list)))) |
179 | (replace-match-string-symbols to) | |
180 | (cons 'replace-eval-replacement | |
181 | (if (cdr to) | |
182 | (cons 'concat to) | |
183 | (car to)))) | |
1606466a SM |
184 | to)) |
185 | ||
78629844 | 186 | |
90c9fc2a | 187 | (defun query-replace-read-to (from prompt regexp-flag) |
78629844 DK |
188 | "Query and return the `to' argument of a query-replace operation." |
189 | (query-replace-compile-replacement | |
190 | (save-excursion | |
2bf2b947 JL |
191 | (let* ((history-add-new-input nil) |
192 | (to (read-from-minibuffer | |
193 | (format "%s %s with: " prompt (query-replace-descr from)) | |
194 | nil nil nil | |
195 | query-replace-to-history-variable from t))) | |
196 | (add-to-history query-replace-to-history-variable to nil t) | |
6b59b130 CY |
197 | (setq query-replace-defaults (cons from to)) |
198 | to)) | |
78629844 DK |
199 | regexp-flag)) |
200 | ||
90c9fc2a | 201 | (defun query-replace-read-args (prompt regexp-flag &optional noerror) |
1606466a SM |
202 | (unless noerror |
203 | (barf-if-buffer-read-only)) | |
90c9fc2a | 204 | (let* ((from (query-replace-read-from prompt regexp-flag)) |
6f1df6d9 | 205 | (to (if (consp from) (prog1 (cdr from) (setq from (car from))) |
90c9fc2a | 206 | (query-replace-read-to from prompt regexp-flag)))) |
10784bac | 207 | (list from to current-prefix-arg))) |
770970cb | 208 | |
47d72254 | 209 | (defun query-replace (from-string to-string &optional delimited start end) |
da44e784 RM |
210 | "Replace some occurrences of FROM-STRING with TO-STRING. |
211 | As each match is found, the user must type a character saying | |
212 | what to do with it. For directions, type \\[help-command] at that time. | |
213 | ||
7ef5c431 KH |
214 | In Transient Mark mode, if the mark is active, operate on the contents |
215 | of the region. Otherwise, operate from point to the end of the buffer. | |
216 | ||
151270f3 RS |
217 | If `query-replace-interactive' is non-nil, the last incremental search |
218 | string is used as FROM-STRING--you don't have to specify it with the | |
219 | minibuffer. | |
220 | ||
446d9629 RS |
221 | Matching is independent of case if `case-fold-search' is non-nil and |
222 | FROM-STRING has no uppercase letters. Replacement transfers the case | |
223 | pattern of the old text to the new text, if `case-replace' and | |
224 | `case-fold-search' are non-nil and FROM-STRING has no uppercase | |
225 | letters. \(Transferring the case pattern means that if the old text | |
226 | matched is all caps, or capitalized, then its replacement is upcased | |
227 | or capitalized.) | |
9b0bf2b6 | 228 | |
118a01c9 | 229 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
81bdc14d | 230 | only matches surrounded by word boundaries. |
47d72254 | 231 | Fourth and fifth arg START and END specify the region to operate on. |
81bdc14d RS |
232 | |
233 | To customize possible responses, change the \"bindings\" in `query-replace-map'." | |
04ff2dee JL |
234 | (interactive |
235 | (let ((common | |
236 | (query-replace-read-args | |
237 | (concat "Query replace" | |
238 | (if current-prefix-arg " word" "") | |
239 | (if (and transient-mark-mode mark-active) " in region" "")) | |
240 | nil))) | |
241 | (list (nth 0 common) (nth 1 common) (nth 2 common) | |
242 | ;; These are done separately here | |
243 | ;; so that command-history will record these expressions | |
244 | ;; rather than the values they had this time. | |
245 | (if (and transient-mark-mode mark-active) | |
246 | (region-beginning)) | |
247 | (if (and transient-mark-mode mark-active) | |
248 | (region-end))))) | |
99a7559f | 249 | (perform-replace from-string to-string t nil delimited nil nil start end)) |
7ef5c431 | 250 | |
73fa8346 | 251 | (define-key esc-map "%" 'query-replace) |
da44e784 | 252 | |
47d72254 | 253 | (defun query-replace-regexp (regexp to-string &optional delimited start end) |
da44e784 RM |
254 | "Replace some things after point matching REGEXP with TO-STRING. |
255 | As each match is found, the user must type a character saying | |
256 | what to do with it. For directions, type \\[help-command] at that time. | |
257 | ||
7ef5c431 KH |
258 | In Transient Mark mode, if the mark is active, operate on the contents |
259 | of the region. Otherwise, operate from point to the end of the buffer. | |
260 | ||
151270f3 RS |
261 | If `query-replace-interactive' is non-nil, the last incremental search |
262 | regexp is used as REGEXP--you don't have to specify it with the | |
263 | minibuffer. | |
264 | ||
446d9629 RS |
265 | Matching is independent of case if `case-fold-search' is non-nil and |
266 | REGEXP has no uppercase letters. Replacement transfers the case | |
267 | pattern of the old text to the new text, if `case-replace' and | |
268 | `case-fold-search' are non-nil and REGEXP has no uppercase letters. | |
269 | \(Transferring the case pattern means that if the old text matched is | |
270 | all caps, or capitalized, then its replacement is upcased or | |
271 | capitalized.) | |
47d72254 | 272 | |
118a01c9 | 273 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 274 | only matches surrounded by word boundaries. |
47d72254 GM |
275 | Fourth and fifth arg START and END specify the region to operate on. |
276 | ||
118a01c9 RS |
277 | In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP, |
278 | and `\\=\\N' (where N is a digit) stands for | |
2f57bf85 | 279 | whatever what matched the Nth `\\(...\\)' in REGEXP. |
7c1c02ac DK |
280 | `\\?' lets you edit the replacement text in the minibuffer |
281 | at the given position for each replacement. | |
282 | ||
ba8d15f9 RS |
283 | In interactive calls, the replacement text can contain `\\,' |
284 | followed by a Lisp expression. Each | |
285 | replacement evaluates that expression to compute the replacement | |
286 | string. Inside of that expression, `\\&' is a string denoting the | |
f1f6079c | 287 | whole match as a string, `\\N' for a partial match, `\\#&' and `\\#N' |
ba8d15f9 RS |
288 | for the whole or a partial match converted to a number with |
289 | `string-to-number', and `\\#' itself for the number of replacements | |
290 | done so far (starting with zero). | |
7c1c02ac | 291 | |
ba8d15f9 RS |
292 | If the replacement expression is a symbol, write a space after it |
293 | to terminate it. One space there, if any, will be discarded. | |
7c1c02ac DK |
294 | |
295 | When using those Lisp features interactively in the replacement | |
296 | text, TO-STRING is actually made a list instead of a string. | |
297 | Use \\[repeat-complex-command] after this command for details." | |
10784bac RS |
298 | (interactive |
299 | (let ((common | |
10ddc30e | 300 | (query-replace-read-args |
04ff2dee JL |
301 | (concat "Query replace" |
302 | (if current-prefix-arg " word" "") | |
303 | " regexp" | |
304 | (if (and transient-mark-mode mark-active) " in region" "")) | |
f79bdb3a | 305 | t))) |
7c1c02ac DK |
306 | (list (nth 0 common) (nth 1 common) (nth 2 common) |
307 | ;; These are done separately here | |
308 | ;; so that command-history will record these expressions | |
309 | ;; rather than the values they had this time. | |
310 | (if (and transient-mark-mode mark-active) | |
311 | (region-beginning)) | |
312 | (if (and transient-mark-mode mark-active) | |
313 | (region-end))))) | |
99a7559f | 314 | (perform-replace regexp to-string t t delimited nil nil start end)) |
2f57bf85 | 315 | |
cbc127de | 316 | (define-key esc-map [?\C-%] 'query-replace-regexp) |
da44e784 | 317 | |
47d72254 | 318 | (defun query-replace-regexp-eval (regexp to-expr &optional delimited start end) |
84482eb3 | 319 | "Replace some things after point matching REGEXP with the result of TO-EXPR. |
fc6a2250 DK |
320 | |
321 | Interactive use of this function is deprecated in favor of the | |
322 | `\\,' feature of `query-replace-regexp'. For non-interactive use, a loop | |
323 | using `search-forward-regexp' and `replace-match' is preferred. | |
324 | ||
84482eb3 RS |
325 | As each match is found, the user must type a character saying |
326 | what to do with it. For directions, type \\[help-command] at that time. | |
327 | ||
328 | TO-EXPR is a Lisp expression evaluated to compute each replacement. It may | |
329 | reference `replace-count' to get the number of replacements already made. | |
330 | If the result of TO-EXPR is not a string, it is converted to one using | |
331 | `prin1-to-string' with the NOESCAPE argument (which see). | |
332 | ||
333 | For convenience, when entering TO-EXPR interactively, you can use `\\&' or | |
653479ad AS |
334 | `\\0' to stand for whatever matched the whole of REGEXP, and `\\N' (where |
335 | N is a digit) to stand for whatever matched the Nth `\\(...\\)' in REGEXP. | |
84482eb3 | 336 | Use `\\#&' or `\\#N' if you want a number instead of a string. |
2f57bf85 | 337 | In interactive use, `\\#' in itself stands for `replace-count'. |
84482eb3 RS |
338 | |
339 | In Transient Mark mode, if the mark is active, operate on the contents | |
340 | of the region. Otherwise, operate from point to the end of the buffer. | |
341 | ||
342 | If `query-replace-interactive' is non-nil, the last incremental search | |
343 | regexp is used as REGEXP--you don't have to specify it with the | |
344 | minibuffer. | |
345 | ||
346 | Preserves case in each replacement if `case-replace' and `case-fold-search' | |
347 | are non-nil and REGEXP has no uppercase letters. | |
47d72254 | 348 | |
84482eb3 | 349 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
470bbe9b | 350 | only matches that are surrounded by word boundaries. |
47d72254 | 351 | Fourth and fifth arg START and END specify the region to operate on." |
84482eb3 | 352 | (interactive |
cc0aea1a | 353 | (progn |
6f1df6d9 SM |
354 | (barf-if-buffer-read-only) |
355 | (let* ((from | |
356 | ;; Let-bind the history var to disable the "foo -> bar" default. | |
357 | ;; Maybe we shouldn't disable this default, but for now I'll | |
358 | ;; leave it off. --Stef | |
359 | (let ((query-replace-to-history-variable nil)) | |
360 | (query-replace-read-from "Query replace regexp" t))) | |
5291cbca | 361 | (to (list (read-from-minibuffer |
6f1df6d9 SM |
362 | (format "Query replace regexp %s with eval: " |
363 | (query-replace-descr from)) | |
5291cbca | 364 | nil nil t query-replace-to-history-variable from t)))) |
84482eb3 RS |
365 | ;; We make TO a list because replace-match-string-symbols requires one, |
366 | ;; and the user might enter a single token. | |
367 | (replace-match-string-symbols to) | |
10784bac RS |
368 | (list from (car to) current-prefix-arg |
369 | (if (and transient-mark-mode mark-active) | |
370 | (region-beginning)) | |
371 | (if (and transient-mark-mode mark-active) | |
cc0aea1a | 372 | (region-end)))))) |
d2ce3151 | 373 | (perform-replace regexp (cons 'replace-eval-replacement to-expr) |
d83a97ab | 374 | t 'literal delimited nil nil start end)) |
84482eb3 | 375 | |
fc6a2250 DK |
376 | (make-obsolete 'query-replace-regexp-eval |
377 | "for interactive use, use the special `\\,' feature of | |
378 | `query-replace-regexp' instead. Non-interactively, a loop | |
379 | using `search-forward-regexp' and `replace-match' is preferred." "22.1") | |
380 | ||
47d72254 | 381 | (defun map-query-replace-regexp (regexp to-strings &optional n start end) |
da44e784 | 382 | "Replace some matches for REGEXP with various strings, in rotation. |
d8f1d2f3 JB |
383 | The second argument TO-STRINGS contains the replacement strings, separated |
384 | by spaces. This command works like `query-replace-regexp' except that | |
385 | each successive replacement uses the next successive replacement string, | |
da44e784 RM |
386 | wrapping around from the last such string to the first. |
387 | ||
7ef5c431 KH |
388 | In Transient Mark mode, if the mark is active, operate on the contents |
389 | of the region. Otherwise, operate from point to the end of the buffer. | |
390 | ||
da44e784 RM |
391 | Non-interactively, TO-STRINGS may be a list of replacement strings. |
392 | ||
151270f3 RS |
393 | If `query-replace-interactive' is non-nil, the last incremental search |
394 | regexp is used as REGEXP--you don't have to specify it with the minibuffer. | |
395 | ||
da44e784 | 396 | A prefix argument N says to use each replacement string N times |
47d72254 GM |
397 | before rotating to the next. |
398 | Fourth and fifth arg START and END specify the region to operate on." | |
770970cb | 399 | (interactive |
5291cbca | 400 | (let* ((from (if query-replace-interactive |
151270f3 RS |
401 | (car regexp-search-ring) |
402 | (read-from-minibuffer "Map query replace (regexp): " | |
403 | nil nil nil | |
84d0a5f8 GM |
404 | query-replace-from-history-variable |
405 | nil t))) | |
5291cbca | 406 | (to (read-from-minibuffer |
770970cb | 407 | (format "Query replace %s with (space-separated strings): " |
6f1df6d9 | 408 | (query-replace-descr from)) |
770970cb | 409 | nil nil nil |
84d0a5f8 | 410 | query-replace-to-history-variable from t))) |
2f2f7e58 RS |
411 | (list from to |
412 | (and current-prefix-arg | |
413 | (prefix-numeric-value current-prefix-arg)) | |
10784bac RS |
414 | (if (and transient-mark-mode mark-active) |
415 | (region-beginning)) | |
416 | (if (and transient-mark-mode mark-active) | |
417 | (region-end))))) | |
da44e784 RM |
418 | (let (replacements) |
419 | (if (listp to-strings) | |
420 | (setq replacements to-strings) | |
421 | (while (/= (length to-strings) 0) | |
422 | (if (string-match " " to-strings) | |
423 | (setq replacements | |
424 | (append replacements | |
425 | (list (substring to-strings 0 | |
426 | (string-match " " to-strings)))) | |
427 | to-strings (substring to-strings | |
428 | (1+ (string-match " " to-strings)))) | |
429 | (setq replacements (append replacements (list to-strings)) | |
430 | to-strings "")))) | |
99a7559f | 431 | (perform-replace regexp replacements t t nil n nil start end))) |
da44e784 | 432 | |
47d72254 | 433 | (defun replace-string (from-string to-string &optional delimited start end) |
da44e784 RM |
434 | "Replace occurrences of FROM-STRING with TO-STRING. |
435 | Preserve case in each match if `case-replace' and `case-fold-search' | |
436 | are non-nil and FROM-STRING has no uppercase letters. | |
9b0bf2b6 RS |
437 | \(Preserving case means that if the string matched is all caps, or capitalized, |
438 | then its replacement is upcased or capitalized.) | |
439 | ||
7ef5c431 KH |
440 | In Transient Mark mode, if the mark is active, operate on the contents |
441 | of the region. Otherwise, operate from point to the end of the buffer. | |
442 | ||
118a01c9 | 443 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 444 | only matches surrounded by word boundaries. |
47d72254 | 445 | Fourth and fifth arg START and END specify the region to operate on. |
da44e784 | 446 | |
151270f3 RS |
447 | If `query-replace-interactive' is non-nil, the last incremental search |
448 | string is used as FROM-STRING--you don't have to specify it with the | |
449 | minibuffer. | |
450 | ||
da44e784 RM |
451 | This function is usually the wrong thing to use in a Lisp program. |
452 | What you probably want is a loop like this: | |
118a01c9 RS |
453 | (while (search-forward FROM-STRING nil t) |
454 | (replace-match TO-STRING nil t)) | |
87532fbe RS |
455 | which will run faster and will not set the mark or print anything. |
456 | \(You may need a more complex loop if FROM-STRING can match the null string | |
457 | and TO-STRING is also null.)" | |
10784bac RS |
458 | (interactive |
459 | (let ((common | |
10ddc30e | 460 | (query-replace-read-args |
04ff2dee JL |
461 | (concat "Replace" |
462 | (if current-prefix-arg " word" "") | |
463 | " string" | |
464 | (if (and transient-mark-mode mark-active) " in region" "")) | |
f79bdb3a | 465 | nil))) |
10784bac RS |
466 | (list (nth 0 common) (nth 1 common) (nth 2 common) |
467 | (if (and transient-mark-mode mark-active) | |
468 | (region-beginning)) | |
469 | (if (and transient-mark-mode mark-active) | |
470 | (region-end))))) | |
99a7559f | 471 | (perform-replace from-string to-string nil nil delimited nil nil start end)) |
da44e784 | 472 | |
47d72254 | 473 | (defun replace-regexp (regexp to-string &optional delimited start end) |
da44e784 | 474 | "Replace things after point matching REGEXP with TO-STRING. |
118a01c9 | 475 | Preserve case in each match if `case-replace' and `case-fold-search' |
da44e784 | 476 | are non-nil and REGEXP has no uppercase letters. |
47d72254 GM |
477 | |
478 | In Transient Mark mode, if the mark is active, operate on the contents | |
479 | of the region. Otherwise, operate from point to the end of the buffer. | |
480 | ||
118a01c9 | 481 | Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace |
da44e784 | 482 | only matches surrounded by word boundaries. |
47d72254 GM |
483 | Fourth and fifth arg START and END specify the region to operate on. |
484 | ||
118a01c9 RS |
485 | In TO-STRING, `\\&' stands for whatever matched the whole of REGEXP, |
486 | and `\\=\\N' (where N is a digit) stands for | |
7c1c02ac DK |
487 | whatever what matched the Nth `\\(...\\)' in REGEXP. |
488 | `\\?' lets you edit the replacement text in the minibuffer | |
489 | at the given position for each replacement. | |
490 | ||
491 | In interactive calls, the replacement text may contain `\\,' | |
492 | followed by a Lisp expression used as part of the replacement | |
493 | text. Inside of that expression, `\\&' is a string denoting the | |
107173cf JB |
494 | whole match, `\\N' a partial match, `\\#&' and `\\#N' the respective |
495 | numeric values from `string-to-number', and `\\#' itself for | |
496 | `replace-count', the number of replacements occurred so far. | |
7c1c02ac DK |
497 | |
498 | If your Lisp expression is an identifier and the next letter in | |
499 | the replacement string would be interpreted as part of it, you | |
500 | can wrap it with an expression like `\\,(or \\#)'. Incidentally, | |
501 | for this particular case you may also enter `\\#' in the | |
502 | replacement text directly. | |
503 | ||
504 | When using those Lisp features interactively in the replacement | |
505 | text, TO-STRING is actually made a list instead of a string. | |
506 | Use \\[repeat-complex-command] after this command for details. | |
da44e784 | 507 | |
151270f3 RS |
508 | If `query-replace-interactive' is non-nil, the last incremental search |
509 | regexp is used as REGEXP--you don't have to specify it with the minibuffer. | |
510 | ||
da44e784 RM |
511 | This function is usually the wrong thing to use in a Lisp program. |
512 | What you probably want is a loop like this: | |
513 | (while (re-search-forward REGEXP nil t) | |
118a01c9 | 514 | (replace-match TO-STRING nil nil)) |
da44e784 | 515 | which will run faster and will not set the mark or print anything." |
10784bac RS |
516 | (interactive |
517 | (let ((common | |
10ddc30e | 518 | (query-replace-read-args |
04ff2dee JL |
519 | (concat "Replace" |
520 | (if current-prefix-arg " word" "") | |
521 | " regexp" | |
522 | (if (and transient-mark-mode mark-active) " in region" "")) | |
f79bdb3a | 523 | t))) |
10784bac RS |
524 | (list (nth 0 common) (nth 1 common) (nth 2 common) |
525 | (if (and transient-mark-mode mark-active) | |
526 | (region-beginning)) | |
527 | (if (and transient-mark-mode mark-active) | |
528 | (region-end))))) | |
99a7559f | 529 | (perform-replace regexp to-string nil t delimited nil nil start end)) |
e32eb3e6 | 530 | |
4c53bd2b RS |
531 | \f |
532 | (defvar regexp-history nil | |
fae97ed8 EZ |
533 | "History list for some commands that read regular expressions. |
534 | ||
535 | Maximum length of the history list is determined by the value | |
536 | of `history-length', which see.") | |
da44e784 | 537 | |
15af15e5 TO |
538 | (defvar occur-collect-regexp-history '("\\1") |
539 | "History of regexp for occur's collect operation") | |
540 | ||
10965505 | 541 | (defun read-regexp (prompt &optional default-value) |
96f606c5 | 542 | "Read regexp as a string using the regexp history and some useful defaults. |
714da757 | 543 | Prompt for a regular expression with PROMPT (without a colon and |
10965505 JL |
544 | space) in the minibuffer. The optional argument DEFAULT-VALUE |
545 | provides the value to display in the minibuffer prompt that is | |
546 | returned if the user just types RET. | |
547 | Values available via M-n are the string at point, the last isearch | |
548 | regexp, the last isearch string, and the last replacement regexp." | |
714da757 | 549 | (let* ((defaults |
96f606c5 JL |
550 | (list (regexp-quote |
551 | (or (funcall (or find-tag-default-function | |
552 | (get major-mode 'find-tag-default-function) | |
553 | 'find-tag-default)) | |
554 | "")) | |
555 | (car regexp-search-ring) | |
556 | (regexp-quote (or (car search-ring) "")) | |
557 | (car (symbol-value | |
558 | query-replace-from-history-variable)))) | |
559 | (defaults (delete-dups (delq nil (delete "" defaults)))) | |
560 | ;; Don't add automatically the car of defaults for empty input | |
561 | (history-add-new-input nil) | |
562 | (input | |
563 | (read-from-minibuffer | |
10965505 JL |
564 | (if default-value |
565 | (format "%s (default %s): " prompt | |
566 | (query-replace-descr default-value)) | |
96f606c5 JL |
567 | (format "%s: " prompt)) |
568 | nil nil nil 'regexp-history defaults t))) | |
569 | (if (equal input "") | |
99910cf4 | 570 | (or default-value input) |
96f606c5 JL |
571 | (prog1 input |
572 | (add-to-history 'regexp-history input))))) | |
573 | ||
e32eb3e6 | 574 | |
31e1d920 | 575 | (defalias 'delete-non-matching-lines 'keep-lines) |
e32eb3e6 GM |
576 | (defalias 'delete-matching-lines 'flush-lines) |
577 | (defalias 'count-matches 'how-many) | |
578 | ||
579 | ||
580 | (defun keep-lines-read-args (prompt) | |
581 | "Read arguments for `keep-lines' and friends. | |
582 | Prompt for a regexp with PROMPT. | |
2ced751f | 583 | Value is a list, (REGEXP)." |
99910cf4 | 584 | (list (read-regexp prompt) nil nil t)) |
e32eb3e6 | 585 | |
bace7209 | 586 | (defun keep-lines (regexp &optional rstart rend interactive) |
698e1804 RS |
587 | "Delete all lines except those containing matches for REGEXP. |
588 | A match split across lines preserves all the lines it lies in. | |
bace7209 LT |
589 | When called from Lisp (and usually interactively as well, see below) |
590 | applies to all lines starting after point. | |
d2a0ee8b | 591 | |
3be42fcd JL |
592 | If REGEXP contains upper case characters (excluding those preceded by `\\') |
593 | and `search-upper-case' is non-nil, the matching is case-sensitive. | |
e32eb3e6 GM |
594 | |
595 | Second and third arg RSTART and REND specify the region to operate on. | |
bace7209 LT |
596 | This command operates on (the accessible part of) all lines whose |
597 | accessible part is entirely contained in the region determined by RSTART | |
598 | and REND. (A newline ending a line counts as part of that line.) | |
e32eb3e6 | 599 | |
2ced751f | 600 | Interactively, in Transient Mark mode when the mark is active, operate |
bace7209 LT |
601 | on all lines whose accessible part is entirely contained in the region. |
602 | Otherwise, the command applies to all lines starting after point. | |
603 | When calling this function from Lisp, you can pretend that it was | |
604 | called interactively by passing a non-nil INTERACTIVE argument. | |
605 | ||
606 | This function starts looking for the next match from the end of | |
607 | the previous match. Hence, it ignores matches that overlap | |
608 | a previously found match." | |
2ced751f | 609 | |
e32eb3e6 | 610 | (interactive |
98faf1bb RS |
611 | (progn |
612 | (barf-if-buffer-read-only) | |
96f606c5 | 613 | (keep-lines-read-args "Keep lines containing match for regexp"))) |
e32eb3e6 | 614 | (if rstart |
119831da RS |
615 | (progn |
616 | (goto-char (min rstart rend)) | |
bace7209 LT |
617 | (setq rend |
618 | (progn | |
619 | (save-excursion | |
620 | (goto-char (max rstart rend)) | |
621 | (unless (or (bolp) (eobp)) | |
622 | (forward-line 0)) | |
623 | (point-marker))))) | |
624 | (if (and interactive transient-mark-mode mark-active) | |
2ced751f | 625 | (setq rstart (region-beginning) |
bace7209 LT |
626 | rend (progn |
627 | (goto-char (region-end)) | |
628 | (unless (or (bolp) (eobp)) | |
629 | (forward-line 0)) | |
630 | (point-marker))) | |
2ced751f RS |
631 | (setq rstart (point) |
632 | rend (point-max-marker))) | |
633 | (goto-char rstart)) | |
698e1804 RS |
634 | (save-excursion |
635 | (or (bolp) (forward-line 1)) | |
d2a0ee8b | 636 | (let ((start (point)) |
3be42fcd JL |
637 | (case-fold-search |
638 | (if (and case-fold-search search-upper-case) | |
639 | (isearch-no-upper-case-p regexp t) | |
640 | case-fold-search))) | |
e32eb3e6 | 641 | (while (< (point) rend) |
698e1804 | 642 | ;; Start is first char not preserved by previous match. |
e32eb3e6 GM |
643 | (if (not (re-search-forward regexp rend 'move)) |
644 | (delete-region start rend) | |
698e1804 | 645 | (let ((end (save-excursion (goto-char (match-beginning 0)) |
bace7209 | 646 | (forward-line 0) |
698e1804 RS |
647 | (point)))) |
648 | ;; Now end is first char preserved by the new match. | |
649 | (if (< start end) | |
650 | (delete-region start end)))) | |
d99118b0 | 651 | |
e32eb3e6 | 652 | (setq start (save-excursion (forward-line 1) (point))) |
698e1804 | 653 | ;; If the match was empty, avoid matching again at same place. |
e32eb3e6 GM |
654 | (and (< (point) rend) |
655 | (= (match-beginning 0) (match-end 0)) | |
bace7209 LT |
656 | (forward-char 1))))) |
657 | (set-marker rend nil) | |
658 | nil) | |
698e1804 | 659 | |
e32eb3e6 | 660 | |
bace7209 LT |
661 | (defun flush-lines (regexp &optional rstart rend interactive) |
662 | "Delete lines containing matches for REGEXP. | |
663 | When called from Lisp (and usually when called interactively as | |
664 | well, see below), applies to the part of the buffer after point. | |
665 | The line point is in is deleted if and only if it contains a | |
666 | match for regexp starting after point. | |
d2a0ee8b | 667 | |
3be42fcd JL |
668 | If REGEXP contains upper case characters (excluding those preceded by `\\') |
669 | and `search-upper-case' is non-nil, the matching is case-sensitive. | |
e32eb3e6 GM |
670 | |
671 | Second and third arg RSTART and REND specify the region to operate on. | |
bace7209 LT |
672 | Lines partially contained in this region are deleted if and only if |
673 | they contain a match entirely contained in it. | |
e32eb3e6 | 674 | |
2ced751f RS |
675 | Interactively, in Transient Mark mode when the mark is active, operate |
676 | on the contents of the region. Otherwise, operate from point to the | |
bace7209 LT |
677 | end of (the accessible portion of) the buffer. When calling this function |
678 | from Lisp, you can pretend that it was called interactively by passing | |
679 | a non-nil INTERACTIVE argument. | |
680 | ||
681 | If a match is split across lines, all the lines it lies in are deleted. | |
682 | They are deleted _before_ looking for the next match. Hence, a match | |
683 | starting on the same line at which another match ended is ignored." | |
2ced751f | 684 | |
e32eb3e6 | 685 | (interactive |
98faf1bb RS |
686 | (progn |
687 | (barf-if-buffer-read-only) | |
96f606c5 | 688 | (keep-lines-read-args "Flush lines containing match for regexp"))) |
e32eb3e6 | 689 | (if rstart |
119831da RS |
690 | (progn |
691 | (goto-char (min rstart rend)) | |
692 | (setq rend (copy-marker (max rstart rend)))) | |
bace7209 | 693 | (if (and interactive transient-mark-mode mark-active) |
2ced751f RS |
694 | (setq rstart (region-beginning) |
695 | rend (copy-marker (region-end))) | |
696 | (setq rstart (point) | |
697 | rend (point-max-marker))) | |
698 | (goto-char rstart)) | |
3be42fcd JL |
699 | (let ((case-fold-search |
700 | (if (and case-fold-search search-upper-case) | |
701 | (isearch-no-upper-case-p regexp t) | |
702 | case-fold-search))) | |
d2a0ee8b | 703 | (save-excursion |
e32eb3e6 GM |
704 | (while (and (< (point) rend) |
705 | (re-search-forward regexp rend t)) | |
d2a0ee8b | 706 | (delete-region (save-excursion (goto-char (match-beginning 0)) |
bace7209 | 707 | (forward-line 0) |
d2a0ee8b | 708 | (point)) |
bace7209 LT |
709 | (progn (forward-line 1) (point)))))) |
710 | (set-marker rend nil) | |
711 | nil) | |
698e1804 | 712 | |
e32eb3e6 | 713 | |
bace7209 LT |
714 | (defun how-many (regexp &optional rstart rend interactive) |
715 | "Print and return number of matches for REGEXP following point. | |
716 | When called from Lisp and INTERACTIVE is omitted or nil, just return | |
717 | the number, do not print it; if INTERACTIVE is t, the function behaves | |
3f2372cb | 718 | in all respects as if it had been called interactively. |
d2a0ee8b | 719 | |
3be42fcd JL |
720 | If REGEXP contains upper case characters (excluding those preceded by `\\') |
721 | and `search-upper-case' is non-nil, the matching is case-sensitive. | |
e32eb3e6 GM |
722 | |
723 | Second and third arg RSTART and REND specify the region to operate on. | |
724 | ||
2ced751f RS |
725 | Interactively, in Transient Mark mode when the mark is active, operate |
726 | on the contents of the region. Otherwise, operate from point to the | |
bace7209 LT |
727 | end of (the accessible portion of) the buffer. |
728 | ||
729 | This function starts looking for the next match from the end of | |
730 | the previous match. Hence, it ignores matches that overlap | |
731 | a previously found match." | |
2ced751f | 732 | |
e32eb3e6 | 733 | (interactive |
96f606c5 | 734 | (keep-lines-read-args "How many matches for regexp")) |
f601efb0 SM |
735 | (save-excursion |
736 | (if rstart | |
bace7209 LT |
737 | (progn |
738 | (goto-char (min rstart rend)) | |
739 | (setq rend (max rstart rend))) | |
740 | (if (and interactive transient-mark-mode mark-active) | |
2ced751f | 741 | (setq rstart (region-beginning) |
bace7209 | 742 | rend (region-end)) |
2ced751f | 743 | (setq rstart (point) |
bace7209 | 744 | rend (point-max))) |
2ced751f | 745 | (goto-char rstart)) |
f601efb0 SM |
746 | (let ((count 0) |
747 | opoint | |
3be42fcd JL |
748 | (case-fold-search |
749 | (if (and case-fold-search search-upper-case) | |
750 | (isearch-no-upper-case-p regexp t) | |
751 | case-fold-search))) | |
f601efb0 SM |
752 | (while (and (< (point) rend) |
753 | (progn (setq opoint (point)) | |
754 | (re-search-forward regexp rend t))) | |
755 | (if (= opoint (point)) | |
756 | (forward-char 1) | |
757 | (setq count (1+ count)))) | |
bace7209 LT |
758 | (when interactive (message "%d occurrence%s" |
759 | count | |
760 | (if (= count 1) "" "s"))) | |
761 | count))) | |
e32eb3e6 | 762 | |
4c53bd2b | 763 | \f |
60e56523 | 764 | (defvar occur-menu-map |
b016851c | 765 | (let ((map (make-sparse-keymap))) |
1ec4b7b2 SM |
766 | (bindings--define-key map [next-error-follow-minor-mode] |
767 | '(menu-item "Auto Occurrence Display" | |
12544bbe | 768 | next-error-follow-minor-mode |
1ec4b7b2 | 769 | :help "Display another occurrence when moving the cursor" |
12544bbe GM |
770 | :button (:toggle . (and (boundp 'next-error-follow-minor-mode) |
771 | next-error-follow-minor-mode)))) | |
1ec4b7b2 SM |
772 | (bindings--define-key map [separator-1] menu-bar-separator) |
773 | (bindings--define-key map [kill-this-buffer] | |
774 | '(menu-item "Kill Occur Buffer" kill-this-buffer | |
775 | :help "Kill the current *Occur* buffer")) | |
776 | (bindings--define-key map [quit-window] | |
777 | '(menu-item "Quit Occur Window" quit-window | |
778 | :help "Quit the current *Occur* buffer. Bury it, and maybe delete the selected frame")) | |
779 | (bindings--define-key map [revert-buffer] | |
780 | '(menu-item "Revert Occur Buffer" revert-buffer | |
781 | :help "Replace the text in the *Occur* buffer with the results of rerunning occur")) | |
782 | (bindings--define-key map [clone-buffer] | |
783 | '(menu-item "Clone Occur Buffer" clone-buffer | |
784 | :help "Create and return a twin copy of the current *Occur* buffer")) | |
785 | (bindings--define-key map [occur-rename-buffer] | |
786 | '(menu-item "Rename Occur Buffer" occur-rename-buffer | |
787 | :help "Rename the current *Occur* buffer to *Occur: original-buffer-name*.")) | |
788 | (bindings--define-key map [occur-edit-buffer] | |
789 | '(menu-item "Edit Occur Buffer" occur-edit-mode | |
790 | :help "Edit the *Occur* buffer and apply changes to the original buffers.")) | |
791 | (bindings--define-key map [separator-2] menu-bar-separator) | |
792 | (bindings--define-key map [occur-mode-goto-occurrence-other-window] | |
793 | '(menu-item "Go To Occurrence Other Window" occur-mode-goto-occurrence-other-window | |
794 | :help "Go to the occurrence the current line describes, in another window")) | |
795 | (bindings--define-key map [occur-mode-goto-occurrence] | |
796 | '(menu-item "Go To Occurrence" occur-mode-goto-occurrence | |
797 | :help "Go to the occurrence the current line describes")) | |
798 | (bindings--define-key map [occur-mode-display-occurrence] | |
799 | '(menu-item "Display Occurrence" occur-mode-display-occurrence | |
800 | :help "Display in another window the occurrence the current line describes")) | |
801 | (bindings--define-key map [occur-next] | |
802 | '(menu-item "Move to Next Match" occur-next | |
803 | :help "Move to the Nth (default 1) next match in an Occur mode buffer")) | |
804 | (bindings--define-key map [occur-prev] | |
805 | '(menu-item "Move to Previous Match" occur-prev | |
806 | :help "Move to the Nth (default 1) previous match in an Occur mode buffer")) | |
b016851c | 807 | map) |
60e56523 LL |
808 | "Menu keymap for `occur-mode'.") |
809 | ||
810 | (defvar occur-mode-map | |
811 | (let ((map (make-sparse-keymap))) | |
812 | ;; We use this alternative name, so we can use \\[occur-mode-mouse-goto]. | |
813 | (define-key map [mouse-2] 'occur-mode-mouse-goto) | |
814 | (define-key map "\C-c\C-c" 'occur-mode-goto-occurrence) | |
8c0f49f0 | 815 | (define-key map "e" 'occur-edit-mode) |
60e56523 LL |
816 | (define-key map "\C-m" 'occur-mode-goto-occurrence) |
817 | (define-key map "o" 'occur-mode-goto-occurrence-other-window) | |
818 | (define-key map "\C-o" 'occur-mode-display-occurrence) | |
819 | (define-key map "\M-n" 'occur-next) | |
820 | (define-key map "\M-p" 'occur-prev) | |
821 | (define-key map "r" 'occur-rename-buffer) | |
822 | (define-key map "c" 'clone-buffer) | |
823 | (define-key map "\C-c\C-f" 'next-error-follow-minor-mode) | |
1ec4b7b2 | 824 | (bindings--define-key map [menu-bar occur] (cons "Occur" occur-menu-map)) |
60e56523 | 825 | map) |
b016851c | 826 | "Keymap for `occur-mode'.") |
698e1804 | 827 | |
46b3d18e RS |
828 | (defvar occur-revert-arguments nil |
829 | "Arguments to pass to `occur-1' to revert an Occur mode buffer. | |
830 | See `occur-revert-function'.") | |
08d355e3 LL |
831 | (make-variable-buffer-local 'occur-revert-arguments) |
832 | (put 'occur-revert-arguments 'permanent-local t) | |
698e1804 | 833 | |
c9ae8cbb JB |
834 | (defcustom occur-mode-hook '(turn-on-font-lock) |
835 | "Hook run when entering Occur mode." | |
836 | :type 'hook | |
837 | :group 'matching) | |
838 | ||
839 | (defcustom occur-hook nil | |
c7d2f2cc | 840 | "Hook run by Occur when there are any matches." |
daae70bf CW |
841 | :type 'hook |
842 | :group 'matching) | |
843 | ||
8e62d5e8 CD |
844 | (defcustom occur-mode-find-occurrence-hook nil |
845 | "Hook run by Occur after locating an occurrence. | |
846 | This will be called with the cursor position at the occurrence. An application | |
847 | for this is to reveal context in an outline-mode when the occurrence is hidden." | |
848 | :type 'hook | |
849 | :group 'matching) | |
850 | ||
de3c9b09 | 851 | (put 'occur-mode 'mode-class 'special) |
abef340a | 852 | (define-derived-mode occur-mode special-mode "Occur" |
698e1804 | 853 | "Major mode for output from \\[occur]. |
0081c8a1 RS |
854 | \\<occur-mode-map>Move point to one of the items in this buffer, then use |
855 | \\[occur-mode-goto-occurrence] to go to the occurrence that the item refers to. | |
856 | Alternatively, click \\[occur-mode-mouse-goto] on an item to go to it. | |
857 | ||
698e1804 | 858 | \\{occur-mode-map}" |
f601efb0 | 859 | (set (make-local-variable 'revert-buffer-function) 'occur-revert-function) |
abef340a SS |
860 | (setq next-error-function 'occur-next-error)) |
861 | ||
60e56523 LL |
862 | \f |
863 | ;;; Occur Edit mode | |
864 | ||
865 | (defvar occur-edit-mode-map | |
866 | (let ((map (make-sparse-keymap))) | |
867 | (set-keymap-parent map text-mode-map) | |
868 | (define-key map [mouse-2] 'occur-mode-mouse-goto) | |
8c0f49f0 CY |
869 | (define-key map "\C-c\C-c" 'occur-cease-edit) |
870 | (define-key map "\C-o" 'occur-mode-display-occurrence) | |
60e56523 | 871 | (define-key map "\C-c\C-f" 'next-error-follow-minor-mode) |
1ec4b7b2 | 872 | (bindings--define-key map [menu-bar occur] (cons "Occur" occur-menu-map)) |
60e56523 LL |
873 | map) |
874 | "Keymap for `occur-edit-mode'.") | |
875 | ||
876 | (define-derived-mode occur-edit-mode occur-mode "Occur-Edit" | |
877 | "Major mode for editing *Occur* buffers. | |
878 | In this mode, changes to the *Occur* buffer are also applied to | |
879 | the originating buffer. | |
880 | ||
08d355e3 | 881 | To return to ordinary Occur mode, use \\[occur-cease-edit]." |
60e56523 | 882 | (setq buffer-read-only nil) |
8c0f49f0 CY |
883 | (add-hook 'after-change-functions 'occur-after-change-function nil t) |
884 | (message (substitute-command-keys | |
885 | "Editing: Type \\[occur-cease-edit] to return to Occur mode."))) | |
886 | ||
887 | (defun occur-cease-edit () | |
888 | "Switch from Occur Edit mode to Occur mode." | |
889 | (interactive) | |
890 | (when (derived-mode-p 'occur-edit-mode) | |
891 | (occur-mode) | |
892 | (message "Switching to Occur mode."))) | |
60e56523 LL |
893 | |
894 | (defun occur-after-change-function (beg end length) | |
895 | (save-excursion | |
896 | (goto-char beg) | |
8c0f49f0 CY |
897 | (let* ((line-beg (line-beginning-position)) |
898 | (m (get-text-property line-beg 'occur-target)) | |
60e56523 | 899 | (buf (marker-buffer m)) |
8c0f49f0 CY |
900 | col) |
901 | (when (and (get-text-property line-beg 'occur-prefix) | |
902 | (not (get-text-property end 'occur-prefix))) | |
903 | (when (= length 0) | |
904 | ;; Apply occur-target property to inserted (e.g. yanked) text. | |
905 | (put-text-property beg end 'occur-target m) | |
906 | ;; Did we insert a newline? Occur Edit mode can't create new | |
907 | ;; Occur entries; just discard everything after the newline. | |
908 | (save-excursion | |
909 | (and (search-forward "\n" end t) | |
910 | (delete-region (1- (point)) end)))) | |
911 | (let* ((line (- (line-number-at-pos) | |
912 | (line-number-at-pos (window-start)))) | |
913 | (readonly (with-current-buffer buf buffer-read-only)) | |
914 | (win (or (get-buffer-window buf) | |
915 | (display-buffer buf t))) | |
916 | (line-end (line-end-position)) | |
917 | (text (save-excursion | |
918 | (goto-char (next-single-property-change | |
919 | line-beg 'occur-prefix nil | |
920 | line-end)) | |
921 | (setq col (- (point) line-beg)) | |
922 | (buffer-substring-no-properties (point) line-end)))) | |
923 | (with-selected-window win | |
924 | (goto-char m) | |
925 | (recenter line) | |
926 | (if readonly | |
927 | (message "Buffer `%s' is read only." buf) | |
928 | (delete-region (line-beginning-position) (line-end-position)) | |
929 | (insert text)) | |
930 | (move-to-column col))))))) | |
60e56523 LL |
931 | |
932 | \f | |
06b60517 | 933 | (defun occur-revert-function (_ignore1 _ignore2) |
46b3d18e | 934 | "Handle `revert-buffer' for Occur mode buffers." |
e1690783 | 935 | (apply 'occur-1 (append occur-revert-arguments (list (buffer-name))))) |
a41284da | 936 | |
78bead73 | 937 | (defun occur-mode-find-occurrence () |
46b3d18e RS |
938 | (let ((pos (get-text-property (point) 'occur-target))) |
939 | (unless pos | |
68608d9c | 940 | (error "No occurrence on this line")) |
46b3d18e RS |
941 | (unless (buffer-live-p (marker-buffer pos)) |
942 | (error "Buffer for this occurrence was killed")) | |
943 | pos)) | |
78bead73 | 944 | |
cedbd3f0 SM |
945 | (defalias 'occur-mode-mouse-goto 'occur-mode-goto-occurrence) |
946 | (defun occur-mode-goto-occurrence (&optional event) | |
3199b96f | 947 | "Go to the occurrence on the current line." |
cedbd3f0 SM |
948 | (interactive (list last-nonmenu-event)) |
949 | (let ((pos | |
950 | (if (null event) | |
951 | ;; Actually `event-end' works correctly with a nil argument as | |
952 | ;; well, so we could dispense with this test, but let's not | |
953 | ;; rely on this undocumented behavior. | |
954 | (occur-mode-find-occurrence) | |
955 | (with-current-buffer (window-buffer (posn-window (event-end event))) | |
956 | (save-excursion | |
957 | (goto-char (posn-point (event-end event))) | |
3199b96f | 958 | (occur-mode-find-occurrence)))))) |
17bb0a2d | 959 | (pop-to-buffer (marker-buffer pos)) |
8e62d5e8 CD |
960 | (goto-char pos) |
961 | (run-hooks 'occur-mode-find-occurrence-hook))) | |
8d15583f | 962 | |
029024e2 RS |
963 | (defun occur-mode-goto-occurrence-other-window () |
964 | "Go to the occurrence the current line describes, in another window." | |
965 | (interactive) | |
46b3d18e RS |
966 | (let ((pos (occur-mode-find-occurrence))) |
967 | (switch-to-buffer-other-window (marker-buffer pos)) | |
8e62d5e8 CD |
968 | (goto-char pos) |
969 | (run-hooks 'occur-mode-find-occurrence-hook))) | |
029024e2 | 970 | |
365486d6 RS |
971 | (defun occur-mode-display-occurrence () |
972 | "Display in another window the occurrence the current line describes." | |
973 | (interactive) | |
46b3d18e | 974 | (let ((pos (occur-mode-find-occurrence)) |
3199b96f CY |
975 | window) |
976 | (setq window (display-buffer (marker-buffer pos) t)) | |
365486d6 RS |
977 | ;; This is the way to set point in the proper window. |
978 | (save-selected-window | |
979 | (select-window window) | |
8e62d5e8 CD |
980 | (goto-char pos) |
981 | (run-hooks 'occur-mode-find-occurrence-hook)))) | |
365486d6 | 982 | |
123d5548 | 983 | (defun occur-find-match (n search message) |
8d15583f RS |
984 | (if (not n) (setq n 1)) |
985 | (let ((r)) | |
986 | (while (> n 0) | |
123d5548 JB |
987 | (setq r (funcall search (point) 'occur-match)) |
988 | (and r | |
989 | (get-text-property r 'occur-match) | |
990 | (setq r (funcall search r 'occur-match))) | |
8d15583f | 991 | (if r |
123d5548 JB |
992 | (goto-char r) |
993 | (error message)) | |
8d15583f RS |
994 | (setq n (1- n))))) |
995 | ||
123d5548 JB |
996 | (defun occur-next (&optional n) |
997 | "Move to the Nth (default 1) next match in an Occur mode buffer." | |
998 | (interactive "p") | |
999 | (occur-find-match n #'next-single-property-change "No more matches")) | |
1000 | ||
8d15583f | 1001 | (defun occur-prev (&optional n) |
46b3d18e | 1002 | "Move to the Nth (default 1) previous match in an Occur mode buffer." |
8d15583f | 1003 | (interactive "p") |
123d5548 | 1004 | (occur-find-match n #'previous-single-property-change "No earlier matches")) |
423e4de7 KS |
1005 | |
1006 | (defun occur-next-error (&optional argp reset) | |
1007 | "Move to the Nth (default 1) next match in an Occur mode buffer. | |
1008 | Compatibility function for \\[next-error] invocations." | |
1009 | (interactive "p") | |
5f9e0ca5 | 1010 | ;; we need to run occur-find-match from within the Occur buffer |
f1f007dc | 1011 | (with-current-buffer |
f42a241b | 1012 | ;; Choose the buffer and make it current. |
5f9e0ca5 TZ |
1013 | (if (next-error-buffer-p (current-buffer)) |
1014 | (current-buffer) | |
f42a241b RS |
1015 | (next-error-find-buffer nil nil |
1016 | (lambda () | |
1017 | (eq major-mode 'occur-mode)))) | |
f1f007dc JL |
1018 | |
1019 | (goto-char (cond (reset (point-min)) | |
1020 | ((< argp 0) (line-beginning-position)) | |
6c6605b2 JL |
1021 | ((> argp 0) (line-end-position)) |
1022 | ((point)))) | |
5f9e0ca5 | 1023 | (occur-find-match |
f1f007dc JL |
1024 | (abs argp) |
1025 | (if (> 0 argp) | |
5f9e0ca5 TZ |
1026 | #'previous-single-property-change |
1027 | #'next-single-property-change) | |
1028 | "No more matches") | |
1029 | ;; In case the *Occur* buffer is visible in a nonselected window. | |
084c41ca SM |
1030 | (let ((win (get-buffer-window (current-buffer) t))) |
1031 | (if win (set-window-point win (point)))) | |
5f9e0ca5 | 1032 | (occur-mode-goto-occurrence))) |
4c53bd2b | 1033 | \f |
aaaecfcd JL |
1034 | (defface match |
1035 | '((((class color) (min-colors 88) (background light)) | |
5183d4c9 | 1036 | :background "yellow1") |
aaaecfcd | 1037 | (((class color) (min-colors 88) (background dark)) |
4bc30b74 | 1038 | :background "RoyalBlue3") |
330167fc RS |
1039 | (((class color) (min-colors 8) (background light)) |
1040 | :background "yellow" :foreground "black") | |
1041 | (((class color) (min-colors 8) (background dark)) | |
aaaecfcd JL |
1042 | :background "blue" :foreground "white") |
1043 | (((type tty) (class mono)) | |
1044 | :inverse-video t) | |
1045 | (t :background "gray")) | |
1046 | "Face used to highlight matches permanently." | |
1047 | :group 'matching | |
bf247b6e | 1048 | :version "22.1") |
aaaecfcd | 1049 | |
9d325ebf | 1050 | (defcustom list-matching-lines-default-context-lines 0 |
9201cc28 | 1051 | "Default number of context lines included around `list-matching-lines' matches. |
e730be7f | 1052 | A negative number means to include that many lines before the match. |
9d325ebf RS |
1053 | A positive number means to include that many lines both before and after." |
1054 | :type 'integer | |
1055 | :group 'matching) | |
698e1804 | 1056 | |
31e1d920 | 1057 | (defalias 'list-matching-lines 'occur) |
698e1804 | 1058 | |
aaaecfcd | 1059 | (defcustom list-matching-lines-face 'match |
9201cc28 | 1060 | "Face used by \\[list-matching-lines] to show the text that matches. |
68608d9c CW |
1061 | If the value is nil, don't highlight the matching portions specially." |
1062 | :type 'face | |
1063 | :group 'matching) | |
1064 | ||
1065 | (defcustom list-matching-lines-buffer-name-face 'underline | |
9201cc28 | 1066 | "Face used by \\[list-matching-lines] to show the names of buffers. |
68608d9c CW |
1067 | If the value is nil, don't highlight the buffer names specially." |
1068 | :type 'face | |
1069 | :group 'matching) | |
1070 | ||
8b363e6f JL |
1071 | (defcustom occur-excluded-properties |
1072 | '(read-only invisible intangible field mouse-face help-echo local-map keymap | |
1073 | yank-handler follow-link) | |
9201cc28 | 1074 | "Text properties to discard when copying lines to the *Occur* buffer. |
8b363e6f JL |
1075 | The value should be a list of text properties to discard or t, |
1076 | which means to discard all text properties." | |
1077 | :type '(choice (const :tag "All" t) (repeat symbol)) | |
1078 | :group 'matching | |
1079 | :version "22.1") | |
1080 | ||
68608d9c | 1081 | (defun occur-read-primary-args () |
15af15e5 TO |
1082 | (let* ((perform-collect (consp current-prefix-arg)) |
1083 | (regexp (read-regexp (if perform-collect | |
1084 | "Collect strings matching regexp" | |
1085 | "List lines matching regexp") | |
1086 | (car regexp-history)))) | |
1087 | (list regexp | |
1088 | (if perform-collect | |
1089 | ;; Perform collect operation | |
1090 | (if (zerop (regexp-opt-depth regexp)) | |
1091 | ;; No subexpression so collect the entire match. | |
1092 | "\\&" | |
1093 | ;; Get the regexp for collection pattern. | |
1094 | (let ((default (car occur-collect-regexp-history))) | |
1095 | (read-string | |
1096 | (format "Regexp to collect (default %s): " default) | |
1097 | nil 'occur-collect-regexp-history default))) | |
1098 | ;; Otherwise normal occur takes numerical prefix argument. | |
1099 | (when current-prefix-arg | |
1100 | (prefix-numeric-value current-prefix-arg)))))) | |
c9daced0 | 1101 | |
a653724b | 1102 | (defun occur-rename-buffer (&optional unique-p interactive-p) |
d99118b0 | 1103 | "Rename the current *Occur* buffer to *Occur: original-buffer-name*. |
47c88c06 | 1104 | Here `original-buffer-name' is the buffer name where Occur was originally run. |
a653724b JB |
1105 | When given the prefix argument, or called non-interactively, the renaming |
1106 | will not clobber the existing buffer(s) of that name, but use | |
1107 | `generate-new-buffer-name' instead. You can add this to `occur-hook' | |
1108 | if you always want a separate *Occur* buffer for each buffer where you | |
1109 | invoke `occur'." | |
1110 | (interactive "P\np") | |
d99118b0 SS |
1111 | (with-current-buffer |
1112 | (if (eq major-mode 'occur-mode) (current-buffer) (get-buffer "*Occur*")) | |
1113 | (rename-buffer (concat "*Occur: " | |
1114 | (mapconcat #'buffer-name | |
1115 | (car (cddr occur-revert-arguments)) "/") | |
1116 | "*") | |
a653724b | 1117 | (or unique-p (not interactive-p))))) |
d99118b0 | 1118 | |
698e1804 | 1119 | (defun occur (regexp &optional nlines) |
99976f85 | 1120 | "Show all lines in the current buffer containing a match for REGEXP. |
774642e5 | 1121 | If a match spreads across multiple lines, all those lines are shown. |
698e1804 | 1122 | |
da44e784 RM |
1123 | Each line is displayed with NLINES lines before and after, or -NLINES |
1124 | before if NLINES is negative. | |
1125 | NLINES defaults to `list-matching-lines-default-context-lines'. | |
698e1804 RS |
1126 | Interactively it is the prefix arg. |
1127 | ||
4c53bd2b | 1128 | The lines are shown in a buffer named `*Occur*'. |
698e1804 | 1129 | It serves as a menu to find any of the occurrences in this buffer. |
de3c9b09 | 1130 | \\<occur-mode-map>\\[describe-mode] in that buffer will explain how. |
9483d601 | 1131 | |
3be42fcd | 1132 | If REGEXP contains upper case characters (excluding those preceded by `\\') |
15af15e5 TO |
1133 | and `search-upper-case' is non-nil, the matching is case-sensitive. |
1134 | ||
1135 | When NLINES is a string or when the function is called | |
1136 | interactively with prefix argument without a number (`C-u' alone | |
1137 | as prefix) the matching strings are collected into the `*Occur*' | |
1138 | buffer by using NLINES as a replacement regexp. NLINES may | |
1139 | contain \\& and \\N which convention follows `replace-match'. | |
1140 | For example, providing \"defun\\s +\\(\\S +\\)\" for REGEXP and | |
1141 | \"\\1\" for NLINES collects all the function names in a lisp | |
1142 | program. When there is no parenthesized subexpressions in REGEXP | |
1143 | the entire match is collected. In any case the searched buffers | |
1144 | are not modified." | |
68608d9c CW |
1145 | (interactive (occur-read-primary-args)) |
1146 | (occur-1 regexp nlines (list (current-buffer)))) | |
1147 | ||
06b60517 JB |
1148 | (defvar ido-ignore-item-temp-list) |
1149 | ||
68608d9c CW |
1150 | (defun multi-occur (bufs regexp &optional nlines) |
1151 | "Show all lines in buffers BUFS containing a match for REGEXP. | |
1152 | This function acts on multiple buffers; otherwise, it is exactly like | |
191b577e | 1153 | `occur'. When you invoke this command interactively, you must specify |
5cf56143 LMI |
1154 | the buffer names that you want, one by one. |
1155 | See also `multi-occur-in-matching-buffers'." | |
a5dfed3e | 1156 | (interactive |
68608d9c | 1157 | (cons |
52698d45 KS |
1158 | (let* ((bufs (list (read-buffer "First buffer to search: " |
1159 | (current-buffer) t))) | |
1160 | (buf nil) | |
1161 | (ido-ignore-item-temp-list bufs)) | |
68608d9c | 1162 | (while (not (string-equal |
f1180544 | 1163 | (setq buf (read-buffer |
52698d45 KS |
1164 | (if (eq read-buffer-function 'ido-read-buffer) |
1165 | "Next buffer to search (C-j to end): " | |
1166 | "Next buffer to search (RET to end): ") | |
1167 | nil t)) | |
68608d9c | 1168 | "")) |
52698d45 KS |
1169 | (add-to-list 'bufs buf) |
1170 | (setq ido-ignore-item-temp-list bufs)) | |
68608d9c CW |
1171 | (nreverse (mapcar #'get-buffer bufs))) |
1172 | (occur-read-primary-args))) | |
1173 | (occur-1 regexp nlines bufs)) | |
1174 | ||
191b577e RS |
1175 | (defun multi-occur-in-matching-buffers (bufregexp regexp &optional allbufs) |
1176 | "Show all lines matching REGEXP in buffers specified by BUFREGEXP. | |
1177 | Normally BUFREGEXP matches against each buffer's visited file name, | |
1178 | but if you specify a prefix argument, it matches against the buffer name. | |
68608d9c CW |
1179 | See also `multi-occur'." |
1180 | (interactive | |
1181 | (cons | |
1182 | (let* ((default (car regexp-history)) | |
1183 | (input | |
1184 | (read-from-minibuffer | |
689f4394 | 1185 | (if current-prefix-arg |
191b577e RS |
1186 | "List lines in buffers whose names match regexp: " |
1187 | "List lines in buffers whose filenames match regexp: ") | |
68608d9c CW |
1188 | nil |
1189 | nil | |
1190 | nil | |
1191 | 'regexp-history))) | |
1192 | (if (equal input "") | |
1193 | default | |
1194 | input)) | |
1195 | (occur-read-primary-args))) | |
1196 | (when bufregexp | |
689f4394 | 1197 | (occur-1 regexp nil |
68608d9c CW |
1198 | (delq nil |
1199 | (mapcar (lambda (buf) | |
191b577e RS |
1200 | (when (if allbufs |
1201 | (string-match bufregexp | |
1202 | (buffer-name buf)) | |
1203 | (and (buffer-file-name buf) | |
1204 | (string-match bufregexp | |
1205 | (buffer-file-name buf)))) | |
68608d9c CW |
1206 | buf)) |
1207 | (buffer-list)))))) | |
1208 | ||
e1690783 | 1209 | (defun occur-1 (regexp nlines bufs &optional buf-name) |
360289a6 JL |
1210 | (unless (and regexp (not (equal regexp ""))) |
1211 | (error "Occur doesn't work with the empty regexp")) | |
e1690783 CW |
1212 | (unless buf-name |
1213 | (setq buf-name "*Occur*")) | |
f42a241b | 1214 | (let (occur-buf |
70ed2a76 CW |
1215 | (active-bufs (delq nil (mapcar #'(lambda (buf) |
1216 | (when (buffer-live-p buf) buf)) | |
1217 | bufs)))) | |
1218 | ;; Handle the case where one of the buffers we're searching is the | |
f42a241b RS |
1219 | ;; output buffer. Just rename it. |
1220 | (when (member buf-name (mapcar 'buffer-name active-bufs)) | |
1221 | (with-current-buffer (get-buffer buf-name) | |
1222 | (rename-uniquely))) | |
1223 | ||
1224 | ;; Now find or create the output buffer. | |
1225 | ;; If we just renamed that buffer, we will make a new one here. | |
1226 | (setq occur-buf (get-buffer-create buf-name)) | |
1227 | ||
68608d9c | 1228 | (with-current-buffer occur-buf |
15af15e5 | 1229 | (if (stringp nlines) |
e1dbe924 | 1230 | (fundamental-mode) ;; This is for collect operation. |
15af15e5 | 1231 | (occur-mode)) |
8121414a CY |
1232 | (let ((inhibit-read-only t) |
1233 | ;; Don't generate undo entries for creation of the initial contents. | |
1234 | (buffer-undo-list t)) | |
06df7f87 | 1235 | (erase-buffer) |
15af15e5 TO |
1236 | (let ((count |
1237 | (if (stringp nlines) | |
1238 | ;; Treat nlines as a regexp to collect. | |
1239 | (let ((bufs active-bufs) | |
1240 | (count 0)) | |
1241 | (while bufs | |
1242 | (with-current-buffer (car bufs) | |
1243 | (save-excursion | |
1244 | (goto-char (point-min)) | |
1245 | (while (re-search-forward regexp nil t) | |
1246 | ;; Insert the replacement regexp. | |
1247 | (let ((str (match-substitute-replacement nlines))) | |
1248 | (if str | |
1249 | (with-current-buffer occur-buf | |
1250 | (insert str) | |
1251 | (setq count (1+ count)) | |
1252 | (or (zerop (current-column)) | |
1253 | (insert "\n")))))))) | |
1254 | (setq bufs (cdr bufs))) | |
1255 | count) | |
1256 | ;; Perform normal occur. | |
1257 | (occur-engine | |
1258 | regexp active-bufs occur-buf | |
1259 | (or nlines list-matching-lines-default-context-lines) | |
1260 | (if (and case-fold-search search-upper-case) | |
1261 | (isearch-no-upper-case-p regexp t) | |
1262 | case-fold-search) | |
1263 | list-matching-lines-buffer-name-face | |
1264 | nil list-matching-lines-face | |
1265 | (not (eq occur-excluded-properties t)))))) | |
06df7f87 EZ |
1266 | (let* ((bufcount (length active-bufs)) |
1267 | (diff (- (length bufs) bufcount))) | |
d66ecdbb | 1268 | (message "Searched %d buffer%s%s; %s match%s%s" |
06df7f87 EZ |
1269 | bufcount (if (= bufcount 1) "" "s") |
1270 | (if (zerop diff) "" (format " (%d killed)" diff)) | |
1271 | (if (zerop count) "no" (format "%d" count)) | |
1272 | (if (= count 1) "" "es") | |
d66ecdbb JL |
1273 | ;; Don't display regexp if with remaining text |
1274 | ;; it is longer than window-width. | |
1275 | (if (> (+ (length regexp) 42) (window-width)) | |
1276 | "" (format " for `%s'" (query-replace-descr regexp))))) | |
06df7f87 | 1277 | (setq occur-revert-arguments (list regexp nlines bufs)) |
c7d2f2cc JB |
1278 | (if (= count 0) |
1279 | (kill-buffer occur-buf) | |
1280 | (display-buffer occur-buf) | |
1281 | (setq next-error-last-buffer occur-buf) | |
1282 | (setq buffer-read-only t) | |
1283 | (set-buffer-modified-p nil) | |
1284 | (run-hooks 'occur-hook))))))) | |
68608d9c | 1285 | |
06b60517 | 1286 | (defun occur-engine (regexp buffers out-buf nlines case-fold |
46b3d18e RS |
1287 | title-face prefix-face match-face keep-props) |
1288 | (with-current-buffer out-buf | |
5cb4031d | 1289 | (let ((globalcount 0) |
06b60517 JB |
1290 | (coding nil) |
1291 | (case-fold-search case-fold)) | |
46b3d18e RS |
1292 | ;; Map over all the buffers |
1293 | (dolist (buf buffers) | |
1294 | (when (buffer-live-p buf) | |
1295 | (let ((matches 0) ;; count of matched lines | |
1296 | (lines 1) ;; line count | |
dc2d2590 JL |
1297 | (prev-after-lines nil) ;; context lines of prev match |
1298 | (prev-lines nil) ;; line number of prev match endpt | |
46b3d18e | 1299 | (matchbeg 0) |
46b3d18e RS |
1300 | (origpt nil) |
1301 | (begpt nil) | |
1302 | (endpt nil) | |
1303 | (marker nil) | |
1304 | (curstring "") | |
dc2d2590 | 1305 | (ret nil) |
bc16bf5e | 1306 | (inhibit-field-text-motion t) |
46b3d18e | 1307 | (headerpt (with-current-buffer out-buf (point)))) |
cedbd3f0 | 1308 | (with-current-buffer buf |
5cb4031d KH |
1309 | (or coding |
1310 | ;; Set CODING only if the current buffer locally | |
1311 | ;; binds buffer-file-coding-system. | |
1312 | (not (local-variable-p 'buffer-file-coding-system)) | |
1313 | (setq coding buffer-file-coding-system)) | |
68608d9c | 1314 | (save-excursion |
46b3d18e RS |
1315 | (goto-char (point-min)) ;; begin searching in the buffer |
1316 | (while (not (eobp)) | |
1317 | (setq origpt (point)) | |
1318 | (when (setq endpt (re-search-forward regexp nil t)) | |
1319 | (setq matches (1+ matches)) ;; increment match count | |
5291cbca | 1320 | (setq matchbeg (match-beginning 0)) |
774642e5 | 1321 | ;; Get beginning of first match line and end of the last. |
f1f007dc JL |
1322 | (save-excursion |
1323 | (goto-char matchbeg) | |
774642e5 JL |
1324 | (setq begpt (line-beginning-position)) |
1325 | (goto-char endpt) | |
1326 | (setq endpt (line-end-position))) | |
1327 | ;; Sum line numbers up to the first match line. | |
1328 | (setq lines (+ lines (count-lines origpt begpt))) | |
46b3d18e RS |
1329 | (setq marker (make-marker)) |
1330 | (set-marker marker matchbeg) | |
53e87c57 | 1331 | (setq curstring (occur-engine-line begpt endpt keep-props)) |
8b363e6f | 1332 | ;; Highlight the matches |
46b3d18e RS |
1333 | (let ((len (length curstring)) |
1334 | (start 0)) | |
46b3d18e RS |
1335 | (while (and (< start len) |
1336 | (string-match regexp curstring start)) | |
f1f007dc JL |
1337 | (add-text-properties |
1338 | (match-beginning 0) (match-end 0) | |
1339 | (append | |
1340 | `(occur-match t) | |
1341 | (when match-face | |
1342 | ;; Use `face' rather than `font-lock-face' here | |
1343 | ;; so as to override faces copied from the buffer. | |
1344 | `(face ,match-face))) | |
1345 | curstring) | |
46b3d18e RS |
1346 | (setq start (match-end 0)))) |
1347 | ;; Generate the string to insert for this match | |
774642e5 JL |
1348 | (let* ((match-prefix |
1349 | ;; Using 7 digits aligns tabs properly. | |
1350 | (apply #'propertize (format "%7d:" lines) | |
1351 | (append | |
1352 | (when prefix-face | |
1353 | `(font-lock-face prefix-face)) | |
1354 | `(occur-prefix t mouse-face (highlight) | |
8c0f49f0 CY |
1355 | ;; Allow insertion of text at |
1356 | ;; the end of the prefix (for | |
1357 | ;; Occur Edit mode). | |
1358 | front-sticky t rear-nonsticky t | |
1359 | occur-target ,marker follow-link t | |
1360 | help-echo "mouse-2: go to this occurrence")))) | |
774642e5 JL |
1361 | (match-str |
1362 | ;; We don't put `mouse-face' on the newline, | |
1363 | ;; because that loses. And don't put it | |
1364 | ;; on context lines to reduce flicker. | |
1365 | (propertize curstring 'mouse-face (list 'highlight) | |
1366 | 'occur-target marker | |
1367 | 'follow-link t | |
1368 | 'help-echo | |
1369 | "mouse-2: go to this occurrence")) | |
1370 | (out-line | |
46b3d18e | 1371 | (concat |
774642e5 JL |
1372 | match-prefix |
1373 | ;; Add non-numeric prefix to all non-first lines | |
1374 | ;; of multi-line matches. | |
1375 | (replace-regexp-in-string | |
1376 | "\n" | |
1377 | "\n :" | |
1378 | match-str) | |
61f570e2 RF |
1379 | ;; Add marker at eol, but no mouse props. |
1380 | (propertize "\n" 'occur-target marker))) | |
46b3d18e RS |
1381 | (data |
1382 | (if (= nlines 0) | |
1383 | ;; The simple display style | |
1384 | out-line | |
f8edc67e | 1385 | ;; The complex multi-line display style. |
dc2d2590 JL |
1386 | (setq ret (occur-context-lines |
1387 | out-line nlines keep-props begpt endpt | |
1388 | lines prev-lines prev-after-lines)) | |
1389 | ;; Set first elem of the returned list to `data', | |
1390 | ;; and the second elem to `prev-after-lines'. | |
1391 | (setq prev-after-lines (nth 1 ret)) | |
1392 | (nth 0 ret)))) | |
46b3d18e RS |
1393 | ;; Actually insert the match display data |
1394 | (with-current-buffer out-buf | |
06b60517 | 1395 | (insert data))) |
46b3d18e | 1396 | (goto-char endpt)) |
e1690783 CW |
1397 | (if endpt |
1398 | (progn | |
774642e5 JL |
1399 | ;; Sum line numbers between first and last match lines. |
1400 | (setq lines (+ lines (count-lines begpt endpt) | |
1401 | ;; Add 1 for empty last match line since | |
1402 | ;; count-lines returns 1 line less. | |
1403 | (if (and (bolp) (eolp)) 1 0))) | |
e1690783 CW |
1404 | ;; On to the next match... |
1405 | (forward-line 1)) | |
dc2d2590 JL |
1406 | (goto-char (point-max))) |
1407 | (setq prev-lines (1- lines))) | |
1408 | ;; Flush remaining context after-lines. | |
1409 | (when prev-after-lines | |
1410 | (with-current-buffer out-buf | |
1411 | (insert (apply #'concat (occur-engine-add-prefix | |
1412 | prev-after-lines))))))) | |
46b3d18e | 1413 | (when (not (zerop matches)) ;; is the count zero? |
daae70bf | 1414 | (setq globalcount (+ globalcount matches)) |
46b3d18e RS |
1415 | (with-current-buffer out-buf |
1416 | (goto-char headerpt) | |
1417 | (let ((beg (point)) | |
1418 | end) | |
60e56523 LL |
1419 | (insert (propertize |
1420 | (format "%d match%s%s in buffer: %s\n" | |
1421 | matches (if (= matches 1) "" "es") | |
1422 | ;; Don't display regexp for multi-buffer. | |
1423 | (if (> (length buffers) 1) | |
1424 | "" (format " for \"%s\"" | |
1425 | (query-replace-descr regexp))) | |
1426 | (buffer-name buf)) | |
1427 | 'read-only t)) | |
46b3d18e RS |
1428 | (setq end (point)) |
1429 | (add-text-properties beg end | |
1430 | (append | |
1431 | (when title-face | |
506a6d7e CW |
1432 | `(font-lock-face ,title-face)) |
1433 | `(occur-title ,buf)))) | |
46b3d18e | 1434 | (goto-char (point-min))))))) |
d66ecdbb JL |
1435 | ;; Display total match count and regexp for multi-buffer. |
1436 | (when (and (not (zerop globalcount)) (> (length buffers) 1)) | |
1437 | (goto-char (point-min)) | |
1438 | (let ((beg (point)) | |
1439 | end) | |
1440 | (insert (format "%d match%s total for \"%s\":\n" | |
1441 | globalcount (if (= globalcount 1) "" "es") | |
1442 | (query-replace-descr regexp))) | |
1443 | (setq end (point)) | |
1444 | (add-text-properties beg end (when title-face | |
1445 | `(font-lock-face ,title-face)))) | |
1446 | (goto-char (point-min))) | |
5cb4031d KH |
1447 | (if coding |
1448 | ;; CODING is buffer-file-coding-system of the first buffer | |
1449 | ;; that locally binds it. Let's use it also for the output | |
1450 | ;; buffer. | |
1451 | (set-buffer-file-coding-system coding)) | |
46b3d18e RS |
1452 | ;; Return the number of matches |
1453 | globalcount))) | |
68608d9c | 1454 | |
53e87c57 | 1455 | (defun occur-engine-line (beg end &optional keep-props) |
f14d1172 JL |
1456 | (if (and keep-props (if (boundp 'jit-lock-mode) jit-lock-mode) |
1457 | (text-property-not-all beg end 'fontified t)) | |
1458 | (if (fboundp 'jit-lock-fontify-now) | |
1459 | (jit-lock-fontify-now beg end))) | |
1460 | (if (and keep-props (not (eq occur-excluded-properties t))) | |
1461 | (let ((str (buffer-substring beg end))) | |
1462 | (remove-list-of-text-properties | |
1463 | 0 (length str) occur-excluded-properties str) | |
1464 | str) | |
1465 | (buffer-substring-no-properties beg end))) | |
1466 | ||
0ef84fc8 JL |
1467 | (defun occur-engine-add-prefix (lines) |
1468 | (mapcar | |
1469 | #'(lambda (line) | |
1470 | (concat " :" line "\n")) | |
1471 | lines)) | |
1472 | ||
1473 | (defun occur-accumulate-lines (count &optional keep-props pt) | |
1474 | (save-excursion | |
1475 | (when pt | |
1476 | (goto-char pt)) | |
1477 | (let ((forwardp (> count 0)) | |
1478 | result beg end moved) | |
1479 | (while (not (or (zerop count) | |
1480 | (if forwardp | |
1481 | (eobp) | |
1482 | (and (bobp) (not moved))))) | |
1483 | (setq count (+ count (if forwardp -1 1))) | |
1484 | (setq beg (line-beginning-position) | |
1485 | end (line-end-position)) | |
1486 | (push (occur-engine-line beg end keep-props) result) | |
1487 | (setq moved (= 0 (forward-line (if forwardp 1 -1))))) | |
1488 | (nreverse result)))) | |
1489 | ||
f8edc67e RS |
1490 | ;; Generate context display for occur. |
1491 | ;; OUT-LINE is the line where the match is. | |
1492 | ;; NLINES and KEEP-PROPS are args to occur-engine. | |
dc2d2590 JL |
1493 | ;; LINES is line count of the current match, |
1494 | ;; PREV-LINES is line count of the previous match, | |
1495 | ;; PREV-AFTER-LINES is a list of after-context lines of the previous match. | |
f8edc67e RS |
1496 | ;; Generate a list of lines, add prefixes to all but OUT-LINE, |
1497 | ;; then concatenate them all together. | |
dc2d2590 JL |
1498 | (defun occur-context-lines (out-line nlines keep-props begpt endpt |
1499 | lines prev-lines prev-after-lines) | |
1500 | ;; Find after- and before-context lines of the current match. | |
1501 | (let ((before-lines | |
1502 | (nreverse (cdr (occur-accumulate-lines | |
1503 | (- (1+ (abs nlines))) keep-props begpt)))) | |
1504 | (after-lines | |
1505 | (cdr (occur-accumulate-lines | |
1506 | (1+ nlines) keep-props endpt))) | |
1507 | separator) | |
1508 | ||
1509 | ;; Combine after-lines of the previous match | |
1510 | ;; with before-lines of the current match. | |
1511 | ||
1512 | (when prev-after-lines | |
1513 | ;; Don't overlap prev after-lines with current before-lines. | |
1514 | (if (>= (+ prev-lines (length prev-after-lines)) | |
1515 | (- lines (length before-lines))) | |
1516 | (setq prev-after-lines | |
1517 | (butlast prev-after-lines | |
1518 | (- (length prev-after-lines) | |
1519 | (- lines prev-lines (length before-lines) 1)))) | |
1520 | ;; Separate non-overlapping context lines with a dashed line. | |
1521 | (setq separator "-------\n"))) | |
1522 | ||
1523 | (when prev-lines | |
1524 | ;; Don't overlap current before-lines with previous match line. | |
1525 | (if (<= (- lines (length before-lines)) | |
1526 | prev-lines) | |
1527 | (setq before-lines | |
1528 | (nthcdr (- (length before-lines) | |
1529 | (- lines prev-lines 1)) | |
1530 | before-lines)) | |
1531 | ;; Separate non-overlapping before-context lines. | |
1532 | (unless (> nlines 0) | |
1533 | (setq separator "-------\n")))) | |
1534 | ||
1535 | (list | |
1536 | ;; Return a list where the first element is the output line. | |
1537 | (apply #'concat | |
1538 | (append | |
1539 | (and prev-after-lines | |
1540 | (occur-engine-add-prefix prev-after-lines)) | |
1541 | (and separator (list separator)) | |
1542 | (occur-engine-add-prefix before-lines) | |
1543 | (list out-line))) | |
1544 | ;; And the second element is the list of context after-lines. | |
1545 | (if (> nlines 0) after-lines)))) | |
1546 | ||
698e1804 | 1547 | \f |
81bdc14d RS |
1548 | ;; It would be nice to use \\[...], but there is no reasonable way |
1549 | ;; to make that display both SPC and Y. | |
698e1804 RS |
1550 | (defconst query-replace-help |
1551 | "Type Space or `y' to replace one match, Delete or `n' to skip to next, | |
be44f62c | 1552 | RET or `q' to exit, Period to replace one match and exit, |
698e1804 RS |
1553 | Comma to replace but not move point immediately, |
1554 | C-r to enter recursive edit (\\[exit-recursive-edit] to get out again), | |
1555 | C-w to delete match and recursive edit, | |
1556 | C-l to clear the screen, redisplay, and offer same replacement again, | |
1557 | ! to replace all remaining matches with no more questions, | |
7ce278f3 GM |
1558 | ^ to move point back to previous match, |
1559 | E to edit the replacement string" | |
f54701d1 | 1560 | "Help message while in `query-replace'.") |
698e1804 | 1561 | |
cedbd3f0 SM |
1562 | (defvar query-replace-map |
1563 | (let ((map (make-sparse-keymap))) | |
1564 | (define-key map " " 'act) | |
1565 | (define-key map "\d" 'skip) | |
1566 | (define-key map [delete] 'skip) | |
1567 | (define-key map [backspace] 'skip) | |
1568 | (define-key map "y" 'act) | |
1569 | (define-key map "n" 'skip) | |
1570 | (define-key map "Y" 'act) | |
1571 | (define-key map "N" 'skip) | |
1572 | (define-key map "e" 'edit-replacement) | |
1573 | (define-key map "E" 'edit-replacement) | |
1574 | (define-key map "," 'act-and-show) | |
1575 | (define-key map "q" 'exit) | |
1576 | (define-key map "\r" 'exit) | |
1577 | (define-key map [return] 'exit) | |
1578 | (define-key map "." 'act-and-exit) | |
1579 | (define-key map "\C-r" 'edit) | |
1580 | (define-key map "\C-w" 'delete-and-edit) | |
1581 | (define-key map "\C-l" 'recenter) | |
1582 | (define-key map "!" 'automatic) | |
1583 | (define-key map "^" 'backup) | |
1584 | (define-key map "\C-h" 'help) | |
1585 | (define-key map [f1] 'help) | |
1586 | (define-key map [help] 'help) | |
1587 | (define-key map "?" 'help) | |
1588 | (define-key map "\C-g" 'quit) | |
1589 | (define-key map "\C-]" 'quit) | |
1590 | (define-key map "\e" 'exit-prefix) | |
1591 | (define-key map [escape] 'exit-prefix) | |
1592 | map) | |
81bdc14d RS |
1593 | "Keymap that defines the responses to questions in `query-replace'. |
1594 | The \"bindings\" in this map are not commands; they are answers. | |
1595 | The valid answers include `act', `skip', `act-and-show', | |
fee88ca0 GM |
1596 | `exit', `act-and-exit', `edit', `edit-replacement', `delete-and-edit', |
1597 | `recenter', `automatic', `backup', `exit-prefix', `quit', and `help'.") | |
81bdc14d | 1598 | |
b591f338 JL |
1599 | (defvar multi-query-replace-map |
1600 | (let ((map (make-sparse-keymap))) | |
1601 | (set-keymap-parent map query-replace-map) | |
1602 | (define-key map "Y" 'automatic-all) | |
1603 | (define-key map "N" 'exit-current) | |
1604 | map) | |
1605 | "Keymap that defines additional bindings for multi-buffer replacements. | |
1606 | It extends its parent map `query-replace-map' with new bindings to | |
1607 | operate on a set of buffers/files. The difference with its parent map | |
1608 | is the additional answers `automatic-all' to replace all remaining | |
1609 | matches in all remaining buffers with no more questions, and | |
1610 | `exit-current' to skip remaining matches in the current buffer | |
1611 | and to continue with the next buffer in the sequence.") | |
1612 | ||
84482eb3 | 1613 | (defun replace-match-string-symbols (n) |
e730be7f DL |
1614 | "Process a list (and any sub-lists), expanding certain symbols. |
1615 | Symbol Expands To | |
1616 | N (match-string N) (where N is a string of digits) | |
1617 | #N (string-to-number (match-string N)) | |
1618 | & (match-string 0) | |
1619 | #& (string-to-number (match-string 0)) | |
2f57bf85 | 1620 | # replace-count |
e730be7f | 1621 | |
97610156 | 1622 | Note that these symbols must be preceded by a backslash in order to |
f72f9f1a RS |
1623 | type them using Lisp syntax." |
1624 | (while (consp n) | |
84482eb3 RS |
1625 | (cond |
1626 | ((consp (car n)) | |
1627 | (replace-match-string-symbols (car n))) ;Process sub-list | |
1628 | ((symbolp (car n)) | |
1629 | (let ((name (symbol-name (car n)))) | |
1630 | (cond | |
1631 | ((string-match "^[0-9]+$" name) | |
1632 | (setcar n (list 'match-string (string-to-number name)))) | |
1633 | ((string-match "^#[0-9]+$" name) | |
1634 | (setcar n (list 'string-to-number | |
1635 | (list 'match-string | |
1636 | (string-to-number (substring name 1)))))) | |
1637 | ((string= "&" name) | |
1638 | (setcar n '(match-string 0))) | |
1639 | ((string= "#&" name) | |
2f57bf85 DK |
1640 | (setcar n '(string-to-number (match-string 0)))) |
1641 | ((string= "#" name) | |
1642 | (setcar n 'replace-count)))))) | |
84482eb3 RS |
1643 | (setq n (cdr n)))) |
1644 | ||
06b60517 JB |
1645 | (defun replace-eval-replacement (expression count) |
1646 | (let* ((replace-count count) | |
1647 | (replacement (eval expression))) | |
84482eb3 RS |
1648 | (if (stringp replacement) |
1649 | replacement | |
1650 | (prin1-to-string replacement t)))) | |
1651 | ||
2f57bf85 DK |
1652 | (defun replace-quote (replacement) |
1653 | "Quote a replacement string. | |
1654 | This just doubles all backslashes in REPLACEMENT and | |
1655 | returns the resulting string. If REPLACEMENT is not | |
1656 | a string, it is first passed through `prin1-to-string' | |
1657 | with the `noescape' argument set. | |
1658 | ||
1659 | `match-data' is preserved across the call." | |
1660 | (save-match-data | |
1661 | (replace-regexp-in-string "\\\\" "\\\\" | |
1662 | (if (stringp replacement) | |
1663 | replacement | |
1664 | (prin1-to-string replacement t)) | |
1665 | t t))) | |
1666 | ||
06b60517 | 1667 | (defun replace-loop-through-replacements (data count) |
e4769531 | 1668 | ;; DATA is a vector containing the following values: |
84482eb3 RS |
1669 | ;; 0 next-rotate-count |
1670 | ;; 1 repeat-count | |
1671 | ;; 2 next-replacement | |
1672 | ;; 3 replacements | |
06b60517 | 1673 | (if (= (aref data 0) count) |
84482eb3 | 1674 | (progn |
06b60517 | 1675 | (aset data 0 (+ count (aref data 1))) |
84482eb3 RS |
1676 | (let ((next (cdr (aref data 2)))) |
1677 | (aset data 2 (if (consp next) next (aref data 3)))))) | |
1678 | (car (aref data 2))) | |
1679 | ||
7c1c02ac DK |
1680 | (defun replace-match-data (integers reuse &optional new) |
1681 | "Like `match-data', but markers in REUSE get invalidated. | |
6a964bb1 | 1682 | If NEW is non-nil, it is set and returned instead of fresh data, |
7c1c02ac DK |
1683 | but coerced to the correct value of INTEGERS." |
1684 | (or (and new | |
1685 | (progn | |
1686 | (set-match-data new) | |
1687 | (and (eq new reuse) | |
1688 | (eq (null integers) (markerp (car reuse))) | |
1689 | new))) | |
10ddc30e | 1690 | (match-data integers reuse t))) |
7c1c02ac DK |
1691 | |
1692 | (defun replace-match-maybe-edit (newtext fixedcase literal noedit match-data) | |
1693 | "Make a replacement with `replace-match', editing `\\?'. | |
15fd7d5d | 1694 | NEWTEXT, FIXEDCASE, LITERAL are just passed on. If NOEDIT is true, no |
7c1c02ac DK |
1695 | check for `\\?' is made to save time. MATCH-DATA is used for the |
1696 | replacement. In case editing is done, it is changed to use markers. | |
1697 | ||
6a964bb1 | 1698 | The return value is non-nil if there has been no `\\?' or NOEDIT was |
7c1c02ac DK |
1699 | passed in. If LITERAL is set, no checking is done, anyway." |
1700 | (unless (or literal noedit) | |
1701 | (setq noedit t) | |
1702 | (while (string-match "\\(\\`\\|[^\\]\\)\\(\\\\\\\\\\)*\\(\\\\\\?\\)" | |
1703 | newtext) | |
1704 | (setq newtext | |
3981e5b5 JB |
1705 | (read-string "Edit replacement string: " |
1706 | (prog1 | |
1707 | (cons | |
1708 | (replace-match "" t t newtext 3) | |
1709 | (1+ (match-beginning 3))) | |
1710 | (setq match-data | |
1711 | (replace-match-data | |
1712 | nil match-data match-data)))) | |
7c1c02ac DK |
1713 | noedit nil))) |
1714 | (set-match-data match-data) | |
1715 | (replace-match newtext fixedcase literal) | |
1716 | noedit) | |
1717 | ||
c35a09fc CY |
1718 | (defvar replace-search-function 'search-forward |
1719 | "Function to use when searching for strings to replace. | |
1720 | It is used by `query-replace' and `replace-string', and is called | |
1721 | with three arguments, as if it were `search-forward'.") | |
1722 | ||
1723 | (defvar replace-re-search-function 're-search-forward | |
1724 | "Function to use when searching for regexps to replace. | |
1725 | It is used by `query-replace-regexp', `replace-regexp', | |
96f606c5 JL |
1726 | `query-replace-regexp-eval', and `map-query-replace-regexp'. |
1727 | It is called with three arguments, as if it were | |
1728 | `re-search-forward'.") | |
c35a09fc | 1729 | |
d99118b0 | 1730 | (defun perform-replace (from-string replacements |
698e1804 | 1731 | query-flag regexp-flag delimited-flag |
99a7559f | 1732 | &optional repeat-count map start end) |
698e1804 RS |
1733 | "Subroutine of `query-replace'. Its complexity handles interactive queries. |
1734 | Don't use this in your own program unless you want to query and set the mark | |
1735 | just as `query-replace' does. Instead, write a simple loop like this: | |
698665d1 GM |
1736 | |
1737 | (while (re-search-forward \"foo[ \\t]+bar\" nil t) | |
698e1804 | 1738 | (replace-match \"foobar\" nil nil)) |
698665d1 GM |
1739 | |
1740 | which will run faster and probably do exactly what you want. Please | |
1741 | see the documentation of `replace-match' to find out how to simulate | |
588c915a CW |
1742 | `case-replace'. |
1743 | ||
1744 | This function returns nil if and only if there were no matches to | |
1745 | make, or the user didn't cancel the call." | |
81bdc14d | 1746 | (or map (setq map query-replace-map)) |
1c1dadab RS |
1747 | (and query-flag minibuffer-auto-raise |
1748 | (raise-frame (window-frame (minibuffer-window)))) | |
26cc71af | 1749 | (let* ((case-fold-search |
3be42fcd JL |
1750 | (if (and case-fold-search search-upper-case) |
1751 | (isearch-no-upper-case-p from-string regexp-flag) | |
1752 | case-fold-search)) | |
26cc71af SM |
1753 | (nocasify (not (and case-replace case-fold-search))) |
1754 | (literal (or (not regexp-flag) (eq regexp-flag 'literal))) | |
c35a09fc CY |
1755 | (search-function |
1756 | (if regexp-flag | |
1757 | replace-re-search-function | |
1758 | replace-search-function)) | |
26cc71af SM |
1759 | (search-string from-string) |
1760 | (real-match-data nil) ; The match data for the current match. | |
1761 | (next-replacement nil) | |
1762 | ;; This is non-nil if we know there is nothing for the user | |
1763 | ;; to edit in the replacement. | |
1764 | (noedit nil) | |
1765 | (keep-going t) | |
1766 | (stack nil) | |
1767 | (replace-count 0) | |
1768 | (nonempty-match nil) | |
b591f338 | 1769 | (multi-buffer nil) |
2952b1ae | 1770 | (recenter-last-op nil) ; Start cycling order with initial position. |
26cc71af SM |
1771 | |
1772 | ;; If non-nil, it is marker saying where in the buffer to stop. | |
1773 | (limit nil) | |
1774 | ||
1775 | ;; Data for the next match. If a cons, it has the same format as | |
1776 | ;; (match-data); otherwise it is t if a match is possible at point. | |
1777 | (match-again t) | |
1778 | ||
1779 | (message | |
1780 | (if query-flag | |
1781 | (apply 'propertize | |
1782 | (substitute-command-keys | |
1783 | "Query replacing %s with %s: (\\<query-replace-map>\\[help] for help) ") | |
1784 | minibuffer-prompt-properties)))) | |
7ef5c431 KH |
1785 | |
1786 | ;; If region is active, in Transient Mark mode, operate on region. | |
47d72254 GM |
1787 | (when start |
1788 | (setq limit (copy-marker (max start end))) | |
1789 | (goto-char (min start end)) | |
1790 | (deactivate-mark)) | |
84482eb3 | 1791 | |
b591f338 JL |
1792 | ;; If last typed key in previous call of multi-buffer perform-replace |
1793 | ;; was `automatic-all', don't ask more questions in next files | |
1e4bd40d | 1794 | (when (eq (lookup-key map (vector last-input-event)) 'automatic-all) |
b591f338 JL |
1795 | (setq query-flag nil multi-buffer t)) |
1796 | ||
84482eb3 RS |
1797 | ;; REPLACEMENTS is either a string, a list of strings, or a cons cell |
1798 | ;; containing a function and its first argument. The function is | |
1799 | ;; called to generate each replacement like this: | |
1800 | ;; (funcall (car replacements) (cdr replacements) replace-count) | |
1801 | ;; It must return a string. | |
1802 | (cond | |
1803 | ((stringp replacements) | |
1804 | (setq next-replacement replacements | |
1805 | replacements nil)) | |
1806 | ((stringp (car replacements)) ; If it isn't a string, it must be a cons | |
1807 | (or repeat-count (setq repeat-count 1)) | |
1808 | (setq replacements (cons 'replace-loop-through-replacements | |
1809 | (vector repeat-count repeat-count | |
1810 | replacements replacements))))) | |
1811 | ||
698e1804 RS |
1812 | (if delimited-flag |
1813 | (setq search-function 're-search-forward | |
1814 | search-string (concat "\\b" | |
1815 | (if regexp-flag from-string | |
1816 | (regexp-quote from-string)) | |
1817 | "\\b"))) | |
ccec9764 | 1818 | (when query-replace-lazy-highlight |
444697a1 | 1819 | (setq isearch-lazy-highlight-last-string nil)) |
35d59c0f | 1820 | |
698e1804 RS |
1821 | (push-mark) |
1822 | (undo-boundary) | |
e782e9f2 RS |
1823 | (unwind-protect |
1824 | ;; Loop finding occurrences that perhaps should be replaced. | |
1825 | (while (and keep-going | |
22a76778 | 1826 | (not (or (eobp) (and limit (>= (point) limit)))) |
5632eb27 PE |
1827 | ;; Use the next match if it is already known; |
1828 | ;; otherwise, search for a match after moving forward | |
1829 | ;; one char if progress is required. | |
1830 | (setq real-match-data | |
b3aad29e CY |
1831 | (cond ((consp match-again) |
1832 | (goto-char (nth 1 match-again)) | |
1833 | (replace-match-data | |
1834 | t real-match-data match-again)) | |
1835 | ;; MATCH-AGAIN non-nil means accept an | |
1836 | ;; adjacent match. | |
1837 | (match-again | |
1838 | (and | |
1839 | (funcall search-function search-string | |
1840 | limit t) | |
1841 | ;; For speed, use only integers and | |
1842 | ;; reuse the list used last time. | |
1843 | (replace-match-data t real-match-data))) | |
1844 | ((and (< (1+ (point)) (point-max)) | |
1845 | (or (null limit) | |
1846 | (< (1+ (point)) limit))) | |
1847 | ;; If not accepting adjacent matches, | |
1848 | ;; move one char to the right before | |
1849 | ;; searching again. Undo the motion | |
1850 | ;; if the search fails. | |
1851 | (let ((opoint (point))) | |
1852 | (forward-char 1) | |
1853 | (if (funcall | |
1854 | search-function search-string | |
1855 | limit t) | |
1856 | (replace-match-data | |
1857 | t real-match-data) | |
1858 | (goto-char opoint) | |
1859 | nil)))))) | |
6a964bb1 | 1860 | |
c0b45763 RS |
1861 | ;; Record whether the match is nonempty, to avoid an infinite loop |
1862 | ;; repeatedly matching the same empty string. | |
1863 | (setq nonempty-match | |
1864 | (/= (nth 0 real-match-data) (nth 1 real-match-data))) | |
1865 | ||
1866 | ;; If the match is empty, record that the next one can't be | |
1867 | ;; adjacent. | |
1868 | ||
1869 | ;; Otherwise, if matching a regular expression, do the next | |
1870 | ;; match now, since the replacement for this match may | |
1871 | ;; affect whether the next match is adjacent to this one. | |
1872 | ;; If that match is empty, don't use it. | |
1873 | (setq match-again | |
1874 | (and nonempty-match | |
1875 | (or (not regexp-flag) | |
1876 | (and (looking-at search-string) | |
1877 | (let ((match (match-data))) | |
1878 | (and (/= (nth 0 match) (nth 1 match)) | |
1879 | match)))))) | |
1880 | ||
1c4fe319 RS |
1881 | ;; Optionally ignore matches that have a read-only property. |
1882 | (unless (and query-replace-skip-read-only | |
1883 | (text-property-not-all | |
c0b45763 | 1884 | (nth 0 real-match-data) (nth 1 real-match-data) |
1c4fe319 RS |
1885 | 'read-only nil)) |
1886 | ||
1c4fe319 RS |
1887 | ;; Calculate the replacement string, if necessary. |
1888 | (when replacements | |
1889 | (set-match-data real-match-data) | |
1890 | (setq next-replacement | |
1891 | (funcall (car replacements) (cdr replacements) | |
2f857176 | 1892 | replace-count))) |
1c4fe319 | 1893 | (if (not query-flag) |
f2e7b9ef | 1894 | (progn |
15fd7d5d | 1895 | (unless (or literal noedit) |
444697a1 JL |
1896 | (replace-highlight |
1897 | (nth 0 real-match-data) (nth 1 real-match-data) | |
1898 | start end search-string | |
1899 | (or delimited-flag regexp-flag) case-fold-search)) | |
7c1c02ac DK |
1900 | (setq noedit |
1901 | (replace-match-maybe-edit | |
1902 | next-replacement nocasify literal | |
1903 | noedit real-match-data) | |
1904 | replace-count (1+ replace-count))) | |
1c4fe319 RS |
1905 | (undo-boundary) |
1906 | (let (done replaced key def) | |
1907 | ;; Loop reading commands until one of them sets done, | |
7c1c02ac DK |
1908 | ;; which means it has finished handling this |
1909 | ;; occurrence. Any command that sets `done' should | |
1910 | ;; leave behind proper match data for the stack. | |
1911 | ;; Commands not setting `done' need to adjust | |
1912 | ;; `real-match-data'. | |
1c4fe319 RS |
1913 | (while (not done) |
1914 | (set-match-data real-match-data) | |
444697a1 JL |
1915 | (replace-highlight |
1916 | (match-beginning 0) (match-end 0) | |
1917 | start end search-string | |
1918 | (or delimited-flag regexp-flag) case-fold-search) | |
1c4fe319 RS |
1919 | ;; Bind message-log-max so we don't fill up the message log |
1920 | ;; with a bunch of identical messages. | |
7abe68aa JL |
1921 | (let ((message-log-max nil) |
1922 | (replacement-presentation | |
1923 | (if query-replace-show-replacement | |
1924 | (save-match-data | |
1925 | (set-match-data real-match-data) | |
1926 | (match-substitute-replacement next-replacement | |
1927 | nocasify literal)) | |
1928 | next-replacement))) | |
b938735a JL |
1929 | (message message |
1930 | (query-replace-descr from-string) | |
7abe68aa | 1931 | (query-replace-descr replacement-presentation))) |
1c4fe319 RS |
1932 | (setq key (read-event)) |
1933 | ;; Necessary in case something happens during read-event | |
1934 | ;; that clobbers the match data. | |
1935 | (set-match-data real-match-data) | |
1936 | (setq key (vector key)) | |
1937 | (setq def (lookup-key map key)) | |
1938 | ;; Restore the match data while we process the command. | |
1939 | (cond ((eq def 'help) | |
1940 | (with-output-to-temp-buffer "*Help*" | |
1941 | (princ | |
1942 | (concat "Query replacing " | |
04ff2dee | 1943 | (if delimited-flag "word " "") |
1c4fe319 RS |
1944 | (if regexp-flag "regexp " "") |
1945 | from-string " with " | |
1946 | next-replacement ".\n\n" | |
1947 | (substitute-command-keys | |
1948 | query-replace-help))) | |
1949 | (with-current-buffer standard-output | |
1950 | (help-mode)))) | |
1951 | ((eq def 'exit) | |
1952 | (setq keep-going nil) | |
1953 | (setq done t)) | |
b591f338 JL |
1954 | ((eq def 'exit-current) |
1955 | (setq multi-buffer t keep-going nil done t)) | |
1c4fe319 RS |
1956 | ((eq def 'backup) |
1957 | (if stack | |
588c915a | 1958 | (let ((elt (pop stack))) |
7c1c02ac DK |
1959 | (goto-char (nth 0 elt)) |
1960 | (setq replaced (nth 1 elt) | |
1961 | real-match-data | |
1962 | (replace-match-data | |
1963 | t real-match-data | |
1964 | (nth 2 elt)))) | |
1c4fe319 RS |
1965 | (message "No previous match") |
1966 | (ding 'no-terminate) | |
1967 | (sit-for 1))) | |
1968 | ((eq def 'act) | |
1969 | (or replaced | |
7c1c02ac DK |
1970 | (setq noedit |
1971 | (replace-match-maybe-edit | |
1972 | next-replacement nocasify literal | |
1973 | noedit real-match-data) | |
1974 | replace-count (1+ replace-count))) | |
1c4fe319 RS |
1975 | (setq done t replaced t)) |
1976 | ((eq def 'act-and-exit) | |
1977 | (or replaced | |
7c1c02ac | 1978 | (setq noedit |
da6eb51c | 1979 | (replace-match-maybe-edit |
7c1c02ac DK |
1980 | next-replacement nocasify literal |
1981 | noedit real-match-data) | |
1982 | replace-count (1+ replace-count))) | |
1c4fe319 RS |
1983 | (setq keep-going nil) |
1984 | (setq done t replaced t)) | |
1985 | ((eq def 'act-and-show) | |
1986 | (if (not replaced) | |
7c1c02ac DK |
1987 | (setq noedit |
1988 | (replace-match-maybe-edit | |
1989 | next-replacement nocasify literal | |
1990 | noedit real-match-data) | |
1991 | replace-count (1+ replace-count) | |
1992 | real-match-data (replace-match-data | |
1993 | t real-match-data) | |
1994 | replaced t))) | |
b591f338 | 1995 | ((or (eq def 'automatic) (eq def 'automatic-all)) |
1c4fe319 | 1996 | (or replaced |
7c1c02ac DK |
1997 | (setq noedit |
1998 | (replace-match-maybe-edit | |
1999 | next-replacement nocasify literal | |
2000 | noedit real-match-data) | |
2001 | replace-count (1+ replace-count))) | |
b591f338 JL |
2002 | (setq done t query-flag nil replaced t) |
2003 | (if (eq def 'automatic-all) (setq multi-buffer t))) | |
1c4fe319 RS |
2004 | ((eq def 'skip) |
2005 | (setq done t)) | |
2006 | ((eq def 'recenter) | |
2952b1ae JL |
2007 | ;; `this-command' has the value `query-replace', |
2008 | ;; so we need to bind it to `recenter-top-bottom' | |
2009 | ;; to allow it to detect a sequence of `C-l'. | |
2010 | (let ((this-command 'recenter-top-bottom) | |
2011 | (last-command 'recenter-top-bottom)) | |
2012 | (recenter-top-bottom))) | |
1c4fe319 RS |
2013 | ((eq def 'edit) |
2014 | (let ((opos (point-marker))) | |
7c1c02ac DK |
2015 | (setq real-match-data (replace-match-data |
2016 | nil real-match-data | |
2017 | real-match-data)) | |
1c4fe319 | 2018 | (goto-char (match-beginning 0)) |
86914dcc RS |
2019 | (save-excursion |
2020 | (save-window-excursion | |
2021 | (recursive-edit))) | |
7c1c02ac DK |
2022 | (goto-char opos) |
2023 | (set-marker opos nil)) | |
1c4fe319 RS |
2024 | ;; Before we make the replacement, |
2025 | ;; decide whether the search string | |
2026 | ;; can match again just after this match. | |
2027 | (if (and regexp-flag nonempty-match) | |
2028 | (setq match-again (and (looking-at search-string) | |
2029 | (match-data))))) | |
1c4fe319 RS |
2030 | ;; Edit replacement. |
2031 | ((eq def 'edit-replacement) | |
7c1c02ac DK |
2032 | (setq real-match-data (replace-match-data |
2033 | nil real-match-data | |
2034 | real-match-data) | |
2035 | next-replacement | |
3981e5b5 JB |
2036 | (read-string "Edit replacement string: " |
2037 | next-replacement) | |
7c1c02ac DK |
2038 | noedit nil) |
2039 | (if replaced | |
2040 | (set-match-data real-match-data) | |
2041 | (setq noedit | |
2042 | (replace-match-maybe-edit | |
2043 | next-replacement nocasify literal noedit | |
2044 | real-match-data) | |
2045 | replaced t)) | |
1c4fe319 | 2046 | (setq done t)) |
d99118b0 | 2047 | |
1c4fe319 | 2048 | ((eq def 'delete-and-edit) |
7c1c02ac DK |
2049 | (replace-match "" t t) |
2050 | (setq real-match-data (replace-match-data | |
2051 | nil real-match-data)) | |
2052 | (replace-dehighlight) | |
2053 | (save-excursion (recursive-edit)) | |
1c4fe319 RS |
2054 | (setq replaced t)) |
2055 | ;; Note: we do not need to treat `exit-prefix' | |
2056 | ;; specially here, since we reread | |
2057 | ;; any unrecognized character. | |
2058 | (t | |
2059 | (setq this-command 'mode-exited) | |
2060 | (setq keep-going nil) | |
2061 | (setq unread-command-events | |
2062 | (append (listify-key-sequence key) | |
2063 | unread-command-events)) | |
35d59c0f | 2064 | (setq done t))) |
ccec9764 | 2065 | (when query-replace-lazy-highlight |
2952b1ae | 2066 | ;; Force lazy rehighlighting only after replacements. |
ccec9764 | 2067 | (if (not (memq def '(skip backup))) |
2952b1ae JL |
2068 | (setq isearch-lazy-highlight-last-string nil))) |
2069 | (unless (eq def 'recenter) | |
2070 | ;; Reset recenter cycling order to initial position. | |
2071 | (setq recenter-last-op nil))) | |
1c4fe319 RS |
2072 | ;; Record previous position for ^ when we move on. |
2073 | ;; Change markers to numbers in the match data | |
2074 | ;; since lots of markers slow down editing. | |
7c1c02ac | 2075 | (push (list (point) replaced |
bace7209 LT |
2076 | ;;; If the replacement has already happened, all we need is the |
2077 | ;;; current match start and end. We could get this with a trivial | |
2078 | ;;; match like | |
2079 | ;;; (save-excursion (goto-char (match-beginning 0)) | |
2080 | ;;; (search-forward (match-string 0)) | |
2081 | ;;; (match-data t)) | |
2082 | ;;; if we really wanted to avoid manually constructing match data. | |
2083 | ;;; Adding current-buffer is necessary so that match-data calls can | |
2084 | ;;; return markers which are appropriate for editing. | |
7c1c02ac DK |
2085 | (if replaced |
2086 | (list | |
2087 | (match-beginning 0) | |
2088 | (match-end 0) | |
2089 | (current-buffer)) | |
2090 | (match-data t))) | |
2091 | stack))))) | |
889617de | 2092 | |
e782e9f2 | 2093 | (replace-dehighlight)) |
4d33492a RS |
2094 | (or unread-command-events |
2095 | (message "Replaced %d occurrence%s" | |
2096 | replace-count | |
2097 | (if (= replace-count 1) "" "s"))) | |
b591f338 | 2098 | (or (and keep-going stack) multi-buffer))) |
698e1804 | 2099 | |
06b60517 JB |
2100 | (defvar isearch-error) |
2101 | (defvar isearch-forward) | |
2102 | (defvar isearch-case-fold-search) | |
2103 | (defvar isearch-string) | |
2104 | ||
e782e9f2 RS |
2105 | (defvar replace-overlay nil) |
2106 | ||
444697a1 JL |
2107 | (defun replace-highlight (match-beg match-end range-beg range-end |
2108 | string regexp case-fold) | |
ccec9764 JL |
2109 | (if query-replace-highlight |
2110 | (if replace-overlay | |
d532160f RS |
2111 | (move-overlay replace-overlay match-beg match-end (current-buffer)) |
2112 | (setq replace-overlay (make-overlay match-beg match-end)) | |
a46961de | 2113 | (overlay-put replace-overlay 'priority 1001) ;higher than lazy overlays |
ccec9764 | 2114 | (overlay-put replace-overlay 'face 'query-replace))) |
444697a1 JL |
2115 | (if query-replace-lazy-highlight |
2116 | (let ((isearch-string string) | |
2117 | (isearch-regexp regexp) | |
300e8fa5 JL |
2118 | ;; Set isearch-word to nil because word-replace is regexp-based, |
2119 | ;; so `isearch-search-fun' should not use `word-search-forward'. | |
2120 | (isearch-word nil) | |
0b60cc09 | 2121 | (search-whitespace-regexp nil) |
e54a1075 JB |
2122 | (isearch-case-fold-search case-fold) |
2123 | (isearch-forward t) | |
2124 | (isearch-error nil)) | |
444697a1 | 2125 | (isearch-lazy-highlight-new-loop range-beg range-end)))) |
ccec9764 | 2126 | |
e782e9f2 | 2127 | (defun replace-dehighlight () |
ccec9764 JL |
2128 | (when replace-overlay |
2129 | (delete-overlay replace-overlay)) | |
2130 | (when query-replace-lazy-highlight | |
444697a1 | 2131 | (lazy-highlight-cleanup lazy-highlight-cleanup) |
ccec9764 | 2132 | (setq isearch-lazy-highlight-last-string nil))) |
e782e9f2 | 2133 | |
c88ab9ce | 2134 | ;;; replace.el ends here |