blob: c2a154db0f19936b4048ac2609886ea223340e2a [file] [log] [blame]
José Fonseca7ad40262009-09-30 17:17:12 +01001##########################################################################
José Fonseca95442442008-07-08 10:32:53 +09002#
José Fonseca6fac5ae2010-11-29 16:09:13 +00003# Copyright 2008-2010 VMware, Inc.
José Fonseca7ad40262009-09-30 17:17:12 +01004# All Rights Reserved.
José Fonseca95442442008-07-08 10:32:53 +09005#
José Fonseca7ad40262009-09-30 17:17:12 +01006# 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:
José Fonseca95442442008-07-08 10:32:53 +090012#
José Fonseca7ad40262009-09-30 17:17:12 +010013# The above copyright notice and this permission notice shall be included in
14# all copies or substantial portions of the Software.
José Fonseca95442442008-07-08 10:32:53 +090015#
José Fonseca7ad40262009-09-30 17:17:12 +010016# 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
22# THE SOFTWARE.
José Fonseca95442442008-07-08 10:32:53 +090023#
José Fonseca7ad40262009-09-30 17:17:12 +010024##########################################################################/
José Fonseca95442442008-07-08 10:32:53 +090025
José Fonsecad626cf42008-07-07 07:43:16 +090026"""C basic types"""
27
José Fonseca8a56d142008-07-09 12:18:08 +090028
29import debug
30
31
José Fonseca6fac5ae2010-11-29 16:09:13 +000032class Type:
José Fonseca02c25002011-10-15 13:17:26 +010033 """Base class for all types."""
José Fonseca6fac5ae2010-11-29 16:09:13 +000034
José Fonseca02c25002011-10-15 13:17:26 +010035 __tags = set()
José Fonseca6fac5ae2010-11-29 16:09:13 +000036
José Fonseca02c25002011-10-15 13:17:26 +010037 def __init__(self, expr, tag = None):
José Fonseca6fac5ae2010-11-29 16:09:13 +000038 self.expr = expr
José Fonseca6fac5ae2010-11-29 16:09:13 +000039
José Fonseca02c25002011-10-15 13:17:26 +010040 # Generate a default tag, used when naming functions that will operate
41 # on this type, so it should preferrably be something representative of
42 # the type.
43 if tag is None:
José Fonseca5b6fb752012-04-14 14:56:45 +010044 if expr is not None:
45 tag = ''.join([c for c in expr if c.isalnum() or c in '_'])
46 else:
47 tag = 'anonynoums'
José Fonseca02c25002011-10-15 13:17:26 +010048 else:
49 for c in tag:
50 assert c.isalnum() or c in '_'
José Fonseca6fac5ae2010-11-29 16:09:13 +000051
José Fonseca02c25002011-10-15 13:17:26 +010052 # Ensure it is unique.
53 if tag in Type.__tags:
54 suffix = 1
55 while tag + str(suffix) in Type.__tags:
56 suffix += 1
57 tag += str(suffix)
58
59 assert tag not in Type.__tags
60 Type.__tags.add(tag)
61
62 self.tag = tag
José Fonseca6fac5ae2010-11-29 16:09:13 +000063
64 def __str__(self):
José Fonseca02c25002011-10-15 13:17:26 +010065 """Return the C/C++ type expression for this type."""
José Fonseca6fac5ae2010-11-29 16:09:13 +000066 return self.expr
67
68 def visit(self, visitor, *args, **kwargs):
69 raise NotImplementedError
70
José Fonseca0075f152012-04-14 20:25:52 +010071 def mutable(self):
72 '''Return a mutable version of this type.
73
74 Convenience wrapper around MutableRebuilder.'''
75 visitor = MutableRebuilder()
76 return visitor.visit(self)
José Fonseca6fac5ae2010-11-29 16:09:13 +000077
78
79class _Void(Type):
José Fonseca02c25002011-10-15 13:17:26 +010080 """Singleton void type."""
José Fonseca6fac5ae2010-11-29 16:09:13 +000081
82 def __init__(self):
83 Type.__init__(self, "void")
84
85 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +000086 return visitor.visitVoid(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +000087
88Void = _Void()
89
90
91class Literal(Type):
José Fonseca2f2ea482011-10-15 15:10:06 +010092 """Class to describe literal types.
José Fonseca6fac5ae2010-11-29 16:09:13 +000093
José Fonseca2f2ea482011-10-15 15:10:06 +010094 Types which are not defined in terms of other types, such as integers and
95 floats."""
96
97 def __init__(self, expr, kind):
José Fonseca6fac5ae2010-11-29 16:09:13 +000098 Type.__init__(self, expr)
José Fonseca2f2ea482011-10-15 15:10:06 +010099 self.kind = kind
José Fonseca6fac5ae2010-11-29 16:09:13 +0000100
101 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000102 return visitor.visitLiteral(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000103
104
José Fonsecabcfc81b2012-08-07 21:07:22 +0100105Bool = Literal("bool", "Bool")
106SChar = Literal("signed char", "SInt")
107UChar = Literal("unsigned char", "UInt")
108Short = Literal("short", "SInt")
109Int = Literal("int", "SInt")
110Long = Literal("long", "SInt")
111LongLong = Literal("long long", "SInt")
112UShort = Literal("unsigned short", "UInt")
113UInt = Literal("unsigned int", "UInt")
114ULong = Literal("unsigned long", "UInt")
115ULongLong = Literal("unsigned long long", "UInt")
116Float = Literal("float", "Float")
117Double = Literal("double", "Double")
118SizeT = Literal("size_t", "UInt")
119
120Char = Literal("char", "SInt")
121WChar = Literal("wchar_t", "SInt")
122
123Int8 = Literal("int8_t", "SInt")
124UInt8 = Literal("uint8_t", "UInt")
125Int16 = Literal("int16_t", "SInt")
126UInt16 = Literal("uint16_t", "UInt")
127Int32 = Literal("int32_t", "SInt")
128UInt32 = Literal("uint32_t", "UInt")
129Int64 = Literal("int64_t", "SInt")
130UInt64 = Literal("uint64_t", "UInt")
131
José Fonsecacb9d2e02012-10-19 14:51:48 +0100132IntPtr = Literal("intptr_t", "SInt")
133UIntPtr = Literal("uintptr_t", "UInt")
José Fonsecabcfc81b2012-08-07 21:07:22 +0100134
José Fonseca6fac5ae2010-11-29 16:09:13 +0000135class Const(Type):
136
137 def __init__(self, type):
José Fonseca903c2ca2011-09-23 09:43:05 +0100138 # While "const foo" and "foo const" are synonymous, "const foo *" and
139 # "foo * const" are not quite the same, and some compilers do enforce
140 # strict const correctness.
José Fonsecabcfc81b2012-08-07 21:07:22 +0100141 if type.expr.startswith("const ") or '*' in type.expr:
José Fonseca6fac5ae2010-11-29 16:09:13 +0000142 expr = type.expr + " const"
143 else:
José Fonseca903c2ca2011-09-23 09:43:05 +0100144 # The most legible
José Fonseca6fac5ae2010-11-29 16:09:13 +0000145 expr = "const " + type.expr
146
José Fonseca02c25002011-10-15 13:17:26 +0100147 Type.__init__(self, expr, 'C' + type.tag)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000148
149 self.type = type
150
151 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000152 return visitor.visitConst(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000153
154
155class Pointer(Type):
156
157 def __init__(self, type):
José Fonseca02c25002011-10-15 13:17:26 +0100158 Type.__init__(self, type.expr + " *", 'P' + type.tag)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000159 self.type = type
160
161 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000162 return visitor.visitPointer(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000163
164
José Fonseca59ee88e2012-01-15 14:24:10 +0000165class IntPointer(Type):
166 '''Integer encoded as a pointer.'''
167
168 def visit(self, visitor, *args, **kwargs):
169 return visitor.visitIntPointer(self, *args, **kwargs)
170
171
José Fonsecafbcf6832012-04-05 07:10:30 +0100172class ObjPointer(Type):
173 '''Pointer to an object.'''
174
175 def __init__(self, type):
176 Type.__init__(self, type.expr + " *", 'P' + type.tag)
177 self.type = type
178
179 def visit(self, visitor, *args, **kwargs):
180 return visitor.visitObjPointer(self, *args, **kwargs)
181
182
José Fonseca59ee88e2012-01-15 14:24:10 +0000183class LinearPointer(Type):
José Fonsecafbcf6832012-04-05 07:10:30 +0100184 '''Pointer to a linear range of memory.'''
José Fonseca59ee88e2012-01-15 14:24:10 +0000185
186 def __init__(self, type, size = None):
187 Type.__init__(self, type.expr + " *", 'P' + type.tag)
188 self.type = type
189 self.size = size
190
191 def visit(self, visitor, *args, **kwargs):
192 return visitor.visitLinearPointer(self, *args, **kwargs)
193
194
José Fonsecab89c5932012-04-01 22:47:11 +0200195class Reference(Type):
196 '''C++ references.'''
197
198 def __init__(self, type):
199 Type.__init__(self, type.expr + " &", 'R' + type.tag)
200 self.type = type
201
202 def visit(self, visitor, *args, **kwargs):
203 return visitor.visitReference(self, *args, **kwargs)
204
205
José Fonseca6fac5ae2010-11-29 16:09:13 +0000206class Handle(Type):
207
José Fonseca8a844ae2010-12-06 18:50:52 +0000208 def __init__(self, name, type, range=None, key=None):
José Fonseca02c25002011-10-15 13:17:26 +0100209 Type.__init__(self, type.expr, 'P' + type.tag)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000210 self.name = name
211 self.type = type
212 self.range = range
José Fonseca8a844ae2010-12-06 18:50:52 +0000213 self.key = key
José Fonseca6fac5ae2010-11-29 16:09:13 +0000214
215 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000216 return visitor.visitHandle(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000217
218
219def ConstPointer(type):
220 return Pointer(Const(type))
221
222
223class Enum(Type):
224
José Fonseca02c25002011-10-15 13:17:26 +0100225 __id = 0
226
José Fonseca6fac5ae2010-11-29 16:09:13 +0000227 def __init__(self, name, values):
228 Type.__init__(self, name)
José Fonseca02c25002011-10-15 13:17:26 +0100229
230 self.id = Enum.__id
231 Enum.__id += 1
232
José Fonseca6fac5ae2010-11-29 16:09:13 +0000233 self.values = list(values)
José Fonseca02c25002011-10-15 13:17:26 +0100234
José Fonseca6fac5ae2010-11-29 16:09:13 +0000235 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000236 return visitor.visitEnum(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000237
238
239def FakeEnum(type, values):
240 return Enum(type.expr, values)
241
242
243class Bitmask(Type):
244
José Fonseca02c25002011-10-15 13:17:26 +0100245 __id = 0
246
José Fonseca6fac5ae2010-11-29 16:09:13 +0000247 def __init__(self, type, values):
248 Type.__init__(self, type.expr)
José Fonseca02c25002011-10-15 13:17:26 +0100249
250 self.id = Bitmask.__id
251 Bitmask.__id += 1
252
José Fonseca6fac5ae2010-11-29 16:09:13 +0000253 self.type = type
254 self.values = values
255
256 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000257 return visitor.visitBitmask(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000258
259Flags = Bitmask
260
261
262class Array(Type):
263
264 def __init__(self, type, length):
265 Type.__init__(self, type.expr + " *")
266 self.type = type
267 self.length = length
268
269 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000270 return visitor.visitArray(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000271
272
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200273class AttribArray(Type):
274
José Fonseca48a92b92013-07-20 15:34:24 +0100275 def __init__(self, baseType, valueTypes, terminator = '0'):
José Fonseca77c10d82013-07-20 15:27:29 +0100276 self.baseType = baseType
José Fonseca48a92b92013-07-20 15:34:24 +0100277 Type.__init__(self, (Pointer(self.baseType)).expr)
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200278 self.valueTypes = valueTypes
Andreas Hartmetz7a0de292013-07-09 22:38:29 +0200279 self.terminator = terminator
280 self.hasKeysWithoutValues = False
281 for key, value in valueTypes:
282 if value is None:
283 self.hasKeysWithoutValues = True
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200284
285 def visit(self, visitor, *args, **kwargs):
286 return visitor.visitAttribArray(self, *args, **kwargs)
287
288
José Fonseca6fac5ae2010-11-29 16:09:13 +0000289class Blob(Type):
290
291 def __init__(self, type, size):
292 Type.__init__(self, type.expr + ' *')
293 self.type = type
294 self.size = size
295
296 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000297 return visitor.visitBlob(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000298
299
300class Struct(Type):
301
José Fonseca02c25002011-10-15 13:17:26 +0100302 __id = 0
303
José Fonseca6fac5ae2010-11-29 16:09:13 +0000304 def __init__(self, name, members):
305 Type.__init__(self, name)
José Fonseca02c25002011-10-15 13:17:26 +0100306
307 self.id = Struct.__id
308 Struct.__id += 1
309
José Fonseca6fac5ae2010-11-29 16:09:13 +0000310 self.name = name
José Fonsecadbf714b2012-11-20 17:03:43 +0000311 self.members = members
José Fonseca6fac5ae2010-11-29 16:09:13 +0000312
313 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000314 return visitor.visitStruct(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000315
316
José Fonsecadbf714b2012-11-20 17:03:43 +0000317def Union(kindExpr, kindTypes, contextLess=True):
José Fonsecaeb216e62012-11-20 11:08:08 +0000318 switchTypes = []
319 for kindCase, kindType, kindMemberName in kindTypes:
320 switchType = Struct(None, [(kindType, kindMemberName)])
321 switchTypes.append((kindCase, switchType))
322 return Polymorphic(kindExpr, switchTypes, contextLess=contextLess)
323
José Fonseca5b6fb752012-04-14 14:56:45 +0100324
José Fonseca6fac5ae2010-11-29 16:09:13 +0000325class Alias(Type):
326
327 def __init__(self, expr, type):
328 Type.__init__(self, expr)
329 self.type = type
330
331 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000332 return visitor.visitAlias(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000333
José Fonseca6fac5ae2010-11-29 16:09:13 +0000334class Arg:
335
José Fonseca9dd8f702012-04-07 10:42:50 +0100336 def __init__(self, type, name, input=True, output=False):
José Fonseca6fac5ae2010-11-29 16:09:13 +0000337 self.type = type
338 self.name = name
José Fonseca9dd8f702012-04-07 10:42:50 +0100339 self.input = input
José Fonseca6fac5ae2010-11-29 16:09:13 +0000340 self.output = output
341 self.index = None
342
343 def __str__(self):
344 return '%s %s' % (self.type, self.name)
345
346
José Fonseca9dd8f702012-04-07 10:42:50 +0100347def In(type, name):
348 return Arg(type, name, input=True, output=False)
349
350def Out(type, name):
351 return Arg(type, name, input=False, output=True)
352
353def InOut(type, name):
354 return Arg(type, name, input=True, output=True)
355
356
José Fonseca6fac5ae2010-11-29 16:09:13 +0000357class Function:
358
José Fonseca84cea3b2012-05-09 21:12:30 +0100359 def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, internal=False):
José Fonseca6fac5ae2010-11-29 16:09:13 +0000360 self.type = type
361 self.name = name
362
363 self.args = []
364 index = 0
365 for arg in args:
José Fonseca8384ccb2011-05-25 10:12:02 +0100366 if not isinstance(arg, Arg):
367 if isinstance(arg, tuple):
368 arg_type, arg_name = arg
369 else:
370 arg_type = arg
371 arg_name = "arg%u" % index
José Fonseca6fac5ae2010-11-29 16:09:13 +0000372 arg = Arg(arg_type, arg_name)
373 arg.index = index
374 index += 1
375 self.args.append(arg)
376
377 self.call = call
378 self.fail = fail
379 self.sideeffects = sideeffects
José Fonseca84cea3b2012-05-09 21:12:30 +0100380 self.internal = internal
José Fonseca6fac5ae2010-11-29 16:09:13 +0000381
382 def prototype(self, name=None):
383 if name is not None:
384 name = name.strip()
385 else:
386 name = self.name
387 s = name
388 if self.call:
389 s = self.call + ' ' + s
390 if name.startswith('*'):
391 s = '(' + s + ')'
392 s = self.type.expr + ' ' + s
393 s += "("
394 if self.args:
395 s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
396 else:
397 s += "void"
398 s += ")"
399 return s
400
José Fonseca568ecc22012-01-15 13:57:03 +0000401 def argNames(self):
402 return [arg.name for arg in self.args]
403
José Fonseca999284f2013-02-19 13:29:26 +0000404 def getArgByName(self, name):
405 for arg in self.args:
406 if arg.name == name:
407 return arg
408 return None
409
José Fonseca6fac5ae2010-11-29 16:09:13 +0000410
411def StdFunction(*args, **kwargs):
412 kwargs.setdefault('call', '__stdcall')
413 return Function(*args, **kwargs)
414
415
416def FunctionPointer(type, name, args, **kwargs):
417 # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
418 return Opaque(name)
419
420
421class Interface(Type):
422
423 def __init__(self, name, base=None):
424 Type.__init__(self, name)
425 self.name = name
426 self.base = base
427 self.methods = []
428
429 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000430 return visitor.visitInterface(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000431
José Fonsecabd086342012-04-18 19:58:32 +0100432 def getMethodByName(self, name):
José Fonsecad275d0a2012-04-30 23:18:05 +0100433 for method in self.iterMethods():
434 if method.name == name:
435 return method
José Fonsecabd086342012-04-18 19:58:32 +0100436 return None
437
José Fonseca54f304a2012-01-14 19:33:08 +0000438 def iterMethods(self):
José Fonseca6fac5ae2010-11-29 16:09:13 +0000439 if self.base is not None:
José Fonseca54f304a2012-01-14 19:33:08 +0000440 for method in self.base.iterMethods():
José Fonseca6fac5ae2010-11-29 16:09:13 +0000441 yield method
442 for method in self.methods:
443 yield method
444 raise StopIteration
445
José Fonseca143e9252012-04-15 09:31:18 +0100446 def iterBases(self):
447 iface = self
448 while iface is not None:
449 yield iface
450 iface = iface.base
451 raise StopIteration
452
José Fonseca5abf5602013-05-30 14:00:44 +0100453 def hasBase(self, *bases):
454 for iface in self.iterBases():
455 if iface in bases:
456 return True
457 return False
458
José Fonseca4220b1b2012-02-03 19:05:29 +0000459 def iterBaseMethods(self):
460 if self.base is not None:
461 for iface, method in self.base.iterBaseMethods():
462 yield iface, method
463 for method in self.methods:
464 yield self, method
465 raise StopIteration
466
José Fonseca6fac5ae2010-11-29 16:09:13 +0000467
468class Method(Function):
469
José Fonseca43aa19f2012-11-10 09:29:38 +0000470 def __init__(self, type, name, args, call = '', const=False, sideeffects=True):
471 assert call == '__stdcall'
José Fonseca5b6fb752012-04-14 14:56:45 +0100472 Function.__init__(self, type, name, args, call = call, sideeffects=sideeffects)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000473 for index in range(len(self.args)):
474 self.args[index].index = index + 1
José Fonseca9dbeda62012-02-03 19:05:54 +0000475 self.const = const
476
477 def prototype(self, name=None):
478 s = Function.prototype(self, name)
479 if self.const:
480 s += ' const'
481 return s
José Fonseca6fac5ae2010-11-29 16:09:13 +0000482
José Fonsecabcb26b22012-04-15 08:42:25 +0100483
José Fonseca5b6fb752012-04-14 14:56:45 +0100484def StdMethod(*args, **kwargs):
485 kwargs.setdefault('call', '__stdcall')
486 return Method(*args, **kwargs)
487
José Fonseca6fac5ae2010-11-29 16:09:13 +0000488
José Fonseca6fac5ae2010-11-29 16:09:13 +0000489class String(Type):
José Fonsecabcfc81b2012-08-07 21:07:22 +0100490 '''Human-legible character string.'''
José Fonseca6fac5ae2010-11-29 16:09:13 +0000491
José Fonsecabcfc81b2012-08-07 21:07:22 +0100492 def __init__(self, type = Char, length = None, wide = False):
493 assert isinstance(type, Type)
494 Type.__init__(self, type.expr + ' *')
495 self.type = type
José Fonseca6fac5ae2010-11-29 16:09:13 +0000496 self.length = length
José Fonsecabcfc81b2012-08-07 21:07:22 +0100497 self.wide = wide
José Fonseca6fac5ae2010-11-29 16:09:13 +0000498
499 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000500 return visitor.visitString(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000501
José Fonseca6fac5ae2010-11-29 16:09:13 +0000502
503class Opaque(Type):
504 '''Opaque pointer.'''
505
506 def __init__(self, expr):
507 Type.__init__(self, expr)
508
509 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000510 return visitor.visitOpaque(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000511
512
513def OpaquePointer(type, *args):
514 return Opaque(type.expr + ' *')
515
516def OpaqueArray(type, size):
517 return Opaque(type.expr + ' *')
518
519def OpaqueBlob(type, size):
520 return Opaque(type.expr + ' *')
José Fonseca8a56d142008-07-09 12:18:08 +0900521
José Fonseca501f2862010-11-19 20:41:18 +0000522
José Fonseca16d46dd2011-10-13 09:52:52 +0100523class Polymorphic(Type):
524
José Fonsecaeb216e62012-11-20 11:08:08 +0000525 def __init__(self, switchExpr, switchTypes, defaultType=None, contextLess=True):
526 if defaultType is None:
527 Type.__init__(self, None)
528 contextLess = False
529 else:
530 Type.__init__(self, defaultType.expr)
José Fonseca54f304a2012-01-14 19:33:08 +0000531 self.switchExpr = switchExpr
532 self.switchTypes = switchTypes
José Fonsecab95e3722012-04-16 14:01:15 +0100533 self.defaultType = defaultType
534 self.contextLess = contextLess
José Fonseca16d46dd2011-10-13 09:52:52 +0100535
536 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000537 return visitor.visitPolymorphic(self, *args, **kwargs)
José Fonseca16d46dd2011-10-13 09:52:52 +0100538
José Fonseca54f304a2012-01-14 19:33:08 +0000539 def iterSwitch(self):
José Fonsecaeb216e62012-11-20 11:08:08 +0000540 cases = []
541 types = []
542
543 if self.defaultType is not None:
544 cases.append(['default'])
545 types.append(self.defaultType)
José Fonseca46161112011-10-14 10:04:55 +0100546
José Fonseca54f304a2012-01-14 19:33:08 +0000547 for expr, type in self.switchTypes:
José Fonseca46161112011-10-14 10:04:55 +0100548 case = 'case %s' % expr
549 try:
550 i = types.index(type)
551 except ValueError:
552 cases.append([case])
553 types.append(type)
554 else:
555 cases[i].append(case)
556
557 return zip(cases, types)
558
José Fonseca16d46dd2011-10-13 09:52:52 +0100559
José Fonsecab95e3722012-04-16 14:01:15 +0100560def EnumPolymorphic(enumName, switchExpr, switchTypes, defaultType, contextLess=True):
561 enumValues = [expr for expr, type in switchTypes]
562 enum = Enum(enumName, enumValues)
563 polymorphic = Polymorphic(switchExpr, switchTypes, defaultType, contextLess)
564 return enum, polymorphic
565
566
José Fonseca501f2862010-11-19 20:41:18 +0000567class Visitor:
José Fonseca9c4a2572012-01-13 23:21:10 +0000568 '''Abstract visitor for the type hierarchy.'''
José Fonseca501f2862010-11-19 20:41:18 +0000569
570 def visit(self, type, *args, **kwargs):
571 return type.visit(self, *args, **kwargs)
572
José Fonseca54f304a2012-01-14 19:33:08 +0000573 def visitVoid(self, void, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000574 raise NotImplementedError
575
José Fonseca54f304a2012-01-14 19:33:08 +0000576 def visitLiteral(self, literal, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000577 raise NotImplementedError
578
José Fonseca54f304a2012-01-14 19:33:08 +0000579 def visitString(self, string, *args, **kwargs):
José Fonseca2defc982010-11-22 16:59:10 +0000580 raise NotImplementedError
581
José Fonseca54f304a2012-01-14 19:33:08 +0000582 def visitConst(self, const, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000583 raise NotImplementedError
584
José Fonseca54f304a2012-01-14 19:33:08 +0000585 def visitStruct(self, struct, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000586 raise NotImplementedError
587
José Fonseca54f304a2012-01-14 19:33:08 +0000588 def visitArray(self, array, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000589 raise NotImplementedError
590
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200591 def visitAttribArray(self, array, *args, **kwargs):
592 raise NotImplementedError
593
José Fonseca54f304a2012-01-14 19:33:08 +0000594 def visitBlob(self, blob, *args, **kwargs):
José Fonseca885f2652010-11-20 11:22:25 +0000595 raise NotImplementedError
596
José Fonseca54f304a2012-01-14 19:33:08 +0000597 def visitEnum(self, enum, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000598 raise NotImplementedError
599
José Fonseca54f304a2012-01-14 19:33:08 +0000600 def visitBitmask(self, bitmask, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000601 raise NotImplementedError
602
José Fonseca54f304a2012-01-14 19:33:08 +0000603 def visitPointer(self, pointer, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000604 raise NotImplementedError
605
José Fonseca59ee88e2012-01-15 14:24:10 +0000606 def visitIntPointer(self, pointer, *args, **kwargs):
607 raise NotImplementedError
608
José Fonsecafbcf6832012-04-05 07:10:30 +0100609 def visitObjPointer(self, pointer, *args, **kwargs):
610 raise NotImplementedError
611
José Fonseca59ee88e2012-01-15 14:24:10 +0000612 def visitLinearPointer(self, pointer, *args, **kwargs):
613 raise NotImplementedError
614
José Fonsecab89c5932012-04-01 22:47:11 +0200615 def visitReference(self, reference, *args, **kwargs):
616 raise NotImplementedError
617
José Fonseca54f304a2012-01-14 19:33:08 +0000618 def visitHandle(self, handle, *args, **kwargs):
José Fonseca50d78d82010-11-23 22:13:14 +0000619 raise NotImplementedError
620
José Fonseca54f304a2012-01-14 19:33:08 +0000621 def visitAlias(self, alias, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000622 raise NotImplementedError
623
José Fonseca54f304a2012-01-14 19:33:08 +0000624 def visitOpaque(self, opaque, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000625 raise NotImplementedError
626
José Fonseca54f304a2012-01-14 19:33:08 +0000627 def visitInterface(self, interface, *args, **kwargs):
José Fonsecac356d6a2010-11-23 14:27:25 +0000628 raise NotImplementedError
629
José Fonseca54f304a2012-01-14 19:33:08 +0000630 def visitPolymorphic(self, polymorphic, *args, **kwargs):
José Fonseca16d46dd2011-10-13 09:52:52 +0100631 raise NotImplementedError
José Fonseca54f304a2012-01-14 19:33:08 +0000632 #return self.visit(polymorphic.defaultType, *args, **kwargs)
José Fonseca16d46dd2011-10-13 09:52:52 +0100633
José Fonsecac356d6a2010-11-23 14:27:25 +0000634
635class OnceVisitor(Visitor):
José Fonseca9c4a2572012-01-13 23:21:10 +0000636 '''Visitor that guarantees that each type is visited only once.'''
José Fonsecac356d6a2010-11-23 14:27:25 +0000637
638 def __init__(self):
639 self.__visited = set()
640
641 def visit(self, type, *args, **kwargs):
642 if type not in self.__visited:
643 self.__visited.add(type)
644 return type.visit(self, *args, **kwargs)
645 return None
646
José Fonseca501f2862010-11-19 20:41:18 +0000647
José Fonsecac9edb832010-11-20 09:03:10 +0000648class Rebuilder(Visitor):
José Fonseca9c4a2572012-01-13 23:21:10 +0000649 '''Visitor which rebuild types as it visits them.
650
651 By itself it is a no-op -- it is intended to be overwritten.
652 '''
José Fonsecac9edb832010-11-20 09:03:10 +0000653
José Fonseca54f304a2012-01-14 19:33:08 +0000654 def visitVoid(self, void):
José Fonsecac9edb832010-11-20 09:03:10 +0000655 return void
656
José Fonseca54f304a2012-01-14 19:33:08 +0000657 def visitLiteral(self, literal):
José Fonsecac9edb832010-11-20 09:03:10 +0000658 return literal
659
José Fonseca54f304a2012-01-14 19:33:08 +0000660 def visitString(self, string):
José Fonsecabcfc81b2012-08-07 21:07:22 +0100661 string_type = self.visit(string.type)
662 if string_type is string.type:
663 return string
664 else:
665 return String(string_type, string.length, string.wide)
José Fonseca2defc982010-11-22 16:59:10 +0000666
José Fonseca54f304a2012-01-14 19:33:08 +0000667 def visitConst(self, const):
José Fonsecaf182eda2012-04-05 19:59:56 +0100668 const_type = self.visit(const.type)
669 if const_type is const.type:
670 return const
671 else:
672 return Const(const_type)
José Fonsecac9edb832010-11-20 09:03:10 +0000673
José Fonseca54f304a2012-01-14 19:33:08 +0000674 def visitStruct(self, struct):
José Fonseca06aa2842011-05-05 07:55:54 +0100675 members = [(self.visit(type), name) for type, name in struct.members]
José Fonsecac9edb832010-11-20 09:03:10 +0000676 return Struct(struct.name, members)
677
José Fonseca54f304a2012-01-14 19:33:08 +0000678 def visitArray(self, array):
José Fonsecac9edb832010-11-20 09:03:10 +0000679 type = self.visit(array.type)
680 return Array(type, array.length)
681
José Fonseca54f304a2012-01-14 19:33:08 +0000682 def visitBlob(self, blob):
José Fonseca885f2652010-11-20 11:22:25 +0000683 type = self.visit(blob.type)
684 return Blob(type, blob.size)
685
José Fonseca54f304a2012-01-14 19:33:08 +0000686 def visitEnum(self, enum):
José Fonsecac9edb832010-11-20 09:03:10 +0000687 return enum
688
José Fonseca54f304a2012-01-14 19:33:08 +0000689 def visitBitmask(self, bitmask):
José Fonsecac9edb832010-11-20 09:03:10 +0000690 type = self.visit(bitmask.type)
691 return Bitmask(type, bitmask.values)
692
José Fonseca54f304a2012-01-14 19:33:08 +0000693 def visitPointer(self, pointer):
José Fonsecaf182eda2012-04-05 19:59:56 +0100694 pointer_type = self.visit(pointer.type)
695 if pointer_type is pointer.type:
696 return pointer
697 else:
698 return Pointer(pointer_type)
José Fonsecac9edb832010-11-20 09:03:10 +0000699
José Fonseca59ee88e2012-01-15 14:24:10 +0000700 def visitIntPointer(self, pointer):
701 return pointer
702
José Fonsecafbcf6832012-04-05 07:10:30 +0100703 def visitObjPointer(self, pointer):
José Fonsecaf182eda2012-04-05 19:59:56 +0100704 pointer_type = self.visit(pointer.type)
705 if pointer_type is pointer.type:
706 return pointer
707 else:
708 return ObjPointer(pointer_type)
José Fonsecafbcf6832012-04-05 07:10:30 +0100709
José Fonseca59ee88e2012-01-15 14:24:10 +0000710 def visitLinearPointer(self, pointer):
José Fonsecaf182eda2012-04-05 19:59:56 +0100711 pointer_type = self.visit(pointer.type)
712 if pointer_type is pointer.type:
713 return pointer
714 else:
715 return LinearPointer(pointer_type)
José Fonseca59ee88e2012-01-15 14:24:10 +0000716
José Fonsecab89c5932012-04-01 22:47:11 +0200717 def visitReference(self, reference):
José Fonsecaf182eda2012-04-05 19:59:56 +0100718 reference_type = self.visit(reference.type)
719 if reference_type is reference.type:
720 return reference
721 else:
722 return Reference(reference_type)
José Fonsecab89c5932012-04-01 22:47:11 +0200723
José Fonseca54f304a2012-01-14 19:33:08 +0000724 def visitHandle(self, handle):
José Fonsecaf182eda2012-04-05 19:59:56 +0100725 handle_type = self.visit(handle.type)
726 if handle_type is handle.type:
727 return handle
728 else:
729 return Handle(handle.name, handle_type, range=handle.range, key=handle.key)
José Fonseca50d78d82010-11-23 22:13:14 +0000730
José Fonseca54f304a2012-01-14 19:33:08 +0000731 def visitAlias(self, alias):
José Fonsecaf182eda2012-04-05 19:59:56 +0100732 alias_type = self.visit(alias.type)
733 if alias_type is alias.type:
734 return alias
735 else:
736 return Alias(alias.expr, alias_type)
José Fonsecac9edb832010-11-20 09:03:10 +0000737
José Fonseca54f304a2012-01-14 19:33:08 +0000738 def visitOpaque(self, opaque):
José Fonsecac9edb832010-11-20 09:03:10 +0000739 return opaque
740
José Fonseca7814edf2012-01-31 10:55:49 +0000741 def visitInterface(self, interface, *args, **kwargs):
742 return interface
743
José Fonseca54f304a2012-01-14 19:33:08 +0000744 def visitPolymorphic(self, polymorphic):
José Fonseca54f304a2012-01-14 19:33:08 +0000745 switchExpr = polymorphic.switchExpr
746 switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
José Fonsecaeb216e62012-11-20 11:08:08 +0000747 if polymorphic.defaultType is None:
748 defaultType = None
749 else:
750 defaultType = self.visit(polymorphic.defaultType)
José Fonsecab95e3722012-04-16 14:01:15 +0100751 return Polymorphic(switchExpr, switchTypes, defaultType, polymorphic.contextLess)
José Fonseca16d46dd2011-10-13 09:52:52 +0100752
José Fonsecac9edb832010-11-20 09:03:10 +0000753
José Fonseca0075f152012-04-14 20:25:52 +0100754class MutableRebuilder(Rebuilder):
755 '''Type visitor which derives a mutable type.'''
756
José Fonsecabcfc81b2012-08-07 21:07:22 +0100757 def visitString(self, string):
758 return string
759
José Fonseca0075f152012-04-14 20:25:52 +0100760 def visitConst(self, const):
761 # Strip out const qualifier
762 return const.type
763
764 def visitAlias(self, alias):
765 # Tear the alias on type changes
766 type = self.visit(alias.type)
767 if type is alias.type:
768 return alias
769 return type
770
771 def visitReference(self, reference):
772 # Strip out references
773 return reference.type
774
775
776class Traverser(Visitor):
777 '''Visitor which all types.'''
778
779 def visitVoid(self, void, *args, **kwargs):
780 pass
781
782 def visitLiteral(self, literal, *args, **kwargs):
783 pass
784
785 def visitString(self, string, *args, **kwargs):
786 pass
787
788 def visitConst(self, const, *args, **kwargs):
789 self.visit(const.type, *args, **kwargs)
790
791 def visitStruct(self, struct, *args, **kwargs):
792 for type, name in struct.members:
793 self.visit(type, *args, **kwargs)
794
795 def visitArray(self, array, *args, **kwargs):
796 self.visit(array.type, *args, **kwargs)
797
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200798 def visitAttribArray(self, attribs, *args, **kwargs):
799 for key, valueType in attribs.valueTypes:
Andreas Hartmetz7a0de292013-07-09 22:38:29 +0200800 if valueType is not None:
801 self.visit(valueType, *args, **kwargs)
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200802
José Fonseca0075f152012-04-14 20:25:52 +0100803 def visitBlob(self, array, *args, **kwargs):
804 pass
805
806 def visitEnum(self, enum, *args, **kwargs):
807 pass
808
809 def visitBitmask(self, bitmask, *args, **kwargs):
810 self.visit(bitmask.type, *args, **kwargs)
811
812 def visitPointer(self, pointer, *args, **kwargs):
813 self.visit(pointer.type, *args, **kwargs)
814
815 def visitIntPointer(self, pointer, *args, **kwargs):
816 pass
817
818 def visitObjPointer(self, pointer, *args, **kwargs):
819 self.visit(pointer.type, *args, **kwargs)
820
821 def visitLinearPointer(self, pointer, *args, **kwargs):
822 self.visit(pointer.type, *args, **kwargs)
823
824 def visitReference(self, reference, *args, **kwargs):
825 self.visit(reference.type, *args, **kwargs)
826
827 def visitHandle(self, handle, *args, **kwargs):
828 self.visit(handle.type, *args, **kwargs)
829
830 def visitAlias(self, alias, *args, **kwargs):
831 self.visit(alias.type, *args, **kwargs)
832
833 def visitOpaque(self, opaque, *args, **kwargs):
834 pass
835
836 def visitInterface(self, interface, *args, **kwargs):
837 if interface.base is not None:
838 self.visit(interface.base, *args, **kwargs)
839 for method in interface.iterMethods():
840 for arg in method.args:
841 self.visit(arg.type, *args, **kwargs)
842 self.visit(method.type, *args, **kwargs)
843
844 def visitPolymorphic(self, polymorphic, *args, **kwargs):
José Fonseca0075f152012-04-14 20:25:52 +0100845 for expr, type in polymorphic.switchTypes:
846 self.visit(type, *args, **kwargs)
José Fonsecaeb216e62012-11-20 11:08:08 +0000847 if polymorphic.defaultType is not None:
848 self.visit(polymorphic.defaultType, *args, **kwargs)
José Fonseca0075f152012-04-14 20:25:52 +0100849
850
851class Collector(Traverser):
José Fonseca9c4a2572012-01-13 23:21:10 +0000852 '''Visitor which collects all unique types as it traverses them.'''
José Fonsecae6a50bd2010-11-24 10:12:22 +0000853
854 def __init__(self):
855 self.__visited = set()
856 self.types = []
857
858 def visit(self, type):
859 if type in self.__visited:
860 return
861 self.__visited.add(type)
862 Visitor.visit(self, type)
863 self.types.append(type)
864
José Fonseca16d46dd2011-10-13 09:52:52 +0100865
José Fonsecadbf714b2012-11-20 17:03:43 +0000866class ExpanderMixin:
867 '''Mixin class that provides a bunch of methods to expand C expressions
868 from the specifications.'''
869
870 __structs = None
871 __indices = None
872
873 def expand(self, expr):
874 # Expand a C expression, replacing certain variables
875 if not isinstance(expr, basestring):
876 return expr
877 variables = {}
878
879 if self.__structs is not None:
880 variables['self'] = '(%s)' % self.__structs[0]
881 if self.__indices is not None:
882 variables['i'] = self.__indices[0]
883
884 expandedExpr = expr.format(**variables)
885 if expandedExpr != expr and 0:
886 sys.stderr.write(" %r -> %r\n" % (expr, expandedExpr))
887 return expandedExpr
888
889 def visitMember(self, member, structInstance, *args, **kwargs):
890 memberType, memberName = member
891 if memberName is None:
892 # Anonymous structure/union member
893 memberInstance = structInstance
894 else:
895 memberInstance = '(%s).%s' % (structInstance, memberName)
896 self.__structs = (structInstance, self.__structs)
897 try:
898 return self.visit(memberType, memberInstance, *args, **kwargs)
899 finally:
900 _, self.__structs = self.__structs
901
902 def visitElement(self, elementIndex, elementType, *args, **kwargs):
903 self.__indices = (elementIndex, self.__indices)
904 try:
905 return self.visit(elementType, *args, **kwargs)
906 finally:
907 _, self.__indices = self.__indices
908
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000909
José Fonseca81301932012-11-11 00:10:20 +0000910class Module:
911 '''A collection of functions.'''
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000912
José Fonseca68ec4122011-02-20 11:25:25 +0000913 def __init__(self, name = None):
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000914 self.name = name
915 self.headers = []
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000916 self.functions = []
917 self.interfaces = []
918
José Fonseca54f304a2012-01-14 19:33:08 +0000919 def addFunctions(self, functions):
José Fonseca81301932012-11-11 00:10:20 +0000920 self.functions.extend(functions)
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000921
José Fonseca54f304a2012-01-14 19:33:08 +0000922 def addInterfaces(self, interfaces):
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000923 self.interfaces.extend(interfaces)
924
José Fonseca81301932012-11-11 00:10:20 +0000925 def mergeModule(self, module):
926 self.headers.extend(module.headers)
927 self.functions.extend(module.functions)
928 self.interfaces.extend(module.interfaces)
José Fonseca68ec4122011-02-20 11:25:25 +0000929
José Fonseca1b6c8752012-04-15 14:33:00 +0100930 def getFunctionByName(self, name):
José Fonsecaeccec3e2011-02-20 09:01:25 +0000931 for function in self.functions:
932 if function.name == name:
933 return function
934 return None
935
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000936
José Fonseca81301932012-11-11 00:10:20 +0000937class API:
938 '''API abstraction.
939
940 Essentially, a collection of types, functions, and interfaces.
941 '''
942
943 def __init__(self, modules = None):
944 self.modules = []
945 if modules is not None:
946 self.modules.extend(modules)
947
948 def getAllTypes(self):
949 collector = Collector()
950 for module in self.modules:
951 for function in module.functions:
952 for arg in function.args:
953 collector.visit(arg.type)
954 collector.visit(function.type)
955 for interface in module.interfaces:
956 collector.visit(interface)
957 for method in interface.iterMethods():
958 for arg in method.args:
959 collector.visit(arg.type)
960 collector.visit(method.type)
961 return collector.types
962
963 def getAllFunctions(self):
964 functions = []
965 for module in self.modules:
966 functions.extend(module.functions)
967 return functions
968
969 def getAllInterfaces(self):
970 types = self.getAllTypes()
971 interfaces = [type for type in types if isinstance(type, Interface)]
972 for module in self.modules:
973 for interface in module.interfaces:
974 if interface not in interfaces:
975 interfaces.append(interface)
976 return interfaces
977
978 def addModule(self, module):
979 self.modules.append(module)
980
981 def getFunctionByName(self, name):
982 for module in self.modules:
983 for function in module.functions:
984 if function.name == name:
985 return function
986 return None
987
988
José Fonseca280a1762012-01-31 15:10:13 +0000989# C string (i.e., zero terminated)
José Fonsecabcfc81b2012-08-07 21:07:22 +0100990CString = String(Char)
991WString = String(WChar, wide=True)
992ConstCString = String(Const(Char))
993ConstWString = String(Const(WChar), wide=True)