scheme interaction mode
[bpt/emacs.git] / lisp / find-dired.el
index d24a51e..6ddeab7 100644 (file)
@@ -1,10 +1,11 @@
 ;;; find-dired.el --- run a `find' command and dired the output
 
-;; Copyright (C) 1992, 1994-1995, 2000-2011 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1994-1995, 2000-2014 Free Software Foundation,
+;; Inc.
 
 ;; Author: Roland McGrath <roland@gnu.org>,
 ;;        Sebastian Kremer <sk@thp.uni-koeln.de>
-;; Maintainer: FSF
+;; Maintainer: emacs-devel@gnu.org
 ;; Keywords: unix
 
 ;; This file is part of GNU Emacs.
 (require 'dired)
 
 (defgroup find-dired nil
-  "Run a `find' command and dired the output."
+  "Run a `find' command and Dired the output."
   :group 'dired
   :prefix "find-")
 
+;; FIXME this option does not really belong in this file, it's more general.
+;; Eg cf some tests in grep.el.
+(defcustom find-exec-terminator
+  (if (eq 0
+         (ignore-errors
+           (process-file find-program nil nil nil
+                         null-device "-exec" "echo" "{}" "+")))
+      "+"
+    (shell-quote-argument ";"))
+  "String that terminates \"find -exec COMMAND {} \".
+The value should include any needed quoting for the shell.
+Common values are \"+\" and \"\\\\;\", with the former more efficient
+than the latter."
+  :version "24.1"
+  :group 'find-dired
+  :type 'string)
+
 ;; find's -ls corresponds to these switches.
 ;; Note -b, at least GNU find quotes spaces etc. in filenames
 (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."
+  (if (eq 0
+         (ignore-errors
+           (process-file find-program nil nil nil null-device "-ls")))
+      (cons "-ls"
+           (if (eq system-type 'berkeley-unix)
+               "-gilsb"
+             "-dilsb"))
+    (cons
+     (format "-exec ls -ld {} %s" find-exec-terminator)
+     "-ld"))
+  "A pair of options to produce and parse an `ls -l'-type list from `find'.
+This is a cons of two strings (FIND-OPTION . LS-SWITCHES).
+FIND-OPTION is the option (or options) passed to `find' to produce
+a file listing in the desired format.  LS-SWITCHES is a set of
+`ls' switches that tell dired how to parse the output of `find'.
+
+The two options must be set to compatible values.
+For example, to use human-readable file sizes with GNU ls:
+   \(\"-exec ls -ldh {} +\" . \"-ldh\")
+
+To use GNU find's inbuilt \"-ls\" option to list files:
+   \(\"-ls\" . \"-dilsb\")
+since GNU find's output has the same format as using GNU ls with
+the options \"-dilsb\"."
+  :version "24.1"             ; add tests for -ls and -exec + support
   :type '(cons (string :tag "Find Option")
               (string :tag "Ls Switches"))
   :group 'find-dired)
 
-(defcustom find-ls-subdir-switches "-al"
+(defcustom find-ls-subdir-switches
+  (if (string-match "-[a-z]*b" (cdr find-ls-option))
+      "-alb"
+    "-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'."
+  :version "24.1"                      ; add -b test
   :type 'string
-  :group 'find-dired
-  :version "22.1")
+  :group 'find-dired)
 
 (defcustom find-grep-options
   (if (or (eq system-type 'berkeley-unix)
-         (string-match "solaris2" system-configuration)
-         (string-match "irix" system-configuration))
+         (string-match "solaris2\\|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.
@@ -89,12 +128,12 @@ find also ignores case.  Otherwise, -name is used."
 ;;;###autoload
 (defun find-dired (dir args)
   "Run `find' and go into Dired mode on a buffer of the output.
-The command run (after changing into DIR) is
+The command run (after changing into DIR) is essentially
 
     find . \\( ARGS \\) -ls
 
-except that the variable `find-ls-option' specifies what to use
-as the final argument."
+except that the car of the variable `find-ls-option' specifies what to
+use in place of \"-ls\" as the final argument."
   (interactive (list (read-directory-name "Run find in directory: " nil "" t)
                     (read-string "Run find (with args): " find-args
                                  '(find-args-history . 1))))
@@ -135,11 +174,12 @@ as the final argument."
                          " " args " "
                          (shell-quote-argument ")")
                          " "))
-                      (if (equal (car find-ls-option) "-exec ls -ld {} \\;")
-                          (concat "-exec ls -ld "
+                      (if (string-match "\\`\\(.*\\) {} \\(\\\\;\\|+\\)\\'"
+                                        (car find-ls-option))
+                          (format "%s %s %s"
+                                  (match-string 1 (car find-ls-option))
                                   (shell-quote-argument "{}")
-                                  " "
-                                  (shell-quote-argument ";"))
+                                  find-exec-terminator)
                         (car find-ls-option))))
     ;; Start the find process.
     (shell-command (concat args "&") (current-buffer))
@@ -170,13 +210,15 @@ as the final argument."
     (insert "  " dir ":\n")
     ;; Make second line a ``find'' line in analogy to the ``total'' or
     ;; ``wildcard'' line.
-    (insert "  " args "\n")
+    (let ((point (point)))
+      (insert "  " args "\n")
+      (dired-insert-set-properties point (point)))
     (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)))
+      (move-marker (process-mark proc) (point) (current-buffer)))
     (setq mode-line-process '(":%s"))))
 
 (defun kill-find ()
@@ -192,11 +234,13 @@ as the final argument."
 ;;;###autoload
 (defun find-name-dired (dir pattern)
   "Search DIR recursively for files matching the globbing pattern PATTERN,
-and run dired on those files.
+and run Dired on those files.
 PATTERN is a shell wildcard (not an Emacs regexp) and need not be quoted.
-The command run (after changing into DIR) is
+The default command run (after changing into DIR) is
+
+    find . -name 'PATTERN' -ls
 
-    find . -name 'PATTERN' -ls"
+See `find-name-arg' to customize the arguments."
   (interactive
    "DFind-name (directory): \nsFind-name (filename wildcard): ")
   (find-dired dir (concat find-name-arg " " (shell-quote-argument pattern))))
@@ -210,12 +254,17 @@ The command run (after changing into DIR) is
 (defalias 'lookfor-dired 'find-grep-dired)
 ;;;###autoload
 (defun find-grep-dired (dir regexp)
-  "Find files in DIR containing a regexp REGEXP and start Dired on output.
+  "Find files in DIR matching a regexp REGEXP and start Dired on output.
 The command run (after changing into DIR) is
 
-    find . -exec grep -s -e REGEXP {} \\\; -ls
+  find . \\( -type f -exec `grep-program' `find-grep-options' \\
+    -e REGEXP {} \\; \\) -ls
 
-Thus ARG can also contain additional grep options."
+where the car of the variable `find-ls-option' specifies what to
+use in place of \"-ls\" as the final argument."
+  ;; Doc used to say "Thus ARG can also contain additional grep options."
+  ;; i) Presumably ARG == REGEXP?
+  ;; ii) No it can't have options, since it gets shell-quoted.
   (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'
@@ -228,6 +277,7 @@ Thus ARG can also contain additional grep options."
                      " "
                      (shell-quote-argument "{}")
                      " "
+                     ;; Doesn't work with "+".
                      (shell-quote-argument ";"))))
 
 (defun find-dired-filter (proc string)
@@ -291,10 +341,11 @@ Thus ARG can also contain additional grep options."
          (let ((buffer-read-only nil))
            (save-excursion
              (goto-char (point-max))
-             (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)
+             (let ((point (point)))
+               (insert "\n  find " state)
+               (forward-char -1)               ;Back up before \n at end of STATE.
+               (insert " at " (substring (current-time-string) 0 19))
+               (dired-insert-set-properties point (point)))
              (setq mode-line-process
                    (concat ":"
                            (symbol-name (process-status proc))))