1 ;;; find-cmd.el --- Build a valid find(1) command with sexps
3 ;; Copyright (C) 2008 Free Software Foundation, Inc.
5 ;; Author: Philip Jackson <phil@shellarchive.co.uk>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 ;; With this module you can build up a (hopefully) valid find(1)
28 ;; string ready for the command line. For example:
30 ;; (find-cmd '(prune (name ".svn" ".git" ".CVS"))
31 ;; '(and (or (name "*.pl" "*.pm" "*.t")
33 ;; (fstype "nfs" "ufs"))))
35 ;; will become (un-wrapped):
37 ;; "find '/home/phil/' \\( \\( -name '.svn' -or -name '.git' -or
38 ;; -name '.CVS' \\) -prune -or -true \\) \\( \\( \\( -name '*.pl'
39 ;; -or -name '*.pm' -or -name '*.t' \\) -or -mtime '+1' \\) -and \\(
40 ;; -fstype 'nfs' -or -fstype 'ufs' \\) \\)"
42 (eval-when-compile (require 'cl
))
44 (defconst find-constituents
97 ;; normal options (always true)
104 (ignore_readdir_race .
(0))
105 (noignore_readdir_race .
(0))
120 ;; these need to be terminated with a ;
121 (exec .
(1 find-command t
))
122 (ok .
(1 find-command t
))
123 (execdir .
(1 find-command t
))
124 (okdir .
(1 find-command t
)))
125 "Holds details of each of the find options. The car of each
126 alist is the name. The cdr is minimum args, the function used
127 to join many occurences of the argument together, and whether or
128 not to leave quotes off the string (non-nil means the string will
132 (defun find-cmd (&rest subfinds
)
133 "Initiate the building of a find command. For exmple:
135 \(find-cmd '\(prune \(name \".svn\" \".git\" \".CVS\"\)\)
136 '\(and \(or \(name \"*.pl\" \"*.pm\" \"*.t\"\)
138 \(fstype \"nfs\" \"ufs\"\)\)\)\)
140 `default-directory' is used as the initial search path. The
141 result is a string that should be ready for the command line."
143 "find " (shell-quote-argument (expand-file-name default-directory
)) " "
146 (mapconcat 'find-to-string subfinds
""))
148 (find-to-string (car subfinds
))))))
150 (defun find-and (form)
151 "And FORMs together, so:
152 \(and \(mtime \"+1\"\) \(name \"something\"\)\)
154 find . \\\( -mtime '+1' -and -name 'something' \\\)"
155 (if (< (length form
) 2)
156 (find-to-string (car form
))
158 (mapconcat 'find-to-string form
"-and ")
161 (defun find-or (form)
162 "Or FORMs together, so:
163 \(or \(mtime \"+1\"\) \(name \"something\"\)\)
165 find . \\\( -mtime '+1' -or -name 'something' \\\)"
166 (if (< (length form
) 2)
167 (find-to-string (car form
))
169 (mapconcat 'find-to-string form
"-or ")
172 (defun find-not (form)
173 "Or FORMs together and prefix with a -not, so:
174 \(not \(mtime \"+1\"\) \(name \"something\"\)\)
176 -not \\\( -mtime '+1' -or -name 'something' \\\)
177 If you wanted the FORMs -and(ed) together instead then this would
179 \(not \(and \(mtime \"+1\"\) \(name \"something\"\)\)\)"
180 (concat "-not " (find-or (mapcar 'find-to-string form
))))
182 (defun find-prune (form)
183 "-or together FORM(s) postfix '-prune' and then -or that with a
185 \(prune \(name \".svn\" \".git\"\)\) \(name \"*.pm\"\)
186 will produce (unwrapped):
187 \\\( \\\( \\\( -name '.svn' -or -name '.git' \\\) /
188 -prune -or -true \\\) -and -name '*.pm' \\\)"
191 (concat (find-or (mapcar 'find-to-string form
)) (find-generic "prune"))
192 (find-generic "true"))))
194 (defun find-generic (option &optional oper argcount args dont-quote
)
195 "This function allows an arbitrary string to be used as a
196 form. OPTION is the name of the form, OPER is the function used
197 to either OR or AND multiple results together. ARGCOUNT is the
198 minimum of args that OPTION can receive and ARGS are the
199 arguments for OPTION."
200 (when (and (numberp argcount
) (< (length args
) argcount
))
201 (error "'%s' needs at least %d arguments" option argcount
))
202 (let ((oper (or oper
'find-or
)))
203 (if (and args
(length args
))
204 (funcall oper
(mapcar (lambda (x)
209 (shell-quote-argument x
)
212 (concat "-" option
" "))))
214 (defun find-command (form)
215 "For each item in FORM add a terminating semi-colon and turn
216 them into valid switches. The result is -and(ed) together."
217 (find-and (mapcar (lambda (x)
218 (concat (find-to-string x
) "\\; "))
221 (defun find-to-string (form)
222 "Parse FORM to produce a set of valid find arguments."
227 (let ((option (cdr (assoc (car form
) find-constituents
))))
229 ((and (symbolp option
) (fboundp option
))
230 (funcall option
(cdr form
)))
232 (let ((option (symbol-name (car form
)))
233 (argcnt (car option
))
235 (dont-quote (car (cddr option
))))
237 (find-generic option oper argcnt
(cdr form
) dont-quote
))))
239 (error "Sorry I don't know how to handle '%s'" (car form
))))))))