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

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