;;; locate.el --- interface to the locate command
;; Copyright (C) 1996, 1998, 2001 Free Software Foundation, Inc.
;; Author: Peter Breton <email@example.com>
;; Keywords: unix files
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;; Search a database of files and use dired commands on
;; the result.
;;;;; Building a database of files ;;;;;;;;;
;; You can create a simple files database with a port of the Unix find command
;; and one of the various Windows NT various scheduling utilities,
;; for example the AT command from the NT Resource Kit, WinCron which is
;; included with Microsoft FrontPage, or the shareware NTCron program.
;; To set up a function which searches the files database, do something
;; like this:
;; (defvar locate-fcodes-file "c:/users/peter/fcodes")
;; (defvar locate-make-command-line 'nt-locate-make-command-line)
;; (defun nt-locate-make-command-line (arg)
;; (list "grep" "-i" arg locate-fcodes-file))
;;;;;;;; ADVICE For dired-make-relative: ;;;;;;;;;
;; For certain dired commands to work right, you should also include the
;; following in your _emacs/.emacs:
;; (defadvice dired-make-relative (before set-no-error activate)
;; "For locate mode and Windows, don't return errors"
;; (if (and (eq major-mode 'locate-mode)
;; (memq system-type (list 'windows-nt 'ms-dos)))
;; (ad-set-arg 2 t)
;; Otherwise, `dired-make-relative' will give error messages like
;; "FILENAME: not in directory tree growing at /"
;; Locate.el provides an interface to a program which searches a
;; database of file names. By default, this program is the GNU locate
;; command, but it could also be the BSD-style find command, or even a
;; user specified command.
;; To use the BSD-style "fast find", or any other shell command of the
;; SHELLPROGRAM Name-to-find
;; set the variable `locate-command' in your .emacs file.
;; To use a more complicated expression, create a function which
;; takes a string (the name to find) as input and returns a list.
;; The first element should be the command to be executed, the remaining
;; elements should be the arguments (including the name to find). Then put
;; (setq locate-make-command-line 'my-locate-command-line)
;; in your .emacs, using the name of your function in place of
;; You should make sure that whichever command you use works correctly
;; from a shell prompt. GNU locate and BSD find expect the file databases
;; to either be in standard places or located via environment variables.
;; If the latter, make sure these environment variables are set in
;; your emacs process.
;; Locate-mode assumes that each line output from the locate-command
;; consists exactly of a file name, possibly preceded or trailed by
;; whitespace. If your file database has other information on the line (for
;; example, the file size), you will need to redefine the function
;; `locate-get-file-positions' to return a list consisting of the first
;; character in the file name and the last character in the file name.
;; To use locate-mode, simply type M-x locate and then the string
;; you wish to find. You can use almost all of the dired commands in
;; the resulting *Locate* buffer. It is worth noting that your commands
;; do not, of course, affect the file database. For example, if you
;; compress a file in the locate buffer, the actual file will be
;; compressed, but the entry in the file database will not be
;; affected. Consequently, the database and the filesystem will be out
;; of sync until the next time the database is updated.
;; The command `locate-with-filter' keeps only lines matching a
;; regular expression; this is often useful to constrain a big search.
(defvar locate-current-filter nil)
(defgroup locate nil
"Interface to the locate command."
(defcustom locate-command "locate"
"*The executable program used to search a database of files."
(defvar locate-history-list nil
"The history list used by the \\[locate] command.")
(defvar locate-grep-history-list nil
"The history list used by the \\[locate-with-filter] command.")
(defcustom locate-make-command-line 'locate-default-make-command-line
"*Function used to create the locate command line."
(defcustom locate-buffer-name "*Locate*"
"*Name of the buffer to show results from the \\[locate] command."
(defcustom locate-fcodes-file nil
"*File name for the database of file names."
:type '(choice file (const nil))
(defcustom locate-header-face nil
"*Face used to highlight the locate header."
(defcustom locate-update-command "updatedb"
"The command used to update the locate database."
(defcustom locate-prompt-for-command nil
"If non-nil, the default behavior of the locate command is to prompt for a command to run.
Otherwise, that behavior is invoked via a prefix argument."
(defun locate-default-make-command-line (search-string)
(list locate-command search-string))
(defun locate-word-at-point ()
(let ((pt (point)))
(skip-chars-backward "." pt)
(defun locate (search-string &optional filter)
"Run the program `locate', putting results in `*Locate*' buffer.
With prefix arg, prompt for the locate command to run."
(if (or (and current-prefix-arg
(and (not current-prefix-arg) locate-prompt-for-command))
(let ((locate-cmd (funcall locate-make-command-line "")))
"Run locate (like this): "
(concat (car locate-cmd) " "
(mapconcat 'identity (cdr locate-cmd) " "))
(+ 2 (length (car locate-cmd))))
nil nil 'locate-history-list))
nil nil 'locate-history-list)
(let* ((locate-cmd-list (funcall locate-make-command-line search-string))
(locate-cmd (car locate-cmd-list))
(locate-cmd-args (cdr locate-cmd-list))
(or (and current-prefix-arg (not locate-prompt-for-command))
(and (not current-prefix-arg) locate-prompt-for-command)))
;; Find the Locate buffer
(set-buffer (get-buffer-create locate-buffer-name))
(setq locate-current-filter filter)
(shell-command search-string locate-buffer-name)
(apply 'call-process locate-cmd nil t nil locate-cmd-args))
(and (not (string-equal (buffer-name) locate-buffer-name))
(defun locate-with-filter (search-string filter)
"Run the locate command with a filter.
The filter is a regular expression. Only results matching the filter are
shown; this is often useful to constrain a big search."
(list (read-from-minibuffer "Locate: " nil nil
(read-from-minibuffer "Filter: " nil nil
(locate search-string filter))
(defun locate-filter-output (filter)
"Filter output from the locate command."
(defvar locate-mode-map nil
"Local keymap for Locate mode buffers.")
(setq locate-mode-map (copy-keymap dired-mode-map))
;; Undefine Useless Dired Menu bars
(define-key locate-mode-map [menu-bar Dired] 'undefined)
(define-key locate-mode-map [menu-bar subdir] 'undefined)
(define-key locate-mode-map [menu-bar mark executables] 'undefined)
(define-key locate-mode-map [menu-bar mark directory] 'undefined)
(define-key locate-mode-map [menu-bar mark directories] 'undefined)
(define-key locate-mode-map [menu-bar mark symlinks] 'undefined)
(define-key locate-mode-map [mouse-2] 'locate-mouse-view-file)
(define-key locate-mode-map "\C-c\C-t" 'locate-tags)
(define-key locate-mode-map "U" 'dired-unmark-all-files)
(define-key locate-mode-map "V" 'locate-find-directory)
;; This variable is used to indent the lines and then to search for
;; the file name
(defconst locate-filename-indentation 4
"The amount of indentation for each file.")
(defun locate-get-file-positions ()
(let ((eol (point)))
;; Assumes names end at the end of the line
(list (point) eol))))
;; From SQL-mode
(defun locate-current-line-number ()
"Return the current line number, as an integer."
(+ (count-lines (point-min) (point))
(if (eq (current-column) 0)
(defun locate-get-filename ()
(let ((pos (locate-get-file-positions))
(and (not (eq lineno 1))
(not (eq lineno 2))
(buffer-substring (elt pos 0) (elt pos 1)))))
(defun locate-mouse-view-file (event)
"In Locate mode, view a file, using the mouse."
(goto-char (posn-point (event-start event)))
;; Define a mode for locate
;; Default directory is set to "/" so that dired commands, which
;; expect to be in a tree, will work properly
(defun locate-mode ()
"Major mode for the `*Locate*' buffer made by \\[locate]."
;; Avoid clobbering this variables
(setq major-mode 'locate-mode
(dired-alist-add-1 default-directory (point-min-marker))
;; This should support both Unix and Windoze style names
(make-string (1- locate-filename-indentation) ?\ )
(setq dired-actual-switches "")
(make-string (1- locate-filename-indentation) ?\ )
(setq revert-buffer-function 'locate-update)
(defun locate-do-setup (search-string)
;; Nothing returned from locate command?
(error "Locate: no match for %s in database using filter %s"
(error "Locate: no match for %s in database" search-string))))
(while (not (eobp))
(insert-char ?\ locate-filename-indentation t)
(defun locate-set-properties ()
(let ((pos (locate-get-file-positions)))
(dired-insert-set-properties (elt pos 0) (elt pos 1)))))
(defun locate-insert-header (search-string)
(let ((locate-format-string "Matches for %s")
(concat " *Matches for \\(" (regexp-quote search-string) "\\)"))
(locate-format-args (list search-string))
(concat locate-format-string " in %s")
" in \\("
(append (list locate-fcodes-file) locate-format-args)))
(concat locate-format-string " using filter %s")
" using filter "
(append (list locate-current-filter) locate-format-args)))
(concat locate-format-string ":\n\n")
(concat locate-regexp-match ":\n"))
(insert (apply 'format locate-format-string (reverse locate-format-args)))
(if (not (looking-at locate-regexp-match))
(add-text-properties (match-beginning 1) (match-end 1)
(list 'face locate-header-face))
(and (match-beginning 2)
(add-text-properties (match-beginning 2) (match-end 2)
(list 'face locate-header-face)))
(and (match-beginning 3)
(add-text-properties (match-beginning 3) (match-end 3)
(list 'face locate-header-face)))
(defun locate-tags ()
"Visit a tags table in `*Locate*' mode."
(let ((tags-table (locate-get-filename)))
(and (y-or-n-p (format "Visit tags table %s? " tags-table))
;; From Stephen Eglen <firstname.lastname@example.org>
(defun locate-update (ignore1 ignore2)
"Update the locate database.
Database is updated using the shell command in `locate-update-command'."
(let ((str (car locate-history-list)))
(cond ((yes-or-no-p "Update locate database (may take a few seconds)? ")
;;; Modified three functions from `dired.el':
(defun locate-find-directory ()
"Visit the directory of the file mentioned on this line."
(let ((directory-name (locate-get-dirname)))
(if (file-directory-p directory-name)
(if (file-symlink-p directory-name)
(error "Directory is a symlink to a nonexistent target")
(error "Directory no longer exists; run `updatedb' to update database")))))
(defun locate-find-directory-other-window ()
"Visit the directory of the file named on this line in other window."
(defun locate-get-dirname ()
"Return the directory name of the file mentioned on this line."
(let (file (filepos (locate-get-file-positions)))
(if (setq file (buffer-substring (nth 0 filepos) (nth 1 filepos)))
;; Get rid of the mouse-face property that file names have.
(set-text-properties 0 (length file) nil file)
(setq file (file-name-directory file))
;; Unquote names quoted by ls or by dired-insert-directory.
;; Using read to unquote is much faster than substituting
;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
;; some ls -b don't escape quotes, argh!
;; This is not needed for GNU ls, though.
"\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
(and file buffer-file-coding-system
(setq file (encode-coding-string file buffer-file-coding-system)))
;; Only for GNU locate
(defun locate-in-alternate-database (search-string database)
"Run the GNU locate command, using an alternate database."
;; (require 'locate)
(read-from-minibuffer "Locate: " nil nil
(read-file-name "Locate using Database: " )
(or (file-exists-p database)
(error "Database file %s does not exist" database))
(function (lambda (string)
(list (concat "--database="
;;; locate.el ends here