Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 243 lines (210 sloc) 7.736 kb
1c53655f »
2011-06-10 Initial dump
1 ;;; find-cmd.el --- Build a valid find(1) command with sexps
2
3 ;; Copyright (C) 2008 Free Software Foundation, Inc.
4
5 ;; Author: Philip Jackson <phil@shellarchive.co.uk>
6 ;; Version: 0.6
7
8 ;; This file is part of GNU Emacs.
9
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 of the License, or
13 ;; (at your option) any later version.
14
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.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
22
23 ;;; Commentary:
24
25 ;; With this module you can build up a (hopefully) valid find(1)
26 ;; string ready for the command line. For example:
27
28 ;; (find-cmd '(prune (name ".svn" ".git" ".CVS"))
29 ;; '(and (or (name "*.pl" "*.pm" "*.t")
30 ;; (mtime "+1"))
31 ;; (fstype "nfs" "ufs"))))
32
33 ;; will become (un-wrapped):
34
35 ;; "find '/home/phil/' \\( \\( -name '.svn' -or -name '.git' -or
36 ;; -name '.CVS' \\) -prune -or -true \\) \\( \\( \\( -name '*.pl'
37 ;; -or -name '*.pm' -or -name '*.t' \\) -or -mtime '+1' \\) -and \\(
38 ;; -fstype 'nfs' -or -fstype 'ufs' \\) \\)"
39
40 ;;; Code:
41
42 (defconst find-constituents
43 '((and . find-and)
44 (not . find-not)
45 (or . find-or)
46
47 (a . find-and)
48 (n . find-not)
49 (o . find-or)
50
51 (prune . find-prune)
52
53 ;; switches
54 (L . (0))
55 (P . (0))
56 (H . (0))
57
58 ;; generic tests
59 (amin . (1))
60 (anewer . (1))
61 (atime . (1))
62 (cmin . (1))
63 (cnewer . (1))
64 (ctime . (1))
65 (empty . (0))
66 (false . (0))
67 (fstype . (1))
68 (gid . (1))
69 (group . (1))
70 (ilname . (1))
71 (iname . (1))
72 (inum . (1))
73 (iwholename . (1))
74 (iregex . (1))
75 (links . (1))
76 (lname . (1))
77 (mmin . (1))
78 (mtime . (1))
79 (name . (1))
80 (newer . (1))
81 (nouser . (0))
82 (nogroup . (0))
83 (path . (1))
84 (perm . (0))
85 (regex . (1))
86 (wholename . (1))
87 (size . (1))
88 (true . (0))
89 (type . (1))
90 (uid . (1))
91 (used . (1))
92 (user . (1))
93 (xtype . (nil))
94
95 ;; normal options (always true)
96 (depth . (0))
97 (maxdepth . (1))
98 (mindepth . (1))
99 (mount . (0))
100 (noleaf . (0))
101 (xdev . (0))
102 (ignore_readdir_race . (0))
103 (noignore_readdir_race . (0))
104
105 ;; actions
106 (delete . (0))
107 (print0 . (0))
108 (printf . (1))
109 (fprintf . (2))
110 (print . (0))
111 (fprint0 . (1))
112 (fprint . (1))
113 (ls . (0))
114 (fls . (1))
115 (prune . (0))
116 (quit . (0))
117
118 ;; these need to be terminated with a ;
119 (exec . (1 find-command t))
120 (ok . (1 find-command t))
121 (execdir . (1 find-command t))
122 (okdir . (1 find-command t)))
123 "Holds details of each of the find options. The car of each
124 alist is the name. The cdr is minimum args, the function used
125 to join many occurences of the argument together, and whether or
126 not to leave quotes off the string (non-nil means the string will
127 be quoted).")
128
129 ;;;###autoload
130 (defun find-cmd (&rest subfinds)
131 "Initiate the building of a find command. For exmple:
132
133 \(find-cmd '\(prune \(name \".svn\" \".git\" \".CVS\"\)\)
134 '\(and \(or \(name \"*.pl\" \"*.pm\" \"*.t\"\)
135 \(mtime \"+1\"\)\)
136 \(fstype \"nfs\" \"ufs\"\)\)\)\)
137
138 `default-directory' is used as the initial search path. The
139 result is a string that should be ready for the command line."
140 (concat
141 "find " (shell-quote-argument (expand-file-name default-directory)) " "
142 (cond
143 ((cdr subfinds)
144 (mapconcat 'find-to-string subfinds ""))
145 (t
146 (find-to-string (car subfinds))))))
147
148 (defun find-and (form)
149 "And FORMs together, so:
150 \(and \(mtime \"+1\"\) \(name \"something\"\)\)
151 will produce:
152 find . \\\( -mtime '+1' -and -name 'something' \\\)"
153 (if (< (length form) 2)
154 (find-to-string (car form))
155 (concat "\\( "
156 (mapconcat 'find-to-string form "-and ")
157 "\\) ")))
158
159 (defun find-or (form)
160 "Or FORMs together, so:
161 \(or \(mtime \"+1\"\) \(name \"something\"\)\)
162 will produce:
163 find . \\\( -mtime '+1' -or -name 'something' \\\)"
164 (if (< (length form) 2)
165 (find-to-string (car form))
166 (concat "\\( "
167 (mapconcat 'find-to-string form "-or ")
168 "\\) ")))
169
170 (defun find-not (form)
171 "Or FORMs together and prefix with a -not, so:
172 \(not \(mtime \"+1\"\) \(name \"something\"\)\)
173 will produce:
174 -not \\\( -mtime '+1' -or -name 'something' \\\)
175 If you wanted the FORMs -and(ed) together instead then this would
176 suffice:
177 \(not \(and \(mtime \"+1\"\) \(name \"something\"\)\)\)"
178 (concat "-not " (find-or (mapcar 'find-to-string form))))
179
180 (defun find-prune (form)
181 "-or together FORM(s) postfix '-prune' and then -or that with a
182 -true, so:
183 \(prune \(name \".svn\" \".git\"\)\) \(name \"*.pm\"\)
184 will produce (unwrapped):
185 \\\( \\\( \\\( -name '.svn' -or -name '.git' \\\) /
186 -prune -or -true \\\) -and -name '*.pm' \\\)"
187 (find-or
188 (list
189 (concat (find-or (mapcar 'find-to-string form)) (find-generic "prune"))
190 (find-generic "true"))))
191
192 (defun find-generic (option &optional oper argcount args dont-quote)
193 "This function allows an arbitrary string to be used as a
194 form. OPTION is the name of the form, OPER is the function used
195 to either OR or AND multiple results together. ARGCOUNT is the
196 minimum of args that OPTION can receive and ARGS are the
197 arguments for OPTION."
198 (when (and (numberp argcount) (< (length args) argcount))
199 (error "'%s' needs at least %d arguments" option argcount))
200 (let ((oper (or oper 'find-or)))
201 (if (and args (length args))
202 (funcall oper (mapcar (lambda (x)
203 (concat "-" option
204 (if dont-quote
205 (concat " " x " ")
206 (concat " "
207 (shell-quote-argument x)
208 " "))))
209 args))
210 (concat "-" option " "))))
211
212 (defun find-command (form)
213 "For each item in FORM add a terminating semi-colon and turn
214 them into valid switches. The result is -and(ed) together."
215 (find-and (mapcar (lambda (x)
216 (concat (find-to-string x) "\\; "))
217 form)))
218
219 (defun find-to-string (form)
220 "Parse FORM to produce a set of valid find arguments."
221 (cond
222 ((stringp form)
223 form)
224 ((consp form)
225 (let ((option (cdr (assoc (car form) find-constituents))))
226 (cond
227 ((and (symbolp option) (fboundp option))
228 (funcall option (cdr form)))
229 ((consp option)
230 (let ((option (symbol-name (car form)))
231 (argcnt (car option))
232 (oper (cadr option))
233 (dont-quote (car (cddr option))))
234 (find-to-string
235 (find-generic option oper argcnt (cdr form) dont-quote))))
236 (t
237 (error "Sorry I don't know how to handle '%s'" (car form))))))))
238
239 (provide 'find-cmd)
240
241 ;; arch-tag: 9687fd9e-4e90-4022-864a-f904526e2046
242 ;;; find-cmd.el ends here
Something went wrong with that request. Please try again.