2 # Copyright (c) 2013 The Chromium Authors. All rights reserved.
3 # Use of this source code is governed by a BSD-style license that can be
4 # found in the LICENSE file.
22 # 'KEY' : ( <TYPE>, [Accepted Values], <Required?>)
24 'DISABLE': (bool, [True, False], False),
25 'SEL_LDR': (bool, [True, False], False),
26 # Disable this project from being included in the NaCl packaged app.
27 'DISABLE_PACKAGE': (bool, [True, False], False),
28 # Don't generate the additional files to allow this project to run as a
29 # packaged app (i.e. manifest.json, background.js, etc.).
30 'NO_PACKAGE_FILES': (bool, [True, False], False),
31 'TOOLS' : (list, VALID_TOOLCHAINS, True),
32 'CONFIGS' : (list, ['Debug', 'Release'], False),
33 'PREREQ' : (list, '', False),
35 'NAME': (str, '', True),
37 # lib = library target
38 # so = shared object target, automatically added to NMF
39 # so-standalone = shared object target, not put into NMF
40 'TYPE': (str, ['main', 'lib', 'static-lib', 'so', 'so-standalone'],
42 'SOURCES': (list, '', True),
43 'CFLAGS': (list, '', False),
44 'CFLAGS_GCC': (list, '', False),
45 'CXXFLAGS': (list, '', False),
46 'DEFINES': (list, '', False),
47 'LDFLAGS': (list, '', False),
48 'INCLUDES': (list, '', False),
49 'LIBS' : (dict, VALID_TOOLCHAINS, False),
50 'DEPS' : (list, '', False)
53 'FILES': (list, '', True),
54 'DEST': (str, '', True),
56 'SEARCH': (list, '', False),
57 'POST': (str, '', False),
58 'PRE': (str, '', False),
59 'DEST': (str, ['getting_started', 'examples/api',
60 'examples/demo', 'examples/tutorial',
61 'src', 'tests'], True),
62 'NAME': (str, '', False),
63 'DATA': (list, '', False),
64 'TITLE': (str, '', False),
65 'GROUP': (str, '', False),
66 'EXPERIMENTAL': (bool, [True, False], False),
67 'PERMISSIONS': (list, '', False),
68 'SOCKET_PERMISSIONS': (list, '', False)
72 class ValidationError(Exception):
76 def ValidateFormat(src, dsc_format):
77 # Verify all required keys are there
78 for key in dsc_format:
79 exp_type, exp_value, required = dsc_format[key]
80 if required and key not in src:
81 raise ValidationError('Missing required key %s.' % key)
83 # For each provided key, verify it's valid
85 # Verify the key is known
86 if key not in dsc_format:
87 raise ValidationError('Unexpected key %s.' % key)
89 exp_type, exp_value, required = dsc_format[key]
92 # Verify the value is non-empty if required
93 if required and not value:
94 raise ValidationError('Expected non-empty value for %s.' % key)
96 # If the expected type is a dict, but the provided type is a list
97 # then the list applies to all keys of the dictionary, so we reset
98 # the expected type and value.
100 if type(value) is list:
104 # Verify the key is of the expected type
105 if exp_type != type(value):
106 raise ValidationError('Key %s expects %s not %s.' % (
107 key, exp_type.__name__.upper(), type(value).__name__.upper()))
109 # If it's a bool, the expected values are always True or False.
113 # If it's a string and there are expected values, make sure it matches
115 if type(exp_value) is list and exp_value:
116 if value not in exp_value:
117 raise ValidationError("Value '%s' not expected for %s." %
121 # if it's a list, then we need to validate the values
123 # If we expect a dictionary, then call this recursively
124 if type(exp_value) is dict:
126 ValidateFormat(val, exp_value)
128 # If we expect a list of strings
129 if type(exp_value) is str:
131 if type(val) is not str:
132 raise ValidationError('Value %s in %s is not a string.' %
135 # if we expect a particular string
136 if type(exp_value) is list:
138 if val not in exp_value:
139 raise ValidationError('Value %s not expected in %s.' %
143 # if we are expecting a dict, verify the keys are allowed
145 print "Expecting dict\n"
147 if sub not in exp_value:
148 raise ValidationError('Sub key %s not expected in %s.' %
152 # If we got this far, it's an unexpected type
153 raise ValidationError('Unexpected type %s for key %s.' %
154 (str(type(src[key])), key))
157 def LoadProject(filename):
158 with open(filename, 'r') as descfile:
160 desc = eval(descfile.read(), {}, {})
161 except Exception as e:
162 raise ValidationError(e)
163 if desc.get('DISABLE', False):
165 ValidateFormat(desc, DSC_FORMAT)
166 desc['FILEPATH'] = os.path.abspath(filename)
170 def LoadProjectTreeUnfiltered(srcpath):
172 out = collections.defaultdict(list)
173 for root, _, files in os.walk(srcpath):
174 for filename in files:
175 if fnmatch.fnmatch(filename, '*.dsc'):
176 filepath = os.path.join(root, filename)
178 desc = LoadProject(filepath)
179 except ValidationError as e:
180 raise ValidationError("Failed to validate: %s: %s" % (filepath, e))
183 out[key].append(desc)
187 def LoadProjectTree(srcpath, include, exclude=None):
188 out = LoadProjectTreeUnfiltered(srcpath)
189 return FilterTree(out, MakeDefaultFilterFn(include, exclude))
192 def GenerateProjects(tree):
194 for val in tree[key]:
198 def FilterTree(tree, filter_fn):
199 out = collections.defaultdict(list)
200 for branch, desc in GenerateProjects(tree):
202 out[branch].append(desc)
206 def MakeDefaultFilterFn(include, exclude):
207 def DefaultFilterFn(desc):
208 matches_include = not include or DescMatchesFilter(desc, include)
209 matches_exclude = exclude and DescMatchesFilter(desc, exclude)
211 # Exclude list overrides include list.
214 return matches_include
216 return DefaultFilterFn
219 def DescMatchesFilter(desc, filters):
220 for key, expected in filters.iteritems():
221 # For any filtered key which is unspecified, assumed False
222 value = desc.get(key, False)
224 # If we provide an expected list, match at least one
225 if type(expected) != list:
226 expected = set([expected])
227 if type(value) != list:
230 if not set(expected) & set(value):
233 # If we fall through, then we matched the filters
237 def PrintProjectTree(tree):
240 for val in tree[key]:
241 print '\t' + val['NAME']
245 parser = optparse.OptionParser(usage='%prog [options] <dir>')
246 parser.add_option('-e', '--experimental',
247 help='build experimental examples and libraries', action='store_true')
248 parser.add_option('-t', '--toolchain',
249 help='Build using toolchain. Can be passed more than once.',
252 options, args = parser.parse_args(argv[1:])
257 parser.error('Expected 0 or 1 args, got %d.' % len(args))
260 load_from_dir = args[0]
262 if options.toolchain:
263 filters['TOOLS'] = options.toolchain
265 if not options.experimental:
266 filters['EXPERIMENTAL'] = False
269 tree = LoadProjectTree(load_from_dir, include=filters)
270 except ValidationError as e:
271 sys.stderr.write(str(e) + '\n')
274 PrintProjectTree(tree)
278 if __name__ == '__main__':
279 sys.exit(main(sys.argv))