2 Descriptor objects for entities that are part of the LLVM project.
11 class ParseError(Exception):
14 class ComponentInfo(object):
16 Base class for component descriptions.
22 def parse_items(items, has_dependencies = True):
24 kwargs['name'] = items.get_string('name')
25 kwargs['parent'] = items.get_optional_string('parent')
27 kwargs['dependencies'] = items.get_list('dependencies')
30 def __init__(self, subpath, name, dependencies, parent):
31 if not subpath.startswith('/'):
32 raise ValueError,"invalid subpath: %r" % subpath
33 self.subpath = subpath
35 self.dependencies = list(dependencies)
37 # The name of the parent component to logically group this component
41 # The parent instance, once loaded.
42 self.parent_instance = None
45 def set_parent_instance(self, parent):
46 assert parent.name == self.parent, "Unexpected parent!"
47 self.parent_instance = parent
48 self.parent_instance.children.append(self)
50 def get_component_references(self):
51 """get_component_references() -> iter
53 Return an iterator over the named references to other components from
54 this object. Items are of the form (reference-type, component-name).
57 # Parent references are handled specially.
58 for r in self.dependencies:
59 yield ('dependency', r)
61 def get_llvmbuild_fragment(self):
64 class GroupComponentInfo(ComponentInfo):
66 Group components have no semantics as far as the build system are concerned,
67 but exist to help organize other components into a logical tree structure.
73 def parse(subpath, items):
74 kwargs = ComponentInfo.parse_items(items, has_dependencies = False)
75 return GroupComponentInfo(subpath, **kwargs)
77 def __init__(self, subpath, name, parent):
78 ComponentInfo.__init__(self, subpath, name, [], parent)
80 def get_llvmbuild_fragment(self):
81 result = StringIO.StringIO()
82 print >>result, 'type = %s' % self.type_name
83 print >>result, 'name = %s' % self.name
84 print >>result, 'parent = %s' % self.parent
85 return result.getvalue()
87 class LibraryComponentInfo(ComponentInfo):
91 def parse(subpath, items):
92 kwargs = ComponentInfo.parse_items(items)
93 kwargs['library_name'] = items.get_optional_string('library_name')
94 kwargs['required_libraries'] = items.get_list('required_libraries')
95 kwargs['add_to_library_groups'] = items.get_list(
96 'add_to_library_groups')
97 return LibraryComponentInfo(subpath, **kwargs)
99 def __init__(self, subpath, name, dependencies, parent, library_name,
100 required_libraries, add_to_library_groups):
101 ComponentInfo.__init__(self, subpath, name, dependencies, parent)
103 # If given, the name to use for the library instead of deriving it from
104 # the component name.
105 self.library_name = library_name
107 # The names of the library components which are required when linking
108 # with this component.
109 self.required_libraries = list(required_libraries)
111 # The names of the library group components this component should be
112 # considered part of.
113 self.add_to_library_groups = list(add_to_library_groups)
115 def get_component_references(self):
116 for r in ComponentInfo.get_component_references(self):
118 for r in self.required_libraries:
119 yield ('required library', r)
120 for r in self.add_to_library_groups:
121 yield ('library group', r)
123 def get_llvmbuild_fragment(self):
124 result = StringIO.StringIO()
125 print >>result, 'type = %s' % self.type_name
126 print >>result, 'name = %s' % self.name
127 print >>result, 'parent = %s' % self.parent
128 if self.library_name is not None:
129 print >>result, 'library_name = %s' % self.library_name
130 if self.required_libraries:
131 print >>result, 'required_libraries = %s' % ' '.join(
132 self.required_libraries)
133 if self.add_to_library_groups:
134 print >>result, 'add_to_library_groups = %s' % ' '.join(
135 self.add_to_library_groups)
136 return result.getvalue()
138 def get_library_name(self):
139 return self.library_name or self.name
141 def get_llvmconfig_component_name(self):
142 return self.get_library_name().lower()
144 class LibraryGroupComponentInfo(ComponentInfo):
145 type_name = 'LibraryGroup'
148 def parse(subpath, items):
149 kwargs = ComponentInfo.parse_items(items, has_dependencies = False)
150 kwargs['required_libraries'] = items.get_list('required_libraries')
151 kwargs['add_to_library_groups'] = items.get_list(
152 'add_to_library_groups')
153 return LibraryGroupComponentInfo(subpath, **kwargs)
155 def __init__(self, subpath, name, parent, required_libraries = [],
156 add_to_library_groups = []):
157 ComponentInfo.__init__(self, subpath, name, [], parent)
159 # The names of the library components which are required when linking
160 # with this component.
161 self.required_libraries = list(required_libraries)
163 # The names of the library group components this component should be
164 # considered part of.
165 self.add_to_library_groups = list(add_to_library_groups)
167 def get_component_references(self):
168 for r in ComponentInfo.get_component_references(self):
170 for r in self.required_libraries:
171 yield ('required library', r)
172 for r in self.add_to_library_groups:
173 yield ('library group', r)
175 def get_llvmbuild_fragment(self):
176 result = StringIO.StringIO()
177 print >>result, 'type = %s' % self.type_name
178 print >>result, 'name = %s' % self.name
179 print >>result, 'parent = %s' % self.parent
180 if self.required_libraries:
181 print >>result, 'required_libraries = %s' % ' '.join(
182 self.required_libraries)
183 if self.add_to_library_groups:
184 print >>result, 'add_to_library_groups = %s' % ' '.join(
185 self.add_to_library_groups)
186 return result.getvalue()
188 def get_llvmconfig_component_name(self):
189 return self.name.lower()
191 class TargetGroupComponentInfo(ComponentInfo):
192 type_name = 'TargetGroup'
195 def parse(subpath, items):
196 kwargs = ComponentInfo.parse_items(items, has_dependencies = False)
197 kwargs['required_libraries'] = items.get_list('required_libraries')
198 kwargs['add_to_library_groups'] = items.get_list(
199 'add_to_library_groups')
200 kwargs['has_jit'] = items.get_optional_bool('has_jit', False)
201 kwargs['has_asmprinter'] = items.get_optional_bool('has_asmprinter',
203 kwargs['has_asmparser'] = items.get_optional_bool('has_asmparser',
205 kwargs['has_disassembler'] = items.get_optional_bool('has_disassembler',
207 return TargetGroupComponentInfo(subpath, **kwargs)
209 def __init__(self, subpath, name, parent, required_libraries = [],
210 add_to_library_groups = [], has_jit = False,
211 has_asmprinter = False, has_asmparser = False,
212 has_disassembler = False):
213 ComponentInfo.__init__(self, subpath, name, [], parent)
215 # The names of the library components which are required when linking
216 # with this component.
217 self.required_libraries = list(required_libraries)
219 # The names of the library group components this component should be
220 # considered part of.
221 self.add_to_library_groups = list(add_to_library_groups)
223 # Whether or not this target supports the JIT.
224 self.has_jit = bool(has_jit)
226 # Whether or not this target defines an assembly printer.
227 self.has_asmprinter = bool(has_asmprinter)
229 # Whether or not this target defines an assembly parser.
230 self.has_asmparser = bool(has_asmparser)
232 # Whether or not this target defines an disassembler.
233 self.has_disassembler = bool(has_disassembler)
235 # Whether or not this target is enabled. This is set in response to
236 # configuration parameters.
239 def get_component_references(self):
240 for r in ComponentInfo.get_component_references(self):
242 for r in self.required_libraries:
243 yield ('required library', r)
244 for r in self.add_to_library_groups:
245 yield ('library group', r)
247 def get_llvmbuild_fragment(self):
248 result = StringIO.StringIO()
249 print >>result, 'type = %s' % self.type_name
250 print >>result, 'name = %s' % self.name
251 print >>result, 'parent = %s' % self.parent
252 if self.required_libraries:
253 print >>result, 'required_libraries = %s' % ' '.join(
254 self.required_libraries)
255 if self.add_to_library_groups:
256 print >>result, 'add_to_library_groups = %s' % ' '.join(
257 self.add_to_library_groups)
258 for bool_key in ('has_asmparser', 'has_asmprinter', 'has_disassembler',
260 if getattr(self, bool_key):
261 print >>result, '%s = 1' % (bool_key,)
262 return result.getvalue()
264 def get_llvmconfig_component_name(self):
265 return self.name.lower()
267 class ToolComponentInfo(ComponentInfo):
271 def parse(subpath, items):
272 kwargs = ComponentInfo.parse_items(items)
273 kwargs['required_libraries'] = items.get_list('required_libraries')
274 return ToolComponentInfo(subpath, **kwargs)
276 def __init__(self, subpath, name, dependencies, parent,
278 ComponentInfo.__init__(self, subpath, name, dependencies, parent)
280 # The names of the library components which are required to link this
282 self.required_libraries = list(required_libraries)
284 def get_component_references(self):
285 for r in ComponentInfo.get_component_references(self):
287 for r in self.required_libraries:
288 yield ('required library', r)
290 def get_llvmbuild_fragment(self):
291 result = StringIO.StringIO()
292 print >>result, 'type = %s' % self.type_name
293 print >>result, 'name = %s' % self.name
294 print >>result, 'parent = %s' % self.parent
295 print >>result, 'required_libraries = %s' % ' '.join(
296 self.required_libraries)
297 return result.getvalue()
299 class BuildToolComponentInfo(ToolComponentInfo):
300 type_name = 'BuildTool'
303 def parse(subpath, items):
304 kwargs = ComponentInfo.parse_items(items)
305 kwargs['required_libraries'] = items.get_list('required_libraries')
306 return BuildToolComponentInfo(subpath, **kwargs)
310 class IniFormatParser(dict):
311 def get_list(self, key):
312 # Check if the value is defined.
313 value = self.get(key)
317 # Lists are just whitespace separated strings.
320 def get_optional_string(self, key):
321 value = self.get_list(key)
325 raise ParseError("multiple values for scalar key: %r" % key)
328 def get_string(self, key):
329 value = self.get_optional_string(key)
331 raise ParseError("missing value for required string: %r" % key)
334 def get_optional_bool(self, key, default = None):
335 value = self.get_optional_string(key)
338 if value not in ('0', '1'):
339 raise ParseError("invalid value(%r) for boolean property: %r" % (
341 return bool(int(value))
343 def get_bool(self, key):
344 value = self.get_optional_bool(key)
346 raise ParseError("missing value for required boolean: %r" % key)
349 _component_type_map = dict(
351 for t in (GroupComponentInfo,
352 LibraryComponentInfo, LibraryGroupComponentInfo,
353 ToolComponentInfo, BuildToolComponentInfo,
354 TargetGroupComponentInfo))
355 def load_from_path(path, subpath):
356 # Load the LLVMBuild.txt file as an .ini format file.
357 parser = ConfigParser.RawConfigParser()
360 # We load each section which starts with 'component' as a distinct component
361 # description (so multiple components can be described in one file).
362 for section in parser.sections():
363 if not section.startswith('component'):
364 # We don't expect arbitrary sections currently, warn the user.
365 warning("ignoring unknown section %r in %r" % (section, path))
368 # Determine the type of the component to instantiate.
369 if not parser.has_option(section, 'type'):
370 fatal("invalid component %r in %r: %s" % (
371 section, path, "no component type"))
373 type_name = parser.get(section, 'type')
374 type_class = _component_type_map.get(type_name)
375 if type_class is None:
376 fatal("invalid component %r in %r: %s" % (
377 section, path, "invalid component type: %r" % type_name))
379 # Instantiate the component based on the remaining values.
381 info = type_class.parse(subpath,
382 IniFormatParser(parser.items(section)))
384 print >>sys.stderr, "error: invalid component %r in %r: %s" % (
385 section, path, "unable to instantiate: %r" % type_name)
387 traceback.print_exc()
390 fatal("unable to load component %r in %r: %s" % (
391 section, path, e.message))