locate.el 12.8 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
;;; locate.el --- interface to the locate command
Richard M. Stallman's avatar
Richard M. Stallman committed
2

3
;; Copyright (C) 1996, 1998 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

5
;; Author: Peter Breton <pbreton@cs.umb.edu>
Richard M. Stallman's avatar
Richard M. Stallman committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39

;; 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.

;;; Commentary:

;; 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:
;; 
40
;; (defvar locate-fcodes-file       "c:/users/peter/fcodes")
Richard M. Stallman's avatar
Richard M. Stallman committed
41 42 43
;; (defvar locate-make-command-line 'nt-locate-make-command-line)
;; 
;; (defun nt-locate-make-command-line (arg)
44
;;  (list "grep" "-i" arg locate-fcodes-file))
Richard M. Stallman's avatar
Richard M. Stallman committed
45 46 47 48 49 50 51 52 53 54 55 56 57
;;
;;;;;;;; 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)
;;     ))
;;
58
;; Otherwise, `dired-make-relative' will give error messages like
Richard M. Stallman's avatar
Richard M. Stallman committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72
;; "FILENAME: not in directory tree growing at /"

;;; Commentary:
;;
;; 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
;; form 
;;
;;   SHELLPROGRAM  Name-to-find
;;
73
;; set the variable `locate-command' in your .emacs file.
Richard M. Stallman's avatar
Richard M. Stallman committed
74 75
;;
;;   To use a more complicated expression, create a function which 
76 77 78
;; 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
Richard M. Stallman's avatar
Richard M. Stallman committed
79 80 81 82
;;
;; (setq locate-make-command-line 'my-locate-command-line) 
;;
;; in your .emacs, using the name of your function in place of
83
;; my-locate-command-line.
Richard M. Stallman's avatar
Richard M. Stallman committed
84 85 86 87 88
;;
;; 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
89
;; your emacs process.
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91 92 93 94
;;
;; 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 
95
;; `locate-get-file-positions' to return a list consisting of the first
Richard M. Stallman's avatar
Richard M. Stallman committed
96 97 98 99 100 101 102 103 104
;; 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
105
;; of sync until the next time the database is updated.
Richard M. Stallman's avatar
Richard M. Stallman committed
106
;;
107
;; The command `locate-with-filter' keeps only lines matching a
Richard M. Stallman's avatar
Richard M. Stallman committed
108 109 110 111 112 113 114 115 116 117
;; regular expression; this is often useful to constrain a big search.
;;

;;; Code:

(eval-when-compile
  (require 'dired))

;; Variables

118 119
(defvar locate-current-filter nil)

Stephen Eglen's avatar
Stephen Eglen committed
120 121 122 123
(defgroup locate nil
  "Interface to the locate command."
  :prefix "locate-"
  :group 'external)
Richard M. Stallman's avatar
Richard M. Stallman committed
124

Stephen Eglen's avatar
Stephen Eglen committed
125 126 127 128
(defcustom locate-command "locate"
  "*The executable program used to search a database of files."
  :type 'string
  :group 'locate)
Richard M. Stallman's avatar
Richard M. Stallman committed
129

Stephen Eglen's avatar
Stephen Eglen committed
130 131
(defvar locate-history-list nil
  "The history list used by the \\[locate] command.")
Richard M. Stallman's avatar
Richard M. Stallman committed
132

Stephen Eglen's avatar
Stephen Eglen committed
133 134 135 136 137 138 139 140 141 142 143
(defcustom locate-make-command-line 'locate-default-make-command-line
  "*Function used to create the locate command line."
  :type 'function
  :group 'locate)

(defcustom locate-buffer-name "*Locate*"
  "*Name of the buffer to show results from the \\[locate] command."
  :type 'string
  :group 'locate)

(defcustom locate-fcodes-file nil
144 145
  "*File name for the database of file names."
  :type '(choice file (const nil))
Stephen Eglen's avatar
Stephen Eglen committed
146 147 148 149 150 151 152
  :group 'locate)

(defcustom locate-mouse-face 'highlight
  "*Face used to highlight locate entries."
  :type 'face
  :group 'locate)

153
(defcustom locate-header-face 'underline
Stephen Eglen's avatar
Stephen Eglen committed
154 155 156
  "*Face used to highlight the locate header."
  :type 'face
  :group 'locate)
Richard M. Stallman's avatar
Richard M. Stallman committed
157

158 159 160 161
(defcustom locate-update-command "updatedb"
  "The command used to update the locate database."
  :type 'string
  :group 'locate)
Richard M. Stallman's avatar
Richard M. Stallman committed
162 163 164 165

;; Functions

(defun locate-default-make-command-line (search-string)
166
  (list locate-command search-string))
Richard M. Stallman's avatar
Richard M. Stallman committed
167 168 169 170 171 172 173

;;;### autoload
(defun locate (search-string &optional filter)
  "Run the \\[locate] command, putting results in `*Locate*' buffer."
  (interactive
      (list (read-from-minibuffer "Locate: " nil nil
		  nil 'locate-history-list)))
174
  (let* ((locate-cmd-list (funcall locate-make-command-line search-string))
Richard M. Stallman's avatar
Richard M. Stallman committed
175 176
	 (locate-cmd (car locate-cmd-list))
	 (locate-cmd-args (cdr locate-cmd-list))
177
	 )
Richard M. Stallman's avatar
Richard M. Stallman committed
178 179
    
    ;; Find the Locate buffer
180 181 182 183 184 185 186 187 188 189
    (save-window-excursion
      (set-buffer (get-buffer-create locate-buffer-name))
      (locate-mode)
      (erase-buffer)
      
      (setq locate-current-filter filter)
      
      (apply 'call-process locate-cmd nil t nil locate-cmd-args)
      (and filter
	  (locate-filter-output filter))
Richard M. Stallman's avatar
Richard M. Stallman committed
190

191 192 193 194 195 196
      (locate-do-setup)
      )
    (and (not (string-equal (buffer-name) locate-buffer-name))
	(switch-to-buffer-other-window locate-buffer-name))
    )
  )
Richard M. Stallman's avatar
Richard M. Stallman committed
197 198 199 200 201

;;;### autoload
(defun locate-with-filter (search-string filter)
  "Run the locate command with a filter."
  (interactive
202 203 204 205
   (list (read-from-minibuffer "Locate: " nil nil
			       nil 'locate-history-list)
	 (read-from-minibuffer "Filter: " nil nil
			       nil 'grep-history)))
Richard M. Stallman's avatar
Richard M. Stallman committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
  (locate search-string filter))

(defun locate-filter-output (filter)
  "Filter output from the locate command."
  (goto-char (point-min))
  (delete-non-matching-lines (regexp-quote filter)))

(defvar locate-mode-map nil
  "Local keymap for Locate mode buffers.")
(if locate-mode-map
    nil

   (require 'dired)

   (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] 'mouse-locate-view-file)
   (define-key locate-mode-map "\C-ct"   'locate-tags)

   (define-key locate-mode-map "U"       'dired-unmark-all-files-no-query)
)

;; This variable is used to indent the lines and then to search for
;; the file name
(defconst locate-filename-indentation 4
240
  "The amount of indentation for each file.")
Richard M. Stallman's avatar
Richard M. Stallman committed
241 242 243

(defun locate-get-file-positions ()
  (save-excursion
244 245 246 247 248 249 250
    (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))))
Richard M. Stallman's avatar
Richard M. Stallman committed
251 252

;; From SQL-mode
253
(defun locate-current-line-number ()
Richard M. Stallman's avatar
Richard M. Stallman committed
254 255 256 257 258 259 260 261
  "Return the current line number, as an integer."
  (+ (count-lines (point-min) (point))
     (if (eq (current-column) 0)
	 1
       0)))

(defun locate-get-filename ()
  (let ((pos    (locate-get-file-positions))
262
	(lineno (locate-current-line-number)))
Richard M. Stallman's avatar
Richard M. Stallman committed
263 264 265 266 267 268 269 270 271
    (and (not (eq lineno 1)) 
	 (not (eq lineno 2)) 
	 (buffer-substring (elt pos 0) (elt pos 1)))))

(defun mouse-locate-view-file (event)
  "In Locate mode, view a file, using the mouse."
  (interactive "@e") 
  (save-excursion
    (goto-char (posn-point (event-start event)))
272
    (view-file (locate-get-filename))))
Richard M. Stallman's avatar
Richard M. Stallman committed
273 274 275 276 277 278 279 280 281 282 283 284

;; 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]."
  (kill-all-local-variables)
  (use-local-map             locate-mode-map)
  (setq major-mode          'locate-mode
        mode-name           "Locate"
        default-directory   "/"
	dired-subdir-alist  (list (cons "/" (point-min-marker))))
285 286 287 288 289 290 291
  (make-local-variable 'dired-move-to-filename-regexp)
  (setq dired-move-to-filename-regexp
	(make-string locate-filename-indentation ?\ ))
  (make-local-variable 'dired-actual-switches)
  (setq dired-actual-switches "")
  (make-local-variable 'dired-permission-flags-regexp)
  (setq dired-permission-flags-regexp "^\\(    \\)")
292 293
  (make-local-variable 'revert-buffer-function)
  (setq revert-buffer-function 'locate-update) 
Richard M. Stallman's avatar
Richard M. Stallman committed
294 295 296 297 298 299 300 301
  (run-hooks 'locate-mode-hook))

(defun locate-do-setup ()
  (let ((search-string (car locate-history-list)))
    (goto-char (point-min))
    (save-excursion
      
      ;; Nothing returned from locate command?
302 303 304 305 306 307 308 309
      (and (eobp)
	   (progn
	     (kill-buffer locate-buffer-name)
	     (if locate-current-filter
		 (error "Locate: no match for %s in database using filter %s"
			search-string locate-current-filter)
	       (error "Locate: no match for %s in database" search-string))))
      
Richard M. Stallman's avatar
Richard M. Stallman committed
310 311
      (locate-insert-header search-string)
      
312 313 314 315
      (while (not (eobp))
	(insert-char ?\  locate-filename-indentation t)
	(locate-set-properties)
	(forward-line 1)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329

(defun locate-set-properties ()
  (save-excursion
    (let ((pos (locate-get-file-positions)))
      (add-text-properties (elt pos 0) (elt pos 1)
			   (list 'mouse-face locate-mouse-face)))))

(defun locate-insert-header (search-string)
  (let ((locate-format-string "Matches for %s")
	(locate-regexp-match
	 (concat " *Matches for \\(" (regexp-quote search-string) "\\)"))
	(locate-format-args (list search-string))
	)
  
330
    (and locate-fcodes-file
Richard M. Stallman's avatar
Richard M. Stallman committed
331 332 333 334 335 336 337 338 339 340
	(setq locate-format-string
	      (concat locate-format-string " in %s")
	      locate-regexp-match
	      (concat locate-regexp-match
		      " in \\("
		      (regexp-quote locate-fcodes-file)
		      "\\)")
	      locate-format-args
	      (append (list locate-fcodes-file) locate-format-args)))

341
    (and locate-current-filter
Richard M. Stallman's avatar
Richard M. Stallman committed
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
	(setq locate-format-string
	      (concat locate-format-string " using filter %s")
	      locate-regexp-match
	      (concat locate-regexp-match
		      " using filter "
		      "\\("
		      (regexp-quote locate-current-filter)
		      "\\)")
	      locate-format-args
	      (append (list locate-current-filter) locate-format-args)))
	
    (setq locate-format-string
	  (concat locate-format-string ": \n\n")
	  locate-regexp-match
	  (concat locate-regexp-match ": \n"))
    
358
    (insert (apply 'format locate-format-string (reverse locate-format-args)))
Richard M. Stallman's avatar
Richard M. Stallman committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
    
    (save-excursion
      (goto-char (point-min))
      (if (not (looking-at locate-regexp-match))
	  nil
	(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."
  (interactive)
  (let ((tags-table (locate-get-filename)))
378 379 380 381 382 383 384 385 386 387 388
    (and (y-or-n-p (format "Visit tags table %s? " tags-table)) 
	 (visit-tags-table tags-table))))

;; 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)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
389 390 391 392

(provide 'locate)

;;; locate.el ends here