1 ##########################################################################
3 # Copyright 2008-2010 VMware, Inc.
6 # Permission is hereby granted, free of charge, to any person obtaining a copy
7 # of this software and associated documentation files (the "Software"), to deal
8 # in the Software without restriction, including without limitation the rights
9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 # copies of the Software, and to permit persons to whom the Software is
11 # furnished to do so, subject to the following conditions:
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 ##########################################################################/
33 """Base class for all types."""
37 def __init__(self, expr, tag = None):
40 # Generate a default tag, used when naming functions that will operate
41 # on this type, so it should preferrably be something representative of
45 tag = ''.join([c for c in expr if c.isalnum() or c in '_'])
50 assert c.isalnum() or c in '_'
52 # Ensure it is unique.
53 if tag in Type.__tags:
55 while tag + str(suffix) in Type.__tags:
59 assert tag not in Type.__tags
65 """Return the C/C++ type expression for this type."""
68 def visit(self, visitor, *args, **kwargs):
69 raise NotImplementedError
72 '''Return a mutable version of this type.
74 Convenience wrapper around MutableRebuilder.'''
75 visitor = MutableRebuilder()
76 return visitor.visit(self)
80 """Singleton void type."""
83 Type.__init__(self, "void")
85 def visit(self, visitor, *args, **kwargs):
86 return visitor.visitVoid(self, *args, **kwargs)
92 """Class to describe literal types.
94 Types which are not defined in terms of other types, such as integers and
97 def __init__(self, expr, kind):
98 Type.__init__(self, expr)
101 def visit(self, visitor, *args, **kwargs):
102 return visitor.visitLiteral(self, *args, **kwargs)
105 Bool = Literal("bool", "Bool")
106 SChar = Literal("signed char", "SInt")
107 UChar = Literal("unsigned char", "UInt")
108 Short = Literal("short", "SInt")
109 Int = Literal("int", "SInt")
110 Long = Literal("long", "SInt")
111 LongLong = Literal("long long", "SInt")
112 UShort = Literal("unsigned short", "UInt")
113 UInt = Literal("unsigned int", "UInt")
114 ULong = Literal("unsigned long", "UInt")
115 ULongLong = Literal("unsigned long long", "UInt")
116 Float = Literal("float", "Float")
117 Double = Literal("double", "Double")
118 SizeT = Literal("size_t", "UInt")
120 Char = Literal("char", "SInt")
121 WChar = Literal("wchar_t", "SInt")
123 Int8 = Literal("int8_t", "SInt")
124 UInt8 = Literal("uint8_t", "UInt")
125 Int16 = Literal("int16_t", "SInt")
126 UInt16 = Literal("uint16_t", "UInt")
127 Int32 = Literal("int32_t", "SInt")
128 UInt32 = Literal("uint32_t", "UInt")
129 Int64 = Literal("int64_t", "SInt")
130 UInt64 = Literal("uint64_t", "UInt")
132 IntPtr = Literal("intptr_t", "SInt")
133 UIntPtr = Literal("uintptr_t", "UInt")
137 def __init__(self, type):
138 # While "const foo" and "foo const" are synonymous, "const foo *" and
139 # "foo * const" are not quite the same, and some compilers do enforce
140 # strict const correctness.
141 if type.expr.startswith("const ") or '*' in type.expr:
142 expr = type.expr + " const"
145 expr = "const " + type.expr
147 Type.__init__(self, expr, 'C' + type.tag)
151 def visit(self, visitor, *args, **kwargs):
152 return visitor.visitConst(self, *args, **kwargs)
157 def __init__(self, type):
158 Type.__init__(self, type.expr + " *", 'P' + type.tag)
161 def visit(self, visitor, *args, **kwargs):
162 return visitor.visitPointer(self, *args, **kwargs)
165 class IntPointer(Type):
166 '''Integer encoded as a pointer.'''
168 def visit(self, visitor, *args, **kwargs):
169 return visitor.visitIntPointer(self, *args, **kwargs)
172 class ObjPointer(Type):
173 '''Pointer to an object.'''
175 def __init__(self, type):
176 Type.__init__(self, type.expr + " *", 'P' + type.tag)
179 def visit(self, visitor, *args, **kwargs):
180 return visitor.visitObjPointer(self, *args, **kwargs)
183 class LinearPointer(Type):
184 '''Pointer to a linear range of memory.'''
186 def __init__(self, type, size = None):
187 Type.__init__(self, type.expr + " *", 'P' + type.tag)
191 def visit(self, visitor, *args, **kwargs):
192 return visitor.visitLinearPointer(self, *args, **kwargs)
195 class Reference(Type):
196 '''C++ references.'''
198 def __init__(self, type):
199 Type.__init__(self, type.expr + " &", 'R' + type.tag)
202 def visit(self, visitor, *args, **kwargs):
203 return visitor.visitReference(self, *args, **kwargs)
208 def __init__(self, name, type, range=None, key=None):
209 Type.__init__(self, type.expr, 'P' + type.tag)
215 def visit(self, visitor, *args, **kwargs):
216 return visitor.visitHandle(self, *args, **kwargs)
219 def ConstPointer(type):
220 return Pointer(Const(type))
227 def __init__(self, name, values):
228 Type.__init__(self, name)
233 self.values = list(values)
235 def visit(self, visitor, *args, **kwargs):
236 return visitor.visitEnum(self, *args, **kwargs)
239 def FakeEnum(type, values):
240 return Enum(type.expr, values)
247 def __init__(self, type, values):
248 Type.__init__(self, type.expr)
250 self.id = Bitmask.__id
256 def visit(self, visitor, *args, **kwargs):
257 return visitor.visitBitmask(self, *args, **kwargs)
264 def __init__(self, type, length):
265 Type.__init__(self, type.expr + " *")
269 def visit(self, visitor, *args, **kwargs):
270 return visitor.visitArray(self, *args, **kwargs)
273 class AttribArray(Type):
275 def __init__(self, baseType, valueTypes, terminator = '0'):
276 self.baseType = baseType
277 Type.__init__(self, (Pointer(self.baseType)).expr)
278 self.valueTypes = valueTypes
279 self.terminator = terminator
280 self.hasKeysWithoutValues = False
281 for key, value in valueTypes:
283 self.hasKeysWithoutValues = True
285 def visit(self, visitor, *args, **kwargs):
286 return visitor.visitAttribArray(self, *args, **kwargs)
291 def __init__(self, type, size):
292 Type.__init__(self, type.expr + ' *')
296 def visit(self, visitor, *args, **kwargs):
297 return visitor.visitBlob(self, *args, **kwargs)
304 def __init__(self, name, members):
305 Type.__init__(self, name)
307 self.id = Struct.__id
311 self.members = members
313 def visit(self, visitor, *args, **kwargs):
314 return visitor.visitStruct(self, *args, **kwargs)
317 def Union(kindExpr, kindTypes, contextLess=True):
319 for kindCase, kindType, kindMemberName in kindTypes:
320 switchType = Struct(None, [(kindType, kindMemberName)])
321 switchTypes.append((kindCase, switchType))
322 return Polymorphic(kindExpr, switchTypes, contextLess=contextLess)
327 def __init__(self, expr, type):
328 Type.__init__(self, expr)
331 def visit(self, visitor, *args, **kwargs):
332 return visitor.visitAlias(self, *args, **kwargs)
336 def __init__(self, type, name, input=True, output=False):
344 return '%s %s' % (self.type, self.name)
348 return Arg(type, name, input=True, output=False)
351 return Arg(type, name, input=False, output=True)
353 def InOut(type, name):
354 return Arg(type, name, input=True, output=True)
359 def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, internal=False):
366 if not isinstance(arg, Arg):
367 if isinstance(arg, tuple):
368 arg_type, arg_name = arg
371 arg_name = "arg%u" % index
372 arg = Arg(arg_type, arg_name)
375 self.args.append(arg)
379 self.sideeffects = sideeffects
380 self.internal = internal
382 def prototype(self, name=None):
389 s = self.call + ' ' + s
390 if name.startswith('*'):
392 s = self.type.expr + ' ' + s
395 s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
402 return [arg.name for arg in self.args]
404 def getArgByName(self, name):
405 for arg in self.args:
411 def StdFunction(*args, **kwargs):
412 kwargs.setdefault('call', '__stdcall')
413 return Function(*args, **kwargs)
416 def FunctionPointer(type, name, args, **kwargs):
417 # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
421 class Interface(Type):
423 def __init__(self, name, base=None):
424 Type.__init__(self, name)
429 def visit(self, visitor, *args, **kwargs):
430 return visitor.visitInterface(self, *args, **kwargs)
432 def getMethodByName(self, name):
433 for method in self.iterMethods():
434 if method.name == name:
438 def iterMethods(self):
439 if self.base is not None:
440 for method in self.base.iterMethods():
442 for method in self.methods:
448 while iface is not None:
453 def hasBase(self, *bases):
454 for iface in self.iterBases():
459 def iterBaseMethods(self):
460 if self.base is not None:
461 for iface, method in self.base.iterBaseMethods():
463 for method in self.methods:
468 class Method(Function):
470 def __init__(self, type, name, args, call = '', const=False, sideeffects=True):
471 assert call == '__stdcall'
472 Function.__init__(self, type, name, args, call = call, sideeffects=sideeffects)
473 for index in range(len(self.args)):
474 self.args[index].index = index + 1
477 def prototype(self, name=None):
478 s = Function.prototype(self, name)
484 def StdMethod(*args, **kwargs):
485 kwargs.setdefault('call', '__stdcall')
486 return Method(*args, **kwargs)
490 '''Human-legible character string.'''
492 def __init__(self, type = Char, length = None, wide = False):
493 assert isinstance(type, Type)
494 Type.__init__(self, type.expr + ' *')
499 def visit(self, visitor, *args, **kwargs):
500 return visitor.visitString(self, *args, **kwargs)
504 '''Opaque pointer.'''
506 def __init__(self, expr):
507 Type.__init__(self, expr)
509 def visit(self, visitor, *args, **kwargs):
510 return visitor.visitOpaque(self, *args, **kwargs)
513 def OpaquePointer(type, *args):
514 return Opaque(type.expr + ' *')
516 def OpaqueArray(type, size):
517 return Opaque(type.expr + ' *')
519 def OpaqueBlob(type, size):
520 return Opaque(type.expr + ' *')
523 class Polymorphic(Type):
525 def __init__(self, switchExpr, switchTypes, defaultType=None, contextLess=True):
526 if defaultType is None:
527 Type.__init__(self, None)
530 Type.__init__(self, defaultType.expr)
531 self.switchExpr = switchExpr
532 self.switchTypes = switchTypes
533 self.defaultType = defaultType
534 self.contextLess = contextLess
536 def visit(self, visitor, *args, **kwargs):
537 return visitor.visitPolymorphic(self, *args, **kwargs)
539 def iterSwitch(self):
543 if self.defaultType is not None:
544 cases.append(['default'])
545 types.append(self.defaultType)
547 for expr, type in self.switchTypes:
548 case = 'case %s' % expr
550 i = types.index(type)
555 cases[i].append(case)
557 return zip(cases, types)
560 def EnumPolymorphic(enumName, switchExpr, switchTypes, defaultType, contextLess=True):
561 enumValues = [expr for expr, type in switchTypes]
562 enum = Enum(enumName, enumValues)
563 polymorphic = Polymorphic(switchExpr, switchTypes, defaultType, contextLess)
564 return enum, polymorphic
568 '''Abstract visitor for the type hierarchy.'''
570 def visit(self, type, *args, **kwargs):
571 return type.visit(self, *args, **kwargs)
573 def visitVoid(self, void, *args, **kwargs):
574 raise NotImplementedError
576 def visitLiteral(self, literal, *args, **kwargs):
577 raise NotImplementedError
579 def visitString(self, string, *args, **kwargs):
580 raise NotImplementedError
582 def visitConst(self, const, *args, **kwargs):
583 raise NotImplementedError
585 def visitStruct(self, struct, *args, **kwargs):
586 raise NotImplementedError
588 def visitArray(self, array, *args, **kwargs):
589 raise NotImplementedError
591 def visitAttribArray(self, array, *args, **kwargs):
592 raise NotImplementedError
594 def visitBlob(self, blob, *args, **kwargs):
595 raise NotImplementedError
597 def visitEnum(self, enum, *args, **kwargs):
598 raise NotImplementedError
600 def visitBitmask(self, bitmask, *args, **kwargs):
601 raise NotImplementedError
603 def visitPointer(self, pointer, *args, **kwargs):
604 raise NotImplementedError
606 def visitIntPointer(self, pointer, *args, **kwargs):
607 raise NotImplementedError
609 def visitObjPointer(self, pointer, *args, **kwargs):
610 raise NotImplementedError
612 def visitLinearPointer(self, pointer, *args, **kwargs):
613 raise NotImplementedError
615 def visitReference(self, reference, *args, **kwargs):
616 raise NotImplementedError
618 def visitHandle(self, handle, *args, **kwargs):
619 raise NotImplementedError
621 def visitAlias(self, alias, *args, **kwargs):
622 raise NotImplementedError
624 def visitOpaque(self, opaque, *args, **kwargs):
625 raise NotImplementedError
627 def visitInterface(self, interface, *args, **kwargs):
628 raise NotImplementedError
630 def visitPolymorphic(self, polymorphic, *args, **kwargs):
631 raise NotImplementedError
632 #return self.visit(polymorphic.defaultType, *args, **kwargs)
635 class OnceVisitor(Visitor):
636 '''Visitor that guarantees that each type is visited only once.'''
639 self.__visited = set()
641 def visit(self, type, *args, **kwargs):
642 if type not in self.__visited:
643 self.__visited.add(type)
644 return type.visit(self, *args, **kwargs)
648 class Rebuilder(Visitor):
649 '''Visitor which rebuild types as it visits them.
651 By itself it is a no-op -- it is intended to be overwritten.
654 def visitVoid(self, void):
657 def visitLiteral(self, literal):
660 def visitString(self, string):
661 string_type = self.visit(string.type)
662 if string_type is string.type:
665 return String(string_type, string.length, string.wide)
667 def visitConst(self, const):
668 const_type = self.visit(const.type)
669 if const_type is const.type:
672 return Const(const_type)
674 def visitStruct(self, struct):
675 members = [(self.visit(type), name) for type, name in struct.members]
676 return Struct(struct.name, members)
678 def visitArray(self, array):
679 type = self.visit(array.type)
680 return Array(type, array.length)
682 def visitBlob(self, blob):
683 type = self.visit(blob.type)
684 return Blob(type, blob.size)
686 def visitEnum(self, enum):
689 def visitBitmask(self, bitmask):
690 type = self.visit(bitmask.type)
691 return Bitmask(type, bitmask.values)
693 def visitPointer(self, pointer):
694 pointer_type = self.visit(pointer.type)
695 if pointer_type is pointer.type:
698 return Pointer(pointer_type)
700 def visitIntPointer(self, pointer):
703 def visitObjPointer(self, pointer):
704 pointer_type = self.visit(pointer.type)
705 if pointer_type is pointer.type:
708 return ObjPointer(pointer_type)
710 def visitLinearPointer(self, pointer):
711 pointer_type = self.visit(pointer.type)
712 if pointer_type is pointer.type:
715 return LinearPointer(pointer_type)
717 def visitReference(self, reference):
718 reference_type = self.visit(reference.type)
719 if reference_type is reference.type:
722 return Reference(reference_type)
724 def visitHandle(self, handle):
725 handle_type = self.visit(handle.type)
726 if handle_type is handle.type:
729 return Handle(handle.name, handle_type, range=handle.range, key=handle.key)
731 def visitAlias(self, alias):
732 alias_type = self.visit(alias.type)
733 if alias_type is alias.type:
736 return Alias(alias.expr, alias_type)
738 def visitOpaque(self, opaque):
741 def visitInterface(self, interface, *args, **kwargs):
744 def visitPolymorphic(self, polymorphic):
745 switchExpr = polymorphic.switchExpr
746 switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
747 if polymorphic.defaultType is None:
750 defaultType = self.visit(polymorphic.defaultType)
751 return Polymorphic(switchExpr, switchTypes, defaultType, polymorphic.contextLess)
754 class MutableRebuilder(Rebuilder):
755 '''Type visitor which derives a mutable type.'''
757 def visitString(self, string):
760 def visitConst(self, const):
761 # Strip out const qualifier
764 def visitAlias(self, alias):
765 # Tear the alias on type changes
766 type = self.visit(alias.type)
767 if type is alias.type:
771 def visitReference(self, reference):
772 # Strip out references
773 return reference.type
776 class Traverser(Visitor):
777 '''Visitor which all types.'''
779 def visitVoid(self, void, *args, **kwargs):
782 def visitLiteral(self, literal, *args, **kwargs):
785 def visitString(self, string, *args, **kwargs):
788 def visitConst(self, const, *args, **kwargs):
789 self.visit(const.type, *args, **kwargs)
791 def visitStruct(self, struct, *args, **kwargs):
792 for type, name in struct.members:
793 self.visit(type, *args, **kwargs)
795 def visitArray(self, array, *args, **kwargs):
796 self.visit(array.type, *args, **kwargs)
798 def visitAttribArray(self, attribs, *args, **kwargs):
799 for key, valueType in attribs.valueTypes:
800 if valueType is not None:
801 self.visit(valueType, *args, **kwargs)
803 def visitBlob(self, array, *args, **kwargs):
806 def visitEnum(self, enum, *args, **kwargs):
809 def visitBitmask(self, bitmask, *args, **kwargs):
810 self.visit(bitmask.type, *args, **kwargs)
812 def visitPointer(self, pointer, *args, **kwargs):
813 self.visit(pointer.type, *args, **kwargs)
815 def visitIntPointer(self, pointer, *args, **kwargs):
818 def visitObjPointer(self, pointer, *args, **kwargs):
819 self.visit(pointer.type, *args, **kwargs)
821 def visitLinearPointer(self, pointer, *args, **kwargs):
822 self.visit(pointer.type, *args, **kwargs)
824 def visitReference(self, reference, *args, **kwargs):
825 self.visit(reference.type, *args, **kwargs)
827 def visitHandle(self, handle, *args, **kwargs):
828 self.visit(handle.type, *args, **kwargs)
830 def visitAlias(self, alias, *args, **kwargs):
831 self.visit(alias.type, *args, **kwargs)
833 def visitOpaque(self, opaque, *args, **kwargs):
836 def visitInterface(self, interface, *args, **kwargs):
837 if interface.base is not None:
838 self.visit(interface.base, *args, **kwargs)
839 for method in interface.iterMethods():
840 for arg in method.args:
841 self.visit(arg.type, *args, **kwargs)
842 self.visit(method.type, *args, **kwargs)
844 def visitPolymorphic(self, polymorphic, *args, **kwargs):
845 for expr, type in polymorphic.switchTypes:
846 self.visit(type, *args, **kwargs)
847 if polymorphic.defaultType is not None:
848 self.visit(polymorphic.defaultType, *args, **kwargs)
851 class Collector(Traverser):
852 '''Visitor which collects all unique types as it traverses them.'''
855 self.__visited = set()
858 def visit(self, type):
859 if type in self.__visited:
861 self.__visited.add(type)
862 Visitor.visit(self, type)
863 self.types.append(type)
867 '''Mixin class that provides a bunch of methods to expand C expressions
868 from the specifications.'''
873 def expand(self, expr):
874 # Expand a C expression, replacing certain variables
875 if not isinstance(expr, basestring):
879 if self.__structs is not None:
880 variables['self'] = '(%s)' % self.__structs[0]
881 if self.__indices is not None:
882 variables['i'] = self.__indices[0]
884 expandedExpr = expr.format(**variables)
885 if expandedExpr != expr and 0:
886 sys.stderr.write(" %r -> %r\n" % (expr, expandedExpr))
889 def visitMember(self, member, structInstance, *args, **kwargs):
890 memberType, memberName = member
891 if memberName is None:
892 # Anonymous structure/union member
893 memberInstance = structInstance
895 memberInstance = '(%s).%s' % (structInstance, memberName)
896 self.__structs = (structInstance, self.__structs)
898 return self.visit(memberType, memberInstance, *args, **kwargs)
900 _, self.__structs = self.__structs
902 def visitElement(self, elementIndex, elementType, *args, **kwargs):
903 self.__indices = (elementIndex, self.__indices)
905 return self.visit(elementType, *args, **kwargs)
907 _, self.__indices = self.__indices
911 '''A collection of functions.'''
913 def __init__(self, name = None):
919 def addFunctions(self, functions):
920 self.functions.extend(functions)
922 def addInterfaces(self, interfaces):
923 self.interfaces.extend(interfaces)
925 def mergeModule(self, module):
926 self.headers.extend(module.headers)
927 self.functions.extend(module.functions)
928 self.interfaces.extend(module.interfaces)
930 def getFunctionByName(self, name):
931 for function in self.functions:
932 if function.name == name:
940 Essentially, a collection of types, functions, and interfaces.
943 def __init__(self, modules = None):
945 if modules is not None:
946 self.modules.extend(modules)
948 def getAllTypes(self):
949 collector = Collector()
950 for module in self.modules:
951 for function in module.functions:
952 for arg in function.args:
953 collector.visit(arg.type)
954 collector.visit(function.type)
955 for interface in module.interfaces:
956 collector.visit(interface)
957 for method in interface.iterMethods():
958 for arg in method.args:
959 collector.visit(arg.type)
960 collector.visit(method.type)
961 return collector.types
963 def getAllFunctions(self):
965 for module in self.modules:
966 functions.extend(module.functions)
969 def getAllInterfaces(self):
970 types = self.getAllTypes()
971 interfaces = [type for type in types if isinstance(type, Interface)]
972 for module in self.modules:
973 for interface in module.interfaces:
974 if interface not in interfaces:
975 interfaces.append(interface)
978 def addModule(self, module):
979 self.modules.append(module)
981 def getFunctionByName(self, name):
982 for module in self.modules:
983 for function in module.functions:
984 if function.name == name:
989 # C string (i.e., zero terminated)
990 CString = String(Char)
991 WString = String(WChar, wide=True)
992 ConstCString = String(Const(Char))
993 ConstWString = String(Const(WChar), wide=True)