1 ##########################################################################
3 # Copyright 2008-2009 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 ##########################################################################/
37 def visit(self, type, *args, **kwargs):
38 return type.visit(self, *args, **kwargs)
40 def visit_void(self, void, *args, **kwargs):
41 raise NotImplementedError
43 def visit_literal(self, literal, *args, **kwargs):
44 raise NotImplementedError
46 def visit_string(self, string, *args, **kwargs):
47 raise NotImplementedError
49 def visit_const(self, const, *args, **kwargs):
50 raise NotImplementedError
52 def visit_struct(self, struct, *args, **kwargs):
53 raise NotImplementedError
55 def visit_array(self, array, *args, **kwargs):
56 raise NotImplementedError
58 def visit_blob(self, blob, *args, **kwargs):
59 raise NotImplementedError
61 def visit_enum(self, enum, *args, **kwargs):
62 raise NotImplementedError
64 def visit_bitmask(self, bitmask, *args, **kwargs):
65 raise NotImplementedError
67 def visit_pointer(self, pointer, *args, **kwargs):
68 raise NotImplementedError
70 def visit_handle(self, handle, *args, **kwargs):
71 raise NotImplementedError
73 def visit_alias(self, alias, *args, **kwargs):
74 raise NotImplementedError
76 def visit_opaque(self, opaque, *args, **kwargs):
77 raise NotImplementedError
79 def visit_interface(self, interface, *args, **kwargs):
80 raise NotImplementedError
83 class OnceVisitor(Visitor):
86 self.__visited = set()
88 def visit(self, type, *args, **kwargs):
89 if type not in self.__visited:
90 self.__visited.add(type)
91 return type.visit(self, *args, **kwargs)
95 class Rebuilder(Visitor):
97 def visit_void(self, void):
100 def visit_literal(self, literal):
103 def visit_string(self, string):
106 def visit_const(self, const):
107 return Const(const.type)
109 def visit_struct(self, struct):
110 members = [self.visit(member) for member in struct.members]
111 return Struct(struct.name, members)
113 def visit_array(self, array):
114 type = self.visit(array.type)
115 return Array(type, array.length)
117 def visit_blob(self, blob):
118 type = self.visit(blob.type)
119 return Blob(type, blob.size)
121 def visit_enum(self, enum):
124 def visit_bitmask(self, bitmask):
125 type = self.visit(bitmask.type)
126 return Bitmask(type, bitmask.values)
128 def visit_pointer(self, pointer):
129 type = self.visit(pointer.type)
132 def visit_handle(self, handle):
133 type = self.visit(handle.type)
134 return Handle(handle.name, type)
136 def visit_alias(self, alias):
137 type = self.visit(alias.type)
138 return Alias(alias.expr, type)
140 def visit_opaque(self, opaque):
148 def __init__(self, expr, id = ''):
152 assert char.isalnum() or char in '_ '
154 id = id.replace(' ', '_')
158 id += str(Type.__seq)
160 assert id not in all_types
168 def visit(self, visitor, *args, **kwargs):
169 raise NotImplementedError
176 Type.__init__(self, "void")
178 def visit(self, visitor, *args, **kwargs):
179 return visitor.visit_void(self, *args, **kwargs)
184 class Concrete(Type):
187 print 'static void Dump%s(const %s &value);' % (self.id, self.expr)
190 print 'static void Dump%s(const %s &value) {' % (self.id, self.expr)
195 def _dump(self, instance):
196 raise NotImplementedError
198 def dump(self, instance):
199 print ' Dump%s(%s);' % (self.id, instance)
204 def __init__(self, expr, format, base=10):
205 Type.__init__(self, expr)
208 def visit(self, visitor, *args, **kwargs):
209 return visitor.visit_literal(self, *args, **kwargs)
214 def __init__(self, type):
216 if type.expr.startswith("const "):
217 expr = type.expr + " const"
219 expr = "const " + type.expr
221 Type.__init__(self, expr, 'C' + type.id)
225 def visit(self, visitor, *args, **kwargs):
226 return visitor.visit_const(self, *args, **kwargs)
231 def __init__(self, type):
232 Type.__init__(self, type.expr + " *", 'P' + type.id)
235 def visit(self, visitor, *args, **kwargs):
236 return visitor.visit_pointer(self, *args, **kwargs)
241 def __init__(self, name, type):
242 Type.__init__(self, type.expr, 'P' + type.id)
246 def visit(self, visitor, *args, **kwargs):
247 return visitor.visit_handle(self, *args, **kwargs)
250 def ConstPointer(type):
251 return Pointer(Const(type))
254 class Enum(Concrete):
256 def __init__(self, name, values):
257 Concrete.__init__(self, name)
260 def visit(self, visitor, *args, **kwargs):
261 return visitor.visit_enum(self, *args, **kwargs)
264 def FakeEnum(type, values):
265 return Enum(type.expr, values)
268 class Bitmask(Concrete):
270 def __init__(self, type, values):
271 Concrete.__init__(self, type.expr)
275 def visit(self, visitor, *args, **kwargs):
276 return visitor.visit_bitmask(self, *args, **kwargs)
283 def __init__(self, type, length):
284 Type.__init__(self, type.expr + " *")
288 def visit(self, visitor, *args, **kwargs):
289 return visitor.visit_array(self, *args, **kwargs)
294 def __init__(self, type, size):
295 Type.__init__(self, type.expr + ' *')
299 def visit(self, visitor, *args, **kwargs):
300 return visitor.visit_blob(self, *args, **kwargs)
303 class Struct(Concrete):
305 def __init__(self, name, members):
306 Concrete.__init__(self, name)
308 self.members = members
310 def visit(self, visitor, *args, **kwargs):
311 return visitor.visit_struct(self, *args, **kwargs)
316 def __init__(self, expr, type):
317 Type.__init__(self, expr)
320 def visit(self, visitor, *args, **kwargs):
321 return visitor.visit_alias(self, *args, **kwargs)
325 arg = Arg(type, name, output=True)
331 def __init__(self, type, name, output=False):
337 return '%s %s' % (self.type, self.name)
342 def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, hidden=False):
348 if isinstance(arg, tuple):
349 arg_type, arg_name = arg
350 arg = Arg(arg_type, arg_name)
351 self.args.append(arg)
355 self.sideeffects = sideeffects
358 def prototype(self, name=None):
365 s = self.call + ' ' + s
366 if name.startswith('*'):
368 s = self.type.expr + ' ' + s
371 s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
378 def StdFunction(*args, **kwargs):
379 kwargs.setdefault('call', 'GLAPIENTRY')
380 return Function(*args, **kwargs)
383 def FunctionPointer(type, name, args, **kwargs):
388 class Interface(Type):
390 def __init__(self, name, base=None):
391 Type.__init__(self, name)
396 def itermethods(self):
397 if self.base is not None:
398 for method in self.base.itermethods():
400 for method in self.methods:
405 class Method(Function):
407 def __init__(self, type, name, args):
408 Function.__init__(self, type, name, args, call = '__stdcall')
414 def WrapPointer(type):
421 Type.__init__(self, "char *")
423 def visit(self, visitor, *args, **kwargs):
424 return visitor.visit_string(self, *args, **kwargs)
430 '''Opaque pointer.'''
432 def __init__(self, expr):
433 Type.__init__(self, expr)
435 def visit(self, visitor, *args, **kwargs):
436 return visitor.visit_opaque(self, *args, **kwargs)
439 def OpaquePointer(type):
440 return Opaque(type.expr + ' *')
446 def __init__(self, name):
453 def add_type(self, type):
454 if type not in self.types:
457 def add_function(self, function):
458 self.functions.append(function)
459 for arg in function.args:
460 self.add_type(arg.type)
461 self.add_type(function.type)
463 def add_functions(self, functions):
464 for function in functions:
465 self.add_function(function)
467 def add_interface(self, interface):
468 self.interfaces.append(interface)
470 def add_interfaces(self, interfaces):
471 self.interfaces.extend(interfaces)
474 Bool = Literal("bool", "Bool")
475 SChar = Literal("signed char", "SInt")
476 UChar = Literal("unsigned char", "UInt")
477 Short = Literal("short", "SInt")
478 Int = Literal("int", "SInt")
479 Long = Literal("long", "SInt")
480 LongLong = Literal("long long", "SInt")
481 UShort = Literal("unsigned short", "UInt")
482 UInt = Literal("unsigned int", "UInt")
483 ULong = Literal("unsigned long", "UInt")
484 ULongLong = Literal("unsigned long long", "UInt")
485 Float = Literal("float", "Float")
486 Double = Literal("double", "Float")
487 SizeT = Literal("size_t", "UInt")
488 WString = Literal("wchar_t *", "WString")