summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2013-05-10 14:16:35 +0200
committerAnthony Liguori <aliguori@us.ibm.com>2013-05-13 09:52:05 -0500
commit33bc94eb209864b4aef7f341f0c2b7cd8740396f (patch)
treef33ca265e24da53515e60fbbf250c3a75cac5346 /include
parentf6e136e47a6adc176cb53a24cf5a515ca09f977f (diff)
downloadqemu-33bc94eb209864b4aef7f341f0c2b7cd8740396f.zip
qom: improve documentation of cast functions
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Message-id: 1368188203-3407-2-git-send-email-pbonzini@redhat.com Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
Diffstat (limited to 'include')
-rw-r--r--include/qom/object.h23
1 files changed, 21 insertions, 2 deletions
diff --git a/include/qom/object.h b/include/qom/object.h
index d0f99c5782..41b7068d19 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -612,7 +612,8 @@ Object *object_dynamic_cast(Object *obj, const char *typename);
*
* See object_dynamic_cast() for a description of the parameters of this
* function. The only difference in behavior is that this function asserts
- * instead of returning #NULL on failure.
+ * instead of returning #NULL on failure. This function is not meant to be
+ * called directly, but only through the wrapper macro OBJECT_CHECK.
*/
Object *object_dynamic_cast_assert(Object *obj, const char *typename);
@@ -659,11 +660,29 @@ Type type_register(const TypeInfo *info);
* @klass: The #ObjectClass to attempt to cast.
* @typename: The QOM typename of the class to cast to.
*
- * Returns: This function always returns @klass and asserts on failure.
+ * See object_class_dynamic_cast() for a description of the parameters
+ * of this function. The only difference in behavior is that this function
+ * asserts instead of returning #NULL on failure. This function is not
+ * meant to be called directly, but only through the wrapper macros
+ * OBJECT_CLASS_CHECK and INTERFACE_CHECK.
*/
ObjectClass *object_class_dynamic_cast_assert(ObjectClass *klass,
const char *typename);
+/**
+ * object_class_dynamic_cast:
+ * @klass: The #ObjectClass to attempt to cast.
+ * @typename: The QOM typename of the class to cast to.
+ *
+ * Returns: If @typename is a class, this function returns @klass if
+ * @typename is a subtype of @klass, else returns #NULL.
+ *
+ * If @typename is an interface, this function returns the interface
+ * definition for @klass if @klass implements it unambiguously; #NULL
+ * is returned if @klass does not implement the interface or if multiple
+ * classes or interfaces on the hierarchy leading to @klass implement
+ * it. (FIXME: perhaps this can be detected at type definition time?)
+ */
ObjectClass *object_class_dynamic_cast(ObjectClass *klass,
const char *typename);