scripts/qapi-visit.py

   1 #
   2 # QAPI visitor generator
   3 #
   4 # Copyright IBM, Corp. 2011
   5 #
   6 # Authors:
   7 #  Anthony Liguori <aliguori@us.ibm.com>
   8 #  Michael Roth    <mdroth@linux.vnet.ibm.com>
   9 #
  10 # This work is licensed under the terms of the GNU GPLv2.
  11 # See the COPYING.LIB file in the top-level directory.
  12
  13 from ordereddict import OrderedDict
  14 from qapi import *
  15 import sys
  16 import os
  17 import getopt
  18 import errno
  19
  20 def generate_visit_struct_body(field_prefix, members):
  21     ret = ""
  22     if len(field_prefix):
  23         field_prefix = field_prefix + "."
  24     for argname, argentry, optional, structured in parse_args(members):
  25         if optional:
  26             ret += mcgen('''
  27 visit_start_optional(m, (obj && *obj) ? &(*obj)->%(c_prefix)shas_%(c_name)s : NULL, "%(name)s", errp);
  28 if ((*obj)->%(prefix)shas_%(c_name)s) {
  29 ''',
  30                          c_prefix=c_var(field_prefix), prefix=field_prefix,
  31                          c_name=c_var(argname), name=argname)
  32             push_indent()
  33
  34         if structured:
  35             ret += mcgen('''
  36 visit_start_struct(m, NULL, "", "%(name)s", 0, errp);
  37 ''',
  38                          name=argname)
  39             ret += generate_visit_struct_body(field_prefix + argname, argentry)
  40             ret += mcgen('''
  41 visit_end_struct(m, errp);
  42 ''')
  43         else:
  44             ret += mcgen('''
  45 visit_type_%(type)s(m, (obj && *obj) ? &(*obj)->%(c_prefix)s%(c_name)s : NULL, "%(name)s", errp);
  46 ''',
  47                          c_prefix=c_var(field_prefix), prefix=field_prefix,
  48                          type=type_name(argentry), c_name=c_var(argname),
  49                          name=argname)
  50
  51         if optional:
  52             pop_indent()
  53             ret += mcgen('''
  54 }
  55 visit_end_optional(m, errp);
  56 ''')
  57     return ret
  58
  59 def generate_visit_struct(name, members):
  60     ret = mcgen('''
  61
  62 void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp)
  63 {
  64     visit_start_struct(m, (void **)obj, "%(name)s", name, sizeof(%(name)s), errp);
  65 ''',
  66                 name=name)
  67     push_indent()
  68     ret += generate_visit_struct_body("", members)
  69     pop_indent()
  70
  71     ret += mcgen('''
  72     visit_end_struct(m, errp);
  73 }
  74 ''')
  75     return ret
  76
  77 def generate_visit_list(name, members):
  78     return mcgen('''
  79
  80 void visit_type_%(name)sList(Visitor *m, %(name)sList ** obj, const char *name, Error **errp)
  81 {
  82     GenericList *i, **head = (GenericList **)obj;
  83
  84     visit_start_list(m, name, errp);
  85
  86     for (*head = i = visit_next_list(m, head, errp); i; i = visit_next_list(m, &i, errp)) {
  87         %(name)sList *native_i = (%(name)sList *)i;
  88         visit_type_%(name)s(m, &native_i->value, NULL, errp);
  89     }
  90
  91     visit_end_list(m, errp);
  92 }
  93 ''',
  94                 name=name)
  95
  96 def generate_visit_enum(name, members):
  97     return mcgen('''
  98
  99 void visit_type_%(name)s(Visitor *m, %(name)s * obj, const char *name, Error **errp)
 100 {
 101     visit_type_enum(m, (int *)obj, %(name)s_lookup, "%(name)s", name, errp);
 102 }
 103 ''',
 104                  name=name)
 105
 106 def generate_visit_union(name, members):
 107     ret = generate_visit_enum('%sKind' % name, members.keys())
 108
 109     ret += mcgen('''
 110
 111 void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp)
 112 {
 113     Error *err = NULL;
 114
 115     visit_start_struct(m, (void **)obj, "%(name)s", name, sizeof(%(name)s), &err);
 116     visit_type_%(name)sKind(m, &(*obj)->kind, "type", &err);
 117     if (err) {
 118         error_propagate(errp, err);
 119         goto end;
 120     }
 121     switch ((*obj)->kind) {
 122 ''',
 123                  name=name)
 124
 125     for key in members:
 126         ret += mcgen('''
 127     case %(abbrev)s_KIND_%(enum)s:
 128         visit_type_%(c_type)s(m, &(*obj)->%(c_name)s, "data", errp);
 129         break;
 130 ''',
 131                 abbrev = de_camel_case(name).upper(),
 132                 enum = de_camel_case(key).upper(),
 133                 c_type=members[key],
 134                 c_name=c_var(key))
 135
 136     ret += mcgen('''
 137     default:
 138         abort();
 139     }
 140 end:
 141     visit_end_struct(m, errp);
 142 }
 143 ''')
 144
 145     return ret
 146
 147 def generate_declaration(name, members, genlist=True):
 148     ret = mcgen('''
 149
 150 void visit_type_%(name)s(Visitor *m, %(name)s ** obj, const char *name, Error **errp);
 151 ''',
 152                 name=name)
 153
 154     if genlist:
 155         ret += mcgen('''
 156 void visit_type_%(name)sList(Visitor *m, %(name)sList ** obj, const char *name, Error **errp);
 157 ''',
 158                  name=name)
 159
 160     return ret
 161
 162 def generate_decl_enum(name, members, genlist=True):
 163     return mcgen('''
 164
 165 void visit_type_%(name)s(Visitor *m, %(name)s * obj, const char *name, Error **errp);
 166 ''',
 167                 name=name)
 168
 169 try:
 170     opts, args = getopt.gnu_getopt(sys.argv[1:], "chp:o:",
 171                                    ["source", "header", "prefix=", "output-dir="])
 172 except getopt.GetoptError, err:
 173     print str(err)
 174     sys.exit(1)
 175
 176 output_dir = ""
 177 prefix = ""
 178 c_file = 'qapi-visit.c'
 179 h_file = 'qapi-visit.h'
 180
 181 do_c = False
 182 do_h = False
 183
 184 for o, a in opts:
 185     if o in ("-p", "--prefix"):
 186         prefix = a
 187     elif o in ("-o", "--output-dir"):
 188         output_dir = a + "/"
 189     elif o in ("-c", "--source"):
 190         do_c = True
 191     elif o in ("-h", "--header"):
 192         do_h = True
 193
 194 if not do_c and not do_h:
 195     do_c = True
 196     do_h = True
 197
 198 c_file = output_dir + prefix + c_file
 199 h_file = output_dir + prefix + h_file
 200
 201 try:
 202     os.makedirs(output_dir)
 203 except os.error, e:
 204     if e.errno != errno.EEXIST:
 205         raise
 206
 207 def maybe_open(really, name, opt):
 208     if really:
 209         return open(name, opt)
 210     else:
 211         import StringIO
 212         return StringIO.StringIO()
 213
 214 fdef = maybe_open(do_c, c_file, 'w')
 215 fdecl = maybe_open(do_h, h_file, 'w')
 216
 217 fdef.write(mcgen('''
 218 /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
 219
 220 /*
 221  * schema-defined QAPI visitor functions
 222  *
 223  * Copyright IBM, Corp. 2011
 224  *
 225  * Authors:
 226  *  Anthony Liguori   <aliguori@us.ibm.com>
 227  *
 228  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 229  * See the COPYING.LIB file in the top-level directory.
 230  *
 231  */
 232
 233 #include "%(header)s"
 234 ''',
 235                  header=basename(h_file)))
 236
 237 fdecl.write(mcgen('''
 238 /* THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY */
 239
 240 /*
 241  * schema-defined QAPI visitor function
 242  *
 243  * Copyright IBM, Corp. 2011
 244  *
 245  * Authors:
 246  *  Anthony Liguori   <aliguori@us.ibm.com>
 247  *
 248  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
 249  * See the COPYING.LIB file in the top-level directory.
 250  *
 251  */
 252
 253 #ifndef %(guard)s
 254 #define %(guard)s
 255
 256 #include "qapi/qapi-visit-core.h"
 257 #include "%(prefix)sqapi-types.h"
 258 ''',
 259                   prefix=prefix, guard=guardname(h_file)))
 260
 261 exprs = parse_schema(sys.stdin)
 262
 263 for expr in exprs:
 264     if expr.has_key('type'):
 265         ret = generate_visit_struct(expr['type'], expr['data'])
 266         ret += generate_visit_list(expr['type'], expr['data'])
 267         fdef.write(ret)
 268
 269         ret = generate_declaration(expr['type'], expr['data'])
 270         fdecl.write(ret)
 271     elif expr.has_key('union'):
 272         ret = generate_visit_union(expr['union'], expr['data'])
 273         ret += generate_visit_list(expr['union'], expr['data'])
 274         fdef.write(ret)
 275
 276         ret = generate_decl_enum('%sKind' % expr['union'], expr['data'].keys())
 277         ret += generate_declaration(expr['union'], expr['data'])
 278         fdecl.write(ret)
 279     elif expr.has_key('enum'):
 280         ret = generate_visit_enum(expr['enum'], expr['data'])
 281         fdef.write(ret)
 282
 283         ret = generate_decl_enum(expr['enum'], expr['data'])
 284         fdecl.write(ret)
 285
 286 fdecl.write('''
 287 #endif
 288 ''')
 289
 290 fdecl.flush()
 291 fdecl.close()
 292
 293 fdef.flush()
 294 fdef.close()