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)
275 def __init__(self, type, size):
276 Type.__init__(self, type.expr + ' *')
280 def visit(self, visitor, *args, **kwargs):
281 return visitor.visitBlob(self, *args, **kwargs)
288 def __init__(self, name, members):
289 Type.__init__(self, name)
291 self.id = Struct.__id
297 # Eliminate anonymous unions
298 for type, name in members:
299 if name is not None or isinstance(type, Polymorphic):
300 self.members.append((type, name))
302 assert isinstance(type, Union)
303 assert type.name is None
304 self.members.extend(type.members)
306 def visit(self, visitor, *args, **kwargs):
307 return visitor.visitStruct(self, *args, **kwargs)
314 def __init__(self, name, members):
315 Type.__init__(self, name)
321 self.members = members
323 def Union_(kindExpr, kindTypes, contextLess=True):
325 for kindCase, kindType, kindMemberName in kindTypes:
326 switchType = Struct(None, [(kindType, kindMemberName)])
327 switchTypes.append((kindCase, switchType))
328 return Polymorphic(kindExpr, switchTypes, contextLess=contextLess)
333 def __init__(self, expr, type):
334 Type.__init__(self, expr)
337 def visit(self, visitor, *args, **kwargs):
338 return visitor.visitAlias(self, *args, **kwargs)
342 def __init__(self, type, name, input=True, output=False):
350 return '%s %s' % (self.type, self.name)
354 return Arg(type, name, input=True, output=False)
357 return Arg(type, name, input=False, output=True)
359 def InOut(type, name):
360 return Arg(type, name, input=True, output=True)
365 # 0-3 are reserved to memcpy, malloc, free, and realloc
368 def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, internal=False):
369 self.id = Function.__id
378 if not isinstance(arg, Arg):
379 if isinstance(arg, tuple):
380 arg_type, arg_name = arg
383 arg_name = "arg%u" % index
384 arg = Arg(arg_type, arg_name)
387 self.args.append(arg)
391 self.sideeffects = sideeffects
392 self.internal = internal
394 def prototype(self, name=None):
401 s = self.call + ' ' + s
402 if name.startswith('*'):
404 s = self.type.expr + ' ' + s
407 s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
414 return [arg.name for arg in self.args]
417 def StdFunction(*args, **kwargs):
418 kwargs.setdefault('call', '__stdcall')
419 return Function(*args, **kwargs)
422 def FunctionPointer(type, name, args, **kwargs):
423 # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
427 class Interface(Type):
429 def __init__(self, name, base=None):
430 Type.__init__(self, name)
435 def visit(self, visitor, *args, **kwargs):
436 return visitor.visitInterface(self, *args, **kwargs)
438 def getMethodByName(self, name):
439 for method in self.iterMethods():
440 if method.name == name:
444 def iterMethods(self):
445 if self.base is not None:
446 for method in self.base.iterMethods():
448 for method in self.methods:
454 while iface is not None:
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 visitBlob(self, blob, *args, **kwargs):
592 raise NotImplementedError
594 def visitEnum(self, enum, *args, **kwargs):
595 raise NotImplementedError
597 def visitBitmask(self, bitmask, *args, **kwargs):
598 raise NotImplementedError
600 def visitPointer(self, pointer, *args, **kwargs):
601 raise NotImplementedError
603 def visitIntPointer(self, pointer, *args, **kwargs):
604 raise NotImplementedError
606 def visitObjPointer(self, pointer, *args, **kwargs):
607 raise NotImplementedError
609 def visitLinearPointer(self, pointer, *args, **kwargs):
610 raise NotImplementedError
612 def visitReference(self, reference, *args, **kwargs):
613 raise NotImplementedError
615 def visitHandle(self, handle, *args, **kwargs):
616 raise NotImplementedError
618 def visitAlias(self, alias, *args, **kwargs):
619 raise NotImplementedError
621 def visitOpaque(self, opaque, *args, **kwargs):
622 raise NotImplementedError
624 def visitInterface(self, interface, *args, **kwargs):
625 raise NotImplementedError
627 def visitPolymorphic(self, polymorphic, *args, **kwargs):
628 raise NotImplementedError
629 #return self.visit(polymorphic.defaultType, *args, **kwargs)
632 class OnceVisitor(Visitor):
633 '''Visitor that guarantees that each type is visited only once.'''
636 self.__visited = set()
638 def visit(self, type, *args, **kwargs):
639 if type not in self.__visited:
640 self.__visited.add(type)
641 return type.visit(self, *args, **kwargs)
645 class Rebuilder(Visitor):
646 '''Visitor which rebuild types as it visits them.
648 By itself it is a no-op -- it is intended to be overwritten.
651 def visitVoid(self, void):
654 def visitLiteral(self, literal):
657 def visitString(self, string):
658 string_type = self.visit(string.type)
659 if string_type is string.type:
662 return String(string_type, string.length, string.wide)
664 def visitConst(self, const):
665 const_type = self.visit(const.type)
666 if const_type is const.type:
669 return Const(const_type)
671 def visitStruct(self, struct):
672 members = [(self.visit(type), name) for type, name in struct.members]
673 return Struct(struct.name, members)
675 def visitArray(self, array):
676 type = self.visit(array.type)
677 return Array(type, array.length)
679 def visitBlob(self, blob):
680 type = self.visit(blob.type)
681 return Blob(type, blob.size)
683 def visitEnum(self, enum):
686 def visitBitmask(self, bitmask):
687 type = self.visit(bitmask.type)
688 return Bitmask(type, bitmask.values)
690 def visitPointer(self, pointer):
691 pointer_type = self.visit(pointer.type)
692 if pointer_type is pointer.type:
695 return Pointer(pointer_type)
697 def visitIntPointer(self, pointer):
700 def visitObjPointer(self, pointer):
701 pointer_type = self.visit(pointer.type)
702 if pointer_type is pointer.type:
705 return ObjPointer(pointer_type)
707 def visitLinearPointer(self, pointer):
708 pointer_type = self.visit(pointer.type)
709 if pointer_type is pointer.type:
712 return LinearPointer(pointer_type)
714 def visitReference(self, reference):
715 reference_type = self.visit(reference.type)
716 if reference_type is reference.type:
719 return Reference(reference_type)
721 def visitHandle(self, handle):
722 handle_type = self.visit(handle.type)
723 if handle_type is handle.type:
726 return Handle(handle.name, handle_type, range=handle.range, key=handle.key)
728 def visitAlias(self, alias):
729 alias_type = self.visit(alias.type)
730 if alias_type is alias.type:
733 return Alias(alias.expr, alias_type)
735 def visitOpaque(self, opaque):
738 def visitInterface(self, interface, *args, **kwargs):
741 def visitPolymorphic(self, polymorphic):
742 switchExpr = polymorphic.switchExpr
743 switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
744 if polymorphic.defaultType is None:
747 defaultType = self.visit(polymorphic.defaultType)
748 return Polymorphic(switchExpr, switchTypes, defaultType, polymorphic.contextLess)
751 class MutableRebuilder(Rebuilder):
752 '''Type visitor which derives a mutable type.'''
754 def visitString(self, string):
757 def visitConst(self, const):
758 # Strip out const qualifier
761 def visitAlias(self, alias):
762 # Tear the alias on type changes
763 type = self.visit(alias.type)
764 if type is alias.type:
768 def visitReference(self, reference):
769 # Strip out references
770 return reference.type
773 class Traverser(Visitor):
774 '''Visitor which all types.'''
776 def visitVoid(self, void, *args, **kwargs):
779 def visitLiteral(self, literal, *args, **kwargs):
782 def visitString(self, string, *args, **kwargs):
785 def visitConst(self, const, *args, **kwargs):
786 self.visit(const.type, *args, **kwargs)
788 def visitStruct(self, struct, *args, **kwargs):
789 for type, name in struct.members:
790 self.visit(type, *args, **kwargs)
792 def visitArray(self, array, *args, **kwargs):
793 self.visit(array.type, *args, **kwargs)
795 def visitBlob(self, array, *args, **kwargs):
798 def visitEnum(self, enum, *args, **kwargs):
801 def visitBitmask(self, bitmask, *args, **kwargs):
802 self.visit(bitmask.type, *args, **kwargs)
804 def visitPointer(self, pointer, *args, **kwargs):
805 self.visit(pointer.type, *args, **kwargs)
807 def visitIntPointer(self, pointer, *args, **kwargs):
810 def visitObjPointer(self, pointer, *args, **kwargs):
811 self.visit(pointer.type, *args, **kwargs)
813 def visitLinearPointer(self, pointer, *args, **kwargs):
814 self.visit(pointer.type, *args, **kwargs)
816 def visitReference(self, reference, *args, **kwargs):
817 self.visit(reference.type, *args, **kwargs)
819 def visitHandle(self, handle, *args, **kwargs):
820 self.visit(handle.type, *args, **kwargs)
822 def visitAlias(self, alias, *args, **kwargs):
823 self.visit(alias.type, *args, **kwargs)
825 def visitOpaque(self, opaque, *args, **kwargs):
828 def visitInterface(self, interface, *args, **kwargs):
829 if interface.base is not None:
830 self.visit(interface.base, *args, **kwargs)
831 for method in interface.iterMethods():
832 for arg in method.args:
833 self.visit(arg.type, *args, **kwargs)
834 self.visit(method.type, *args, **kwargs)
836 def visitPolymorphic(self, polymorphic, *args, **kwargs):
837 for expr, type in polymorphic.switchTypes:
838 self.visit(type, *args, **kwargs)
839 if polymorphic.defaultType is not None:
840 self.visit(polymorphic.defaultType, *args, **kwargs)
843 class Collector(Traverser):
844 '''Visitor which collects all unique types as it traverses them.'''
847 self.__visited = set()
850 def visit(self, type):
851 if type in self.__visited:
853 self.__visited.add(type)
854 Visitor.visit(self, type)
855 self.types.append(type)
860 '''A collection of functions.'''
862 def __init__(self, name = None):
868 def addFunctions(self, functions):
869 self.functions.extend(functions)
871 def addInterfaces(self, interfaces):
872 self.interfaces.extend(interfaces)
874 def mergeModule(self, module):
875 self.headers.extend(module.headers)
876 self.functions.extend(module.functions)
877 self.interfaces.extend(module.interfaces)
879 def getFunctionByName(self, name):
880 for function in self.functions:
881 if function.name == name:
889 Essentially, a collection of types, functions, and interfaces.
892 def __init__(self, modules = None):
894 if modules is not None:
895 self.modules.extend(modules)
897 def getAllTypes(self):
898 collector = Collector()
899 for module in self.modules:
900 for function in module.functions:
901 for arg in function.args:
902 collector.visit(arg.type)
903 collector.visit(function.type)
904 for interface in module.interfaces:
905 collector.visit(interface)
906 for method in interface.iterMethods():
907 for arg in method.args:
908 collector.visit(arg.type)
909 collector.visit(method.type)
910 return collector.types
912 def getAllFunctions(self):
914 for module in self.modules:
915 functions.extend(module.functions)
918 def getAllInterfaces(self):
919 types = self.getAllTypes()
920 interfaces = [type for type in types if isinstance(type, Interface)]
921 for module in self.modules:
922 for interface in module.interfaces:
923 if interface not in interfaces:
924 interfaces.append(interface)
927 def addModule(self, module):
928 self.modules.append(module)
930 def getFunctionByName(self, name):
931 for module in self.modules:
932 for function in module.functions:
933 if function.name == name:
938 # C string (i.e., zero terminated)
939 CString = String(Char)
940 WString = String(WChar, wide=True)
941 ConstCString = String(Const(Char))
942 ConstWString = String(Const(WChar), wide=True)