+ # FIXME - structures with variable sized members, sort out when serialize() is needed
+
+ # as switch does never appear at toplevel,
+ # continue here with type construction
+ if self.is_switch:
+ # special: switch C structs get pointer fields for variable-sized members
+ _c_complex(self)
+ # declare switch (un)packing functions
+ _c_accessors(self, name, name)
+
+ if self.need_serialize:
+ if not hasattr(self, 'in_reply'):
+ _c_serialize(self)
+ _c_unserialize(self)
+
+# _c_type_setup()
+
+def get_request_fields(self):
+ param_fields = []
+ wire_fields = []
+
+ for field in self.fields:
+ if field.visible:
+ # the field should appear as a parameter in the function call
+ param_fields.append(field)
+ if field.wire and not field.auto:
+ if field.type.fixed_size() and not self.is_switch:
+ # need to set the field up in the xcb_out structure
+ wire_fields.append(field)
+ # fields like 'pad0' are skipped!
+
+ return (param_fields, wire_fields)
+# get_request_fields()
+
+def unserialize_fields(complex_type, code_lines=[], space='', prefix='', bitcase=False):
+ prefix_str = prefix
+ need_padding = False
+
+ if prefix != '':
+ prefix_str += "->"
+ if hasattr(complex_type, 'type'):
+ self = complex_type.type
+ complex_name = complex_type.name
+ else:
+ self = complex_type
+ complex_name = '_aux'
+
+ if self.is_switch:
+ switch_expr = _c_accessor_get_expr(self.expr)
+ need_padding = True
+ for b in self.bitcases:
+ bitcase_expr = _c_accessor_get_expr(b.type.expr, prefix)
+ code_lines.append(' if(%s & %s) {' % (switch_expr, bitcase_expr))
+ unserialize_fields(b.type, code_lines, space="%s " % space,
+ prefix="%s%s" % (prefix_str, complex_name), bitcase=True)
+ code_lines.append(' }')
+
+ else:
+ for field in self.fields:
+ if not ((field.wire and not field.auto) or field.visible):
+ continue
+
+ length = "sizeof(%s)" % field.c_field_type
+
+ # 1. fields with fixed size
+ if field.type.fixed_size():
+ need_padding = True
+ value = ' _aux->%s = (%s) *xcb_tmp;' % (field.c_field_name, field.type.c_type)
+ # FIXME - lists
+
+ # 2. fields with variable size
+ else:
+ #if need_padding:
+ # unserialize: always calculate padding before variable sized fields
+ code_lines.append('%s if (0 != xcb_block_len) {' % space)
+ code_lines.append('%s xcb_block_len += -xcb_block_len & 3;' % space)
+ code_lines.append('%s xcb_tmp += xcb_block_len;' % space)
+ code_lines.append('%s xcb_buffer_len += xcb_block_len;' % space)
+ code_lines.append('%s xcb_block_len = 0;' % space)
+ code_lines.append('%s }' % space)
+
+ # FIXME
+ print("unserialize not yet implemented for variable size fields like %s" % field.c_field_name)
+
+ value = ' xcb_parts[xcb_parts_idx].iov_base = (char *) %s%s;' % (prefix_str, field.c_field_name)
+ if field.type.is_list:
+ # FIXME - list with variable-sized elements
+ if field.type.size is None:
+ errmsg = '%s: warning: list object with variable-sized members not supported for field %s\n'
+ sys.stderr.write(errmsg % (self.c_type, field.c_field_name))
+ length = '%s * sizeof(%s)' % (_c_accessor_get_expr(field.type.expr, prefix), field.type.member.c_wiretype)
+ elif field.type.is_switch:
+ # switch is handled by this function as a special case
+ unserialize_fields(field.type, code_lines, space, prefix="%s%s" % (prefix_str, field.c_field_name))
+ else:
+ # FIXME - variable sized field that is not a list
+ errmsg = '%s: warning: non-list object of variable size not supported for field %s\n'
+ sys.stderr.write(errmsg % (self.c_type, field.c_field_name))
+ length = '%s * sizeof(%s)' % ('Uh oh', field.type.c_wiretype)
+
+ # save serialization C code
+ if value is not None:
+ if field.type.fixed_size():
+ # field appears in the request structure
+ code_lines.append('%s /* %s.%s */' % (space, self.c_type, field.c_field_name))
+ else:
+ code_lines.append('%s /* %s */' % (space, field.c_field_name))
+
+ # _aux->XXX =
+ code_lines.append('%s%s' % (space, value))
+ if field.type.fixed_size():
+ code_lines.append('%s xcb_block_len += %s;' % (space, length))
+ code_lines.append('%s xcb_tmp += %s;' % (space, length))
+ else:
+ # take account of padding
+ code_lines.append('%s xcb_block_len = %s;' % (space, length))
+ code_lines.append('%s xcb_block_len += -xcb_block_len & 3;' % space)
+ code_lines.append('%s xcb_tmp += xcb_block_len;' % space)
+ code_lines.append('%s xcb_buffer_len += xcb_block_len;' % space)
+ code_lines.append('%s xcb_block_len = 0;' % space)
+
+ if not bitcase:
+ code_lines.append('%s xcb_block_len += -xcb_block_len & 3;' % space)
+ #code_lines.append('%s xcb_tmp += xcb_block_len;' % space)
+ code_lines.append('%s xcb_buffer_len += xcb_block_len;' % space)
+
+# unserialize_fields()
+
+
+def serialize_fields(complex_type, code_lines=[], temp_vars=set(),
+ space='', prefix='', serialize_fixed_size_fields=False,
+ bitcase=False):
+ """
+ helper routine to build up iovec arrays that will later be copied into a single buffer
+
+ complex_type - encapsulating Type/Field
+ code_lines, temp_vars - containers for generated code & variable declarations
+ space - extra space to be inserted before any statement
+ prefix - prefix to be used for struct members, needed for switch/bitcase mapping
+ bitcase - flags whether fields are bitcase members
+ """
+
+ # count -> no. of entries in xcb_parts array
+ count = 0
+ # flag to mark wether explicit padding needs to be inserted
+ need_padding = False
+ prefix_str = prefix
+ if prefix != '':
+ prefix_str += "->"
+
+ if hasattr(complex_type, 'type'):
+ self = complex_type.type
+ complex_name = complex_type.name
+ else:
+ self = complex_type
+ complex_name = '_aux'
+
+ def end_block(count):
+ "end a block => insert padding"
+ if need_padding and not bitcase:
+ code_lines.append(' /* padding */')
+ code_lines.append(' xcb_parts[xcb_parts_idx].iov_base = xcb_pad0;')
+ code_lines.append(' xcb_pad = -xcb_block_len & 3;')
+ code_lines.append(' xcb_parts[xcb_parts_idx].iov_len = xcb_pad;')
+ code_lines.append(' xcb_parts_idx++;')
+ code_lines.append('')
+ code_lines.append(' xcb_buffer_len += xcb_pad + %s;' % 'xcb_block_len')
+ code_lines.append('')
+ count += 1
+ return count
+ # end_block()
+
+ def insert_padding(count):
+ code_lines.append('%s /* implicit padding */' % space)
+ code_lines.append('%s xcb_pad = -xcb_block_len & 3;' % space)
+ code_lines.append('%s if (0 != xcb_pad) {' % space)
+ code_lines.append('%s xcb_parts[xcb_parts_idx].iov_base = xcb_pad0;' % space)
+ code_lines.append('%s xcb_parts[xcb_parts_idx].iov_len = xcb_pad;' % space)
+ code_lines.append('%s xcb_buffer_len += xcb_block_len + xcb_pad;' % space)
+ code_lines.append('%s xcb_pad = 0;' % space)
+ code_lines.append('%s xcb_parts_idx++;' % space)
+ code_lines.append('%s }' % space)
+ return count + 1
+ # insert_padding()
+
+ # special case - if self.is_switch, all fields need to be serialized conditionally
+ if self.is_switch:
+ switch_expr = _c_accessor_get_expr(self.expr)
+ need_padding = True
+
+ for b in self.bitcases:
+ bitcase_expr = _c_accessor_get_expr(b.type.expr, prefix)
+ code_lines.append(' if(%s & %s) {' % (switch_expr, bitcase_expr))
+
+ count += serialize_fields(b.type, code_lines, temp_vars, '%s ' % space,
+ prefix="%s%s" % (prefix_str, complex_name),
+ serialize_fixed_size_fields=True, bitcase=True)
+ code_lines.append(' }')
+
+ else:
+ for field in self.fields:
+ value = None
+
+ # sort out invisible fields
+ if not ((field.wire and not field.auto) or field.visible):
+ continue
+ # else
+ length = "sizeof(%s)" % field.c_field_type
+
+ # 1. fields with fixed size
+ # fixed size fields are not always handled here,
+ # dependent on serialize_fixed_size_fields
+ if field.type.fixed_size() and serialize_fixed_size_fields:
+ value = ' xcb_parts[xcb_parts_idx].iov_base = (char *) '
+ need_padding = True
+
+ if field.type.is_expr:
+ # need to register a temporary variable for the expression
+ if field.type.c_type is None:
+ raise Exception("type for field '%s' (expression '%s') unkown" %
+ (field.field_name, _c_accessor_get_expr(field.type.expr)))
+ temp_vars.add(' %s xcb_expr_%s = %s;' % (field.type.c_type, field.field_name,
+ _c_accessor_get_expr(field.type.expr, prefix)))
+ value += "&xcb_expr_%s;" % field.field_name
+
+ elif field.type.is_pad:
+ if field.type.nmemb == 1:
+ temp_vars.add(' unsigned int xcb_pad = 0;')
+ temp_vars.add(' char xcb_pad0[3] = {0, 0, 0};')
+ value += "&xcb_pad;"
+ else:
+ value = ' memset(xcb_parts[xcb_parts_idx].iov_base, 0, %d);' % field.type.nmemb
+ length += "*%d" % field.type.nmemb
+
+ else:
+ # non-list type with fixed size
+ if field.type.nmemb == 1:
+ value += "&%s%s;" % (prefix_str, field.c_field_name)
+ # list with nmemb (fixed size) elements
+ else:
+ value += '%s%s;' % (prefix_str, field.c_field_name)
+ length = '%d' % field.type.nmemb
+
+ # 2. fields with variable size
+ elif not field.type.fixed_size():
+ # always calculate padding before variable sized fields
+ count = insert_padding(count)
+ code_lines.append('%s xcb_block_len = 0;' % space)
+
+ value = ' xcb_parts[xcb_parts_idx].iov_base = (char *) %s%s;' % (prefix_str, field.c_field_name)
+
+ if field.type.is_list:
+ # FIXME - list of variable length with variable size elements
+ if field.type.size is None:
+ errmsg = '%s: warning: list object with variable-sized members not supported for field %s\n'
+ sys.stderr.write(errmsg % (self.c_type, field.c_field_name))
+ length = 'undefined'
+ # list of variable length with fixed size elements
+ else:
+ length = '%s * sizeof(%s)' % (_c_accessor_get_expr(field.type.expr, prefix),
+ field.type.member.c_wiretype)
+
+ elif field.type.is_switch:
+ # switch is handled at the beginning of this function as a special case
+ count += serialize_fields(field.type, code_lines, temp_vars, space,
+ prefix="%s%s" % (prefix_str, field.c_field_name))
+
+ else:
+ # FIXME - variable sized field that is not a list
+ errmsg = '%s: warning: non-list object of variable size not supported for field %s\n'
+ sys.stderr.write(errmsg % (self.c_type, field.c_field_name))
+ length = '%s * sizeof(%s)' % ('Uh oh', field.type.c_wiretype)
+
+ # 3. save serialization C code
+ if value is not None:
+ # insert a comment so one can easily trace back to the XML
+ if field.type.fixed_size():
+ # field belongs to some anchestor structure
+ code_lines.append('%s /* %s.%s */' % (space, self.c_type, field.c_field_name))
+ else:
+ code_lines.append('%s /* %s */' % (space, field.c_field_name))
+
+ # set xcb_parts[].iov_base and xcb_parts[].iov_len
+ code_lines.append('%s%s' % (space, value))
+ code_lines.append('%s xcb_parts[xcb_parts_idx].iov_len = %s;' % (space, length))
+ # increase xcb_parts index
+ code_lines.append('%s xcb_parts_idx++;' % space)
+ count += 1
+
+ # record required memory
+ if field.type.fixed_size():
+ code_lines.append('%s xcb_block_len += %s;' % (space, length))
+ else:
+ # FIXME
+ count = insert_padding(count)
+ # raise Exception("obsolete - should not be reached")
+ # code_lines.append('%s xcb_unpadded = xcb_parts[xcb_parts_idx].iov_len;' % space)
+
+ count = end_block(count)
+ if count > 0:
+ temp_vars.add(' unsigned int xcb_parts_idx = 0;')
+ temp_vars.add(' unsigned int xcb_block_len = 0;')
+ if need_padding:
+ temp_vars.add(' unsigned int xcb_pad = 0;')
+ temp_vars.add(' char xcb_pad0[3] = {0, 0, 0};')
+ return count
+# serialize_fields()
+
+def _c_switch_aux_params(self):
+ # get the fields referenced by the switch expression
+ def get_expr_fields(expr):
+ if expr.op is None:
+ if expr.lenfield_name is not None:
+ return [expr.lenfield_name]
+ else:
+ if expr.op == '~':
+ return get_expr_fields(expr.rhs)
+ elif expr.op == 'popcount':
+ return get_expr_fields(expr.rhs)
+ elif expr.op == 'sumof':
+ return [expr.lenfield_name]
+ elif expr.op == 'enumref':
+ return []
+ else:
+ return get_expr_fields(expr.lhs) + get_expr_fields(expr.rhs)
+ # get_expr_fields()
+
+ # resolve the field names with the parent structure(s)
+ unresolved_fields = get_expr_fields(self.expr)
+ expr_fields = dict.fromkeys(unresolved_fields)
+ for p in reversed(self.parent):
+ parent_fields = dict((f.field_name, f) for f in p.fields)
+ if len(unresolved_fields) == 0:
+ break
+ for f in parent_fields.keys():
+ if f in unresolved_fields:
+ expr_fields[f] = parent_fields[f]
+ unresolved_fields.remove(f)
+
+ if None in expr_fields.values():
+ raise Exception("could not resolve all fields for <switch> %s" % self.name)
+
+ params = []
+ for name, field in expr_fields.iteritems():
+ params.append((field, name))
+
+ return params
+# _c_switch_aux_params()
+
+def get_serialize_params(self, buffer_var='_buffer', aux_var='_aux', unserialize=False):
+ param_fields, wire_fields = get_request_fields(self)
+ if self.is_switch:
+ switch_params = _c_switch_aux_params(self)
+ param_fields += [s[0] for s in switch_params]
+
+ # _serialize function parameters
+ params = [('void', '**', buffer_var)]
+ # parameter fields if any
+ if self.is_switch:
+ for p in switch_params:
+ typespec = p[0].c_field_const_type
+ pointerspec = p[0].c_pointer
+ params.append((typespec, pointerspec, p[0].c_field_name))
+ # aux argument - structure to be serialized
+ if not unserialize:
+ params.append(('const %s' % self.c_type, '*', aux_var))
+ else:
+ params.append(('%s' % self.c_type, '*', aux_var))
+ if not self.is_switch:
+ for p in param_fields:
+ if not p.type.fixed_size():
+ params.append((p.c_field_const_type, p.c_pointer, p.c_field_name))
+ return (param_fields, wire_fields, params)
+# get_serialize_params()
+
+def _c_serialize(self):
+ _h_setlevel(1)
+ _c_setlevel(1)
+
+ _hc('')
+ # _serialize() returns the buffer size
+ _hc('int')
+
+ variable_size_fields = 0
+ # maximum space required for type definition of function arguments
+ maxtypelen = 0
+ param_fields, wire_fields, params = get_serialize_params(self)
+
+ # determine N(variable_fields)
+ for field in param_fields:
+ # if self.is_switch, treat all fields as if they are variable sized
+ if not field.type.fixed_size() or self.is_switch:
+ variable_size_fields += 1
+ # determine maxtypelen
+ for p in params:
+ maxtypelen = max(maxtypelen, len(p[0]) + len(p[1]))
+
+ # write to .c/.h
+ for p in range(len(params)):
+ line = ""
+ typespec, pointerspec, field_name = params[p]
+ indent = ' '*(len(self.c_serialize_name)+2)
+ # p==0: function declaration
+ if 0==p:
+ line = "%s (" % self.c_serialize_name
+ indent = ''
+ spacing = ' '*(maxtypelen-len(typespec)-len(pointerspec))
+ line += "%s%s%s %s%s /**< */" % (indent, typespec, spacing, pointerspec, field_name)
+ if p < len(params)-1:
+ _hc("%s," % line)
+ else:
+ _h("%s);" % line)
+ _c("%s)" % line)
+
+ _c('{')
+ if not self.is_switch:
+ _c(' %s *xcb_out = *_buffer;', self.c_type)
+ _c(' unsigned int xcb_buffer_len = sizeof(%s);', self.c_type)
+ else:
+ _c(' char *xcb_out = *_buffer;')
+ _c(' unsigned int xcb_buffer_len = 0;')
+ if variable_size_fields > 0:
+ code_lines = []
+ temp_vars = set()
+ count = serialize_fields(self, code_lines, temp_vars,
+ serialize_fixed_size_fields=False)
+ # update variable size fields
+ variable_size_fields = count
+ _c(' struct iovec xcb_parts[%d];', count)
+ for t in temp_vars:
+ _c(t)
+ _c(' char *xcb_tmp;')
+ _c(' unsigned int i;')
+ if not self.is_switch:
+ _c(' unsigned int xcb_out_pad = -xcb_buffer_len & 3;')
+ _c(' /* add size of padding */')
+ _c(' xcb_buffer_len += xcb_out_pad;')
+
+ _c('')
+
+ if variable_size_fields > 0:
+ for l in code_lines:
+ _c(l)
+
+ # variable sized fields have been collected, now
+ # allocate memory and copy everything into a continuous memory area
+ _c(' if (NULL == xcb_out) {')
+ _c(' /* allocate memory */')
+ _c(' *_buffer = malloc(xcb_buffer_len);')
+ _c(' xcb_out = *_buffer;')
+ _c(' }')
+ _c('')
+
+ # fill in struct members
+ if not self.is_switch:
+ if len(wire_fields)>0:
+ _c(' *xcb_out = *_aux;')
+
+ # copy variable size fields into the buffer
+ if variable_size_fields > 0:
+ # xcb_out padding
+ if not self.is_switch:
+ _c(' xcb_tmp = (char*)++xcb_out;')
+ _c(' xcb_tmp += xcb_out_pad;')
+ else:
+ _c(' xcb_tmp = xcb_out;')
+
+ # variable sized fields
+ _c(' for(i=0; i<xcb_parts_idx; i++) {')
+# _c(' if (0 != xcb_parts[i].iov_base) {')
+ _c(' memcpy(xcb_tmp, xcb_parts[i].iov_base, xcb_parts[i].iov_len);')
+# _c(' }')
+ _c(' xcb_tmp += xcb_parts[i].iov_len;')
+ _c(' }')
+ _c('')
+ _c(' return xcb_buffer_len;')
+ _c('}')
+# _c_serialize()
+
+def _c_unserialize(self):
+ _h_setlevel(1)
+ _c_setlevel(1)
+
+ # _unserialize()
+ _hc('')
+ # _unserialize() returns the buffer size as well
+ _hc('int')
+
+
+ variable_size_fields = 0
+ # maximum space required for type definition of function arguments
+ maxtypelen = 0
+ param_fields, wire_fields, params = get_serialize_params(self, unserialize=True)
+
+ # determine N(variable_fields)
+ for field in param_fields:
+ # if self.is_switch, treat all fields as if they are variable sized
+ if not field.type.fixed_size() or self.is_switch:
+ variable_size_fields += 1
+ # determine maxtypelen
+ for p in params:
+ maxtypelen = max(maxtypelen, len(p[0]) + len(p[1]))
+
+ # write to .c/.h
+ for p in range(len(params)):
+ line = ""
+ typespec, pointerspec, field_name = params[p]
+ indent = ' '*(len(self.c_unserialize_name)+2)
+ # p==0: function declaration
+ if 0==p:
+ line = "%s (" % self.c_unserialize_name
+ indent = ''
+ pointerspec = '*'
+ spacing = ' '*(maxtypelen-len(typespec)-len(pointerspec))
+ line += "%s%s%s %s%s /**< */" % (indent, typespec, spacing, pointerspec, field_name)
+ if p < len(params)-1:
+ _hc("%s," % line)
+ else:
+ _h("%s);" % line)
+ _c("%s)" % line)
+
+ _c('{')
+ _c(' char *xcb_tmp = _buffer;')
+ _c(' unsigned int xcb_buffer_len = 0;')
+ _c(' unsigned int xcb_block_len = 0;')
+ _c('')
+ code_lines = []
+ unserialize_fields(self, code_lines)
+ for l in code_lines:
+ _c(l)
+ _c('')
+ _c(' return xcb_buffer_len;')
+ _c('}')
+# _c_unserialize()
+