]> code.delx.au - gnu-emacs/blobdiff - lisp/find-dired.el
(enum event_kind) [MAC_OS]: Update comment for MAC_APPLE_EVENT.
[gnu-emacs] / lisp / find-dired.el
index 71958d8af63703fe583e9e3c253228cf88030127..88e5414d525116c5c0c94492b4d13b9055eaff97 100644 (file)
 ;;; find-dired.el --- run a `find' command and dired the output
 
-;;; Copyright (C) 1992, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1994, 1995, 2000, 2002, 2003, 2004,
+;;   2005, 2006 Free Software Foundation, Inc.
 
-;; Author: Roland McGrath <roland@gnu.ai.mit.edu>,
+;; Author: Roland McGrath <roland@gnu.org>,
 ;;        Sebastian Kremer <sk@thp.uni-koeln.de>
-;; Maintainer: Sebastian Kremer <sk@thp.uni-koeln.de>
+;; Maintainer: FSF
 ;; Keywords: unix
 
-(defconst find-dired-version (substring "$Revision: 1.17 $" 11 -2)
-  "$Id: find-dired.el,v 1.17 1994/11/19 14:03:23 rms Exp rms $")
-
-;;; This program 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 1, or (at your option)
-;;; any later version.
-;;;
-;;; This program 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.
-;;;
-;;; A copy of the GNU General Public License can be obtained from this
-;;; program's author (send electronic mail to roland@ai.mit.edu) or from
-;;; the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
-;;; 02139, USA.
-;;;
+;; This file is part of GNU Emacs.
 
-;;; Commentary:
+;; 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.
 
-;; LISPDIR ENTRY for the Elisp Archive ===============================
-;;    LCD Archive Entry:
-;;    find-dired|Roland McGrath, Sebastian Kremer
-;;    |roland@gnu.ai.mit.edu, sk@thp.uni-koeln.de
-;;    |Run a `find' command and dired the output
-;;    |$Date: 1994/11/19 14:03:23 $|$Revision: 1.17 $|
+;; 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.
 
-;; INSTALLATION ======================================================
+;; 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., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
 
-;; To use this file, byte-compile it, install it somewhere in your
-;; load-path, and put:
+;;; Commentary:
 
-;;   (autoload 'find-dired "find-dired" nil t)
-;;   (autoload 'find-name-dired "find-dired" nil t)
-;;   (autoload 'find-grep-dired "find-dired" nil t)
+;;; Code:
 
-;; in your ~/.emacs, or site-init.el, etc.
+(require 'dired)
 
-;; To bind it to a key, put, e.g.:
-;;
-;;   (global-set-key "\C-cf" 'find-dired)
-;;   (global-set-key "\C-cn" 'find-name-dired)
-;;   (global-set-key "\C-cl" 'find-grep-dired)
-;;
-;; in your ~/.emacs.
+(defgroup find-dired nil
+  "Run a `find' command and dired the output."
+  :group 'dired
+  :prefix "find-")
 
-;;; Code:
+(defcustom find-dired-find-program "find"
+  "Program used to find files."
+  :group 'dired
+  :type 'file)
 
-(require 'dired)
+;; find's -ls corresponds to these switches.
+;; Note -b, at least GNU find quotes spaces etc. in filenames
+;;;###autoload
+(defcustom find-ls-option
+  (if (eq system-type 'berkeley-unix) '("-ls" . "-gilsb")
+    '("-exec ls -ld {} \\;" . "-ld"))
+  "*Description of the option to `find' to produce an `ls -l'-type listing.
+This is a cons of two strings (FIND-OPTION . LS-SWITCHES).  FIND-OPTION
+gives the option (or options) to `find' that produce the desired output.
+LS-SWITCHES is a list of `ls' switches to tell dired how to parse the output."
+  :type '(cons (string :tag "Find Option")
+              (string :tag "Ls Switches"))
+  :group 'find-dired)
 
 ;;;###autoload
-(defvar find-ls-option (if (eq system-type 'berkeley-unix) "-ls"
-                        "-exec ls -ld {} \\;")
-  "*Option to `find' to produce an `ls -l'-type listing.")
+(defcustom find-ls-subdir-switches "-al"
+  "`ls' switches for inserting subdirectories in `*Find*' buffers.
+This should contain the \"-l\" switch.
+Use the \"-F\" or \"-b\" switches if and only if you also use
+them for `find-ls-option'."
+  :type 'string
+  :group 'find-dired
+  :version "22.1")
 
 ;;;###autoload
-(defvar find-grep-options (if (eq system-type 'berkeley-unix) "-s" "-q")
+(defcustom find-grep-options
+  (if (or (eq system-type 'berkeley-unix)
+         (string-match "solaris2" system-configuration)
+         (string-match "irix" system-configuration))
+      "-s" "-q")
   "*Option to grep to be as silent as possible.
 On Berkeley systems, this is `-s'; on Posix, and with GNU grep, `-q' does it.
-On other systems, the closest you can come is to use `-l'.")
+On other systems, the closest you can come is to use `-l'."
+  :type 'string
+  :group 'find-dired)
 
 (defvar find-args nil
   "Last arguments given to `find' by \\[find-dired].")
 
+;; History of find-args values entered in the minibuffer.
+(defvar find-args-history nil)
+
+(defvar dired-sort-inhibit)
+
 ;;;###autoload
 (defun find-dired (dir args)
-  "Run `find' and go into dired-mode on a buffer of the output.
+  "Run `find' and go into Dired mode on a buffer of the output.
 The command run (after changing into DIR) is
 
-    find . \\( ARGS \\) -ls"
+    find . \\( ARGS \\) -ls
+
+except that the variable `find-ls-option' specifies what to use
+as the final argument."
   (interactive (list (read-file-name "Run find in directory: " nil "" t)
-                    (if (featurep 'gmhist)
-                        (read-with-history-in 'find-args-history
-                                              "Run find (with args): ")
-                      (read-string "Run find (with args): " find-args))))
-  ;; Expand DIR ("" means default-directory), and make sure it has a
-  ;; trailing slash.
-  (setq dir (file-name-as-directory (expand-file-name dir)))
-  ;; Check that it's really a directory.
-  (or (file-directory-p dir)
-      (error "find-dired needs a directory: %s" dir))
-  (switch-to-buffer (get-buffer-create "*Find*"))
-  (widen)
-  (kill-all-local-variables)
-  (setq buffer-read-only nil)
-  (erase-buffer)
-  (setq default-directory dir
-       find-args args                  ; save for next interactive call
-       args (concat "find . "
-                    (if (string= args "")
-                        ""
-                      (concat "\\( " args " \\) "))
-                    find-ls-option))
-  ;; The next statement will bomb in classic dired (no optional arg allowed)
-  ;; find(1)'s -ls corresponds to these switches.
-  ;; Note -b, at least GNU find quotes spaces etc. in filenames
-  (dired-mode dir "-gilsb")
-  ;; Set subdir-alist so that Tree Dired will work:
-  (if (fboundp 'dired-simple-subdir-alist)
-      ;; will work even with nested dired format (dired-nstd.el,v 1.15
-      ;; and later)
-      (dired-simple-subdir-alist)
-    ;; else we have an ancient tree dired (or classic dired, where
-    ;; this does no harm) 
-    (set (make-local-variable 'dired-subdir-alist)
-        (list (cons default-directory (point-min-marker)))))
-  (setq buffer-read-only nil)
-  ;; Subdir headlerline must come first because the first marker in
-  ;; subdir-alist points there.
-  (insert "  " dir ":\n")
-  ;; Make second line a ``find'' line in analogy to the ``total'' or
-  ;; ``wildcard'' line. 
-  (insert "  " args "\n")
-  ;; Start the find process
-  (set-process-filter (start-process-shell-command "find"
-                                                  (current-buffer) args)
-                     (function find-dired-filter))
-  (set-process-sentinel (get-buffer-process (current-buffer))
-                       (function find-dired-sentinel))
-  (setq mode-line-process '(":%s")))
+                    (read-string "Run find (with args): " find-args
+                                 '(find-args-history . 1))))
+  (let ((dired-buffers dired-buffers))
+    ;; Expand DIR ("" means default-directory), and make sure it has a
+    ;; trailing slash.
+    (setq dir (file-name-as-directory (expand-file-name dir)))
+    ;; Check that it's really a directory.
+    (or (file-directory-p dir)
+       (error "find-dired needs a directory: %s" dir))
+    (switch-to-buffer (get-buffer-create "*Find*"))
+
+    ;; See if there's still a `find' running, and offer to kill
+    ;; it first, if it is.
+    (let ((find (get-buffer-process (current-buffer))))
+      (when find
+       (if (or (not (eq (process-status find) 'run))
+               (yes-or-no-p "A `find' process is running; kill it? "))
+           (condition-case nil
+               (progn
+                 (interrupt-process find)
+                 (sit-for 1)
+                 (delete-process find))
+             (error nil))
+         (error "Cannot have two processes in `%s' at once" (buffer-name)))))
+
+    (widen)
+    (kill-all-local-variables)
+    (setq buffer-read-only nil)
+    (erase-buffer)
+    (setq default-directory dir
+         find-args args              ; save for next interactive call
+         args (concat find-dired-find-program " . "
+                      (if (string= args "")
+                          ""
+                        (concat "\\( " args " \\) "))
+                      (car find-ls-option)))
+    ;; Start the find process.
+    (shell-command (concat args "&") (current-buffer))
+    ;; The next statement will bomb in classic dired (no optional arg allowed)
+    (dired-mode dir (cdr find-ls-option))
+    (let ((map (make-sparse-keymap)))
+      (set-keymap-parent map (current-local-map))
+      (define-key map "\C-c\C-k" 'kill-find)
+      (use-local-map map))
+    (make-local-variable 'dired-sort-inhibit)
+    (setq dired-sort-inhibit t)
+    (set (make-local-variable 'revert-buffer-function)
+        `(lambda (ignore-auto noconfirm)
+           (find-dired ,dir ,find-args)))
+    ;; Set subdir-alist so that Tree Dired will work:
+    (if (fboundp 'dired-simple-subdir-alist)
+       ;; will work even with nested dired format (dired-nstd.el,v 1.15
+       ;; and later)
+       (dired-simple-subdir-alist)
+      ;; else we have an ancient tree dired (or classic dired, where
+      ;; this does no harm)
+      (set (make-local-variable 'dired-subdir-alist)
+          (list (cons default-directory (point-min-marker)))))
+    (set (make-local-variable 'dired-subdir-switches) find-ls-subdir-switches)
+    (setq buffer-read-only nil)
+    ;; Subdir headlerline must come first because the first marker in
+    ;; subdir-alist points there.
+    (insert "  " dir ":\n")
+    ;; Make second line a ``find'' line in analogy to the ``total'' or
+    ;; ``wildcard'' line.
+    (insert "  " args "\n")
+    (setq buffer-read-only t)
+    (let ((proc (get-buffer-process (current-buffer))))
+      (set-process-filter proc (function find-dired-filter))
+      (set-process-sentinel proc (function find-dired-sentinel))
+      ;; Initialize the process marker; it is used by the filter.
+      (move-marker (process-mark proc) 1 (current-buffer)))
+    (setq mode-line-process '(":%s"))))
+
+(defun kill-find ()
+  "Kill the `find' process running in the current buffer."
+  (interactive)
+  (let ((find (get-buffer-process (current-buffer))))
+    (and find (eq (process-status find) 'run)
+        (eq (process-filter find) (function find-dired-filter))
+        (condition-case nil
+            (delete-process find)
+          (error nil)))))
 
 ;;;###autoload
 (defun find-name-dired (dir pattern)
@@ -139,7 +189,7 @@ The command run (after changing into DIR) is
     find . -name 'PATTERN' -ls"
   (interactive
    "DFind-name (directory): \nsFind-name (filename wildcard): ")
-  (find-dired dir (concat "-name '" pattern "'")))
+  (find-dired dir (concat "-name " (shell-quote-argument pattern))))
 
 ;; This functionality suggested by
 ;; From: oblanc@watcgl.waterloo.edu (Olivier Blanc)
@@ -149,23 +199,28 @@ The command run (after changing into DIR) is
 
 (defalias 'lookfor-dired 'find-grep-dired)
 ;;;###autoload
-(defun find-grep-dired (dir args)
-  "Find files in DIR containing a regexp ARG and start Dired on output.
+(defun find-grep-dired (dir regexp)
+  "Find files in DIR containing a regexp REGEXP and start Dired on output.
 The command run (after changing into DIR) is
 
-    find . -exec grep -s ARG {} \\\; -ls
+    find . -exec grep -s -e REGEXP {} \\\; -ls
 
 Thus ARG can also contain additional grep options."
   (interactive "DFind-grep (directory): \nsFind-grep (grep regexp): ")
   ;; find -exec doesn't allow shell i/o redirections in the command,
   ;; or we could use `grep -l >/dev/null'
+  ;; We use -type f, not ! -type d, to avoid getting screwed
+  ;; by FIFOs and devices.  I'm not sure what's best to do
+  ;; about symlinks, so as far as I know this is not wrong.
   (find-dired dir
-             (concat "! -type d -exec grep " find-grep-options " "
-                     args " {} \\\; ")))
+             (concat "-type f -exec grep " find-grep-options " -e "
+                     (shell-quote-argument regexp)
+                     " {} \\\; ")))
 
 (defun find-dired-filter (proc string)
   ;; Filter for \\[find-dired] processes.
-  (let ((buf (process-buffer proc)))
+  (let ((buf (process-buffer proc))
+       (inhibit-read-only t))
     (if (buffer-name buf)              ; not killed?
        (save-excursion
          (set-buffer buf)
@@ -184,23 +239,33 @@ Thus ARG can also contain additional grep options."
                  (forward-line 1))
                ;; Convert ` ./FILE' to ` FILE'
                ;; This would lose if the current chunk of output
-               ;; starts or ends within the ` ./', so backup up a bit:
+               ;; starts or ends within the ` ./', so back up a bit:
                (goto-char (- end 3))   ; no error if < 0
                (while (search-forward " ./" nil t)
-                 (delete-region (point) (- (point) 2)))))))
+                 (delete-region (point) (- (point) 2)))
+               ;; Find all the complete lines in the unprocessed
+               ;; output and process it to add text properties.
+               (goto-char end)
+               (if (search-backward "\n" (process-mark proc) t)
+                   (progn
+                     (dired-insert-set-properties (process-mark proc)
+                                                  (1+ (point)))
+                     (move-marker (process-mark proc) (1+ (point)))))
+               ))))
       ;; The buffer has been killed.
       (delete-process proc))))
 
 (defun find-dired-sentinel (proc state)
   ;; Sentinel for \\[find-dired] processes.
-  (let ((buf (process-buffer proc)))
+  (let ((buf (process-buffer proc))
+       (inhibit-read-only t))
     (if (buffer-name buf)
        (save-excursion
          (set-buffer buf)
          (let ((buffer-read-only nil))
            (save-excursion
              (goto-char (point-max))
-             (insert "\nfind " state)
+             (insert "\n  find " state)
              (forward-char -1)         ;Back up before \n at end of STATE.
              (insert " at " (substring (current-time-string) 0 19))
              (forward-char 1)
@@ -211,10 +276,11 @@ Thus ARG can also contain additional grep options."
              ;; process is dead, we can delete it now.  Otherwise it
              ;; will stay around until M-x list-processes.
              (delete-process proc)
-             ;; Force mode line redisplay soon.
-             (set-buffer-modified-p (buffer-modified-p))))
+             (force-mode-line-update)))
          (message "find-dired %s finished." (current-buffer))))))
+
 \f
 (provide 'find-dired)
 
+;;; arch-tag: 8edece95-af00-4221-bc74-a4bd2f75f9b0
 ;;; find-dired.el ends here