# on this type, so it should preferrably be something representative of
# the type.
if tag is None:
- tag = ''.join([c for c in expr if c.isalnum() or c in '_'])
+ if expr is not None:
+ tag = ''.join([c for c in expr if c.isalnum() or c in '_'])
+ else:
+ tag = 'anonynoums'
else:
for c in tag:
assert c.isalnum() or c in '_'
def visit(self, visitor, *args, **kwargs):
raise NotImplementedError
+ def mutable(self):
+ '''Return a mutable version of this type.
+
+ Convenience wrapper around MutableRebuilder.'''
+ visitor = MutableRebuilder()
+ return visitor.visit(self)
class _Void(Type):
return visitor.visitLiteral(self, *args, **kwargs)
+Bool = Literal("bool", "Bool")
+SChar = Literal("signed char", "SInt")
+UChar = Literal("unsigned char", "UInt")
+Short = Literal("short", "SInt")
+Int = Literal("int", "SInt")
+Long = Literal("long", "SInt")
+LongLong = Literal("long long", "SInt")
+UShort = Literal("unsigned short", "UInt")
+UInt = Literal("unsigned int", "UInt")
+ULong = Literal("unsigned long", "UInt")
+ULongLong = Literal("unsigned long long", "UInt")
+Float = Literal("float", "Float")
+Double = Literal("double", "Double")
+SizeT = Literal("size_t", "UInt")
+
+Char = Literal("char", "SInt")
+WChar = Literal("wchar_t", "SInt")
+
+Int8 = Literal("int8_t", "SInt")
+UInt8 = Literal("uint8_t", "UInt")
+Int16 = Literal("int16_t", "SInt")
+UInt16 = Literal("uint16_t", "UInt")
+Int32 = Literal("int32_t", "SInt")
+UInt32 = Literal("uint32_t", "UInt")
+Int64 = Literal("int64_t", "SInt")
+UInt64 = Literal("uint64_t", "UInt")
+
+IntPtr = Literal("intptr_t", "SInt")
+UIntPtr = Literal("uintptr_t", "UInt")
+
class Const(Type):
def __init__(self, type):
# While "const foo" and "foo const" are synonymous, "const foo *" and
# "foo * const" are not quite the same, and some compilers do enforce
# strict const correctness.
- if isinstance(type, String) or type is WString:
- # For strings we never intend to say a const pointer to chars, but
- # rather a point to const chars.
- expr = "const " + type.expr
- elif type.expr.startswith("const ") or '*' in type.expr:
+ if type.expr.startswith("const ") or '*' in type.expr:
expr = type.expr + " const"
else:
# The most legible
return visitor.visitIntPointer(self, *args, **kwargs)
+class ObjPointer(Type):
+ '''Pointer to an object.'''
+
+ def __init__(self, type):
+ Type.__init__(self, type.expr + " *", 'P' + type.tag)
+ self.type = type
+
+ def visit(self, visitor, *args, **kwargs):
+ return visitor.visitObjPointer(self, *args, **kwargs)
+
+
class LinearPointer(Type):
- '''Integer encoded as a pointer.'''
+ '''Pointer to a linear range of memory.'''
def __init__(self, type, size = None):
Type.__init__(self, type.expr + " *", 'P' + type.tag)
return visitor.visitLinearPointer(self, *args, **kwargs)
+class Reference(Type):
+ '''C++ references.'''
+
+ def __init__(self, type):
+ Type.__init__(self, type.expr + " &", 'R' + type.tag)
+ self.type = type
+
+ def visit(self, visitor, *args, **kwargs):
+ return visitor.visitReference(self, *args, **kwargs)
+
+
class Handle(Type):
def __init__(self, name, type, range=None, key=None):
return visitor.visitStruct(self, *args, **kwargs)
+def Union(kindExpr, kindTypes, contextLess=True):
+ switchTypes = []
+ for kindCase, kindType, kindMemberName in kindTypes:
+ switchType = Struct(None, [(kindType, kindMemberName)])
+ switchTypes.append((kindCase, switchType))
+ return Polymorphic(kindExpr, switchTypes, contextLess=contextLess)
+
+
class Alias(Type):
def __init__(self, expr, type):
def visit(self, visitor, *args, **kwargs):
return visitor.visitAlias(self, *args, **kwargs)
-
-def Out(type, name):
- arg = Arg(type, name, output=True)
- return arg
-
-
class Arg:
- def __init__(self, type, name, output=False):
+ def __init__(self, type, name, input=True, output=False):
self.type = type
self.name = name
+ self.input = input
self.output = output
self.index = None
return '%s %s' % (self.type, self.name)
-class Function:
+def In(type, name):
+ return Arg(type, name, input=True, output=False)
+
+def Out(type, name):
+ return Arg(type, name, input=False, output=True)
- # 0-3 are reserved to memcpy, malloc, free, and realloc
- __id = 4
+def InOut(type, name):
+ return Arg(type, name, input=True, output=True)
- def __init__(self, type, name, args, call = '', fail = None, sideeffects=True):
- self.id = Function.__id
- Function.__id += 1
+class Function:
+
+ def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, internal=False):
self.type = type
self.name = name
self.call = call
self.fail = fail
self.sideeffects = sideeffects
+ self.internal = internal
def prototype(self, name=None):
if name is not None:
def argNames(self):
return [arg.name for arg in self.args]
+ def getArgByName(self, name):
+ for arg in self.args:
+ if arg.name == name:
+ return arg
+ return None
+
def StdFunction(*args, **kwargs):
kwargs.setdefault('call', '__stdcall')
def visit(self, visitor, *args, **kwargs):
return visitor.visitInterface(self, *args, **kwargs)
+ def getMethodByName(self, name):
+ for method in self.iterMethods():
+ if method.name == name:
+ return method
+ return None
+
def iterMethods(self):
if self.base is not None:
for method in self.base.iterMethods():
for method in self.methods:
yield method
raise StopIteration
-
+
+ def iterBases(self):
+ iface = self
+ while iface is not None:
+ yield iface
+ iface = iface.base
+ raise StopIteration
+
def iterBaseMethods(self):
if self.base is not None:
for iface, method in self.base.iterBaseMethods():
class Method(Function):
- def __init__(self, type, name, args, const=False):
- Function.__init__(self, type, name, args, call = '__stdcall')
+ def __init__(self, type, name, args, call = '', const=False, sideeffects=True):
+ assert call == '__stdcall'
+ Function.__init__(self, type, name, args, call = call, sideeffects=sideeffects)
for index in range(len(self.args)):
self.args[index].index = index + 1
self.const = const
return s
+def StdMethod(*args, **kwargs):
+ kwargs.setdefault('call', '__stdcall')
+ return Method(*args, **kwargs)
+
+
class String(Type):
+ '''Human-legible character string.'''
- def __init__(self, expr = "char *", length = None, kind = 'String'):
- Type.__init__(self, expr)
+ def __init__(self, type = Char, length = None, wide = False):
+ assert isinstance(type, Type)
+ Type.__init__(self, type.expr + ' *')
+ self.type = type
self.length = length
- self.kind = kind
+ self.wide = wide
def visit(self, visitor, *args, **kwargs):
return visitor.visitString(self, *args, **kwargs)
class Polymorphic(Type):
- def __init__(self, defaultType, switchExpr, switchTypes):
- Type.__init__(self, defaultType.expr)
- self.defaultType = defaultType
+ def __init__(self, switchExpr, switchTypes, defaultType=None, contextLess=True):
+ if defaultType is None:
+ Type.__init__(self, None)
+ contextLess = False
+ else:
+ Type.__init__(self, defaultType.expr)
self.switchExpr = switchExpr
self.switchTypes = switchTypes
+ self.defaultType = defaultType
+ self.contextLess = contextLess
def visit(self, visitor, *args, **kwargs):
return visitor.visitPolymorphic(self, *args, **kwargs)
def iterSwitch(self):
- cases = [['default']]
- types = [self.defaultType]
+ cases = []
+ types = []
+
+ if self.defaultType is not None:
+ cases.append(['default'])
+ types.append(self.defaultType)
for expr, type in self.switchTypes:
case = 'case %s' % expr
return zip(cases, types)
+def EnumPolymorphic(enumName, switchExpr, switchTypes, defaultType, contextLess=True):
+ enumValues = [expr for expr, type in switchTypes]
+ enum = Enum(enumName, enumValues)
+ polymorphic = Polymorphic(switchExpr, switchTypes, defaultType, contextLess)
+ return enum, polymorphic
+
+
class Visitor:
'''Abstract visitor for the type hierarchy.'''
def visitIntPointer(self, pointer, *args, **kwargs):
raise NotImplementedError
+ def visitObjPointer(self, pointer, *args, **kwargs):
+ raise NotImplementedError
+
def visitLinearPointer(self, pointer, *args, **kwargs):
raise NotImplementedError
+ def visitReference(self, reference, *args, **kwargs):
+ raise NotImplementedError
+
def visitHandle(self, handle, *args, **kwargs):
raise NotImplementedError
return literal
def visitString(self, string):
- return string
+ string_type = self.visit(string.type)
+ if string_type is string.type:
+ return string
+ else:
+ return String(string_type, string.length, string.wide)
def visitConst(self, const):
- return Const(const.type)
+ const_type = self.visit(const.type)
+ if const_type is const.type:
+ return const
+ else:
+ return Const(const_type)
def visitStruct(self, struct):
members = [(self.visit(type), name) for type, name in struct.members]
return Bitmask(type, bitmask.values)
def visitPointer(self, pointer):
- type = self.visit(pointer.type)
- return Pointer(type)
+ pointer_type = self.visit(pointer.type)
+ if pointer_type is pointer.type:
+ return pointer
+ else:
+ return Pointer(pointer_type)
def visitIntPointer(self, pointer):
return pointer
+ def visitObjPointer(self, pointer):
+ pointer_type = self.visit(pointer.type)
+ if pointer_type is pointer.type:
+ return pointer
+ else:
+ return ObjPointer(pointer_type)
+
def visitLinearPointer(self, pointer):
- type = self.visit(pointer.type)
- return LinearPointer(type, pointer.size)
+ pointer_type = self.visit(pointer.type)
+ if pointer_type is pointer.type:
+ return pointer
+ else:
+ return LinearPointer(pointer_type)
+
+ def visitReference(self, reference):
+ reference_type = self.visit(reference.type)
+ if reference_type is reference.type:
+ return reference
+ else:
+ return Reference(reference_type)
def visitHandle(self, handle):
- type = self.visit(handle.type)
- return Handle(handle.name, type, range=handle.range, key=handle.key)
+ handle_type = self.visit(handle.type)
+ if handle_type is handle.type:
+ return handle
+ else:
+ return Handle(handle.name, handle_type, range=handle.range, key=handle.key)
def visitAlias(self, alias):
- type = self.visit(alias.type)
- return Alias(alias.expr, type)
+ alias_type = self.visit(alias.type)
+ if alias_type is alias.type:
+ return alias
+ else:
+ return Alias(alias.expr, alias_type)
def visitOpaque(self, opaque):
return opaque
return interface
def visitPolymorphic(self, polymorphic):
- defaultType = self.visit(polymorphic.defaultType)
switchExpr = polymorphic.switchExpr
switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
- return Polymorphic(defaultType, switchExpr, switchTypes)
+ if polymorphic.defaultType is None:
+ defaultType = None
+ else:
+ defaultType = self.visit(polymorphic.defaultType)
+ return Polymorphic(switchExpr, switchTypes, defaultType, polymorphic.contextLess)
-class Collector(Visitor):
- '''Visitor which collects all unique types as it traverses them.'''
+class MutableRebuilder(Rebuilder):
+ '''Type visitor which derives a mutable type.'''
- def __init__(self):
- self.__visited = set()
- self.types = []
+ def visitString(self, string):
+ return string
- def visit(self, type):
- if type in self.__visited:
- return
- self.__visited.add(type)
- Visitor.visit(self, type)
- self.types.append(type)
+ def visitConst(self, const):
+ # Strip out const qualifier
+ return const.type
- def visitVoid(self, literal):
+ def visitAlias(self, alias):
+ # Tear the alias on type changes
+ type = self.visit(alias.type)
+ if type is alias.type:
+ return alias
+ return type
+
+ def visitReference(self, reference):
+ # Strip out references
+ return reference.type
+
+
+class Traverser(Visitor):
+ '''Visitor which all types.'''
+
+ def visitVoid(self, void, *args, **kwargs):
pass
- def visitLiteral(self, literal):
+ def visitLiteral(self, literal, *args, **kwargs):
pass
- def visitString(self, string):
+ def visitString(self, string, *args, **kwargs):
pass
- def visitConst(self, const):
- self.visit(const.type)
+ def visitConst(self, const, *args, **kwargs):
+ self.visit(const.type, *args, **kwargs)
- def visitStruct(self, struct):
+ def visitStruct(self, struct, *args, **kwargs):
for type, name in struct.members:
- self.visit(type)
+ self.visit(type, *args, **kwargs)
- def visitArray(self, array):
- self.visit(array.type)
+ def visitArray(self, array, *args, **kwargs):
+ self.visit(array.type, *args, **kwargs)
- def visitBlob(self, array):
+ def visitBlob(self, array, *args, **kwargs):
pass
- def visitEnum(self, enum):
+ def visitEnum(self, enum, *args, **kwargs):
pass
- def visitBitmask(self, bitmask):
- self.visit(bitmask.type)
+ def visitBitmask(self, bitmask, *args, **kwargs):
+ self.visit(bitmask.type, *args, **kwargs)
- def visitPointer(self, pointer):
- self.visit(pointer.type)
+ def visitPointer(self, pointer, *args, **kwargs):
+ self.visit(pointer.type, *args, **kwargs)
- def visitIntPointer(self, pointer):
+ def visitIntPointer(self, pointer, *args, **kwargs):
pass
- def visitLinearPointer(self, pointer):
- self.visit(pointer.type)
+ def visitObjPointer(self, pointer, *args, **kwargs):
+ self.visit(pointer.type, *args, **kwargs)
- def visitHandle(self, handle):
- self.visit(handle.type)
+ def visitLinearPointer(self, pointer, *args, **kwargs):
+ self.visit(pointer.type, *args, **kwargs)
- def visitAlias(self, alias):
- self.visit(alias.type)
+ def visitReference(self, reference, *args, **kwargs):
+ self.visit(reference.type, *args, **kwargs)
- def visitOpaque(self, opaque):
+ def visitHandle(self, handle, *args, **kwargs):
+ self.visit(handle.type, *args, **kwargs)
+
+ def visitAlias(self, alias, *args, **kwargs):
+ self.visit(alias.type, *args, **kwargs)
+
+ def visitOpaque(self, opaque, *args, **kwargs):
pass
- def visitInterface(self, interface):
+ def visitInterface(self, interface, *args, **kwargs):
if interface.base is not None:
- self.visit(interface.base)
+ self.visit(interface.base, *args, **kwargs)
for method in interface.iterMethods():
for arg in method.args:
- self.visit(arg.type)
- self.visit(method.type)
+ self.visit(arg.type, *args, **kwargs)
+ self.visit(method.type, *args, **kwargs)
- def visitPolymorphic(self, polymorphic):
- self.visit(polymorphic.defaultType)
+ def visitPolymorphic(self, polymorphic, *args, **kwargs):
for expr, type in polymorphic.switchTypes:
- self.visit(type)
+ self.visit(type, *args, **kwargs)
+ if polymorphic.defaultType is not None:
+ self.visit(polymorphic.defaultType, *args, **kwargs)
-class API:
- '''API abstraction.
+class Collector(Traverser):
+ '''Visitor which collects all unique types as it traverses them.'''
+
+ def __init__(self):
+ self.__visited = set()
+ self.types = []
+
+ def visit(self, type):
+ if type in self.__visited:
+ return
+ self.__visited.add(type)
+ Visitor.visit(self, type)
+ self.types.append(type)
+
+
+class ExpanderMixin:
+ '''Mixin class that provides a bunch of methods to expand C expressions
+ from the specifications.'''
+
+ __structs = None
+ __indices = None
+
+ def expand(self, expr):
+ # Expand a C expression, replacing certain variables
+ if not isinstance(expr, basestring):
+ return expr
+ variables = {}
+
+ if self.__structs is not None:
+ variables['self'] = '(%s)' % self.__structs[0]
+ if self.__indices is not None:
+ variables['i'] = self.__indices[0]
+
+ expandedExpr = expr.format(**variables)
+ if expandedExpr != expr and 0:
+ sys.stderr.write(" %r -> %r\n" % (expr, expandedExpr))
+ return expandedExpr
+
+ def visitMember(self, member, structInstance, *args, **kwargs):
+ memberType, memberName = member
+ if memberName is None:
+ # Anonymous structure/union member
+ memberInstance = structInstance
+ else:
+ memberInstance = '(%s).%s' % (structInstance, memberName)
+ self.__structs = (structInstance, self.__structs)
+ try:
+ return self.visit(memberType, memberInstance, *args, **kwargs)
+ finally:
+ _, self.__structs = self.__structs
+
+ def visitElement(self, elementIndex, elementType, *args, **kwargs):
+ self.__indices = (elementIndex, self.__indices)
+ try:
+ return self.visit(elementType, *args, **kwargs)
+ finally:
+ _, self.__indices = self.__indices
- Essentially, a collection of types, functions, and interfaces.
- '''
+
+class Module:
+ '''A collection of functions.'''
def __init__(self, name = None):
self.name = name
self.functions = []
self.interfaces = []
+ def addFunctions(self, functions):
+ self.functions.extend(functions)
+
+ def addInterfaces(self, interfaces):
+ self.interfaces.extend(interfaces)
+
+ def mergeModule(self, module):
+ self.headers.extend(module.headers)
+ self.functions.extend(module.functions)
+ self.interfaces.extend(module.interfaces)
+
+ def getFunctionByName(self, name):
+ for function in self.functions:
+ if function.name == name:
+ return function
+ return None
+
+
+class API:
+ '''API abstraction.
+
+ Essentially, a collection of types, functions, and interfaces.
+ '''
+
+ def __init__(self, modules = None):
+ self.modules = []
+ if modules is not None:
+ self.modules.extend(modules)
+
def getAllTypes(self):
collector = Collector()
- for function in self.functions:
- for arg in function.args:
- collector.visit(arg.type)
- collector.visit(function.type)
- for interface in self.interfaces:
- collector.visit(interface)
- for method in interface.iterMethods():
- for arg in method.args:
+ for module in self.modules:
+ for function in module.functions:
+ for arg in function.args:
collector.visit(arg.type)
- collector.visit(method.type)
+ collector.visit(function.type)
+ for interface in module.interfaces:
+ collector.visit(interface)
+ for method in interface.iterMethods():
+ for arg in method.args:
+ collector.visit(arg.type)
+ collector.visit(method.type)
return collector.types
+ def getAllFunctions(self):
+ functions = []
+ for module in self.modules:
+ functions.extend(module.functions)
+ return functions
+
def getAllInterfaces(self):
types = self.getAllTypes()
interfaces = [type for type in types if isinstance(type, Interface)]
- for interface in self.interfaces:
- if interface not in interfaces:
- interfaces.append(interface)
+ for module in self.modules:
+ for interface in module.interfaces:
+ if interface not in interfaces:
+ interfaces.append(interface)
return interfaces
- def addFunction(self, function):
- self.functions.append(function)
-
- def addFunctions(self, functions):
- for function in functions:
- self.addFunction(function)
-
- def addInterface(self, interface):
- self.interfaces.append(interface)
-
- def addInterfaces(self, interfaces):
- self.interfaces.extend(interfaces)
-
- def addApi(self, api):
- self.headers.extend(api.headers)
- self.addFunctions(api.functions)
- self.addInterfaces(api.interfaces)
+ def addModule(self, module):
+ self.modules.append(module)
- def get_function_by_name(self, name):
- for function in self.functions:
- if function.name == name:
- return function
+ def getFunctionByName(self, name):
+ for module in self.modules:
+ for function in module.functions:
+ if function.name == name:
+ return function
return None
-Bool = Literal("bool", "Bool")
-SChar = Literal("signed char", "SInt")
-UChar = Literal("unsigned char", "UInt")
-Short = Literal("short", "SInt")
-Int = Literal("int", "SInt")
-Long = Literal("long", "SInt")
-LongLong = Literal("long long", "SInt")
-UShort = Literal("unsigned short", "UInt")
-UInt = Literal("unsigned int", "UInt")
-ULong = Literal("unsigned long", "UInt")
-ULongLong = Literal("unsigned long long", "UInt")
-Float = Literal("float", "Float")
-Double = Literal("double", "Double")
-SizeT = Literal("size_t", "UInt")
-
# C string (i.e., zero terminated)
-CString = String()
-WString = String("wchar_t *", kind="WString")
-
-Int8 = Literal("int8_t", "SInt")
-UInt8 = Literal("uint8_t", "UInt")
-Int16 = Literal("int16_t", "SInt")
-UInt16 = Literal("uint16_t", "UInt")
-Int32 = Literal("int32_t", "SInt")
-UInt32 = Literal("uint32_t", "UInt")
-Int64 = Literal("int64_t", "SInt")
-UInt64 = Literal("uint64_t", "UInt")
+CString = String(Char)
+WString = String(WChar, wide=True)
+ConstCString = String(Const(Char))
+ConstWString = String(Const(WChar), wide=True)
projects / apitrace / blobdiff