include/qom/object.h

9  * This work is licensed under the terms of the GNU GPL, version 2 or later.
145  * The base for all objects.  The first member of this object is a pointer to
151  * first member.  This allows identification of the real type of the object at
170  * Direct usage of this macro should be avoided, and the complete
173  * This macro will provide the instance type cast functions for a
187  * Direct usage of this macro should be avoided, and the complete
190  * This macro will provide the class type cast functions for a
209  * Direct usage of this macro should be avoided, and the complete
212  * This macro will provide the three standard type cast functions for a
226  * This macro is typically used in a header file, and will:
248  * This does the same as OBJECT_DECLARE_TYPE(), but with no class struct
251  * This macro should be used unless the class struct needs to have
273  * This is the base macro used to implement all the OBJECT_DEFINE_*
317  * This macro is typically used in a source file, and will:
323  * After using this macro, implementations of the _finalize, _class_init,
327  * This macro should rarely be used, instead one of the more specialized
346  * This is a specialization of OBJECT_DEFINE_TYPE_EXTENDED, which is suitable
364  * This is a specialization of OBJECT_DEFINE_TYPE_EXTENDED, which is suitable
386  * This is a specialization of OBJECT_DEFINE_TYPE_EXTENDED, which is suitable
403  * This is a variant of OBJECT_DEFINE_TYPE_EXTENDED, which is suitable for
423  * This is a variant of OBJECT_DEFINE_TYPE_EXTENDED, which is suitable for
426  * OBJECT_DECLARE_SIMPLE_TYPE then this is probably the right choice for
444  * @instance_init: This function is called to initialize an object.  The parent
447  * @instance_post_init: This function is called to finish initialization of
450  * @instance_finalize: This function is called during object destruction.  This
452  *   An object should only free the members that are unique to its type in this
454  * @abstract: If this field is true, then the class is considered abstract and
457  *   for this object.  If @class_size is 0, then the size of the class will be
458  *   assumed to be the size of the parent class.  This allows a type to avoid
461  * @class_init: This function is called after all parent class initialization
463  *   This is also the function to use to override virtual methods from a parent
465  * @class_base_init: This function is called for all base classes after all
467  *   is initialized.  This is the function to use to undo the effects of
470  *   @class_base_init. This can be useful when building dynamic
472  * @interfaces: The list of interfaces associated with this type.  This
502  * this function will always succeed.
512  * this function will always succeed.
524  * will define a macro based on this type to perform type safe dynamic_casts to
525  * this object type.
527  * If an invalid object is passed to this function, a run time assert will be
540  * A type safe version of @object_class_dynamic_cast_assert.  This macro is
554  * This function will return a specific class for a given object.  Its generally
575  * The class for all interfaces.  Subclasses of this class should only add
615  * This function will initialize a new object using heap allocated memory.
627  * This function will initialize a new object using heap allocated memory.
643  * This function will initialize a new object using heap allocated memory.
717  * This function will set a list of properties on an existing object
765  * This function will initialize an object.  The memory for the object should
781  * This function will initialize an object. The memory for the object should
826  * This is like::
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.
857  * @func: Name of function where this function was called
859  * See object_dynamic_cast() for a description of the parameters of this
860  * function.  The only difference in behavior is that this function asserts
862  * This function is not meant to be called directly, but only through
945  * @func: Name of function where this function was called
948  * of this function.  The only difference in behavior is that this function
950  * enabled.  This function is not meant to be called directly, but only through
963  * Returns: If @typename is a class, this function returns @klass if
966  * If @typename is an interface, this function returns the interface
970  * it.  (FIXME: perhaps this can be detected at type definition time?)
1066  * @name: the name of the property.  This can contain any character except for
1069  * @type: the type name of the property.  This namespace is pretty loosely
1073  * @get: The getter to be called to read a property.  If this is NULL, then
1075  * @set: the setter to be called to write a property.  If this is NULL,
1077  * @release: called when the property is removed from the object.  This is
1079  *   destruction.  This may be NULL.
1083  * Returns: The #ObjectProperty; this can be used to set the @resolve
1099  * @name: the name of the property.  This can contain any character except for
1102  * @type: the type name of the property.  This namespace is pretty loosely
1106  * @get: The getter to be called to read a property.  If this is NULL, then
1108  * @set: the setter to be called to write a property.  If this is NULL,
1110  * @release: called when the property is removed from the object.  This is
1112  *   destruction.  This may be NULL.
1190  * @errp: returns an error if this function fails
1216  * @errp: returns an error if this function fails
1269  * This can be used on abstract classes as it does not create a temporary
1281  * pointer should not be used again after this point without
1295  * @v: the visitor that will receive the property value.  This should be an
1297  * @errp: returns an error if this function fails
1311  * @errp: returns an error if this function fails
1324  * @errp: returns an error if this function fails
1338  * @errp: returns an error if this function fails
1355  * @errp: returns an error if this function fails
1369  * @errp: returns an error if this function fails
1382  * @errp: returns an error if this function fails
1395  * @errp: returns an error if this function fails
1408  * @errp: returns an error if this function fails
1421  * @errp: returns an error if this function fails
1434  * @errp: returns an error if this function fails
1447  * @errp: returns an error if this function fails
1460  * @v: the visitor that will be used to write the property value.  This should
1463  * @errp: returns an error if this function fails
1477  * @errp: returns an error if this function fails
1491  * @errp: returns an error if this function fails
1503  * @errp: returns an error if this function fails
1532  * object instances. This is the object at path
1543  * instances.  Any object which is put into this container must not be
1564  * Returns: The canonical path for a object, newly allocated.  This is
1602  * This is similar to object_resolve_path().  However, when looking for a
1604  * This restricts the search and avoids spuriously flagging matches as
1608  * a dynamic cast to @typename.  This is important if either the link,
1634  * This is like object_resolve_path(), except paths not starting with
1646  * This is similar to object_resolve_path with an absolute path, but it
1664  * a bidirectional relationship.  This is by design.
1757  * @get: the getter or NULL if the property is write-only.  This function must
1761  * Add a string property using getters/setters.  This function will add a
1783  * Add a bool property using getters/setters.  This function will add a
1806  * Add an enum property using getters/setters.  This function will add a
1831  * This function will add a property of type 'struct tm'.
1858  * Add an integer property in memory.  This function will add a
1879  * Add an integer property in memory.  This function will add a
1900  * Add an integer property in memory.  This function will add a
1921  * Add an integer property in memory.  This function will add a
1942  * Add an alias for a property on an object.  This function will add a property
1946  * this property exists.  In the case of a child object or an alias on the same
1947  * object this will be the case.  For aliases to other objects the caller is
1961  * Add an unmodifiable link for a property on an object.  This function will
1965  * this property exists.  In the case @target is a child of @obj,
1966  * this will be the case.  Otherwise, the caller is responsible for