feat(object): expose object tree query APIs

Author: chenglong

include/miniqom/object.h

@@ -37,6 +37,12 @@ bool object_realize(Object *obj, Error *err);
 void object_unrealize(Object *obj);
 bool object_is_realized(const Object *obj);
 
+Object *object_get_parent(const Object *obj);
+const char *object_get_name(const Object *obj);
+size_t object_get_child_count(const Object *obj);
+Object *object_get_child(const Object *obj, size_t index);
+Object *object_find_child(Object *parent, const char *name);
+
 bool object_add_child(Object *parent, const char *name,
                       Object *child, Error *err);
 

src/main.c

@@ -15,12 +15,12 @@ static void dump_tree(const Object *obj, unsigned depth)
     }
 
     printf("%s (%s)\n",
-           obj->name ? obj->name : "<root>",
+           object_get_name(obj),
            object_get_type_name(obj));
 
     for (size_t i = 0; i < obj->child_count; i++)
     {
-        dump_tree(obj->children[i], depth + 1);
+        dump_tree(object_get_child(obj, i), depth + 1);
     }
 }
 

src/qom/object.c

@@ -213,6 +213,36 @@ bool object_is_instance_of(const Object *obj, const char *type_name)
     return object_is_a(obj, type_name);
 }
 
+Object *object_get_parent(const Object *obj)
+{
+    return obj ? obj->parent : NULL;
+}
+
+const char *object_get_name(const Object *obj)
+{
+    if (!obj || !obj->name)
+    {
+        return "";
+    }
+
+    return obj->name;
+}
+
+size_t object_get_child_count(const Object *obj)
+{
+    return obj ? obj->child_count : 0;
+}
+
+Object *object_get_child(const Object *obj, size_t index)
+{
+    if (!obj || index >= obj->child_count)
+    {
+        return NULL;
+    }
+
+    return obj->children[index];
+}
+
 bool object_add_child(Object *parent, const char *name,
                       Object *child, Error *err)
 {
@@ -237,8 +267,13 @@ bool object_add_child(Object *parent, const char *name,
     return true;
 }
 
-static Object *object_find_child(Object *obj, const char *name)
+Object *object_find_child(Object *obj, const char *name)
 {
+    if (!obj || !name)
+    {
+        return NULL;
+    }
+
     for (size_t i = 0; i < obj->child_count; i++)
     {
         if (!strcmp(obj->children[i]->name, name))

tests/test_qom.c

@@ -307,6 +307,35 @@ static void test_object_tree(void)
     assert(object_add_child(objects, "mem0", mem0, &err));
     assert(object_resolve_path(root, "/objects/mem0") == mem0);
 
+    assert(object_get_parent(objects) == root);
+    assert(object_get_parent(mem0) == objects);
+
+    assert(!strcmp(object_get_name(root), ""));
+    assert(!strcmp(object_get_name(objects), "objects"));
+    assert(!strcmp(object_get_name(mem0), "mem0"));
+
+    assert(object_get_child_count(root) == 1);
+    assert(object_get_child_count(objects) == 1);
+    assert(object_get_child_count(mem0) == 0);
+
+    assert(object_get_child(root, 0) == objects);
+    assert(object_get_child(objects, 0) == mem0);
+    assert(object_get_child(mem0, 0) == NULL);
+
+    assert(object_find_child(root, "objects") == objects);
+    assert(object_find_child(objects, "mem0") == mem0);
+    assert(object_find_child(root, "missing") == NULL);
+
+    assert(object_get_parent(NULL) == NULL);
+    assert(!strcmp(object_get_name(NULL), ""));
+    assert(object_get_child_count(NULL) == 0);
+    assert(object_get_child(NULL, 0) == NULL);
+    assert(object_find_child(NULL, "objects") == NULL);
+    assert(object_find_child(root, NULL) == NULL);
+
+    assert(object_get_child(root, 1) == NULL);
+    assert(object_get_child(objects, 1) == NULL);
+
     object_free(root);
 }