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)
107 def __init__(self, type):
108 # While "const foo" and "foo const" are synonymous, "const foo *" and
109 # "foo * const" are not quite the same, and some compilers do enforce
110 # strict const correctness.
111 if isinstance(type, String) or type is WString:
112 # For strings we never intend to say a const pointer to chars, but
113 # rather a point to const chars.
114 expr = "const " + type.expr
115 elif type.expr.startswith("const ") or '*' in type.expr:
116 expr = type.expr + " const"
119 expr = "const " + type.expr
121 Type.__init__(self, expr, 'C' + type.tag)
125 def visit(self, visitor, *args, **kwargs):
126 return visitor.visitConst(self, *args, **kwargs)
131 def __init__(self, type):
132 Type.__init__(self, type.expr + " *", 'P' + type.tag)
135 def visit(self, visitor, *args, **kwargs):
136 return visitor.visitPointer(self, *args, **kwargs)
139 class IntPointer(Type):
140 '''Integer encoded as a pointer.'''
142 def visit(self, visitor, *args, **kwargs):
143 return visitor.visitIntPointer(self, *args, **kwargs)
146 class ObjPointer(Type):
147 '''Pointer to an object.'''
149 def __init__(self, type):
150 Type.__init__(self, type.expr + " *", 'P' + type.tag)
153 def visit(self, visitor, *args, **kwargs):
154 return visitor.visitObjPointer(self, *args, **kwargs)
157 class LinearPointer(Type):
158 '''Pointer to a linear range of memory.'''
160 def __init__(self, type, size = None):
161 Type.__init__(self, type.expr + " *", 'P' + type.tag)
165 def visit(self, visitor, *args, **kwargs):
166 return visitor.visitLinearPointer(self, *args, **kwargs)
169 class Reference(Type):
170 '''C++ references.'''
172 def __init__(self, type):
173 Type.__init__(self, type.expr + " &", 'R' + type.tag)
176 def visit(self, visitor, *args, **kwargs):
177 return visitor.visitReference(self, *args, **kwargs)
182 def __init__(self, name, type, range=None, key=None):
183 Type.__init__(self, type.expr, 'P' + type.tag)
189 def visit(self, visitor, *args, **kwargs):
190 return visitor.visitHandle(self, *args, **kwargs)
193 def ConstPointer(type):
194 return Pointer(Const(type))
201 def __init__(self, name, values):
202 Type.__init__(self, name)
207 self.values = list(values)
209 def visit(self, visitor, *args, **kwargs):
210 return visitor.visitEnum(self, *args, **kwargs)
213 def FakeEnum(type, values):
214 return Enum(type.expr, values)
221 def __init__(self, type, values):
222 Type.__init__(self, type.expr)
224 self.id = Bitmask.__id
230 def visit(self, visitor, *args, **kwargs):
231 return visitor.visitBitmask(self, *args, **kwargs)
238 def __init__(self, type, length):
239 Type.__init__(self, type.expr + " *")
243 def visit(self, visitor, *args, **kwargs):
244 return visitor.visitArray(self, *args, **kwargs)
249 def __init__(self, type, size):
250 Type.__init__(self, type.expr + ' *')
254 def visit(self, visitor, *args, **kwargs):
255 return visitor.visitBlob(self, *args, **kwargs)
262 def __init__(self, name, members):
263 Type.__init__(self, name)
265 self.id = Struct.__id
271 # Eliminate anonymous unions
272 for type, name in members:
274 self.members.append((type, name))
276 assert isinstance(type, Union)
277 assert type.name is None
278 self.members.extend(type.members)
280 def visit(self, visitor, *args, **kwargs):
281 return visitor.visitStruct(self, *args, **kwargs)
288 def __init__(self, name, members):
289 Type.__init__(self, name)
295 self.members = members
300 def __init__(self, expr, type):
301 Type.__init__(self, expr)
304 def visit(self, visitor, *args, **kwargs):
305 return visitor.visitAlias(self, *args, **kwargs)
309 def __init__(self, type, name, input=True, output=False):
317 return '%s %s' % (self.type, self.name)
321 return Arg(type, name, input=True, output=False)
324 return Arg(type, name, input=False, output=True)
326 def InOut(type, name):
327 return Arg(type, name, input=True, output=True)
332 # 0-3 are reserved to memcpy, malloc, free, and realloc
335 def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, internal=False):
336 self.id = Function.__id
345 if not isinstance(arg, Arg):
346 if isinstance(arg, tuple):
347 arg_type, arg_name = arg
350 arg_name = "arg%u" % index
351 arg = Arg(arg_type, arg_name)
354 self.args.append(arg)
358 self.sideeffects = sideeffects
359 self.internal = internal
361 def prototype(self, name=None):
368 s = self.call + ' ' + s
369 if name.startswith('*'):
371 s = self.type.expr + ' ' + s
374 s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
381 return [arg.name for arg in self.args]
384 def StdFunction(*args, **kwargs):
385 kwargs.setdefault('call', '__stdcall')
386 return Function(*args, **kwargs)
389 def FunctionPointer(type, name, args, **kwargs):
390 # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
394 class Interface(Type):
396 def __init__(self, name, base=None):
397 Type.__init__(self, name)
402 def visit(self, visitor, *args, **kwargs):
403 return visitor.visitInterface(self, *args, **kwargs)
405 def getMethodByName(self, name):
406 for method in self.iterMethods():
407 if method.name == name:
411 def iterMethods(self):
412 if self.base is not None:
413 for method in self.base.iterMethods():
415 for method in self.methods:
421 while iface is not None:
426 def iterBaseMethods(self):
427 if self.base is not None:
428 for iface, method in self.base.iterBaseMethods():
430 for method in self.methods:
435 class Method(Function):
437 def __init__(self, type, name, args, call = '__stdcall', const=False, sideeffects=True):
438 Function.__init__(self, type, name, args, call = call, sideeffects=sideeffects)
439 for index in range(len(self.args)):
440 self.args[index].index = index + 1
443 def prototype(self, name=None):
444 s = Function.prototype(self, name)
450 def StdMethod(*args, **kwargs):
451 kwargs.setdefault('call', '__stdcall')
452 return Method(*args, **kwargs)
457 def __init__(self, expr = "char *", length = None, kind = 'String'):
458 Type.__init__(self, expr)
462 def visit(self, visitor, *args, **kwargs):
463 return visitor.visitString(self, *args, **kwargs)
467 '''Opaque pointer.'''
469 def __init__(self, expr):
470 Type.__init__(self, expr)
472 def visit(self, visitor, *args, **kwargs):
473 return visitor.visitOpaque(self, *args, **kwargs)
476 def OpaquePointer(type, *args):
477 return Opaque(type.expr + ' *')
479 def OpaqueArray(type, size):
480 return Opaque(type.expr + ' *')
482 def OpaqueBlob(type, size):
483 return Opaque(type.expr + ' *')
486 class Polymorphic(Type):
488 def __init__(self, switchExpr, switchTypes, defaultType, contextLess=True):
489 Type.__init__(self, defaultType.expr)
490 self.switchExpr = switchExpr
491 self.switchTypes = switchTypes
492 self.defaultType = defaultType
493 self.contextLess = contextLess
495 def visit(self, visitor, *args, **kwargs):
496 return visitor.visitPolymorphic(self, *args, **kwargs)
498 def iterSwitch(self):
499 cases = [['default']]
500 types = [self.defaultType]
502 for expr, type in self.switchTypes:
503 case = 'case %s' % expr
505 i = types.index(type)
510 cases[i].append(case)
512 return zip(cases, types)
515 def EnumPolymorphic(enumName, switchExpr, switchTypes, defaultType, contextLess=True):
516 enumValues = [expr for expr, type in switchTypes]
517 enum = Enum(enumName, enumValues)
518 polymorphic = Polymorphic(switchExpr, switchTypes, defaultType, contextLess)
519 return enum, polymorphic
523 '''Abstract visitor for the type hierarchy.'''
525 def visit(self, type, *args, **kwargs):
526 return type.visit(self, *args, **kwargs)
528 def visitVoid(self, void, *args, **kwargs):
529 raise NotImplementedError
531 def visitLiteral(self, literal, *args, **kwargs):
532 raise NotImplementedError
534 def visitString(self, string, *args, **kwargs):
535 raise NotImplementedError
537 def visitConst(self, const, *args, **kwargs):
538 raise NotImplementedError
540 def visitStruct(self, struct, *args, **kwargs):
541 raise NotImplementedError
543 def visitArray(self, array, *args, **kwargs):
544 raise NotImplementedError
546 def visitBlob(self, blob, *args, **kwargs):
547 raise NotImplementedError
549 def visitEnum(self, enum, *args, **kwargs):
550 raise NotImplementedError
552 def visitBitmask(self, bitmask, *args, **kwargs):
553 raise NotImplementedError
555 def visitPointer(self, pointer, *args, **kwargs):
556 raise NotImplementedError
558 def visitIntPointer(self, pointer, *args, **kwargs):
559 raise NotImplementedError
561 def visitObjPointer(self, pointer, *args, **kwargs):
562 raise NotImplementedError
564 def visitLinearPointer(self, pointer, *args, **kwargs):
565 raise NotImplementedError
567 def visitReference(self, reference, *args, **kwargs):
568 raise NotImplementedError
570 def visitHandle(self, handle, *args, **kwargs):
571 raise NotImplementedError
573 def visitAlias(self, alias, *args, **kwargs):
574 raise NotImplementedError
576 def visitOpaque(self, opaque, *args, **kwargs):
577 raise NotImplementedError
579 def visitInterface(self, interface, *args, **kwargs):
580 raise NotImplementedError
582 def visitPolymorphic(self, polymorphic, *args, **kwargs):
583 raise NotImplementedError
584 #return self.visit(polymorphic.defaultType, *args, **kwargs)
587 class OnceVisitor(Visitor):
588 '''Visitor that guarantees that each type is visited only once.'''
591 self.__visited = set()
593 def visit(self, type, *args, **kwargs):
594 if type not in self.__visited:
595 self.__visited.add(type)
596 return type.visit(self, *args, **kwargs)
600 class Rebuilder(Visitor):
601 '''Visitor which rebuild types as it visits them.
603 By itself it is a no-op -- it is intended to be overwritten.
606 def visitVoid(self, void):
609 def visitLiteral(self, literal):
612 def visitString(self, string):
615 def visitConst(self, const):
616 const_type = self.visit(const.type)
617 if const_type is const.type:
620 return Const(const_type)
622 def visitStruct(self, struct):
623 members = [(self.visit(type), name) for type, name in struct.members]
624 return Struct(struct.name, members)
626 def visitArray(self, array):
627 type = self.visit(array.type)
628 return Array(type, array.length)
630 def visitBlob(self, blob):
631 type = self.visit(blob.type)
632 return Blob(type, blob.size)
634 def visitEnum(self, enum):
637 def visitBitmask(self, bitmask):
638 type = self.visit(bitmask.type)
639 return Bitmask(type, bitmask.values)
641 def visitPointer(self, pointer):
642 pointer_type = self.visit(pointer.type)
643 if pointer_type is pointer.type:
646 return Pointer(pointer_type)
648 def visitIntPointer(self, pointer):
651 def visitObjPointer(self, pointer):
652 pointer_type = self.visit(pointer.type)
653 if pointer_type is pointer.type:
656 return ObjPointer(pointer_type)
658 def visitLinearPointer(self, pointer):
659 pointer_type = self.visit(pointer.type)
660 if pointer_type is pointer.type:
663 return LinearPointer(pointer_type)
665 def visitReference(self, reference):
666 reference_type = self.visit(reference.type)
667 if reference_type is reference.type:
670 return Reference(reference_type)
672 def visitHandle(self, handle):
673 handle_type = self.visit(handle.type)
674 if handle_type is handle.type:
677 return Handle(handle.name, handle_type, range=handle.range, key=handle.key)
679 def visitAlias(self, alias):
680 alias_type = self.visit(alias.type)
681 if alias_type is alias.type:
684 return Alias(alias.expr, alias_type)
686 def visitOpaque(self, opaque):
689 def visitInterface(self, interface, *args, **kwargs):
692 def visitPolymorphic(self, polymorphic):
693 switchExpr = polymorphic.switchExpr
694 switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
695 defaultType = self.visit(polymorphic.defaultType)
696 return Polymorphic(switchExpr, switchTypes, defaultType, polymorphic.contextLess)
699 class MutableRebuilder(Rebuilder):
700 '''Type visitor which derives a mutable type.'''
702 def visitConst(self, const):
703 # Strip out const qualifier
706 def visitAlias(self, alias):
707 # Tear the alias on type changes
708 type = self.visit(alias.type)
709 if type is alias.type:
713 def visitReference(self, reference):
714 # Strip out references
715 return reference.type
718 class Traverser(Visitor):
719 '''Visitor which all types.'''
721 def visitVoid(self, void, *args, **kwargs):
724 def visitLiteral(self, literal, *args, **kwargs):
727 def visitString(self, string, *args, **kwargs):
730 def visitConst(self, const, *args, **kwargs):
731 self.visit(const.type, *args, **kwargs)
733 def visitStruct(self, struct, *args, **kwargs):
734 for type, name in struct.members:
735 self.visit(type, *args, **kwargs)
737 def visitArray(self, array, *args, **kwargs):
738 self.visit(array.type, *args, **kwargs)
740 def visitBlob(self, array, *args, **kwargs):
743 def visitEnum(self, enum, *args, **kwargs):
746 def visitBitmask(self, bitmask, *args, **kwargs):
747 self.visit(bitmask.type, *args, **kwargs)
749 def visitPointer(self, pointer, *args, **kwargs):
750 self.visit(pointer.type, *args, **kwargs)
752 def visitIntPointer(self, pointer, *args, **kwargs):
755 def visitObjPointer(self, pointer, *args, **kwargs):
756 self.visit(pointer.type, *args, **kwargs)
758 def visitLinearPointer(self, pointer, *args, **kwargs):
759 self.visit(pointer.type, *args, **kwargs)
761 def visitReference(self, reference, *args, **kwargs):
762 self.visit(reference.type, *args, **kwargs)
764 def visitHandle(self, handle, *args, **kwargs):
765 self.visit(handle.type, *args, **kwargs)
767 def visitAlias(self, alias, *args, **kwargs):
768 self.visit(alias.type, *args, **kwargs)
770 def visitOpaque(self, opaque, *args, **kwargs):
773 def visitInterface(self, interface, *args, **kwargs):
774 if interface.base is not None:
775 self.visit(interface.base, *args, **kwargs)
776 for method in interface.iterMethods():
777 for arg in method.args:
778 self.visit(arg.type, *args, **kwargs)
779 self.visit(method.type, *args, **kwargs)
781 def visitPolymorphic(self, polymorphic, *args, **kwargs):
782 self.visit(polymorphic.defaultType, *args, **kwargs)
783 for expr, type in polymorphic.switchTypes:
784 self.visit(type, *args, **kwargs)
787 class Collector(Traverser):
788 '''Visitor which collects all unique types as it traverses them.'''
791 self.__visited = set()
794 def visit(self, type):
795 if type in self.__visited:
797 self.__visited.add(type)
798 Visitor.visit(self, type)
799 self.types.append(type)
806 Essentially, a collection of types, functions, and interfaces.
809 def __init__(self, name = None):
815 def getAllTypes(self):
816 collector = Collector()
817 for function in self.functions:
818 for arg in function.args:
819 collector.visit(arg.type)
820 collector.visit(function.type)
821 for interface in self.interfaces:
822 collector.visit(interface)
823 for method in interface.iterMethods():
824 for arg in method.args:
825 collector.visit(arg.type)
826 collector.visit(method.type)
827 return collector.types
829 def getAllInterfaces(self):
830 types = self.getAllTypes()
831 interfaces = [type for type in types if isinstance(type, Interface)]
832 for interface in self.interfaces:
833 if interface not in interfaces:
834 interfaces.append(interface)
837 def addFunction(self, function):
838 self.functions.append(function)
840 def addFunctions(self, functions):
841 for function in functions:
842 self.addFunction(function)
844 def addInterface(self, interface):
845 self.interfaces.append(interface)
847 def addInterfaces(self, interfaces):
848 self.interfaces.extend(interfaces)
850 def addApi(self, api):
851 self.headers.extend(api.headers)
852 self.addFunctions(api.functions)
853 self.addInterfaces(api.interfaces)
855 def getFunctionByName(self, name):
856 for function in self.functions:
857 if function.name == name:
862 Bool = Literal("bool", "Bool")
863 SChar = Literal("signed char", "SInt")
864 UChar = Literal("unsigned char", "UInt")
865 Short = Literal("short", "SInt")
866 Int = Literal("int", "SInt")
867 Long = Literal("long", "SInt")
868 LongLong = Literal("long long", "SInt")
869 UShort = Literal("unsigned short", "UInt")
870 UInt = Literal("unsigned int", "UInt")
871 ULong = Literal("unsigned long", "UInt")
872 ULongLong = Literal("unsigned long long", "UInt")
873 Float = Literal("float", "Float")
874 Double = Literal("double", "Double")
875 SizeT = Literal("size_t", "UInt")
877 # C string (i.e., zero terminated)
879 WString = String("wchar_t *", kind="WString")
881 Int8 = Literal("int8_t", "SInt")
882 UInt8 = Literal("uint8_t", "UInt")
883 Int16 = Literal("int16_t", "SInt")
884 UInt16 = Literal("uint16_t", "UInt")
885 Int32 = Literal("int32_t", "SInt")
886 UInt32 = Literal("uint32_t", "UInt")
887 Int64 = Literal("int64_t", "SInt")
888 UInt64 = Literal("uint64_t", "UInt")