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, handle.range)
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, range=None):
242 Type.__init__(self, type.expr, 'P' + type.id)
247 def visit(self, visitor, *args, **kwargs):
248 return visitor.visit_handle(self, *args, **kwargs)
251 def ConstPointer(type):
252 return Pointer(Const(type))
255 class Enum(Concrete):
259 def __init__(self, name, values):
260 Concrete.__init__(self, name)
261 self.vid = Enum.__vid
262 Enum.__vid += len(values)
263 self.values = list(values)
265 def visit(self, visitor, *args, **kwargs):
266 return visitor.visit_enum(self, *args, **kwargs)
269 def FakeEnum(type, values):
270 return Enum(type.expr, values)
273 class Bitmask(Concrete):
275 def __init__(self, type, values):
276 Concrete.__init__(self, type.expr)
280 def visit(self, visitor, *args, **kwargs):
281 return visitor.visit_bitmask(self, *args, **kwargs)
288 def __init__(self, type, length):
289 Type.__init__(self, type.expr + " *")
293 def visit(self, visitor, *args, **kwargs):
294 return visitor.visit_array(self, *args, **kwargs)
299 def __init__(self, type, size):
300 Type.__init__(self, type.expr + ' *')
304 def visit(self, visitor, *args, **kwargs):
305 return visitor.visit_blob(self, *args, **kwargs)
308 class Struct(Concrete):
310 def __init__(self, name, members):
311 Concrete.__init__(self, name)
313 self.members = members
315 def visit(self, visitor, *args, **kwargs):
316 return visitor.visit_struct(self, *args, **kwargs)
321 def __init__(self, expr, type):
322 Type.__init__(self, expr)
325 def visit(self, visitor, *args, **kwargs):
326 return visitor.visit_alias(self, *args, **kwargs)
330 arg = Arg(type, name, output=True)
336 def __init__(self, type, name, output=False):
343 return '%s %s' % (self.type, self.name)
350 def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, hidden=False):
351 self.id = Function.__id
360 if isinstance(arg, tuple):
361 arg_type, arg_name = arg
362 arg = Arg(arg_type, arg_name)
365 self.args.append(arg)
369 self.sideeffects = sideeffects
372 def prototype(self, name=None):
379 s = self.call + ' ' + s
380 if name.startswith('*'):
382 s = self.type.expr + ' ' + s
385 s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
392 def StdFunction(*args, **kwargs):
393 kwargs.setdefault('call', '__stdcall')
394 return Function(*args, **kwargs)
397 def FunctionPointer(type, name, args, **kwargs):
402 class Interface(Type):
404 def __init__(self, name, base=None):
405 Type.__init__(self, name)
410 def visit(self, visitor, *args, **kwargs):
411 return visitor.visit_interface(self, *args, **kwargs)
413 def itermethods(self):
414 if self.base is not None:
415 for method in self.base.itermethods():
417 for method in self.methods:
422 class Method(Function):
424 def __init__(self, type, name, args):
425 Function.__init__(self, type, name, args, call = '__stdcall')
426 for index in range(len(self.args)):
427 self.args[index].index = index + 1
432 def WrapPointer(type):
438 def __init__(self, expr = "char *", length = None):
439 Type.__init__(self, expr)
442 def visit(self, visitor, *args, **kwargs):
443 return visitor.visit_string(self, *args, **kwargs)
449 '''Opaque pointer.'''
451 def __init__(self, expr):
452 Type.__init__(self, expr)
454 def visit(self, visitor, *args, **kwargs):
455 return visitor.visit_opaque(self, *args, **kwargs)
458 def OpaquePointer(type, *args):
459 return Opaque(type.expr + ' *')
461 def OpaqueArray(type, size):
462 return Opaque(type.expr + ' *')
464 def OpaqueBlob(type, size):
465 return Opaque(type.expr + ' *')
468 class Collector(Visitor):
472 self.__visited = set()
475 def visit(self, type):
476 if type in self.__visited:
478 self.__visited.add(type)
479 Visitor.visit(self, type)
480 self.types.append(type)
482 def visit_void(self, literal):
485 def visit_literal(self, literal):
488 def visit_string(self, string):
491 def visit_const(self, const):
492 self.visit(const.type)
494 def visit_struct(self, struct):
495 for type, name in struct.members:
498 def visit_array(self, array):
499 self.visit(array.type)
501 def visit_blob(self, array):
504 def visit_enum(self, enum):
507 def visit_bitmask(self, bitmask):
508 self.visit(bitmask.type)
510 def visit_pointer(self, pointer):
511 self.visit(pointer.type)
513 def visit_handle(self, handle):
514 self.visit(handle.type)
516 def visit_alias(self, alias):
517 self.visit(alias.type)
519 def visit_opaque(self, opaque):
522 def visit_interface(self, interface):
523 if interface.base is not None:
524 self.visit(interface.base)
525 for method in interface.itermethods():
526 for arg in method.args:
528 self.visit(method.type)
533 def __init__(self, name):
540 collector = Collector()
541 for function in self.functions:
542 for arg in function.args:
543 collector.visit(arg.type)
544 collector.visit(function.type)
545 for interface in self.interfaces:
546 collector.visit(interface)
547 for method in interface.itermethods():
548 for arg in method.args:
549 collector.visit(arg.type)
550 collector.visit(method.type)
551 return collector.types
553 def add_function(self, function):
554 self.functions.append(function)
556 def add_functions(self, functions):
557 for function in functions:
558 self.add_function(function)
560 def add_interface(self, interface):
561 self.interfaces.append(interface)
563 def add_interfaces(self, interfaces):
564 self.interfaces.extend(interfaces)
567 Bool = Literal("bool", "Bool")
568 SChar = Literal("signed char", "SInt")
569 UChar = Literal("unsigned char", "UInt")
570 Short = Literal("short", "SInt")
571 Int = Literal("int", "SInt")
572 Long = Literal("long", "SInt")
573 LongLong = Literal("long long", "SInt")
574 UShort = Literal("unsigned short", "UInt")
575 UInt = Literal("unsigned int", "UInt")
576 ULong = Literal("unsigned long", "UInt")
577 ULongLong = Literal("unsigned long long", "UInt")
578 Float = Literal("float", "Float")
579 Double = Literal("double", "Float")
580 SizeT = Literal("size_t", "UInt")
581 WString = Literal("wchar_t *", "WString")
583 Int8 = Literal("int8_t", "SInt")
584 UInt8 = Literal("uint8_t", "UInt")
585 Int16 = Literal("int16_t", "SInt")
586 UInt16 = Literal("uint16_t", "UInt")
587 Int32 = Literal("int32_t", "SInt")
588 UInt32 = Literal("uint32_t", "UInt")
589 Int64 = Literal("int64_t", "SInt")
590 UInt64 = Literal("uint64_t", "UInt")