(eval-when-compile
(require 'dired))
(defvar locate-current-filter nil)
(defgroup locate nil
"Interface to the locate command."
:prefix "locate-"
:group 'external)
(defcustom locate-command "locate"
"*The executable program used to search a database of files."
:type 'string
:group 'locate)
(defvar locate-history-list nil
"The history list used by the \\[locate] command.")
(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
"*File name for the database of file names."
:type '(choice file (const nil))
:group 'locate)
(defcustom locate-mouse-face 'highlight
"*Face used to highlight locate entries."
:type 'face
:group 'locate)
(defcustom locate-header-face 'underline
"*Face used to highlight the locate header."
:type 'face
:group 'locate)
(defcustom locate-update-command "updatedb"
"The command used to update the locate database."
:type 'string
:group 'locate)
(defun locate-default-make-command-line (search-string)
(list locate-command search-string))
(defun locate (search-string &optional filter)
"Run the program `locate', putting results in `*Locate*' buffer."
(interactive
(list (read-from-minibuffer "Locate: " nil 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))
)
(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))
(locate-do-setup)
)
(and (not (string-equal (buffer-name) locate-buffer-name))
(switch-to-buffer-other-window 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."
(interactive
(list (read-from-minibuffer "Locate: " nil nil
nil 'locate-history-list)
(read-from-minibuffer "Filter: " nil nil
nil 'grep-history)))
(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))
(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)
)
(defconst locate-filename-indentation 4
"The amount of indentation for each file.")
(defun locate-get-file-positions ()
(save-excursion
(end-of-line)
(let ((eol (point)))
(beginning-of-line)
(forward-char locate-filename-indentation)
(list (point) eol))))
(defun locate-current-line-number ()
"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))
(lineno (locate-current-line-number)))
(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)))
(view-file (locate-get-filename))))
(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))))
(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 "^\\( \\)")
(make-local-variable 'revert-buffer-function)
(setq revert-buffer-function 'locate-update)
(run-hooks 'locate-mode-hook))
(defun locate-do-setup ()
(let ((search-string (car locate-history-list)))
(goto-char (point-min))
(save-excursion
(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))))
(locate-insert-header search-string)
(while (not (eobp))
(insert-char ?\ locate-filename-indentation t)
(locate-set-properties)
(forward-line 1)))))
(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))
)
(and locate-fcodes-file
(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)))
(and locate-current-filter
(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"))
(insert (apply 'format locate-format-string (reverse locate-format-args)))
(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)))
(and (y-or-n-p (format "Visit tags table %s? " tags-table))
(visit-tags-table tags-table))))
(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)))))
(provide 'locate)