lisp/find-dired.el

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