include/qapi/visitor.h

64  * bool visit_type_FOO(Visitor *v, const char *name, T obj, Error **errp);
78  * The visit_type_FOO() functions take a non-null @obj argument; they
79  * allocate *@obj during input visits, leave it unchanged during
89  * visitor, then *@obj will be set to NULL for pointer types, and left
105  * bool visit_type_FOO_members(Visitor *v, FOO *obj, Error **errp);
114  * void qapi_free_FOO(FOO *obj);
116  * Does nothing when @obj is NULL.
127  * BASE *qapi_CHILD_base(CHILD *obj);
275  * Start visiting an object @obj (struct or union).
280  * @obj must be non-NULL for a real walk, in which case @size
282  * into *@obj.  @obj may also be NULL for a virtual walk, in which
285  * On failure, set *@obj to NULL and store an error through @errp.
293  * with the same @obj to clean up, even if intermediate visits fail.
299 bool visit_start_struct(Visitor *v, const char *name, void **obj,
320  * @obj must match what was passed to the paired visit_start_struct().
327 void visit_end_struct(Visitor *v, void **obj);
354  * NULL and obj set to the address of the value member of the list
373  * that function's name parameter set to NULL and obj set to the
409  * Start the visit of an alternate @obj.
414  * @obj must not be NULL. Input and clone visitors use @size to
415  * determine how much memory to allocate into *@obj, then determine
417  * (*@obj)->type.  Other visitors leave @obj unchanged.
419  * On failure, set *@obj to NULL and store an error through @errp.
425  * the same @obj to clean up, even if visiting the contents of the
429                            GenericAlternate **obj, size_t size,
435  * @obj must match what was passed to the paired visit_start_alternate().
443 void visit_end_alternate(Visitor *v, void **obj);
504  * @obj must be non-NULL.  Input visitors parse input and set *@obj to
505  * the enumeration value, leaving @obj unchanged on error; other
506  * visitors use *@obj but leave it unchanged.
522 bool visit_type_enum(Visitor *v, const char *name, int *obj,
543  * @obj must be non-NULL.  Input visitors set *@obj to the value;
544  * other visitors will leave *@obj unchanged.
551 bool visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp);
557 bool visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
564 bool visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
571 bool visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
579 bool visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
586 bool visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp);
592 bool visit_type_int16(Visitor *v, const char *name, int16_t *obj,
599 bool visit_type_int32(Visitor *v, const char *name, int32_t *obj,
606 bool visit_type_int64(Visitor *v, const char *name, int64_t *obj,
615 bool visit_type_size(Visitor *v, const char *name, uint64_t *obj,
624  * @obj must be non-NULL.  Input visitors set *@obj to the value;
625  * other visitors will leave *@obj unchanged.
632 bool visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp);
640  * @obj must be non-NULL.  Input and clone visitors set *@obj to the
642  * Other visitors leave *@obj unchanged, and commonly treat NULL like
646  * into @obj for use by an output visitor.
648  * On failure, set *@obj to NULL and store an error through @errp.
653  * FIXME: Callers that try to output NULL *obj should not be allowed.
655 bool visit_type_str(Visitor *v, const char *name, char **obj, Error **errp);
663  * @obj must be non-NULL.  Input visitors set *@obj to the value;
664  * other visitors will leave *@obj unchanged.  Visitors should
672 bool visit_type_number(Visitor *v, const char *name, double *obj,
681  * @obj must be non-NULL.  Input visitors set *@obj to the value;
682  * other visitors will leave *@obj unchanged.  *@obj must be non-NULL
685  * On failure, set *@obj to NULL and store an error through @errp.
694 bool visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp);
702  * @obj must be non-NULL.  Input visitors set *@obj to the value;
703  * other visitors ignore *@obj.
705  * On failure, set *@obj to NULL and store an error through @errp.
710 bool visit_type_null(Visitor *v, const char *name, QNull **obj,