lisp/find-dired.el

   1 ;;; find-dired.el --- run a `find' command and dired the output
   2
   3 ;; Copyright (C) 1992, 1994, 1995, 2000, 2002 Free Software Foundation, Inc.
   4
   5 ;; Author: Roland McGrath <roland@gnu.org>,
   6 ;;         Sebastian Kremer <sk@thp.uni-koeln.de>
   7 ;; Maintainer: FSF
   8 ;; Keywords: unix
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  25 ;; Boston, MA 02111-1307, USA.
  26
  27 ;;; Commentary:
  28
  29 ;;; Code:
  30
  31 (require 'dired)
  32
  33 (defgroup find-dired nil
  34   "Run a `find' command and dired the output."
  35   :group 'dired
  36   :prefix "find-")
  37
  38 (defcustom find-dired-find-program "find"
  39   "Program used to find files."
  40   :group 'dired
  41   :type 'file)
  42
  43 ;; find's -ls corresponds to these switches.
  44 ;; Note -b, at least GNU find quotes spaces etc. in filenames
  45 ;;;###autoload
  46 (defcustom find-ls-option
  47   (if (eq system-type 'berkeley-unix) '("-ls" . "-gilsb")
  48     '("-exec ls -ld {} \\;" . "-ld"))
  49   "*Description of the option to `find' to produce an `ls -l'-type listing.
  50 This is a cons of two strings (FIND-OPTION . LS-SWITCHES).  FIND-OPTION
  51 gives the option (or options) to `find' that produce the desired output.
  52 LS-SWITCHES is a list of `ls' switches to tell dired how to parse the output."
  53   :type '(cons (string :tag "Find Option")
  54                (string :tag "Ls Switches"))
  55   :group 'find-dired)
  56
  57 ;;;###autoload
  58 (defcustom find-grep-options
  59   (if (or (eq system-type 'berkeley-unix)
  60           (string-match "solaris2" system-configuration)
  61           (string-match "irix" system-configuration))
  62       "-s" "-q")
  63   "*Option to grep to be as silent as possible.
  64 On Berkeley systems, this is `-s'; on Posix, and with GNU grep, `-q' does it.
  65 On other systems, the closest you can come is to use `-l'."
  66   :type 'string
  67   :group 'find-dired)
  68
  69 (defvar find-args nil
  70   "Last arguments given to `find' by \\[find-dired].")
  71
  72 ;; History of find-args values entered in the minibuffer.
  73 (defvar find-args-history nil)
  74
  75 ;;;###autoload
  76 (defun find-dired (dir args)
  77   "Run `find' and go into Dired mode on a buffer of the output.
  78 The command run (after changing into DIR) is
  79
  80     find . \\( ARGS \\) -ls
  81
  82 except that the variable `find-ls-option' specifies what to use
  83 as the final argument."
  84   (interactive (list (read-file-name "Run find in directory: " nil "" t)
  85                      (read-string "Run find (with args): " find-args
  86                                   '(find-args-history . 1))))
  87   (let ((dired-buffers dired-buffers))
  88     ;; Expand DIR ("" means default-directory), and make sure it has a
  89     ;; trailing slash.
  90     (setq dir (abbreviate-file-name
  91                (file-name-as-directory (expand-file-name dir))))
  92     ;; Check that it's really a directory.
  93     (or (file-directory-p dir)
  94         (error "find-dired needs a directory: %s" dir))
  95     (switch-to-buffer (get-buffer-create "*Find*"))
  96
  97     ;; See if there's still a `find' running, and offer to kill
  98     ;; it first, if it is.
  99     (let ((find (get-buffer-process (current-buffer))))
 100       (when find
 101         (if (or (not (eq (process-status find) 'run))
 102                 (yes-or-no-p "A `find' process is running; kill it? "))
 103             (condition-case nil
 104                 (progn
 105                   (interrupt-process find)
 106                   (sit-for 1)
 107                   (delete-process find))
 108               (error nil))
 109           (error "Cannot have two processes in `%s' at once" (buffer-name)))))
 110
 111     (widen)
 112     (kill-all-local-variables)
 113     (setq buffer-read-only nil)
 114     (erase-buffer)
 115     (setq default-directory dir
 116           find-args args                ; save for next interactive call
 117           args (concat find-dired-find-program " . "
 118                        (if (string= args "")
 119                            ""
 120                          (concat "\\( " args " \\) "))
 121                        (car find-ls-option)))
 122     ;; The next statement will bomb in classic dired (no optional arg allowed)
 123     (dired-mode dir (cdr find-ls-option))
 124     ;; This really should rerun the find command, but I don't
 125     ;; have time for that.
 126     (use-local-map (append (make-sparse-keymap) (current-local-map)))
 127     (define-key (current-local-map) "g" 'undefined)
 128     ;; Set subdir-alist so that Tree Dired will work:
 129     (if (fboundp 'dired-simple-subdir-alist)
 130         ;; will work even with nested dired format (dired-nstd.el,v 1.15
 131         ;; and later)
 132         (dired-simple-subdir-alist)
 133       ;; else we have an ancient tree dired (or classic dired, where
 134       ;; this does no harm)
 135       (set (make-local-variable 'dired-subdir-alist)
 136            (list (cons default-directory (point-min-marker)))))
 137     (setq buffer-read-only nil)
 138     ;; Subdir headlerline must come first because the first marker in
 139     ;; subdir-alist points there.
 140     (insert "  " dir ":\n")
 141     ;; Make second line a ``find'' line in analogy to the ``total'' or
 142     ;; ``wildcard'' line.
 143     (insert "  " args "\n")
 144     ;; Start the find process.
 145     (let ((proc (start-process-shell-command find-dired-find-program (current-buffer) args)))
 146       (set-process-filter proc (function find-dired-filter))
 147       (set-process-sentinel proc (function find-dired-sentinel))
 148       ;; Initialize the process marker; it is used by the filter.
 149       (move-marker (process-mark proc) 1 (current-buffer)))
 150     (setq mode-line-process '(":%s"))))
 151
 152 ;;;###autoload
 153 (defun find-name-dired (dir pattern)
 154   "Search DIR recursively for files matching the globbing pattern PATTERN,
 155 and run dired on those files.
 156 PATTERN is a shell wildcard (not an Emacs regexp) and need not be quoted.
 157 The command run (after changing into DIR) is
 158
 159     find . -name 'PATTERN' -ls"
 160   (interactive
 161    "DFind-name (directory): \nsFind-name (filename wildcard): ")
 162   (find-dired dir (concat "-name " (shell-quote-argument pattern))))
 163
 164 ;; This functionality suggested by
 165 ;; From: oblanc@watcgl.waterloo.edu (Olivier Blanc)
 166 ;; Subject: find-dired, lookfor-dired
 167 ;; Date: 10 May 91 17:50:00 GMT
 168 ;; Organization: University of Waterloo
 169
 170 (defalias 'lookfor-dired 'find-grep-dired)
 171 ;;;###autoload
 172 (defun find-grep-dired (dir regexp)
 173   "Find files in DIR containing a regexp REGEXP and start Dired on output.
 174 The command run (after changing into DIR) is
 175
 176     find . -exec grep -s -e REGEXP {} \\\; -ls
 177
 178 Thus ARG can also contain additional grep options."
 179   (interactive "DFind-grep (directory): \nsFind-grep (grep regexp): ")
 180   ;; find -exec doesn't allow shell i/o redirections in the command,
 181   ;; or we could use `grep -l >/dev/null'
 182   ;; We use -type f, not ! -type d, to avoid getting screwed
 183   ;; by FIFOs and devices.  I'm not sure what's best to do
 184   ;; about symlinks, so as far as I know this is not wrong.
 185   (find-dired dir
 186               (concat "-type f -exec grep " find-grep-options " -e "
 187                       (shell-quote-argument regexp)
 188                       " {} \\\; ")))
 189
 190 (defun find-dired-filter (proc string)
 191   ;; Filter for \\[find-dired] processes.
 192   (let ((buf (process-buffer proc)))
 193     (if (buffer-name buf)               ; not killed?
 194         (save-excursion
 195           (set-buffer buf)
 196           (save-restriction
 197             (widen)
 198             (save-excursion
 199               (let ((buffer-read-only nil)
 200                     (end (point-max)))
 201                 (goto-char end)
 202                 (insert string)
 203                 (goto-char end)
 204                 (or (looking-at "^")
 205                     (forward-line 1))
 206                 (while (looking-at "^")
 207                   (insert "  ")
 208                   (forward-line 1))
 209                 ;; Convert ` ./FILE' to ` FILE'
 210                 ;; This would lose if the current chunk of output
 211                 ;; starts or ends within the ` ./', so back up a bit:
 212                 (goto-char (- end 3))   ; no error if < 0
 213                 (while (search-forward " ./" nil t)
 214                   (delete-region (point) (- (point) 2)))
 215                 ;; Find all the complete lines in the unprocessed
 216                 ;; output and process it to add text properties.
 217                 (goto-char end)
 218                 (if (search-backward "\n" (process-mark proc) t)
 219                     (progn
 220                       (dired-insert-set-properties (process-mark proc)
 221                                                    (1+ (point)))
 222                       (move-marker (process-mark proc) (1+ (point)))))
 223                 ))))
 224       ;; The buffer has been killed.
 225       (delete-process proc))))
 226
 227 (defun find-dired-sentinel (proc state)
 228   ;; Sentinel for \\[find-dired] processes.
 229   (let ((buf (process-buffer proc)))
 230     (if (buffer-name buf)
 231         (save-excursion
 232           (set-buffer buf)
 233           (let ((buffer-read-only nil))
 234             (save-excursion
 235               (goto-char (point-max))
 236               (insert "\n  find " state)
 237               (forward-char -1)         ;Back up before \n at end of STATE.
 238               (insert " at " (substring (current-time-string) 0 19))
 239               (forward-char 1)
 240               (setq mode-line-process
 241                     (concat ":"
 242                             (symbol-name (process-status proc))))
 243               ;; Since the buffer and mode line will show that the
 244               ;; process is dead, we can delete it now.  Otherwise it
 245               ;; will stay around until M-x list-processes.
 246               (delete-process proc)
 247               (force-mode-line-update)))
 248           (message "find-dired %s finished." (current-buffer))))))
 249 \f
 250 (provide 'find-dired)
 251
 252 ;;; find-dired.el ends here