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             tag = ''.join([c for c in expr if c.isalnum() or c in '_'])
  45         else:
  46             for c in tag:
  47                 assert c.isalnum() or c in '_'
  48
  49         # Ensure it is unique.
  50         if tag in Type.__tags:
  51             suffix = 1
  52             while tag + str(suffix) in Type.__tags:
  53                 suffix += 1
  54             tag += str(suffix)
  55
  56         assert tag not in Type.__tags
  57         Type.__tags.add(tag)
  58
  59         self.tag = tag
  60
  61     def __str__(self):
  62         """Return the C/C++ type expression for this type."""
  63         return self.expr
  64
  65     def visit(self, visitor, *args, **kwargs):
  66         raise NotImplementedError
  67
  68
  69
  70 class _Void(Type):
  71     """Singleton void type."""
  72
  73     def __init__(self):
  74         Type.__init__(self, "void")
  75
  76     def visit(self, visitor, *args, **kwargs):
  77         return visitor.visitVoid(self, *args, **kwargs)
  78
  79 Void = _Void()
  80
  81
  82 class Literal(Type):
  83     """Class to describe literal types.
  84
  85     Types which are not defined in terms of other types, such as integers and
  86     floats."""
  87
  88     def __init__(self, expr, kind):
  89         Type.__init__(self, expr)
  90         self.kind = kind
  91
  92     def visit(self, visitor, *args, **kwargs):
  93         return visitor.visitLiteral(self, *args, **kwargs)
  94
  95
  96 class Const(Type):
  97
  98     def __init__(self, type):
  99         # While "const foo" and "foo const" are synonymous, "const foo *" and
 100         # "foo * const" are not quite the same, and some compilers do enforce
 101         # strict const correctness.
 102         if isinstance(type, String) or type is WString:
 103             # For strings we never intend to say a const pointer to chars, but
 104             # rather a point to const chars.
 105             expr = "const " + type.expr
 106         elif type.expr.startswith("const ") or '*' in type.expr:
 107             expr = type.expr + " const"
 108         else:
 109             # The most legible
 110             expr = "const " + type.expr
 111
 112         Type.__init__(self, expr, 'C' + type.tag)
 113
 114         self.type = type
 115
 116     def visit(self, visitor, *args, **kwargs):
 117         return visitor.visitConst(self, *args, **kwargs)
 118
 119
 120 class Pointer(Type):
 121
 122     def __init__(self, type):
 123         Type.__init__(self, type.expr + " *", 'P' + type.tag)
 124         self.type = type
 125
 126     def visit(self, visitor, *args, **kwargs):
 127         return visitor.visitPointer(self, *args, **kwargs)
 128
 129
 130 class IntPointer(Type):
 131     '''Integer encoded as a pointer.'''
 132
 133     def visit(self, visitor, *args, **kwargs):
 134         return visitor.visitIntPointer(self, *args, **kwargs)
 135
 136
 137 class LinearPointer(Type):
 138     '''Integer encoded as a pointer.'''
 139
 140     def __init__(self, type, size = None):
 141         Type.__init__(self, type.expr + " *", 'P' + type.tag)
 142         self.type = type
 143         self.size = size
 144
 145     def visit(self, visitor, *args, **kwargs):
 146         return visitor.visitLinearPointer(self, *args, **kwargs)
 147
 148
 149 class Handle(Type):
 150
 151     def __init__(self, name, type, range=None, key=None):
 152         Type.__init__(self, type.expr, 'P' + type.tag)
 153         self.name = name
 154         self.type = type
 155         self.range = range
 156         self.key = key
 157
 158     def visit(self, visitor, *args, **kwargs):
 159         return visitor.visitHandle(self, *args, **kwargs)
 160
 161
 162 def ConstPointer(type):
 163     return Pointer(Const(type))
 164
 165
 166 class Enum(Type):
 167
 168     __id = 0
 169
 170     def __init__(self, name, values):
 171         Type.__init__(self, name)
 172
 173         self.id = Enum.__id
 174         Enum.__id += 1
 175
 176         self.values = list(values)
 177
 178     def visit(self, visitor, *args, **kwargs):
 179         return visitor.visitEnum(self, *args, **kwargs)
 180
 181
 182 def FakeEnum(type, values):
 183     return Enum(type.expr, values)
 184
 185
 186 class Bitmask(Type):
 187
 188     __id = 0
 189
 190     def __init__(self, type, values):
 191         Type.__init__(self, type.expr)
 192
 193         self.id = Bitmask.__id
 194         Bitmask.__id += 1
 195
 196         self.type = type
 197         self.values = values
 198
 199     def visit(self, visitor, *args, **kwargs):
 200         return visitor.visitBitmask(self, *args, **kwargs)
 201
 202 Flags = Bitmask
 203
 204
 205 class Array(Type):
 206
 207     def __init__(self, type, length):
 208         Type.__init__(self, type.expr + " *")
 209         self.type = type
 210         self.length = length
 211
 212     def visit(self, visitor, *args, **kwargs):
 213         return visitor.visitArray(self, *args, **kwargs)
 214
 215
 216 class Blob(Type):
 217
 218     def __init__(self, type, size):
 219         Type.__init__(self, type.expr + ' *')
 220         self.type = type
 221         self.size = size
 222
 223     def visit(self, visitor, *args, **kwargs):
 224         return visitor.visitBlob(self, *args, **kwargs)
 225
 226
 227 class Struct(Type):
 228
 229     __id = 0
 230
 231     def __init__(self, name, members):
 232         Type.__init__(self, name)
 233
 234         self.id = Struct.__id
 235         Struct.__id += 1
 236
 237         self.name = name
 238         self.members = members
 239
 240     def visit(self, visitor, *args, **kwargs):
 241         return visitor.visitStruct(self, *args, **kwargs)
 242
 243
 244 class Alias(Type):
 245
 246     def __init__(self, expr, type):
 247         Type.__init__(self, expr)
 248         self.type = type
 249
 250     def visit(self, visitor, *args, **kwargs):
 251         return visitor.visitAlias(self, *args, **kwargs)
 252
 253
 254 def Out(type, name):
 255     arg = Arg(type, name, output=True)
 256     return arg
 257
 258
 259 class Arg:
 260
 261     def __init__(self, type, name, output=False):
 262         self.type = type
 263         self.name = name
 264         self.output = output
 265         self.index = None
 266
 267     def __str__(self):
 268         return '%s %s' % (self.type, self.name)
 269
 270
 271 class Function:
 272
 273     # 0-3 are reserved to memcpy, malloc, free, and realloc
 274     __id = 4
 275
 276     def __init__(self, type, name, args, call = '', fail = None, sideeffects=True):
 277         self.id = Function.__id
 278         Function.__id += 1
 279
 280         self.type = type
 281         self.name = name
 282
 283         self.args = []
 284         index = 0
 285         for arg in args:
 286             if not isinstance(arg, Arg):
 287                 if isinstance(arg, tuple):
 288                     arg_type, arg_name = arg
 289                 else:
 290                     arg_type = arg
 291                     arg_name = "arg%u" % index
 292                 arg = Arg(arg_type, arg_name)
 293             arg.index = index
 294             index += 1
 295             self.args.append(arg)
 296
 297         self.call = call
 298         self.fail = fail
 299         self.sideeffects = sideeffects
 300
 301     def prototype(self, name=None):
 302         if name is not None:
 303             name = name.strip()
 304         else:
 305             name = self.name
 306         s = name
 307         if self.call:
 308             s = self.call + ' ' + s
 309         if name.startswith('*'):
 310             s = '(' + s + ')'
 311         s = self.type.expr + ' ' + s
 312         s += "("
 313         if self.args:
 314             s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
 315         else:
 316             s += "void"
 317         s += ")"
 318         return s
 319
 320     def argNames(self):
 321         return [arg.name for arg in self.args]
 322
 323
 324 def StdFunction(*args, **kwargs):
 325     kwargs.setdefault('call', '__stdcall')
 326     return Function(*args, **kwargs)
 327
 328
 329 def FunctionPointer(type, name, args, **kwargs):
 330     # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
 331     return Opaque(name)
 332
 333
 334 class Interface(Type):
 335
 336     def __init__(self, name, base=None):
 337         Type.__init__(self, name)
 338         self.name = name
 339         self.base = base
 340         self.methods = []
 341
 342     def visit(self, visitor, *args, **kwargs):
 343         return visitor.visitInterface(self, *args, **kwargs)
 344
 345     def iterMethods(self):
 346         if self.base is not None:
 347             for method in self.base.iterMethods():
 348                 yield method
 349         for method in self.methods:
 350             yield method
 351         raise StopIteration
 352
 353
 354 class Method(Function):
 355
 356     def __init__(self, type, name, args):
 357         Function.__init__(self, type, name, args, call = '__stdcall')
 358         for index in range(len(self.args)):
 359             self.args[index].index = index + 1
 360
 361
 362 class String(Type):
 363
 364     def __init__(self, expr = "char *", length = None, kind = 'String'):
 365         Type.__init__(self, expr)
 366         self.length = length
 367         self.kind = kind
 368
 369     def visit(self, visitor, *args, **kwargs):
 370         return visitor.visitString(self, *args, **kwargs)
 371
 372
 373 class Opaque(Type):
 374     '''Opaque pointer.'''
 375
 376     def __init__(self, expr):
 377         Type.__init__(self, expr)
 378
 379     def visit(self, visitor, *args, **kwargs):
 380         return visitor.visitOpaque(self, *args, **kwargs)
 381
 382
 383 def OpaquePointer(type, *args):
 384     return Opaque(type.expr + ' *')
 385
 386 def OpaqueArray(type, size):
 387     return Opaque(type.expr + ' *')
 388
 389 def OpaqueBlob(type, size):
 390     return Opaque(type.expr + ' *')
 391
 392
 393 class Polymorphic(Type):
 394
 395     def __init__(self, defaultType, switchExpr, switchTypes):
 396         Type.__init__(self, defaultType.expr)
 397         self.defaultType = defaultType
 398         self.switchExpr = switchExpr
 399         self.switchTypes = switchTypes
 400
 401     def visit(self, visitor, *args, **kwargs):
 402         return visitor.visitPolymorphic(self, *args, **kwargs)
 403
 404     def iterSwitch(self):
 405         cases = [['default']]
 406         types = [self.defaultType]
 407
 408         for expr, type in self.switchTypes:
 409             case = 'case %s' % expr
 410             try:
 411                 i = types.index(type)
 412             except ValueError:
 413                 cases.append([case])
 414                 types.append(type)
 415             else:
 416                 cases[i].append(case)
 417
 418         return zip(cases, types)
 419
 420
 421 class Visitor:
 422     '''Abstract visitor for the type hierarchy.'''
 423
 424     def visit(self, type, *args, **kwargs):
 425         return type.visit(self, *args, **kwargs)
 426
 427     def visitVoid(self, void, *args, **kwargs):
 428         raise NotImplementedError
 429
 430     def visitLiteral(self, literal, *args, **kwargs):
 431         raise NotImplementedError
 432
 433     def visitString(self, string, *args, **kwargs):
 434         raise NotImplementedError
 435
 436     def visitConst(self, const, *args, **kwargs):
 437         raise NotImplementedError
 438
 439     def visitStruct(self, struct, *args, **kwargs):
 440         raise NotImplementedError
 441
 442     def visitArray(self, array, *args, **kwargs):
 443         raise NotImplementedError
 444
 445     def visitBlob(self, blob, *args, **kwargs):
 446         raise NotImplementedError
 447
 448     def visitEnum(self, enum, *args, **kwargs):
 449         raise NotImplementedError
 450
 451     def visitBitmask(self, bitmask, *args, **kwargs):
 452         raise NotImplementedError
 453
 454     def visitPointer(self, pointer, *args, **kwargs):
 455         raise NotImplementedError
 456
 457     def visitIntPointer(self, pointer, *args, **kwargs):
 458         raise NotImplementedError
 459
 460     def visitLinearPointer(self, pointer, *args, **kwargs):
 461         raise NotImplementedError
 462
 463     def visitHandle(self, handle, *args, **kwargs):
 464         raise NotImplementedError
 465
 466     def visitAlias(self, alias, *args, **kwargs):
 467         raise NotImplementedError
 468
 469     def visitOpaque(self, opaque, *args, **kwargs):
 470         raise NotImplementedError
 471
 472     def visitInterface(self, interface, *args, **kwargs):
 473         raise NotImplementedError
 474
 475     def visitPolymorphic(self, polymorphic, *args, **kwargs):
 476         raise NotImplementedError
 477         #return self.visit(polymorphic.defaultType, *args, **kwargs)
 478
 479
 480 class OnceVisitor(Visitor):
 481     '''Visitor that guarantees that each type is visited only once.'''
 482
 483     def __init__(self):
 484         self.__visited = set()
 485
 486     def visit(self, type, *args, **kwargs):
 487         if type not in self.__visited:
 488             self.__visited.add(type)
 489             return type.visit(self, *args, **kwargs)
 490         return None
 491
 492
 493 class Rebuilder(Visitor):
 494     '''Visitor which rebuild types as it visits them.
 495
 496     By itself it is a no-op -- it is intended to be overwritten.
 497     '''
 498
 499     def visitVoid(self, void):
 500         return void
 501
 502     def visitLiteral(self, literal):
 503         return literal
 504
 505     def visitString(self, string):
 506         return string
 507
 508     def visitConst(self, const):
 509         return Const(const.type)
 510
 511     def visitStruct(self, struct):
 512         members = [(self.visit(type), name) for type, name in struct.members]
 513         return Struct(struct.name, members)
 514
 515     def visitArray(self, array):
 516         type = self.visit(array.type)
 517         return Array(type, array.length)
 518
 519     def visitBlob(self, blob):
 520         type = self.visit(blob.type)
 521         return Blob(type, blob.size)
 522
 523     def visitEnum(self, enum):
 524         return enum
 525
 526     def visitBitmask(self, bitmask):
 527         type = self.visit(bitmask.type)
 528         return Bitmask(type, bitmask.values)
 529
 530     def visitPointer(self, pointer):
 531         type = self.visit(pointer.type)
 532         return Pointer(type)
 533
 534     def visitIntPointer(self, pointer):
 535         return pointer
 536
 537     def visitLinearPointer(self, pointer):
 538         type = self.visit(pointer.type)
 539         return LinearPointer(type, pointer.size)
 540
 541     def visitHandle(self, handle):
 542         type = self.visit(handle.type)
 543         return Handle(handle.name, type, range=handle.range, key=handle.key)
 544
 545     def visitAlias(self, alias):
 546         type = self.visit(alias.type)
 547         return Alias(alias.expr, type)
 548
 549     def visitOpaque(self, opaque):
 550         return opaque
 551
 552     def visitInterface(self, interface, *args, **kwargs):
 553         return interface
 554
 555     def visitPolymorphic(self, polymorphic):
 556         defaultType = self.visit(polymorphic.defaultType)
 557         switchExpr = polymorphic.switchExpr
 558         switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
 559         return Polymorphic(defaultType, switchExpr, switchTypes)
 560
 561
 562 class Collector(Visitor):
 563     '''Visitor which collects all unique types as it traverses them.'''
 564
 565     def __init__(self):
 566         self.__visited = set()
 567         self.types = []
 568
 569     def visit(self, type):
 570         if type in self.__visited:
 571             return
 572         self.__visited.add(type)
 573         Visitor.visit(self, type)
 574         self.types.append(type)
 575
 576     def visitVoid(self, literal):
 577         pass
 578
 579     def visitLiteral(self, literal):
 580         pass
 581
 582     def visitString(self, string):
 583         pass
 584
 585     def visitConst(self, const):
 586         self.visit(const.type)
 587
 588     def visitStruct(self, struct):
 589         for type, name in struct.members:
 590             self.visit(type)
 591
 592     def visitArray(self, array):
 593         self.visit(array.type)
 594
 595     def visitBlob(self, array):
 596         pass
 597
 598     def visitEnum(self, enum):
 599         pass
 600
 601     def visitBitmask(self, bitmask):
 602         self.visit(bitmask.type)
 603
 604     def visitPointer(self, pointer):
 605         self.visit(pointer.type)
 606
 607     def visitIntPointer(self, pointer):
 608         pass
 609
 610     def visitLinearPointer(self, pointer):
 611         self.visit(pointer.type)
 612
 613     def visitHandle(self, handle):
 614         self.visit(handle.type)
 615
 616     def visitAlias(self, alias):
 617         self.visit(alias.type)
 618
 619     def visitOpaque(self, opaque):
 620         pass
 621
 622     def visitInterface(self, interface):
 623         if interface.base is not None:
 624             self.visit(interface.base)
 625         for method in interface.iterMethods():
 626             for arg in method.args:
 627                 self.visit(arg.type)
 628             self.visit(method.type)
 629
 630     def visitPolymorphic(self, polymorphic):
 631         self.visit(polymorphic.defaultType)
 632         for expr, type in polymorphic.switchTypes:
 633             self.visit(type)
 634
 635
 636 class API:
 637     '''API abstraction.
 638
 639     Essentially, a collection of types, functions, and interfaces.
 640     '''
 641
 642     def __init__(self, name = None):
 643         self.name = name
 644         self.headers = []
 645         self.functions = []
 646         self.interfaces = []
 647
 648     def getAllTypes(self):
 649         collector = Collector()
 650         for function in self.functions:
 651             for arg in function.args:
 652                 collector.visit(arg.type)
 653             collector.visit(function.type)
 654         for interface in self.interfaces:
 655             collector.visit(interface)
 656             for method in interface.iterMethods():
 657                 for arg in method.args:
 658                     collector.visit(arg.type)
 659                 collector.visit(method.type)
 660         return collector.types
 661
 662     def getAllInterfaces(self):
 663         types = self.getAllTypes()
 664         interfaces = [type for type in types if isinstance(type, Interface)]
 665         for interface in self.interfaces:
 666             if interface not in interfaces:
 667                 interfaces.append(interface)
 668         return interfaces
 669
 670     def addFunction(self, function):
 671         self.functions.append(function)
 672
 673     def addFunctions(self, functions):
 674         for function in functions:
 675             self.addFunction(function)
 676
 677     def addInterface(self, interface):
 678         self.interfaces.append(interface)
 679
 680     def addInterfaces(self, interfaces):
 681         self.interfaces.extend(interfaces)
 682
 683     def addApi(self, api):
 684         self.headers.extend(api.headers)
 685         self.addFunctions(api.functions)
 686         self.addInterfaces(api.interfaces)
 687
 688     def get_function_by_name(self, name):
 689         for function in self.functions:
 690             if function.name == name:
 691                 return function
 692         return None
 693
 694
 695 Bool = Literal("bool", "Bool")
 696 SChar = Literal("signed char", "SInt")
 697 UChar = Literal("unsigned char", "UInt")
 698 Short = Literal("short", "SInt")
 699 Int = Literal("int", "SInt")
 700 Long = Literal("long", "SInt")
 701 LongLong = Literal("long long", "SInt")
 702 UShort = Literal("unsigned short", "UInt")
 703 UInt = Literal("unsigned int", "UInt")
 704 ULong = Literal("unsigned long", "UInt")
 705 ULongLong = Literal("unsigned long long", "UInt")
 706 Float = Literal("float", "Float")
 707 Double = Literal("double", "Double")
 708 SizeT = Literal("size_t", "UInt")
 709
 710 # C string (i.e., zero terminated)
 711 CString = String()
 712 WString = String("wchar_t *", kind="WString")
 713
 714 Int8 = Literal("int8_t", "SInt")
 715 UInt8 = Literal("uint8_t", "UInt")
 716 Int16 = Literal("int16_t", "SInt")
 717 UInt16 = Literal("uint16_t", "UInt")
 718 Int32 = Literal("int32_t", "SInt")
 719 UInt32 = Literal("uint32_t", "UInt")
 720 Int64 = Literal("int64_t", "SInt")
 721 UInt64 = Literal("uint64_t", "UInt")