1 ;;; find-dired.el --- run a `find' command and dired the output
3 ;; Copyright (C) 1992, 1994-1995, 2000-2011 Free Software Foundation, Inc.
5 ;; Author: Roland McGrath <roland@gnu.org>,
6 ;; Sebastian Kremer <sk@thp.uni-koeln.de>
10 ;; This file is part of GNU Emacs.
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 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
31 (defgroup find-dired nil
32 "Run a `find' command and dired the output."
36 ;; find's -ls corresponds to these switches.
37 ;; Note -b, at least GNU find quotes spaces etc. in filenames
38 (defcustom find-ls-option
39 (if (eq system-type
'berkeley-unix
) '("-ls" .
"-gilsb")
40 '("-exec ls -ld {} \\;" .
"-ld"))
41 "Description of the option to `find' to produce an `ls -l'-type listing.
42 This is a cons of two strings (FIND-OPTION . LS-SWITCHES). FIND-OPTION
43 gives the option (or options) to `find' that produce the desired output.
44 LS-SWITCHES is a list of `ls' switches to tell dired how to parse the output."
45 :type
'(cons (string :tag
"Find Option")
46 (string :tag
"Ls Switches"))
49 (defcustom find-ls-subdir-switches
"-al"
50 "`ls' switches for inserting subdirectories in `*Find*' buffers.
51 This should contain the \"-l\" switch.
52 Use the \"-F\" or \"-b\" switches if and only if you also use
53 them for `find-ls-option'."
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
))
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'."
69 ;; This used to be autoloaded (see bug#4387).
70 (defcustom find-name-arg
71 (if read-file-name-completion-ignore-case
74 "Argument used to specify file name pattern.
75 If `read-file-name-completion-ignore-case' is non-nil, -iname is used so that
76 find also ignores case. Otherwise, -name is used."
82 "Last arguments given to `find' by \\[find-dired].")
84 ;; History of find-args values entered in the minibuffer.
85 (defvar find-args-history nil
)
87 (defvar dired-sort-inhibit
)
90 (defun find-dired (dir args
)
91 "Run `find' and go into Dired mode on a buffer of the output.
92 The command run (after changing into DIR) is
94 find . \\( ARGS \\) -ls
96 except that the variable `find-ls-option' specifies what to use
97 as the final argument."
98 (interactive (list (read-directory-name "Run find in directory: " nil
"" t
)
99 (read-string "Run find (with args): " find-args
100 '(find-args-history .
1))))
101 (let ((dired-buffers dired-buffers
))
102 ;; Expand DIR ("" means default-directory), and make sure it has a
104 (setq dir
(file-name-as-directory (expand-file-name dir
)))
105 ;; Check that it's really a directory.
106 (or (file-directory-p dir
)
107 (error "find-dired needs a directory: %s" dir
))
108 (switch-to-buffer (get-buffer-create "*Find*"))
110 ;; See if there's still a `find' running, and offer to kill
111 ;; it first, if it is.
112 (let ((find (get-buffer-process (current-buffer))))
114 (if (or (not (eq (process-status find
) 'run
))
115 (yes-or-no-p "A `find' process is running; kill it? "))
118 (interrupt-process find
)
120 (delete-process find
))
122 (error "Cannot have two processes in `%s' at once" (buffer-name)))))
125 (kill-all-local-variables)
126 (setq buffer-read-only nil
)
128 (setq default-directory dir
129 find-args args
; save for next interactive call
130 args
(concat find-program
" . "
131 (if (string= args
"")
134 (shell-quote-argument "(")
136 (shell-quote-argument ")")
138 (if (equal (car find-ls-option
) "-exec ls -ld {} \\;")
139 (concat "-exec ls -ld "
140 (shell-quote-argument "{}")
142 (shell-quote-argument ";"))
143 (car find-ls-option
))))
144 ;; Start the find process.
145 (shell-command (concat args
"&") (current-buffer))
146 ;; The next statement will bomb in classic dired (no optional arg allowed)
147 (dired-mode dir
(cdr find-ls-option
))
148 (let ((map (make-sparse-keymap)))
149 (set-keymap-parent map
(current-local-map))
150 (define-key map
"\C-c\C-k" 'kill-find
)
152 (make-local-variable 'dired-sort-inhibit
)
153 (setq dired-sort-inhibit t
)
154 (set (make-local-variable 'revert-buffer-function
)
155 `(lambda (ignore-auto noconfirm
)
156 (find-dired ,dir
,find-args
)))
157 ;; Set subdir-alist so that Tree Dired will work:
158 (if (fboundp 'dired-simple-subdir-alist
)
159 ;; will work even with nested dired format (dired-nstd.el,v 1.15
161 (dired-simple-subdir-alist)
162 ;; else we have an ancient tree dired (or classic dired, where
163 ;; this does no harm)
164 (set (make-local-variable 'dired-subdir-alist
)
165 (list (cons default-directory
(point-min-marker)))))
166 (set (make-local-variable 'dired-subdir-switches
) find-ls-subdir-switches
)
167 (setq buffer-read-only nil
)
168 ;; Subdir headlerline must come first because the first marker in
169 ;; subdir-alist points there.
170 (insert " " dir
":\n")
171 ;; Make second line a ``find'' line in analogy to the ``total'' or
172 ;; ``wildcard'' line.
173 (insert " " args
"\n")
174 (setq buffer-read-only t
)
175 (let ((proc (get-buffer-process (current-buffer))))
176 (set-process-filter proc
(function find-dired-filter
))
177 (set-process-sentinel proc
(function find-dired-sentinel
))
178 ;; Initialize the process marker; it is used by the filter.
179 (move-marker (process-mark proc
) 1 (current-buffer)))
180 (setq mode-line-process
'(":%s"))))
183 "Kill the `find' process running in the current buffer."
185 (let ((find (get-buffer-process (current-buffer))))
186 (and find
(eq (process-status find
) 'run
)
187 (eq (process-filter find
) (function find-dired-filter
))
189 (delete-process find
)
193 (defun find-name-dired (dir pattern
)
194 "Search DIR recursively for files matching the globbing pattern PATTERN,
195 and run dired on those files.
196 PATTERN is a shell wildcard (not an Emacs regexp) and need not be quoted.
197 The command run (after changing into DIR) is
199 find . -name 'PATTERN' -ls"
201 "DFind-name (directory): \nsFind-name (filename wildcard): ")
202 (find-dired dir
(concat find-name-arg
" " (shell-quote-argument pattern
))))
204 ;; This functionality suggested by
205 ;; From: oblanc@watcgl.waterloo.edu (Olivier Blanc)
206 ;; Subject: find-dired, lookfor-dired
207 ;; Date: 10 May 91 17:50:00 GMT
208 ;; Organization: University of Waterloo
210 (defalias 'lookfor-dired
'find-grep-dired
)
212 (defun find-grep-dired (dir regexp
)
213 "Find files in DIR containing a regexp REGEXP and start Dired on output.
214 The command run (after changing into DIR) is
216 find . -exec grep -s -e REGEXP {} \\\; -ls
218 Thus ARG can also contain additional grep options."
219 (interactive "DFind-grep (directory): \nsFind-grep (grep regexp): ")
220 ;; find -exec doesn't allow shell i/o redirections in the command,
221 ;; or we could use `grep -l >/dev/null'
222 ;; We use -type f, not ! -type d, to avoid getting screwed
223 ;; by FIFOs and devices. I'm not sure what's best to do
224 ;; about symlinks, so as far as I know this is not wrong.
226 (concat "-type f -exec " grep-program
" " find-grep-options
" -e "
227 (shell-quote-argument regexp
)
229 (shell-quote-argument "{}")
231 (shell-quote-argument ";"))))
233 (defun find-dired-filter (proc string
)
234 ;; Filter for \\[find-dired] processes.
235 (let ((buf (process-buffer proc
))
236 (inhibit-read-only t
))
237 (if (buffer-name buf
)
238 (with-current-buffer buf
242 (let ((buffer-read-only nil
)
244 (l-opt (and (consp find-ls-option
)
245 (string-match "l" (cdr find-ls-option
))))
246 (ls-regexp (concat "^ +[^ \t\r\n]+\\( +[^ \t\r\n]+\\) +"
247 "[^ \t\r\n]+ +[^ \t\r\n]+\\( +[0-9]+\\)")))
253 (while (looking-at "^")
256 ;; Convert ` ./FILE' to ` FILE'
257 ;; This would lose if the current chunk of output
258 ;; starts or ends within the ` ./', so back up a bit:
259 (goto-char (- beg
3)) ; no error if < 0
260 (while (search-forward " ./" nil t
)
261 (delete-region (point) (- (point) 2)))
262 ;; Pad the number of links and file size. This is a
263 ;; quick and dirty way of getting the columns to line up
264 ;; most of the time, but it's not foolproof.
267 (goto-char (line-beginning-position))
268 (while (re-search-forward ls-regexp nil t
)
269 (replace-match (format "%4s" (match-string 1))
271 (replace-match (format "%9s" (match-string 2))
274 ;; Find all the complete lines in the unprocessed
275 ;; output and process it to add text properties.
276 (goto-char (point-max))
277 (if (search-backward "\n" (process-mark proc
) t
)
279 (dired-insert-set-properties (process-mark proc
)
281 (move-marker (process-mark proc
) (1+ (point)))))))))
282 ;; The buffer has been killed.
283 (delete-process proc
))))
285 (defun find-dired-sentinel (proc state
)
286 ;; Sentinel for \\[find-dired] processes.
287 (let ((buf (process-buffer proc
))
288 (inhibit-read-only t
))
289 (if (buffer-name buf
)
290 (with-current-buffer buf
291 (let ((buffer-read-only nil
))
293 (goto-char (point-max))
294 (insert "\n find " state
)
295 (forward-char -
1) ;Back up before \n at end of STATE.
296 (insert " at " (substring (current-time-string) 0 19))
298 (setq mode-line-process
300 (symbol-name (process-status proc
))))
301 ;; Since the buffer and mode line will show that the
302 ;; process is dead, we can delete it now. Otherwise it
303 ;; will stay around until M-x list-processes.
304 (delete-process proc
)
305 (force-mode-line-update)))
306 (message "find-dired %s finished." (current-buffer))))))
309 (provide 'find-dired
)
311 ;;; find-dired.el ends here