values: add `_empty` prefix when relevant

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/include/babeltrace/values.h b/include/babeltrace/values.h
index 7e7cf64aac1b0e6d9d0b8b750edc5a8fdbd43395..fa306bd270f74972ab7e8773997843733bfc60d3 100644 (file)
--- a/include/babeltrace/values.h
+++ b/include/babeltrace/values.h
@@ -591,8 +591,8 @@ extern struct bt_value *bt_value_array_get(const struct bt_value *array_obj,
  * @see bt_value_array_append_integer()
  * @see bt_value_array_append_float()
  * @see bt_value_array_append_string()
- * @see bt_value_array_append_array()
- * @see bt_value_array_append_map()
+ * @see bt_value_array_append_empty_array()
+ * @see bt_value_array_append_empty_map()
  */
 extern enum bt_value_status bt_value_array_append(struct bt_value *array_obj,
        struct bt_value *element_obj);
@@ -676,7 +676,7 @@ extern enum bt_value_status bt_value_array_append_string(
  *
  * @see bt_value_array_append()
  */
-extern enum bt_value_status bt_value_array_append_array(
+extern enum bt_value_status bt_value_array_append_empty_array(
        struct bt_value *array_obj);
 
 /**
@@ -691,7 +691,7 @@ extern enum bt_value_status bt_value_array_append_array(
  *
  * @see bt_value_array_append()
  */
-extern enum bt_value_status bt_value_array_append_map(
+extern enum bt_value_status bt_value_array_append_empty_map(
        struct bt_value *array_obj);
 
 /**
@@ -809,8 +809,8 @@ extern bool bt_value_map_has_key(const struct bt_value *map_obj,
  * @see bt_value_map_insert_integer()
  * @see bt_value_map_insert_float()
  * @see bt_value_map_insert_string()
- * @see bt_value_map_insert_array()
- * @see bt_value_map_insert_map()
+ * @see bt_value_map_insert_empty_array()
+ * @see bt_value_map_insert_empty_map()
  */
 extern enum bt_value_status bt_value_map_insert(
        struct bt_value *map_obj, const char *key,
@@ -919,7 +919,7 @@ extern enum bt_value_status bt_value_map_insert_string(
  *
  * @see bt_value_map_insert()
  */
-extern enum bt_value_status bt_value_map_insert_array(
+extern enum bt_value_status bt_value_map_insert_empty_array(
        struct bt_value *map_obj, const char *key);
 
 /**
@@ -938,7 +938,7 @@ extern enum bt_value_status bt_value_map_insert_array(
  *
  * @see bt_value_map_insert()
  */
-extern enum bt_value_status bt_value_map_insert_map(
+extern enum bt_value_status bt_value_map_insert_empty_map(
        struct bt_value *map_obj, const char *key);
 
 /**

diff --git a/lib/values.c b/lib/values.c
index f75f008c6008d539eaaf7cd22d75338bc2a02236..18ee1c5eb165a4c28098b13b10ffa5d3a0e71b5a 100644 (file)
--- a/lib/values.c
+++ b/lib/values.c
@@ -922,7 +922,8 @@ enum bt_value_status bt_value_array_append_string(struct bt_value *array_obj,
        return ret;
 }
 
-enum bt_value_status bt_value_array_append_array(struct bt_value *array_obj)
+enum bt_value_status bt_value_array_append_empty_array(
+       struct bt_value *array_obj)
 {
        enum bt_value_status ret;
        struct bt_value *empty_array_obj = NULL;
@@ -934,7 +935,7 @@ enum bt_value_status bt_value_array_append_array(struct bt_value *array_obj)
        return ret;
 }
 
-enum bt_value_status bt_value_array_append_map(struct bt_value *array_obj)
+enum bt_value_status bt_value_array_append_empty_map(struct bt_value *array_obj)
 {
        enum bt_value_status ret;
        struct bt_value *map_obj = NULL;
@@ -1113,7 +1114,7 @@ enum bt_value_status bt_value_map_insert_string(struct bt_value *map_obj,
        return ret;
 }
 
-enum bt_value_status bt_value_map_insert_array(struct bt_value *map_obj,
+enum bt_value_status bt_value_map_insert_empty_array(struct bt_value *map_obj,
        const char *key)
 {
        enum bt_value_status ret;
@@ -1126,7 +1127,7 @@ enum bt_value_status bt_value_map_insert_array(struct bt_value *map_obj,
        return ret;
 }
 
-enum bt_value_status bt_value_map_insert_map(struct bt_value *map_obj,
+enum bt_value_status bt_value_map_insert_empty_map(struct bt_value *map_obj,
        const char *key)
 {
        enum bt_value_status ret;

diff --git a/tests/lib/test_bt_values.c b/tests/lib/test_bt_values.c
index d10ae0cf31e9cfdf7401fd90a32400c1fc7d2640..7a8fc52249ae82bb164156c9fdb1358455bc4557 100644 (file)
--- a/tests/lib/test_bt_values.c
+++ b/tests/lib/test_bt_values.c
@@ -375,14 +375,14 @@ void test_array(void)
        ok(bt_value_array_append_string(NULL, "bt_obj") ==
                BT_VALUE_STATUS_INVAL,
                "bt_value_array_append_string() fails with an array value object set to NULL");
-       ret = bt_value_array_append_array(array_obj);
-       ok(!ret, "bt_value_array_append_array() succeeds");
-       ok(bt_value_array_append_array(NULL) == BT_VALUE_STATUS_INVAL,
-               "bt_value_array_append_array() fails with an array value object set to NULL");
-       ret = bt_value_array_append_map(array_obj);
-       ok(!ret, "bt_value_array_append_map() succeeds");
-       ok(bt_value_array_append_map(NULL) == BT_VALUE_STATUS_INVAL,
-               "bt_value_array_append_map() fails with an array value object set to NULL");
+       ret = bt_value_array_append_empty_array(array_obj);
+       ok(!ret, "bt_value_array_append_empty_array() succeeds");
+       ok(bt_value_array_append_empty_array(NULL) == BT_VALUE_STATUS_INVAL,
+               "bt_value_array_append_empty_array() fails with an array value object set to NULL");
+       ret = bt_value_array_append_empty_map(array_obj);
+       ok(!ret, "bt_value_array_append_empty_map() succeeds");
+       ok(bt_value_array_append_empty_map(NULL) == BT_VALUE_STATUS_INVAL,
+               "bt_value_array_append_empty_map() fails with an array value object set to NULL");
 
        ok(bt_value_array_size(array_obj) == 10,
                "the bt_value_array_append_*() functions increment the array value object's size");
@@ -419,15 +419,15 @@ void test_array(void)
        BT_PUT(obj);
        obj = bt_value_array_get(array_obj, 8);
        ok(obj && bt_value_is_array(obj),
-               "bt_value_array_append_array() appends an array value object");
+               "bt_value_array_append_empty_array() appends an array value object");
        ok(bt_value_array_is_empty(obj),
-               "bt_value_array_append_array() an empty array value object");
+               "bt_value_array_append_empty_array() an empty array value object");
        BT_PUT(obj);
        obj = bt_value_array_get(array_obj, 9);
        ok(obj && bt_value_is_map(obj),
-               "bt_value_array_append_map() appends a map value object");
+               "bt_value_array_append_empty_map() appends a map value object");
        ok(bt_value_map_is_empty(obj),
-               "bt_value_array_append_map() an empty map value object");
+               "bt_value_array_append_empty_map() an empty map value object");
        BT_PUT(obj);
 
        assert(!bt_value_freeze(array_obj));
@@ -446,12 +446,12 @@ void test_array(void)
        ok(bt_value_array_append_string(array_obj, "yayayayaya") ==
                BT_VALUE_STATUS_FROZEN,
                "bt_value_array_append_string() fails with a frozen array value object");
-       ok(bt_value_array_append_array(array_obj) ==
+       ok(bt_value_array_append_empty_array(array_obj) ==
                BT_VALUE_STATUS_FROZEN,
-               "bt_value_array_append_array() fails with a frozen array value object");
-       ok(bt_value_array_append_map(array_obj) ==
+               "bt_value_array_append_empty_array() fails with a frozen array value object");
+       ok(bt_value_array_append_empty_map(array_obj) ==
                BT_VALUE_STATUS_FROZEN,
-               "bt_value_array_append_map() fails with a frozen array value object");
+               "bt_value_array_append_empty_map() fails with a frozen array value object");
        ok(bt_value_array_set(array_obj, 2, bt_value_null) ==
                BT_VALUE_STATUS_FROZEN,
                "bt_value_array_set() fails with a frozen array value object");
@@ -748,14 +748,14 @@ void test_map(void)
        ok(bt_value_map_insert_string(NULL, "string2", "bt_obj") ==
                BT_VALUE_STATUS_INVAL,
                "bt_value_map_insert_string() fails with a map value object set to NULL");
-       ret = bt_value_map_insert_array(map_obj, "array2");
-       ok(!ret, "bt_value_map_insert_array() succeeds");
-       ok(bt_value_map_insert_array(NULL, "array2") == BT_VALUE_STATUS_INVAL,
-               "bt_value_map_insert_array() fails with a map value object set to NULL");
-       ret = bt_value_map_insert_map(map_obj, "map2");
-       ok(!ret, "bt_value_map_insert_map() succeeds");
-       ok(bt_value_map_insert_map(NULL, "map2") == BT_VALUE_STATUS_INVAL,
-               "bt_value_map_insert_map() fails with a map value object set to NULL");
+       ret = bt_value_map_insert_empty_array(map_obj, "array2");
+       ok(!ret, "bt_value_map_insert_empty_array() succeeds");
+       ok(bt_value_map_insert_empty_array(NULL, "array2") == BT_VALUE_STATUS_INVAL,
+               "bt_value_map_insert_empty_array() fails with a map value object set to NULL");
+       ret = bt_value_map_insert_empty_map(map_obj, "map2");
+       ok(!ret, "bt_value_map_insert_empty_map() succeeds");
+       ok(bt_value_map_insert_empty_map(NULL, "map2") == BT_VALUE_STATUS_INVAL,
+               "bt_value_map_insert_empty_map() fails with a map value object set to NULL");
 
        ok(bt_value_map_size(map_obj) == 10,
                "the bt_value_map_insert*() functions increment the map value object's size");
@@ -820,12 +820,12 @@ void test_map(void)
        ok(bt_value_map_insert_string(map_obj, "duh", "yayayayaya") ==
                BT_VALUE_STATUS_FROZEN,
                "bt_value_map_insert_string() fails with a frozen array value object");
-       ok(bt_value_map_insert_array(map_obj, "duh") ==
+       ok(bt_value_map_insert_empty_array(map_obj, "duh") ==
                BT_VALUE_STATUS_FROZEN,
-               "bt_value_map_insert_array() fails with a frozen array value object");
-       ok(bt_value_map_insert_map(map_obj, "duh") ==
+               "bt_value_map_insert_empty_array() fails with a frozen array value object");
+       ok(bt_value_map_insert_empty_map(map_obj, "duh") ==
                BT_VALUE_STATUS_FROZEN,
-               "bt_value_map_insert_map() fails with a frozen array value object");
+               "bt_value_map_insert_empty_map() fails with a frozen array value object");
        ok(bt_value_map_size(map_obj) == 10,
                "appending to a frozen map value object does not change its size");