blob: 5cf1a37def1295c08620014332487f5539298876 [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
Andreas Hartmetzedea8992013-07-12 11:37:35 +0200275 def __init__(self, keyType, valueTypes, isConst = True, punType = None, terminator = '0'):
276 self.baseType = Int
277 if punType is not None:
278 self.baseType = punType
Andreas Hartmetzb936e552013-07-08 12:36:11 +0200279 if isConst:
Andreas Hartmetzedea8992013-07-12 11:37:35 +0200280 Type.__init__(self, (Pointer(Const(self.baseType))).expr)
Andreas Hartmetzb936e552013-07-08 12:36:11 +0200281 else:
Andreas Hartmetzedea8992013-07-12 11:37:35 +0200282 Type.__init__(self, (Pointer(self.baseType)).expr)
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200283 self.keyType = keyType
284 self.valueTypes = valueTypes
Andreas Hartmetz7a0de292013-07-09 22:38:29 +0200285 self.terminator = terminator
286 self.hasKeysWithoutValues = False
287 for key, value in valueTypes:
288 if value is None:
289 self.hasKeysWithoutValues = True
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200290
291 def visit(self, visitor, *args, **kwargs):
292 return visitor.visitAttribArray(self, *args, **kwargs)
293
294
José Fonseca6fac5ae2010-11-29 16:09:13 +0000295class Blob(Type):
296
297 def __init__(self, type, size):
298 Type.__init__(self, type.expr + ' *')
299 self.type = type
300 self.size = size
301
302 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000303 return visitor.visitBlob(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000304
305
306class Struct(Type):
307
José Fonseca02c25002011-10-15 13:17:26 +0100308 __id = 0
309
José Fonseca6fac5ae2010-11-29 16:09:13 +0000310 def __init__(self, name, members):
311 Type.__init__(self, name)
José Fonseca02c25002011-10-15 13:17:26 +0100312
313 self.id = Struct.__id
314 Struct.__id += 1
315
José Fonseca6fac5ae2010-11-29 16:09:13 +0000316 self.name = name
José Fonsecadbf714b2012-11-20 17:03:43 +0000317 self.members = members
José Fonseca6fac5ae2010-11-29 16:09:13 +0000318
319 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000320 return visitor.visitStruct(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000321
322
José Fonsecadbf714b2012-11-20 17:03:43 +0000323def Union(kindExpr, kindTypes, contextLess=True):
José Fonsecaeb216e62012-11-20 11:08:08 +0000324 switchTypes = []
325 for kindCase, kindType, kindMemberName in kindTypes:
326 switchType = Struct(None, [(kindType, kindMemberName)])
327 switchTypes.append((kindCase, switchType))
328 return Polymorphic(kindExpr, switchTypes, contextLess=contextLess)
329
José Fonseca5b6fb752012-04-14 14:56:45 +0100330
José Fonseca6fac5ae2010-11-29 16:09:13 +0000331class Alias(Type):
332
333 def __init__(self, expr, type):
334 Type.__init__(self, expr)
335 self.type = type
336
337 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000338 return visitor.visitAlias(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000339
José Fonseca6fac5ae2010-11-29 16:09:13 +0000340class Arg:
341
José Fonseca9dd8f702012-04-07 10:42:50 +0100342 def __init__(self, type, name, input=True, output=False):
José Fonseca6fac5ae2010-11-29 16:09:13 +0000343 self.type = type
344 self.name = name
José Fonseca9dd8f702012-04-07 10:42:50 +0100345 self.input = input
José Fonseca6fac5ae2010-11-29 16:09:13 +0000346 self.output = output
347 self.index = None
348
349 def __str__(self):
350 return '%s %s' % (self.type, self.name)
351
352
José Fonseca9dd8f702012-04-07 10:42:50 +0100353def In(type, name):
354 return Arg(type, name, input=True, output=False)
355
356def Out(type, name):
357 return Arg(type, name, input=False, output=True)
358
359def InOut(type, name):
360 return Arg(type, name, input=True, output=True)
361
362
José Fonseca6fac5ae2010-11-29 16:09:13 +0000363class Function:
364
José Fonseca84cea3b2012-05-09 21:12:30 +0100365 def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, internal=False):
José Fonseca6fac5ae2010-11-29 16:09:13 +0000366 self.type = type
367 self.name = name
368
369 self.args = []
370 index = 0
371 for arg in args:
José Fonseca8384ccb2011-05-25 10:12:02 +0100372 if not isinstance(arg, Arg):
373 if isinstance(arg, tuple):
374 arg_type, arg_name = arg
375 else:
376 arg_type = arg
377 arg_name = "arg%u" % index
José Fonseca6fac5ae2010-11-29 16:09:13 +0000378 arg = Arg(arg_type, arg_name)
379 arg.index = index
380 index += 1
381 self.args.append(arg)
382
383 self.call = call
384 self.fail = fail
385 self.sideeffects = sideeffects
José Fonseca84cea3b2012-05-09 21:12:30 +0100386 self.internal = internal
José Fonseca6fac5ae2010-11-29 16:09:13 +0000387
388 def prototype(self, name=None):
389 if name is not None:
390 name = name.strip()
391 else:
392 name = self.name
393 s = name
394 if self.call:
395 s = self.call + ' ' + s
396 if name.startswith('*'):
397 s = '(' + s + ')'
398 s = self.type.expr + ' ' + s
399 s += "("
400 if self.args:
401 s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
402 else:
403 s += "void"
404 s += ")"
405 return s
406
José Fonseca568ecc22012-01-15 13:57:03 +0000407 def argNames(self):
408 return [arg.name for arg in self.args]
409
José Fonseca999284f2013-02-19 13:29:26 +0000410 def getArgByName(self, name):
411 for arg in self.args:
412 if arg.name == name:
413 return arg
414 return None
415
José Fonseca6fac5ae2010-11-29 16:09:13 +0000416
417def StdFunction(*args, **kwargs):
418 kwargs.setdefault('call', '__stdcall')
419 return Function(*args, **kwargs)
420
421
422def FunctionPointer(type, name, args, **kwargs):
423 # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
424 return Opaque(name)
425
426
427class Interface(Type):
428
429 def __init__(self, name, base=None):
430 Type.__init__(self, name)
431 self.name = name
432 self.base = base
433 self.methods = []
434
435 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000436 return visitor.visitInterface(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000437
José Fonsecabd086342012-04-18 19:58:32 +0100438 def getMethodByName(self, name):
José Fonsecad275d0a2012-04-30 23:18:05 +0100439 for method in self.iterMethods():
440 if method.name == name:
441 return method
José Fonsecabd086342012-04-18 19:58:32 +0100442 return None
443
José Fonseca54f304a2012-01-14 19:33:08 +0000444 def iterMethods(self):
José Fonseca6fac5ae2010-11-29 16:09:13 +0000445 if self.base is not None:
José Fonseca54f304a2012-01-14 19:33:08 +0000446 for method in self.base.iterMethods():
José Fonseca6fac5ae2010-11-29 16:09:13 +0000447 yield method
448 for method in self.methods:
449 yield method
450 raise StopIteration
451
José Fonseca143e9252012-04-15 09:31:18 +0100452 def iterBases(self):
453 iface = self
454 while iface is not None:
455 yield iface
456 iface = iface.base
457 raise StopIteration
458
José Fonseca5abf5602013-05-30 14:00:44 +0100459 def hasBase(self, *bases):
460 for iface in self.iterBases():
461 if iface in bases:
462 return True
463 return False
464
José Fonseca4220b1b2012-02-03 19:05:29 +0000465 def iterBaseMethods(self):
466 if self.base is not None:
467 for iface, method in self.base.iterBaseMethods():
468 yield iface, method
469 for method in self.methods:
470 yield self, method
471 raise StopIteration
472
José Fonseca6fac5ae2010-11-29 16:09:13 +0000473
474class Method(Function):
475
José Fonseca43aa19f2012-11-10 09:29:38 +0000476 def __init__(self, type, name, args, call = '', const=False, sideeffects=True):
477 assert call == '__stdcall'
José Fonseca5b6fb752012-04-14 14:56:45 +0100478 Function.__init__(self, type, name, args, call = call, sideeffects=sideeffects)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000479 for index in range(len(self.args)):
480 self.args[index].index = index + 1
José Fonseca9dbeda62012-02-03 19:05:54 +0000481 self.const = const
482
483 def prototype(self, name=None):
484 s = Function.prototype(self, name)
485 if self.const:
486 s += ' const'
487 return s
José Fonseca6fac5ae2010-11-29 16:09:13 +0000488
José Fonsecabcb26b22012-04-15 08:42:25 +0100489
José Fonseca5b6fb752012-04-14 14:56:45 +0100490def StdMethod(*args, **kwargs):
491 kwargs.setdefault('call', '__stdcall')
492 return Method(*args, **kwargs)
493
José Fonseca6fac5ae2010-11-29 16:09:13 +0000494
José Fonseca6fac5ae2010-11-29 16:09:13 +0000495class String(Type):
José Fonsecabcfc81b2012-08-07 21:07:22 +0100496 '''Human-legible character string.'''
José Fonseca6fac5ae2010-11-29 16:09:13 +0000497
José Fonsecabcfc81b2012-08-07 21:07:22 +0100498 def __init__(self, type = Char, length = None, wide = False):
499 assert isinstance(type, Type)
500 Type.__init__(self, type.expr + ' *')
501 self.type = type
José Fonseca6fac5ae2010-11-29 16:09:13 +0000502 self.length = length
José Fonsecabcfc81b2012-08-07 21:07:22 +0100503 self.wide = wide
José Fonseca6fac5ae2010-11-29 16:09:13 +0000504
505 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000506 return visitor.visitString(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000507
José Fonseca6fac5ae2010-11-29 16:09:13 +0000508
509class Opaque(Type):
510 '''Opaque pointer.'''
511
512 def __init__(self, expr):
513 Type.__init__(self, expr)
514
515 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000516 return visitor.visitOpaque(self, *args, **kwargs)
José Fonseca6fac5ae2010-11-29 16:09:13 +0000517
518
519def OpaquePointer(type, *args):
520 return Opaque(type.expr + ' *')
521
522def OpaqueArray(type, size):
523 return Opaque(type.expr + ' *')
524
525def OpaqueBlob(type, size):
526 return Opaque(type.expr + ' *')
José Fonseca8a56d142008-07-09 12:18:08 +0900527
José Fonseca501f2862010-11-19 20:41:18 +0000528
José Fonseca16d46dd2011-10-13 09:52:52 +0100529class Polymorphic(Type):
530
José Fonsecaeb216e62012-11-20 11:08:08 +0000531 def __init__(self, switchExpr, switchTypes, defaultType=None, contextLess=True):
532 if defaultType is None:
533 Type.__init__(self, None)
534 contextLess = False
535 else:
536 Type.__init__(self, defaultType.expr)
José Fonseca54f304a2012-01-14 19:33:08 +0000537 self.switchExpr = switchExpr
538 self.switchTypes = switchTypes
José Fonsecab95e3722012-04-16 14:01:15 +0100539 self.defaultType = defaultType
540 self.contextLess = contextLess
José Fonseca16d46dd2011-10-13 09:52:52 +0100541
542 def visit(self, visitor, *args, **kwargs):
José Fonseca54f304a2012-01-14 19:33:08 +0000543 return visitor.visitPolymorphic(self, *args, **kwargs)
José Fonseca16d46dd2011-10-13 09:52:52 +0100544
José Fonseca54f304a2012-01-14 19:33:08 +0000545 def iterSwitch(self):
José Fonsecaeb216e62012-11-20 11:08:08 +0000546 cases = []
547 types = []
548
549 if self.defaultType is not None:
550 cases.append(['default'])
551 types.append(self.defaultType)
José Fonseca46161112011-10-14 10:04:55 +0100552
José Fonseca54f304a2012-01-14 19:33:08 +0000553 for expr, type in self.switchTypes:
José Fonseca46161112011-10-14 10:04:55 +0100554 case = 'case %s' % expr
555 try:
556 i = types.index(type)
557 except ValueError:
558 cases.append([case])
559 types.append(type)
560 else:
561 cases[i].append(case)
562
563 return zip(cases, types)
564
José Fonseca16d46dd2011-10-13 09:52:52 +0100565
José Fonsecab95e3722012-04-16 14:01:15 +0100566def EnumPolymorphic(enumName, switchExpr, switchTypes, defaultType, contextLess=True):
567 enumValues = [expr for expr, type in switchTypes]
568 enum = Enum(enumName, enumValues)
569 polymorphic = Polymorphic(switchExpr, switchTypes, defaultType, contextLess)
570 return enum, polymorphic
571
572
José Fonseca501f2862010-11-19 20:41:18 +0000573class Visitor:
José Fonseca9c4a2572012-01-13 23:21:10 +0000574 '''Abstract visitor for the type hierarchy.'''
José Fonseca501f2862010-11-19 20:41:18 +0000575
576 def visit(self, type, *args, **kwargs):
577 return type.visit(self, *args, **kwargs)
578
José Fonseca54f304a2012-01-14 19:33:08 +0000579 def visitVoid(self, void, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000580 raise NotImplementedError
581
José Fonseca54f304a2012-01-14 19:33:08 +0000582 def visitLiteral(self, literal, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000583 raise NotImplementedError
584
José Fonseca54f304a2012-01-14 19:33:08 +0000585 def visitString(self, string, *args, **kwargs):
José Fonseca2defc982010-11-22 16:59:10 +0000586 raise NotImplementedError
587
José Fonseca54f304a2012-01-14 19:33:08 +0000588 def visitConst(self, const, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000589 raise NotImplementedError
590
José Fonseca54f304a2012-01-14 19:33:08 +0000591 def visitStruct(self, struct, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000592 raise NotImplementedError
593
José Fonseca54f304a2012-01-14 19:33:08 +0000594 def visitArray(self, array, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000595 raise NotImplementedError
596
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200597 def visitAttribArray(self, array, *args, **kwargs):
598 raise NotImplementedError
599
José Fonseca54f304a2012-01-14 19:33:08 +0000600 def visitBlob(self, blob, *args, **kwargs):
José Fonseca885f2652010-11-20 11:22:25 +0000601 raise NotImplementedError
602
José Fonseca54f304a2012-01-14 19:33:08 +0000603 def visitEnum(self, enum, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000604 raise NotImplementedError
605
José Fonseca54f304a2012-01-14 19:33:08 +0000606 def visitBitmask(self, bitmask, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000607 raise NotImplementedError
608
José Fonseca54f304a2012-01-14 19:33:08 +0000609 def visitPointer(self, pointer, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000610 raise NotImplementedError
611
José Fonseca59ee88e2012-01-15 14:24:10 +0000612 def visitIntPointer(self, pointer, *args, **kwargs):
613 raise NotImplementedError
614
José Fonsecafbcf6832012-04-05 07:10:30 +0100615 def visitObjPointer(self, pointer, *args, **kwargs):
616 raise NotImplementedError
617
José Fonseca59ee88e2012-01-15 14:24:10 +0000618 def visitLinearPointer(self, pointer, *args, **kwargs):
619 raise NotImplementedError
620
José Fonsecab89c5932012-04-01 22:47:11 +0200621 def visitReference(self, reference, *args, **kwargs):
622 raise NotImplementedError
623
José Fonseca54f304a2012-01-14 19:33:08 +0000624 def visitHandle(self, handle, *args, **kwargs):
José Fonseca50d78d82010-11-23 22:13:14 +0000625 raise NotImplementedError
626
José Fonseca54f304a2012-01-14 19:33:08 +0000627 def visitAlias(self, alias, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000628 raise NotImplementedError
629
José Fonseca54f304a2012-01-14 19:33:08 +0000630 def visitOpaque(self, opaque, *args, **kwargs):
José Fonseca501f2862010-11-19 20:41:18 +0000631 raise NotImplementedError
632
José Fonseca54f304a2012-01-14 19:33:08 +0000633 def visitInterface(self, interface, *args, **kwargs):
José Fonsecac356d6a2010-11-23 14:27:25 +0000634 raise NotImplementedError
635
José Fonseca54f304a2012-01-14 19:33:08 +0000636 def visitPolymorphic(self, polymorphic, *args, **kwargs):
José Fonseca16d46dd2011-10-13 09:52:52 +0100637 raise NotImplementedError
José Fonseca54f304a2012-01-14 19:33:08 +0000638 #return self.visit(polymorphic.defaultType, *args, **kwargs)
José Fonseca16d46dd2011-10-13 09:52:52 +0100639
José Fonsecac356d6a2010-11-23 14:27:25 +0000640
641class OnceVisitor(Visitor):
José Fonseca9c4a2572012-01-13 23:21:10 +0000642 '''Visitor that guarantees that each type is visited only once.'''
José Fonsecac356d6a2010-11-23 14:27:25 +0000643
644 def __init__(self):
645 self.__visited = set()
646
647 def visit(self, type, *args, **kwargs):
648 if type not in self.__visited:
649 self.__visited.add(type)
650 return type.visit(self, *args, **kwargs)
651 return None
652
José Fonseca501f2862010-11-19 20:41:18 +0000653
José Fonsecac9edb832010-11-20 09:03:10 +0000654class Rebuilder(Visitor):
José Fonseca9c4a2572012-01-13 23:21:10 +0000655 '''Visitor which rebuild types as it visits them.
656
657 By itself it is a no-op -- it is intended to be overwritten.
658 '''
José Fonsecac9edb832010-11-20 09:03:10 +0000659
José Fonseca54f304a2012-01-14 19:33:08 +0000660 def visitVoid(self, void):
José Fonsecac9edb832010-11-20 09:03:10 +0000661 return void
662
José Fonseca54f304a2012-01-14 19:33:08 +0000663 def visitLiteral(self, literal):
José Fonsecac9edb832010-11-20 09:03:10 +0000664 return literal
665
José Fonseca54f304a2012-01-14 19:33:08 +0000666 def visitString(self, string):
José Fonsecabcfc81b2012-08-07 21:07:22 +0100667 string_type = self.visit(string.type)
668 if string_type is string.type:
669 return string
670 else:
671 return String(string_type, string.length, string.wide)
José Fonseca2defc982010-11-22 16:59:10 +0000672
José Fonseca54f304a2012-01-14 19:33:08 +0000673 def visitConst(self, const):
José Fonsecaf182eda2012-04-05 19:59:56 +0100674 const_type = self.visit(const.type)
675 if const_type is const.type:
676 return const
677 else:
678 return Const(const_type)
José Fonsecac9edb832010-11-20 09:03:10 +0000679
José Fonseca54f304a2012-01-14 19:33:08 +0000680 def visitStruct(self, struct):
José Fonseca06aa2842011-05-05 07:55:54 +0100681 members = [(self.visit(type), name) for type, name in struct.members]
José Fonsecac9edb832010-11-20 09:03:10 +0000682 return Struct(struct.name, members)
683
José Fonseca54f304a2012-01-14 19:33:08 +0000684 def visitArray(self, array):
José Fonsecac9edb832010-11-20 09:03:10 +0000685 type = self.visit(array.type)
686 return Array(type, array.length)
687
José Fonseca54f304a2012-01-14 19:33:08 +0000688 def visitBlob(self, blob):
José Fonseca885f2652010-11-20 11:22:25 +0000689 type = self.visit(blob.type)
690 return Blob(type, blob.size)
691
José Fonseca54f304a2012-01-14 19:33:08 +0000692 def visitEnum(self, enum):
José Fonsecac9edb832010-11-20 09:03:10 +0000693 return enum
694
José Fonseca54f304a2012-01-14 19:33:08 +0000695 def visitBitmask(self, bitmask):
José Fonsecac9edb832010-11-20 09:03:10 +0000696 type = self.visit(bitmask.type)
697 return Bitmask(type, bitmask.values)
698
José Fonseca54f304a2012-01-14 19:33:08 +0000699 def visitPointer(self, pointer):
José Fonsecaf182eda2012-04-05 19:59:56 +0100700 pointer_type = self.visit(pointer.type)
701 if pointer_type is pointer.type:
702 return pointer
703 else:
704 return Pointer(pointer_type)
José Fonsecac9edb832010-11-20 09:03:10 +0000705
José Fonseca59ee88e2012-01-15 14:24:10 +0000706 def visitIntPointer(self, pointer):
707 return pointer
708
José Fonsecafbcf6832012-04-05 07:10:30 +0100709 def visitObjPointer(self, pointer):
José Fonsecaf182eda2012-04-05 19:59:56 +0100710 pointer_type = self.visit(pointer.type)
711 if pointer_type is pointer.type:
712 return pointer
713 else:
714 return ObjPointer(pointer_type)
José Fonsecafbcf6832012-04-05 07:10:30 +0100715
José Fonseca59ee88e2012-01-15 14:24:10 +0000716 def visitLinearPointer(self, pointer):
José Fonsecaf182eda2012-04-05 19:59:56 +0100717 pointer_type = self.visit(pointer.type)
718 if pointer_type is pointer.type:
719 return pointer
720 else:
721 return LinearPointer(pointer_type)
José Fonseca59ee88e2012-01-15 14:24:10 +0000722
José Fonsecab89c5932012-04-01 22:47:11 +0200723 def visitReference(self, reference):
José Fonsecaf182eda2012-04-05 19:59:56 +0100724 reference_type = self.visit(reference.type)
725 if reference_type is reference.type:
726 return reference
727 else:
728 return Reference(reference_type)
José Fonsecab89c5932012-04-01 22:47:11 +0200729
José Fonseca54f304a2012-01-14 19:33:08 +0000730 def visitHandle(self, handle):
José Fonsecaf182eda2012-04-05 19:59:56 +0100731 handle_type = self.visit(handle.type)
732 if handle_type is handle.type:
733 return handle
734 else:
735 return Handle(handle.name, handle_type, range=handle.range, key=handle.key)
José Fonseca50d78d82010-11-23 22:13:14 +0000736
José Fonseca54f304a2012-01-14 19:33:08 +0000737 def visitAlias(self, alias):
José Fonsecaf182eda2012-04-05 19:59:56 +0100738 alias_type = self.visit(alias.type)
739 if alias_type is alias.type:
740 return alias
741 else:
742 return Alias(alias.expr, alias_type)
José Fonsecac9edb832010-11-20 09:03:10 +0000743
José Fonseca54f304a2012-01-14 19:33:08 +0000744 def visitOpaque(self, opaque):
José Fonsecac9edb832010-11-20 09:03:10 +0000745 return opaque
746
José Fonseca7814edf2012-01-31 10:55:49 +0000747 def visitInterface(self, interface, *args, **kwargs):
748 return interface
749
José Fonseca54f304a2012-01-14 19:33:08 +0000750 def visitPolymorphic(self, polymorphic):
José Fonseca54f304a2012-01-14 19:33:08 +0000751 switchExpr = polymorphic.switchExpr
752 switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
José Fonsecaeb216e62012-11-20 11:08:08 +0000753 if polymorphic.defaultType is None:
754 defaultType = None
755 else:
756 defaultType = self.visit(polymorphic.defaultType)
José Fonsecab95e3722012-04-16 14:01:15 +0100757 return Polymorphic(switchExpr, switchTypes, defaultType, polymorphic.contextLess)
José Fonseca16d46dd2011-10-13 09:52:52 +0100758
José Fonsecac9edb832010-11-20 09:03:10 +0000759
José Fonseca0075f152012-04-14 20:25:52 +0100760class MutableRebuilder(Rebuilder):
761 '''Type visitor which derives a mutable type.'''
762
José Fonsecabcfc81b2012-08-07 21:07:22 +0100763 def visitString(self, string):
764 return string
765
José Fonseca0075f152012-04-14 20:25:52 +0100766 def visitConst(self, const):
767 # Strip out const qualifier
768 return const.type
769
770 def visitAlias(self, alias):
771 # Tear the alias on type changes
772 type = self.visit(alias.type)
773 if type is alias.type:
774 return alias
775 return type
776
777 def visitReference(self, reference):
778 # Strip out references
779 return reference.type
780
781
782class Traverser(Visitor):
783 '''Visitor which all types.'''
784
785 def visitVoid(self, void, *args, **kwargs):
786 pass
787
788 def visitLiteral(self, literal, *args, **kwargs):
789 pass
790
791 def visitString(self, string, *args, **kwargs):
792 pass
793
794 def visitConst(self, const, *args, **kwargs):
795 self.visit(const.type, *args, **kwargs)
796
797 def visitStruct(self, struct, *args, **kwargs):
798 for type, name in struct.members:
799 self.visit(type, *args, **kwargs)
800
801 def visitArray(self, array, *args, **kwargs):
802 self.visit(array.type, *args, **kwargs)
803
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200804 def visitAttribArray(self, attribs, *args, **kwargs):
805 for key, valueType in attribs.valueTypes:
Andreas Hartmetz7a0de292013-07-09 22:38:29 +0200806 if valueType is not None:
807 self.visit(valueType, *args, **kwargs)
Andreas Hartmetzba7bb0d2013-07-07 22:51:12 +0200808
José Fonseca0075f152012-04-14 20:25:52 +0100809 def visitBlob(self, array, *args, **kwargs):
810 pass
811
812 def visitEnum(self, enum, *args, **kwargs):
813 pass
814
815 def visitBitmask(self, bitmask, *args, **kwargs):
816 self.visit(bitmask.type, *args, **kwargs)
817
818 def visitPointer(self, pointer, *args, **kwargs):
819 self.visit(pointer.type, *args, **kwargs)
820
821 def visitIntPointer(self, pointer, *args, **kwargs):
822 pass
823
824 def visitObjPointer(self, pointer, *args, **kwargs):
825 self.visit(pointer.type, *args, **kwargs)
826
827 def visitLinearPointer(self, pointer, *args, **kwargs):
828 self.visit(pointer.type, *args, **kwargs)
829
830 def visitReference(self, reference, *args, **kwargs):
831 self.visit(reference.type, *args, **kwargs)
832
833 def visitHandle(self, handle, *args, **kwargs):
834 self.visit(handle.type, *args, **kwargs)
835
836 def visitAlias(self, alias, *args, **kwargs):
837 self.visit(alias.type, *args, **kwargs)
838
839 def visitOpaque(self, opaque, *args, **kwargs):
840 pass
841
842 def visitInterface(self, interface, *args, **kwargs):
843 if interface.base is not None:
844 self.visit(interface.base, *args, **kwargs)
845 for method in interface.iterMethods():
846 for arg in method.args:
847 self.visit(arg.type, *args, **kwargs)
848 self.visit(method.type, *args, **kwargs)
849
850 def visitPolymorphic(self, polymorphic, *args, **kwargs):
José Fonseca0075f152012-04-14 20:25:52 +0100851 for expr, type in polymorphic.switchTypes:
852 self.visit(type, *args, **kwargs)
José Fonsecaeb216e62012-11-20 11:08:08 +0000853 if polymorphic.defaultType is not None:
854 self.visit(polymorphic.defaultType, *args, **kwargs)
José Fonseca0075f152012-04-14 20:25:52 +0100855
856
857class Collector(Traverser):
José Fonseca9c4a2572012-01-13 23:21:10 +0000858 '''Visitor which collects all unique types as it traverses them.'''
José Fonsecae6a50bd2010-11-24 10:12:22 +0000859
860 def __init__(self):
861 self.__visited = set()
862 self.types = []
863
864 def visit(self, type):
865 if type in self.__visited:
866 return
867 self.__visited.add(type)
868 Visitor.visit(self, type)
869 self.types.append(type)
870
José Fonseca16d46dd2011-10-13 09:52:52 +0100871
José Fonsecadbf714b2012-11-20 17:03:43 +0000872class ExpanderMixin:
873 '''Mixin class that provides a bunch of methods to expand C expressions
874 from the specifications.'''
875
876 __structs = None
877 __indices = None
878
879 def expand(self, expr):
880 # Expand a C expression, replacing certain variables
881 if not isinstance(expr, basestring):
882 return expr
883 variables = {}
884
885 if self.__structs is not None:
886 variables['self'] = '(%s)' % self.__structs[0]
887 if self.__indices is not None:
888 variables['i'] = self.__indices[0]
889
890 expandedExpr = expr.format(**variables)
891 if expandedExpr != expr and 0:
892 sys.stderr.write(" %r -> %r\n" % (expr, expandedExpr))
893 return expandedExpr
894
895 def visitMember(self, member, structInstance, *args, **kwargs):
896 memberType, memberName = member
897 if memberName is None:
898 # Anonymous structure/union member
899 memberInstance = structInstance
900 else:
901 memberInstance = '(%s).%s' % (structInstance, memberName)
902 self.__structs = (structInstance, self.__structs)
903 try:
904 return self.visit(memberType, memberInstance, *args, **kwargs)
905 finally:
906 _, self.__structs = self.__structs
907
908 def visitElement(self, elementIndex, elementType, *args, **kwargs):
909 self.__indices = (elementIndex, self.__indices)
910 try:
911 return self.visit(elementType, *args, **kwargs)
912 finally:
913 _, self.__indices = self.__indices
914
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000915
José Fonseca81301932012-11-11 00:10:20 +0000916class Module:
917 '''A collection of functions.'''
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000918
José Fonseca68ec4122011-02-20 11:25:25 +0000919 def __init__(self, name = None):
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000920 self.name = name
921 self.headers = []
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000922 self.functions = []
923 self.interfaces = []
924
José Fonseca54f304a2012-01-14 19:33:08 +0000925 def addFunctions(self, functions):
José Fonseca81301932012-11-11 00:10:20 +0000926 self.functions.extend(functions)
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000927
José Fonseca54f304a2012-01-14 19:33:08 +0000928 def addInterfaces(self, interfaces):
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000929 self.interfaces.extend(interfaces)
930
José Fonseca81301932012-11-11 00:10:20 +0000931 def mergeModule(self, module):
932 self.headers.extend(module.headers)
933 self.functions.extend(module.functions)
934 self.interfaces.extend(module.interfaces)
José Fonseca68ec4122011-02-20 11:25:25 +0000935
José Fonseca1b6c8752012-04-15 14:33:00 +0100936 def getFunctionByName(self, name):
José Fonsecaeccec3e2011-02-20 09:01:25 +0000937 for function in self.functions:
938 if function.name == name:
939 return function
940 return None
941
José Fonseca8fbdd3a2010-11-23 20:55:07 +0000942
José Fonseca81301932012-11-11 00:10:20 +0000943class API:
944 '''API abstraction.
945
946 Essentially, a collection of types, functions, and interfaces.
947 '''
948
949 def __init__(self, modules = None):
950 self.modules = []
951 if modules is not None:
952 self.modules.extend(modules)
953
954 def getAllTypes(self):
955 collector = Collector()
956 for module in self.modules:
957 for function in module.functions:
958 for arg in function.args:
959 collector.visit(arg.type)
960 collector.visit(function.type)
961 for interface in module.interfaces:
962 collector.visit(interface)
963 for method in interface.iterMethods():
964 for arg in method.args:
965 collector.visit(arg.type)
966 collector.visit(method.type)
967 return collector.types
968
969 def getAllFunctions(self):
970 functions = []
971 for module in self.modules:
972 functions.extend(module.functions)
973 return functions
974
975 def getAllInterfaces(self):
976 types = self.getAllTypes()
977 interfaces = [type for type in types if isinstance(type, Interface)]
978 for module in self.modules:
979 for interface in module.interfaces:
980 if interface not in interfaces:
981 interfaces.append(interface)
982 return interfaces
983
984 def addModule(self, module):
985 self.modules.append(module)
986
987 def getFunctionByName(self, name):
988 for module in self.modules:
989 for function in module.functions:
990 if function.name == name:
991 return function
992 return None
993
994
José Fonseca280a1762012-01-31 15:10:13 +0000995# C string (i.e., zero terminated)
José Fonsecabcfc81b2012-08-07 21:07:22 +0100996CString = String(Char)
997WString = String(WChar, wide=True)
998ConstCString = String(Const(Char))
999ConstWString = String(Const(WChar), wide=True)