#define BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
/*
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
- * Author: 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
* http://www.efficios.com/ctf
*/
-/* For bt_bool */
+/*
+ * For bt_bool, bt_field_class bt_field_path
+ * bt_field_class_signed_enumeration_mapping_ranges
+ * bt_field_class_unsigned_enumeration_mapping_ranges,
+ * bt_field_class_enumeration_mapping_label_array
+ */
#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 const char * const *bt_field_class_enumeration_mapping_label_array;
+typedef enum bt_field_class_status {
+ BT_FIELD_CLASS_STATUS_OK = 0,
+ BT_FIELD_CLASS_STATUS_NOMEM = -12,
+} bt_field_class_status;
-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,
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);
+ const 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 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_unsigned_enumeration_mapping_ranges **ranges);
extern void bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
- const struct bt_field_class *field_class, uint64_t index,
+ const bt_field_class *field_class, uint64_t index,
const char **label,
- const struct bt_field_class_signed_enumeration_mapping_ranges **ranges);
+ const bt_field_class_signed_enumeration_mapping_ranges **ranges);
extern uint64_t
bt_field_class_unsigned_enumeration_mapping_ranges_get_range_count(
- const struct bt_field_class_unsigned_enumeration_mapping_ranges *ranges);
+ const bt_field_class_unsigned_enumeration_mapping_ranges *ranges);
extern uint64_t
bt_field_class_signed_enumeration_mapping_ranges_get_range_count(
- const struct bt_field_class_signed_enumeration_mapping_ranges *ranges);
+ const bt_field_class_signed_enumeration_mapping_ranges *ranges);
extern void
bt_field_class_unsigned_enumeration_mapping_ranges_get_range_by_index(
- const struct bt_field_class_unsigned_enumeration_mapping_ranges *ranges,
+ const bt_field_class_unsigned_enumeration_mapping_ranges *ranges,
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,
+ const bt_field_class_signed_enumeration_mapping_ranges *ranges,
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 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 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 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_structure_member *
+bt_field_class_structure_borrow_member_by_name_const(
+ const bt_field_class *field_class, const char *name);
-extern const struct bt_field_class *
+extern const char *bt_field_class_structure_member_get_name(
+ const bt_field_class_structure_member *member);
+
+extern const bt_field_class *
+bt_field_class_structure_member_borrow_field_class_const(
+ const bt_field_class_structure_member *member);
+
+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
}