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
  34     __all = {}
  35     __seq = 0
  36
  37     def __init__(self, expr, id = ''):
  38         self.expr = expr
  39
  40         for char in id:
  41             assert char.isalnum() or char in '_ '
  42
  43         id = id.replace(' ', '_')
  44
  45         if id in Type.__all:
  46             Type.__seq += 1
  47             id += str(Type.__seq)
  48
  49         assert id not in Type.__all
  50         Type.__all[id] = self
  51
  52         self.id = id
  53
  54     def __str__(self):
  55         return self.expr
  56
  57     def visit(self, visitor, *args, **kwargs):
  58         raise NotImplementedError
  59
  60
  61
  62 class _Void(Type):
  63
  64     def __init__(self):
  65         Type.__init__(self, "void")
  66
  67     def visit(self, visitor, *args, **kwargs):
  68         return visitor.visit_void(self, *args, **kwargs)
  69
  70 Void = _Void()
  71
  72
  73 class Literal(Type):
  74
  75     def __init__(self, expr, format, base=10):
  76         Type.__init__(self, expr)
  77         self.format = format
  78
  79     def visit(self, visitor, *args, **kwargs):
  80         return visitor.visit_literal(self, *args, **kwargs)
  81
  82
  83 class Const(Type):
  84
  85     def __init__(self, type):
  86         # While "const foo" and "foo const" are synonymous, "const foo *" and
  87         # "foo * const" are not quite the same, and some compilers do enforce
  88         # strict const correctness.
  89         if isinstance(type, String) or type is WString:
  90             # For strings we never intend to say a const pointer to chars, but
  91             # rather a point to const chars.
  92             expr = "const " + type.expr
  93         elif type.expr.startswith("const ") or '*' in type.expr:
  94             expr = type.expr + " const"
  95         else:
  96             # The most legible
  97             expr = "const " + type.expr
  98
  99         Type.__init__(self, expr, 'C' + type.id)
 100
 101         self.type = type
 102
 103     def visit(self, visitor, *args, **kwargs):
 104         return visitor.visit_const(self, *args, **kwargs)
 105
 106
 107 class Pointer(Type):
 108
 109     def __init__(self, type):
 110         Type.__init__(self, type.expr + " *", 'P' + type.id)
 111         self.type = type
 112
 113     def visit(self, visitor, *args, **kwargs):
 114         return visitor.visit_pointer(self, *args, **kwargs)
 115
 116
 117 class Handle(Type):
 118
 119     def __init__(self, name, type, range=None, key=None):
 120         Type.__init__(self, type.expr, 'P' + type.id)
 121         self.name = name
 122         self.type = type
 123         self.range = range
 124         self.key = key
 125
 126     def visit(self, visitor, *args, **kwargs):
 127         return visitor.visit_handle(self, *args, **kwargs)
 128
 129
 130 def ConstPointer(type):
 131     return Pointer(Const(type))
 132
 133
 134 class Enum(Type):
 135
 136     def __init__(self, name, values):
 137         Type.__init__(self, name)
 138         self.values = list(values)
 139
 140     def visit(self, visitor, *args, **kwargs):
 141         return visitor.visit_enum(self, *args, **kwargs)
 142
 143
 144 def FakeEnum(type, values):
 145     return Enum(type.expr, values)
 146
 147
 148 class Bitmask(Type):
 149
 150     def __init__(self, type, values):
 151         Type.__init__(self, type.expr)
 152         self.type = type
 153         self.values = values
 154
 155     def visit(self, visitor, *args, **kwargs):
 156         return visitor.visit_bitmask(self, *args, **kwargs)
 157
 158 Flags = Bitmask
 159
 160
 161 class Array(Type):
 162
 163     def __init__(self, type, length):
 164         Type.__init__(self, type.expr + " *")
 165         self.type = type
 166         self.length = length
 167
 168     def visit(self, visitor, *args, **kwargs):
 169         return visitor.visit_array(self, *args, **kwargs)
 170
 171
 172 class Blob(Type):
 173
 174     def __init__(self, type, size):
 175         Type.__init__(self, type.expr + ' *')
 176         self.type = type
 177         self.size = size
 178
 179     def visit(self, visitor, *args, **kwargs):
 180         return visitor.visit_blob(self, *args, **kwargs)
 181
 182
 183 class Struct(Type):
 184
 185     def __init__(self, name, members):
 186         Type.__init__(self, name)
 187         self.name = name
 188         self.members = members
 189
 190     def visit(self, visitor, *args, **kwargs):
 191         return visitor.visit_struct(self, *args, **kwargs)
 192
 193
 194 class Alias(Type):
 195
 196     def __init__(self, expr, type):
 197         Type.__init__(self, expr)
 198         self.type = type
 199
 200     def visit(self, visitor, *args, **kwargs):
 201         return visitor.visit_alias(self, *args, **kwargs)
 202
 203
 204 def Out(type, name):
 205     arg = Arg(type, name, output=True)
 206     return arg
 207
 208
 209 class Arg:
 210
 211     def __init__(self, type, name, output=False):
 212         self.type = type
 213         self.name = name
 214         self.output = output
 215         self.index = None
 216
 217     def __str__(self):
 218         return '%s %s' % (self.type, self.name)
 219
 220
 221 class Function:
 222
 223     __id = 0
 224
 225     def __init__(self, type, name, args, call = '', fail = None, sideeffects=True):
 226         self.id = Function.__id
 227         Function.__id += 1
 228
 229         self.type = type
 230         self.name = name
 231
 232         self.args = []
 233         index = 0
 234         for arg in args:
 235             if not isinstance(arg, Arg):
 236                 if isinstance(arg, tuple):
 237                     arg_type, arg_name = arg
 238                 else:
 239                     arg_type = arg
 240                     arg_name = "arg%u" % index
 241                 arg = Arg(arg_type, arg_name)
 242             arg.index = index
 243             index += 1
 244             self.args.append(arg)
 245
 246         self.call = call
 247         self.fail = fail
 248         self.sideeffects = sideeffects
 249
 250     def prototype(self, name=None):
 251         if name is not None:
 252             name = name.strip()
 253         else:
 254             name = self.name
 255         s = name
 256         if self.call:
 257             s = self.call + ' ' + s
 258         if name.startswith('*'):
 259             s = '(' + s + ')'
 260         s = self.type.expr + ' ' + s
 261         s += "("
 262         if self.args:
 263             s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
 264         else:
 265             s += "void"
 266         s += ")"
 267         return s
 268
 269
 270 def StdFunction(*args, **kwargs):
 271     kwargs.setdefault('call', '__stdcall')
 272     return Function(*args, **kwargs)
 273
 274
 275 def FunctionPointer(type, name, args, **kwargs):
 276     # XXX: We should probably treat function pointers (callbacks or not) in a generic fashion
 277     return Opaque(name)
 278
 279
 280 class Interface(Type):
 281
 282     def __init__(self, name, base=None):
 283         Type.__init__(self, name)
 284         self.name = name
 285         self.base = base
 286         self.methods = []
 287
 288     def visit(self, visitor, *args, **kwargs):
 289         return visitor.visit_interface(self, *args, **kwargs)
 290
 291     def itermethods(self):
 292         if self.base is not None:
 293             for method in self.base.itermethods():
 294                 yield method
 295         for method in self.methods:
 296             yield method
 297         raise StopIteration
 298
 299
 300 class Method(Function):
 301
 302     def __init__(self, type, name, args):
 303         Function.__init__(self, type, name, args, call = '__stdcall')
 304         for index in range(len(self.args)):
 305             self.args[index].index = index + 1
 306
 307
 308 def WrapPointer(type):
 309     return Pointer(type)
 310
 311
 312 class String(Type):
 313
 314     def __init__(self, expr = "char *", length = None):
 315         Type.__init__(self, expr)
 316         self.length = length
 317
 318     def visit(self, visitor, *args, **kwargs):
 319         return visitor.visit_string(self, *args, **kwargs)
 320
 321 # C string (i.e., zero terminated)
 322 CString = String()
 323
 324
 325 class Opaque(Type):
 326     '''Opaque pointer.'''
 327
 328     def __init__(self, expr):
 329         Type.__init__(self, expr)
 330
 331     def visit(self, visitor, *args, **kwargs):
 332         return visitor.visit_opaque(self, *args, **kwargs)
 333
 334
 335 def OpaquePointer(type, *args):
 336     return Opaque(type.expr + ' *')
 337
 338 def OpaqueArray(type, size):
 339     return Opaque(type.expr + ' *')
 340
 341 def OpaqueBlob(type, size):
 342     return Opaque(type.expr + ' *')
 343
 344
 345 class Visitor:
 346
 347     def visit(self, type, *args, **kwargs):
 348         return type.visit(self, *args, **kwargs)
 349
 350     def visit_void(self, void, *args, **kwargs):
 351         raise NotImplementedError
 352
 353     def visit_literal(self, literal, *args, **kwargs):
 354         raise NotImplementedError
 355
 356     def visit_string(self, string, *args, **kwargs):
 357         raise NotImplementedError
 358
 359     def visit_const(self, const, *args, **kwargs):
 360         raise NotImplementedError
 361
 362     def visit_struct(self, struct, *args, **kwargs):
 363         raise NotImplementedError
 364
 365     def visit_array(self, array, *args, **kwargs):
 366         raise NotImplementedError
 367
 368     def visit_blob(self, blob, *args, **kwargs):
 369         raise NotImplementedError
 370
 371     def visit_enum(self, enum, *args, **kwargs):
 372         raise NotImplementedError
 373
 374     def visit_bitmask(self, bitmask, *args, **kwargs):
 375         raise NotImplementedError
 376
 377     def visit_pointer(self, pointer, *args, **kwargs):
 378         raise NotImplementedError
 379
 380     def visit_handle(self, handle, *args, **kwargs):
 381         raise NotImplementedError
 382
 383     def visit_alias(self, alias, *args, **kwargs):
 384         raise NotImplementedError
 385
 386     def visit_opaque(self, opaque, *args, **kwargs):
 387         raise NotImplementedError
 388
 389     def visit_interface(self, interface, *args, **kwargs):
 390         raise NotImplementedError
 391
 392
 393 class OnceVisitor(Visitor):
 394
 395     def __init__(self):
 396         self.__visited = set()
 397
 398     def visit(self, type, *args, **kwargs):
 399         if type not in self.__visited:
 400             self.__visited.add(type)
 401             return type.visit(self, *args, **kwargs)
 402         return None
 403
 404
 405 class Rebuilder(Visitor):
 406
 407     def visit_void(self, void):
 408         return void
 409
 410     def visit_literal(self, literal):
 411         return literal
 412
 413     def visit_string(self, string):
 414         return string
 415
 416     def visit_const(self, const):
 417         return Const(const.type)
 418
 419     def visit_struct(self, struct):
 420         members = [(self.visit(type), name) for type, name in struct.members]
 421         return Struct(struct.name, members)
 422
 423     def visit_array(self, array):
 424         type = self.visit(array.type)
 425         return Array(type, array.length)
 426
 427     def visit_blob(self, blob):
 428         type = self.visit(blob.type)
 429         return Blob(type, blob.size)
 430
 431     def visit_enum(self, enum):
 432         return enum
 433
 434     def visit_bitmask(self, bitmask):
 435         type = self.visit(bitmask.type)
 436         return Bitmask(type, bitmask.values)
 437
 438     def visit_pointer(self, pointer):
 439         type = self.visit(pointer.type)
 440         return Pointer(type)
 441
 442     def visit_handle(self, handle):
 443         type = self.visit(handle.type)
 444         return Handle(handle.name, type, range=handle.range, key=handle.key)
 445
 446     def visit_alias(self, alias):
 447         type = self.visit(alias.type)
 448         return Alias(alias.expr, type)
 449
 450     def visit_opaque(self, opaque):
 451         return opaque
 452
 453
 454 class Collector(Visitor):
 455     '''Collect.'''
 456
 457     def __init__(self):
 458         self.__visited = set()
 459         self.types = []
 460
 461     def visit(self, type):
 462         if type in self.__visited:
 463             return
 464         self.__visited.add(type)
 465         Visitor.visit(self, type)
 466         self.types.append(type)
 467
 468     def visit_void(self, literal):
 469         pass
 470
 471     def visit_literal(self, literal):
 472         pass
 473
 474     def visit_string(self, string):
 475         pass
 476
 477     def visit_const(self, const):
 478         self.visit(const.type)
 479
 480     def visit_struct(self, struct):
 481         for type, name in struct.members:
 482             self.visit(type)
 483
 484     def visit_array(self, array):
 485         self.visit(array.type)
 486
 487     def visit_blob(self, array):
 488         pass
 489
 490     def visit_enum(self, enum):
 491         pass
 492
 493     def visit_bitmask(self, bitmask):
 494         self.visit(bitmask.type)
 495
 496     def visit_pointer(self, pointer):
 497         self.visit(pointer.type)
 498
 499     def visit_handle(self, handle):
 500         self.visit(handle.type)
 501
 502     def visit_alias(self, alias):
 503         self.visit(alias.type)
 504
 505     def visit_opaque(self, opaque):
 506         pass
 507
 508     def visit_interface(self, interface):
 509         if interface.base is not None:
 510             self.visit(interface.base)
 511         for method in interface.itermethods():
 512             for arg in method.args:
 513                 self.visit(arg.type)
 514             self.visit(method.type)
 515
 516
 517 class API:
 518
 519     def __init__(self, name = None):
 520         self.name = name
 521         self.headers = []
 522         self.functions = []
 523         self.interfaces = []
 524
 525     def all_types(self):
 526         collector = Collector()
 527         for function in self.functions:
 528             for arg in function.args:
 529                 collector.visit(arg.type)
 530             collector.visit(function.type)
 531         for interface in self.interfaces:
 532             collector.visit(interface)
 533             for method in interface.itermethods():
 534                 for arg in method.args:
 535                     collector.visit(arg.type)
 536                 collector.visit(method.type)
 537         return collector.types
 538
 539     def add_function(self, function):
 540         self.functions.append(function)
 541
 542     def add_functions(self, functions):
 543         for function in functions:
 544             self.add_function(function)
 545
 546     def add_interface(self, interface):
 547         self.interfaces.append(interface)
 548
 549     def add_interfaces(self, interfaces):
 550         self.interfaces.extend(interfaces)
 551
 552     def add_api(self, api):
 553         self.headers.extend(api.headers)
 554         self.add_functions(api.functions)
 555         self.add_interfaces(api.interfaces)
 556
 557     def get_function_by_name(self, name):
 558         for function in self.functions:
 559             if function.name == name:
 560                 return function
 561         return None
 562
 563
 564 Bool = Literal("bool", "Bool")
 565 SChar = Literal("signed char", "SInt")
 566 UChar = Literal("unsigned char", "UInt")
 567 Short = Literal("short", "SInt")
 568 Int = Literal("int", "SInt")
 569 Long = Literal("long", "SInt")
 570 LongLong = Literal("long long", "SInt")
 571 UShort = Literal("unsigned short", "UInt")
 572 UInt = Literal("unsigned int", "UInt")
 573 ULong = Literal("unsigned long", "UInt")
 574 ULongLong = Literal("unsigned long long", "UInt")
 575 Float = Literal("float", "Float")
 576 Double = Literal("double", "Double")
 577 SizeT = Literal("size_t", "UInt")
 578 WString = Literal("wchar_t *", "WString")
 579
 580 Int8 = Literal("int8_t", "SInt")
 581 UInt8 = Literal("uint8_t", "UInt")
 582 Int16 = Literal("int16_t", "SInt")
 583 UInt16 = Literal("uint16_t", "UInt")
 584 Int32 = Literal("int32_t", "SInt")
 585 UInt32 = Literal("uint32_t", "UInt")
 586 Int64 = Literal("int64_t", "SInt")
 587 UInt64 = Literal("uint64_t", "UInt")