git.cworth.org Git - apitrace/blob - specs/stdapi.py

   1 ##########################################################################
   2 #
   3 # Copyright 2008-2010 VMware, Inc.
   4 # All Rights Reserved.
   5 #
   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:
  12 #
  13 # The above copyright notice and this permission notice shall be included in
  14 # all copies or substantial portions of the Software.
  15 #
  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
  22 # THE SOFTWARE.
  23 #
  24 ##########################################################################/
  25
  26 """C basic types"""
  27
  28
  29 import debug
  30
  31
  32 class Type:
  33     """Base class for all types."""
  34
  35     __tags = set()
  36
  37     def __init__(self, expr, tag = None):
  38         self.expr = expr
  39
  40         # 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:
  44             if expr is not None:
  45                 tag = ''.join([c for c in expr if c.isalnum() or c in '_'])
  46             else:
  47                 tag = 'anonynoums'
  48         else:
  49             for c in tag:
  50                 assert c.isalnum() or c in '_'
  51
  52         # 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
  63
  64     def __str__(self):
  65         """Return the C/C++ type expression for this type."""
  66         return self.expr
  67
  68     def visit(self, visitor, *args, **kwargs):
  69         raise NotImplementedError
  70
  71     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)
  77
  78
  79 class _Void(Type):
  80     """Singleton void type."""
  81
  82     def __init__(self):
  83         Type.__init__(self, "void")
  84
  85     def visit(self, visitor, *args, **kwargs):
  86         return visitor.visitVoid(self, *args, **kwargs)
  87
  88 Void = _Void()
  89
  90
  91 class Literal(Type):
  92     """Class to describe literal types.
  93
  94     Types which are not defined in terms of other types, such as integers and
  95     floats."""
  96
  97     def __init__(self, expr, kind):
  98         Type.__init__(self, expr)
  99         self.kind = kind
 100
 101     def visit(self, visitor, *args, **kwargs):
 102         return visitor.visitLiteral(self, *args, **kwargs)
 103
 104
 105 Bool = Literal("bool", "Bool")
 106 SChar = Literal("signed char", "SInt")
 107 UChar = Literal("unsigned char", "UInt")
 108 Short = Literal("short", "SInt")
 109 Int = Literal("int", "SInt")
 110 Long = Literal("long", "SInt")
 111 LongLong = Literal("long long", "SInt")
 112 UShort = Literal("unsigned short", "UInt")
 113 UInt = Literal("unsigned int", "UInt")
 114 ULong = Literal("unsigned long", "UInt")
 115 ULongLong = Literal("unsigned long long", "UInt")
 116 Float = Literal("float", "Float")
 117 Double = Literal("double", "Double")
 118 SizeT = Literal("size_t", "UInt")
 119
 120 Char = Literal("char", "SInt")
 121 WChar = Literal("wchar_t", "SInt")
 122
 123 Int8 = Literal("int8_t", "SInt")
 124 UInt8 = Literal("uint8_t", "UInt")
 125 Int16 = Literal("int16_t", "SInt")
 126 UInt16 = Literal("uint16_t", "UInt")
 127 Int32 = Literal("int32_t", "SInt")
 128 UInt32 = Literal("uint32_t", "UInt")
 129 Int64 = Literal("int64_t", "SInt")
 130 UInt64 = Literal("uint64_t", "UInt")
 131
 132 IntPtr = Literal("intptr_t", "SInt")
 133 UIntPtr = Literal("uintptr_t", "UInt")
 134
 135 class Const(Type):
 136
 137     def __init__(self, type):
 138         # 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.
 141         if type.expr.startswith("const ") or '*' in type.expr:
 142             expr = type.expr + " const"
 143         else:
 144             # The most legible
 145             expr = "const " + type.expr
 146
 147         Type.__init__(self, expr, 'C' + type.tag)
 148
 149         self.type = type
 150
 151     def visit(self, visitor, *args, **kwargs):
 152         return visitor.visitConst(self, *args, **kwargs)
 153
 154
 155 class Pointer(Type):
 156
 157     def __init__(self, type):
 158         Type.__init__(self, type.expr + " *", 'P' + type.tag)
 159         self.type = type
 160
 161     def visit(self, visitor, *args, **kwargs):
 162         return visitor.visitPointer(self, *args, **kwargs)
 163
 164
 165 class 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
 172 class 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
 183 class LinearPointer(Type):
 184     '''Pointer to a linear range of memory.'''
 185
 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
 195 class 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
 206 class Handle(Type):
 207
 208     def __init__(self, name, type, range=None, key=None):
 209         Type.__init__(self, type.expr, 'P' + type.tag)
 210         self.name = name
 211         self.type = type
 212         self.range = range
 213         self.key = key
 214
 215     def visit(self, visitor, *args, **kwargs):
 216         return visitor.visitHandle(self, *args, **kwargs)
 217
 218
 219 def ConstPointer(type):
 220     return Pointer(Const(type))
 221
 222
 223 class Enum(Type):
 224
 225     __id = 0
 226
 227     def __init__(self, name, values):
 228         Type.__init__(self, name)
 229
 230         self.id = Enum.__id
 231         Enum.__id += 1
 232
 233         self.values = list(values)
 234
 235     def visit(self, visitor, *args, **kwargs):
 236         return visitor.visitEnum(self, *args, **kwargs)
 237
 238
 239 def FakeEnum(type, values):
 240     return Enum(type.expr, values)
 241
 242
 243 class Bitmask(Type):
 244
 245     __id = 0
 246
 247     def __init__(self, type, values):
 248         Type.__init__(self, type.expr)
 249
 250         self.id = Bitmask.__id
 251         Bitmask.__id += 1
 252
 253         self.type = type
 254         self.values = values
 255
 256     def visit(self, visitor, *args, **kwargs):
 257         return visitor.visitBitmask(self, *args, **kwargs)
 258
 259 Flags = Bitmask
 260
 261
 262 class 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):
 270         return visitor.visitArray(self, *args, **kwargs)
 271
 272
 273 class AttribArray(Type):
 274
 275     def __init__(self, keyType, valueTypes, isConst = True):
 276         if isConst:
 277             Type.__init__(self, (Pointer(Const(Int))).expr)
 278         else:
 279             Type.__init__(self, (Pointer(Int)).expr)
 280         self.type = (Pointer(Const(Int))) # for function prototypes and such
 281         self.keyType = keyType
 282         self.valueTypes = valueTypes
 283
 284     def visit(self, visitor, *args, **kwargs):
 285         return visitor.visitAttribArray(self, *args, **kwargs)
 286
 287
 288 class Blob(Type):
 289
 290     def __init__(self, type, size):
 291         Type.__init__(self, type.expr + ' *')
 292         self.type = type
 293         self.size = size
 294
 295     def visit(self, visitor, *args, **kwargs):
 296         return visitor.visitBlob(self, *args, **kwargs)
 297
 298
 299 class Struct(Type):
 300
 301     __id = 0
 302
 303     def __init__(self, name, members):
 304         Type.__init__(self, name)
 305
 306         self.id = Struct.__id
 307         Struct.__id += 1
 308
 309         self.name = name
 310         self.members = members
 311
 312     def visit(self, visitor, *args, **kwargs):
 313         return visitor.visitStruct(self, *args, **kwargs)
 314
 315
 316 def Union(kindExpr, kindTypes, contextLess=True):
 317     switchTypes = []
 318     for kindCase, kindType, kindMemberName in kindTypes:
 319         switchType = Struct(None, [(kindType, kindMemberName)])
 320         switchTypes.append((kindCase, switchType))
 321     return Polymorphic(kindExpr, switchTypes, contextLess=contextLess)
 322
 323
 324 class Alias(Type):
 325
 326     def __init__(self, expr, type):
 327         Type.__init__(self, expr)
 328         self.type = type
 329
 330     def visit(self, visitor, *args, **kwargs):
 331         return visitor.visitAlias(self, *args, **kwargs)
 332
 333 class Arg:
 334
 335     def __init__(self, type, name, input=True, output=False):
 336         self.type = type
 337         self.name = name
 338         self.input = input
 339         self.output = output
 340         self.index = None
 341
 342     def __str__(self):
 343         return '%s %s' % (self.type, self.name)
 344
 345
 346 def In(type, name):
 347     return Arg(type, name, input=True, output=False)
 348
 349 def Out(type, name):
 350     return Arg(type, name, input=False, output=True)
 351
 352 def InOut(type, name):
 353     return Arg(type, name, input=True, output=True)
 354
 355
 356 class Function:
 357
 358     def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, internal=False):
 359         self.type = type
 360         self.name = name
 361
 362         self.args = []
 363         index = 0
 364         for arg in args:
 365             if not isinstance(arg, Arg):
 366                 if isinstance(arg, tuple):
 367                     arg_type, arg_name = arg
 368                 else:
 369                     arg_type = arg
 370                     arg_name = "arg%u" % index
 371                 arg = Arg(arg_type, arg_name)
 372             arg.index = index
 373             index += 1
 374             self.args.append(arg)
 375
 376         self.call = call
 377         self.fail = fail
 378         self.sideeffects = sideeffects
 379         self.internal = internal
 380
 381     def prototype(self, name=None):
 382         if name is not None:
 383             name = name.strip()
 384         else:
 385             name = self.name
 386         s = name
 387         if self.call:
 388             s = self.call + ' ' + s
 389         if name.startswith('*'):
 390             s = '(' + s + ')'
 391         s = self.type.expr + ' ' + s
 392         s += "("
 393         if self.args:
 394             s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
 395         else:
 396             s += "void"
 397         s += ")"
 398         return s
 399
 400     def argNames(self):
 401         return [arg.name for arg in self.args]
 402
 403     def getArgByName(self, name):
 404         for arg in self.args:
 405             if arg.name == name:
 406                 return arg
 407         return None
 408
 409
 410 def StdFunction(*args, **kwargs):
 411     kwargs.setdefault('call', '__stdcall')
 412     return Function(*args, **kwargs)
 413
 414
 415 def FunctionPointer(type, name, args, **kwargs):
 416     # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
 417     return Opaque(name)
 418
 419
 420 class Interface(Type):
 421
 422     def __init__(self, name, base=None):
 423         Type.__init__(self, name)
 424         self.name = name
 425         self.base = base
 426         self.methods = []
 427
 428     def visit(self, visitor, *args, **kwargs):
 429         return visitor.visitInterface(self, *args, **kwargs)
 430
 431     def getMethodByName(self, name):
 432         for method in self.iterMethods():
 433             if method.name == name:
 434                 return method
 435         return None
 436
 437     def iterMethods(self):
 438         if self.base is not None:
 439             for method in self.base.iterMethods():
 440                 yield method
 441         for method in self.methods:
 442             yield method
 443         raise StopIteration
 444
 445     def iterBases(self):
 446         iface = self
 447         while iface is not None:
 448             yield iface
 449             iface = iface.base
 450         raise StopIteration
 451
 452     def hasBase(self, *bases):
 453         for iface in self.iterBases():
 454             if iface in bases:
 455                 return True
 456         return False
 457
 458     def iterBaseMethods(self):
 459         if self.base is not None:
 460             for iface, method in self.base.iterBaseMethods():
 461                 yield iface, method
 462         for method in self.methods:
 463             yield self, method
 464         raise StopIteration
 465
 466
 467 class Method(Function):
 468
 469     def __init__(self, type, name, args, call = '', const=False, sideeffects=True):
 470         assert call == '__stdcall'
 471         Function.__init__(self, type, name, args, call = call, sideeffects=sideeffects)
 472         for index in range(len(self.args)):
 473             self.args[index].index = index + 1
 474         self.const = const
 475
 476     def prototype(self, name=None):
 477         s = Function.prototype(self, name)
 478         if self.const:
 479             s += ' const'
 480         return s
 481
 482
 483 def StdMethod(*args, **kwargs):
 484     kwargs.setdefault('call', '__stdcall')
 485     return Method(*args, **kwargs)
 486
 487
 488 class String(Type):
 489     '''Human-legible character string.'''
 490
 491     def __init__(self, type = Char, length = None, wide = False):
 492         assert isinstance(type, Type)
 493         Type.__init__(self, type.expr + ' *')
 494         self.type = type
 495         self.length = length
 496         self.wide = wide
 497
 498     def visit(self, visitor, *args, **kwargs):
 499         return visitor.visitString(self, *args, **kwargs)
 500
 501
 502 class Opaque(Type):
 503     '''Opaque pointer.'''
 504
 505     def __init__(self, expr):
 506         Type.__init__(self, expr)
 507
 508     def visit(self, visitor, *args, **kwargs):
 509         return visitor.visitOpaque(self, *args, **kwargs)
 510
 511
 512 def OpaquePointer(type, *args):
 513     return Opaque(type.expr + ' *')
 514
 515 def OpaqueArray(type, size):
 516     return Opaque(type.expr + ' *')
 517
 518 def OpaqueBlob(type, size):
 519     return Opaque(type.expr + ' *')
 520
 521
 522 class Polymorphic(Type):
 523
 524     def __init__(self, switchExpr, switchTypes, defaultType=None, contextLess=True):
 525         if defaultType is None:
 526             Type.__init__(self, None)
 527             contextLess = False
 528         else:
 529             Type.__init__(self, defaultType.expr)
 530         self.switchExpr = switchExpr
 531         self.switchTypes = switchTypes
 532         self.defaultType = defaultType
 533         self.contextLess = contextLess
 534
 535     def visit(self, visitor, *args, **kwargs):
 536         return visitor.visitPolymorphic(self, *args, **kwargs)
 537
 538     def iterSwitch(self):
 539         cases = []
 540         types = []
 541
 542         if self.defaultType is not None:
 543             cases.append(['default'])
 544             types.append(self.defaultType)
 545
 546         for expr, type in self.switchTypes:
 547             case = 'case %s' % expr
 548             try:
 549                 i = types.index(type)
 550             except ValueError:
 551                 cases.append([case])
 552                 types.append(type)
 553             else:
 554                 cases[i].append(case)
 555
 556         return zip(cases, types)
 557
 558
 559 def EnumPolymorphic(enumName, switchExpr, switchTypes, defaultType, contextLess=True):
 560     enumValues = [expr for expr, type in switchTypes]
 561     enum = Enum(enumName, enumValues)
 562     polymorphic = Polymorphic(switchExpr, switchTypes, defaultType, contextLess)
 563     return enum, polymorphic
 564
 565
 566 class Visitor:
 567     '''Abstract visitor for the type hierarchy.'''
 568
 569     def visit(self, type, *args, **kwargs):
 570         return type.visit(self, *args, **kwargs)
 571
 572     def visitVoid(self, void, *args, **kwargs):
 573         raise NotImplementedError
 574
 575     def visitLiteral(self, literal, *args, **kwargs):
 576         raise NotImplementedError
 577
 578     def visitString(self, string, *args, **kwargs):
 579         raise NotImplementedError
 580
 581     def visitConst(self, const, *args, **kwargs):
 582         raise NotImplementedError
 583
 584     def visitStruct(self, struct, *args, **kwargs):
 585         raise NotImplementedError
 586
 587     def visitArray(self, array, *args, **kwargs):
 588         raise NotImplementedError
 589
 590     def visitAttribArray(self, array, *args, **kwargs):
 591         raise NotImplementedError
 592
 593     def visitBlob(self, blob, *args, **kwargs):
 594         raise NotImplementedError
 595
 596     def visitEnum(self, enum, *args, **kwargs):
 597         raise NotImplementedError
 598
 599     def visitBitmask(self, bitmask, *args, **kwargs):
 600         raise NotImplementedError
 601
 602     def visitPointer(self, pointer, *args, **kwargs):
 603         raise NotImplementedError
 604
 605     def visitIntPointer(self, pointer, *args, **kwargs):
 606         raise NotImplementedError
 607
 608     def visitObjPointer(self, pointer, *args, **kwargs):
 609         raise NotImplementedError
 610
 611     def visitLinearPointer(self, pointer, *args, **kwargs):
 612         raise NotImplementedError
 613
 614     def visitReference(self, reference, *args, **kwargs):
 615         raise NotImplementedError
 616
 617     def visitHandle(self, handle, *args, **kwargs):
 618         raise NotImplementedError
 619
 620     def visitAlias(self, alias, *args, **kwargs):
 621         raise NotImplementedError
 622
 623     def visitOpaque(self, opaque, *args, **kwargs):
 624         raise NotImplementedError
 625
 626     def visitInterface(self, interface, *args, **kwargs):
 627         raise NotImplementedError
 628
 629     def visitPolymorphic(self, polymorphic, *args, **kwargs):
 630         raise NotImplementedError
 631         #return self.visit(polymorphic.defaultType, *args, **kwargs)
 632
 633
 634 class OnceVisitor(Visitor):
 635     '''Visitor that guarantees that each type is visited only once.'''
 636
 637     def __init__(self):
 638         self.__visited = set()
 639
 640     def visit(self, type, *args, **kwargs):
 641         if type not in self.__visited:
 642             self.__visited.add(type)
 643             return type.visit(self, *args, **kwargs)
 644         return None
 645
 646
 647 class Rebuilder(Visitor):
 648     '''Visitor which rebuild types as it visits them.
 649
 650     By itself it is a no-op -- it is intended to be overwritten.
 651     '''
 652
 653     def visitVoid(self, void):
 654         return void
 655
 656     def visitLiteral(self, literal):
 657         return literal
 658
 659     def visitString(self, string):
 660         string_type = self.visit(string.type)
 661         if string_type is string.type:
 662             return string
 663         else:
 664             return String(string_type, string.length, string.wide)
 665
 666     def visitConst(self, const):
 667         const_type = self.visit(const.type)
 668         if const_type is const.type:
 669             return const
 670         else:
 671             return Const(const_type)
 672
 673     def visitStruct(self, struct):
 674         members = [(self.visit(type), name) for type, name in struct.members]
 675         return Struct(struct.name, members)
 676
 677     def visitArray(self, array):
 678         type = self.visit(array.type)
 679         return Array(type, array.length)
 680
 681     def visitBlob(self, blob):
 682         type = self.visit(blob.type)
 683         return Blob(type, blob.size)
 684
 685     def visitEnum(self, enum):
 686         return enum
 687
 688     def visitBitmask(self, bitmask):
 689         type = self.visit(bitmask.type)
 690         return Bitmask(type, bitmask.values)
 691
 692     def visitPointer(self, pointer):
 693         pointer_type = self.visit(pointer.type)
 694         if pointer_type is pointer.type:
 695             return pointer
 696         else:
 697             return Pointer(pointer_type)
 698
 699     def visitIntPointer(self, pointer):
 700         return pointer
 701
 702     def visitObjPointer(self, pointer):
 703         pointer_type = self.visit(pointer.type)
 704         if pointer_type is pointer.type:
 705             return pointer
 706         else:
 707             return ObjPointer(pointer_type)
 708
 709     def visitLinearPointer(self, pointer):
 710         pointer_type = self.visit(pointer.type)
 711         if pointer_type is pointer.type:
 712             return pointer
 713         else:
 714             return LinearPointer(pointer_type)
 715
 716     def visitReference(self, reference):
 717         reference_type = self.visit(reference.type)
 718         if reference_type is reference.type:
 719             return reference
 720         else:
 721             return Reference(reference_type)
 722
 723     def visitHandle(self, handle):
 724         handle_type = self.visit(handle.type)
 725         if handle_type is handle.type:
 726             return handle
 727         else:
 728             return Handle(handle.name, handle_type, range=handle.range, key=handle.key)
 729
 730     def visitAlias(self, alias):
 731         alias_type = self.visit(alias.type)
 732         if alias_type is alias.type:
 733             return alias
 734         else:
 735             return Alias(alias.expr, alias_type)
 736
 737     def visitOpaque(self, opaque):
 738         return opaque
 739
 740     def visitInterface(self, interface, *args, **kwargs):
 741         return interface
 742
 743     def visitPolymorphic(self, polymorphic):
 744         switchExpr = polymorphic.switchExpr
 745         switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
 746         if polymorphic.defaultType is None:
 747             defaultType = None
 748         else:
 749             defaultType = self.visit(polymorphic.defaultType)
 750         return Polymorphic(switchExpr, switchTypes, defaultType, polymorphic.contextLess)
 751
 752
 753 class MutableRebuilder(Rebuilder):
 754     '''Type visitor which derives a mutable type.'''
 755
 756     def visitString(self, string):
 757         return string
 758
 759     def visitConst(self, const):
 760         # Strip out const qualifier
 761         return const.type
 762
 763     def visitAlias(self, alias):
 764         # Tear the alias on type changes
 765         type = self.visit(alias.type)
 766         if type is alias.type:
 767             return alias
 768         return type
 769
 770     def visitReference(self, reference):
 771         # Strip out references
 772         return reference.type
 773
 774
 775 class Traverser(Visitor):
 776     '''Visitor which all types.'''
 777
 778     def visitVoid(self, void, *args, **kwargs):
 779         pass
 780
 781     def visitLiteral(self, literal, *args, **kwargs):
 782         pass
 783
 784     def visitString(self, string, *args, **kwargs):
 785         pass
 786
 787     def visitConst(self, const, *args, **kwargs):
 788         self.visit(const.type, *args, **kwargs)
 789
 790     def visitStruct(self, struct, *args, **kwargs):
 791         for type, name in struct.members:
 792             self.visit(type, *args, **kwargs)
 793
 794     def visitArray(self, array, *args, **kwargs):
 795         self.visit(array.type, *args, **kwargs)
 796
 797     def visitAttribArray(self, attribs, *args, **kwargs):
 798         for key, valueType in attribs.valueTypes:
 799             self.visit(valueType, *args, **kwargs)
 800
 801     def visitBlob(self, array, *args, **kwargs):
 802         pass
 803
 804     def visitEnum(self, enum, *args, **kwargs):
 805         pass
 806
 807     def visitBitmask(self, bitmask, *args, **kwargs):
 808         self.visit(bitmask.type, *args, **kwargs)
 809
 810     def visitPointer(self, pointer, *args, **kwargs):
 811         self.visit(pointer.type, *args, **kwargs)
 812
 813     def visitIntPointer(self, pointer, *args, **kwargs):
 814         pass
 815
 816     def visitObjPointer(self, pointer, *args, **kwargs):
 817         self.visit(pointer.type, *args, **kwargs)
 818
 819     def visitLinearPointer(self, pointer, *args, **kwargs):
 820         self.visit(pointer.type, *args, **kwargs)
 821
 822     def visitReference(self, reference, *args, **kwargs):
 823         self.visit(reference.type, *args, **kwargs)
 824
 825     def visitHandle(self, handle, *args, **kwargs):
 826         self.visit(handle.type, *args, **kwargs)
 827
 828     def visitAlias(self, alias, *args, **kwargs):
 829         self.visit(alias.type, *args, **kwargs)
 830
 831     def visitOpaque(self, opaque, *args, **kwargs):
 832         pass
 833
 834     def visitInterface(self, interface, *args, **kwargs):
 835         if interface.base is not None:
 836             self.visit(interface.base, *args, **kwargs)
 837         for method in interface.iterMethods():
 838             for arg in method.args:
 839                 self.visit(arg.type, *args, **kwargs)
 840             self.visit(method.type, *args, **kwargs)
 841
 842     def visitPolymorphic(self, polymorphic, *args, **kwargs):
 843         for expr, type in polymorphic.switchTypes:
 844             self.visit(type, *args, **kwargs)
 845         if polymorphic.defaultType is not None:
 846             self.visit(polymorphic.defaultType, *args, **kwargs)
 847
 848
 849 class Collector(Traverser):
 850     '''Visitor which collects all unique types as it traverses them.'''
 851
 852     def __init__(self):
 853         self.__visited = set()
 854         self.types = []
 855
 856     def visit(self, type):
 857         if type in self.__visited:
 858             return
 859         self.__visited.add(type)
 860         Visitor.visit(self, type)
 861         self.types.append(type)
 862
 863
 864 class ExpanderMixin:
 865     '''Mixin class that provides a bunch of methods to expand C expressions
 866     from the specifications.'''
 867
 868     __structs = None
 869     __indices = None
 870
 871     def expand(self, expr):
 872         # Expand a C expression, replacing certain variables
 873         if not isinstance(expr, basestring):
 874             return expr
 875         variables = {}
 876
 877         if self.__structs is not None:
 878             variables['self'] = '(%s)' % self.__structs[0]
 879         if self.__indices is not None:
 880             variables['i'] = self.__indices[0]
 881
 882         expandedExpr = expr.format(**variables)
 883         if expandedExpr != expr and 0:
 884             sys.stderr.write("  %r -> %r\n" % (expr, expandedExpr))
 885         return expandedExpr
 886
 887     def visitMember(self, member, structInstance, *args, **kwargs):
 888         memberType, memberName = member
 889         if memberName is None:
 890             # Anonymous structure/union member
 891             memberInstance = structInstance
 892         else:
 893             memberInstance = '(%s).%s' % (structInstance, memberName)
 894         self.__structs = (structInstance, self.__structs)
 895         try:
 896             return self.visit(memberType, memberInstance, *args, **kwargs)
 897         finally:
 898             _, self.__structs = self.__structs
 899
 900     def visitElement(self, elementIndex, elementType, *args, **kwargs):
 901         self.__indices = (elementIndex, self.__indices)
 902         try:
 903             return self.visit(elementType, *args, **kwargs)
 904         finally:
 905             _, self.__indices = self.__indices
 906
 907
 908 class Module:
 909     '''A collection of functions.'''
 910
 911     def __init__(self, name = None):
 912         self.name = name
 913         self.headers = []
 914         self.functions = []
 915         self.interfaces = []
 916
 917     def addFunctions(self, functions):
 918         self.functions.extend(functions)
 919
 920     def addInterfaces(self, interfaces):
 921         self.interfaces.extend(interfaces)
 922
 923     def mergeModule(self, module):
 924         self.headers.extend(module.headers)
 925         self.functions.extend(module.functions)
 926         self.interfaces.extend(module.interfaces)
 927
 928     def getFunctionByName(self, name):
 929         for function in self.functions:
 930             if function.name == name:
 931                 return function
 932         return None
 933
 934
 935 class API:
 936     '''API abstraction.
 937
 938     Essentially, a collection of types, functions, and interfaces.
 939     '''
 940
 941     def __init__(self, modules = None):
 942         self.modules = []
 943         if modules is not None:
 944             self.modules.extend(modules)
 945
 946     def getAllTypes(self):
 947         collector = Collector()
 948         for module in self.modules:
 949             for function in module.functions:
 950                 for arg in function.args:
 951                     collector.visit(arg.type)
 952                 collector.visit(function.type)
 953             for interface in module.interfaces:
 954                 collector.visit(interface)
 955                 for method in interface.iterMethods():
 956                     for arg in method.args:
 957                         collector.visit(arg.type)
 958                     collector.visit(method.type)
 959         return collector.types
 960
 961     def getAllFunctions(self):
 962         functions = []
 963         for module in self.modules:
 964             functions.extend(module.functions)
 965         return functions
 966
 967     def getAllInterfaces(self):
 968         types = self.getAllTypes()
 969         interfaces = [type for type in types if isinstance(type, Interface)]
 970         for module in self.modules:
 971             for interface in module.interfaces:
 972                 if interface not in interfaces:
 973                     interfaces.append(interface)
 974         return interfaces
 975
 976     def addModule(self, module):
 977         self.modules.append(module)
 978
 979     def getFunctionByName(self, name):
 980         for module in self.modules:
 981             for function in module.functions:
 982                 if function.name == name:
 983                     return function
 984         return None
 985
 986
 987 # C string (i.e., zero terminated)
 988 CString = String(Char)
 989 WString = String(WChar, wide=True)
 990 ConstCString = String(Const(Char))
 991 ConstWString = String(Const(WChar), wide=True)