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:
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
326 def __init__(self, expr, type):
327 Type.__init__(self, expr)
330 def visit(self, visitor, *args, **kwargs):
331 return visitor.visitAlias(self, *args, **kwargs)
335 def __init__(self, type, name, input=True, output=False):
343 return '%s %s' % (self.type, self.name)
347 return Arg(type, name, input=True, output=False)
350 return Arg(type, name, input=False, output=True)
352 def InOut(type, name):
353 return Arg(type, name, input=True, output=True)
358 # 0-3 are reserved to memcpy, malloc, free, and realloc
361 def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, internal=False):
362 self.id = Function.__id
371 if not isinstance(arg, Arg):
372 if isinstance(arg, tuple):
373 arg_type, arg_name = arg
376 arg_name = "arg%u" % index
377 arg = Arg(arg_type, arg_name)
380 self.args.append(arg)
384 self.sideeffects = sideeffects
385 self.internal = internal
387 def prototype(self, name=None):
394 s = self.call + ' ' + s
395 if name.startswith('*'):
397 s = self.type.expr + ' ' + s
400 s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
407 return [arg.name for arg in self.args]
410 def StdFunction(*args, **kwargs):
411 kwargs.setdefault('call', '__stdcall')
412 return Function(*args, **kwargs)
415 def FunctionPointer(type, name, args, **kwargs):
416 # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
420 class Interface(Type):
422 def __init__(self, name, base=None):
423 Type.__init__(self, name)
428 def visit(self, visitor, *args, **kwargs):
429 return visitor.visitInterface(self, *args, **kwargs)
431 def getMethodByName(self, name):
432 for method in self.iterMethods():
433 if method.name == name:
437 def iterMethods(self):
438 if self.base is not None:
439 for method in self.base.iterMethods():
441 for method in self.methods:
447 while iface is not None:
452 def iterBaseMethods(self):
453 if self.base is not None:
454 for iface, method in self.base.iterBaseMethods():
456 for method in self.methods:
461 class Method(Function):
463 def __init__(self, type, name, args, call = '', const=False, sideeffects=True):
464 assert call == '__stdcall'
465 Function.__init__(self, type, name, args, call = call, sideeffects=sideeffects)
466 for index in range(len(self.args)):
467 self.args[index].index = index + 1
470 def prototype(self, name=None):
471 s = Function.prototype(self, name)
477 def StdMethod(*args, **kwargs):
478 kwargs.setdefault('call', '__stdcall')
479 return Method(*args, **kwargs)
483 '''Human-legible character string.'''
485 def __init__(self, type = Char, length = None, wide = False):
486 assert isinstance(type, Type)
487 Type.__init__(self, type.expr + ' *')
492 def visit(self, visitor, *args, **kwargs):
493 return visitor.visitString(self, *args, **kwargs)
497 '''Opaque pointer.'''
499 def __init__(self, expr):
500 Type.__init__(self, expr)
502 def visit(self, visitor, *args, **kwargs):
503 return visitor.visitOpaque(self, *args, **kwargs)
506 def OpaquePointer(type, *args):
507 return Opaque(type.expr + ' *')
509 def OpaqueArray(type, size):
510 return Opaque(type.expr + ' *')
512 def OpaqueBlob(type, size):
513 return Opaque(type.expr + ' *')
516 class Polymorphic(Type):
518 def __init__(self, switchExpr, switchTypes, defaultType, contextLess=True):
519 Type.__init__(self, defaultType.expr)
520 self.switchExpr = switchExpr
521 self.switchTypes = switchTypes
522 self.defaultType = defaultType
523 self.contextLess = contextLess
525 def visit(self, visitor, *args, **kwargs):
526 return visitor.visitPolymorphic(self, *args, **kwargs)
528 def iterSwitch(self):
529 cases = [['default']]
530 types = [self.defaultType]
532 for expr, type in self.switchTypes:
533 case = 'case %s' % expr
535 i = types.index(type)
540 cases[i].append(case)
542 return zip(cases, types)
545 def EnumPolymorphic(enumName, switchExpr, switchTypes, defaultType, contextLess=True):
546 enumValues = [expr for expr, type in switchTypes]
547 enum = Enum(enumName, enumValues)
548 polymorphic = Polymorphic(switchExpr, switchTypes, defaultType, contextLess)
549 return enum, polymorphic
553 '''Abstract visitor for the type hierarchy.'''
555 def visit(self, type, *args, **kwargs):
556 return type.visit(self, *args, **kwargs)
558 def visitVoid(self, void, *args, **kwargs):
559 raise NotImplementedError
561 def visitLiteral(self, literal, *args, **kwargs):
562 raise NotImplementedError
564 def visitString(self, string, *args, **kwargs):
565 raise NotImplementedError
567 def visitConst(self, const, *args, **kwargs):
568 raise NotImplementedError
570 def visitStruct(self, struct, *args, **kwargs):
571 raise NotImplementedError
573 def visitArray(self, array, *args, **kwargs):
574 raise NotImplementedError
576 def visitBlob(self, blob, *args, **kwargs):
577 raise NotImplementedError
579 def visitEnum(self, enum, *args, **kwargs):
580 raise NotImplementedError
582 def visitBitmask(self, bitmask, *args, **kwargs):
583 raise NotImplementedError
585 def visitPointer(self, pointer, *args, **kwargs):
586 raise NotImplementedError
588 def visitIntPointer(self, pointer, *args, **kwargs):
589 raise NotImplementedError
591 def visitObjPointer(self, pointer, *args, **kwargs):
592 raise NotImplementedError
594 def visitLinearPointer(self, pointer, *args, **kwargs):
595 raise NotImplementedError
597 def visitReference(self, reference, *args, **kwargs):
598 raise NotImplementedError
600 def visitHandle(self, handle, *args, **kwargs):
601 raise NotImplementedError
603 def visitAlias(self, alias, *args, **kwargs):
604 raise NotImplementedError
606 def visitOpaque(self, opaque, *args, **kwargs):
607 raise NotImplementedError
609 def visitInterface(self, interface, *args, **kwargs):
610 raise NotImplementedError
612 def visitPolymorphic(self, polymorphic, *args, **kwargs):
613 raise NotImplementedError
614 #return self.visit(polymorphic.defaultType, *args, **kwargs)
617 class OnceVisitor(Visitor):
618 '''Visitor that guarantees that each type is visited only once.'''
621 self.__visited = set()
623 def visit(self, type, *args, **kwargs):
624 if type not in self.__visited:
625 self.__visited.add(type)
626 return type.visit(self, *args, **kwargs)
630 class Rebuilder(Visitor):
631 '''Visitor which rebuild types as it visits them.
633 By itself it is a no-op -- it is intended to be overwritten.
636 def visitVoid(self, void):
639 def visitLiteral(self, literal):
642 def visitString(self, string):
643 string_type = self.visit(string.type)
644 if string_type is string.type:
647 return String(string_type, string.length, string.wide)
649 def visitConst(self, const):
650 const_type = self.visit(const.type)
651 if const_type is const.type:
654 return Const(const_type)
656 def visitStruct(self, struct):
657 members = [(self.visit(type), name) for type, name in struct.members]
658 return Struct(struct.name, members)
660 def visitArray(self, array):
661 type = self.visit(array.type)
662 return Array(type, array.length)
664 def visitBlob(self, blob):
665 type = self.visit(blob.type)
666 return Blob(type, blob.size)
668 def visitEnum(self, enum):
671 def visitBitmask(self, bitmask):
672 type = self.visit(bitmask.type)
673 return Bitmask(type, bitmask.values)
675 def visitPointer(self, pointer):
676 pointer_type = self.visit(pointer.type)
677 if pointer_type is pointer.type:
680 return Pointer(pointer_type)
682 def visitIntPointer(self, pointer):
685 def visitObjPointer(self, pointer):
686 pointer_type = self.visit(pointer.type)
687 if pointer_type is pointer.type:
690 return ObjPointer(pointer_type)
692 def visitLinearPointer(self, pointer):
693 pointer_type = self.visit(pointer.type)
694 if pointer_type is pointer.type:
697 return LinearPointer(pointer_type)
699 def visitReference(self, reference):
700 reference_type = self.visit(reference.type)
701 if reference_type is reference.type:
704 return Reference(reference_type)
706 def visitHandle(self, handle):
707 handle_type = self.visit(handle.type)
708 if handle_type is handle.type:
711 return Handle(handle.name, handle_type, range=handle.range, key=handle.key)
713 def visitAlias(self, alias):
714 alias_type = self.visit(alias.type)
715 if alias_type is alias.type:
718 return Alias(alias.expr, alias_type)
720 def visitOpaque(self, opaque):
723 def visitInterface(self, interface, *args, **kwargs):
726 def visitPolymorphic(self, polymorphic):
727 switchExpr = polymorphic.switchExpr
728 switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
729 defaultType = self.visit(polymorphic.defaultType)
730 return Polymorphic(switchExpr, switchTypes, defaultType, polymorphic.contextLess)
733 class MutableRebuilder(Rebuilder):
734 '''Type visitor which derives a mutable type.'''
736 def visitString(self, string):
739 def visitConst(self, const):
740 # Strip out const qualifier
743 def visitAlias(self, alias):
744 # Tear the alias on type changes
745 type = self.visit(alias.type)
746 if type is alias.type:
750 def visitReference(self, reference):
751 # Strip out references
752 return reference.type
755 class Traverser(Visitor):
756 '''Visitor which all types.'''
758 def visitVoid(self, void, *args, **kwargs):
761 def visitLiteral(self, literal, *args, **kwargs):
764 def visitString(self, string, *args, **kwargs):
767 def visitConst(self, const, *args, **kwargs):
768 self.visit(const.type, *args, **kwargs)
770 def visitStruct(self, struct, *args, **kwargs):
771 for type, name in struct.members:
772 self.visit(type, *args, **kwargs)
774 def visitArray(self, array, *args, **kwargs):
775 self.visit(array.type, *args, **kwargs)
777 def visitBlob(self, array, *args, **kwargs):
780 def visitEnum(self, enum, *args, **kwargs):
783 def visitBitmask(self, bitmask, *args, **kwargs):
784 self.visit(bitmask.type, *args, **kwargs)
786 def visitPointer(self, pointer, *args, **kwargs):
787 self.visit(pointer.type, *args, **kwargs)
789 def visitIntPointer(self, pointer, *args, **kwargs):
792 def visitObjPointer(self, pointer, *args, **kwargs):
793 self.visit(pointer.type, *args, **kwargs)
795 def visitLinearPointer(self, pointer, *args, **kwargs):
796 self.visit(pointer.type, *args, **kwargs)
798 def visitReference(self, reference, *args, **kwargs):
799 self.visit(reference.type, *args, **kwargs)
801 def visitHandle(self, handle, *args, **kwargs):
802 self.visit(handle.type, *args, **kwargs)
804 def visitAlias(self, alias, *args, **kwargs):
805 self.visit(alias.type, *args, **kwargs)
807 def visitOpaque(self, opaque, *args, **kwargs):
810 def visitInterface(self, interface, *args, **kwargs):
811 if interface.base is not None:
812 self.visit(interface.base, *args, **kwargs)
813 for method in interface.iterMethods():
814 for arg in method.args:
815 self.visit(arg.type, *args, **kwargs)
816 self.visit(method.type, *args, **kwargs)
818 def visitPolymorphic(self, polymorphic, *args, **kwargs):
819 self.visit(polymorphic.defaultType, *args, **kwargs)
820 for expr, type in polymorphic.switchTypes:
821 self.visit(type, *args, **kwargs)
824 class Collector(Traverser):
825 '''Visitor which collects all unique types as it traverses them.'''
828 self.__visited = set()
831 def visit(self, type):
832 if type in self.__visited:
834 self.__visited.add(type)
835 Visitor.visit(self, type)
836 self.types.append(type)
841 '''A collection of functions.'''
843 def __init__(self, name = None):
849 def addFunctions(self, functions):
850 self.functions.extend(functions)
852 def addInterfaces(self, interfaces):
853 self.interfaces.extend(interfaces)
855 def mergeModule(self, module):
856 self.headers.extend(module.headers)
857 self.functions.extend(module.functions)
858 self.interfaces.extend(module.interfaces)
860 def getFunctionByName(self, name):
861 for function in self.functions:
862 if function.name == name:
870 Essentially, a collection of types, functions, and interfaces.
873 def __init__(self, modules = None):
875 if modules is not None:
876 self.modules.extend(modules)
878 def getAllTypes(self):
879 collector = Collector()
880 for module in self.modules:
881 for function in module.functions:
882 for arg in function.args:
883 collector.visit(arg.type)
884 collector.visit(function.type)
885 for interface in module.interfaces:
886 collector.visit(interface)
887 for method in interface.iterMethods():
888 for arg in method.args:
889 collector.visit(arg.type)
890 collector.visit(method.type)
891 return collector.types
893 def getAllFunctions(self):
895 for module in self.modules:
896 functions.extend(module.functions)
899 def getAllInterfaces(self):
900 types = self.getAllTypes()
901 interfaces = [type for type in types if isinstance(type, Interface)]
902 for module in self.modules:
903 for interface in module.interfaces:
904 if interface not in interfaces:
905 interfaces.append(interface)
908 def addModule(self, module):
909 self.modules.append(module)
911 def getFunctionByName(self, name):
912 for module in self.modules:
913 for function in module.functions:
914 if function.name == name:
919 # C string (i.e., zero terminated)
920 CString = String(Char)
921 WString = String(WChar, wide=True)
922 ConstCString = String(Const(Char))
923 ConstWString = String(Const(WChar), wide=True)