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