1 ;;; locate.el --- interface to the locate command
3 ;; Copyright (C) 1996, 1998 Free Software Foundation, Inc.
5 ;; Author: Peter Breton <pbreton@cs.umb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;; Search a database of files and use dired commands on
30 ;;;;; Building a database of files ;;;;;;;;;
32 ;; You can create a simple files database with a port of the Unix find command
33 ;; and one of the various Windows NT various scheduling utilities,
34 ;; for example the AT command from the NT Resource Kit, WinCron which is
35 ;; included with Microsoft FrontPage, or the shareware NTCron program.
37 ;; To set up a function which searches the files database, do something
40 ;; (defvar locate-fcodes-file "c:/users/peter/fcodes")
41 ;; (defvar locate-make-command-line 'nt-locate-make-command-line)
43 ;; (defun nt-locate-make-command-line (arg)
44 ;; (list "grep" "-i" arg locate-fcodes-file))
46 ;;;;;;;; ADVICE For dired-make-relative: ;;;;;;;;;
48 ;; For certain dired commands to work right, you should also include the
49 ;; following in your _emacs/.emacs:
51 ;; (defadvice dired-make-relative (before set-no-error activate)
52 ;; "For locate mode and Windows, don't return errors"
53 ;; (if (and (eq major-mode 'locate-mode)
54 ;; (memq system-type (list 'windows-nt 'ms-dos)))
58 ;; Otherwise, `dired-make-relative' will give error messages like
59 ;; "FILENAME: not in directory tree growing at /"
63 ;; Locate.el provides an interface to a program which searches a
64 ;; database of file names. By default, this program is the GNU locate
65 ;; command, but it could also be the BSD-style find command, or even a
66 ;; user specified command.
68 ;; To use the BSD-style "fast find", or any other shell command of the
71 ;; SHELLPROGRAM Name-to-find
73 ;; set the variable `locate-command' in your .emacs file.
75 ;; To use a more complicated expression, create a function which
76 ;; takes a string (the name to find) as input and returns a list.
77 ;; The first element should be the command to be executed, the remaining
78 ;; elements should be the arguments (including the name to find). Then put
80 ;; (setq locate-make-command-line 'my-locate-command-line)
82 ;; in your .emacs, using the name of your function in place of
83 ;; my-locate-command-line.
85 ;; You should make sure that whichever command you use works correctly
86 ;; from a shell prompt. GNU locate and BSD find expect the file databases
87 ;; to either be in standard places or located via environment variables.
88 ;; If the latter, make sure these environment variables are set in
89 ;; your emacs process.
91 ;; Locate-mode assumes that each line output from the locate-command
92 ;; consists exactly of a file name, possibly preceded or trailed by
93 ;; whitespace. If your file database has other information on the line (for
94 ;; example, the file size), you will need to redefine the function
95 ;; `locate-get-file-positions' to return a list consisting of the first
96 ;; character in the file name and the last character in the file name.
98 ;; To use locate-mode, simply type M-x locate and then the string
99 ;; you wish to find. You can use almost all of the dired commands in
100 ;; the resulting *Locate* buffer. It is worth noting that your commands
101 ;; do not, of course, affect the file database. For example, if you
102 ;; compress a file in the locate buffer, the actual file will be
103 ;; compressed, but the entry in the file database will not be
104 ;; affected. Consequently, the database and the filesystem will be out
105 ;; of sync until the next time the database is updated.
107 ;; The command `locate-with-filter' keeps only lines matching a
108 ;; regular expression; this is often useful to constrain a big search.
118 (defvar locate-current-filter nil
)
121 "Interface to the locate command."
125 (defcustom locate-command
"locate"
126 "*The executable program used to search a database of files."
130 (defvar locate-history-list nil
131 "The history list used by the \\[locate] command.")
133 (defvar locate-grep-history-list nil
134 "The history list used by the \\[locate-with-filter] command.")
136 (defcustom locate-make-command-line
'locate-default-make-command-line
137 "*Function used to create the locate command line."
141 (defcustom locate-buffer-name
"*Locate*"
142 "*Name of the buffer to show results from the \\[locate] command."
146 (defcustom locate-fcodes-file nil
147 "*File name for the database of file names."
148 :type
'(choice file
(const nil
))
151 (defcustom locate-header-face nil
152 "*Face used to highlight the locate header."
156 (defcustom locate-update-command
"updatedb"
157 "The command used to update the locate database."
161 (defcustom locate-prompt-for-command nil
162 "If non-nil, the default behavior of the locate command is to prompt for a command to run.
163 Otherwise, that behavior is invoked via a prefix argument."
170 (defun locate-default-make-command-line (search-string)
171 (list locate-command search-string
))
174 (defun locate (arg search-string
&optional filter
)
175 "Run the program `locate', putting results in `*Locate*' buffer.
176 With prefix arg, prompt for the locate command to run."
180 (if (or (and current-prefix-arg
(not locate-prompt-for-command
))
181 (and (not current-prefix-arg
) locate-prompt-for-command
))
182 (read-from-minibuffer "Run locate command: "
183 nil nil nil
'locate-history-list
)
184 (read-from-minibuffer "Locate: " nil nil
185 nil
'locate-history-list
)
187 (let* ((locate-cmd-list (funcall locate-make-command-line search-string
))
188 (locate-cmd (car locate-cmd-list
))
189 (locate-cmd-args (cdr locate-cmd-list
))
191 (or (and arg
(not locate-prompt-for-command
))
192 (and (not arg
) locate-prompt-for-command
)))
195 ;; Find the Locate buffer
196 (save-window-excursion
197 (set-buffer (get-buffer-create locate-buffer-name
))
201 (setq locate-current-filter filter
)
203 (if run-locate-command
204 (shell-command search-string locate-buffer-name
)
205 (apply 'call-process locate-cmd nil t nil locate-cmd-args
))
208 (locate-filter-output filter
))
212 (and (not (string-equal (buffer-name) locate-buffer-name
))
213 (switch-to-buffer-other-window locate-buffer-name
))
215 (run-hooks 'locate-post-command-hook
)
220 (defun locate-with-filter (search-string filter
)
221 "Run the locate command with a filter.
223 The filter is a regular expression. Only results matching the filter are
224 shown; this is often useful to constrain a big search."
226 (list (read-from-minibuffer "Locate: " nil nil
227 nil
'locate-history-list
)
228 (read-from-minibuffer "Filter: " nil nil
229 nil
'locate-grep-history-list
)))
230 (locate nil search-string filter
))
232 (defun locate-filter-output (filter)
233 "Filter output from the locate command."
234 (goto-char (point-min))
235 (delete-non-matching-lines filter
))
237 (defvar locate-mode-map nil
238 "Local keymap for Locate mode buffers.")
244 (setq locate-mode-map
(copy-keymap dired-mode-map
))
246 ;; Undefine Useless Dired Menu bars
247 (define-key locate-mode-map
[menu-bar Dired
] 'undefined
)
248 (define-key locate-mode-map
[menu-bar subdir
] 'undefined
)
250 (define-key locate-mode-map
[menu-bar mark executables
] 'undefined
)
251 (define-key locate-mode-map
[menu-bar mark directory
] 'undefined
)
252 (define-key locate-mode-map
[menu-bar mark directories
] 'undefined
)
253 (define-key locate-mode-map
[menu-bar mark symlinks
] 'undefined
)
255 (define-key locate-mode-map
[mouse-2
] 'locate-mouse-view-file
)
256 (define-key locate-mode-map
"\C-c\C-t" 'locate-tags
)
258 (define-key locate-mode-map
"U" 'dired-unmark-all-files
)
259 (define-key locate-mode-map
"V" 'locate-find-directory
)
262 ;; This variable is used to indent the lines and then to search for
264 (defconst locate-filename-indentation
4
265 "The amount of indentation for each file.")
267 (defun locate-get-file-positions ()
273 ;; Assumes names end at the end of the line
274 (forward-char locate-filename-indentation
)
275 (list (point) eol
))))
278 (defun locate-current-line-number ()
279 "Return the current line number, as an integer."
280 (+ (count-lines (point-min) (point))
281 (if (eq (current-column) 0)
285 (defun locate-get-filename ()
286 (let ((pos (locate-get-file-positions))
287 (lineno (locate-current-line-number)))
288 (and (not (eq lineno
1))
290 (buffer-substring (elt pos
0) (elt pos
1)))))
292 (defun locate-mouse-view-file (event)
293 "In Locate mode, view a file, using the mouse."
296 (goto-char (posn-point (event-start event
)))
297 (view-file (locate-get-filename))))
299 ;; Define a mode for locate
300 ;; Default directory is set to "/" so that dired commands, which
301 ;; expect to be in a tree, will work properly
302 (defun locate-mode ()
303 "Major mode for the `*Locate*' buffer made by \\[locate]."
304 (kill-all-local-variables)
305 ;; Avoid clobbering this variables
306 (make-local-variable 'dired-subdir-alist
)
307 (use-local-map locate-mode-map
)
308 (setq major-mode
'locate-mode
310 default-directory
"/")
311 (dired-alist-add-1 default-directory
(point-min-marker))
312 (make-local-variable 'dired-move-to-filename-regexp
)
313 ;; This should support both Unix and Windoze style names
314 (setq dired-move-to-filename-regexp
316 (make-string (1- locate-filename-indentation
) ?\
)
317 "\\(/\\|[A-Za-z]:\\)"))
318 (make-local-variable 'dired-actual-switches
)
319 (setq dired-actual-switches
"")
320 (make-local-variable 'dired-permission-flags-regexp
)
321 (setq dired-permission-flags-regexp
323 (make-string (1- locate-filename-indentation
) ?\
)
325 (make-local-variable 'revert-buffer-function
)
326 (setq revert-buffer-function
'locate-update
)
327 (run-hooks 'locate-mode-hook
))
329 (defun locate-do-setup ()
330 (let ((search-string (car locate-history-list
)))
331 (goto-char (point-min))
334 ;; Nothing returned from locate command?
337 (kill-buffer locate-buffer-name
)
338 (if locate-current-filter
339 (error "Locate: no match for %s in database using filter %s"
340 search-string locate-current-filter
)
341 (error "Locate: no match for %s in database" search-string
))))
343 (locate-insert-header search-string
)
346 (insert-char ?\ locate-filename-indentation t
)
347 (locate-set-properties)
350 (defun locate-set-properties ()
352 (let ((pos (locate-get-file-positions)))
353 (dired-insert-set-properties (elt pos
0) (elt pos
1)))))
355 (defun locate-insert-header (search-string)
356 (let ((locate-format-string "Matches for %s")
358 (concat " *Matches for \\(" (regexp-quote search-string
) "\\)"))
359 (locate-format-args (list search-string
))
362 (and locate-fcodes-file
363 (setq locate-format-string
364 (concat locate-format-string
" in %s")
366 (concat locate-regexp-match
368 (regexp-quote locate-fcodes-file
)
371 (append (list locate-fcodes-file
) locate-format-args
)))
373 (and locate-current-filter
374 (setq locate-format-string
375 (concat locate-format-string
" using filter %s")
377 (concat locate-regexp-match
380 (regexp-quote locate-current-filter
)
383 (append (list locate-current-filter
) locate-format-args
)))
385 (setq locate-format-string
386 (concat locate-format-string
": \n\n")
388 (concat locate-regexp-match
": \n"))
390 (insert (apply 'format locate-format-string
(reverse locate-format-args
)))
393 (goto-char (point-min))
394 (if (not (looking-at locate-regexp-match
))
396 (add-text-properties (match-beginning 1) (match-end 1)
397 (list 'face locate-header-face
))
398 (and (match-beginning 2)
399 (add-text-properties (match-beginning 2) (match-end 2)
400 (list 'face locate-header-face
)))
401 (and (match-beginning 3)
402 (add-text-properties (match-beginning 3) (match-end 3)
403 (list 'face locate-header-face
)))
406 (defun locate-tags ()
407 "Visit a tags table in `*Locate*' mode."
409 (let ((tags-table (locate-get-filename)))
410 (and (y-or-n-p (format "Visit tags table %s? " tags-table
))
411 (visit-tags-table tags-table
))))
413 ;; From Stephen Eglen <stephen@cns.ed.ac.uk>
414 (defun locate-update (ignore1 ignore2
)
415 "Update the locate database.
416 Database is updated using the shell command in `locate-update-command'."
417 (let ((str (car locate-history-list
)))
418 (cond ((yes-or-no-p "Update locate database (may take a few seconds)? ")
419 (shell-command locate-update-command
)
422 ;;; Modified three functions from `dired.el':
423 ;;; dired-find-directory,
424 ;;; dired-find-directory-other-window
425 ;;; dired-get-filename
427 (defun locate-find-directory ()
428 "Visit the directory of the file mentioned on this line."
430 (let ((directory-name (locate-get-dirname)))
431 (if (file-directory-p directory-name
)
432 (find-file directory-name
)
433 (if (file-symlink-p directory-name
)
434 (error "Directory is a symlink to a nonexistent target")
435 (error "Directory no longer exists; run `updatedb' to update database")))))
437 (defun locate-find-directory-other-window ()
438 "Visit the directory of the file named on this line in other window."
440 (find-file-other-window (locate-get-dirname)))
442 (defun locate-get-dirname ()
443 "Return the directory name of the file mentioned on this line."
444 (let (file (filepos (locate-get-file-positions)))
445 (if (setq file
(buffer-substring (nth 0 filepos
) (nth 1 filepos
)))
447 ;; Get rid of the mouse-face property that file names have.
448 (set-text-properties 0 (length file
) nil file
)
449 (setq file
(file-name-directory file
))
450 ;; Unquote names quoted by ls or by dired-insert-directory.
451 ;; Using read to unquote is much faster than substituting
452 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
456 ;; some ls -b don't escape quotes, argh!
457 ;; This is not needed for GNU ls, though.
458 (or (dired-string-replace-match
459 "\\([^\\]\\|\\`\\)\"" file
"\\1\\\\\"" nil t
)
462 (and file buffer-file-coding-system
463 (not file-name-coding-system
)
464 (setq file
(encode-coding-string file buffer-file-coding-system
)))
467 ;; Only for GNU locate
468 (defun locate-in-alternate-database (search-string database
)
469 "Run the GNU locate command, using an alternate database."
474 (read-from-minibuffer "Locate: " nil nil
475 nil
'locate-history-list
))
476 (read-file-name "Locate using Database: " )
478 (or (file-exists-p database
)
479 (error "Database file %s does not exist" database
))
480 (let ((locate-make-command-line
481 (function (lambda (string)
483 (list (concat "--database="
484 (expand-file-name database
))
486 (locate nil search-string
)))
490 ;;; locate.el ends here