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 ##########################################################################/
37 def __init__(self, expr, id = ''):
41 assert char.isalnum() or char in '_ '
43 id = id.replace(' ', '_')
49 assert id not in Type.__all
57 def visit(self, visitor, *args, **kwargs):
58 raise NotImplementedError
65 Type.__init__(self, "void")
67 def visit(self, visitor, *args, **kwargs):
68 return visitor.visit_void(self, *args, **kwargs)
75 def __init__(self, expr, format, base=10):
76 Type.__init__(self, expr)
79 def visit(self, visitor, *args, **kwargs):
80 return visitor.visit_literal(self, *args, **kwargs)
85 def __init__(self, type):
86 # While "const foo" and "foo const" are synonymous, "const foo *" and
87 # "foo * const" are not quite the same, and some compilers do enforce
88 # strict const correctness.
89 if isinstance(type, String) or type is WString:
90 # For strings we never intend to say a const pointer to chars, but
91 # rather a point to const chars.
92 expr = "const " + type.expr
93 elif type.expr.startswith("const ") or '*' in type.expr:
94 expr = type.expr + " const"
97 expr = "const " + type.expr
99 Type.__init__(self, expr, 'C' + type.id)
103 def visit(self, visitor, *args, **kwargs):
104 return visitor.visit_const(self, *args, **kwargs)
109 def __init__(self, type):
110 Type.__init__(self, type.expr + " *", 'P' + type.id)
113 def visit(self, visitor, *args, **kwargs):
114 return visitor.visit_pointer(self, *args, **kwargs)
119 def __init__(self, name, type, range=None, key=None):
120 Type.__init__(self, type.expr, 'P' + type.id)
126 def visit(self, visitor, *args, **kwargs):
127 return visitor.visit_handle(self, *args, **kwargs)
130 def ConstPointer(type):
131 return Pointer(Const(type))
136 def __init__(self, name, values):
137 Type.__init__(self, name)
138 self.values = list(values)
140 def visit(self, visitor, *args, **kwargs):
141 return visitor.visit_enum(self, *args, **kwargs)
144 def FakeEnum(type, values):
145 return Enum(type.expr, values)
150 def __init__(self, type, values):
151 Type.__init__(self, type.expr)
155 def visit(self, visitor, *args, **kwargs):
156 return visitor.visit_bitmask(self, *args, **kwargs)
163 def __init__(self, type, length):
164 Type.__init__(self, type.expr + " *")
168 def visit(self, visitor, *args, **kwargs):
169 return visitor.visit_array(self, *args, **kwargs)
174 def __init__(self, type, size):
175 Type.__init__(self, type.expr + ' *')
179 def visit(self, visitor, *args, **kwargs):
180 return visitor.visit_blob(self, *args, **kwargs)
185 def __init__(self, name, members):
186 Type.__init__(self, name)
188 self.members = members
190 def visit(self, visitor, *args, **kwargs):
191 return visitor.visit_struct(self, *args, **kwargs)
196 def __init__(self, expr, type):
197 Type.__init__(self, expr)
200 def visit(self, visitor, *args, **kwargs):
201 return visitor.visit_alias(self, *args, **kwargs)
205 arg = Arg(type, name, output=True)
211 def __init__(self, type, name, output=False):
218 return '%s %s' % (self.type, self.name)
225 def __init__(self, type, name, args, call = '', fail = None, sideeffects=True):
226 self.id = Function.__id
235 if not isinstance(arg, Arg):
236 if isinstance(arg, tuple):
237 arg_type, arg_name = arg
240 arg_name = "arg%u" % index
241 arg = Arg(arg_type, arg_name)
244 self.args.append(arg)
248 self.sideeffects = sideeffects
250 def prototype(self, name=None):
257 s = self.call + ' ' + s
258 if name.startswith('*'):
260 s = self.type.expr + ' ' + s
263 s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
270 def StdFunction(*args, **kwargs):
271 kwargs.setdefault('call', '__stdcall')
272 return Function(*args, **kwargs)
275 def FunctionPointer(type, name, args, **kwargs):
276 # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
280 class Interface(Type):
282 def __init__(self, name, base=None):
283 Type.__init__(self, name)
288 def visit(self, visitor, *args, **kwargs):
289 return visitor.visit_interface(self, *args, **kwargs)
291 def itermethods(self):
292 if self.base is not None:
293 for method in self.base.itermethods():
295 for method in self.methods:
300 class Method(Function):
302 def __init__(self, type, name, args):
303 Function.__init__(self, type, name, args, call = '__stdcall')
304 for index in range(len(self.args)):
305 self.args[index].index = index + 1
310 def __init__(self, expr = "char *", length = None):
311 Type.__init__(self, expr)
314 def visit(self, visitor, *args, **kwargs):
315 return visitor.visit_string(self, *args, **kwargs)
317 # C string (i.e., zero terminated)
322 '''Opaque pointer.'''
324 def __init__(self, expr):
325 Type.__init__(self, expr)
327 def visit(self, visitor, *args, **kwargs):
328 return visitor.visit_opaque(self, *args, **kwargs)
331 def OpaquePointer(type, *args):
332 return Opaque(type.expr + ' *')
334 def OpaqueArray(type, size):
335 return Opaque(type.expr + ' *')
337 def OpaqueBlob(type, size):
338 return Opaque(type.expr + ' *')
343 def visit(self, type, *args, **kwargs):
344 return type.visit(self, *args, **kwargs)
346 def visit_void(self, void, *args, **kwargs):
347 raise NotImplementedError
349 def visit_literal(self, literal, *args, **kwargs):
350 raise NotImplementedError
352 def visit_string(self, string, *args, **kwargs):
353 raise NotImplementedError
355 def visit_const(self, const, *args, **kwargs):
356 raise NotImplementedError
358 def visit_struct(self, struct, *args, **kwargs):
359 raise NotImplementedError
361 def visit_array(self, array, *args, **kwargs):
362 raise NotImplementedError
364 def visit_blob(self, blob, *args, **kwargs):
365 raise NotImplementedError
367 def visit_enum(self, enum, *args, **kwargs):
368 raise NotImplementedError
370 def visit_bitmask(self, bitmask, *args, **kwargs):
371 raise NotImplementedError
373 def visit_pointer(self, pointer, *args, **kwargs):
374 raise NotImplementedError
376 def visit_handle(self, handle, *args, **kwargs):
377 raise NotImplementedError
379 def visit_alias(self, alias, *args, **kwargs):
380 raise NotImplementedError
382 def visit_opaque(self, opaque, *args, **kwargs):
383 raise NotImplementedError
385 def visit_interface(self, interface, *args, **kwargs):
386 raise NotImplementedError
389 class OnceVisitor(Visitor):
392 self.__visited = set()
394 def visit(self, type, *args, **kwargs):
395 if type not in self.__visited:
396 self.__visited.add(type)
397 return type.visit(self, *args, **kwargs)
401 class Rebuilder(Visitor):
403 def visit_void(self, void):
406 def visit_literal(self, literal):
409 def visit_string(self, string):
412 def visit_const(self, const):
413 return Const(const.type)
415 def visit_struct(self, struct):
416 members = [(self.visit(type), name) for type, name in struct.members]
417 return Struct(struct.name, members)
419 def visit_array(self, array):
420 type = self.visit(array.type)
421 return Array(type, array.length)
423 def visit_blob(self, blob):
424 type = self.visit(blob.type)
425 return Blob(type, blob.size)
427 def visit_enum(self, enum):
430 def visit_bitmask(self, bitmask):
431 type = self.visit(bitmask.type)
432 return Bitmask(type, bitmask.values)
434 def visit_pointer(self, pointer):
435 type = self.visit(pointer.type)
438 def visit_handle(self, handle):
439 type = self.visit(handle.type)
440 return Handle(handle.name, type, range=handle.range, key=handle.key)
442 def visit_alias(self, alias):
443 type = self.visit(alias.type)
444 return Alias(alias.expr, type)
446 def visit_opaque(self, opaque):
450 class Collector(Visitor):
454 self.__visited = set()
457 def visit(self, type):
458 if type in self.__visited:
460 self.__visited.add(type)
461 Visitor.visit(self, type)
462 self.types.append(type)
464 def visit_void(self, literal):
467 def visit_literal(self, literal):
470 def visit_string(self, string):
473 def visit_const(self, const):
474 self.visit(const.type)
476 def visit_struct(self, struct):
477 for type, name in struct.members:
480 def visit_array(self, array):
481 self.visit(array.type)
483 def visit_blob(self, array):
486 def visit_enum(self, enum):
489 def visit_bitmask(self, bitmask):
490 self.visit(bitmask.type)
492 def visit_pointer(self, pointer):
493 self.visit(pointer.type)
495 def visit_handle(self, handle):
496 self.visit(handle.type)
498 def visit_alias(self, alias):
499 self.visit(alias.type)
501 def visit_opaque(self, opaque):
504 def visit_interface(self, interface):
505 if interface.base is not None:
506 self.visit(interface.base)
507 for method in interface.itermethods():
508 for arg in method.args:
510 self.visit(method.type)
515 def __init__(self, name = None):
522 collector = Collector()
523 for function in self.functions:
524 for arg in function.args:
525 collector.visit(arg.type)
526 collector.visit(function.type)
527 for interface in self.interfaces:
528 collector.visit(interface)
529 for method in interface.itermethods():
530 for arg in method.args:
531 collector.visit(arg.type)
532 collector.visit(method.type)
533 return collector.types
535 def add_function(self, function):
536 self.functions.append(function)
538 def add_functions(self, functions):
539 for function in functions:
540 self.add_function(function)
542 def add_interface(self, interface):
543 self.interfaces.append(interface)
545 def add_interfaces(self, interfaces):
546 self.interfaces.extend(interfaces)
548 def add_api(self, api):
549 self.headers.extend(api.headers)
550 self.add_functions(api.functions)
551 self.add_interfaces(api.interfaces)
553 def get_function_by_name(self, name):
554 for function in self.functions:
555 if function.name == name:
560 Bool = Literal("bool", "Bool")
561 SChar = Literal("signed char", "SInt")
562 UChar = Literal("unsigned char", "UInt")
563 Short = Literal("short", "SInt")
564 Int = Literal("int", "SInt")
565 Long = Literal("long", "SInt")
566 LongLong = Literal("long long", "SInt")
567 UShort = Literal("unsigned short", "UInt")
568 UInt = Literal("unsigned int", "UInt")
569 ULong = Literal("unsigned long", "UInt")
570 ULongLong = Literal("unsigned long long", "UInt")
571 Float = Literal("float", "Float")
572 Double = Literal("double", "Double")
573 SizeT = Literal("size_t", "UInt")
574 WString = Literal("wchar_t *", "WString")
576 Int8 = Literal("int8_t", "SInt")
577 UInt8 = Literal("uint8_t", "UInt")
578 Int16 = Literal("int16_t", "SInt")
579 UInt16 = Literal("uint16_t", "UInt")
580 Int32 = Literal("int32_t", "SInt")
581 UInt32 = Literal("uint32_t", "UInt")
582 Int64 = Literal("int64_t", "SInt")
583 UInt64 = Literal("uint64_t", "UInt")