Fix: headers: make static inline upcasts compatible with C++
[babeltrace.git] / include / babeltrace / trace-ir / field-class-const.h
index 3e0e16e6f40d6b0efc0e79679eca6f16b73b6ca4..9f2f960b40ec9ff4b4b4612ef9eb8c9c70f2caa8 100644 (file)
  * http://www.efficios.com/ctf
  */
 
-/* For bt_bool */
+/*
+ * For bt_bool, bt_field_class, bt_field_path,
+ * bt_field_class_enumeration_mapping,
+ * bt_field_class_unsigned_enumeration_mapping,
+ * bt_field_class_signed_enumeration_mapping,
+ * bt_field_class_enumeration_mapping_label_array, __BT_UPCAST_CONST
+ */
 #include <babeltrace/types.h>
 
 #include <stdint.h>
 extern "C" {
 #endif
 
-struct bt_field_class;
-struct bt_field_path;
-struct bt_field_class_signed_enumeration_mapping_ranges;
-struct bt_field_class_unsigned_enumeration_mapping_ranges;
+typedef enum bt_field_class_status {
+       BT_FIELD_CLASS_STATUS_OK = 0,
+       BT_FIELD_CLASS_STATUS_NOMEM = -12,
+} bt_field_class_status;
 
-typedef const char * const *bt_field_class_enumeration_mapping_label_array;
-
-enum bt_field_class_type {
+typedef enum bt_field_class_type {
        BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
        BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
        BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
@@ -55,108 +59,151 @@ enum bt_field_class_type {
        BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
        BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
        BT_FIELD_CLASS_TYPE_VARIANT,
-};
+} bt_field_class_type;
 
-enum bt_field_class_integer_preferred_display_base {
+typedef enum bt_field_class_integer_preferred_display_base {
        BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
        BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
        BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
        BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
-};
+} bt_field_class_integer_preferred_display_base;
 
-extern enum bt_field_class_type bt_field_class_get_type(
-               const struct bt_field_class *field_class);
+extern bt_field_class_type bt_field_class_get_type(
+               const bt_field_class *field_class);
 
 extern uint64_t bt_field_class_integer_get_field_value_range(
-               const struct bt_field_class *field_class);
+               const bt_field_class *field_class);
 
-extern enum bt_field_class_integer_preferred_display_base
+extern bt_field_class_integer_preferred_display_base
 bt_field_class_integer_get_preferred_display_base(
-               const struct bt_field_class *field_class);
+               const bt_field_class *field_class);
 
 extern bt_bool bt_field_class_real_is_single_precision(
-               const struct bt_field_class *field_class);
+               const bt_field_class *field_class);
 
 extern uint64_t bt_field_class_enumeration_get_mapping_count(
-               const struct bt_field_class *field_class);
-
-extern void bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
-               const struct bt_field_class *field_class, uint64_t index,
-               const char **label,
-               const struct bt_field_class_unsigned_enumeration_mapping_ranges **ranges);
+               const bt_field_class *field_class);
+
+extern const bt_field_class_unsigned_enumeration_mapping *
+bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
+               const bt_field_class *field_class, uint64_t index);
+
+extern const bt_field_class_signed_enumeration_mapping *
+bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
+               const bt_field_class *field_class, uint64_t index);
+
+static inline
+const bt_field_class_enumeration_mapping *
+bt_field_class_unsigned_enumeration_mapping_as_mapping_const(
+               const bt_field_class_unsigned_enumeration_mapping *mapping)
+{
+       return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
+}
 
-extern void bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
-               const struct bt_field_class *field_class, uint64_t index,
-               const char **label,
-               const struct bt_field_class_signed_enumeration_mapping_ranges **ranges);
+static inline
+const bt_field_class_enumeration_mapping *
+bt_field_class_signed_enumeration_mapping_as_mapping_const(
+               const bt_field_class_signed_enumeration_mapping *mapping)
+{
+       return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
+}
 
-extern uint64_t
-bt_field_class_unsigned_enumeration_mapping_ranges_get_range_count(
-               const struct bt_field_class_unsigned_enumeration_mapping_ranges *ranges);
+extern const char *bt_field_class_enumeration_mapping_get_label(
+               const bt_field_class_enumeration_mapping *mapping);
 
-extern uint64_t
-bt_field_class_signed_enumeration_mapping_ranges_get_range_count(
-               const struct bt_field_class_signed_enumeration_mapping_ranges *ranges);
+extern uint64_t bt_field_class_enumeration_mapping_get_range_count(
+               const bt_field_class_enumeration_mapping *mapping);
 
 extern void
-bt_field_class_unsigned_enumeration_mapping_ranges_get_range_by_index(
-               const struct bt_field_class_unsigned_enumeration_mapping_ranges *ranges,
+bt_field_class_unsigned_enumeration_mapping_get_range_by_index(
+               const bt_field_class_unsigned_enumeration_mapping *mapping,
                uint64_t index, uint64_t *lower, uint64_t *upper);
 
 extern void
-bt_field_class_signed_enumeration_mapping_ranges_get_range_by_index(
-               const struct bt_field_class_unsigned_enumeration_mapping_ranges *ranges,
+bt_field_class_signed_enumeration_mapping_get_range_by_index(
+               const bt_field_class_signed_enumeration_mapping *mapping,
                uint64_t index, int64_t *lower, int64_t *upper);
 
-extern int bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
-               const struct bt_field_class *field_class, uint64_t value,
+extern bt_field_class_status
+bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
+               const bt_field_class *field_class, uint64_t value,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count);
 
-extern int bt_field_class_signed_enumeration_get_mapping_labels_by_value(
-               const struct bt_field_class *field_class, int64_t value,
+extern bt_field_class_status
+bt_field_class_signed_enumeration_get_mapping_labels_by_value(
+               const bt_field_class *field_class, int64_t value,
                bt_field_class_enumeration_mapping_label_array *label_array,
                uint64_t *count);
 
 extern uint64_t bt_field_class_structure_get_member_count(
-               const struct bt_field_class *field_class);
+               const bt_field_class *field_class);
+
+extern const bt_field_class_structure_member *
+bt_field_class_structure_borrow_member_by_index_const(
+               const bt_field_class *field_class, uint64_t index);
+
+extern const bt_field_class_structure_member *
+bt_field_class_structure_borrow_member_by_name_const(
+               const bt_field_class *field_class, const char *name);
 
-extern void bt_field_class_structure_borrow_member_by_index_const(
-               const struct bt_field_class *struct_field_class, uint64_t index,
-               const char **name, const struct bt_field_class **field_class);
+extern const char *bt_field_class_structure_member_get_name(
+               const bt_field_class_structure_member *member);
 
-extern
-const struct bt_field_class *
-bt_field_class_structure_borrow_member_field_class_by_name_const(
-               const struct bt_field_class *field_class, const char *name);
+extern const bt_field_class *
+bt_field_class_structure_member_borrow_field_class_const(
+               const bt_field_class_structure_member *member);
 
-extern const struct bt_field_class *
+extern const bt_field_class *
 bt_field_class_array_borrow_element_field_class_const(
-               const struct bt_field_class *field_class);
+               const bt_field_class *field_class);
 
 extern uint64_t bt_field_class_static_array_get_length(
-               const struct bt_field_class *field_class);
+               const bt_field_class *field_class);
 
-extern const struct bt_field_path *
+extern const bt_field_path *
 bt_field_class_dynamic_array_borrow_length_field_path_const(
-               const struct bt_field_class *field_class);
+               const bt_field_class *field_class);
 
-extern const struct bt_field_path *
+extern const bt_field_path *
 bt_field_class_variant_borrow_selector_field_path_const(
-               const struct bt_field_class *field_class);
+               const bt_field_class *field_class);
 
 extern uint64_t bt_field_class_variant_get_option_count(
-               const struct bt_field_class *field_class);
+               const bt_field_class *field_class);
+
+extern const bt_field_class_variant_option *
+bt_field_class_variant_borrow_option_by_index_const(
+               const bt_field_class *field_class, uint64_t index);
+
+extern const bt_field_class_variant_option *
+bt_field_class_variant_borrow_option_by_name_const(
+               const bt_field_class *field_class, const char *name);
+
+extern const char *bt_field_class_variant_option_get_name(
+               const bt_field_class_variant_option *option);
+
+extern const bt_field_class *
+bt_field_class_variant_option_borrow_field_class_const(
+               const bt_field_class_variant_option *option);
+
+extern void bt_field_class_get_ref(const bt_field_class *field_class);
+
+extern void bt_field_class_put_ref(const bt_field_class *field_class);
+
+#define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var)         \
+       do {                                            \
+               bt_field_class_put_ref(_var);           \
+               (_var) = NULL;                          \
+       } while (0)
 
-extern void bt_field_class_variant_borrow_option_by_index_const(
-               const struct bt_field_class *variant_field_class, uint64_t index,
-               const char **name, const struct bt_field_class **field_class);
+#define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src)    \
+       do {                                            \
+               bt_field_class_put_ref(_var_dst);       \
+               (_var_dst) = (_var_src);                \
+               (_var_src) = NULL;                      \
+       } while (0)
 
-extern
-const struct bt_field_class *
-bt_field_class_variant_borrow_option_field_class_by_name_const(
-               const struct bt_field_class *field_class,
-               const char *name);
 
 #ifdef __cplusplus
 }
This page took 0.026872 seconds and 4 git commands to generate.