2 # QAPI visitor generator
4 # Copyright IBM, Corp. 2011
5 # Copyright (C) 2014-2016 Red Hat, Inc.
12 # This work is licensed under the terms of the GNU GPL, version 2.
13 # See the COPYING file in the top-level directory.
19 def gen_visit_decl(name, scalar=False):
20 c_type = c_name(name) + ' *'
24 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp);
26 c_name=c_name(name), c_type=c_type)
29 def gen_visit_members_decl(name):
32 void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp);
37 def gen_visit_object_members(name, base, members, variants):
40 void visit_type_%(c_name)s_members(Visitor *v, %(c_name)s *obj, Error **errp)
49 visit_type_%(c_type)s_members(v, (%(c_type)s *)obj, &err);
52 ret += gen_err_check()
57 if (visit_optional(v, "%(name)s", &obj->has_%(c_name)s)) {
59 name=memb.name, c_name=c_name(memb.name))
62 visit_type_%(c_type)s(v, "%(name)s", &obj->%(c_name)s, &err);
64 c_type=memb.type.c_name(), name=memb.name,
65 c_name=c_name(memb.name))
66 ret += gen_err_check()
75 switch (obj->%(c_name)s) {
77 c_name=c_name(variants.tag_member.name))
79 for var in variants.variants:
82 visit_type_%(c_type)s_members(v, &obj->u.%(c_name)s, &err);
85 case=c_enum_const(variants.tag_member.type.name,
87 variants.tag_member.type.prefix),
88 c_type=var.type.c_name(), c_name=c_name(var.name))
96 # 'goto out' produced for base, for each member, and if variants were
98 if base or members or variants:
104 error_propagate(errp, err);
110 def gen_visit_list(name, element_type):
113 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
117 size_t size = sizeof(**obj);
119 visit_start_list(v, name, (GenericList **)obj, size, &err);
124 for (tail = *obj; tail;
125 tail = (%(c_name)s *)visit_next_list(v, (GenericList *)tail, size)) {
126 visit_type_%(c_elt_type)s(v, NULL, &tail->value, &err);
133 if (err && visit_is_input(v)) {
134 qapi_free_%(c_name)s(*obj);
138 error_propagate(errp, err);
141 c_name=c_name(name), c_elt_type=element_type.c_name())
144 def gen_visit_enum(name):
147 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
150 visit_type_enum(v, name, &value, %(c_name)s_lookup, errp);
157 def gen_visit_alternate(name, variants):
160 for var in variants.variants:
161 if var.type.alternate_qtype() == 'QTYPE_QINT':
162 promote_int = 'false'
166 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
170 visit_start_alternate(v, name, (GenericAlternate **)obj, sizeof(**obj),
171 %(promote_int)s, &err);
175 switch ((*obj)->type) {
177 c_name=c_name(name), promote_int=promote_int)
179 for var in variants.variants:
183 case=var.type.alternate_qtype())
184 if isinstance(var.type, QAPISchemaObjectType):
186 visit_start_struct(v, name, NULL, 0, &err);
190 visit_type_%(c_type)s_members(v, &(*obj)->u.%(c_name)s, &err);
192 visit_check_struct(v, &err);
196 c_type=var.type.c_name(),
197 c_name=c_name(var.name))
200 visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
202 c_type=var.type.c_name(),
203 c_name=c_name(var.name))
210 error_setg(&err, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
213 visit_end_alternate(v);
214 if (err && visit_is_input(v)) {
215 qapi_free_%(c_name)s(*obj);
219 error_propagate(errp, err);
222 name=name, c_name=c_name(name))
227 def gen_visit_object(name, base, members, variants):
230 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
234 visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
241 visit_type_%(c_name)s_members(v, *obj, &err);
245 visit_check_struct(v, &err);
248 if (err && visit_is_input(v)) {
249 qapi_free_%(c_name)s(*obj);
253 error_propagate(errp, err);
259 class QAPISchemaGenVisitVisitor(QAPISchemaVisitor):
265 def visit_begin(self, schema):
268 self._btin = guardstart('QAPI_VISIT_BUILTIN')
271 # To avoid header dependency hell, we always generate
272 # declarations for built-in types in our header files and
273 # simply guard them. See also do_builtins (command line
275 self._btin += guardend('QAPI_VISIT_BUILTIN')
276 self.decl = self._btin + self.decl
279 def visit_enum_type(self, name, info, values, prefix):
280 # Special case for our lone builtin enum type
281 # TODO use something cleaner than existence of info
283 self._btin += gen_visit_decl(name, scalar=True)
285 self.defn += gen_visit_enum(name)
287 self.decl += gen_visit_decl(name, scalar=True)
288 self.defn += gen_visit_enum(name)
290 def visit_array_type(self, name, info, element_type):
291 decl = gen_visit_decl(name)
292 defn = gen_visit_list(name, element_type)
293 if isinstance(element_type, QAPISchemaBuiltinType):
301 def visit_object_type(self, name, info, base, members, variants):
302 # Nothing to do for the special empty builtin
303 if name == 'q_empty':
305 self.decl += gen_visit_members_decl(name)
306 self.defn += gen_visit_object_members(name, base, members, variants)
307 # TODO Worth changing the visitor signature, so we could
308 # directly use rather than repeat type.is_implicit()?
309 if not name.startswith('q_'):
310 # only explicit types need an allocating visit
311 self.decl += gen_visit_decl(name)
312 self.defn += gen_visit_object(name, base, members, variants)
314 def visit_alternate_type(self, name, info, variants):
315 self.decl += gen_visit_decl(name)
316 self.defn += gen_visit_alternate(name, variants)
318 # If you link code generated from multiple schemata, you want only one
319 # instance of the code for built-in types. Generate it only when
320 # do_builtins, enabled by command line option -b. See also
321 # QAPISchemaGenVisitVisitor.visit_end().
324 (input_file, output_dir, do_c, do_h, prefix, opts) = \
325 parse_command_line("b", ["builtins"])
328 if o in ("-b", "--builtins"):
333 * schema-defined QAPI visitor functions
335 * Copyright IBM, Corp. 2011
340 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
341 * See the COPYING.LIB file in the top-level directory.
347 * schema-defined QAPI visitor functions
349 * Copyright IBM, Corp. 2011
354 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
355 * See the COPYING.LIB file in the top-level directory.
360 (fdef, fdecl) = open_output(output_dir, do_c, do_h, prefix,
361 'qapi-visit.c', 'qapi-visit.h',
362 c_comment, h_comment)
365 #include "qemu/osdep.h"
366 #include "qemu-common.h"
367 #include "qapi/error.h"
368 #include "%(prefix)sqapi-visit.h"
372 fdecl.write(mcgen('''
373 #include "qapi/visitor.h"
374 #include "qapi/qmp/qerror.h"
375 #include "%(prefix)sqapi-types.h"
380 schema = QAPISchema(input_file)
381 gen = QAPISchemaGenVisitVisitor()
384 fdecl.write(gen.decl)
386 close_output(fdef, fdecl)