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     def __init__(self, name, values):
 258         Concrete.__init__(self, name)
 259         self.values = values
 260
 261     def visit(self, visitor, *args, **kwargs):
 262         return visitor.visit_enum(self, *args, **kwargs)
 263
 264
 265 def FakeEnum(type, values):
 266     return Enum(type.expr, values)
 267
 268
 269 class Bitmask(Concrete):
 270
 271     def __init__(self, type, values):
 272         Concrete.__init__(self, type.expr)
 273         self.type = type
 274         self.values = values
 275
 276     def visit(self, visitor, *args, **kwargs):
 277         return visitor.visit_bitmask(self, *args, **kwargs)
 278
 279 Flags = Bitmask
 280
 281
 282 class Array(Type):
 283
 284     def __init__(self, type, length):
 285         Type.__init__(self, type.expr + " *")
 286         self.type = type
 287         self.length = length
 288
 289     def visit(self, visitor, *args, **kwargs):
 290         return visitor.visit_array(self, *args, **kwargs)
 291
 292
 293 class Blob(Type):
 294
 295     def __init__(self, type, size):
 296         Type.__init__(self, type.expr + ' *')
 297         self.type = type
 298         self.size = size
 299
 300     def visit(self, visitor, *args, **kwargs):
 301         return visitor.visit_blob(self, *args, **kwargs)
 302
 303
 304 class Struct(Concrete):
 305
 306     def __init__(self, name, members):
 307         Concrete.__init__(self, name)
 308         self.name = name
 309         self.members = members
 310
 311     def visit(self, visitor, *args, **kwargs):
 312         return visitor.visit_struct(self, *args, **kwargs)
 313
 314
 315 class Alias(Type):
 316
 317     def __init__(self, expr, type):
 318         Type.__init__(self, expr)
 319         self.type = type
 320
 321     def visit(self, visitor, *args, **kwargs):
 322         return visitor.visit_alias(self, *args, **kwargs)
 323
 324
 325 def Out(type, name):
 326     arg = Arg(type, name, output=True)
 327     return arg
 328
 329
 330 class Arg:
 331
 332     def __init__(self, type, name, output=False):
 333         self.type = type
 334         self.name = name
 335         self.output = output
 336         self.index = None
 337
 338     def __str__(self):
 339         return '%s %s' % (self.type, self.name)
 340
 341
 342 class Function:
 343
 344     def __init__(self, type, name, args, call = '', fail = None, sideeffects=True, hidden=False):
 345         self.type = type
 346         self.name = name
 347
 348         self.args = []
 349         index = 0
 350         for arg in args:
 351             if isinstance(arg, tuple):
 352                 arg_type, arg_name = arg
 353                 arg = Arg(arg_type, arg_name)
 354             arg.index = index
 355             index += 1
 356             self.args.append(arg)
 357
 358         self.call = call
 359         self.fail = fail
 360         self.sideeffects = sideeffects
 361         self.hidden = False
 362
 363     def prototype(self, name=None):
 364         if name is not None:
 365             name = name.strip()
 366         else:
 367             name = self.name
 368         s = name
 369         if self.call:
 370             s = self.call + ' ' + s
 371         if name.startswith('*'):
 372             s = '(' + s + ')'
 373         s = self.type.expr + ' ' + s
 374         s += "("
 375         if self.args:
 376             s += ", ".join(["%s %s" % (arg.type, arg.name) for arg in self.args])
 377         else:
 378             s += "void"
 379         s += ")"
 380         return s
 381
 382
 383 def StdFunction(*args, **kwargs):
 384     kwargs.setdefault('call', '__stdcall')
 385     return Function(*args, **kwargs)
 386
 387
 388 def FunctionPointer(type, name, args, **kwargs):
 389     # XXX
 390     return Opaque(name)
 391
 392
 393 class Interface(Type):
 394
 395     def __init__(self, name, base=None):
 396         Type.__init__(self, name)
 397         self.name = name
 398         self.base = base
 399         self.methods = []
 400
 401     def itermethods(self):
 402         if self.base is not None:
 403             for method in self.stdapi.itermethods():
 404                 yield method
 405         for method in self.methods:
 406             yield method
 407         raise StopIteration
 408
 409
 410 class Method(Function):
 411
 412     def __init__(self, type, name, args):
 413         Function.__init__(self, type, name, args, call = '__stdcall')
 414
 415
 416 towrap = []
 417
 418
 419 def WrapPointer(type):
 420     return Pointer(type)
 421
 422
 423 class String(Type):
 424
 425     def __init__(self, expr = "char *", length = None):
 426         Type.__init__(self, expr)
 427         self.length = length
 428
 429     def visit(self, visitor, *args, **kwargs):
 430         return visitor.visit_string(self, *args, **kwargs)
 431
 432 CString = String()
 433
 434
 435 class Opaque(Type):
 436     '''Opaque pointer.'''
 437
 438     def __init__(self, expr):
 439         Type.__init__(self, expr)
 440
 441     def visit(self, visitor, *args, **kwargs):
 442         return visitor.visit_opaque(self, *args, **kwargs)
 443
 444
 445 def OpaquePointer(type):
 446     return Opaque(type.expr + ' *')
 447
 448
 449 class Collector(Visitor):
 450     '''Collect.'''
 451
 452     def __init__(self):
 453         self.__visited = set()
 454         self.types = []
 455
 456     def visit(self, type):
 457         if type in self.__visited:
 458             return
 459         self.__visited.add(type)
 460         Visitor.visit(self, type)
 461         self.types.append(type)
 462
 463     def visit_void(self, literal):
 464         pass
 465
 466     def visit_literal(self, literal):
 467         pass
 468
 469     def visit_string(self, string):
 470         pass
 471
 472     def visit_const(self, const):
 473         self.visit(const.type)
 474
 475     def visit_struct(self, struct):
 476         for type, name in struct.members:
 477             self.visit(type)
 478
 479     def visit_array(self, array):
 480         self.visit(array.type)
 481
 482     def visit_blob(self, array):
 483         pass
 484
 485     def visit_enum(self, enum):
 486         pass
 487
 488     def visit_bitmask(self, bitmask):
 489         self.visit(bitmask.type)
 490
 491     def visit_pointer(self, pointer):
 492         self.visit(pointer.type)
 493
 494     def visit_handle(self, handle):
 495         self.visit(handle.type)
 496
 497     def visit_alias(self, alias):
 498         self.visit(alias.type)
 499
 500     def visit_opaque(self, opaque):
 501         pass
 502
 503     def visit_interface(self, interface):
 504         pass
 505
 506
 507 class API:
 508
 509     def __init__(self, name):
 510         self.name = name
 511         self.headers = []
 512         self.functions = []
 513         self.interfaces = []
 514
 515     def all_types(self):
 516         collector = Collector()
 517         for function in self.functions:
 518             for arg in function.args:
 519                 collector.visit(arg.type)
 520             collector.visit(function.type)
 521         for interface in self.interfaces:
 522             collector.visit(interface)
 523             for method in interface.methods:
 524                 for arg in method.args:
 525                     collector.visit(arg.type)
 526                 collector.visit(method.type)
 527         return collector.types
 528
 529     def add_function(self, function):
 530         self.functions.append(function)
 531
 532     def add_functions(self, functions):
 533         for function in functions:
 534             self.add_function(function)
 535
 536     def add_interface(self, interface):
 537         self.interfaces.append(interface)
 538
 539     def add_interfaces(self, interfaces):
 540         self.interfaces.extend(interfaces)
 541
 542
 543 Bool = Literal("bool", "Bool")
 544 SChar = Literal("signed char", "SInt")
 545 UChar = Literal("unsigned char", "UInt")
 546 Short = Literal("short", "SInt")
 547 Int = Literal("int", "SInt")
 548 Long = Literal("long", "SInt")
 549 LongLong = Literal("long long", "SInt")
 550 UShort = Literal("unsigned short", "UInt")
 551 UInt = Literal("unsigned int", "UInt")
 552 ULong = Literal("unsigned long", "UInt")
 553 ULongLong = Literal("unsigned long long", "UInt")
 554 Float = Literal("float", "Float")
 555 Double = Literal("double", "Float")
 556 SizeT = Literal("size_t", "UInt")
 557 WString = Literal("wchar_t *", "WString")
 558