1 ;;; locate.el --- interface to the locate command
3 ;; Copyright (C) 1996, 1998, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Peter Breton <pbreton@cs.umb.edu>
7 ;; Keywords: unix files
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; Search a database of files and use dired commands on the result.
30 ;; Locate.el provides an interface to a program which searches a
31 ;; database of file names. By default, this program is the GNU locate
32 ;; command, but it could also be the BSD-style find command, or even a
33 ;; user specified command.
35 ;; To use the BSD-style "fast find", or any other shell command of the
38 ;; SHELLPROGRAM Name-to-find
40 ;; set the variable `locate-command' in your .emacs file.
42 ;; To use a more complicated expression, create a function which
43 ;; takes a string (the name to find) as input and returns a list.
44 ;; The first element should be the command to be executed, the remaining
45 ;; elements should be the arguments (including the name to find). Then put
47 ;; (setq locate-make-command-line 'my-locate-command-line)
49 ;; in your .emacs, using the name of your function in place of
50 ;; my-locate-command-line.
52 ;; You should make sure that whichever command you use works correctly
53 ;; from a shell prompt. GNU locate and BSD find expect the file databases
54 ;; to either be in standard places or located via environment variables.
55 ;; If the latter, make sure these environment variables are set in
56 ;; your emacs process.
58 ;; Locate-mode assumes that each line output from the locate-command
59 ;; consists exactly of a file name, possibly preceded or trailed by
60 ;; whitespace. If your file database has other information on the line (for
61 ;; example, the file size), you will need to redefine the function
62 ;; `locate-get-file-positions' to return a list consisting of the first
63 ;; character in the file name and the last character in the file name.
65 ;; To use locate-mode, simply type M-x locate and then the string
66 ;; you wish to find. You can use almost all of the dired commands in
67 ;; the resulting *Locate* buffer. It is worth noting that your commands
68 ;; do not, of course, affect the file database. For example, if you
69 ;; compress a file in the locate buffer, the actual file will be
70 ;; compressed, but the entry in the file database will not be
71 ;; affected. Consequently, the database and the filesystem will be out
72 ;; of sync until the next time the database is updated.
74 ;; The command `locate-with-filter' keeps only lines matching a
75 ;; regular expression; this is often useful to constrain a big search.
78 ;;;;; Building a database of files ;;;;;;;;;
80 ;; You can create a simple files database with a port of the Unix find command
81 ;; and one of the various Windows NT various scheduling utilities,
82 ;; for example the AT command from the NT Resource Kit, WinCron which is
83 ;; included with Microsoft FrontPage, or the shareware NTCron program.
85 ;; To set up a function which searches the files database, do something
88 ;; (defvar locate-fcodes-file "c:/users/peter/fcodes")
89 ;; (defvar locate-make-command-line 'nt-locate-make-command-line)
91 ;; (defun nt-locate-make-command-line (arg)
92 ;; (list "grep" "-i" arg locate-fcodes-file))
94 ;;;;;;;; ADVICE For dired-make-relative: ;;;;;;;;;
96 ;; For certain dired commands to work right, you should also include the
97 ;; following in your _emacs/.emacs:
99 ;; (defadvice dired-make-relative (before set-no-error activate)
100 ;; "For locate mode and Windows, don't return errors"
101 ;; (if (and (eq major-mode 'locate-mode)
102 ;; (memq system-type (list 'windows-nt 'ms-dos)))
106 ;; Otherwise, `dired-make-relative' will give error messages like
107 ;; "FILENAME: not in directory tree growing at /"
117 (defvar locate-current-filter nil
)
118 (defvar locate-local-filter nil
)
119 (defvar locate-local-search nil
)
120 (defvar locate-local-prompt nil
)
123 "Interface to the locate command."
127 (defcustom locate-command
"locate"
128 "Executable program for searching a database of files.
129 The Emacs commands `locate' and `locate-with-filter' use this.
130 The value should be a program that can be called from a shell
131 with one argument, SEARCH-STRING. The program determines which
132 database it searches. The output of the program should consist
133 of those file names in the database that match SEARCH-STRING,
134 listed one per line, possibly with leading or trailing
135 whitespace. If the output is in another form, you may have to
136 redefine the function `locate-get-file-positions'.
138 The program may interpret SEARCH-STRING as a literal string, a
139 shell pattern or a regular expression. The exact rules of what
140 constitutes a match may also depend on the program.
142 The standard value of this variable is \"locate\".
143 This program normally searches a database of all files on your
144 system, or of all files that you have access to. Consult the
145 documentation of that program for the details about how it determines
146 which file names match SEARCH-STRING. (Those details vary highly with
151 (defvar locate-history-list nil
152 "The history list used by the \\[locate] command.")
154 (defvar locate-grep-history-list nil
155 "The history list used by the \\[locate-with-filter] command.")
157 (defcustom locate-make-command-line
'locate-default-make-command-line
158 "Function used to create the locate command line.
159 The Emacs commands `locate' and `locate-with-filter' use this.
160 This function should take one argument, a string (the name to find)
161 and return a list of strings. The first element of the list should be
162 the name of a command to be executed by a shell, the remaining elements
163 should be the arguments to that command (including the name to find)."
167 (defcustom locate-buffer-name
"*Locate*"
168 "Name of the buffer to show results from the \\[locate] command."
172 (defcustom locate-fcodes-file nil
173 "File name for the database of file names used by `locate'.
174 If non-nil, `locate' uses this name in the header of the `*Locate*'
175 buffer. If nil, it mentions no file name in that header.
177 Just setting this variable does not actually change the database
178 that `locate' searches. The executive program that the Emacs
179 function `locate' uses, as given by the variables `locate-command'
180 or `locate-make-command-line', determines the database."
181 :type
'(choice (const :tag
"None" nil
) file
)
184 (defcustom locate-header-face nil
185 "Face used to highlight the locate header."
186 :type
'(choice (const :tag
"None" nil
) face
)
190 (defcustom locate-ls-subdir-switches
"-al"
191 "`ls' switches for inserting subdirectories in `*Locate*' buffers.
192 This should contain the \"-l\" switch, but not the \"-F\" or \"-b\" switches."
197 (defcustom locate-update-when-revert nil
198 "This option affects how the *Locate* buffer gets reverted.
199 If non-nil, offer to update the locate database when reverting that buffer.
200 \(Normally, you need to have root privileges for this to work. See the
201 option `locate-update-path'.)
202 If nil, reverting does not update the locate database."
207 (defcustom locate-update-command
"updatedb"
208 "The executable program used to update the locate database."
212 (defcustom locate-update-path
"/"
213 "The default directory from where `locate-update-command' is called.
214 Usually, root permissions are required to run that command. This
215 can be achieved by setting this option to \"/su::\" or \"/sudo::\"
216 \(if you have the appropriate authority). If your current user
217 permissions are sufficient to run the command, you can set this
223 (defcustom locate-prompt-for-command nil
224 "If non-nil, the `locate' command prompts for a command to run.
225 Otherwise, that behavior is invoked via a prefix argument.
227 Setting this option non-nil actually inverts the meaning of a prefix arg;
228 that is, with a prefix arg, you get the default behavior."
234 (defun locate-default-make-command-line (search-string)
235 (list locate-command search-string
))
237 (defun locate-word-at-point ()
239 (buffer-substring-no-properties
241 (skip-chars-backward "-a-zA-Z0-9.")
244 (skip-chars-forward "-a-zA-Z0-9.")
245 (skip-chars-backward "." pt
)
248 ;; Function for use in interactive declarations.
249 (defun locate-prompt-for-search-string ()
250 (if (or (and current-prefix-arg
251 (not locate-prompt-for-command
))
252 (and (not current-prefix-arg
) locate-prompt-for-command
))
253 (let ((locate-cmd (funcall locate-make-command-line
"")))
254 (read-from-minibuffer
255 "Run locate (like this): "
257 (concat (car locate-cmd
) " "
258 (mapconcat 'identity
(cdr locate-cmd
) " "))
259 (+ 2 (length (car locate-cmd
))))
260 nil nil
'locate-history-list
))
261 (let* ((default (locate-word-at-point))
263 (read-from-minibuffer
264 (if (> (length default
) 0)
265 (format "Locate (default %s): " default
)
267 nil nil nil
'locate-history-list default t
)))
268 (and (equal input
"") default
269 (setq input default
))
273 (defun locate (search-string &optional filter arg
)
274 "Run the program `locate', putting results in `*Locate*' buffer.
275 Pass it SEARCH-STRING as argument. Interactively, prompt for SEARCH-STRING.
276 With prefix arg, prompt for the exact shell command to run instead.
278 This program searches for those file names in a database that match
279 SEARCH-STRING and normally outputs all matching absolute file names,
280 one per line. The database normally consists of all files on your
281 system, or of all files that you have access to. Consult the
282 documentation of the program for the details about how it determines
283 which file names match SEARCH-STRING. (Those details vary highly with
286 You can specify another program for this command to run by customizing
287 the variables `locate-command' or `locate-make-command-line'.
289 The main use of FILTER is to implement `locate-with-filter'. See
290 the docstring of that function for its meaning.
292 ARG is the interactive prefix arg."
295 (locate-prompt-for-search-string)
299 (if (equal search-string
"")
300 (error "Please specify a filename to search for"))
301 (let* ((locate-cmd-list (funcall locate-make-command-line search-string
))
302 (locate-cmd (car locate-cmd-list
))
303 (locate-cmd-args (cdr locate-cmd-list
))
305 (or (and arg
(not locate-prompt-for-command
))
306 (and (not arg
) locate-prompt-for-command
)))
309 ;; Find the Locate buffer
310 (save-window-excursion
311 (set-buffer (get-buffer-create locate-buffer-name
))
313 (let ((inhibit-read-only t
)
314 (buffer-undo-list t
))
317 (setq locate-current-filter filter
)
318 (set (make-local-variable 'locate-local-search
) search-string
)
319 (set (make-local-variable 'locate-local-filter
) filter
)
320 (set (make-local-variable 'locate-local-prompt
) run-locate-command
)
322 (if run-locate-command
323 (shell-command search-string locate-buffer-name
)
324 (apply 'call-process locate-cmd nil t nil locate-cmd-args
))
327 (locate-filter-output filter
))
329 (locate-do-setup search-string
)
331 (and (not (string-equal (buffer-name) locate-buffer-name
))
332 (switch-to-buffer-other-window locate-buffer-name
))
334 (run-hooks 'dired-mode-hook
)
335 (dired-next-line 3) ;move to first matching file.
336 (run-hooks 'locate-post-command-hook
)
341 (defun locate-with-filter (search-string filter
&optional arg
)
342 "Run the executable program `locate' with a filter.
343 This function is similar to the function `locate', which see.
344 The difference is that, when invoked interactively, the present function
345 prompts for both SEARCH-STRING and FILTER. It passes SEARCH-STRING
346 to the locate executable program. It produces a `*Locate*' buffer
347 that lists only those lines in the output of the locate program that
348 contain a match for the regular expression FILTER; this is often useful
349 to constrain a big search.
351 ARG is the interactive prefix arg, which has the same effect as in `locate'.
353 When called from Lisp, this function is identical with `locate',
354 except that FILTER is not optional."
357 (locate-prompt-for-search-string)
358 (read-from-minibuffer "Filter: " nil nil
359 nil
'locate-grep-history-list
)
361 (locate search-string filter arg
))
363 (defun locate-filter-output (filter)
364 "Filter output from the locate command."
365 (goto-char (point-min))
368 (defvar locate-mode-map nil
369 "Local keymap for Locate mode buffers.")
375 (setq locate-mode-map
(copy-keymap dired-mode-map
))
377 ;; Undefine Useless Dired Menu bars
378 (define-key locate-mode-map
[menu-bar Dired
] 'undefined
)
379 (define-key locate-mode-map
[menu-bar subdir
] 'undefined
)
381 (define-key locate-mode-map
[menu-bar mark executables
] 'undefined
)
382 (define-key locate-mode-map
[menu-bar mark directory
] 'undefined
)
383 (define-key locate-mode-map
[menu-bar mark directories
] 'undefined
)
384 (define-key locate-mode-map
[menu-bar mark symlinks
] 'undefined
)
386 (define-key locate-mode-map
[M-mouse-2
] 'locate-mouse-view-file
)
387 (define-key locate-mode-map
"\C-c\C-t" 'locate-tags
)
389 (define-key locate-mode-map
"l" 'locate-do-redisplay
)
390 (define-key locate-mode-map
"U" 'dired-unmark-all-files
)
391 (define-key locate-mode-map
"V" 'locate-find-directory
)
394 ;; This variable is used to indent the lines and then to search for
396 (defconst locate-filename-indentation
4
397 "The amount of indentation for each file.")
399 (defun locate-get-file-positions ()
400 "Return list of start and end of the file name on the current line.
401 This is a list of two buffer positions.
403 You should only call this function on lines that contain a file name
404 listed by the locate program. Inside inserted subdirectories, or if
405 there is no file name on the current line, the return value is
406 meaningless. You can check whether the current line contains a file
407 listed by the locate program, using the function
408 `locate-main-listing-line-p'."
414 ;; Assumes names end at the end of the line
415 (forward-char locate-filename-indentation
)
416 (list (point) eol
))))
419 (defun locate-current-line-number ()
420 "Return the current line number, as an integer."
421 (+ (count-lines (point-min) (point))
422 (if (eq (current-column) 0)
426 ;; You should only call this function on lines that contain a file name
427 ;; listed by the locate program. Inside inserted subdirectories, or if
428 ;; there is no file name on the current line, the return value is
429 ;; meaningless. You can check whether the current line contains a file
430 ;; listed by the locate program, using the function
431 ;; `locate-main-listing-line-p'.
432 (defun locate-get-filename ()
433 (let ((pos (locate-get-file-positions))
434 (lineno (locate-current-line-number)))
435 (and (not (eq lineno
1))
437 (buffer-substring (elt pos
0) (elt pos
1)))))
439 (defun locate-main-listing-line-p ()
440 "Return t if current line contains a file name listed by locate.
441 This function returns nil if the current line either contains no
442 file name or is inside a subdirectory."
445 (looking-at (concat "."
446 (make-string (1- locate-filename-indentation
) ?\s
)
447 "\\(/\\|[A-Za-z]:\\)"))))
449 (defun locate-mouse-view-file (event)
450 "In Locate mode, view a file, using the mouse."
453 (goto-char (posn-point (event-start event
)))
454 (if (locate-main-listing-line-p)
455 (view-file (locate-get-filename))
456 (message "This command only works inside main listing."))))
458 ;; Define a mode for locate
459 ;; Default directory is set to "/" so that dired commands, which
460 ;; expect to be in a tree, will work properly
461 (defun locate-mode ()
462 "Major mode for the `*Locate*' buffer made by \\[locate].
464 In that buffer, you can use almost all the usual dired bindings.
465 \\[locate-find-directory] visits the directory of the file on the current line.
467 Operating on listed files works, but does not always
468 automatically update the buffer as in ordinary Dired.
469 This is true both for the main listing and for subdirectories.
470 Reverting the buffer using \\[revert-buffer] deletes all subdirectories.
471 Specific `locate-mode' commands, such as \\[locate-find-directory],
472 do not work in subdirectories.
475 ;; Not to be called interactively.
476 (kill-all-local-variables)
477 ;; Avoid clobbering this variable
478 (make-local-variable 'dired-subdir-alist
)
479 (use-local-map locate-mode-map
)
480 (setq major-mode
'locate-mode
482 default-directory
"/"
485 (dired-alist-add-1 default-directory
(point-min-marker))
486 (set (make-local-variable 'dired-directory
) "/")
487 (set (make-local-variable 'dired-subdir-switches
) locate-ls-subdir-switches
)
488 (setq dired-switches-alist nil
)
489 (make-local-variable 'directory-listing-before-filename-regexp
)
490 ;; This should support both Unix and Windoze style names
491 (setq directory-listing-before-filename-regexp
493 (make-string (1- locate-filename-indentation
) ?\s
)
494 "\\(/\\|[A-Za-z]:\\)\\|"
495 (default-value 'directory-listing-before-filename-regexp
)))
496 (make-local-variable 'dired-actual-switches
)
497 (setq dired-actual-switches
"")
498 (make-local-variable 'dired-permission-flags-regexp
)
499 (setq dired-permission-flags-regexp
501 (make-string (1- locate-filename-indentation
) ?\s
)
503 (default-value 'dired-permission-flags-regexp
)))
504 (make-local-variable 'revert-buffer-function
)
505 (setq revert-buffer-function
'locate-update
)
506 (set (make-local-variable 'page-delimiter
) "\n\n")
507 (run-mode-hooks 'locate-mode-hook
))
509 (defun locate-do-setup (search-string)
510 (goto-char (point-min))
513 ;; Nothing returned from locate command?
516 (kill-buffer locate-buffer-name
)
517 (if locate-current-filter
518 (error "Locate: no match for %s in database using filter %s"
519 search-string locate-current-filter
)
520 (error "Locate: no match for %s in database" search-string
))))
522 (locate-insert-header search-string
)
525 (insert-char ?\s locate-filename-indentation t
)
526 (locate-set-properties)
528 (goto-char (point-min)))
530 (defun locate-set-properties ()
532 (let ((pos (locate-get-file-positions)))
533 (dired-insert-set-properties (elt pos
0) (elt pos
1)))))
535 (defun locate-insert-header (search-string)
536 ;; There needs to be a space before `Matches, because otherwise,
537 ;; `*!" would erase the `M'. We can not use two spaces, or the line
538 ;; would mistakenly fit `dired-subdir-regexp'.
539 (let ((locate-format-string " /:\n Matches for %s")
541 (concat " *Matches for \\(" (regexp-quote search-string
) "\\)"))
542 (locate-format-args (list search-string
))
545 (and locate-fcodes-file
546 (setq locate-format-string
547 (concat locate-format-string
" in %s")
549 (concat locate-regexp-match
551 (regexp-quote locate-fcodes-file
)
554 (append (list locate-fcodes-file
) locate-format-args
)))
556 (and locate-current-filter
557 (setq locate-format-string
558 (concat locate-format-string
" using filter %s")
560 (concat locate-regexp-match
563 (regexp-quote locate-current-filter
)
566 (append (list locate-current-filter
) locate-format-args
)))
568 (setq locate-format-string
569 (concat locate-format-string
":\n\n")
571 (concat locate-regexp-match
":\n"))
573 (insert (apply 'format locate-format-string
(reverse locate-format-args
)))
576 (goto-char (point-min))
578 (if (not (looking-at locate-regexp-match
))
580 (add-text-properties (match-beginning 1) (match-end 1)
581 (list 'face locate-header-face
))
582 (and (match-beginning 2)
583 (add-text-properties (match-beginning 2) (match-end 2)
584 (list 'face locate-header-face
)))
585 (and (match-beginning 3)
586 (add-text-properties (match-beginning 3) (match-end 3)
587 (list 'face locate-header-face
)))
590 (defun locate-tags ()
591 "Visit a tags table in `*Locate*' mode."
593 (if (locate-main-listing-line-p)
594 (let ((tags-table (locate-get-filename)))
595 (and (y-or-n-p (format "Visit tags table %s? " tags-table
))
596 (visit-tags-table tags-table
)))
597 (message "This command only works inside main listing.")))
599 ;; From Stephen Eglen <stephen@cns.ed.ac.uk>
600 (defun locate-update (ignore1 ignore2
)
601 "Revert the *Locate* buffer.
602 If `locate-update-when-revert' is non-nil, offer to update the
603 locate database using the shell command in `locate-update-command'."
604 (let ((locate-buffer-name (buffer-name))
605 (locate-prompt-for-command locate-local-prompt
))
606 (and locate-update-when-revert
607 (yes-or-no-p "Update locate database (may take a few seconds)? ")
608 ;; `expand-file-name' is used in order to autoload Tramp if
609 ;; necessary. It cannot be loaded when `default-directory'
611 (let ((default-directory (expand-file-name locate-update-path
)))
612 (shell-command locate-update-command
)))
613 (locate locate-local-search locate-local-filter
)))
615 ;;; Modified three functions from `dired.el':
616 ;;; dired-find-directory,
617 ;;; dired-find-directory-other-window
618 ;;; dired-get-filename
620 (defun locate-find-directory ()
621 "Visit the directory of the file mentioned on this line."
623 (if (locate-main-listing-line-p)
624 (let ((directory-name (locate-get-dirname)))
625 (if (file-directory-p directory-name
)
626 (find-file directory-name
)
627 (if (file-symlink-p directory-name
)
628 (error "Directory is a symlink to a nonexistent target")
629 (error "Directory no longer exists; run `updatedb' to update database"))))
630 (message "This command only works inside main listing.")))
632 (defun locate-find-directory-other-window ()
633 "Visit the directory of the file named on this line in other window."
635 (if (locate-main-listing-line-p)
636 (find-file-other-window (locate-get-dirname))
637 (message "This command only works inside main listing.")))
639 ;; You should only call this function on lines that contain a file name
640 ;; listed by the locate program. Inside inserted subdirectories, or if
641 ;; there is no file name on the current line, the return value is
642 ;; meaningless. You can check whether the current line contains a file
643 ;; listed by the locate program, using the function
644 ;; `locate-main-listing-line-p'.
645 (defun locate-get-dirname ()
646 "Return the directory name of the file mentioned on this line."
647 (let (file (filepos (locate-get-file-positions)))
648 (if (setq file
(buffer-substring (nth 0 filepos
) (nth 1 filepos
)))
650 ;; Get rid of the mouse-face property that file names have.
651 (set-text-properties 0 (length file
) nil file
)
652 (setq file
(file-name-directory file
))
653 ;; Unquote names quoted by ls or by dired-insert-directory.
654 ;; Using read to unquote is much faster than substituting
655 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
659 ;; some ls -b don't escape quotes, argh!
660 ;; This is not needed for GNU ls, though.
661 (or (dired-string-replace-match
662 "\\([^\\]\\|\\`\\)\"" file
"\\1\\\\\"" nil t
)
665 (and file buffer-file-coding-system
666 (not file-name-coding-system
)
667 (setq file
(encode-coding-string file buffer-file-coding-system
)))
670 ;; Only for GNU locate
671 (defun locate-in-alternate-database (search-string database
)
672 "Run the GNU locate program, using an alternate database.
674 This command only works if you use GNU locate. It does not work
675 properly if `locate-prompt-for-command' is set to t. In that
676 case, you can just run the regular `locate' command and specify
677 the database on the command line."
682 (read-from-minibuffer "Locate: " nil nil
683 nil
'locate-history-list
))
684 (read-file-name "Locate using Database: " )
686 (or (file-exists-p database
)
687 (error "Database file %s does not exist" database
))
688 (let ((locate-make-command-line
689 (function (lambda (string)
691 (list (concat "--database="
692 (expand-file-name database
))
694 (locate search-string
)))
696 (defun locate-do-redisplay (&optional arg test-for-subdir
)
697 "Like `dired-do-redisplay', but adapted for `*Locate*' buffers."
699 (if (string= (dired-current-directory) "/")
700 (message "This command only works in subdirectories.")
701 (let ((dired-actual-switches locate-ls-subdir-switches
))
702 (dired-do-redisplay arg test-for-subdir
))))
706 ;;; arch-tag: 60c4d098-b5d5-4b3c-a3e0-51a2e9f43898
707 ;;; locate.el ends here