include/qom/object.h

35  * @obj: the object that owns the property
43 typedef void (ObjectPropertyAccessor)(Object *obj,
51  * @obj: the object that owns the property
60  * Returns: If @path is the path that led to @obj, the function
64 typedef Object *(ObjectPropertyResolve)(Object *obj,
70  * @obj: the object that owns the property
76 typedef void (ObjectPropertyRelease)(Object *obj,
82  * @obj: the object that owns the property
87 typedef void (ObjectPropertyInit)(Object *obj, ObjectProperty *prop);
105  * @obj: the object that is being removed from the composition tree
108  * The function should remove any backlinks from children objects to @obj.
110 typedef void (ObjectUnparent)(Object *obj);
114  * @obj: the object being freed
118 typedef void (ObjectFree)(void *obj);
178     OBJ_NAME(const void *obj) \
179     { return OBJECT_CHECK(InstanceType, obj, TYPENAME); }
195     OBJ_NAME##_GET_CLASS(const void *obj) \
196     { return OBJECT_GET_CLASS(ClassType, obj, TYPENAME); } \
281     module_obj_name##_finalize(Object *obj); \
285     module_obj_name##_init(Object *obj); \
483     void (*instance_init)(Object *obj);
484     void (*instance_post_init)(Object *obj);
485     void (*instance_finalize)(Object *obj);
499  * @obj: A derivative of #Object
504 #define OBJECT(obj) \  argument
505     ((Object *)(obj))
520  * @obj: A derivative of @type to cast.
530 #define OBJECT_CHECK(type, obj, name) \  argument
531     ((type *)object_dynamic_cast_assert(OBJECT(obj), (name), \
551  * @obj: The object to obtain the class for.
552  * @name: The QOM typename of @obj.
558 #define OBJECT_GET_CLASS(class, obj, name) \  argument
559     OBJECT_CLASS_CHECK(class, object_get_class(OBJECT(obj)), name)
602  * @obj: the object to convert to an interface
605  * Returns: @obj casted to @interface if cast is valid, otherwise raise error.
607 #define INTERFACE_CHECK(interface, obj, name) \  argument
608     ((interface *)object_dynamic_cast_assert(OBJECT((obj)), (name), \
660  *      Object *obj;
662  *      obj = object_new_with_props(TYPE_MEMORY_BACKEND_FILE,
672  *      if (!obj) {
703 bool object_apply_global_props(Object *obj, const GPtrArray *props,
709 void object_apply_compat_props(Object *obj);
713  * @obj: the object instance to set properties on
728  *      Object *obj = ...get / create object...;
730  *      if (!object_set_props(obj,
745 bool object_set_props(Object *obj, Error **errp, ...) G_GNUC_NULL_TERMINATED;
749  * @obj: the object instance to set properties on
757 bool object_set_propv(Object *obj, Error **errp, va_list vargs);
761  * @obj: A pointer to the memory to be used for the object.
762  * @size: The maximum size available at @obj for the object.
769 void object_initialize(void *obj, size_t size, const char *typename);
841  * @obj: The object to cast.
844  * This function will determine if @obj is-a @typename.  @obj can refer to an
847  * Returns: This function returns @obj on success or #NULL on failure.
849 Object *object_dynamic_cast(Object *obj, const char *typename);
853  * @obj: The object to cast.
865 Object *object_dynamic_cast_assert(Object *obj, const char *typename,
870  * @obj: A derivative of #Object
872  * Returns: The #ObjectClass of the type associated with @obj.
874 ObjectClass *object_get_class(Object *obj);
878  * @obj: A derivative of #Object.
880  * Returns: The QOM typename of @obj.
882 const char *object_get_typename(const Object *obj);
927  * @obj: a QOM object
934  * then set the corresponding property in @obj.
936 void object_set_properties_from_keyval(Object *obj, const QDict *qdict,
1046  * @obj: the object
1050  * Returns: @obj
1052 Object *object_ref(void *obj);
1056  * @obj: the object
1061 void object_unref(void *obj);
1065  * @obj: the object to add a property to
1086 ObjectProperty *object_property_try_add(Object *obj, const char *name,
1098  * @obj: the object to add a property to
1115 ObjectProperty *object_property_add(Object *obj, const char *name,
1122 void object_property_del(Object *obj, const char *name);
1177  * @obj: the object
1184 ObjectProperty *object_property_find(Object *obj, const char *name);
1188  * @obj: the object
1196 ObjectProperty *object_property_find_err(Object *obj,
1234  * @obj: the object
1250  *      object_property_iter_init(&iter, obj);
1256                                Object *obj);
1289 void object_unparent(Object *obj);
1293  * @obj: the object
1303 bool object_property_get(Object *obj, const char *name, Visitor *v,
1308  * @obj: the object
1317 bool object_property_set_str(Object *obj, const char *name,
1322  * @obj: the object
1330 char *object_property_get_str(Object *obj, const char *name,
1335  * @obj: the object
1348 bool object_property_set_link(Object *obj, const char *name,
1353  * @obj: the object
1361 Object *object_property_get_link(Object *obj, const char *name,
1366  * @obj: the object
1375 bool object_property_set_bool(Object *obj, const char *name,
1380  * @obj: the object
1387 bool object_property_get_bool(Object *obj, const char *name,
1392  * @obj: the object
1401 bool object_property_set_int(Object *obj, const char *name,
1406  * @obj: the object
1413 int64_t object_property_get_int(Object *obj, const char *name,
1418  * @obj: the object
1427 bool object_property_set_uint(Object *obj, const char *name,
1432  * @obj: the object
1439 uint64_t object_property_get_uint(Object *obj, const char *name,
1444  * @obj: the object
1453 int object_property_get_enum(Object *obj, const char *name,
1458  * @obj: the object
1469 bool object_property_set(Object *obj, const char *name, Visitor *v,
1474  * @obj: the object
1483 bool object_property_parse(Object *obj, const char *name,
1488  * @obj: the object
1496 char *object_property_print(Object *obj, const char *name, bool human,
1501  * @obj: the object
1507 const char *object_property_get_type(Object *obj, const char *name,
1552  * @obj: the object
1558 const char *object_get_canonical_path_component(const Object *obj);
1562  * @obj: the object
1568 char *object_get_canonical_path(const Object *obj);
1655  * @obj: the object to add a property to
1672 ObjectProperty *object_property_try_add_child(Object *obj, const char *name,
1677  * @obj: the object to add a property to
1684 ObjectProperty *object_property_add_child(Object *obj, const char *name,
1698  * @obj: the object to add a property to
1707 void object_property_allow_set_link(const Object *obj, const char *name,
1712  * @obj: the object to add a property to
1740 ObjectProperty *object_property_add_link(Object *obj, const char *name,
1742                               void (*check)(const Object *obj, const char *name,
1749                               void (*check)(const Object *obj, const char *name,
1755  * @obj: the object to add a property to
1766 ObjectProperty *object_property_add_str(Object *obj, const char *name,
1778  * @obj: the object to add a property to
1788 ObjectProperty *object_property_add_bool(Object *obj, const char *name,
1799  * @obj: the object to add a property to
1811 ObjectProperty *object_property_add_enum(Object *obj, const char *name,
1826  * @obj: the object to add a property to
1835 ObjectProperty *object_property_add_tm(Object *obj, const char *name,
1853  * @obj: the object to add a property to
1863 ObjectProperty *object_property_add_uint8_ptr(Object *obj, const char *name,
1874  * @obj: the object to add a property to
1884 ObjectProperty *object_property_add_uint16_ptr(Object *obj, const char *name,
1895  * @obj: the object to add a property to
1905 ObjectProperty *object_property_add_uint32_ptr(Object *obj, const char *name,
1916  * @obj: the object to add a property to
1926 ObjectProperty *object_property_add_uint64_ptr(Object *obj, const char *name,
1937  * @obj: the object to add a property to
1952 ObjectProperty *object_property_add_alias(Object *obj, const char *name,
1957  * @obj: the object to add a property to
1965  * this property exists.  In the case @target is a child of @obj,
1971 ObjectProperty *object_property_add_const_link(Object *obj, const char *name,
1976  * @obj: the object owning the property
1984 void object_property_set_description(Object *obj, const char *name,
1991  * @obj: the object whose children will be navigated
1995  * Call @fn passing each child of @obj and @opaque to it, until @fn returns
1998  * It is forbidden to add or remove children from @obj from the @fn
2003 int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
2008  * @obj: the object whose children will be navigated
2012  * Call @fn passing each child of @obj and @opaque to it, until @fn returns
2013  * non-zero. Calls recursively, all child nodes of @obj will also be passed
2016  * It is forbidden to add or remove children from @obj (or its
2021 int object_child_foreach_recursive(Object *obj,
2027  * @obj: the parent object
2035 Object *object_property_add_new_container(Object *obj, const char *name);