;;; locate.el --- interface to the locate command
-;; Copyright (C) 1996, 1998, 2001 Free Software Foundation, Inc.
+;; Copyright (C) 1996, 1998, 2001, 2002, 2003, 2004,
+;; 2005, 2006 Free Software Foundation, Inc.
;; Author: Peter Breton <pbreton@cs.umb.edu>
;; Keywords: unix files
;; 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
-;; Search a database of files and use dired commands on
-;; the result.
-;;
-\f
-;;;;; 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 /"
-\f
-;;; Commentary:
+;; Search a database of files and use dired commands on the result.
;;
;; Locate.el provides an interface to a program which searches a
;; database of file names. By default, this program is the GNU locate
;; The command `locate-with-filter' keeps only lines matching a
;; regular expression; this is often useful to constrain a big search.
;;
+\f
+;;;;; 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 /"
+
\f
;;; Code:
:group 'external)
(defcustom locate-command "locate"
- "*The executable program used to search a database of files."
+ "Executable program for searching a database of files.
+The Emacs commands `locate' and `locate-with-filter' use this.
+The value should be a program that can be called from a shell
+with one argument, SEARCH-STRING. The program determines which
+database it searches. The output of the program should consist
+of those file names in the database that match SEARCH-STRING,
+listed one per line, possibly with leading or trailing
+whitespace. If the output is in another form, you may have to
+redefine the function `locate-get-file-positions'.
+
+The program may interpret SEARCH-STRING as a literal string, a
+shell pattern or a regular expression. The exact rules of what
+constitutes a match may also depend on the program.
+
+The standard value of this variable is \"locate\".
+This program normally searches a database of all files on your
+system, or of all files that you have access to. Consult the
+documentation of that program for the details about how it determines
+which file names match SEARCH-STRING. (Those details vary highly with
+the version.)"
:type 'string
:group 'locate)
"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."
+ "Function used to create the locate command line.
+The Emacs commands `locate' and `locate-with-filter' use this.
+This function should take one argument, a string (the name to find)
+and return a list of strings. The first element of the list should be
+the name of a command to be executed by a shell, the remaining elements
+should be the arguments to that command (including the name to find)."
:type 'function
:group 'locate)
(defcustom locate-buffer-name "*Locate*"
- "*Name of the buffer to show results from the \\[locate] command."
+ "Name of the buffer to show results from the \\[locate] command."
:type 'string
:group 'locate)
(defcustom locate-fcodes-file nil
- "*File name for the database of file names."
- :type '(choice file (const nil))
+ "File name for the database of file names used by `locate'.
+If non-nil, `locate' uses this name in the header of the `*Locate*'
+buffer. If nil, it mentions no file name in that header.
+
+Just setting this variable does not actually change the database
+that `locate' searches. The executive program that the Emacs
+function `locate' uses, as given by the variables `locate-command'
+or `locate-make-command-line', determines the database."
+ :type '(choice (const :tag "None" nil) file)
:group 'locate)
(defcustom locate-header-face nil
- "*Face used to highlight the locate header."
- :type 'face
+ "Face used to highlight the locate header."
+ :type '(choice (const :tag "None" nil) face)
:group 'locate)
+;;;###autoload
+(defcustom locate-ls-subdir-switches "-al"
+ "`ls' switches for inserting subdirectories in `*Locate*' buffers.
+This should contain the \"-l\" switch, but not the \"-F\" or \"-b\" switches."
+ :type 'string
+ :group 'locate
+ :version "22.1")
+
(defcustom locate-update-command "updatedb"
- "The command used to update the locate database."
+ "The executable program used to update the locate database."
:type 'string
:group 'locate)
(defcustom locate-prompt-for-command nil
- "If non-nil, the locate command prompts for a command to run.
+ "If non-nil, the `locate' command prompts for a command to run.
Otherwise, that behavior is invoked via a prefix argument."
:group 'locate
:type 'boolean
;;;###autoload
(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."
+Pass it SEARCH-STRING as argument. Interactively, prompt for SEARCH-STRING.
+With prefix arg, prompt for the exact shell command to run instead.
+
+This program searches for those file names in a database that match
+SEARCH-STRING and normally outputs all matching absolute file names,
+one per line. The database normally consists of all files on your
+system, or of all files that you have access to. Consult the
+documentation of the program for the details about how it determines
+which file names match SEARCH-STRING. (Those details vary highly with
+the version.)
+
+You can specify another program for this command to run by customizing
+the variables `locate-command' or `locate-make-command-line'.
+
+The main use of FILTER is to implement `locate-with-filter'. See
+the docstring of that function for its meaning."
(interactive
(list
(if (or (and current-prefix-arg
(input
(read-from-minibuffer
(if (> (length default) 0)
- (format "Locate (default `%s'): " default)
+ (format "Locate (default %s): " default)
(format "Locate: "))
nil nil nil 'locate-history-list default t)))
(and (equal input "") default
(save-window-excursion
(set-buffer (get-buffer-create locate-buffer-name))
(locate-mode)
- (erase-buffer)
+ (let ((inhibit-read-only t)
+ (buffer-undo-list t))
+ (erase-buffer)
- (setq locate-current-filter filter)
+ (setq locate-current-filter filter)
- (if run-locate-command
- (shell-command search-string locate-buffer-name)
- (apply 'call-process locate-cmd nil t nil locate-cmd-args))
+ (if run-locate-command
+ (shell-command search-string locate-buffer-name)
+ (apply 'call-process locate-cmd nil t nil locate-cmd-args))
- (and filter
- (locate-filter-output filter))
+ (and filter
+ (locate-filter-output filter))
- (locate-do-setup search-string)
- )
+ (locate-do-setup search-string)
+ ))
(and (not (string-equal (buffer-name) locate-buffer-name))
(switch-to-buffer-other-window locate-buffer-name))
(run-hooks 'dired-mode-hook)
- (dired-next-line 2) ;move to first matching file.
+ (dired-next-line 3) ;move to first matching file.
(run-hooks 'locate-post-command-hook)
)
)
;;;###autoload
(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."
+ "Run the executable program `locate' with a filter.
+This function is similar to the function `locate', which see.
+The difference is that, when invoked interactively, the present function
+prompts for both SEARCH-STRING and FILTER. It passes SEARCH-STRING
+to the locate executable program. It produces a `*Locate*' buffer
+that lists only those lines in the output of the locate program that
+contain a match for the regular expression FILTER; this is often useful
+to constrain a big search.
+
+When called from Lisp, this function is identical with `locate',
+except that FILTER is not optional."
(interactive
(list (read-from-minibuffer "Locate: " nil nil
nil 'locate-history-list)
(defun locate-filter-output (filter)
"Filter output from the locate command."
(goto-char (point-min))
- (delete-non-matching-lines filter))
+ (keep-lines filter))
(defvar locate-mode-map nil
"Local keymap for Locate mode buffers.")
(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 [M-mouse-2] 'locate-mouse-view-file)
(define-key locate-mode-map "\C-c\C-t" 'locate-tags)
+ (define-key locate-mode-map "l" 'locate-do-redisplay)
(define-key locate-mode-map "U" 'dired-unmark-all-files)
(define-key locate-mode-map "V" 'locate-find-directory)
)
"The amount of indentation for each file.")
(defun locate-get-file-positions ()
+ "Return list of start and end of the file name on the current line.
+This is a list of two buffer positions.
+
+You should only call this function on lines that contain a file name
+listed by the locate program. Inside inserted subdirectories, or if
+there is no file name on the current line, the return value is
+meaningless. You can check whether the current line contains a file
+listed by the locate program, using the function
+`locate-main-listing-line-p'."
(save-excursion
(end-of-line)
(let ((eol (point)))
1
0)))
+;; You should only call this function on lines that contain a file name
+;; listed by the locate program. Inside inserted subdirectories, or if
+;; there is no file name on the current line, the return value is
+;; meaningless. You can check whether the current line contains a file
+;; listed by the locate program, using the function
+;; `locate-main-listing-line-p'.
(defun locate-get-filename ()
(let ((pos (locate-get-file-positions))
(lineno (locate-current-line-number)))
(not (eq lineno 2))
(buffer-substring (elt pos 0) (elt pos 1)))))
+(defun locate-main-listing-line-p ()
+ "Return t if current line contains a file name listed by locate.
+This function returns nil if the current line either contains no
+file name or is inside a subdirectory."
+ (save-excursion
+ (forward-line 0)
+ (looking-at (concat "."
+ (make-string (1- locate-filename-indentation) ?\ )
+ "\\(/\\|[A-Za-z]:\\)"))))
+
(defun locate-mouse-view-file (event)
"In Locate mode, view a file, using the mouse."
(interactive "@e")
(save-excursion
(goto-char (posn-point (event-start event)))
- (view-file (locate-get-filename))))
+ (if (locate-main-listing-line-p)
+ (view-file (locate-get-filename))
+ (message "This command only works inside main listing."))))
;; 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].
+\\<locate-mode-map>\
In that buffer, you can use almost all the usual dired bindings.
\\[locate-find-directory] visits the directory of the file on the current line.
+Operating on listed files works, but does not always
+automatically update the buffer as in ordinary Dired.
+This is true both for the main listing and for subdirectories.
+Reverting the buffer using \\[revert-buffer] deletes all subdirectories.
+Specific `locate-mode' commands, such as \\[locate-find-directory],
+do not work in subdirectories.
+
\\{locate-mode-map}"
+ ;; Not to be called interactively.
(kill-all-local-variables)
- ;; Avoid clobbering this variables
+ ;; Avoid clobbering this variable
(make-local-variable 'dired-subdir-alist)
(use-local-map locate-mode-map)
(setq major-mode 'locate-mode
mode-name "Locate"
- default-directory "/")
+ default-directory "/"
+ buffer-read-only t
+ selective-display t)
(dired-alist-add-1 default-directory (point-min-marker))
- (make-local-variable 'dired-move-to-filename-regexp)
+ (set (make-local-variable 'dired-directory) "/")
+ (set (make-local-variable 'dired-subdir-switches) locate-ls-subdir-switches)
+ (setq dired-switches-alist nil)
+ (make-local-variable 'directory-listing-before-filename-regexp)
;; This should support both Unix and Windoze style names
- (setq dired-move-to-filename-regexp
- (concat "."
+ (setq directory-listing-before-filename-regexp
+ (concat "^."
(make-string (1- locate-filename-indentation) ?\ )
- "\\(/\\|[A-Za-z]:\\)"))
+ "\\(/\\|[A-Za-z]:\\)\\|"
+ (default-value 'directory-listing-before-filename-regexp)))
(make-local-variable 'dired-actual-switches)
(setq dired-actual-switches "")
(make-local-variable 'dired-permission-flags-regexp)
(setq dired-permission-flags-regexp
(concat "^.\\("
(make-string (1- locate-filename-indentation) ?\ )
- "\\)"))
+ "\\)\\|"
+ (default-value 'dired-permission-flags-regexp)))
(make-local-variable 'revert-buffer-function)
(setq revert-buffer-function 'locate-update)
- (run-hooks 'locate-mode-hook))
+ (set (make-local-variable 'page-delimiter) "\n\n")
+ (run-mode-hooks 'locate-mode-hook))
(defun locate-do-setup (search-string)
(goto-char (point-min))
(dired-insert-set-properties (elt pos 0) (elt pos 1)))))
(defun locate-insert-header (search-string)
- (let ((locate-format-string "Matches for %s")
+ ;; There needs to be a space before `Matches, because otherwise,
+ ;; `*!" would erase the `M'. We can not use two spaces, or the line
+ ;; would mistakenly fit `dired-subdir-regexp'.
+ (let ((locate-format-string " /:\n Matches for %s")
(locate-regexp-match
(concat " *Matches for \\(" (regexp-quote search-string) "\\)"))
(locate-format-args (list search-string))
(save-excursion
(goto-char (point-min))
+ (forward-line 1)
(if (not (looking-at locate-regexp-match))
nil
(add-text-properties (match-beginning 1) (match-end 1)
(defun locate-tags ()
"Visit a tags table in `*Locate*' mode."
(interactive)
- (let ((tags-table (locate-get-filename)))
- (and (y-or-n-p (format "Visit tags table %s? " tags-table))
- (visit-tags-table tags-table))))
+ (if (locate-main-listing-line-p)
+ (let ((tags-table (locate-get-filename)))
+ (and (y-or-n-p (format "Visit tags table %s? " tags-table))
+ (visit-tags-table tags-table)))
+ (message "This command only works inside main listing.")))
;; From Stephen Eglen <stephen@cns.ed.ac.uk>
(defun locate-update (ignore1 ignore2)
(defun locate-find-directory ()
"Visit the directory of the file mentioned on this line."
(interactive)
- (let ((directory-name (locate-get-dirname)))
- (if (file-directory-p directory-name)
- (find-file 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")))))
+ (if (locate-main-listing-line-p)
+ (let ((directory-name (locate-get-dirname)))
+ (if (file-directory-p directory-name)
+ (find-file 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"))))
+ (message "This command only works inside main listing.")))
(defun locate-find-directory-other-window ()
"Visit the directory of the file named on this line in other window."
(interactive)
- (find-file-other-window (locate-get-dirname)))
-
+ (if (locate-main-listing-line-p)
+ (find-file-other-window (locate-get-dirname))
+ (message "This command only works inside main listing.")))
+
+;; You should only call this function on lines that contain a file name
+;; listed by the locate program. Inside inserted subdirectories, or if
+;; there is no file name on the current line, the return value is
+;; meaningless. You can check whether the current line contains a file
+;; listed by the locate program, using the function
+;; `locate-main-listing-line-p'.
(defun locate-get-dirname ()
"Return the directory name of the file mentioned on this line."
(let (file (filepos (locate-get-file-positions)))
string))))))
(locate search-string)))
+(defun locate-do-redisplay (&optional arg test-for-subdir)
+ "Like `dired-do-redisplay', but adapted for `*Locate*' buffers."
+ (interactive "P\np")
+ (if (string= (dired-current-directory) "/")
+ (message "This command only works in subdirectories.")
+ (let ((dired-actual-switches locate-ls-subdir-switches))
+ (dired-do-redisplay arg test-for-subdir))))
+
(provide 'locate)
;;; arch-tag: 60c4d098-b5d5-4b3c-a3e0-51a2e9f43898