Commit | Line | Data |
---|---|---|
72ece9e8 JL |
1 | ;;; misearch.el --- isearch extensions for multi-buffer search |
2 | ||
acaf905b | 3 | ;; Copyright (C) 2007-2012 Free Software Foundation, Inc. |
72ece9e8 JL |
4 | |
5 | ;; Author: Juri Linkov <juri@jurta.org> | |
6 | ;; Keywords: matching | |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software: you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation, either version 3 of the License, or | |
13 | ;; (at your option) any later version. | |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. | |
22 | ||
23 | ;;; Commentary: | |
24 | ||
25 | ;; This file adds more dimensions to the search space. It implements | |
26 | ;; various features that extend isearch. One of them is an ability to | |
27 | ;; search through multiple buffers. | |
28 | ||
29 | ;;; Code: | |
30 | ||
31 | ;;; Search multiple buffers | |
32 | ||
33 | ;;;###autoload (add-hook 'isearch-mode-hook 'multi-isearch-setup) | |
34 | ||
35 | (defgroup multi-isearch nil | |
36 | "Using isearch to search through multiple buffers." | |
37 | :version "23.1" | |
38 | :group 'isearch) | |
39 | ||
40 | (defcustom multi-isearch-search t | |
41 | "Non-nil enables searching multiple related buffers, in certain modes." | |
42 | :type 'boolean | |
43 | :version "23.1" | |
44 | :group 'multi-isearch) | |
45 | ||
46 | (defcustom multi-isearch-pause t | |
47 | "A choice defining where to pause the search. | |
48 | If the value is nil, don't pause before going to the next buffer. | |
49 | If the value is `initial', pause only after a failing search in the | |
50 | initial buffer. | |
51 | If t, pause in all buffers that contain the search string." | |
52 | :type '(choice | |
53 | (const :tag "Don't pause" nil) | |
54 | (const :tag "Only in initial buffer" initial) | |
55 | (const :tag "All buffers" t)) | |
56 | :version "23.1" | |
57 | :group 'multi-isearch) | |
58 | ||
59 | ;;;###autoload | |
60 | (defvar multi-isearch-next-buffer-function nil | |
61 | "Function to call to get the next buffer to search. | |
62 | ||
63 | When this variable is set to a function that returns a buffer, then | |
64 | after typing another \\[isearch-forward] or \\[isearch-backward] \ | |
65 | at a failing search, the search goes | |
66 | to the next buffer in the series and continues searching for the | |
67 | next occurrence. | |
68 | ||
9b7322d8 JL |
69 | This function should return the next buffer (it doesn't need to switch |
70 | to it), or nil if it can't find the next buffer (when it reaches the | |
71 | end of the search space). | |
72 | ||
72ece9e8 JL |
73 | The first argument of this function is the current buffer where the |
74 | search is currently searching. It defines the base buffer relative to | |
75 | which this function should find the next buffer. When the isearch | |
76 | direction is backward (when `isearch-forward' is nil), this function | |
9b7322d8 JL |
77 | should return the previous buffer to search. |
78 | ||
79 | If the second argument of this function WRAP is non-nil, then it | |
80 | should return the first buffer in the series; and for the backward | |
81 | search, it should return the last buffer in the series.") | |
72ece9e8 JL |
82 | |
83 | ;;;###autoload | |
84 | (defvar multi-isearch-next-buffer-current-function nil | |
85 | "The currently active function to get the next buffer to search. | |
86 | Initialized from `multi-isearch-next-buffer-function' when | |
87 | Isearch starts.") | |
88 | ||
89 | ;;;###autoload | |
90 | (defvar multi-isearch-current-buffer nil | |
91 | "The buffer where the search is currently searching. | |
92 | The value is nil when the search still is in the initial buffer.") | |
93 | ||
94 | (defvar multi-isearch-orig-search-fun nil) | |
95 | (defvar multi-isearch-orig-wrap nil) | |
96 | (defvar multi-isearch-orig-push-state nil) | |
97 | ||
98 | \f | |
99 | ;;;###autoload | |
100 | (defun multi-isearch-setup () | |
101 | "Set up isearch to search multiple buffers. | |
102 | Intended to be added to `isearch-mode-hook'." | |
103 | (when (and multi-isearch-search | |
104 | multi-isearch-next-buffer-function) | |
105 | (setq multi-isearch-current-buffer nil | |
106 | multi-isearch-next-buffer-current-function | |
107 | multi-isearch-next-buffer-function | |
108 | multi-isearch-orig-search-fun | |
109 | (default-value 'isearch-search-fun-function) | |
110 | multi-isearch-orig-wrap | |
111 | (default-value 'isearch-wrap-function) | |
112 | multi-isearch-orig-push-state | |
113 | (default-value 'isearch-push-state-function)) | |
114 | (setq-default isearch-search-fun-function 'multi-isearch-search-fun | |
115 | isearch-wrap-function 'multi-isearch-wrap | |
116 | isearch-push-state-function 'multi-isearch-push-state) | |
117 | (add-hook 'isearch-mode-end-hook 'multi-isearch-end))) | |
118 | ||
119 | (defun multi-isearch-end () | |
120 | "Clean up the multi-buffer search after terminating isearch." | |
121 | (setq multi-isearch-current-buffer nil | |
122 | multi-isearch-next-buffer-current-function nil) | |
123 | (setq-default isearch-search-fun-function multi-isearch-orig-search-fun | |
124 | isearch-wrap-function multi-isearch-orig-wrap | |
125 | isearch-push-state-function multi-isearch-orig-push-state) | |
126 | (remove-hook 'isearch-mode-end-hook 'multi-isearch-end)) | |
127 | ||
128 | (defun multi-isearch-search-fun () | |
129 | "Return the proper search function, for isearch in multiple buffers." | |
130 | (lambda (string bound noerror) | |
131 | (let ((search-fun | |
132 | ;; Use standard functions to search within one buffer | |
133 | (cond | |
134 | (isearch-word | |
135 | (if isearch-forward 'word-search-forward 'word-search-backward)) | |
136 | (isearch-regexp | |
137 | (if isearch-forward 're-search-forward 're-search-backward)) | |
138 | (t | |
139 | (if isearch-forward 'search-forward 'search-backward)))) | |
140 | found buffer) | |
141 | (or | |
142 | ;; 1. First try searching in the initial buffer | |
143 | (let ((res (funcall search-fun string bound noerror))) | |
144 | ;; Reset wrapping for all-buffers pause after successful search | |
30c62133 | 145 | (if (and res (not bound) (eq multi-isearch-pause t)) |
72ece9e8 JL |
146 | (setq multi-isearch-current-buffer nil)) |
147 | res) | |
148 | ;; 2. If the above search fails, start visiting next/prev buffers | |
149 | ;; successively, and search the string in them. Do this only | |
150 | ;; when bound is nil (i.e. not while lazy-highlighting search | |
151 | ;; strings in the current buffer). | |
152 | (when (and (not bound) multi-isearch-search) | |
153 | ;; If no-pause or there was one attempt to leave the current buffer | |
154 | (if (or (null multi-isearch-pause) | |
155 | (and multi-isearch-pause multi-isearch-current-buffer)) | |
156 | (condition-case nil | |
157 | (progn | |
158 | (while (not found) | |
159 | ;; Find the next buffer to search | |
160 | (setq buffer (funcall multi-isearch-next-buffer-current-function | |
054ae856 | 161 | (or buffer (current-buffer)) nil)) |
72ece9e8 JL |
162 | (with-current-buffer buffer |
163 | (goto-char (if isearch-forward (point-min) (point-max))) | |
164 | (setq isearch-barrier (point) isearch-opoint (point)) | |
165 | ;; After visiting the next/prev buffer search the | |
166 | ;; string in it again, until the function in | |
167 | ;; multi-isearch-next-buffer-current-function raises | |
168 | ;; an error at the beginning/end of the buffer sequence. | |
169 | (setq found (funcall search-fun string bound noerror)))) | |
170 | ;; Set buffer for isearch-search-string to switch | |
171 | (if buffer (setq multi-isearch-current-buffer buffer)) | |
172 | ;; Return point of the new search result | |
173 | found) | |
174 | ;; Return nil when multi-isearch-next-buffer-current-function fails | |
9b7322d8 | 175 | ;; (`with-current-buffer' raises an error for nil returned from it). |
30c62133 JL |
176 | (error (signal 'search-failed (list string "end of multi")))) |
177 | (signal 'search-failed (list string "repeat for next buffer")))))))) | |
72ece9e8 JL |
178 | |
179 | (defun multi-isearch-wrap () | |
180 | "Wrap the multiple buffers search when search is failed. | |
181 | Switch buffer to the first buffer for a forward search, | |
182 | or to the last buffer for a backward search. | |
183 | Set `multi-isearch-current-buffer' to the current buffer to display | |
184 | the isearch suffix message [initial buffer] only when isearch leaves | |
185 | the initial buffer." | |
186 | (if (or (null multi-isearch-pause) | |
187 | (and multi-isearch-pause multi-isearch-current-buffer)) | |
188 | (progn | |
189 | (switch-to-buffer | |
190 | (setq multi-isearch-current-buffer | |
191 | (funcall multi-isearch-next-buffer-current-function | |
192 | (current-buffer) t))) | |
193 | (goto-char (if isearch-forward (point-min) (point-max)))) | |
194 | (setq multi-isearch-current-buffer (current-buffer)) | |
195 | (setq isearch-wrapped nil))) | |
196 | ||
197 | (defun multi-isearch-push-state () | |
198 | "Save a function restoring the state of multiple buffers search. | |
199 | Save the current buffer to the additional state parameter in the | |
200 | search status stack." | |
201 | `(lambda (cmd) | |
202 | (multi-isearch-pop-state cmd ,(current-buffer)))) | |
203 | ||
06b60517 | 204 | (defun multi-isearch-pop-state (_cmd buffer) |
72ece9e8 JL |
205 | "Restore the multiple buffers search state. |
206 | Switch to the buffer restored from the search status stack." | |
207 | (unless (equal buffer (current-buffer)) | |
208 | (switch-to-buffer (setq multi-isearch-current-buffer buffer)))) | |
209 | ||
210 | \f | |
211 | ;;; Global multi-buffer search invocations | |
212 | ||
213 | (defvar multi-isearch-buffer-list nil) | |
214 | ||
215 | (defun multi-isearch-next-buffer-from-list (&optional buffer wrap) | |
92f8bfc7 JL |
216 | "Return the next buffer in the series of buffers. |
217 | This function is used for multiple buffers Isearch. A sequence of | |
218 | buffers is defined by the variable `multi-isearch-buffer-list' | |
219 | set in `multi-isearch-buffers' or `multi-isearch-buffers-regexp'." | |
72ece9e8 JL |
220 | (let ((buffers (if isearch-forward |
221 | multi-isearch-buffer-list | |
222 | (reverse multi-isearch-buffer-list)))) | |
223 | (if wrap | |
224 | (car buffers) | |
054ae856 | 225 | (cadr (member buffer buffers))))) |
72ece9e8 | 226 | |
06b60517 JB |
227 | (defvar ido-ignore-item-temp-list) ; from ido.el |
228 | ||
c585bf32 JL |
229 | (defun multi-isearch-read-buffers () |
230 | "Return a list of buffers specified interactively, one by one." | |
231 | ;; Most code from `multi-occur'. | |
232 | (let* ((bufs (list (read-buffer "First buffer to search: " | |
233 | (current-buffer) t))) | |
234 | (buf nil) | |
235 | (ido-ignore-item-temp-list bufs)) | |
236 | (while (not (string-equal | |
237 | (setq buf (read-buffer | |
238 | (if (eq read-buffer-function 'ido-read-buffer) | |
239 | "Next buffer to search (C-j to end): " | |
240 | "Next buffer to search (RET to end): ") | |
241 | nil t)) | |
242 | "")) | |
243 | (add-to-list 'bufs buf) | |
244 | (setq ido-ignore-item-temp-list bufs)) | |
67296dda | 245 | (nreverse bufs))) |
c585bf32 JL |
246 | |
247 | (defun multi-isearch-read-matching-buffers () | |
248 | "Return a list of buffers whose names match specified regexp." | |
249 | ;; Most code from `multi-occur-in-matching-buffers' | |
250 | ;; and `kill-matching-buffers'. | |
251 | (let ((bufregexp | |
252 | (read-regexp "Search in buffers whose names match regexp"))) | |
253 | (when bufregexp | |
254 | (delq nil (mapcar (lambda (buf) | |
255 | (when (string-match bufregexp (buffer-name buf)) | |
256 | buf)) | |
257 | (buffer-list)))))) | |
258 | ||
72ece9e8 JL |
259 | ;;;###autoload |
260 | (defun multi-isearch-buffers (buffers) | |
c585bf32 | 261 | "Start multi-buffer Isearch on a list of BUFFERS. |
67296dda | 262 | This list can contain live buffers or their names. |
c585bf32 JL |
263 | Interactively read buffer names to search, one by one, ended with RET. |
264 | With a prefix argument, ask for a regexp, and search in buffers | |
265 | whose names match the specified regexp." | |
266 | (interactive | |
267 | (list (if current-prefix-arg | |
268 | (multi-isearch-read-matching-buffers) | |
269 | (multi-isearch-read-buffers)))) | |
72ece9e8 JL |
270 | (let ((multi-isearch-next-buffer-function |
271 | 'multi-isearch-next-buffer-from-list) | |
67296dda JL |
272 | (multi-isearch-buffer-list (mapcar #'get-buffer buffers))) |
273 | (switch-to-buffer (car multi-isearch-buffer-list)) | |
72ece9e8 JL |
274 | (goto-char (if isearch-forward (point-min) (point-max))) |
275 | (isearch-forward))) | |
276 | ||
277 | ;;;###autoload | |
278 | (defun multi-isearch-buffers-regexp (buffers) | |
c585bf32 | 279 | "Start multi-buffer regexp Isearch on a list of BUFFERS. |
67296dda | 280 | This list can contain live buffers or their names. |
c585bf32 JL |
281 | Interactively read buffer names to search, one by one, ended with RET. |
282 | With a prefix argument, ask for a regexp, and search in buffers | |
283 | whose names match the specified regexp." | |
284 | (interactive | |
285 | (list (if current-prefix-arg | |
286 | (multi-isearch-read-matching-buffers) | |
287 | (multi-isearch-read-buffers)))) | |
72ece9e8 JL |
288 | (let ((multi-isearch-next-buffer-function |
289 | 'multi-isearch-next-buffer-from-list) | |
67296dda JL |
290 | (multi-isearch-buffer-list (mapcar #'get-buffer buffers))) |
291 | (switch-to-buffer (car multi-isearch-buffer-list)) | |
72ece9e8 JL |
292 | (goto-char (if isearch-forward (point-min) (point-max))) |
293 | (isearch-forward-regexp))) | |
294 | ||
295 | \f | |
296 | ;;; Global multi-file search invocations | |
297 | ||
298 | (defvar multi-isearch-file-list nil) | |
299 | ||
300 | (defun multi-isearch-next-file-buffer-from-list (&optional buffer wrap) | |
92f8bfc7 JL |
301 | "Return the next buffer in the series of file buffers. |
302 | This function is used for multiple file buffers Isearch. A sequence | |
303 | of files is defined by the variable `multi-isearch-file-list' set in | |
304 | `multi-isearch-files' or `multi-isearch-files-regexp'. | |
305 | Every next/previous file in the defined sequence is visited by | |
306 | `find-file-noselect' that returns the corresponding file buffer." | |
72ece9e8 JL |
307 | (let ((files (if isearch-forward |
308 | multi-isearch-file-list | |
309 | (reverse multi-isearch-file-list)))) | |
310 | (find-file-noselect | |
311 | (if wrap | |
312 | (car files) | |
313 | (cadr (member (buffer-file-name buffer) files)))))) | |
314 | ||
c585bf32 JL |
315 | (defun multi-isearch-read-files () |
316 | "Return a list of files specified interactively, one by one." | |
317 | ;; Most code from `multi-occur'. | |
318 | (let* ((files (list (read-file-name "First file to search: " | |
319 | default-directory | |
320 | buffer-file-name))) | |
321 | (file nil)) | |
322 | (while (not (string-equal | |
323 | (setq file (read-file-name | |
324 | "Next file to search (RET to end): " | |
325 | default-directory | |
326 | default-directory)) | |
327 | default-directory)) | |
328 | (add-to-list 'files file)) | |
329 | (nreverse files))) | |
330 | ||
331 | (defun multi-isearch-read-matching-files () | |
332 | "Return a list of files whose names match specified wildcard." | |
333 | ;; Most wildcard code from `find-file-noselect'. | |
334 | (let ((filename (read-regexp "Search in files whose names match wildcard"))) | |
335 | (when (and filename | |
336 | (not (string-match "\\`/:" filename)) | |
337 | (string-match "[[*?]" filename)) | |
338 | (condition-case nil | |
339 | (file-expand-wildcards filename t) | |
340 | (error (list filename)))))) | |
341 | ||
72ece9e8 JL |
342 | ;;;###autoload |
343 | (defun multi-isearch-files (files) | |
c585bf32 | 344 | "Start multi-buffer Isearch on a list of FILES. |
67296dda JL |
345 | Relative file names in this list are expanded to absolute |
346 | file names using the current buffer's value of `default-directory'. | |
c585bf32 JL |
347 | Interactively read file names to search, one by one, ended with RET. |
348 | With a prefix argument, ask for a wildcard, and search in file buffers | |
349 | whose file names match the specified wildcard." | |
350 | (interactive | |
351 | (list (if current-prefix-arg | |
352 | (multi-isearch-read-matching-files) | |
353 | (multi-isearch-read-files)))) | |
72ece9e8 JL |
354 | (let ((multi-isearch-next-buffer-function |
355 | 'multi-isearch-next-file-buffer-from-list) | |
67296dda JL |
356 | (multi-isearch-file-list (mapcar #'expand-file-name files))) |
357 | (find-file (car multi-isearch-file-list)) | |
72ece9e8 JL |
358 | (goto-char (if isearch-forward (point-min) (point-max))) |
359 | (isearch-forward))) | |
360 | ||
361 | ;;;###autoload | |
362 | (defun multi-isearch-files-regexp (files) | |
c585bf32 | 363 | "Start multi-buffer regexp Isearch on a list of FILES. |
67296dda JL |
364 | Relative file names in this list are expanded to absolute |
365 | file names using the current buffer's value of `default-directory'. | |
c585bf32 JL |
366 | Interactively read file names to search, one by one, ended with RET. |
367 | With a prefix argument, ask for a wildcard, and search in file buffers | |
368 | whose file names match the specified wildcard." | |
369 | (interactive | |
370 | (list (if current-prefix-arg | |
371 | (multi-isearch-read-matching-files) | |
372 | (multi-isearch-read-files)))) | |
72ece9e8 JL |
373 | (let ((multi-isearch-next-buffer-function |
374 | 'multi-isearch-next-file-buffer-from-list) | |
67296dda JL |
375 | (multi-isearch-file-list (mapcar #'expand-file-name files))) |
376 | (find-file (car multi-isearch-file-list)) | |
72ece9e8 JL |
377 | (goto-char (if isearch-forward (point-min) (point-max))) |
378 | (isearch-forward-regexp))) | |
379 | ||
380 | \f | |
381 | (provide 'multi-isearch) | |
382 | ||
72ece9e8 | 383 | ;;; misearch.el ends here |