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 visit(self, visitor, *args, **kwargs):
 411         return visitor.visit_interface(self, *args, **kwargs)
 412
 413     def itermethods(self):
 414         if self.base is not None:
 415             for method in self.base.itermethods():
 416                 yield method
 417         for method in self.methods:
 418             yield method
 419         raise StopIteration
 420
 421
 422 class Method(Function):
 423
 424     def __init__(self, type, name, args):
 425         Function.__init__(self, type, name, args, call = '__stdcall')
 426         for index in range(len(self.args)):
 427             self.args[index].index = index + 1
 428
 429 towrap = []
 430
 431
 432 def WrapPointer(type):
 433     return Pointer(type)
 434
 435
 436 class String(Type):
 437
 438     def __init__(self, expr = "char *", length = None):
 439         Type.__init__(self, expr)
 440         self.length = length
 441
 442     def visit(self, visitor, *args, **kwargs):
 443         return visitor.visit_string(self, *args, **kwargs)
 444
 445 CString = String()
 446
 447
 448 class Opaque(Type):
 449     '''Opaque pointer.'''
 450
 451     def __init__(self, expr):
 452         Type.__init__(self, expr)
 453
 454     def visit(self, visitor, *args, **kwargs):
 455         return visitor.visit_opaque(self, *args, **kwargs)
 456
 457
 458 def OpaquePointer(type, *args):
 459     return Opaque(type.expr + ' *')
 460
 461 def OpaqueArray(type, size):
 462     return Opaque(type.expr + ' *')
 463
 464 def OpaqueBlob(type, size):
 465     return Opaque(type.expr + ' *')
 466
 467
 468 class Collector(Visitor):
 469     '''Collect.'''
 470
 471     def __init__(self):
 472         self.__visited = set()
 473         self.types = []
 474
 475     def visit(self, type):
 476         if type in self.__visited:
 477             return
 478         self.__visited.add(type)
 479         Visitor.visit(self, type)
 480         self.types.append(type)
 481
 482     def visit_void(self, literal):
 483         pass
 484
 485     def visit_literal(self, literal):
 486         pass
 487
 488     def visit_string(self, string):
 489         pass
 490
 491     def visit_const(self, const):
 492         self.visit(const.type)
 493
 494     def visit_struct(self, struct):
 495         for type, name in struct.members:
 496             self.visit(type)
 497
 498     def visit_array(self, array):
 499         self.visit(array.type)
 500
 501     def visit_blob(self, array):
 502         pass
 503
 504     def visit_enum(self, enum):
 505         pass
 506
 507     def visit_bitmask(self, bitmask):
 508         self.visit(bitmask.type)
 509
 510     def visit_pointer(self, pointer):
 511         self.visit(pointer.type)
 512
 513     def visit_handle(self, handle):
 514         self.visit(handle.type)
 515
 516     def visit_alias(self, alias):
 517         self.visit(alias.type)
 518
 519     def visit_opaque(self, opaque):
 520         pass
 521
 522     def visit_interface(self, interface):
 523         if interface.base is not None:
 524             self.visit(interface.base)
 525         for method in interface.itermethods():
 526             for arg in method.args:
 527                 self.visit(arg.type)
 528             self.visit(method.type)
 529
 530
 531 class API:
 532
 533     def __init__(self, name):
 534         self.name = name
 535         self.headers = []
 536         self.functions = []
 537         self.interfaces = []
 538
 539     def all_types(self):
 540         collector = Collector()
 541         for function in self.functions:
 542             for arg in function.args:
 543                 collector.visit(arg.type)
 544             collector.visit(function.type)
 545         for interface in self.interfaces:
 546             collector.visit(interface)
 547             for method in interface.itermethods():
 548                 for arg in method.args:
 549                     collector.visit(arg.type)
 550                 collector.visit(method.type)
 551         return collector.types
 552
 553     def add_function(self, function):
 554         self.functions.append(function)
 555
 556     def add_functions(self, functions):
 557         for function in functions:
 558             self.add_function(function)
 559
 560     def add_interface(self, interface):
 561         self.interfaces.append(interface)
 562
 563     def add_interfaces(self, interfaces):
 564         self.interfaces.extend(interfaces)
 565
 566
 567 Bool = Literal("bool", "Bool")
 568 SChar = Literal("signed char", "SInt")
 569 UChar = Literal("unsigned char", "UInt")
 570 Short = Literal("short", "SInt")
 571 Int = Literal("int", "SInt")
 572 Long = Literal("long", "SInt")
 573 LongLong = Literal("long long", "SInt")
 574 UShort = Literal("unsigned short", "UInt")
 575 UInt = Literal("unsigned int", "UInt")
 576 ULong = Literal("unsigned long", "UInt")
 577 ULongLong = Literal("unsigned long long", "UInt")
 578 Float = Literal("float", "Float")
 579 Double = Literal("double", "Float")
 580 SizeT = Literal("size_t", "UInt")
 581 WString = Literal("wchar_t *", "WString")
 582
 583 Int8 = Literal("int8_t", "SInt")
 584 UInt8 = Literal("uint8_t", "UInt")
 585 Int16 = Literal("int16_t", "SInt")
 586 UInt16 = Literal("uint16_t", "UInt")
 587 Int32 = Literal("int32_t", "SInt")
 588 UInt32 = Literal("uint32_t", "UInt")
 589 Int64 = Literal("int64_t", "SInt")
 590 UInt64 = Literal("uint64_t", "UInt")