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):
 365         Type.__init__(self, expr)
 366         self.length = length
 367
 368     def visit(self, visitor, *args, **kwargs):
 369         return visitor.visitString(self, *args, **kwargs)
 370
 371 # C string (i.e., zero terminated)
 372 CString = String()
 373
 374
 375 class Opaque(Type):
 376     '''Opaque pointer.'''
 377
 378     def __init__(self, expr):
 379         Type.__init__(self, expr)
 380
 381     def visit(self, visitor, *args, **kwargs):
 382         return visitor.visitOpaque(self, *args, **kwargs)
 383
 384
 385 def OpaquePointer(type, *args):
 386     return Opaque(type.expr + ' *')
 387
 388 def OpaqueArray(type, size):
 389     return Opaque(type.expr + ' *')
 390
 391 def OpaqueBlob(type, size):
 392     return Opaque(type.expr + ' *')
 393
 394
 395 class Polymorphic(Type):
 396
 397     def __init__(self, defaultType, switchExpr, switchTypes):
 398         Type.__init__(self, defaultType.expr)
 399         self.defaultType = defaultType
 400         self.switchExpr = switchExpr
 401         self.switchTypes = switchTypes
 402
 403     def visit(self, visitor, *args, **kwargs):
 404         return visitor.visitPolymorphic(self, *args, **kwargs)
 405
 406     def iterSwitch(self):
 407         cases = [['default']]
 408         types = [self.defaultType]
 409
 410         for expr, type in self.switchTypes:
 411             case = 'case %s' % expr
 412             try:
 413                 i = types.index(type)
 414             except ValueError:
 415                 cases.append([case])
 416                 types.append(type)
 417             else:
 418                 cases[i].append(case)
 419
 420         return zip(cases, types)
 421
 422
 423 class Visitor:
 424     '''Abstract visitor for the type hierarchy.'''
 425
 426     def visit(self, type, *args, **kwargs):
 427         return type.visit(self, *args, **kwargs)
 428
 429     def visitVoid(self, void, *args, **kwargs):
 430         raise NotImplementedError
 431
 432     def visitLiteral(self, literal, *args, **kwargs):
 433         raise NotImplementedError
 434
 435     def visitString(self, string, *args, **kwargs):
 436         raise NotImplementedError
 437
 438     def visitConst(self, const, *args, **kwargs):
 439         raise NotImplementedError
 440
 441     def visitStruct(self, struct, *args, **kwargs):
 442         raise NotImplementedError
 443
 444     def visitArray(self, array, *args, **kwargs):
 445         raise NotImplementedError
 446
 447     def visitBlob(self, blob, *args, **kwargs):
 448         raise NotImplementedError
 449
 450     def visitEnum(self, enum, *args, **kwargs):
 451         raise NotImplementedError
 452
 453     def visitBitmask(self, bitmask, *args, **kwargs):
 454         raise NotImplementedError
 455
 456     def visitPointer(self, pointer, *args, **kwargs):
 457         raise NotImplementedError
 458
 459     def visitIntPointer(self, pointer, *args, **kwargs):
 460         raise NotImplementedError
 461
 462     def visitLinearPointer(self, pointer, *args, **kwargs):
 463         raise NotImplementedError
 464
 465     def visitHandle(self, handle, *args, **kwargs):
 466         raise NotImplementedError
 467
 468     def visitAlias(self, alias, *args, **kwargs):
 469         raise NotImplementedError
 470
 471     def visitOpaque(self, opaque, *args, **kwargs):
 472         raise NotImplementedError
 473
 474     def visitInterface(self, interface, *args, **kwargs):
 475         raise NotImplementedError
 476
 477     def visitPolymorphic(self, polymorphic, *args, **kwargs):
 478         raise NotImplementedError
 479         #return self.visit(polymorphic.defaultType, *args, **kwargs)
 480
 481
 482 class OnceVisitor(Visitor):
 483     '''Visitor that guarantees that each type is visited only once.'''
 484
 485     def __init__(self):
 486         self.__visited = set()
 487
 488     def visit(self, type, *args, **kwargs):
 489         if type not in self.__visited:
 490             self.__visited.add(type)
 491             return type.visit(self, *args, **kwargs)
 492         return None
 493
 494
 495 class Rebuilder(Visitor):
 496     '''Visitor which rebuild types as it visits them.
 497
 498     By itself it is a no-op -- it is intended to be overwritten.
 499     '''
 500
 501     def visitVoid(self, void):
 502         return void
 503
 504     def visitLiteral(self, literal):
 505         return literal
 506
 507     def visitString(self, string):
 508         return string
 509
 510     def visitConst(self, const):
 511         return Const(const.type)
 512
 513     def visitStruct(self, struct):
 514         members = [(self.visit(type), name) for type, name in struct.members]
 515         return Struct(struct.name, members)
 516
 517     def visitArray(self, array):
 518         type = self.visit(array.type)
 519         return Array(type, array.length)
 520
 521     def visitBlob(self, blob):
 522         type = self.visit(blob.type)
 523         return Blob(type, blob.size)
 524
 525     def visitEnum(self, enum):
 526         return enum
 527
 528     def visitBitmask(self, bitmask):
 529         type = self.visit(bitmask.type)
 530         return Bitmask(type, bitmask.values)
 531
 532     def visitPointer(self, pointer):
 533         type = self.visit(pointer.type)
 534         return Pointer(type)
 535
 536     def visitIntPointer(self, pointer):
 537         return pointer
 538
 539     def visitLinearPointer(self, pointer):
 540         type = self.visit(pointer.type)
 541         return LinearPointer(type, pointer.size)
 542
 543     def visitHandle(self, handle):
 544         type = self.visit(handle.type)
 545         return Handle(handle.name, type, range=handle.range, key=handle.key)
 546
 547     def visitAlias(self, alias):
 548         type = self.visit(alias.type)
 549         return Alias(alias.expr, type)
 550
 551     def visitOpaque(self, opaque):
 552         return opaque
 553
 554     def visitInterface(self, interface, *args, **kwargs):
 555         return interface
 556
 557     def visitPolymorphic(self, polymorphic):
 558         defaultType = self.visit(polymorphic.defaultType)
 559         switchExpr = polymorphic.switchExpr
 560         switchTypes = [(expr, self.visit(type)) for expr, type in polymorphic.switchTypes]
 561         return Polymorphic(defaultType, switchExpr, switchTypes)
 562
 563
 564 class Collector(Visitor):
 565     '''Visitor which collects all unique types as it traverses them.'''
 566
 567     def __init__(self):
 568         self.__visited = set()
 569         self.types = []
 570
 571     def visit(self, type):
 572         if type in self.__visited:
 573             return
 574         self.__visited.add(type)
 575         Visitor.visit(self, type)
 576         self.types.append(type)
 577
 578     def visitVoid(self, literal):
 579         pass
 580
 581     def visitLiteral(self, literal):
 582         pass
 583
 584     def visitString(self, string):
 585         pass
 586
 587     def visitConst(self, const):
 588         self.visit(const.type)
 589
 590     def visitStruct(self, struct):
 591         for type, name in struct.members:
 592             self.visit(type)
 593
 594     def visitArray(self, array):
 595         self.visit(array.type)
 596
 597     def visitBlob(self, array):
 598         pass
 599
 600     def visitEnum(self, enum):
 601         pass
 602
 603     def visitBitmask(self, bitmask):
 604         self.visit(bitmask.type)
 605
 606     def visitPointer(self, pointer):
 607         self.visit(pointer.type)
 608
 609     def visitIntPointer(self, pointer):
 610         pass
 611
 612     def visitLinearPointer(self, pointer):
 613         self.visit(pointer.type)
 614
 615     def visitHandle(self, handle):
 616         self.visit(handle.type)
 617
 618     def visitAlias(self, alias):
 619         self.visit(alias.type)
 620
 621     def visitOpaque(self, opaque):
 622         pass
 623
 624     def visitInterface(self, interface):
 625         if interface.base is not None:
 626             self.visit(interface.base)
 627         for method in interface.iterMethods():
 628             for arg in method.args:
 629                 self.visit(arg.type)
 630             self.visit(method.type)
 631
 632     def visitPolymorphic(self, polymorphic):
 633         self.visit(polymorphic.defaultType)
 634         for expr, type in polymorphic.switchTypes:
 635             self.visit(type)
 636
 637
 638 class API:
 639     '''API abstraction.
 640
 641     Essentially, a collection of types, functions, and interfaces.
 642     '''
 643
 644     def __init__(self, name = None):
 645         self.name = name
 646         self.headers = []
 647         self.functions = []
 648         self.interfaces = []
 649
 650     def getAllTypes(self):
 651         collector = Collector()
 652         for function in self.functions:
 653             for arg in function.args:
 654                 collector.visit(arg.type)
 655             collector.visit(function.type)
 656         for interface in self.interfaces:
 657             collector.visit(interface)
 658             for method in interface.iterMethods():
 659                 for arg in method.args:
 660                     collector.visit(arg.type)
 661                 collector.visit(method.type)
 662         return collector.types
 663
 664     def getAllInterfaces(self):
 665         types = self.getAllTypes()
 666         interfaces = [type for type in types if isinstance(type, Interface)]
 667         for interface in self.interfaces:
 668             if interface not in interfaces:
 669                 interfaces.append(interface)
 670         return interfaces
 671
 672     def addFunction(self, function):
 673         self.functions.append(function)
 674
 675     def addFunctions(self, functions):
 676         for function in functions:
 677             self.addFunction(function)
 678
 679     def addInterface(self, interface):
 680         self.interfaces.append(interface)
 681
 682     def addInterfaces(self, interfaces):
 683         self.interfaces.extend(interfaces)
 684
 685     def addApi(self, api):
 686         self.headers.extend(api.headers)
 687         self.addFunctions(api.functions)
 688         self.addInterfaces(api.interfaces)
 689
 690     def get_function_by_name(self, name):
 691         for function in self.functions:
 692             if function.name == name:
 693                 return function
 694         return None
 695
 696
 697 Bool = Literal("bool", "Bool")
 698 SChar = Literal("signed char", "SInt")
 699 UChar = Literal("unsigned char", "UInt")
 700 Short = Literal("short", "SInt")
 701 Int = Literal("int", "SInt")
 702 Long = Literal("long", "SInt")
 703 LongLong = Literal("long long", "SInt")
 704 UShort = Literal("unsigned short", "UInt")
 705 UInt = Literal("unsigned int", "UInt")
 706 ULong = Literal("unsigned long", "UInt")
 707 ULongLong = Literal("unsigned long long", "UInt")
 708 Float = Literal("float", "Float")
 709 Double = Literal("double", "Double")
 710 SizeT = Literal("size_t", "UInt")
 711 WString = Literal("wchar_t *", "WString")
 712
 713 Int8 = Literal("int8_t", "SInt")
 714 UInt8 = Literal("uint8_t", "UInt")
 715 Int16 = Literal("int16_t", "SInt")
 716 UInt16 = Literal("uint16_t", "UInt")
 717 Int32 = Literal("int32_t", "SInt")
 718 UInt32 = Literal("uint32_t", "UInt")
 719 Int64 = Literal("int64_t", "SInt")
 720 UInt64 = Literal("uint64_t", "UInt")