Auto-commit of generated files.
[emacs.git] / lisp / misearch.el
blob0c4cd4ea323c386886c97c9401c257c1e741b3d9
1 ;;; misearch.el --- isearch extensions for multi-buffer search
3 ;; Copyright (C) 2007-2013 Free Software Foundation, Inc.
5 ;; Author: Juri Linkov <juri@jurta.org>
6 ;; Keywords: matching
8 ;; This file is part of GNU Emacs.
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.
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.
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/>.
23 ;;; Commentary:
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.
29 ;;; Code:
31 ;;; Search multiple buffers
33 ;;;###autoload (add-hook 'isearch-mode-hook 'multi-isearch-setup)
35 (defgroup multi-isearch nil
36 "Using isearch to search through multiple buffers."
37 :version "23.1"
38 :group 'isearch)
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)
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)
59 ;;;###autoload
60 (defvar multi-isearch-next-buffer-function nil
61 "Function to call to get the next buffer to search.
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.
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).
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 option `isearch-forward' is nil), this function
77 should return the previous buffer to search.
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.")
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.")
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.")
94 (defvar multi-isearch-orig-search-fun nil)
95 (defvar multi-isearch-orig-wrap nil)
96 (defvar multi-isearch-orig-push-state nil)
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)))
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))
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 (isearch-search-fun-default))
134 found buffer)
136 ;; 1. First try searching in the initial buffer
137 (let ((res (funcall search-fun string bound noerror)))
138 ;; Reset wrapping for all-buffers pause after successful search
139 (if (and res (not bound) (eq multi-isearch-pause t))
140 (setq multi-isearch-current-buffer nil))
141 res)
142 ;; 2. If the above search fails, start visiting next/prev buffers
143 ;; successively, and search the string in them. Do this only
144 ;; when bound is nil (i.e. not while lazy-highlighting search
145 ;; strings in the current buffer).
146 (when (and (not bound) multi-isearch-search)
147 ;; If no-pause or there was one attempt to leave the current buffer
148 (if (or (null multi-isearch-pause)
149 (and multi-isearch-pause multi-isearch-current-buffer))
150 (condition-case nil
151 (progn
152 (while (not found)
153 ;; Find the next buffer to search
154 (setq buffer (funcall multi-isearch-next-buffer-current-function
155 (or buffer (current-buffer)) nil))
156 (with-current-buffer buffer
157 (goto-char (if isearch-forward (point-min) (point-max)))
158 (setq isearch-barrier (point) isearch-opoint (point))
159 ;; After visiting the next/prev buffer search the
160 ;; string in it again, until the function in
161 ;; multi-isearch-next-buffer-current-function raises
162 ;; an error at the beginning/end of the buffer sequence.
163 (setq found (funcall search-fun string bound noerror))))
164 ;; Set buffer for isearch-search-string to switch
165 (if buffer (setq multi-isearch-current-buffer buffer))
166 ;; Return point of the new search result
167 found)
168 ;; Return nil when multi-isearch-next-buffer-current-function fails
169 ;; (`with-current-buffer' raises an error for nil returned from it).
170 (error (signal 'search-failed (list string "end of multi"))))
171 (signal 'search-failed (list string "repeat for next buffer"))))))))
173 (defun multi-isearch-wrap ()
174 "Wrap the multiple buffers search when search is failed.
175 Switch buffer to the first buffer for a forward search,
176 or to the last buffer for a backward search.
177 Set `multi-isearch-current-buffer' to the current buffer to display
178 the isearch suffix message [initial buffer] only when isearch leaves
179 the initial buffer."
180 (if (or (null multi-isearch-pause)
181 (and multi-isearch-pause multi-isearch-current-buffer))
182 (progn
183 (switch-to-buffer
184 (setq multi-isearch-current-buffer
185 (funcall multi-isearch-next-buffer-current-function
186 (current-buffer) t)))
187 (goto-char (if isearch-forward (point-min) (point-max))))
188 (setq multi-isearch-current-buffer (current-buffer))
189 (setq isearch-wrapped nil)))
191 (defun multi-isearch-push-state ()
192 "Save a function restoring the state of multiple buffers search.
193 Save the current buffer to the additional state parameter in the
194 search status stack."
195 `(lambda (cmd)
196 (multi-isearch-pop-state cmd ,(current-buffer))))
198 (defun multi-isearch-pop-state (_cmd buffer)
199 "Restore the multiple buffers search state.
200 Switch to the buffer restored from the search status stack."
201 (unless (equal buffer (current-buffer))
202 (switch-to-buffer (setq multi-isearch-current-buffer buffer))))
205 ;;; Global multi-buffer search invocations
207 (defvar multi-isearch-buffer-list nil)
209 (defun multi-isearch-next-buffer-from-list (&optional buffer wrap)
210 "Return the next buffer in the series of buffers.
211 This function is used for multiple buffers Isearch. A sequence of
212 buffers is defined by the variable `multi-isearch-buffer-list'
213 set in `multi-isearch-buffers' or `multi-isearch-buffers-regexp'."
214 (let ((buffers (if isearch-forward
215 multi-isearch-buffer-list
216 (reverse multi-isearch-buffer-list))))
217 (if wrap
218 (car buffers)
219 (cadr (member buffer buffers)))))
221 (defvar ido-ignore-item-temp-list) ; from ido.el
223 (defun multi-isearch-read-buffers ()
224 "Return a list of buffers specified interactively, one by one."
225 ;; Most code from `multi-occur'.
226 (let* ((bufs (list (read-buffer "First buffer to search: "
227 (current-buffer) t)))
228 (buf nil)
229 (ido-ignore-item-temp-list bufs))
230 (while (not (string-equal
231 (setq buf (read-buffer
232 (if (eq read-buffer-function 'ido-read-buffer)
233 "Next buffer to search (C-j to end): "
234 "Next buffer to search (RET to end): ")
235 nil t))
236 ""))
237 (add-to-list 'bufs buf)
238 (setq ido-ignore-item-temp-list bufs))
239 (nreverse bufs)))
241 (defun multi-isearch-read-matching-buffers ()
242 "Return a list of buffers whose names match specified regexp."
243 ;; Most code from `multi-occur-in-matching-buffers'
244 ;; and `kill-matching-buffers'.
245 (let ((bufregexp
246 (read-regexp "Search in buffers whose names match regexp")))
247 (when bufregexp
248 (delq nil (mapcar (lambda (buf)
249 (when (string-match bufregexp (buffer-name buf))
250 buf))
251 (buffer-list))))))
253 ;;;###autoload
254 (defun multi-isearch-buffers (buffers)
255 "Start multi-buffer Isearch on a list of BUFFERS.
256 This list can contain live buffers or their names.
257 Interactively read buffer names to search, one by one, ended with RET.
258 With a prefix argument, ask for a regexp, and search in buffers
259 whose names match the specified regexp."
260 (interactive
261 (list (if current-prefix-arg
262 (multi-isearch-read-matching-buffers)
263 (multi-isearch-read-buffers))))
264 (let ((multi-isearch-next-buffer-function
265 'multi-isearch-next-buffer-from-list)
266 (multi-isearch-buffer-list (mapcar #'get-buffer buffers)))
267 (switch-to-buffer (car multi-isearch-buffer-list))
268 (goto-char (if isearch-forward (point-min) (point-max)))
269 (isearch-forward)))
271 ;;;###autoload
272 (defun multi-isearch-buffers-regexp (buffers)
273 "Start multi-buffer regexp Isearch on a list of BUFFERS.
274 This list can contain live buffers or their names.
275 Interactively read buffer names to search, one by one, ended with RET.
276 With a prefix argument, ask for a regexp, and search in buffers
277 whose names match the specified regexp."
278 (interactive
279 (list (if current-prefix-arg
280 (multi-isearch-read-matching-buffers)
281 (multi-isearch-read-buffers))))
282 (let ((multi-isearch-next-buffer-function
283 'multi-isearch-next-buffer-from-list)
284 (multi-isearch-buffer-list (mapcar #'get-buffer buffers)))
285 (switch-to-buffer (car multi-isearch-buffer-list))
286 (goto-char (if isearch-forward (point-min) (point-max)))
287 (isearch-forward-regexp)))
290 ;;; Global multi-file search invocations
292 (defvar multi-isearch-file-list nil)
294 (defun multi-isearch-next-file-buffer-from-list (&optional buffer wrap)
295 "Return the next buffer in the series of file buffers.
296 This function is used for multiple file buffers Isearch. A sequence
297 of files is defined by the variable `multi-isearch-file-list' set in
298 `multi-isearch-files' or `multi-isearch-files-regexp'.
299 Every next/previous file in the defined sequence is visited by
300 `find-file-noselect' that returns the corresponding file buffer."
301 (let ((files (if isearch-forward
302 multi-isearch-file-list
303 (reverse multi-isearch-file-list))))
304 (find-file-noselect
305 (if wrap
306 (car files)
307 (cadr (member (buffer-file-name buffer) files))))))
309 (defun multi-isearch-read-files ()
310 "Return a list of files specified interactively, one by one."
311 ;; Most code from `multi-occur'.
312 (let* ((files (list (read-file-name "First file to search: "
313 default-directory
314 buffer-file-name)))
315 (file nil))
316 (while (not (string-equal
317 (setq file (read-file-name
318 "Next file to search (RET to end): "
319 default-directory
320 default-directory))
321 default-directory))
322 (add-to-list 'files file))
323 (nreverse files)))
325 (defun multi-isearch-read-matching-files ()
326 "Return a list of files whose names match specified wildcard."
327 ;; Most wildcard code from `find-file-noselect'.
328 (let ((filename (read-regexp "Search in files whose names match wildcard")))
329 (when (and filename
330 (not (string-match "\\`/:" filename))
331 (string-match "[[*?]" filename))
332 (condition-case nil
333 (file-expand-wildcards filename t)
334 (error (list filename))))))
336 ;;;###autoload
337 (defun multi-isearch-files (files)
338 "Start multi-buffer Isearch on a list of FILES.
339 Relative file names in this list are expanded to absolute
340 file names using the current buffer's value of `default-directory'.
341 Interactively read file names to search, one by one, ended with RET.
342 With a prefix argument, ask for a wildcard, and search in file buffers
343 whose file names match the specified wildcard."
344 (interactive
345 (list (if current-prefix-arg
346 (multi-isearch-read-matching-files)
347 (multi-isearch-read-files))))
348 (let ((multi-isearch-next-buffer-function
349 'multi-isearch-next-file-buffer-from-list)
350 (multi-isearch-file-list (mapcar #'expand-file-name files)))
351 (find-file (car multi-isearch-file-list))
352 (goto-char (if isearch-forward (point-min) (point-max)))
353 (isearch-forward)))
355 ;;;###autoload
356 (defun multi-isearch-files-regexp (files)
357 "Start multi-buffer regexp Isearch on a list of FILES.
358 Relative file names in this list are expanded to absolute
359 file names using the current buffer's value of `default-directory'.
360 Interactively read file names to search, one by one, ended with RET.
361 With a prefix argument, ask for a wildcard, and search in file buffers
362 whose file names match the specified wildcard."
363 (interactive
364 (list (if current-prefix-arg
365 (multi-isearch-read-matching-files)
366 (multi-isearch-read-files))))
367 (let ((multi-isearch-next-buffer-function
368 'multi-isearch-next-file-buffer-from-list)
369 (multi-isearch-file-list (mapcar #'expand-file-name files)))
370 (find-file (car multi-isearch-file-list))
371 (goto-char (if isearch-forward (point-min) (point-max)))
372 (isearch-forward-regexp)))
375 (provide 'multi-isearch)
376 (provide 'misearch)
377 ;;; misearch.el ends here