Commit | Line | Data |
---|---|---|
ec3476d0 | 1 | ;;; filecache.el --- find files using a pre-loaded cache |
6b279740 | 2 | ;; |
b662c4bc | 3 | ;; Author: Peter Breton <pbreton@cs.umb.edu> |
6b279740 | 4 | ;; Created: Sun Nov 10 1996 |
f5f727f8 | 5 | ;; Keywords: convenience |
6b279740 | 6 | ;; |
dea0a87d | 7 | ;; Copyright (C) 1996, 2000 Free Software Foundation, Inc. |
13161e8b RS |
8 | |
9 | ;; This file is part of GNU Emacs. | |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
6b279740 RS |
12 | ;; it under the terms of the GNU General Public License as published by |
13 | ;; the Free Software Foundation; either version 2, or (at your option) | |
14 | ;; any later version. | |
13161e8b RS |
15 | |
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
6b279740 | 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
13161e8b RS |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
19 | ;; GNU General Public License for more details. | |
20 | ||
6b279740 | 21 | ;; You should have received a copy of the GNU General Public License |
13161e8b RS |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
25 | ||
6b279740 RS |
26 | ;;; Commentary: |
27 | ;; | |
28 | ;; The file-cache package is an attempt to make it easy to locate files | |
29 | ;; by name, without having to remember exactly where they are located. | |
30 | ;; This is very handy when working with source trees. You can also add | |
31 | ;; frequently used files to the cache to create a hotlist effect. | |
32 | ;; The cache can be used with any interactive command which takes a | |
33 | ;; filename as an argument. | |
34 | ;; | |
35 | ;; It is worth noting that this package works best when most of the files | |
36 | ;; in the cache have unique names, or (if they have the same name) exist in | |
37 | ;; only a few directories. The worst case is many files all with | |
38 | ;; the same name and in different directories, for example a big source tree | |
39 | ;; with a Makefile in each directory. In such a case, you should probably | |
40 | ;; use an alternate strategy to find the files. | |
41 | ;; | |
42 | ;; ADDING FILES TO THE CACHE: | |
43 | ;; | |
44 | ;; Use the following functions to add items to the file cache: | |
24ccf465 | 45 | ;; |
6b279740 RS |
46 | ;; * `file-cache-add-file': Adds a single file to the cache |
47 | ;; | |
48 | ;; * `file-cache-add-file-list': Adds a list of files to the cache | |
49 | ;; | |
50 | ;; The following functions use the regular expressions in | |
51 | ;; `file-cache-delete-regexps' to eliminate unwanted files: | |
24ccf465 | 52 | ;; |
6b279740 RS |
53 | ;; * `file-cache-add-directory': Adds the files in a directory to the |
54 | ;; cache. You can also specify a regular expression to match the files | |
55 | ;; which should be added. | |
56 | ;; | |
57 | ;; * `file-cache-add-directory-list': Same as above, but acts on a list | |
58 | ;; of directories. You can use `load-path', `exec-path' and the like. | |
59 | ;; | |
60 | ;; * `file-cache-add-directory-using-find': Uses the `find' command to | |
61 | ;; add a directory tree to the cache. | |
62 | ;; | |
63 | ;; * `file-cache-add-directory-using-locate': Uses the `locate' command to | |
64 | ;; add files matching a pattern to the cache. | |
65 | ;; | |
57089611 PB |
66 | ;; * `file-cache-add-directory-recursively': Uses the find-lisp package to |
67 | ;; add all files matching a pattern to the cache. | |
68 | ;; | |
6b279740 RS |
69 | ;; Use the function `file-cache-clear-cache' to remove all items from the |
70 | ;; cache. There are a number of `file-cache-delete' functions provided | |
71 | ;; as well, but in general it is probably better to not worry too much | |
72 | ;; about extra files in the cache. | |
73 | ;; | |
74 | ;; The most convenient way to initialize the cache is with an | |
b662c4bc RS |
75 | ;; `eval-after-load' function, as noted in the ADDING FILES |
76 | ;; AUTOMATICALLY section. | |
6b279740 RS |
77 | ;; |
78 | ;; FINDING FILES USING THE CACHE: | |
79 | ;; | |
80 | ;; You can use the file-cache with any function that expects a filename as | |
81 | ;; an argument. For example: | |
82 | ;; | |
83 | ;; 1) Invoke a function which expects a filename as an argument: | |
84 | ;; M-x find-file | |
85 | ;; | |
86 | ;; 2) Begin typing a file name. | |
87 | ;; | |
88 | ;; 3) Invoke `file-cache-minibuffer-complete' (bound by default to | |
89 | ;; C-TAB) to complete on the filename using the cache. | |
90 | ;; | |
91 | ;; 4) When you have found a unique completion, the minibuffer contents | |
92 | ;; will change to the full name of that file. | |
24ccf465 | 93 | ;; |
6b279740 RS |
94 | ;; If there are a number of directories which contain the completion, |
95 | ;; invoking `file-cache-minibuffer-complete' repeatedly will cycle through | |
96 | ;; them. | |
97 | ;; | |
98 | ;; 5) You can then edit the minibuffer contents, or press RETURN. | |
99 | ;; | |
100 | ;; It is much easier to simply try it than trying to explain it :) | |
101 | ;; | |
b662c4bc | 102 | ;;; ADDING FILES AUTOMATICALLY |
6b279740 RS |
103 | ;; |
104 | ;; For maximum utility, you should probably define an `eval-after-load' | |
105 | ;; form which loads your favorite files: | |
106 | ;; | |
24ccf465 | 107 | ;; (eval-after-load |
6b279740 RS |
108 | ;; "filecache" |
109 | ;; '(progn | |
110 | ;; (message "Loading file cache...") | |
111 | ;; (file-cache-add-directory-using-find "~/projects") | |
112 | ;; (file-cache-add-directory-list load-path) | |
113 | ;; (file-cache-add-directory "~/") | |
114 | ;; (file-cache-add-file-list (list "~/foo/bar" "~/baz/bar")) | |
115 | ;; )) | |
116 | ;; | |
117 | ;; If you clear and reload the cache frequently, it is probably easiest | |
118 | ;; to put your initializations in a function: | |
119 | ;; | |
24ccf465 | 120 | ;; (eval-after-load |
6b279740 RS |
121 | ;; "filecache" |
122 | ;; '(my-file-cache-initialize)) | |
24ccf465 | 123 | ;; |
6b279740 RS |
124 | ;; (defun my-file-cache-initialize () |
125 | ;; (interactive) | |
126 | ;; (message "Loading file cache...") | |
127 | ;; (file-cache-add-directory-using-find "~/projects") | |
128 | ;; (file-cache-add-directory-list load-path) | |
129 | ;; (file-cache-add-directory "~/") | |
130 | ;; (file-cache-add-file-list (list "~/foo/bar" "~/baz/bar")) | |
131 | ;; )) | |
132 | ;; | |
133 | ;; Of course, you can still add files to the cache afterwards, via | |
134 | ;; Lisp functions. | |
135 | ;; | |
136 | ;; RELATED WORK: | |
24ccf465 | 137 | ;; |
6b279740 RS |
138 | ;; This package is a distant relative of Noah Friedman's fff utilities. |
139 | ;; Our goal is pretty similar, but the implementation strategies are | |
140 | ;; different. | |
13161e8b | 141 | |
6b279740 RS |
142 | ;;; Code: |
143 | ||
57089611 PB |
144 | (eval-when-compile |
145 | (require 'find-lisp)) | |
146 | ||
33933d45 AS |
147 | (defgroup file-cache nil |
148 | "Find files using a pre-loaded cache." | |
149 | :group 'files | |
f5f727f8 | 150 | :group 'convenience |
33933d45 AS |
151 | :prefix "file-cache-") |
152 | ||
6b279740 | 153 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
b662c4bc | 154 | ;; Customization Variables |
6b279740 RS |
155 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
156 | ||
157 | ;; User-modifiable variables | |
24ccf465 PB |
158 | (defcustom file-cache-filter-regexps |
159 | (list "~$" "\\.o$" "\\.exe$" "\\.a$" "\\.elc$" ",v$" "\\.output$" | |
0a162908 | 160 | "\\.$" "#$" "\\.class$") |
6b279740 RS |
161 | "*List of regular expressions used as filters by the file cache. |
162 | File names which match these expressions will not be added to the cache. | |
24ccf465 | 163 | Note that the functions `file-cache-add-file' and `file-cache-add-file-list' |
33933d45 AS |
164 | do not use this variable." |
165 | :type '(repeat regexp) | |
166 | :group 'file-cache) | |
6b279740 | 167 | |
33933d45 AS |
168 | (defcustom file-cache-find-command "find" |
169 | "*External program used by `file-cache-add-directory-using-find'." | |
170 | :type 'string | |
171 | :group 'file-cache) | |
6b279740 | 172 | |
6e74cce2 RS |
173 | (defcustom file-cache-find-command-posix-flag 'not-defined |
174 | "*Set to t, if `file-cache-find-command' handles wildcards POSIX style. | |
175 | This variable is automatically set to nil or non-nil | |
176 | if it has the initial value `not-defined' whenever you first | |
177 | call the `file-cache-add-directory-using-find'. | |
178 | ||
179 | Under Windows operating system where Cygwin is available, this value | |
180 | should be t." | |
181 | :type '(choice (const :tag "Yes" t) | |
182 | (const :tag "No" nil) | |
183 | (const :tag "Unknown" not-defined)) | |
184 | :group 'file-cache) | |
185 | ||
33933d45 AS |
186 | (defcustom file-cache-locate-command "locate" |
187 | "*External program used by `file-cache-add-directory-using-locate'." | |
188 | :type 'string | |
189 | :group 'file-cache) | |
6b279740 RS |
190 | |
191 | ;; Minibuffer messages | |
33933d45 AS |
192 | (defcustom file-cache-no-match-message " [File Cache: No match]" |
193 | "Message to display when there is no completion." | |
194 | :type 'string | |
195 | :group 'file-cache) | |
196 | ||
197 | (defcustom file-cache-sole-match-message " [File Cache: sole completion]" | |
198 | "Message to display when there is only one completion." | |
199 | :type 'string | |
200 | :group 'file-cache) | |
201 | ||
202 | (defcustom file-cache-non-unique-message | |
203 | " [File Cache: complete but not unique]" | |
204 | "Message to display when there is a non-unique completion." | |
205 | :type 'string | |
206 | :group 'file-cache) | |
6b279740 | 207 | |
24ccf465 | 208 | (defcustom file-cache-completion-ignore-case |
c60ee5e7 | 209 | (if (memq system-type (list 'ms-dos 'windows-nt 'cygwin)) |
24ccf465 PB |
210 | t |
211 | completion-ignore-case) | |
b047c9b7 GM |
212 | "If non-nil, file-cache completion should ignore case. |
213 | Defaults to the value of `completion-ignore-case'." | |
214 | :type 'sexp | |
215 | :group 'file-cache | |
216 | ) | |
217 | ||
24ccf465 | 218 | (defcustom file-cache-case-fold-search |
c60ee5e7 | 219 | (if (memq system-type (list 'ms-dos 'windows-nt 'cygwin)) |
24ccf465 PB |
220 | t |
221 | case-fold-search) | |
222 | "If non-nil, file-cache completion should ignore case. | |
223 | Defaults to the value of `case-fold-search'." | |
224 | :type 'sexp | |
225 | :group 'file-cache | |
226 | ) | |
227 | ||
3750be31 RS |
228 | (defcustom file-cache-ignore-case |
229 | (memq system-type (list 'ms-dos 'windows-nt 'cygwin)) | |
230 | "Non-nil means ignore case when checking completions in the file cache. | |
231 | Defaults to nil on DOS and Windows, and t on other systems." | |
24ccf465 PB |
232 | :type 'sexp |
233 | :group 'file-cache | |
234 | ) | |
235 | ||
6b279740 RS |
236 | (defvar file-cache-multiple-directory-message nil) |
237 | ||
238 | ;; Internal variables | |
239 | ;; This should be named *Completions* because that's what the function | |
240 | ;; switch-to-completions in simple.el expects | |
33933d45 AS |
241 | (defcustom file-cache-completions-buffer "*Completions*" |
242 | "Buffer to display completions when using the file cache." | |
243 | :type 'string | |
244 | :group 'file-cache) | |
245 | ||
24ccf465 | 246 | (defcustom file-cache-buffer "*File Cache*" |
33933d45 AS |
247 | "Buffer to hold the cache of file names." |
248 | :type 'string | |
249 | :group 'file-cache) | |
250 | ||
251 | (defcustom file-cache-buffer-default-regexp "^.+$" | |
252 | "Regexp to match files in `file-cache-buffer'." | |
253 | :type 'regexp | |
254 | :group 'file-cache) | |
6b279740 RS |
255 | |
256 | (defvar file-cache-last-completion nil) | |
257 | ||
258 | (defvar file-cache-alist nil | |
259 | "Internal data structure to hold cache of file names.") | |
260 | ||
261 | (defvar file-cache-completions-keymap nil | |
262 | "Keymap for file cache completions buffer.") | |
263 | ||
264 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
265 | ;; Functions to add files to the cache | |
266 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
267 | ||
268 | (defun file-cache-add-directory (directory &optional regexp) | |
269 | "Add DIRECTORY to the file cache. | |
24ccf465 | 270 | If the optional REGEXP argument is non-nil, only files which match it will |
6b279740 | 271 | be added to the cache." |
b662c4bc RS |
272 | (interactive "DAdd files from directory: ") |
273 | ;; Not an error, because otherwise we can't use load-paths that | |
274 | ;; contain non-existent directories. | |
275 | (if (not (file-accessible-directory-p directory)) | |
276 | (message "Directory %s does not exist" directory) | |
277 | (let* ((dir (expand-file-name directory)) | |
278 | (dir-files (directory-files dir t regexp)) | |
279 | ) | |
280 | ;; Filter out files we don't want to see | |
281 | (mapcar | |
282 | '(lambda (file) | |
6e74cce2 RS |
283 | (if (file-directory-p file) |
284 | (setq dir-files (delq file dir-files)) | |
285 | (mapcar | |
286 | '(lambda (regexp) | |
287 | (if (string-match regexp file) | |
288 | (setq dir-files (delq file dir-files)))) | |
289 | file-cache-filter-regexps))) | |
b662c4bc RS |
290 | dir-files) |
291 | (file-cache-add-file-list dir-files)))) | |
6b279740 RS |
292 | |
293 | (defun file-cache-add-directory-list (directory-list &optional regexp) | |
294 | "Add DIRECTORY-LIST (a list of directory names) to the file cache. | |
24ccf465 PB |
295 | If the optional REGEXP argument is non-nil, only files which match it |
296 | will be added to the cache. Note that the REGEXP is applied to the files | |
6b279740 RS |
297 | in each directory, not to the directory list itself." |
298 | (interactive "XAdd files from directory list: ") | |
24ccf465 | 299 | (mapcar |
6b279740 RS |
300 | '(lambda (dir) (file-cache-add-directory dir regexp)) |
301 | directory-list)) | |
302 | ||
303 | (defun file-cache-add-file-list (file-list) | |
304 | "Add FILE-LIST (a list of files names) to the file cache." | |
305 | (interactive "XFile List: ") | |
306 | (mapcar 'file-cache-add-file file-list)) | |
307 | ||
308 | ;; Workhorse function | |
309 | (defun file-cache-add-file (file) | |
310 | "Add FILE to the file cache." | |
311 | (interactive "fAdd File: ") | |
b662c4bc | 312 | (if (not (file-exists-p file)) |
bbc66b08 | 313 | (message "Filecache: file %s does not exist" file) |
b662c4bc RS |
314 | (let* ((file-name (file-name-nondirectory file)) |
315 | (dir-name (file-name-directory file)) | |
3750be31 RS |
316 | (the-entry (assoc-string |
317 | file-name file-cache-alist | |
318 | file-cache-ignore-case)) | |
b662c4bc RS |
319 | ) |
320 | ;; Does the entry exist already? | |
321 | (if the-entry | |
322 | (if (or (and (stringp (cdr the-entry)) | |
323 | (string= dir-name (cdr the-entry))) | |
324 | (and (listp (cdr the-entry)) | |
325 | (member dir-name (cdr the-entry)))) | |
326 | nil | |
327 | (setcdr the-entry (append (list dir-name) (cdr the-entry))) | |
328 | ) | |
329 | ;; If not, add it to the cache | |
330 | (setq file-cache-alist | |
24ccf465 | 331 | (cons (cons file-name (list dir-name)) |
b662c4bc RS |
332 | file-cache-alist))) |
333 | ))) | |
24ccf465 | 334 | |
6b279740 RS |
335 | (defun file-cache-add-directory-using-find (directory) |
336 | "Use the `find' command to add files to the file cache. | |
337 | Find is run in DIRECTORY." | |
338 | (interactive "DAdd files under directory: ") | |
339 | (let ((dir (expand-file-name directory))) | |
d9c1ce9d RS |
340 | (when (memq system-type '(windows-nt cygwin)) |
341 | (if (eq file-cache-find-command-posix-flag 'not-defined) | |
342 | (setq file-cache-find-command-posix-flag | |
343 | (executable-command-find-posix-p file-cache-find-command)))) | |
6b279740 RS |
344 | (set-buffer (get-buffer-create file-cache-buffer)) |
345 | (erase-buffer) | |
24ccf465 | 346 | (call-process file-cache-find-command nil |
6b279740 | 347 | (get-buffer file-cache-buffer) nil |
24ccf465 | 348 | dir "-name" |
da14d1ac RS |
349 | (if (memq system-type '(windows-nt cygwin)) |
350 | (if file-cache-find-command-posix-flag | |
351 | "\\*" | |
352 | "'*'") | |
353 | "*") | |
6b279740 RS |
354 | "-print") |
355 | (file-cache-add-from-file-cache-buffer))) | |
356 | ||
357 | (defun file-cache-add-directory-using-locate (string) | |
358 | "Use the `locate' command to add files to the file cache. | |
359 | STRING is passed as an argument to the locate command." | |
360 | (interactive "sAdd files using locate string: ") | |
361 | (set-buffer (get-buffer-create file-cache-buffer)) | |
362 | (erase-buffer) | |
24ccf465 | 363 | (call-process file-cache-locate-command nil |
6b279740 RS |
364 | (get-buffer file-cache-buffer) nil |
365 | string) | |
366 | (file-cache-add-from-file-cache-buffer)) | |
367 | ||
57089611 PB |
368 | (defun file-cache-add-directory-recursively (dir &optional regexp) |
369 | "Adds DIR and any subdirectories to the file-cache. | |
370 | This function does not use any external programs | |
371 | If the optional REGEXP argument is non-nil, only files which match it | |
372 | will be added to the cache. Note that the REGEXP is applied to the files | |
373 | in each directory, not to the directory list itself." | |
374 | (interactive "DAdd directory: ") | |
375 | (require 'find-lisp) | |
376 | (mapcar | |
377 | (function | |
378 | (lambda(file) | |
379 | (or (file-directory-p file) | |
380 | (let (filtered) | |
381 | (mapcar | |
382 | (function | |
383 | (lambda(regexp) | |
384 | (and (string-match regexp file) | |
385 | (setq filtered t)) | |
386 | )) | |
387 | file-cache-filter-regexps) | |
388 | filtered) | |
389 | (file-cache-add-file file)))) | |
390 | (find-lisp-find-files dir (if regexp regexp "^")))) | |
391 | ||
6b279740 RS |
392 | (defun file-cache-add-from-file-cache-buffer (&optional regexp) |
393 | "Add any entries found in the file cache buffer. | |
394 | Each entry matches the regular expression `file-cache-buffer-default-regexp' | |
395 | or the optional REGEXP argument." | |
396 | (set-buffer file-cache-buffer) | |
24ccf465 | 397 | (mapcar |
6b279740 RS |
398 | (function (lambda (elt) |
399 | (goto-char (point-min)) | |
400 | (delete-matching-lines elt))) | |
401 | file-cache-filter-regexps) | |
402 | (goto-char (point-min)) | |
403 | (let ((full-filename)) | |
404 | (while (re-search-forward | |
24ccf465 | 405 | (or regexp file-cache-buffer-default-regexp) |
6b279740 RS |
406 | (point-max) t) |
407 | (setq full-filename (buffer-substring-no-properties | |
24ccf465 | 408 | (match-beginning 0) (match-end 0))) |
6b279740 RS |
409 | (file-cache-add-file full-filename)))) |
410 | ||
411 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
412 | ;; Functions to delete from the cache | |
413 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
414 | ||
415 | (defun file-cache-clear-cache () | |
416 | "Clear the file cache." | |
417 | (interactive) | |
418 | (setq file-cache-alist nil)) | |
419 | ||
420 | ;; This clears *all* files with the given name | |
421 | (defun file-cache-delete-file (file) | |
422 | "Delete FILE from the file cache." | |
423 | (interactive | |
424 | (list (completing-read "Delete file from cache: " file-cache-alist))) | |
24ccf465 | 425 | (setq file-cache-alist |
3750be31 | 426 | (delq (assoc-string file file-cache-alist file-cache-ignore-case) |
24ccf465 | 427 | file-cache-alist))) |
6b279740 RS |
428 | |
429 | (defun file-cache-delete-file-list (file-list) | |
430 | "Delete FILE-LIST (a list of files) from the file cache." | |
431 | (interactive "XFile List: ") | |
432 | (mapcar 'file-cache-delete-file file-list)) | |
433 | ||
434 | (defun file-cache-delete-file-regexp (regexp) | |
435 | "Delete files matching REGEXP from the file cache." | |
436 | (interactive "sRegexp: ") | |
437 | (let ((delete-list)) | |
24ccf465 | 438 | (mapcar '(lambda (elt) |
6b279740 RS |
439 | (and (string-match regexp (car elt)) |
440 | (setq delete-list (cons (car elt) delete-list)))) | |
441 | file-cache-alist) | |
442 | (file-cache-delete-file-list delete-list) | |
bbc66b08 EZ |
443 | (message "Filecache: deleted %d files from file cache" |
444 | (length delete-list)))) | |
6b279740 RS |
445 | |
446 | (defun file-cache-delete-directory (directory) | |
447 | "Delete DIRECTORY from the file cache." | |
448 | (interactive "DDelete directory from file cache: ") | |
449 | (let ((dir (expand-file-name directory)) | |
450 | (result 0)) | |
24ccf465 PB |
451 | (mapcar |
452 | '(lambda (entry) | |
6b279740 RS |
453 | (if (file-cache-do-delete-directory dir entry) |
454 | (setq result (1+ result)))) | |
455 | file-cache-alist) | |
456 | (if (zerop result) | |
bbc66b08 EZ |
457 | (error "Filecache: no entries containing %s found in cache" directory) |
458 | (message "Filecache: deleted %d entries" result)))) | |
6b279740 RS |
459 | |
460 | (defun file-cache-do-delete-directory (dir entry) | |
461 | (let ((directory-list (cdr entry)) | |
462 | (directory (file-cache-canonical-directory dir)) | |
463 | ) | |
464 | (and (member directory directory-list) | |
465 | (if (equal 1 (length directory-list)) | |
24ccf465 | 466 | (setq file-cache-alist |
6b279740 RS |
467 | (delq entry file-cache-alist)) |
468 | (setcdr entry (delete directory directory-list))) | |
469 | ) | |
470 | )) | |
471 | ||
472 | (defun file-cache-delete-directory-list (directory-list) | |
473 | "Delete DIRECTORY-LIST (a list of directories) from the file cache." | |
474 | (interactive "XDirectory List: ") | |
475 | (mapcar 'file-cache-delete-directory directory-list)) | |
476 | ||
477 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
478 | ;; Utility functions | |
479 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
480 | ||
481 | ;; Returns the name of a directory for a file in the cache | |
482 | (defun file-cache-directory-name (file) | |
3750be31 RS |
483 | (let* ((directory-list (cdr (assoc-string |
484 | file file-cache-alist | |
485 | file-cache-ignore-case))) | |
6b279740 RS |
486 | (len (length directory-list)) |
487 | (directory) | |
488 | (num) | |
489 | ) | |
490 | (if (not (listp directory-list)) | |
bbc66b08 | 491 | (error "Filecache: unknown type in file-cache-alist for key %s" file)) |
24ccf465 | 492 | (cond |
6b279740 RS |
493 | ;; Single element |
494 | ((eq 1 len) | |
495 | (setq directory (elt directory-list 0))) | |
496 | ;; No elements | |
497 | ((eq 0 len) | |
bbc66b08 | 498 | (error "Filecache: no directory found for key %s" file)) |
6b279740 RS |
499 | ;; Multiple elements |
500 | (t | |
dea0a87d | 501 | (let* ((minibuffer-dir (file-name-directory (minibuffer-contents))) |
6b279740 RS |
502 | (dir-list (member minibuffer-dir directory-list)) |
503 | ) | |
504 | (setq directory | |
505 | ;; If the directory is in the list, return the next element | |
506 | ;; Otherwise, return the first element | |
24ccf465 PB |
507 | (if dir-list |
508 | (or (elt directory-list | |
6b279740 RS |
509 | (setq num (1+ (- len (length dir-list))))) |
510 | (elt directory-list (setq num 0))) | |
511 | (elt directory-list (setq num 0)))) | |
512 | ) | |
513 | ) | |
514 | ) | |
515 | ;; If there were multiple directories, set up a minibuffer message | |
516 | (setq file-cache-multiple-directory-message | |
517 | (and num (format " [%d of %d]" (1+ num) len))) | |
518 | directory)) | |
519 | ||
520 | ;; Returns the name of a file in the cache | |
521 | (defun file-cache-file-name (file) | |
522 | (let ((directory (file-cache-directory-name file))) | |
523 | (concat directory file))) | |
24ccf465 | 524 | |
6b279740 RS |
525 | ;; Return a canonical directory for comparison purposes. |
526 | ;; Such a directory ends with a forward slash. | |
527 | (defun file-cache-canonical-directory (dir) | |
528 | (let ((directory dir)) | |
529 | (if (not (char-equal ?/ (string-to-char (substring directory -1)))) | |
530 | (concat directory "/") | |
531 | directory))) | |
532 | ||
533 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
534 | ;; Minibuffer functions | |
535 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
536 | ||
13161e8b RS |
537 | ;; The prefix argument works around a bug in the minibuffer completion. |
538 | ;; The completion function doesn't distinguish between the states: | |
24ccf465 | 539 | ;; |
13161e8b RS |
540 | ;; "Multiple completions of name" (eg, Makefile, Makefile.in) |
541 | ;; "Name available in multiple directories" (/tmp/Makefile, ~me/Makefile) | |
24ccf465 | 542 | ;; |
13161e8b RS |
543 | ;; The default is to do the former; a prefix arg forces the latter. |
544 | ||
6b279740 | 545 | ;;;###autoload |
13161e8b RS |
546 | (defun file-cache-minibuffer-complete (arg) |
547 | "Complete a filename in the minibuffer using a preloaded cache. | |
548 | Filecache does two kinds of substitution: it completes on names in | |
549 | the cache, and, once it has found a unique name, it cycles through | |
24ccf465 PB |
550 | the directories that the name is available in. With a prefix argument, |
551 | the name is considered already unique; only the second substitution | |
13161e8b | 552 | \(directories) is done." |
24ccf465 PB |
553 | (interactive "P") |
554 | (let* | |
6b279740 | 555 | ( |
b047c9b7 | 556 | (completion-ignore-case file-cache-completion-ignore-case) |
24ccf465 | 557 | (case-fold-search file-cache-case-fold-search) |
dea0a87d | 558 | (string (file-name-nondirectory (minibuffer-contents))) |
13161e8b | 559 | (completion-string (try-completion string file-cache-alist)) |
6b279740 RS |
560 | (completion-list) |
561 | (len) | |
562 | (file-cache-string) | |
563 | ) | |
24ccf465 | 564 | (cond |
13161e8b RS |
565 | ;; If it's the only match, replace the original contents |
566 | ((or arg (eq completion-string t)) | |
567 | (setq file-cache-string (file-cache-file-name string)) | |
dea0a87d | 568 | (if (string= file-cache-string (minibuffer-contents)) |
13161e8b | 569 | (file-cache-temp-minibuffer-message file-cache-sole-match-message) |
dea0a87d | 570 | (delete-minibuffer-contents) |
add91c7b | 571 | (insert file-cache-string) |
13161e8b | 572 | (if file-cache-multiple-directory-message |
24ccf465 | 573 | (file-cache-temp-minibuffer-message |
13161e8b RS |
574 | file-cache-multiple-directory-message)) |
575 | )) | |
576 | ||
6b279740 RS |
577 | ;; If it's the longest match, insert it |
578 | ((stringp completion-string) | |
579 | ;; If we've already inserted a unique string, see if the user | |
580 | ;; wants to use that one | |
581 | (if (and (string= string completion-string) | |
3750be31 RS |
582 | (assoc-string string file-cache-alist |
583 | file-cache-ignore-case)) | |
6b279740 RS |
584 | (if (and (eq last-command this-command) |
585 | (string= file-cache-last-completion completion-string)) | |
24ccf465 | 586 | (progn |
dea0a87d | 587 | (delete-minibuffer-contents) |
add91c7b | 588 | (insert (file-cache-file-name completion-string)) |
6b279740 RS |
589 | (setq file-cache-last-completion nil) |
590 | ) | |
591 | (file-cache-temp-minibuffer-message file-cache-non-unique-message) | |
592 | (setq file-cache-last-completion string) | |
593 | ) | |
594 | (setq file-cache-last-completion string) | |
595 | (setq completion-list (all-completions string file-cache-alist) | |
596 | len (length completion-list)) | |
597 | (if (> len 1) | |
598 | (progn | |
599 | (goto-char (point-max)) | |
add91c7b | 600 | (insert |
6b279740 RS |
601 | (substring completion-string (length string))) |
602 | ;; Add our own setup function to the Completions Buffer | |
603 | (let ((completion-setup-hook | |
24ccf465 | 604 | (reverse |
6b279740 RS |
605 | (append (list 'file-cache-completion-setup-function) |
606 | completion-setup-hook))) | |
607 | ) | |
608 | (with-output-to-temp-buffer file-cache-completions-buffer | |
609 | (display-completion-list completion-list)) | |
610 | ) | |
611 | ) | |
612 | (setq file-cache-string (file-cache-file-name completion-string)) | |
dea0a87d | 613 | (if (string= file-cache-string (minibuffer-contents)) |
24ccf465 | 614 | (file-cache-temp-minibuffer-message |
13161e8b | 615 | file-cache-sole-match-message) |
dea0a87d | 616 | (delete-minibuffer-contents) |
add91c7b | 617 | (insert file-cache-string) |
6b279740 | 618 | (if file-cache-multiple-directory-message |
24ccf465 | 619 | (file-cache-temp-minibuffer-message |
6b279740 RS |
620 | file-cache-multiple-directory-message))) |
621 | ))) | |
24ccf465 | 622 | |
6b279740 RS |
623 | ;; No match |
624 | ((eq completion-string nil) | |
625 | (file-cache-temp-minibuffer-message file-cache-no-match-message)) | |
626 | ) | |
627 | )) | |
628 | ||
629 | ;; Lifted from "complete.el" | |
630 | (defun file-cache-temp-minibuffer-message (msg) | |
631 | "A Lisp version of `temp_minibuffer_message' from minibuf.c." | |
632 | (let ((savemax (point-max))) | |
633 | (save-excursion | |
634 | (goto-char (point-max)) | |
635 | (insert msg)) | |
636 | (let ((inhibit-quit t)) | |
637 | (sit-for 2) | |
638 | (delete-region savemax (point-max)) | |
639 | (if quit-flag | |
640 | (setq quit-flag nil | |
641 | unread-command-events (list 7)))))) | |
642 | ||
643 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
644 | ;; Completion functions | |
645 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
646 | ||
647 | (defun file-cache-completion-setup-function () | |
648 | (set-buffer file-cache-completions-buffer) | |
649 | ||
650 | (if file-cache-completions-keymap | |
651 | nil | |
24ccf465 | 652 | (setq file-cache-completions-keymap |
6b279740 | 653 | (copy-keymap completion-list-mode-map)) |
24ccf465 PB |
654 | (define-key file-cache-completions-keymap [mouse-2] |
655 | 'file-cache-mouse-choose-completion) | |
656 | (define-key file-cache-completions-keymap "\C-m" | |
6b279740 RS |
657 | 'file-cache-choose-completion)) |
658 | ||
659 | (use-local-map file-cache-completions-keymap) | |
660 | ) | |
661 | ||
662 | (defun file-cache-choose-completion () | |
663 | "Choose a completion in the `*Completions*' buffer." | |
664 | (interactive) | |
665 | (let ((completion-no-auto-exit t)) | |
666 | (choose-completion) | |
667 | (select-window (active-minibuffer-window)) | |
13161e8b | 668 | (file-cache-minibuffer-complete nil) |
6b279740 RS |
669 | ) |
670 | ) | |
671 | ||
672 | (defun file-cache-mouse-choose-completion (event) | |
673 | "Choose a completion with the mouse." | |
674 | (interactive "e") | |
675 | (let ((completion-no-auto-exit t)) | |
676 | (mouse-choose-completion event) | |
677 | (select-window (active-minibuffer-window)) | |
13161e8b | 678 | (file-cache-minibuffer-complete nil) |
6b279740 RS |
679 | ) |
680 | ) | |
681 | ||
57089611 PB |
682 | (defun file-cache-complete () |
683 | "Complete the word at point, using the filecache." | |
684 | (interactive) | |
685 | (let (start pattern completion all) | |
686 | (save-excursion | |
687 | (skip-syntax-backward "^\"") | |
688 | (setq start (point))) | |
689 | (setq pattern (buffer-substring-no-properties start (point))) | |
690 | (setq completion (try-completion pattern file-cache-alist)) | |
691 | (setq all (all-completions pattern file-cache-alist nil)) | |
692 | (cond ((eq completion t)) | |
693 | ((null completion) | |
694 | (message "Can't find completion for \"%s\"" pattern) | |
695 | (ding)) | |
696 | ((not (string= pattern completion)) | |
697 | (delete-region start (point)) | |
698 | (insert completion) | |
699 | ) | |
700 | (t | |
701 | (with-output-to-temp-buffer "*Completions*" | |
702 | (display-completion-list all)) | |
703 | )) | |
704 | )) | |
705 | ||
b047c9b7 GM |
706 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
707 | ;; Show parts of the cache | |
708 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
709 | ||
710 | (defun file-cache-files-matching-internal (regexp) | |
711 | "Output a list of files whose names (not including directories) | |
712 | match REGEXP." | |
713 | (let ((results)) | |
714 | (mapcar | |
715 | (function | |
716 | (lambda(cache-element) | |
717 | (and (string-match regexp | |
718 | (elt cache-element 0)) | |
719 | (if results | |
720 | (nconc results (list (elt cache-element 0))) | |
721 | (setq results (list (elt cache-element 0))))))) | |
722 | file-cache-alist) | |
723 | results)) | |
724 | ||
725 | (defun file-cache-files-matching (regexp) | |
726 | "Output a list of files whose names (not including directories) | |
727 | match REGEXP." | |
728 | (interactive "sFind files matching regexp: ") | |
24ccf465 | 729 | (let ((results |
b047c9b7 GM |
730 | (file-cache-files-matching-internal regexp)) |
731 | buf) | |
24ccf465 PB |
732 | (set-buffer |
733 | (setq buf (get-buffer-create | |
b047c9b7 GM |
734 | "*File Cache Files Matching*"))) |
735 | (erase-buffer) | |
736 | (insert | |
737 | (mapconcat | |
738 | 'identity | |
739 | results | |
740 | "\n")) | |
741 | (goto-char (point-min)) | |
742 | (display-buffer buf))) | |
743 | ||
6b279740 RS |
744 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
745 | ;; Debugging functions | |
746 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
747 | ||
748 | (defun file-cache-debug-read-from-minibuffer (file) | |
749 | "Debugging function." | |
24ccf465 | 750 | (interactive |
6b279740 | 751 | (list (completing-read "File Cache: " file-cache-alist))) |
3750be31 RS |
752 | (message "%s" (assoc-string file file-cache-alist |
753 | file-cache-ignore-case)) | |
6b279740 RS |
754 | ) |
755 | ||
57089611 PB |
756 | (defun file-cache-display () |
757 | "Display the file cache." | |
758 | (interactive) | |
759 | (let ((buf "*File Cache Contents*")) | |
760 | (with-current-buffer | |
761 | (get-buffer-create buf) | |
762 | (erase-buffer) | |
763 | (mapcar | |
764 | (function | |
765 | (lambda(item) | |
766 | (insert (nth 1 item) (nth 0 item) "\n"))) | |
767 | file-cache-alist) | |
768 | (pop-to-buffer buf) | |
769 | ))) | |
770 | ||
6b279740 RS |
771 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
772 | ;; Keybindings | |
773 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | |
774 | ||
775 | ;;;###autoload (define-key minibuffer-local-completion-map [C-tab] 'file-cache-minibuffer-complete) | |
776 | ;;;###autoload (define-key minibuffer-local-map [C-tab] 'file-cache-minibuffer-complete) | |
777 | ;;;###autoload (define-key minibuffer-local-must-match-map [C-tab] 'file-cache-minibuffer-complete) | |
778 | ||
779 | (provide 'filecache) | |
780 | ||
ab5796a9 | 781 | ;;; arch-tag: 433d3ca4-4af2-47ce-b2cf-1f727460f538 |
6b279740 | 782 | ;;; filecache.el ends here |