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     bits contains a list of (name, bitnum) tuples.  items only appear if specified as a bit. bitnum is a number.
 118     '''
 119     def __init__(self, name, elt):
 120         SimpleType.__init__(self, name, 4)
 121         self.values = []
 122         self.bits = []
 123         for item in list(elt):
 124             # First check if we're using a default value
 125             if len(list(item)) == 0:
 126                 self.values.append((item.get('name'), ''))
 127                 continue
 128
 129             # An explicit value or bit was specified.
 130             value = list(item)[0]
 131             if value.tag == 'value':
 132                 self.values.append((item.get('name'), value.text))
 133             elif value.tag == 'bit':
 134                 self.values.append((item.get('name'), '%u' % (1 << int(value.text))))
 135                 self.bits.append((item.get('name'), value.text))
 136
 137     def resolve(self, module):
 138         self.resolved = True
 139
 140     def fixed_size(self):
 141         return True
 142
 143     out = __main__.output['enum']
 144
 145
 146 class ListType(Type):
 147     '''
 148     Derived class which represents a list of some other datatype.  Fixed- or variable-sized.
 149
 150     Public fields added:
 151     member is the datatype of the list elements.
 152     parent is the structure type containing the list.
 153     expr is an Expression object containing the length information, for variable-sized lists.
 154     '''
 155     def __init__(self, elt, member, parent):
 156         Type.__init__(self, member.name)
 157         self.is_list = True
 158         self.member = member
 159         self.parent = parent
 160
 161         if elt.tag == 'list':
 162             elts = list(elt)
 163             self.expr = Expression(elts[0] if len(elts) else elt, self)
 164         elif elt.tag == 'valueparam':
 165             self.expr = Expression(elt, self)
 166
 167         self.size = member.size if member.fixed_size() else None
 168         self.nmemb = self.expr.nmemb if self.expr.fixed_size() else None
 169
 170     def make_member_of(self, module, complex_type, field_type, field_name, visible, wire, auto):
 171         if not self.fixed_size():
 172             # We need a length field.
 173             # Ask our Expression object for it's name, type, and whether it's on the wire.
 174             lenfid = self.expr.lenfield_type
 175             lenfield_name = self.expr.lenfield_name
 176             lenwire = self.expr.lenwire
 177             needlen = True
 178
 179             # See if the length field is already in the structure.
 180             for field in self.parent.fields:
 181                 if field.field_name == lenfield_name:
 182                     needlen = False
 183
 184             # It isn't, so we need to add it to the structure ourself.
 185             if needlen:
 186                 type = module.get_type(lenfid)
 187                 lenfield_type = module.get_type_name(lenfid)
 188                 type.make_member_of(module, complex_type, lenfield_type, lenfield_name, True, lenwire, False)
 189
 190         # Add ourself to the structure by calling our original method.
 191         Type.make_member_of(self, module, complex_type, field_type, field_name, visible, wire, auto)
 192
 193     def resolve(self, module):
 194         if self.resolved:
 195             return
 196         self.member.resolve(module)
 197
 198         # Find my length field again.  We need the actual Field object in the expr.
 199         # This is needed because we might have added it ourself above.
 200         if not self.fixed_size():
 201             for field in self.parent.fields:
 202                 if field.field_name == self.expr.lenfield_name and field.wire:
 203                     self.expr.lenfield = field
 204                     break
 205
 206         self.resolved = True
 207
 208     def fixed_size(self):
 209         return self.member.fixed_size() and self.expr.fixed_size()
 210
 211 class ExprType(Type):
 212     '''
 213     Derived class which represents an exprfield.  Fixed size.
 214
 215     Public fields added:
 216     expr is an Expression object containing the value of the field.
 217     '''
 218     def __init__(self, elt, member, parent):
 219         Type.__init__(self, member.name)
 220         self.is_expr = True
 221         self.member = member
 222         self.parent = parent
 223
 224         self.expr = Expression(list(elt)[0], self)
 225
 226         self.size = member.size
 227         self.nmemb = 1
 228
 229     def resolve(self, module):
 230         if self.resolved:
 231             return
 232         self.member.resolve(module)
 233         self.resolved = True
 234
 235     def fixed_size(self):
 236         return True
 237
 238 class SizedPadType(Type):
 239     '''
 240     Derived class which represents a padding field of given size.
 241     '''
 242     def __init__(self, size):
 243         Type.__init__(self, tcard8.name)
 244         self.is_pad = True
 245         self.size = 1
 246         self.nmemb = int(size)
 247
 248     def resolve(self, module):
 249         self.resolved = True
 250
 251     def fixed_size(self):
 252         return True
 253
 254 class PadType(SizedPadType):
 255     '''
 256     Derived class which represents a padding field of given type.
 257     '''
 258     def __init__(self, elt):
 259         self.nmemb = "1" if (elt == None) else elt.get('bytes')
 260         SizedPadType.__init__(self, self.nmemb)
 261
 262 class ComplexType(Type):
 263     '''
 264     Derived class which represents a structure.  Base type for all structure types.
 265
 266     Public fields added:
 267     fields is an array of Field objects describing the structure fields.
 268     '''
 269     def __init__(self, name, elt):
 270         Type.__init__(self, name)
 271         self.is_container = True
 272         self.elt = elt
 273         self.fields = []
 274         self.nmemb = 1
 275         self.size = 0
 276
 277     def resolve(self, module):
 278         if self.resolved:
 279             return
 280         pads = 0
 281
 282         # Resolve all of our field datatypes.
 283         for child in list(self.elt):
 284             value_mask_pad = None
 285             if child.tag == 'pad':
 286                 field_name = 'pad' + str(pads)
 287                 fkey = 'CARD8'
 288                 type = PadType(child)
 289                 pads = pads + 1
 290                 visible = False
 291             elif child.tag == 'field':
 292                 field_name = child.get('name')
 293                 fkey = child.get('type')
 294                 type = module.get_type(fkey)
 295                 visible = True
 296             elif child.tag == 'exprfield':
 297                 field_name = child.get('name')
 298                 fkey = child.get('type')
 299                 type = ExprType(child, module.get_type(fkey), self)
 300                 visible = False
 301             elif child.tag == 'list':
 302                 field_name = child.get('name')
 303                 fkey = child.get('type')
 304                 type = ListType(child, module.get_type(fkey), self)
 305                 visible = True
 306             elif child.tag == 'valueparam':
 307                 field_name = child.get('value-list-name')
 308                 fkey = 'CARD32'
 309                 type = ListType(child, module.get_type(fkey), self)
 310                 visible = True
 311                 value_mask_pad = child.get('value-mask-pad')
 312             else:
 313                 # Hit this on Reply
 314                 continue
 315
 316             # Get the full type name for the field
 317             field_type = module.get_type_name(fkey)
 318             # Add the field to ourself
 319             type.make_member_of(module, self, field_type, field_name, visible, True, False)
 320             # Recursively resolve the type (could be another structure, list)
 321             type.resolve(module)
 322
 323             # Add a value-mask-pad if necessary
 324             if value_mask_pad != None:
 325                 vmp_field_name = 'pad' + str(pads)
 326                 vmp_fkey = 'CARD8'
 327                 vmp_type = SizedPadType(value_mask_pad)
 328                 pads = pads + 1
 329                 vmp_visible = False
 330                 vmp_field_type = module.get_type_name(vmp_fkey)
 331                 vmp_type.make_member_of(module, self, vmp_field_type, vmp_field_name, vmp_visible, True, False)
 332                 vmp_type.resolve(module)
 333
 334         self.calc_size() # Figure out how big we are
 335         self.resolved = True
 336
 337     def calc_size(self):
 338         self.size = 0
 339         for m in self.fields:
 340             if not m.wire:
 341                 continue
 342             if m.type.fixed_size():
 343                 self.size = self.size + (m.type.size * m.type.nmemb)
 344             else:
 345                 self.size = None
 346                 break
 347
 348     def fixed_size(self):
 349         for m in self.fields:
 350             if not m.type.fixed_size():
 351                 return False
 352         return True
 353
 354
 355 class Struct(ComplexType):
 356     '''
 357     Derived class representing a struct data type.
 358     '''
 359     out = __main__.output['struct']
 360
 361
 362 class Union(ComplexType):
 363     '''
 364     Derived class representing a union data type.
 365     '''
 366     def __init__(self, name, elt):
 367         ComplexType.__init__(self, name, elt)
 368         self.is_union = True
 369
 370     out = __main__.output['union']
 371
 372
 373 class Reply(ComplexType):
 374     '''
 375     Derived class representing a reply.  Only found as a field of Request.
 376     '''
 377     def __init__(self, name, elt):
 378         ComplexType.__init__(self, name, elt)
 379         self.is_reply = True
 380
 381     def resolve(self, module):
 382         if self.resolved:
 383             return
 384         # Add the automatic protocol fields
 385         self.fields.append(Field(tcard8, tcard8.name, 'response_type', False, True, True))
 386         self.fields.append(_placeholder_byte)
 387         self.fields.append(Field(tcard16, tcard16.name, 'sequence', False, True, True))
 388         self.fields.append(Field(tcard32, tcard32.name, 'length', False, True, True))
 389         ComplexType.resolve(self, module)
 390
 391
 392 class Request(ComplexType):
 393     '''
 394     Derived class representing a request.
 395
 396     Public fields added:
 397     reply contains the reply datatype or None for void requests.
 398     opcode contains the request number.
 399     '''
 400     def __init__(self, name, elt):
 401         ComplexType.__init__(self, name, elt)
 402         self.reply = None
 403         self.opcode = elt.get('opcode')
 404
 405         for child in list(elt):
 406             if child.tag == 'reply':
 407                 self.reply = Reply(name, child)
 408
 409     def resolve(self, module):
 410         if self.resolved:
 411             return
 412         # Add the automatic protocol fields
 413         if module.namespace.is_ext:
 414             self.fields.append(Field(tcard8, tcard8.name, 'major_opcode', False, True, True))
 415             self.fields.append(Field(tcard8, tcard8.name, 'minor_opcode', False, True, True))
 416             self.fields.append(Field(tcard16, tcard16.name, 'length', False, True, True))
 417             ComplexType.resolve(self, module)
 418         else:
 419             self.fields.append(Field(tcard8, tcard8.name, 'major_opcode', False, True, True))
 420             self.fields.append(_placeholder_byte)
 421             self.fields.append(Field(tcard16, tcard16.name, 'length', False, True, True))
 422             ComplexType.resolve(self, module)
 423
 424         if self.reply:
 425             self.reply.resolve(module)
 426
 427     out = __main__.output['request']
 428
 429
 430 class Event(ComplexType):
 431     '''
 432     Derived class representing an event data type.
 433
 434     Public fields added:
 435     opcodes is a dictionary of name -> opcode number, for eventcopies.
 436     '''
 437     def __init__(self, name, elt):
 438         ComplexType.__init__(self, name, elt)
 439         self.opcodes = {}
 440
 441         tmp = elt.get('no-sequence-number')
 442         self.has_seq = (tmp == None or tmp.lower() == 'false' or tmp == '0')
 443
 444     def add_opcode(self, opcode, name, main):
 445         self.opcodes[name] = opcode
 446         if main:
 447             self.name = name
 448
 449     def resolve(self, module):
 450         if self.resolved:
 451             return
 452
 453         # Add the automatic protocol fields
 454         self.fields.append(Field(tcard8, tcard8.name, 'response_type', False, True, True))
 455         if self.has_seq:
 456             self.fields.append(_placeholder_byte)
 457             self.fields.append(Field(tcard16, tcard16.name, 'sequence', False, True, True))
 458         ComplexType.resolve(self, module)
 459
 460     out = __main__.output['event']
 461
 462
 463 class Error(ComplexType):
 464     '''
 465     Derived class representing an error data type.
 466
 467     Public fields added:
 468     opcodes is a dictionary of name -> opcode number, for errorcopies.
 469     '''
 470     def __init__(self, name, elt):
 471         ComplexType.__init__(self, name, elt)
 472         self.opcodes = {}
 473
 474     def add_opcode(self, opcode, name, main):
 475         self.opcodes[name] = opcode
 476         if main:
 477             self.name = name
 478
 479     def resolve(self, module):
 480         if self.resolved:
 481             return
 482
 483         # Add the automatic protocol fields
 484         self.fields.append(Field(tcard8, tcard8.name, 'response_type', False, True, True))
 485         self.fields.append(Field(tcard8, tcard8.name, 'error_code', False, True, True))
 486         self.fields.append(Field(tcard16, tcard16.name, 'sequence', False, True, True))
 487         ComplexType.resolve(self, module)
 488
 489     out = __main__.output['error']
 490
 491 _placeholder_byte = Field(PadType(None), tcard8.name, 'pad0', False, True, False)