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.visit_void(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.visit_literal(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.visit_const(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.visit_pointer(self, *args, **kwargs)
 128
 129
 130 class Handle(Type):
 131
 132     def __init__(self, name, type, range=None, key=None):
 133         Type.__init__(self, type.expr, 'P' + type.tag)
 134         self.name = name
 135         self.type = type
 136         self.range = range
 137         self.key = key
 138
 139     def visit(self, visitor, *args, **kwargs):
 140         return visitor.visit_handle(self, *args, **kwargs)
 141
 142
 143 def ConstPointer(type):
 144     return Pointer(Const(type))
 145
 146
 147 class Enum(Type):
 148
 149     __id = 0
 150
 151     def __init__(self, name, values):
 152         Type.__init__(self, name)
 153
 154         self.id = Enum.__id
 155         Enum.__id += 1
 156
 157         self.values = list(values)
 158
 159     def visit(self, visitor, *args, **kwargs):
 160         return visitor.visit_enum(self, *args, **kwargs)
 161
 162
 163 def FakeEnum(type, values):
 164     return Enum(type.expr, values)
 165
 166
 167 class Bitmask(Type):
 168
 169     __id = 0
 170
 171     def __init__(self, type, values):
 172         Type.__init__(self, type.expr)
 173
 174         self.id = Bitmask.__id
 175         Bitmask.__id += 1
 176
 177         self.type = type
 178         self.values = values
 179
 180     def visit(self, visitor, *args, **kwargs):
 181         return visitor.visit_bitmask(self, *args, **kwargs)
 182
 183 Flags = Bitmask
 184
 185
 186 class Array(Type):
 187
 188     def __init__(self, type, length):
 189         Type.__init__(self, type.expr + " *")
 190         self.type = type
 191         self.length = length
 192
 193     def visit(self, visitor, *args, **kwargs):
 194         return visitor.visit_array(self, *args, **kwargs)
 195
 196
 197 class Blob(Type):
 198
 199     def __init__(self, type, size):
 200         Type.__init__(self, type.expr + ' *')
 201         self.type = type
 202         self.size = size
 203
 204     def visit(self, visitor, *args, **kwargs):
 205         return visitor.visit_blob(self, *args, **kwargs)
 206
 207
 208 class Struct(Type):
 209
 210     __id = 0
 211
 212     def __init__(self, name, members):
 213         Type.__init__(self, name)
 214
 215         self.id = Struct.__id
 216         Struct.__id += 1
 217
 218         self.name = name
 219         self.members = members
 220
 221     def visit(self, visitor, *args, **kwargs):
 222         return visitor.visit_struct(self, *args, **kwargs)
 223
 224
 225 class Alias(Type):
 226
 227     def __init__(self, expr, type):
 228         Type.__init__(self, expr)
 229         self.type = type
 230
 231     def visit(self, visitor, *args, **kwargs):
 232         return visitor.visit_alias(self, *args, **kwargs)
 233
 234
 235 def Out(type, name):
 236     arg = Arg(type, name, output=True)
 237     return arg
 238
 239
 240 class Arg:
 241
 242     def __init__(self, type, name, output=False):
 243         self.type = type
 244         self.name = name
 245         self.output = output
 246         self.index = None
 247
 248     def __str__(self):
 249         return '%s %s' % (self.type, self.name)
 250
 251
 252 class Function:
 253
 254     # 0-3 are reserved to memcpy, malloc, free, and realloc
 255     __id = 4
 256
 257     def __init__(self, type, name, args, call = '', fail = None, sideeffects=True):
 258         self.id = Function.__id
 259         Function.__id += 1
 260
 261         self.type = type
 262         self.name = name
 263
 264         self.args = []
 265         index = 0
 266         for arg in args:
 267             if not isinstance(arg, Arg):
 268                 if isinstance(arg, tuple):
 269                     arg_type, arg_name = arg
 270                 else:
 271                     arg_type = arg
 272                     arg_name = "arg%u" % index
 273                 arg = Arg(arg_type, arg_name)
 274             arg.index = index
 275             index += 1
 276             self.args.append(arg)
 277
 278         self.call = call
 279         self.fail = fail
 280         self.sideeffects = sideeffects
 281
 282     def prototype(self, name=None):
 283         if name is not None:
 284             name = name.strip()
 285         else:
 286             name = self.name
 287         s = name
 288         if self.call:
 289             s = self.call + ' ' + s
 290         if name.startswith('*'):
 291             s = '(' + s + ')'
 292         s = self.type.expr + ' ' + s
 293         s += "("
 294         if self.args:
 295             s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
 296         else:
 297             s += "void"
 298         s += ")"
 299         return s
 300
 301
 302 def StdFunction(*args, **kwargs):
 303     kwargs.setdefault('call', '__stdcall')
 304     return Function(*args, **kwargs)
 305
 306
 307 def FunctionPointer(type, name, args, **kwargs):
 308     # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
 309     return Opaque(name)
 310
 311
 312 class Interface(Type):
 313
 314     def __init__(self, name, base=None):
 315         Type.__init__(self, name)
 316         self.name = name
 317         self.base = base
 318         self.methods = []
 319
 320     def visit(self, visitor, *args, **kwargs):
 321         return visitor.visit_interface(self, *args, **kwargs)
 322
 323     def itermethods(self):
 324         if self.base is not None:
 325             for method in self.base.itermethods():
 326                 yield method
 327         for method in self.methods:
 328             yield method
 329         raise StopIteration
 330
 331
 332 class Method(Function):
 333
 334     def __init__(self, type, name, args):
 335         Function.__init__(self, type, name, args, call = '__stdcall')
 336         for index in range(len(self.args)):
 337             self.args[index].index = index + 1
 338
 339
 340 class String(Type):
 341
 342     def __init__(self, expr = "char *", length = None):
 343         Type.__init__(self, expr)
 344         self.length = length
 345
 346     def visit(self, visitor, *args, **kwargs):
 347         return visitor.visit_string(self, *args, **kwargs)
 348
 349 # C string (i.e., zero terminated)
 350 CString = String()
 351
 352
 353 class Opaque(Type):
 354     '''Opaque pointer.'''
 355
 356     def __init__(self, expr):
 357         Type.__init__(self, expr)
 358
 359     def visit(self, visitor, *args, **kwargs):
 360         return visitor.visit_opaque(self, *args, **kwargs)
 361
 362
 363 def OpaquePointer(type, *args):
 364     return Opaque(type.expr + ' *')
 365
 366 def OpaqueArray(type, size):
 367     return Opaque(type.expr + ' *')
 368
 369 def OpaqueBlob(type, size):
 370     return Opaque(type.expr + ' *')
 371
 372
 373 class Polymorphic(Type):
 374
 375     def __init__(self, default_type, switch_expr, switch_types):
 376         Type.__init__(self, default_type.expr)
 377         self.default_type = default_type
 378         self.switch_expr = switch_expr
 379         self.switch_types = switch_types
 380
 381     def visit(self, visitor, *args, **kwargs):
 382         return visitor.visit_polymorphic(self, *args, **kwargs)
 383
 384     def iterswitch(self):
 385         cases = [['default']]
 386         types = [self.default_type]
 387
 388         for expr, type in self.switch_types:
 389             case = 'case %s' % expr
 390             try:
 391                 i = types.index(type)
 392             except ValueError:
 393                 cases.append([case])
 394                 types.append(type)
 395             else:
 396                 cases[i].append(case)
 397
 398         return zip(cases, types)
 399
 400
 401 class Visitor:
 402     '''Abstract visitor for the type hierarchy.'''
 403
 404     def visit(self, type, *args, **kwargs):
 405         return type.visit(self, *args, **kwargs)
 406
 407     def visit_void(self, void, *args, **kwargs):
 408         raise NotImplementedError
 409
 410     def visit_literal(self, literal, *args, **kwargs):
 411         raise NotImplementedError
 412
 413     def visit_string(self, string, *args, **kwargs):
 414         raise NotImplementedError
 415
 416     def visit_const(self, const, *args, **kwargs):
 417         raise NotImplementedError
 418
 419     def visit_struct(self, struct, *args, **kwargs):
 420         raise NotImplementedError
 421
 422     def visit_array(self, array, *args, **kwargs):
 423         raise NotImplementedError
 424
 425     def visit_blob(self, blob, *args, **kwargs):
 426         raise NotImplementedError
 427
 428     def visit_enum(self, enum, *args, **kwargs):
 429         raise NotImplementedError
 430
 431     def visit_bitmask(self, bitmask, *args, **kwargs):
 432         raise NotImplementedError
 433
 434     def visit_pointer(self, pointer, *args, **kwargs):
 435         raise NotImplementedError
 436
 437     def visit_handle(self, handle, *args, **kwargs):
 438         raise NotImplementedError
 439
 440     def visit_alias(self, alias, *args, **kwargs):
 441         raise NotImplementedError
 442
 443     def visit_opaque(self, opaque, *args, **kwargs):
 444         raise NotImplementedError
 445
 446     def visit_interface(self, interface, *args, **kwargs):
 447         raise NotImplementedError
 448
 449     def visit_polymorphic(self, polymorphic, *args, **kwargs):
 450         raise NotImplementedError
 451         #return self.visit(polymorphic.default_type, *args, **kwargs)
 452
 453
 454 class OnceVisitor(Visitor):
 455     '''Visitor that guarantees that each type is visited only once.'''
 456
 457     def __init__(self):
 458         self.__visited = set()
 459
 460     def visit(self, type, *args, **kwargs):
 461         if type not in self.__visited:
 462             self.__visited.add(type)
 463             return type.visit(self, *args, **kwargs)
 464         return None
 465
 466
 467 class Rebuilder(Visitor):
 468     '''Visitor which rebuild types as it visits them.
 469
 470     By itself it is a no-op -- it is intended to be overwritten.
 471     '''
 472
 473     def visit_void(self, void):
 474         return void
 475
 476     def visit_literal(self, literal):
 477         return literal
 478
 479     def visit_string(self, string):
 480         return string
 481
 482     def visit_const(self, const):
 483         return Const(const.type)
 484
 485     def visit_struct(self, struct):
 486         members = [(self.visit(type), name) for type, name in struct.members]
 487         return Struct(struct.name, members)
 488
 489     def visit_array(self, array):
 490         type = self.visit(array.type)
 491         return Array(type, array.length)
 492
 493     def visit_blob(self, blob):
 494         type = self.visit(blob.type)
 495         return Blob(type, blob.size)
 496
 497     def visit_enum(self, enum):
 498         return enum
 499
 500     def visit_bitmask(self, bitmask):
 501         type = self.visit(bitmask.type)
 502         return Bitmask(type, bitmask.values)
 503
 504     def visit_pointer(self, pointer):
 505         type = self.visit(pointer.type)
 506         return Pointer(type)
 507
 508     def visit_handle(self, handle):
 509         type = self.visit(handle.type)
 510         return Handle(handle.name, type, range=handle.range, key=handle.key)
 511
 512     def visit_alias(self, alias):
 513         type = self.visit(alias.type)
 514         return Alias(alias.expr, type)
 515
 516     def visit_opaque(self, opaque):
 517         return opaque
 518
 519     def visit_polymorphic(self, polymorphic):
 520         default_type = self.visit(polymorphic.default_type)
 521         switch_expr = polymorphic.switch_expr
 522         switch_types = [(expr, self.visit(type)) for expr, type in polymorphic.switch_types]
 523         return Polymorphic(default_type, switch_expr, switch_types)
 524
 525
 526 class Collector(Visitor):
 527     '''Visitor which collects all unique types as it traverses them.'''
 528
 529     def __init__(self):
 530         self.__visited = set()
 531         self.types = []
 532
 533     def visit(self, type):
 534         if type in self.__visited:
 535             return
 536         self.__visited.add(type)
 537         Visitor.visit(self, type)
 538         self.types.append(type)
 539
 540     def visit_void(self, literal):
 541         pass
 542
 543     def visit_literal(self, literal):
 544         pass
 545
 546     def visit_string(self, string):
 547         pass
 548
 549     def visit_const(self, const):
 550         self.visit(const.type)
 551
 552     def visit_struct(self, struct):
 553         for type, name in struct.members:
 554             self.visit(type)
 555
 556     def visit_array(self, array):
 557         self.visit(array.type)
 558
 559     def visit_blob(self, array):
 560         pass
 561
 562     def visit_enum(self, enum):
 563         pass
 564
 565     def visit_bitmask(self, bitmask):
 566         self.visit(bitmask.type)
 567
 568     def visit_pointer(self, pointer):
 569         self.visit(pointer.type)
 570
 571     def visit_handle(self, handle):
 572         self.visit(handle.type)
 573
 574     def visit_alias(self, alias):
 575         self.visit(alias.type)
 576
 577     def visit_opaque(self, opaque):
 578         pass
 579
 580     def visit_interface(self, interface):
 581         if interface.base is not None:
 582             self.visit(interface.base)
 583         for method in interface.itermethods():
 584             for arg in method.args:
 585                 self.visit(arg.type)
 586             self.visit(method.type)
 587
 588     def visit_polymorphic(self, polymorphic):
 589         self.visit(polymorphic.default_type)
 590         for expr, type in polymorphic.switch_types:
 591             self.visit(type)
 592
 593
 594 class API:
 595     '''API abstraction.
 596
 597     Essentially, a collection of types, functions, and interfaces.
 598     '''
 599
 600     def __init__(self, name = None):
 601         self.name = name
 602         self.headers = []
 603         self.functions = []
 604         self.interfaces = []
 605
 606     def all_types(self):
 607         collector = Collector()
 608         for function in self.functions:
 609             for arg in function.args:
 610                 collector.visit(arg.type)
 611             collector.visit(function.type)
 612         for interface in self.interfaces:
 613             collector.visit(interface)
 614             for method in interface.itermethods():
 615                 for arg in method.args:
 616                     collector.visit(arg.type)
 617                 collector.visit(method.type)
 618         return collector.types
 619
 620     def add_function(self, function):
 621         self.functions.append(function)
 622
 623     def add_functions(self, functions):
 624         for function in functions:
 625             self.add_function(function)
 626
 627     def add_interface(self, interface):
 628         self.interfaces.append(interface)
 629
 630     def add_interfaces(self, interfaces):
 631         self.interfaces.extend(interfaces)
 632
 633     def add_api(self, api):
 634         self.headers.extend(api.headers)
 635         self.add_functions(api.functions)
 636         self.add_interfaces(api.interfaces)
 637
 638     def get_function_by_name(self, name):
 639         for function in self.functions:
 640             if function.name == name:
 641                 return function
 642         return None
 643
 644
 645 Bool = Literal("bool", "Bool")
 646 SChar = Literal("signed char", "SInt")
 647 UChar = Literal("unsigned char", "UInt")
 648 Short = Literal("short", "SInt")
 649 Int = Literal("int", "SInt")
 650 Long = Literal("long", "SInt")
 651 LongLong = Literal("long long", "SInt")
 652 UShort = Literal("unsigned short", "UInt")
 653 UInt = Literal("unsigned int", "UInt")
 654 ULong = Literal("unsigned long", "UInt")
 655 ULongLong = Literal("unsigned long long", "UInt")
 656 Float = Literal("float", "Float")
 657 Double = Literal("double", "Double")
 658 SizeT = Literal("size_t", "UInt")
 659 WString = Literal("wchar_t *", "WString")
 660
 661 Int8 = Literal("int8_t", "SInt")
 662 UInt8 = Literal("uint8_t", "UInt")
 663 Int16 = Literal("int16_t", "SInt")
 664 UInt16 = Literal("uint16_t", "UInt")
 665 Int32 = Literal("int32_t", "SInt")
 666 UInt32 = Literal("uint32_t", "UInt")
 667 Int64 = Literal("int64_t", "SInt")
 668 UInt64 = Literal("uint64_t", "UInt")