Document libbabeltrace2's C API
[babeltrace.git] / src / lib / trace-ir / field-class.c
index 62c5afa9ad1cdd0e0ae10e221e23e1954122bcf1..b4a542666752987d10b392a899cc1d863a615284 100644 (file)
@@ -26,8 +26,6 @@
 
 #include "lib/assert-pre.h"
 #include <babeltrace2/trace-ir/field-class.h>
-#include <babeltrace2/trace-ir/field-class-const.h>
-#include <babeltrace2/trace-ir/field-const.h>
 #include <babeltrace2/trace-ir/field.h>
 #include <babeltrace2/trace-ir/clock-class.h>
 #include "lib/object.h"
@@ -37,6 +35,7 @@
 #include "compat/glib.h"
 #include <float.h>
 #include <inttypes.h>
+#include <stdbool.h>
 #include <stdlib.h>
 
 #include "clock-class.h"
@@ -97,6 +96,7 @@ struct bt_field_class *bt_field_class_bit_array_create(
 {
        struct bt_field_class_bit_array *ba_fc = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
        BT_ASSERT_PRE(length > 0 && length <= 64,
                "Unsupported length for bit array field class "
@@ -149,6 +149,7 @@ struct bt_field_class *bt_field_class_bool_create(
 {
        struct bt_field_class_bool *bool_fc = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
        BT_LOGD("Creating default boolean field class object.");
        bool_fc = g_new0(struct bt_field_class_bool, 1);
@@ -235,6 +236,8 @@ end:
 struct bt_field_class *bt_field_class_integer_unsigned_create(
                bt_trace_class *trace_class)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return create_integer_field_class(trace_class,
                BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER);
 }
@@ -242,6 +245,8 @@ struct bt_field_class *bt_field_class_integer_unsigned_create(
 struct bt_field_class *bt_field_class_integer_signed_create(
                bt_trace_class *trace_class)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return create_integer_field_class(trace_class,
                BT_FIELD_CLASS_TYPE_SIGNED_INTEGER);
 }
@@ -399,6 +404,8 @@ end:
 struct bt_field_class *bt_field_class_enumeration_unsigned_create(
                bt_trace_class *trace_class)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return create_enumeration_field_class(trace_class,
                BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION);
 }
@@ -406,6 +413,8 @@ struct bt_field_class *bt_field_class_enumeration_unsigned_create(
 struct bt_field_class *bt_field_class_enumeration_signed_create(
                bt_trace_class *trace_class)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return create_enumeration_field_class(trace_class,
                BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION);
 }
@@ -454,7 +463,7 @@ borrow_enumeration_field_class_mapping_by_label(
        struct bt_field_class_enumeration_mapping *mapping = NULL;
        uint64_t i;
 
-       BT_ASSERT(fc);
+       BT_ASSERT_DBG(fc);
        BT_ASSERT_PRE_DEV_NON_NULL(label, "Label");
 
        for (i = 0; i < fc->mappings->len; i++) {
@@ -531,6 +540,7 @@ bt_field_class_enumeration_unsigned_get_mapping_labels_for_value(
        const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
        uint64_t i;
 
+       BT_ASSERT_PRE_DEV_NO_ERROR();
        BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
        BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)");
        BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)");
@@ -571,6 +581,7 @@ bt_field_class_enumeration_signed_get_mapping_labels_for_value(
        const struct bt_field_class_enumeration *enum_fc = (const void *) fc;
        uint64_t i;
 
+       BT_ASSERT_PRE_DEV_NO_ERROR();
        BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
        BT_ASSERT_PRE_DEV_NON_NULL(label_array, "Label array (output)");
        BT_ASSERT_PRE_DEV_NON_NULL(count, "Count (output)");
@@ -637,6 +648,7 @@ add_mapping_to_enumeration_field_class(struct bt_field_class *fc,
        struct bt_field_class_enumeration *enum_fc = (void *) fc;
        struct bt_field_class_enumeration_mapping mapping = { 0 };
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT(fc);
        BT_ASSERT_PRE_NON_NULL(label, "Label");
        BT_ASSERT_PRE_NON_NULL(range_set, "Integer range set");
@@ -666,6 +678,7 @@ bt_field_class_enumeration_unsigned_add_mapping(
                struct bt_field_class *fc, const char *label,
                const struct bt_integer_range_set_unsigned *range_set)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(fc, "Field class");
        BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
                "Field class");
@@ -678,6 +691,7 @@ bt_field_class_enumeration_signed_add_mapping(
                struct bt_field_class *fc, const char *label,
                const struct bt_integer_range_set_signed *range_set)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(fc, "Field class");
        BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
                "Field class");
@@ -726,6 +740,8 @@ end:
 struct bt_field_class *bt_field_class_real_single_precision_create(
        bt_trace_class *trace_class)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return create_real_field_class(trace_class,
                BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL);
 }
@@ -733,6 +749,8 @@ struct bt_field_class *bt_field_class_real_single_precision_create(
 struct bt_field_class *bt_field_class_real_double_precision_create(
        bt_trace_class *trace_class)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return create_real_field_class(trace_class,
                BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL);
 }
@@ -846,6 +864,7 @@ struct bt_field_class *bt_field_class_structure_create(
        int ret;
        struct bt_field_class_structure *struct_fc = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
        BT_LOGD_STR("Creating default structure field class object.");
        struct_fc = g_new0(struct bt_field_class_structure, 1);
@@ -1000,6 +1019,7 @@ bt_field_class_structure_append_member(
        enum bt_field_class_structure_append_member_status status;
        struct bt_named_field_class *named_fc = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(fc, "Field class");
        BT_ASSERT_PRE_FC_HAS_ID(fc, BT_FIELD_CLASS_TYPE_STRUCTURE,
                "Field class");
@@ -1038,7 +1058,7 @@ borrow_named_field_class_from_container_field_class_at_index(
                struct bt_field_class_named_field_class_container *fc,
                uint64_t index)
 {
-       BT_ASSERT(fc);
+       BT_ASSERT_DBG(fc);
        BT_ASSERT_PRE_DEV_VALID_INDEX(index, fc->named_fcs->len);
        return fc->named_fcs->pdata[index];
 }
@@ -1077,7 +1097,7 @@ borrow_named_field_class_from_container_field_class_by_name(
        gpointer orig_key;
        gpointer value;
 
-       BT_ASSERT(fc);
+       BT_ASSERT_DBG(fc);
        BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
        if (!g_hash_table_lookup_extended(fc->name_to_index, name, &orig_key,
                        &value)) {
@@ -1257,6 +1277,8 @@ struct bt_field_class *bt_field_class_option_without_selector_create(
                struct bt_trace_class *trace_class,
                struct bt_field_class *content_fc)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return create_option_field_class(trace_class,
                BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR_FIELD,
                content_fc, NULL);
@@ -1267,17 +1289,11 @@ struct bt_field_class *bt_field_class_option_with_selector_field_bool_create(
                struct bt_field_class *content_fc,
                struct bt_field_class *selector_fc)
 {
-       struct bt_field_class_option_with_selector_field_bool *fc =
-               (void *) create_option_field_class(trace_class,
-                       BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
-                       content_fc, selector_fc);
+       BT_ASSERT_PRE_NO_ERROR();
 
-       if (!fc) {
-               goto end;
-       }
-
-end:
-       return (void *) fc;
+       return create_option_field_class(trace_class,
+               BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR_FIELD,
+               content_fc, selector_fc);
 }
 
 struct bt_field_class *
@@ -1291,6 +1307,7 @@ bt_field_class_option_with_selector_field_integer_unsigned_create(
        const struct bt_integer_range_set *range_set =
                (const void *) u_range_set;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(range_set, "Integer range set");
        BT_ASSERT_PRE(range_set->ranges->len > 0,
                "Integer range set is empty: %!+R", range_set);
@@ -1321,6 +1338,7 @@ bt_field_class_option_with_selector_field_integer_signed_create(
        const struct bt_integer_range_set *range_set =
                (const void *) i_range_set;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(range_set, "Integer range set");
        BT_ASSERT_PRE(range_set->ranges->len > 0,
                "Integer range set is empty: %!+R", range_set);
@@ -1460,6 +1478,7 @@ struct bt_field_class *bt_field_class_variant_create(
        struct bt_field_class_variant_with_selector_field *var_with_sel_fc = NULL;
        enum bt_field_class_type fc_type;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
 
        if (selector_fc) {
@@ -1478,8 +1497,8 @@ struct bt_field_class *bt_field_class_variant_create(
                        goto error;
                }
 
-               if (selector_fc->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER ||
-                               selector_fc->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION) {
+               if (bt_field_class_type_is(selector_fc->type,
+                               BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER)) {
                        fc_type = BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD;
                } else {
                        fc_type = BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD;
@@ -1537,6 +1556,7 @@ bt_field_class_variant_without_selector_append_option(struct bt_field_class *fc,
        enum bt_field_class_variant_without_selector_append_option_status status;
        struct bt_named_field_class *named_fc = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(fc, "Field class");
        BT_ASSERT_PRE_NON_NULL(name, "Name");
        BT_ASSERT_PRE_NON_NULL(option_fc, "Option field class");
@@ -1707,6 +1727,8 @@ bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
                struct bt_field_class *option_fc,
                const struct bt_integer_range_set_unsigned *range_set)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return append_option_to_variant_with_selector_field_field_class(fc,
                name, option_fc, (const void *) range_set,
                BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD);
@@ -1718,6 +1740,8 @@ bt_field_class_variant_with_selector_field_integer_signed_append_option(
                struct bt_field_class *option_fc,
                const struct bt_integer_range_set_signed *range_set)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        return append_option_to_variant_with_selector_field_field_class(fc,
                name, option_fc, (const void *) range_set,
                BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD);
@@ -1936,6 +1960,7 @@ bt_field_class_array_static_create(bt_trace_class *trace_class,
 {
        struct bt_field_class_array_static *array_fc = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
        BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class");
        BT_LOGD_STR("Creating default static array field class object.");
@@ -2016,6 +2041,7 @@ struct bt_field_class *bt_field_class_array_dynamic_create(
 {
        struct bt_field_class_array_dynamic *array_fc = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
        BT_ASSERT_PRE_NON_NULL(element_fc, "Element field class");
        BT_LOGD_STR("Creating default dynamic array field class object.");
@@ -2058,6 +2084,7 @@ bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const(
 {
        const struct bt_field_class_array_dynamic *seq_fc = (const void *) fc;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_DEV_NON_NULL(fc, "Field class");
        BT_ASSERT_PRE_DEV_FC_HAS_ID(fc,
                BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD,
@@ -2078,6 +2105,7 @@ struct bt_field_class *bt_field_class_string_create(bt_trace_class *trace_class)
 {
        struct bt_field_class_string *string_fc = NULL;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(trace_class, "Trace class");
        BT_LOGD_STR("Creating default string field class object.");
        string_fc = g_new0(struct bt_field_class_string, 1);
@@ -2115,12 +2143,9 @@ void _bt_field_class_freeze(const struct bt_field_class *c_fc)
        bt_value_freeze(fc->user_attributes);
        fc->frozen = true;
 
-       switch (fc->type) {
-       case BT_FIELD_CLASS_TYPE_STRUCTURE:
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
-       {
+       if (fc->type == BT_FIELD_CLASS_TYPE_STRUCTURE ||
+                       bt_field_class_type_is(fc->type,
+                               BT_FIELD_CLASS_TYPE_VARIANT)) {
                struct bt_field_class_named_field_class_container *container_fc =
                        (void *) fc;
                uint64_t i;
@@ -2129,11 +2154,6 @@ void _bt_field_class_freeze(const struct bt_field_class *c_fc)
                        bt_named_field_class_freeze(
                                container_fc->named_fcs->pdata[i]);
                }
-
-               break;
-       }
-       default:
-               break;
        }
 }
 
@@ -2158,12 +2178,9 @@ void bt_field_class_make_part_of_trace_class(const struct bt_field_class *c_fc)
                "Field class is already part of a trace: %!+F", fc);
        fc->part_of_trace_class = true;
 
-       switch (fc->type) {
-       case BT_FIELD_CLASS_TYPE_STRUCTURE:
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR_FIELD:
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR_FIELD:
-       case BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR_FIELD:
-       {
+       if (fc->type == BT_FIELD_CLASS_TYPE_STRUCTURE ||
+                       bt_field_class_type_is(fc->type,
+                               BT_FIELD_CLASS_TYPE_VARIANT)) {
                struct bt_field_class_named_field_class_container *container_fc =
                        (void *) fc;
                uint64_t i;
@@ -2174,20 +2191,11 @@ void bt_field_class_make_part_of_trace_class(const struct bt_field_class *c_fc)
 
                        bt_field_class_make_part_of_trace_class(named_fc->fc);
                }
-
-               break;
-       }
-       case BT_FIELD_CLASS_TYPE_STATIC_ARRAY:
-       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD:
-       case BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD:
-       {
+       } else if (bt_field_class_type_is(fc->type,
+                       BT_FIELD_CLASS_TYPE_ARRAY)) {
                struct bt_field_class_array *array_fc = (void *) fc;
 
                bt_field_class_make_part_of_trace_class(array_fc->element_fc);
-               break;
-       }
-       default:
-               break;
        }
 }
 
This page took 0.030164 seconds and 4 git commands to generate.