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