;;; locate.el --- interface to the locate command
;; Copyright (C) 1996, 1998, 2001, 2002, 2003, 2004,
-;; 2005 Free Software Foundation, Inc.
+;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
;; Author: Peter Breton <pbreton@cs.umb.edu>
;; Keywords: unix files
;; 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)
+;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; Variables
(defvar locate-current-filter nil)
+(defvar locate-local-filter nil)
+(defvar locate-local-search nil)
+(defvar locate-local-prompt nil)
(defgroup locate nil
"Interface to the locate command."
: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
:group 'locate
:version "22.1")
+(defcustom locate-update-when-revert nil
+ "This option affects how the *Locate* buffer gets reverted.
+If non-nil, offer to update the locate database when reverting that buffer.
+\(Normally, you need to have root privileges for this to work. See the
+option `locate-update-path'.)
+If nil, reverting does not update the locate database."
+ :type 'boolean
+ :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-update-path "/"
+ "The default directory from where `locate-update-command' is called.
+Usually, root permissions are required to run that command. This
+can be achieved by setting this option to \"/su::\" or \"/sudo::\"
+\(if you have the appropriate authority). If your current user
+permissions are sufficient to run the command, you can set this
+option to \"/\"."
+ :type 'string
+ :group 'locate
+ :version "22.1")
+
(defcustom locate-prompt-for-command nil
- "If non-nil, the locate command prompts for a command to run.
-Otherwise, that behavior is invoked via a prefix argument."
+ "If non-nil, the `locate' command prompts for a command to run.
+Otherwise, that behavior is invoked via a prefix argument.
+
+Setting this option non-nil actually inverts the meaning of a prefix arg;
+that is, with a prefix arg, you get the default behavior."
:group 'locate
- :type 'boolean
- )
+ :type 'boolean)
;; Functions
(skip-chars-backward "." pt)
(point)))))
+;; Function for use in interactive declarations.
+(defun locate-prompt-for-search-string ()
+ (if (or (and current-prefix-arg
+ (not locate-prompt-for-command))
+ (and (not current-prefix-arg) locate-prompt-for-command))
+ (let ((locate-cmd (funcall locate-make-command-line "")))
+ (read-from-minibuffer
+ "Run locate (like this): "
+ (cons
+ (concat (car locate-cmd) " "
+ (mapconcat 'identity (cdr locate-cmd) " "))
+ (+ 2 (length (car locate-cmd))))
+ nil nil 'locate-history-list))
+ (let* ((default (locate-word-at-point))
+ (input
+ (read-from-minibuffer
+ (if (> (length default) 0)
+ (format "Locate (default %s): " default)
+ (format "Locate: "))
+ nil nil nil 'locate-history-list default t)))
+ (and (equal input "") default
+ (setq input default))
+ input)))
+
;;;###autoload
-(defun locate (search-string &optional filter)
+(defun locate (search-string &optional filter arg)
"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.
+
+ARG is the interactive prefix arg."
(interactive
- (list
- (if (or (and current-prefix-arg
- (not locate-prompt-for-command))
- (and (not current-prefix-arg) locate-prompt-for-command))
- (let ((locate-cmd (funcall locate-make-command-line "")))
- (read-from-minibuffer
- "Run locate (like this): "
- (cons
- (concat (car locate-cmd) " "
- (mapconcat 'identity (cdr locate-cmd) " "))
- (+ 2 (length (car locate-cmd))))
- nil nil 'locate-history-list))
- (let* ((default (locate-word-at-point))
- (input
- (read-from-minibuffer
- (if (> (length default) 0)
- (format "Locate (default %s): " default)
- (format "Locate: "))
- nil nil nil 'locate-history-list default t)))
- (and (equal input "") default
- (setq input default))
- input))))
+ (list
+ (locate-prompt-for-search-string)
+ nil
+ current-prefix-arg))
+
(if (equal search-string "")
(error "Please specify a filename to search for"))
(let* ((locate-cmd-list (funcall locate-make-command-line search-string))
(locate-cmd (car locate-cmd-list))
(locate-cmd-args (cdr locate-cmd-list))
(run-locate-command
- (or (and current-prefix-arg (not locate-prompt-for-command))
- (and (not current-prefix-arg) locate-prompt-for-command)))
+ (or (and arg (not locate-prompt-for-command))
+ (and (not arg) locate-prompt-for-command)))
)
;; Find the Locate buffer
(erase-buffer)
(setq locate-current-filter filter)
+ (set (make-local-variable 'locate-local-search) search-string)
+ (set (make-local-variable 'locate-local-filter) filter)
+ (set (make-local-variable 'locate-local-prompt) run-locate-command)
(if run-locate-command
(shell-command search-string locate-buffer-name)
)
;;;###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."
+(defun locate-with-filter (search-string filter &optional arg)
+ "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.
+
+ARG is the interactive prefix arg, which has the same effect as in `locate'.
+
+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)
- (read-from-minibuffer "Filter: " nil nil
- nil 'locate-grep-history-list)))
- (locate search-string filter))
+ (list
+ (locate-prompt-for-search-string)
+ (read-from-minibuffer "Filter: " nil nil
+ nil 'locate-grep-history-list)
+ current-prefix-arg))
+ (locate search-string filter arg))
(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.")
"The amount of indentation for each file.")
(defun locate-get-file-positions ()
- (save-excursion
- (end-of-line)
- (let ((eol (point)))
- (beginning-of-line)
-
- ;; Assumes names end at the end of the line
- (forward-char locate-filename-indentation)
- (list (point) eol))))
+ "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'."
+ (list (+ locate-filename-indentation
+ (line-beginning-position))
+ ;; Assume names end at the end of the line.
+ (line-end-position)))
;; From SQL-mode
(defun locate-current-line-number ()
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)))
(save-excursion
(forward-line 0)
(looking-at (concat "."
- (make-string (1- locate-filename-indentation) ?\ )
+ (make-string (1- locate-filename-indentation) ?\s)
"\\(/\\|[A-Za-z]:\\)"))))
(defun locate-mouse-view-file (event)
;; This should support both Unix and Windoze style names
(setq directory-listing-before-filename-regexp
(concat "^."
- (make-string (1- locate-filename-indentation) ?\ )
+ (make-string (1- locate-filename-indentation) ?\s)
"\\(/\\|[A-Za-z]:\\)\\|"
(default-value 'directory-listing-before-filename-regexp)))
(make-local-variable 'dired-actual-switches)
(make-local-variable 'dired-permission-flags-regexp)
(setq dired-permission-flags-regexp
(concat "^.\\("
- (make-string (1- locate-filename-indentation) ?\ )
+ (make-string (1- locate-filename-indentation) ?\s)
"\\)\\|"
(default-value 'dired-permission-flags-regexp)))
(make-local-variable 'revert-buffer-function)
(locate-insert-header search-string)
(while (not (eobp))
- (insert-char ?\ locate-filename-indentation t)
+ (insert-char ?\s locate-filename-indentation t)
(locate-set-properties)
(forward-line 1)))
(goto-char (point-min)))
;; From Stephen Eglen <stephen@cns.ed.ac.uk>
(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)? ")
- (shell-command locate-update-command)
- (locate str)))))
+ "Revert the *Locate* buffer.
+If `locate-update-when-revert' is non-nil, offer to update the
+locate database using the shell command in `locate-update-command'."
+ (let ((locate-buffer-name (buffer-name))
+ (locate-prompt-for-command locate-local-prompt))
+ (and locate-update-when-revert
+ (yes-or-no-p "Update locate database (may take a few seconds)? ")
+ ;; `expand-file-name' is used in order to autoload Tramp if
+ ;; necessary. It cannot be loaded when `default-directory'
+ ;; is remote.
+ (let ((default-directory (expand-file-name locate-update-path)))
+ (shell-command locate-update-command)))
+ (locate locate-local-search locate-local-filter)))
;;; Modified three functions from `dired.el':
;;; dired-find-directory,
(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)))
;; Only for GNU locate
(defun locate-in-alternate-database (search-string database)
- "Run the GNU locate command, using an alternate database."
+ "Run the GNU locate program, using an alternate database.
+
+This command only works if you use GNU locate. It does not work
+properly if `locate-prompt-for-command' is set to t. In that
+case, you can just run the regular `locate' command and specify
+the database on the command line."
(interactive
(list
(progn
HCoop / bpt / emacs.git / blobdiff