mirror of
https://github.com/qemu/qemu.git
synced 2024-12-17 17:23:52 +08:00
c9ac145843
This adds a function that, given a QDict of non-help options, prints help for user creatable objects. Signed-off-by: Kevin Wolf <kwolf@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20201007164903.282198-4-kwolf@redhat.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
207 lines
6.7 KiB
C
207 lines
6.7 KiB
C
#ifndef OBJECT_INTERFACES_H
|
|
#define OBJECT_INTERFACES_H
|
|
|
|
#include "qom/object.h"
|
|
#include "qapi/visitor.h"
|
|
|
|
#define TYPE_USER_CREATABLE "user-creatable"
|
|
|
|
typedef struct UserCreatableClass UserCreatableClass;
|
|
DECLARE_CLASS_CHECKERS(UserCreatableClass, USER_CREATABLE,
|
|
TYPE_USER_CREATABLE)
|
|
#define USER_CREATABLE(obj) \
|
|
INTERFACE_CHECK(UserCreatable, (obj), \
|
|
TYPE_USER_CREATABLE)
|
|
|
|
typedef struct UserCreatable UserCreatable;
|
|
|
|
/**
|
|
* UserCreatableClass:
|
|
* @parent_class: the base class
|
|
* @complete: callback to be called after @obj's properties are set.
|
|
* @can_be_deleted: callback to be called before an object is removed
|
|
* to check if @obj can be removed safely.
|
|
*
|
|
* Interface is designed to work with -object/object-add/object_add
|
|
* commands.
|
|
* Interface is mandatory for objects that are designed to be user
|
|
* creatable (i.e. -object/object-add/object_add, will accept only
|
|
* objects that inherit this interface).
|
|
*
|
|
* Interface also provides an optional ability to do the second
|
|
* stage * initialization of the object after its properties were
|
|
* set.
|
|
*
|
|
* For objects created without using -object/object-add/object_add,
|
|
* @user_creatable_complete() wrapper should be called manually if
|
|
* object's type implements USER_CREATABLE interface and needs
|
|
* complete() callback to be called.
|
|
*/
|
|
struct UserCreatableClass {
|
|
/* <private> */
|
|
InterfaceClass parent_class;
|
|
|
|
/* <public> */
|
|
void (*complete)(UserCreatable *uc, Error **errp);
|
|
bool (*can_be_deleted)(UserCreatable *uc);
|
|
};
|
|
|
|
/**
|
|
* user_creatable_complete:
|
|
* @uc: the user-creatable object whose complete() method is called if defined
|
|
* @errp: if an error occurs, a pointer to an area to store the error
|
|
*
|
|
* Wrapper to call complete() method if one of types it's inherited
|
|
* from implements USER_CREATABLE interface, otherwise the call does
|
|
* nothing.
|
|
*
|
|
* Returns: %true on success, %false on failure.
|
|
*/
|
|
bool user_creatable_complete(UserCreatable *uc, Error **errp);
|
|
|
|
/**
|
|
* user_creatable_can_be_deleted:
|
|
* @uc: the object whose can_be_deleted() method is called if implemented
|
|
*
|
|
* Wrapper to call can_be_deleted() method if one of types it's inherited
|
|
* from implements USER_CREATABLE interface.
|
|
*/
|
|
bool user_creatable_can_be_deleted(UserCreatable *uc);
|
|
|
|
/**
|
|
* user_creatable_add_type:
|
|
* @type: the object type name
|
|
* @id: the unique ID for the object
|
|
* @qdict: the object properties
|
|
* @v: the visitor
|
|
* @errp: if an error occurs, a pointer to an area to store the error
|
|
*
|
|
* Create an instance of the user creatable object @type, placing
|
|
* it in the object composition tree with name @id, initializing
|
|
* it with properties from @qdict
|
|
*
|
|
* Returns: the newly created object or NULL on error
|
|
*/
|
|
Object *user_creatable_add_type(const char *type, const char *id,
|
|
const QDict *qdict,
|
|
Visitor *v, Error **errp);
|
|
|
|
/**
|
|
* user_creatable_add_dict:
|
|
* @qdict: the object definition
|
|
* @keyval: if true, use a keyval visitor for processing @qdict (i.e.
|
|
* assume that all @qdict values are strings); otherwise, use
|
|
* the normal QObject visitor (i.e. assume all @qdict values
|
|
* have the QType expected by the QOM object type)
|
|
* @errp: if an error occurs, a pointer to an area to store the error
|
|
*
|
|
* Create an instance of the user creatable object that is defined by
|
|
* @qdict. The object type is taken from the QDict key 'qom-type', its
|
|
* ID from the key 'id'. The remaining entries in @qdict are used to
|
|
* initialize the object properties.
|
|
*
|
|
* Returns: %true on success, %false on failure.
|
|
*/
|
|
bool user_creatable_add_dict(QDict *qdict, bool keyval, Error **errp);
|
|
|
|
/**
|
|
* user_creatable_add_opts:
|
|
* @opts: the object definition
|
|
* @errp: if an error occurs, a pointer to an area to store the error
|
|
*
|
|
* Create an instance of the user creatable object whose type
|
|
* is defined in @opts by the 'qom-type' option, placing it
|
|
* in the object composition tree with name provided by the
|
|
* 'id' field. The remaining options in @opts are used to
|
|
* initialize the object properties.
|
|
*
|
|
* Returns: the newly created object or NULL on error
|
|
*/
|
|
Object *user_creatable_add_opts(QemuOpts *opts, Error **errp);
|
|
|
|
|
|
/**
|
|
* user_creatable_add_opts_predicate:
|
|
* @type: the QOM type to be added
|
|
*
|
|
* A callback function to determine whether an object
|
|
* of type @type should be created. Instances of this
|
|
* callback should be passed to user_creatable_add_opts_foreach
|
|
*/
|
|
typedef bool (*user_creatable_add_opts_predicate)(const char *type);
|
|
|
|
/**
|
|
* user_creatable_add_opts_foreach:
|
|
* @opaque: a user_creatable_add_opts_predicate callback or NULL
|
|
* @opts: options to create
|
|
* @errp: unused
|
|
*
|
|
* An iterator callback to be used in conjunction with
|
|
* the qemu_opts_foreach() method for creating a list of
|
|
* objects from a set of QemuOpts
|
|
*
|
|
* The @opaque parameter can be passed a user_creatable_add_opts_predicate
|
|
* callback to filter which types of object are created during iteration.
|
|
* When it fails, report the error.
|
|
*
|
|
* Returns: 0 on success, -1 when an error was reported.
|
|
*/
|
|
int user_creatable_add_opts_foreach(void *opaque,
|
|
QemuOpts *opts, Error **errp);
|
|
|
|
/**
|
|
* user_creatable_print_help:
|
|
* @type: the QOM type to be added
|
|
* @opts: options to create
|
|
*
|
|
* Prints help if requested in @type or @opts. Note that if @type is neither
|
|
* "help"/"?" nor a valid user creatable type, no help will be printed
|
|
* regardless of @opts.
|
|
*
|
|
* Returns: true if a help option was found and help was printed, false
|
|
* otherwise.
|
|
*/
|
|
bool user_creatable_print_help(const char *type, QemuOpts *opts);
|
|
|
|
/**
|
|
* user_creatable_print_help_from_qdict:
|
|
* @args: options to create
|
|
*
|
|
* Prints help considering the other options given in @args (if "qom-type" is
|
|
* given and valid, print properties for the type, otherwise print valid types)
|
|
*
|
|
* In contrast to user_creatable_print_help(), this function can't return that
|
|
* no help was requested. It should only be called if we know that help is
|
|
* requested and it will always print some help.
|
|
*/
|
|
void user_creatable_print_help_from_qdict(QDict *args);
|
|
|
|
/**
|
|
* user_creatable_del:
|
|
* @id: the unique ID for the object
|
|
* @errp: if an error occurs, a pointer to an area to store the error
|
|
*
|
|
* Delete an instance of the user creatable object identified
|
|
* by @id.
|
|
*
|
|
* Returns: %true on success, %false on failure.
|
|
*/
|
|
bool user_creatable_del(const char *id, Error **errp);
|
|
|
|
/**
|
|
* user_creatable_cleanup:
|
|
*
|
|
* Delete all user-creatable objects and the user-creatable
|
|
* objects container.
|
|
*/
|
|
void user_creatable_cleanup(void);
|
|
|
|
/**
|
|
* qmp_object_add:
|
|
*
|
|
* QMP command handler for object-add. See the QAPI schema for documentation.
|
|
*/
|
|
void qmp_object_add(QDict *qdict, QObject **ret_data, Error **errp);
|
|
|
|
#endif
|