git.cworth.org Git - apitrace/blob - base.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 class Type:
  35
  36     __seq = 0
  37
  38     def __init__(self, expr, id = ''):
  39         self.expr = expr
  40
  41         for char in id:
  42             assert char.isalnum() or char in '_ '
  43
  44         id = id.replace(' ', '_')
  45
  46         if id in all_types:
  47             Type.__seq += 1
  48             id += str(Type.__seq)
  49
  50         assert id not in all_types
  51         all_types[id] = self
  52
  53         self.id = id
  54
  55     def __str__(self):
  56         return self.expr
  57
  58     def isoutput(self):
  59         return False
  60
  61     def decl(self):
  62         pass
  63
  64     def impl(self):
  65         pass
  66
  67     def dump(self, instance):
  68         raise NotImplementedError
  69
  70     def wrap_instance(self, instance):
  71         pass
  72
  73     def unwrap_instance(self, instance):
  74         pass
  75
  76
  77 class _Void(Type):
  78
  79     def __init__(self):
  80         Type.__init__(self, "void")
  81
  82 Void = _Void()
  83
  84
  85 class Concrete(Type):
  86
  87     def decl(self):
  88         print 'static void Dump%s(const %s &value);' % (self.id, self.expr)
  89
  90     def impl(self):
  91         print 'static void Dump%s(const %s &value) {' % (self.id, self.expr)
  92         self._dump("value");
  93         print '}'
  94         print
  95
  96     def _dump(self, instance):
  97         raise NotImplementedError
  98
  99     def dump(self, instance):
 100         print '    Dump%s(%s);' % (self.id, instance)
 101
 102
 103 class Intrinsic(Concrete):
 104
 105     def __init__(self, expr, format):
 106         Concrete.__init__(self, expr)
 107         self.format = format
 108
 109     def _dump(self, instance):
 110         print '    Log::TextF("%s", %s);' % (self.format, instance)
 111
 112
 113 class Const(Type):
 114
 115     def __init__(self, type):
 116
 117         if isinstance(type, Pointer):
 118             expr = type.expr + " const"
 119         else:
 120             expr = "const " + type.expr
 121
 122         Type.__init__(self, expr, 'C' + type.id)
 123
 124         self.type = type
 125
 126     def dump(self, instance):
 127         self.type.dump(instance)
 128
 129
 130 class Pointer(Type):
 131
 132     def __init__(self, type):
 133         Type.__init__(self, type.expr + " *", 'P' + type.id)
 134         self.type = type
 135
 136     def dump(self, instance):
 137         print '    if(%s) {' % instance
 138         print '        Log::BeginReference("%s", %s);' % (self.type, instance)
 139         try:
 140             self.type.dump("*" + instance)
 141         except NotImplementedError:
 142             pass
 143         print '        Log::EndReference();'
 144         print '    }'
 145         print '    else'
 146         print '        Log::Text("NULL");'
 147
 148     def wrap_instance(self, instance):
 149         self.type.wrap_instance("*" + instance)
 150
 151     def unwrap_instance(self, instance):
 152         self.type.wrap_instance("*" + instance)
 153
 154
 155 def ConstPointer(type):
 156     return Pointer(Const(type))
 157
 158
 159 class OutPointer(Pointer):
 160
 161     def isoutput(self):
 162         return True
 163
 164
 165 class Enum(Concrete):
 166
 167     def __init__(self, name, values):
 168         Concrete.__init__(self, name)
 169         self.values = values
 170
 171     def _dump(self, instance):
 172         print '    switch(%s) {' % instance
 173         for value in self.values:
 174             print '    case %s:' % value
 175             print '        Log::Text("%s");' % value
 176             print '        break;'
 177         print '    default:'
 178         print '        Log::TextF("%%i", %s);' % instance
 179         print '        break;'
 180         print '    }'
 181
 182
 183 class FakeEnum(Enum):
 184
 185     def __init__(self, type, values):
 186         Enum.__init__(self, type.expr, values)
 187         self.type = type
 188
 189
 190 class Flags(Concrete):
 191
 192     def __init__(self, type, values):
 193         Concrete.__init__(self, type.expr)
 194         self.type = type
 195         self.values = values
 196
 197     def _dump(self, instance):
 198         print '    bool l_First = TRUE;'
 199         print '    %s l_Value = %s;' % (self.type, instance)
 200         for value in self.values:
 201             print '    if((l_Value & %s) == %s) {' % (value, value)
 202             print '        if(!l_First)'
 203             print '            Log::Text(" | ");'
 204             print '        Log::Text("%s");' % value
 205             print '        l_Value &= ~%s;' % value
 206             print '        l_First = FALSE;'
 207             print '    }'
 208         print '    if(l_Value || l_First) {'
 209         print '        if(!l_First)'
 210         print '            Log::Text(" | ");'
 211         self.type.dump("l_Value");
 212         print '    }'
 213
 214
 215 class Array(Type):
 216
 217     def __init__(self, type, length):
 218         Type.__init__(self, type.expr + " *", 'P' + type.id)
 219         self.type = type
 220         self.length = length
 221
 222     def dump(self, instance):
 223         index = '__i' + self.type.id
 224         print '    for (int %s = 0; %s < %s; ++%s) {' % (index, index, self.length, index)
 225         print '        Log::BeginElement("%s");' % (self.type,)
 226         self.type.dump('(%s)[%s]' % (instance, index))
 227         print '        Log::EndElement();'
 228         print '    }'
 229
 230     def wrap_instance(self, instance):
 231         self.type.wrap_instance("*" + instance)
 232
 233     def unwrap_instance(self, instance):
 234         self.type.wrap_instance("*" + instance)
 235
 236
 237 class Struct(Concrete):
 238
 239     def __init__(self, name, members):
 240         Concrete.__init__(self, name)
 241         self.members = members
 242
 243     def _dump(self, instance):
 244         for type, name in self.members:
 245             print '    Log::BeginElement("%s", "%s");' % (type, name)
 246             type.dump('(%s).%s' % (instance, name))
 247             print '    Log::EndElement();'
 248
 249
 250 class Alias(Type):
 251
 252     def __init__(self, name, type):
 253         Type.__init__(self, name)
 254         self.type = type
 255
 256     def dump(self, instance):
 257         self.type.dump(instance)
 258
 259
 260 class Function:
 261
 262     def __init__(self, type, name, args, call = '__stdcall', fail = None):
 263         self.type = type
 264         self.name = name
 265         self.args = args
 266         self.call = call
 267         self.fail = fail
 268
 269     def prototype(self, name=None):
 270         if name is not None:
 271             name = name.strip()
 272         else:
 273             name = self.name
 274         s = name
 275         if self.call:
 276             s = self.call + ' ' + s
 277         if name.startswith('*'):
 278             s = '(' + s + ')'
 279         s = self.type.expr + ' ' + s
 280         s += "("
 281         if self.args:
 282             s += ", ".join(["%s %s" % (type, name) for type, name in self.args])
 283         else:
 284             s += "void"
 285         s += ")"
 286         return s
 287
 288     def pointer_type(self):
 289         return 'P' + self.name
 290
 291     def pointer_value(self):
 292         return 'p' + self.name
 293
 294     def wrap_decl(self):
 295         ptype = self.pointer_type()
 296         pvalue = self.pointer_value()
 297         print 'typedef ' + self.prototype('* %s' % ptype) + ';'
 298         print 'static %s %s = NULL;' % (ptype, pvalue)
 299         print
 300
 301     def get_true_pointer(self):
 302         raise NotImplementedError
 303
 304     def fail_impl(self):
 305         if self.fail is not None:
 306             if self.type is Void:
 307                 assert self.fail == ''
 308                 print '            return;'
 309             else:
 310                 assert self.fail != ''
 311                 print '            return %s;' % self.fail
 312         else:
 313             print '            ExitProcess(0);'
 314
 315     def wrap_impl(self):
 316         pvalue = self.pointer_value()
 317         print self.prototype() + ' {'
 318         if self.type is Void:
 319             result = ''
 320         else:
 321             print '    %s result;' % self.type
 322             result = 'result = '
 323         self.get_true_pointer()
 324         print '    Log::BeginCall("%s");' % (self.name)
 325         for type, name in self.args:
 326             if not type.isoutput():
 327                 type.unwrap_instance(name)
 328                 print '    Log::BeginArg("%s", "%s");' % (type, name)
 329                 type.dump(name)
 330                 print '    Log::EndArg();'
 331         print '    %s%s(%s);' % (result, pvalue, ', '.join([str(name) for type, name in self.args]))
 332         for type, name in self.args:
 333             if type.isoutput():
 334                 print '    Log::BeginArg("%s", "%s");' % (type, name)
 335                 type.dump(name)
 336                 print '    Log::EndArg();'
 337                 type.wrap_instance(name)
 338         if self.type is not Void:
 339             print '    Log::BeginReturn("%s");' % self.type
 340             self.type.dump("result")
 341             print '    Log::EndReturn();'
 342             self.type.wrap_instance('result')
 343         print '    Log::EndCall();'
 344         self.post_call_impl()
 345         if self.type is not Void:
 346             print '    return result;'
 347         print '}'
 348         print
 349
 350     def post_call_impl(self):
 351         pass
 352
 353
 354 class Interface(Type):
 355
 356     def __init__(self, name, base=None):
 357         Type.__init__(self, name)
 358         self.name = name
 359         self.base = base
 360         self.methods = []
 361
 362     def itermethods(self):
 363         if self.base is not None:
 364             for method in self.base.itermethods():
 365                 yield method
 366         for method in self.methods:
 367             yield method
 368         raise StopIteration
 369
 370     def wrap_name(self):
 371         return "Wrap" + self.expr
 372
 373     def wrap_pre_decl(self):
 374         print "class %s;" % self.wrap_name()
 375
 376     def wrap_decl(self):
 377         print "class %s : public %s " % (self.wrap_name(), self.name)
 378         print "{"
 379         print "public:"
 380         print "    %s(%s * pInstance);" % (self.wrap_name(), self.name)
 381         print "    virtual ~%s();" % self.wrap_name()
 382         print
 383         for method in self.itermethods():
 384             print "    " + method.prototype() + ";"
 385         print
 386         #print "private:"
 387         print "    %s * m_pInstance;" % (self.name,)
 388         print "};"
 389         print
 390
 391     def wrap_impl(self):
 392         print '%s::%s(%s * pInstance) {' % (self.wrap_name(), self.wrap_name(), self.name)
 393         print '    m_pInstance = pInstance;'
 394         print '}'
 395         print
 396         print '%s::~%s() {' % (self.wrap_name(), self.wrap_name())
 397         print '}'
 398         print
 399         for method in self.itermethods():
 400             print method.prototype(self.wrap_name() + '::' + method.name) + ' {'
 401             if method.type is Void:
 402                 result = ''
 403             else:
 404                 print '    %s result;' % method.type
 405                 result = 'result = '
 406             print '    Log::BeginCall("%s");' % (self.name + '::' + method.name)
 407             print '    Log::BeginArg("%s *", "this");' % self.name
 408             print '    Log::BeginReference("%s", m_pInstance);' % self.name
 409             print '    Log::EndReference();'
 410             print '    Log::EndArg();'
 411             for type, name in method.args:
 412                 if not type.isoutput():
 413                     type.unwrap_instance(name)
 414                     print '    Log::BeginArg("%s", "%s");' % (type, name)
 415                     type.dump(name)
 416                     print '    Log::EndArg();'
 417             print '    %sm_pInstance->%s(%s);' % (result, method.name, ', '.join([str(name) for type, name in method.args]))
 418             for type, name in method.args:
 419                 if type.isoutput():
 420                     print '    Log::BeginArg("%s", "%s");' % (type, name)
 421                     type.dump(name)
 422                     print '    Log::EndArg();'
 423                     type.wrap_instance(name)
 424             if method.type is not Void:
 425                 print '    Log::BeginReturn("%s");' % method.type
 426                 method.type.dump("result")
 427                 print '    Log::EndReturn();'
 428                 method.type.wrap_instance('result')
 429             print '    Log::EndCall();'
 430             if method.name == 'QueryInterface':
 431                 print '    if(*ppvObj == m_pInstance)'
 432                 print '        *ppvObj = this;'
 433             if method.name == 'Release':
 434                 assert method.type is not Void
 435                 print '    if(!result)'
 436                 print '        delete this;'
 437             if method.type is not Void:
 438                 print '    return result;'
 439             print '}'
 440             print
 441         print
 442
 443
 444 class Method(Function):
 445
 446     def __init__(self, type, name, args):
 447         Function.__init__(self, type, name, args)
 448
 449
 450 towrap = []
 451
 452 class WrapPointer(Pointer):
 453
 454     def __init__(self, type):
 455         Pointer.__init__(self, type)
 456         if type not in towrap:
 457             towrap.append(type)
 458
 459     def wrap_instance(self, instance):
 460         print "    if(%s)" % instance
 461         print "        %s = new %s(%s);" % (instance, self.type.wrap_name(), instance)
 462
 463     def unwrap_instance(self, instance):
 464         print "    if(%s)" % instance
 465         print "        %s = static_cast<%s *>(%s)->m_pInstance;" % (instance, self.type.wrap_name(), instance)
 466
 467
 468 class _String(Type):
 469
 470     def __init__(self):
 471         Type.__init__(self, "char *")
 472
 473     def dump(self, instance):
 474         print '    Log::DumpString((const char *)%s);' % instance
 475
 476 String = _String()
 477
 478 class _WString(Type):
 479
 480     def __init__(self):
 481         Type.__init__(self, "wchar_t *")
 482
 483     def dump(self, instance):
 484         print '    Log::DumpWString(%s);' % instance
 485
 486 WString = _WString()
 487
 488
 489 SChar = Intrinsic("signed char", "%i")
 490 UChar = Intrinsic("unsigned char", "%u")
 491 Short = Intrinsic("short", "%i")
 492 Int = Intrinsic("int", "%i")
 493 Long = Intrinsic("long", "%li")
 494 UShort = Intrinsic("unsigned short", "%u")
 495 UInt = Intrinsic("unsigned int", "%u")
 496 ULong = Intrinsic("unsigned long", "%lu")
 497 Float = Intrinsic("float", "%f")
 498 Double = Intrinsic("double", "%f")
 499 SizeT = Intrinsic("size_t", "%lu")
 500
 501
 502 def wrap():
 503     for type in all_types.itervalues():
 504         type.decl()
 505     print
 506     for type in all_types.itervalues():
 507         type.impl()
 508     print
 509     for type in towrap:
 510         type.wrap_pre_decl()
 511     print
 512     for type in towrap:
 513         type.wrap_decl()
 514     print
 515     for type in towrap:
 516         type.wrap_impl()
 517     print