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