lib: commonize some precondition assertion macros
[babeltrace.git] / src / lib / trace-ir / field-class.h
index 476b86dc3b8b3a63fb8f96a7a26a7ef6da612806..464dd286c98e23e2a4dba8f80ff0a629e26ca560 100644 (file)
-#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
-#define BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
-
 /*
+ * SPDX-License-Identifier: MIT
+ *
  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
  */
 
-#include "lib/assert-pre.h"
+#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
+#define BABELTRACE_TRACE_IR_FIELD_CLASSES_INTERNAL_H
+
+#include "lib/assert-cond.h"
 #include <babeltrace2/trace-ir/clock-class.h>
 #include <babeltrace2/trace-ir/field-class.h>
 #include "common/macros.h"
 #include "common/common.h"
 #include "lib/object.h"
 #include <babeltrace2/types.h>
+#include <stdbool.h>
 #include <stdint.h>
 #include <glib.h>
 
-#define _BT_ASSERT_PRE_FC_IS_INT_COND(_fc)                             \
-       (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
-
-#define _BT_ASSERT_PRE_FC_IS_INT_FMT(_name)                            \
-       _name " is not an integer field class: %![fc-]+F"
-
-#define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc)                    \
-       (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION)
-
-#define _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name)                   \
-       _name " is not an unsigned integer field class: %![fc-]+F"
-
-
-#define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc)                      \
-       (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_INTEGER || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
-
-#define _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name)                     \
-       _name " is not a signed integer field class: %![fc-]+F"
-
-#define _BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc)                            \
-       (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION)
-
-#define _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name)                           \
-       _name " is not an enumeration field class: %![fc-]+F"
-
-#define _BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc)                           \
-       (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_STATIC_ARRAY || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY)
-
-#define _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name)                          \
-       _name " is not an array field class: %![fc-]+F"
-
-#define _BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc)                         \
-       (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)
-
-#define _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name)                                \
-       _name " is not a variant field class: %![fc-]+F"
-
-#define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc)                        \
-       (((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR || \
-       ((const struct bt_field_class *) (_fc))->type == BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR)
-
-#define _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name)               \
-       _name " is not a variant field class with a selector: %![fc-]+F"
-
-#define _BT_ASSERT_PRE_FC_HAS_ID_COND(_fc, _type)                      \
-       (((const struct bt_field_class *) (_fc))->type == (_type))
-
-#define _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name)                            \
-       _name " has the wrong type: expected-type=%s, %![fc-]+F"
-
-#define BT_ASSERT_PRE_FC_IS_INT(_fc, _name)                            \
-       BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc),               \
-               _BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_FC_IS_UNSIGNED_INT(_fc, _name)                   \
-       BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc),      \
-               _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_FC_IS_SIGNED_INT(_fc, _name)                     \
-       BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc),        \
-               _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_FC_IS_ENUM(_fc, _name)                           \
-       BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc),              \
-               _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_FC_IS_ARRAY(_fc, _name)                          \
-       BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc),             \
-               _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_FC_IS_VARIANT(_fc, _name)                                \
-       BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc),           \
-               _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL(_fc, _name)               \
-       BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc),  \
-               _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_FC_HAS_ID(_fc, _type, _name)                     \
-       BT_ASSERT_PRE(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)),    \
-               _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name),                    \
-               bt_common_field_class_type_string(_type), (_fc))
-
-#define BT_ASSERT_PRE_DEV_FC_IS_INT(_fc, _name)                                \
-       BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_INT_COND(_fc),           \
-               _BT_ASSERT_PRE_FC_IS_INT_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_DEV_FC_IS_UNSIGNED_INT(_fc, _name)               \
-       BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_COND(_fc),  \
-               _BT_ASSERT_PRE_FC_IS_UNSIGNED_INT_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_DEV_FC_IS_SIGNED_INT(_fc, _name)                 \
-       BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_SIGNED_INT_COND(_fc),    \
-               _BT_ASSERT_PRE_FC_IS_SIGNED_INT_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_DEV_FC_IS_ENUM(_fc, _name)                       \
-       BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ENUM_COND(_fc),          \
-               _BT_ASSERT_PRE_FC_IS_ENUM_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_DEV_FC_IS_ARRAY(_fc, _name)                      \
-       BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_ARRAY_COND(_fc),         \
-               _BT_ASSERT_PRE_FC_IS_ARRAY_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_DEV_FC_IS_VARIANT(_fc, _name)                    \
-       BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_COND(_fc),       \
-               _BT_ASSERT_PRE_FC_IS_VARIANT_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_DEV_FC_IS_VARIANT_WITH_SEL(_fc, _name)           \
-       BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_COND(_fc), \
-               _BT_ASSERT_PRE_FC_IS_VARIANT_WITH_SEL_FMT(_name), (_fc))
-
-#define BT_ASSERT_PRE_DEV_FC_HAS_ID(_fc, _type, _name)                 \
-       BT_ASSERT_PRE_DEV(_BT_ASSERT_PRE_FC_HAS_ID_COND((_fc), (_type)), \
-               _BT_ASSERT_PRE_FC_HAS_ID_FMT(_name),                    \
-               bt_common_field_class_type_string(_type), (_fc))
-
-#define BT_ASSERT_PRE_DEV_FC_HOT(_fc, _name)                           \
-       BT_ASSERT_PRE_DEV_HOT((const struct bt_field_class *) (_fc),    \
-               (_name), ": %!+F", (_fc))
-
 #define BT_FIELD_CLASS_ENUM_MAPPING_AT_INDEX(_fc, _index)              \
        (&g_array_index(((struct bt_field_class_enumeration *) (_fc))->mappings, \
                struct bt_field_class_enumeration_mapping, (_index)))
@@ -179,6 +35,9 @@ struct bt_field_class {
        enum bt_field_class_type type;
        bool frozen;
 
+       /* Owned by this */
+       struct bt_value *user_attributes;
+
        /*
         * This flag indicates whether or not this field class is part
         * of a trace class.
@@ -186,6 +45,15 @@ struct bt_field_class {
        bool part_of_trace_class;
 };
 
+struct bt_field_class_bool {
+       struct bt_field_class common;
+};
+
+struct bt_field_class_bit_array {
+       struct bt_field_class common;
+       uint64_t length;
+};
+
 struct bt_field_class_integer {
        struct bt_field_class common;
 
@@ -209,8 +77,8 @@ struct bt_field_class_enumeration_mapping {
        const struct bt_integer_range_set *range_set;
 };
 
-struct bt_field_class_unsigned_enumeration_mapping;
-struct bt_field_class_signed_enumeration_mapping;
+struct bt_field_class_enumeration_unsigned_mapping;
+struct bt_field_class_enumeration_signed_mapping;
 
 struct bt_field_class_enumeration {
        struct bt_field_class_integer common;
@@ -221,9 +89,9 @@ struct bt_field_class_enumeration {
        /*
         * This is an array of `const char *` which acts as a temporary
         * (potentially growing) buffer for
-        * bt_field_class_unsigned_enumeration_get_mapping_labels_for_value()
+        * bt_field_class_enumeration_unsigned_get_mapping_labels_for_value()
         * and
-        * bt_field_class_signed_enumeration_get_mapping_labels_for_value().
+        * bt_field_class_enumeration_signed_get_mapping_labels_for_value().
         *
         * The actual strings are owned by the mappings above.
         */
@@ -232,7 +100,6 @@ struct bt_field_class_enumeration {
 
 struct bt_field_class_real {
        struct bt_field_class common;
-       bool is_single_precision;
 };
 
 struct bt_field_class_string {
@@ -243,6 +110,9 @@ struct bt_field_class_string {
 struct bt_named_field_class {
        GString *name;
 
+       /* Owned by this */
+       struct bt_value *user_attributes;
+
        /* Owned by this */
        struct bt_field_class *fc;
 
@@ -251,8 +121,8 @@ struct bt_named_field_class {
 
 struct bt_field_class_structure_member;
 struct bt_field_class_variant_option;
-struct bt_field_class_variant_with_unsigned_selector_option;
-struct bt_field_class_variant_with_signed_selector_option;
+struct bt_field_class_variant_with_selector_field_integer_unsigned_option;
+struct bt_field_class_variant_with_selector_field_integer_signed_option;
 
 struct bt_field_class_named_field_class_container {
        struct bt_field_class common;
@@ -278,23 +148,54 @@ struct bt_field_class_array {
        struct bt_field_class *element_fc;
 };
 
-struct bt_field_class_static_array {
+struct bt_field_class_array_static {
        struct bt_field_class_array common;
        uint64_t length;
 };
 
-struct bt_field_class_dynamic_array {
+struct bt_field_class_array_dynamic {
        struct bt_field_class_array common;
 
-       /* Weak: never dereferenced, only use to find it elsewhere */
+       /* Owned by this */
        struct bt_field_class *length_fc;
 
        /* Owned by this */
        struct bt_field_path *length_field_path;
 };
 
+struct bt_field_class_option {
+       struct bt_field_class common;
+
+       /* Owned by this */
+       struct bt_field_class *content_fc;
+};
+
+struct bt_field_class_option_with_selector_field {
+       struct bt_field_class_option common;
+
+       /* Owned by this */
+       struct bt_field_class *selector_fc;
+
+       /* Owned by this */
+       struct bt_field_path *selector_field_path;
+};
+
+struct bt_field_class_option_with_selector_field_bool {
+       struct bt_field_class_option_with_selector_field common;
+
+       /* Owned by this */
+       bool sel_is_reversed;
+};
+
+struct bt_field_class_option_with_selector_field_integer {
+       struct bt_field_class_option_with_selector_field common;
+
+       /* Owned by this */
+       const struct bt_integer_range_set *range_set;
+};
+
 /* Variant FC (with selector) option: named field class + range set */
-struct bt_field_class_variant_with_selector_option {
+struct bt_field_class_variant_with_selector_field_option {
        struct bt_named_field_class common;
 
        /* Owned by this */
@@ -307,13 +208,13 @@ struct bt_field_class_variant {
         * named field classes are of type
         * `struct bt_named_field_class *` if the variant field class
         * doesn't have a selector, or
-        * `struct bt_field_class_variant_with_selector_option *`
+        * `struct bt_field_class_variant_with_selector_field_option *`
         * if it has.
         */
        struct bt_field_class_named_field_class_container common;
 };
 
-struct bt_field_class_variant_with_selector {
+struct bt_field_class_variant_with_selector_field {
        struct bt_field_class_variant common;
 
        /*
This page took 0.028205 seconds and 4 git commands to generate.