git.demorecorder.com Git - free-sw/xcb/proto/blob - xcbgen/xtypes.py

   1 '''
   2 This module contains the classes which represent XCB data types.
   3 '''
   4 from expr import Field, Expression
   5 import __main__
   6
   7 class Type(object):
   8     '''
   9     Abstract base class for all XCB data types.
  10     Contains default fields, and some abstract methods.
  11     '''
  12     def __init__(self, name):
  13         '''
  14         Default structure initializer.  Sets up default fields.
  15
  16         Public fields:
  17         name is a tuple of strings specifying the full type name.
  18         size is the size of the datatype in bytes, or None if variable-sized.
  19         nmemb is 1 for non-list types, None for variable-sized lists, otherwise number of elts.
  20         booleans for identifying subclasses, because I can't figure out isinstance().
  21         '''
  22         self.name = name
  23         self.size = None
  24         self.nmemb = None
  25         self.resolved = False
  26
  27         # Screw isinstance().
  28         self.is_simple = False
  29         self.is_list = False
  30         self.is_expr = False
  31         self.is_container = False
  32         self.is_reply = False
  33         self.is_union = False
  34         self.is_pad = False
  35
  36     def resolve(self, module):
  37         '''
  38         Abstract method for resolving a type.
  39         This should make sure any referenced types are already declared.
  40         '''
  41         raise Exception('abstract resolve method not overridden!')
  42
  43     def out(self, name):
  44         '''
  45         Abstract method for outputting code.
  46         These are declared in the language-specific modules, and
  47         there must be a dictionary containing them declared when this module is imported!
  48         '''
  49         raise Exception('abstract out method not overridden!')
  50
  51     def fixed_size(self):
  52         '''
  53         Abstract method for determining if the data type is fixed-size.
  54         '''
  55         raise Exception('abstract fixed_size method not overridden!')
  56
  57     def make_member_of(self, module, complex_type, field_type, field_name, visible, wire, auto):
  58         '''
  59         Default method for making a data type a member of a structure.
  60         Extend this if the data type needs to add an additional length field or something.
  61
  62         module is the global module object.
  63         complex_type is the structure object.
  64         see Field for the meaning of the other parameters.
  65         '''
  66         new_field = Field(self, field_type, field_name, visible, wire, auto)
  67
  68         # We dump the _placeholder_byte if any fields are added.
  69         for (idx, field) in enumerate(complex_type.fields):
  70             if field == _placeholder_byte:
  71                 complex_type.fields[idx] = new_field
  72                 return
  73
  74         complex_type.fields.append(new_field)
  75
  76 class SimpleType(Type):
  77     '''
  78     Derived class which represents a cardinal type like CARD32 or char.
  79     Any type which is typedef'ed to cardinal will be one of these.
  80
  81     Public fields added:
  82     none
  83     '''
  84     def __init__(self, name, size):
  85         Type.__init__(self, name)
  86         self.is_simple = True
  87         self.size = size
  88         self.nmemb = 1
  89
  90     def resolve(self, module):
  91         self.resolved = True
  92
  93     def fixed_size(self):
  94         return True
  95
  96     out = __main__.output['simple']
  97
  98
  99 # Cardinal datatype globals.  See module __init__ method.
 100 tcard8 = SimpleType(('uint8_t',), 1)
 101 tcard16 = SimpleType(('uint16_t',), 2)
 102 tcard32 = SimpleType(('uint32_t',), 4)
 103 tint8 =  SimpleType(('int8_t',), 1)
 104 tint16 = SimpleType(('int16_t',), 2)
 105 tint32 = SimpleType(('int32_t',), 4)
 106 tchar =  SimpleType(('char',), 1)
 107 tfloat = SimpleType(('float',), 4)
 108 tdouble = SimpleType(('double',), 8)
 109
 110
 111 class Enum(SimpleType):
 112     '''
 113     Derived class which represents an enum.  Fixed-size.
 114
 115     Public fields added:
 116     values contains a list of (name, value) tuples.  value is empty, or a number.
 117     '''
 118     def __init__(self, name, elt):
 119         SimpleType.__init__(self, name, 4)
 120         self.values = []
 121         for item in list(elt):
 122             # First check if we're using a default value
 123             if len(list(item)) == 0:
 124                 self.values.append((item.get('name'), ''))
 125                 continue
 126
 127             # An explicit value or bit was specified.
 128             value = list(item)[0]
 129             if value.tag == 'value':
 130                 self.values.append((item.get('name'), value.text))
 131             elif value.tag == 'bit':
 132                 self.values.append((item.get('name'), '%u' % (1 << int(value.text))))
 133
 134     def resolve(self, module):
 135         self.resolved = True
 136
 137     def fixed_size(self):
 138         return True
 139
 140     out = __main__.output['enum']
 141
 142
 143 class ListType(Type):
 144     '''
 145     Derived class which represents a list of some other datatype.  Fixed- or variable-sized.
 146
 147     Public fields added:
 148     member is the datatype of the list elements.
 149     parent is the structure type containing the list.
 150     expr is an Expression object containing the length information, for variable-sized lists.
 151     '''
 152     def __init__(self, elt, member, parent):
 153         Type.__init__(self, member.name)
 154         self.is_list = True
 155         self.member = member
 156         self.parent = parent
 157
 158         if elt.tag == 'list':
 159             elts = list(elt)
 160             self.expr = Expression(elts[0] if len(elts) else elt, self)
 161         elif elt.tag == 'valueparam':
 162             self.expr = Expression(elt, self)
 163
 164         self.size = member.size if member.fixed_size() else None
 165         self.nmemb = self.expr.nmemb if self.expr.fixed_size() else None
 166
 167     def make_member_of(self, module, complex_type, field_type, field_name, visible, wire, auto):
 168         if not self.fixed_size():
 169             # We need a length field.
 170             # Ask our Expression object for it's name, type, and whether it's on the wire.
 171             lenfid = self.expr.lenfield_type
 172             lenfield_name = self.expr.lenfield_name
 173             lenwire = self.expr.lenwire
 174             needlen = True
 175
 176             # See if the length field is already in the structure.
 177             for field in self.parent.fields:
 178                 if field.field_name == lenfield_name:
 179                     needlen = False
 180
 181             # It isn't, so we need to add it to the structure ourself.
 182             if needlen:
 183                 type = module.get_type(lenfid)
 184                 lenfield_type = module.get_type_name(lenfid)
 185                 type.make_member_of(module, complex_type, lenfield_type, lenfield_name, True, lenwire, False)
 186
 187         # Add ourself to the structure by calling our original method.
 188         Type.make_member_of(self, module, complex_type, field_type, field_name, visible, wire, auto)
 189
 190     def resolve(self, module):
 191         if self.resolved:
 192             return
 193         self.member.resolve(module)
 194
 195         # Find my length field again.  We need the actual Field object in the expr.
 196         # This is needed because we might have added it ourself above.
 197         if not self.fixed_size():
 198             for field in self.parent.fields:
 199                 if field.field_name == self.expr.lenfield_name and field.wire:
 200                     self.expr.lenfield = field
 201                     break
 202
 203         self.resolved = True
 204
 205     def fixed_size(self):
 206         return self.member.fixed_size() and self.expr.fixed_size()
 207
 208 class ExprType(Type):
 209     '''
 210     Derived class which represents an exprfield.  Fixed size.
 211
 212     Public fields added:
 213     expr is an Expression object containing the value of the field.
 214     '''
 215     def __init__(self, elt, member, parent):
 216         Type.__init__(self, member.name)
 217         self.is_expr = True
 218         self.member = member
 219         self.parent = parent
 220
 221         self.expr = Expression(list(elt)[0], self)
 222
 223         self.size = member.size
 224         self.nmemb = 1
 225
 226     def resolve(self, module):
 227         if self.resolved:
 228             return
 229         self.member.resolve(module)
 230         self.resolved = True
 231
 232     def fixed_size(self):
 233         return True
 234
 235 class SizedPadType(Type):
 236     '''
 237     Derived class which represents a padding field of given size.
 238     '''
 239     def __init__(self, size):
 240         Type.__init__(self, tcard8.name)
 241         self.is_pad = True
 242         self.size = 1
 243         self.nmemb = int(size)
 244
 245     def resolve(self, module):
 246         self.resolved = True
 247
 248     def fixed_size(self):
 249         return True
 250
 251 class PadType(SizedPadType):
 252     '''
 253     Derived class which represents a padding field of given type.
 254     '''
 255     def __init__(self, elt):
 256         self.nmemb = "1" if (elt == None) else elt.get('bytes')
 257         SizedPadType.__init__(self, self.nmemb)
 258
 259 class ComplexType(Type):
 260     '''
 261     Derived class which represents a structure.  Base type for all structure types.
 262
 263     Public fields added:
 264     fields is an array of Field objects describing the structure fields.
 265     '''
 266     def __init__(self, name, elt):
 267         Type.__init__(self, name)
 268         self.is_container = True
 269         self.elt = elt
 270         self.fields = []
 271         self.nmemb = 1
 272         self.size = 0
 273
 274     def resolve(self, module):
 275         if self.resolved:
 276             return
 277         pads = 0
 278
 279         # Resolve all of our field datatypes.
 280         for child in list(self.elt):
 281             value_mask_pad = None
 282             if child.tag == 'pad':
 283                 field_name = 'pad' + str(pads)
 284                 fkey = 'CARD8'
 285                 type = PadType(child)
 286                 pads = pads + 1
 287                 visible = False
 288             elif child.tag == 'field':
 289                 field_name = child.get('name')
 290                 fkey = child.get('type')
 291                 type = module.get_type(fkey)
 292                 visible = True
 293             elif child.tag == 'exprfield':
 294                 field_name = child.get('name')
 295                 fkey = child.get('type')
 296                 type = ExprType(child, module.get_type(fkey), self)
 297                 visible = False
 298             elif child.tag == 'list':
 299                 field_name = child.get('name')
 300                 fkey = child.get('type')
 301                 type = ListType(child, module.get_type(fkey), self)
 302                 visible = True
 303             elif child.tag == 'valueparam':
 304                 field_name = child.get('value-list-name')
 305                 fkey = 'CARD32'
 306                 type = ListType(child, module.get_type(fkey), self)
 307                 visible = True
 308                 value_mask_pad = child.get('value-mask-pad')
 309             else:
 310                 # Hit this on Reply
 311                 continue
 312
 313             # Get the full type name for the field
 314             field_type = module.get_type_name(fkey)
 315             # Add the field to ourself
 316             type.make_member_of(module, self, field_type, field_name, visible, True, False)
 317             # Recursively resolve the type (could be another structure, list)
 318             type.resolve(module)
 319
 320             # Add a value-mask-pad if necessary
 321             if value_mask_pad != None:
 322                 vmp_field_name = 'pad' + str(pads)
 323                 vmp_fkey = 'CARD8'
 324                 vmp_type = SizedPadType(value_mask_pad)
 325                 pads = pads + 1
 326                 vmp_visible = False
 327                 vmp_field_type = module.get_type_name(vmp_fkey)
 328                 vmp_type.make_member_of(module, self, vmp_field_type, vmp_field_name, vmp_visible, True, False)
 329                 vmp_type.resolve(module)
 330
 331         self.calc_size() # Figure out how big we are
 332         self.resolved = True
 333
 334     def calc_size(self):
 335         self.size = 0
 336         for m in self.fields:
 337             if not m.wire:
 338                 continue
 339             if m.type.fixed_size():
 340                 self.size = self.size + (m.type.size * m.type.nmemb)
 341             else:
 342                 self.size = None
 343                 break
 344
 345     def fixed_size(self):
 346         for m in self.fields:
 347             if not m.type.fixed_size():
 348                 return False
 349         return True
 350
 351
 352 class Struct(ComplexType):
 353     '''
 354     Derived class representing a struct data type.
 355     '''
 356     out = __main__.output['struct']
 357
 358
 359 class Union(ComplexType):
 360     '''
 361     Derived class representing a union data type.
 362     '''
 363     def __init__(self, name, elt):
 364         ComplexType.__init__(self, name, elt)
 365         self.is_union = True
 366
 367     out = __main__.output['union']
 368
 369
 370 class Reply(ComplexType):
 371     '''
 372     Derived class representing a reply.  Only found as a field of Request.
 373     '''
 374     def __init__(self, name, elt):
 375         ComplexType.__init__(self, name, elt)
 376         self.is_reply = True
 377
 378     def resolve(self, module):
 379         if self.resolved:
 380             return
 381         # Add the automatic protocol fields
 382         self.fields.append(Field(tcard8, tcard8.name, 'response_type', False, True, True))
 383         self.fields.append(_placeholder_byte)
 384         self.fields.append(Field(tcard16, tcard16.name, 'sequence', False, True, True))
 385         self.fields.append(Field(tcard32, tcard32.name, 'length', False, True, True))
 386         ComplexType.resolve(self, module)
 387
 388
 389 class Request(ComplexType):
 390     '''
 391     Derived class representing a request.
 392
 393     Public fields added:
 394     reply contains the reply datatype or None for void requests.
 395     opcode contains the request number.
 396     '''
 397     def __init__(self, name, elt):
 398         ComplexType.__init__(self, name, elt)
 399         self.reply = None
 400         self.opcode = elt.get('opcode')
 401
 402         for child in list(elt):
 403             if child.tag == 'reply':
 404                 self.reply = Reply(name, child)
 405
 406     def resolve(self, module):
 407         if self.resolved:
 408             return
 409         # Add the automatic protocol fields
 410         if module.namespace.is_ext:
 411             self.fields.append(Field(tcard8, tcard8.name, 'major_opcode', False, True, True))
 412             self.fields.append(Field(tcard8, tcard8.name, 'minor_opcode', False, True, True))
 413             self.fields.append(Field(tcard16, tcard16.name, 'length', False, True, True))
 414             ComplexType.resolve(self, module)
 415         else:
 416             self.fields.append(Field(tcard8, tcard8.name, 'major_opcode', False, True, True))
 417             self.fields.append(_placeholder_byte)
 418             self.fields.append(Field(tcard16, tcard16.name, 'length', False, True, True))
 419             ComplexType.resolve(self, module)
 420
 421         if self.reply:
 422             self.reply.resolve(module)
 423
 424     out = __main__.output['request']
 425
 426
 427 class Event(ComplexType):
 428     '''
 429     Derived class representing an event data type.
 430
 431     Public fields added:
 432     opcodes is a dictionary of name -> opcode number, for eventcopies.
 433     '''
 434     def __init__(self, name, elt):
 435         ComplexType.__init__(self, name, elt)
 436         self.opcodes = {}
 437
 438         tmp = elt.get('no-sequence-number')
 439         self.has_seq = (tmp == None or tmp.lower() == 'false' or tmp == '0')
 440
 441     def add_opcode(self, opcode, name, main):
 442         self.opcodes[name] = opcode
 443         if main:
 444             self.name = name
 445
 446     def resolve(self, module):
 447         if self.resolved:
 448             return
 449
 450         # Add the automatic protocol fields
 451         self.fields.append(Field(tcard8, tcard8.name, 'response_type', False, True, True))
 452         if self.has_seq:
 453             self.fields.append(_placeholder_byte)
 454             self.fields.append(Field(tcard16, tcard16.name, 'sequence', False, True, True))
 455         ComplexType.resolve(self, module)
 456
 457     out = __main__.output['event']
 458
 459
 460 class Error(ComplexType):
 461     '''
 462     Derived class representing an error data type.
 463
 464     Public fields added:
 465     opcodes is a dictionary of name -> opcode number, for errorcopies.
 466     '''
 467     def __init__(self, name, elt):
 468         ComplexType.__init__(self, name, elt)
 469         self.opcodes = {}
 470
 471     def add_opcode(self, opcode, name, main):
 472         self.opcodes[name] = opcode
 473         if main:
 474             self.name = name
 475
 476     def resolve(self, module):
 477         if self.resolved:
 478             return
 479
 480         # Add the automatic protocol fields
 481         self.fields.append(Field(tcard8, tcard8.name, 'response_type', False, True, True))
 482         self.fields.append(Field(tcard8, tcard8.name, 'error_code', False, True, True))
 483         self.fields.append(Field(tcard16, tcard16.name, 'sequence', False, True, True))
 484         ComplexType.resolve(self, module)
 485
 486     out = __main__.output['error']
 487
 488 _placeholder_byte = Field(PadType(None), tcard8.name, 'pad0', False, True, False)