lisp/locate.el

   1 ;;; locate.el --- interface to the locate command
   2
   3 ;; Copyright (C) 1996, 1998 Free Software Foundation, Inc.
   4
   5 ;; Author: Peter Breton <pbreton@cs.umb.edu>
   6 ;; Keywords: unix files
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;; Search a database of files and use dired commands on
  28 ;; the result.
  29 ;;
  30 \f
  31 ;;;;; Building a database of files ;;;;;;;;;
  32 ;;
  33 ;; You can create a simple files database with a port of the Unix find command
  34 ;; and one of the various Windows NT various scheduling utilities,
  35 ;; for example the AT command from the NT Resource Kit, WinCron which is
  36 ;; included with Microsoft FrontPage, or the shareware NTCron program.
  37 ;;
  38 ;; To set up a function which searches the files database, do something
  39 ;; like this:
  40 ;;
  41 ;; (defvar locate-fcodes-file       "c:/users/peter/fcodes")
  42 ;; (defvar locate-make-command-line 'nt-locate-make-command-line)
  43 ;;
  44 ;; (defun nt-locate-make-command-line (arg)
  45 ;;  (list "grep" "-i" arg locate-fcodes-file))
  46 ;;
  47 ;;;;;;;; ADVICE For dired-make-relative: ;;;;;;;;;
  48 ;;
  49 ;; For certain dired commands to work right, you should also include the
  50 ;; following in your _emacs/.emacs:
  51 ;;
  52 ;; (defadvice dired-make-relative (before set-no-error activate)
  53 ;;   "For locate mode and Windows, don't return errors"
  54 ;;   (if (and (eq   major-mode  'locate-mode)
  55 ;;         (memq system-type (list 'windows-nt 'ms-dos)))
  56 ;;       (ad-set-arg 2 t)
  57 ;;     ))
  58 ;;
  59 ;; Otherwise, `dired-make-relative' will give error messages like
  60 ;; "FILENAME: not in directory tree growing at /"
  61 \f
  62 ;;; Commentary:
  63 ;;
  64 ;; Locate.el provides an interface to a program which searches a
  65 ;; database of file names. By default, this program is the GNU locate
  66 ;; command, but it could also be the BSD-style find command, or even a
  67 ;; user specified command.
  68 ;;
  69 ;; To use the BSD-style "fast find", or any other shell command of the
  70 ;; form
  71 ;;
  72 ;;   SHELLPROGRAM  Name-to-find
  73 ;;
  74 ;; set the variable `locate-command' in your .emacs file.
  75 ;;
  76 ;;   To use a more complicated expression, create a function which
  77 ;; takes a string (the name to find) as input and returns a list.
  78 ;; The first element should be the command to be executed, the remaining
  79 ;; elements should be the arguments (including the name to find). Then put
  80 ;;
  81 ;; (setq locate-make-command-line 'my-locate-command-line)
  82 ;;
  83 ;; in your .emacs, using the name of your function in place of
  84 ;; my-locate-command-line.
  85 ;;
  86 ;; You should make sure that whichever command you use works correctly
  87 ;; from a shell prompt. GNU locate and BSD find expect the file databases
  88 ;; to either be in standard places or located via environment variables.
  89 ;; If the latter, make sure these environment variables are set in
  90 ;; your emacs process.
  91 ;;
  92 ;; Locate-mode assumes that each line output from the locate-command
  93 ;; consists exactly of a file name, possibly preceded or trailed by
  94 ;; whitespace. If your file database has other information on the line (for
  95 ;; example, the file size), you will need to redefine the function
  96 ;; `locate-get-file-positions' to return a list consisting of the first
  97 ;; character in the file name and the last character in the file name.
  98 ;;
  99 ;; To use locate-mode, simply type M-x locate and then the string
 100 ;; you wish to find. You can use almost all of the dired commands in
 101 ;; the resulting *Locate* buffer.  It is worth noting that your commands
 102 ;; do not, of course, affect the file database. For example, if you
 103 ;; compress a file in the locate buffer, the actual file will be
 104 ;; compressed, but the entry in the file database will not be
 105 ;; affected. Consequently, the database and the filesystem will be out
 106 ;; of sync until the next time the database is updated.
 107 ;;
 108 ;; The command `locate-with-filter' keeps only lines matching a
 109 ;; regular expression; this is often useful to constrain a big search.
 110 ;;
 111 \f
 112 ;;; Code:
 113
 114 (eval-when-compile
 115   (require 'dired))
 116
 117 ;; Variables
 118
 119 (defvar locate-current-filter nil)
 120
 121 (defgroup locate nil
 122   "Interface to the locate command."
 123   :prefix "locate-"
 124   :group 'external)
 125
 126 (defcustom locate-command "locate"
 127   "*The executable program used to search a database of files."
 128   :type 'string
 129   :group 'locate)
 130
 131 (defvar locate-history-list nil
 132   "The history list used by the \\[locate] command.")
 133
 134 (defvar locate-grep-history-list nil
 135   "The history list used by the \\[locate-with-filter] command.")
 136
 137 (defcustom locate-make-command-line 'locate-default-make-command-line
 138   "*Function used to create the locate command line."
 139   :type 'function
 140   :group 'locate)
 141
 142 (defcustom locate-buffer-name "*Locate*"
 143   "*Name of the buffer to show results from the \\[locate] command."
 144   :type 'string
 145   :group 'locate)
 146
 147 (defcustom locate-fcodes-file nil
 148   "*File name for the database of file names."
 149   :type '(choice file (const nil))
 150   :group 'locate)
 151
 152 (defcustom locate-header-face nil
 153   "*Face used to highlight the locate header."
 154   :type 'face
 155   :group 'locate)
 156
 157 (defcustom locate-update-command "updatedb"
 158   "The command used to update the locate database."
 159   :type 'string
 160   :group 'locate)
 161
 162 (defcustom locate-prompt-for-command nil
 163   "If non-nil, the default behavior of the locate command is to prompt for a command to run.
 164 Otherwise, that behavior is invoked via a prefix argument."
 165   :group 'locate
 166   :type 'boolean
 167   )
 168
 169 ;; Functions
 170
 171 (defun locate-default-make-command-line (search-string)
 172   (list locate-command search-string))
 173
 174 (defun locate-word-at-point ()
 175   (let ((pt (point)))
 176     (buffer-substring-no-properties
 177      (save-excursion
 178        (skip-chars-backward "-a-zA-Z0-9.")
 179        (point))
 180      (save-excursion
 181        (skip-chars-forward "-a-zA-Z0-9.")
 182        (skip-chars-backward "." pt)
 183        (point)))))
 184
 185 ;;;###autoload
 186 (defun locate (arg search-string &optional filter)
 187   "Run the program `locate', putting results in `*Locate*' buffer.
 188 With prefix arg, prompt for the locate command to run."
 189   (interactive
 190       (list
 191        current-prefix-arg
 192        (if (or (and current-prefix-arg       (not locate-prompt-for-command))
 193                (and (not current-prefix-arg) locate-prompt-for-command))
 194            (read-from-minibuffer "Run locate command: "
 195                                  nil nil nil 'locate-history-list)
 196          (read-from-minibuffer "Locate: " (locate-word-at-point) nil
 197                                nil 'locate-history-list)
 198          )))
 199   (let* ((locate-cmd-list (funcall locate-make-command-line search-string))
 200          (locate-cmd (car locate-cmd-list))
 201          (locate-cmd-args (cdr locate-cmd-list))
 202          (run-locate-command
 203           (or (and arg (not locate-prompt-for-command))
 204               (and (not arg) locate-prompt-for-command)))
 205          )
 206
 207     ;; Find the Locate buffer
 208     (save-window-excursion
 209       (set-buffer (get-buffer-create locate-buffer-name))
 210       (locate-mode)
 211       (erase-buffer)
 212
 213       (setq locate-current-filter filter)
 214
 215       (if run-locate-command
 216           (shell-command search-string locate-buffer-name)
 217         (apply 'call-process locate-cmd nil t nil locate-cmd-args))
 218
 219       (and filter
 220           (locate-filter-output filter))
 221
 222       (locate-do-setup)
 223       )
 224     (and (not (string-equal (buffer-name) locate-buffer-name))
 225         (switch-to-buffer-other-window locate-buffer-name))
 226
 227     (run-hooks 'dired-mode-hook)
 228     (run-hooks 'locate-post-command-hook)
 229     )
 230   )
 231
 232 ;;;###autoload
 233 (defun locate-with-filter (search-string filter)
 234   "Run the locate command with a filter.
 235
 236 The filter is a regular expression. Only results matching the filter are
 237 shown; this is often useful to constrain a big search."
 238   (interactive
 239    (list (read-from-minibuffer "Locate: " nil nil
 240                                nil 'locate-history-list)
 241          (read-from-minibuffer "Filter: " nil nil
 242                                nil 'locate-grep-history-list)))
 243   (locate nil search-string filter))
 244
 245 (defun locate-filter-output (filter)
 246   "Filter output from the locate command."
 247   (goto-char (point-min))
 248   (delete-non-matching-lines filter))
 249
 250 (defvar locate-mode-map nil
 251   "Local keymap for Locate mode buffers.")
 252 (if locate-mode-map
 253     nil
 254
 255    (require 'dired)
 256
 257    (setq locate-mode-map (copy-keymap dired-mode-map))
 258
 259    ;; Undefine Useless Dired Menu bars
 260    (define-key locate-mode-map [menu-bar Dired]   'undefined)
 261    (define-key locate-mode-map [menu-bar subdir]  'undefined)
 262
 263    (define-key locate-mode-map [menu-bar mark executables] 'undefined)
 264    (define-key locate-mode-map [menu-bar mark directory]   'undefined)
 265    (define-key locate-mode-map [menu-bar mark directories] 'undefined)
 266    (define-key locate-mode-map [menu-bar mark symlinks]    'undefined)
 267
 268    (define-key locate-mode-map [mouse-2]   'locate-mouse-view-file)
 269    (define-key locate-mode-map "\C-c\C-t"  'locate-tags)
 270
 271    (define-key locate-mode-map "U"       'dired-unmark-all-files)
 272    (define-key locate-mode-map "V"       'locate-find-directory)
 273 )
 274
 275 ;; This variable is used to indent the lines and then to search for
 276 ;; the file name
 277 (defconst locate-filename-indentation 4
 278   "The amount of indentation for each file.")
 279
 280 (defun locate-get-file-positions ()
 281   (save-excursion
 282     (end-of-line)
 283     (let ((eol (point)))
 284       (beginning-of-line)
 285
 286       ;; Assumes names end at the end of the line
 287       (forward-char locate-filename-indentation)
 288       (list (point) eol))))
 289
 290 ;; From SQL-mode
 291 (defun locate-current-line-number ()
 292   "Return the current line number, as an integer."
 293   (+ (count-lines (point-min) (point))
 294      (if (eq (current-column) 0)
 295          1
 296        0)))
 297
 298 (defun locate-get-filename ()
 299   (let ((pos    (locate-get-file-positions))
 300         (lineno (locate-current-line-number)))
 301     (and (not (eq lineno 1))
 302          (not (eq lineno 2))
 303          (buffer-substring (elt pos 0) (elt pos 1)))))
 304
 305 (defun locate-mouse-view-file (event)
 306   "In Locate mode, view a file, using the mouse."
 307   (interactive "@e")
 308   (save-excursion
 309     (goto-char (posn-point (event-start event)))
 310     (view-file (locate-get-filename))))
 311
 312 ;; Define a mode for locate
 313 ;; Default directory is set to "/" so that dired commands, which
 314 ;; expect to be in a tree, will work properly
 315 (defun locate-mode ()
 316   "Major mode for the `*Locate*' buffer made by \\[locate]."
 317   (kill-all-local-variables)
 318   ;; Avoid clobbering this variables
 319   (make-local-variable 'dired-subdir-alist)
 320   (use-local-map             locate-mode-map)
 321   (setq major-mode          'locate-mode
 322         mode-name           "Locate"
 323         default-directory   "/")
 324   (dired-alist-add-1 default-directory (point-min-marker))
 325   (make-local-variable 'dired-move-to-filename-regexp)
 326   ;; This should support both Unix and Windoze style names
 327   (setq dired-move-to-filename-regexp
 328         (concat "."
 329                 (make-string (1- locate-filename-indentation) ?\ )
 330                 "\\(/\\|[A-Za-z]:\\)"))
 331   (make-local-variable 'dired-actual-switches)
 332   (setq dired-actual-switches "")
 333   (make-local-variable 'dired-permission-flags-regexp)
 334   (setq dired-permission-flags-regexp
 335         (concat "^.\\("
 336                 (make-string (1- locate-filename-indentation) ?\ )
 337                 "\\)"))
 338   (make-local-variable 'revert-buffer-function)
 339   (setq revert-buffer-function 'locate-update)
 340   (run-hooks 'locate-mode-hook))
 341
 342 (defun locate-do-setup ()
 343   (let ((search-string (car locate-history-list)))
 344     (goto-char (point-min))
 345     (save-excursion
 346
 347       ;; Nothing returned from locate command?
 348       (and (eobp)
 349            (progn
 350              (kill-buffer locate-buffer-name)
 351              (if locate-current-filter
 352                  (error "Locate: no match for %s in database using filter %s"
 353                         search-string locate-current-filter)
 354                (error "Locate: no match for %s in database" search-string))))
 355
 356       (locate-insert-header search-string)
 357
 358       (while (not (eobp))
 359         (insert-char ?\  locate-filename-indentation t)
 360         (locate-set-properties)
 361         (forward-line 1)))))
 362
 363 (defun locate-set-properties ()
 364   (save-excursion
 365     (let ((pos (locate-get-file-positions)))
 366       (dired-insert-set-properties (elt pos 0) (elt pos 1)))))
 367
 368 (defun locate-insert-header (search-string)
 369   (let ((locate-format-string "Matches for %s")
 370         (locate-regexp-match
 371          (concat " *Matches for \\(" (regexp-quote search-string) "\\)"))
 372         (locate-format-args (list search-string))
 373         )
 374
 375     (and locate-fcodes-file
 376         (setq locate-format-string
 377               (concat locate-format-string " in %s")
 378               locate-regexp-match
 379               (concat locate-regexp-match
 380                       " in \\("
 381                       (regexp-quote locate-fcodes-file)
 382                       "\\)")
 383               locate-format-args
 384               (append (list locate-fcodes-file) locate-format-args)))
 385
 386     (and locate-current-filter
 387         (setq locate-format-string
 388               (concat locate-format-string " using filter %s")
 389               locate-regexp-match
 390               (concat locate-regexp-match
 391                       " using filter "
 392                       "\\("
 393                       (regexp-quote locate-current-filter)
 394                       "\\)")
 395               locate-format-args
 396               (append (list locate-current-filter) locate-format-args)))
 397
 398     (setq locate-format-string
 399           (concat locate-format-string ": \n\n")
 400           locate-regexp-match
 401           (concat locate-regexp-match ": \n"))
 402
 403     (insert (apply 'format locate-format-string (reverse locate-format-args)))
 404
 405     (save-excursion
 406       (goto-char (point-min))
 407       (if (not (looking-at locate-regexp-match))
 408           nil
 409         (add-text-properties (match-beginning 1) (match-end 1)
 410                              (list 'face locate-header-face))
 411         (and (match-beginning 2)
 412              (add-text-properties (match-beginning 2) (match-end 2)
 413                                   (list 'face locate-header-face)))
 414         (and (match-beginning 3)
 415              (add-text-properties (match-beginning 3) (match-end 3)
 416                                   (list 'face locate-header-face)))
 417         ))))
 418
 419 (defun locate-tags ()
 420   "Visit a tags table in `*Locate*' mode."
 421   (interactive)
 422   (let ((tags-table (locate-get-filename)))
 423     (and (y-or-n-p (format "Visit tags table %s? " tags-table))
 424          (visit-tags-table tags-table))))
 425
 426 ;; From Stephen Eglen <stephen@cns.ed.ac.uk>
 427 (defun locate-update (ignore1 ignore2)
 428   "Update the locate database.
 429 Database is updated using the shell command in `locate-update-command'."
 430   (let ((str (car locate-history-list)))
 431     (cond ((yes-or-no-p "Update locate database (may take a few seconds)? ")
 432            (shell-command locate-update-command)
 433            (locate nil str)))))
 434
 435 ;;; Modified three functions from `dired.el':
 436 ;;;   dired-find-directory,
 437 ;;;   dired-find-directory-other-window
 438 ;;;   dired-get-filename
 439
 440 (defun locate-find-directory ()
 441   "Visit the directory of the file mentioned on this line."
 442   (interactive)
 443   (let ((directory-name (locate-get-dirname)))
 444     (if (file-directory-p directory-name)
 445         (find-file directory-name)
 446       (if (file-symlink-p directory-name)
 447           (error "Directory is a symlink to a nonexistent target")
 448         (error "Directory no longer exists; run `updatedb' to update database")))))
 449
 450 (defun locate-find-directory-other-window ()
 451   "Visit the directory of the file named on this line in other window."
 452   (interactive)
 453   (find-file-other-window (locate-get-dirname)))
 454
 455 (defun locate-get-dirname ()
 456   "Return the directory name of the file mentioned on this line."
 457   (let (file (filepos (locate-get-file-positions)))
 458     (if (setq file (buffer-substring (nth 0 filepos) (nth 1 filepos)))
 459         (progn
 460           ;; Get rid of the mouse-face property that file names have.
 461           (set-text-properties 0 (length file) nil file)
 462           (setq file (file-name-directory file))
 463           ;; Unquote names quoted by ls or by dired-insert-directory.
 464           ;; Using read to unquote is much faster than substituting
 465           ;; \007 (4 chars) -> ^G  (1 char) etc. in a lisp loop.
 466           (setq file
 467                 (read
 468                  (concat "\""
 469                          ;; some ls -b don't escape quotes, argh!
 470                          ;; This is not needed for GNU ls, though.
 471                          (or (dired-string-replace-match
 472                               "\\([^\\]\\|\\`\\)\"" file "\\1\\\\\"" nil t)
 473                              file)
 474                          "\"")))))
 475     (and file buffer-file-coding-system
 476          (not file-name-coding-system)
 477          (setq file (encode-coding-string file buffer-file-coding-system)))
 478     file))
 479
 480 ;; Only for GNU locate
 481 (defun locate-in-alternate-database  (search-string database)
 482   "Run the GNU locate command, using an alternate database."
 483   (interactive
 484       (list
 485        (progn
 486          ;; (require 'locate)
 487          (read-from-minibuffer "Locate: " nil nil
 488                                nil 'locate-history-list))
 489        (read-file-name "Locate using Database: " )
 490        ))
 491   (or (file-exists-p database)
 492       (error "Database file %s does not exist" database))
 493   (let ((locate-make-command-line
 494          (function (lambda (string)
 495                      (cons locate-command
 496                            (list (concat "--database="
 497                                          (expand-file-name database))
 498                                  string))))))
 499     (locate nil search-string)))
 500
 501 (provide 'locate)
 502
 503 ;;; locate.el ends here