[babeltrace.git] / include / babeltrace2 / trace-ir / field-class-const.h

#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
#define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H

/*
 * 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.
 *
 * The Common Trace Format (CTF) Specification is available at
 * http://www.efficios.com/ctf
 */

#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif

#include <stdint.h>
#include <stddef.h>

#include <babeltrace2/types.h>

#ifdef __cplusplus
extern "C" {
#endif

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_SIGNED_ENUMERATION,
	BT_FIELD_CLASS_TYPE_REAL,
	BT_FIELD_CLASS_TYPE_STRING,
	BT_FIELD_CLASS_TYPE_STRUCTURE,
	BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
	BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
	BT_FIELD_CLASS_TYPE_VARIANT,
} bt_field_class_type;

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 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 bt_field_class *field_class);

extern bt_field_class_integer_preferred_display_base
bt_field_class_integer_get_preferred_display_base(
		const bt_field_class *field_class);

extern bt_bool bt_field_class_real_is_single_precision(
		const bt_field_class *field_class);

extern uint64_t bt_field_class_enumeration_get_mapping_count(
		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);
}

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 const char *bt_field_class_enumeration_mapping_get_label(
		const bt_field_class_enumeration_mapping *mapping);

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_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_get_range_by_index(
		const bt_field_class_signed_enumeration_mapping *mapping,
		uint64_t index, int64_t *lower, int64_t *upper);

typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
	BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_field_class_enumeration_get_mapping_labels_for_value_status;

extern bt_field_class_enumeration_get_mapping_labels_for_value_status
bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
		const bt_field_class *field_class, uint64_t value,
		bt_field_class_enumeration_mapping_label_array *label_array,
		uint64_t *count);

extern bt_field_class_enumeration_get_mapping_labels_for_value_status
bt_field_class_signed_enumeration_get_mapping_labels_for_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 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 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 bt_field_class *field_class);

extern uint64_t bt_field_class_static_array_get_length(
		const bt_field_class *field_class);

extern const bt_field_path *
bt_field_class_dynamic_array_borrow_length_field_path_const(
		const bt_field_class *field_class);

extern const bt_field_path *
bt_field_class_variant_borrow_selector_field_path_const(
		const bt_field_class *field_class);

extern uint64_t bt_field_class_variant_get_option_count(
		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)

#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)


#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */
Commit	Line	Data
3fd40f46 PP	1	#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
3fd40f46 PP	2	#define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
78cf9df6 PP	3
78cf9df6 PP	4	/*
f2b0325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
78cf9df6 PP	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
78cf9df6 PP	7	*
78cf9df6 PP	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*
	26	* The Common Trace Format (CTF) Specification is available at
	27	* http://www.efficios.com/ctf
	28	*/
	29
9df34b44 PP	30	#ifndef __BT_IN_BABELTRACE_H
	31	# error "Please include <babeltrace2/babeltrace.h> instead."
	32	#endif
	33
78cf9df6 PP	34	#include <stdint.h>
	35	#include <stddef.h>
	36
e278f258 PP	37	#include <babeltrace2/types.h>
e278f258 PP	38
78cf9df6 PP	39	#ifdef __cplusplus
	40	extern "C" {
	41	#endif
	42
ee78f405	43	typedef enum bt_field_class_type {
78cf9df6 PP	44	BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
	45	BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
	46	BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
	47	BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
	48	BT_FIELD_CLASS_TYPE_REAL,
	49	BT_FIELD_CLASS_TYPE_STRING,
	50	BT_FIELD_CLASS_TYPE_STRUCTURE,
	51	BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
	52	BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
	53	BT_FIELD_CLASS_TYPE_VARIANT,
ee78f405	54	} bt_field_class_type;
78cf9df6	55
ee78f405	56	typedef enum bt_field_class_integer_preferred_display_base {
78cf9df6 PP	57	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
	58	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
	59	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
	60	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
ee78f405	61	} bt_field_class_integer_preferred_display_base;
78cf9df6	62
ee78f405	63	extern bt_field_class_type bt_field_class_get_type(
8eee8ea2	64	const bt_field_class *field_class);
78cf9df6 PP	65
78cf9df6 PP	66	extern uint64_t bt_field_class_integer_get_field_value_range(
8eee8ea2	67	const bt_field_class *field_class);
78cf9df6	68
ee78f405	69	extern bt_field_class_integer_preferred_display_base
78cf9df6	70	bt_field_class_integer_get_preferred_display_base(
8eee8ea2	71	const bt_field_class *field_class);
78cf9df6 PP	72
78cf9df6 PP	73	extern bt_bool bt_field_class_real_is_single_precision(
8eee8ea2	74	const bt_field_class *field_class);
78cf9df6 PP	75
78cf9df6 PP	76	extern uint64_t bt_field_class_enumeration_get_mapping_count(
8eee8ea2	77	const bt_field_class *field_class);
78cf9df6	78
b6baf3bb PP	79	extern const bt_field_class_unsigned_enumeration_mapping *
	80	bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
	81	const bt_field_class *field_class, uint64_t index);
	82
	83	extern const bt_field_class_signed_enumeration_mapping *
	84	bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
	85	const bt_field_class *field_class, uint64_t index);
	86
	87	static inline
	88	const bt_field_class_enumeration_mapping *
	89	bt_field_class_unsigned_enumeration_mapping_as_mapping_const(
	90	const bt_field_class_unsigned_enumeration_mapping *mapping)
	91	{
8470daa9	92	return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
b6baf3bb	93	}
78cf9df6	94
b6baf3bb PP	95	static inline
	96	const bt_field_class_enumeration_mapping *
	97	bt_field_class_signed_enumeration_mapping_as_mapping_const(
	98	const bt_field_class_signed_enumeration_mapping *mapping)
	99	{
8470daa9	100	return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
b6baf3bb	101	}
78cf9df6	102
b6baf3bb PP	103	extern const char *bt_field_class_enumeration_mapping_get_label(
b6baf3bb PP	104	const bt_field_class_enumeration_mapping *mapping);
78cf9df6	105
b6baf3bb PP	106	extern uint64_t bt_field_class_enumeration_mapping_get_range_count(
b6baf3bb PP	107	const bt_field_class_enumeration_mapping *mapping);
78cf9df6 PP	108
78cf9df6 PP	109	extern void
b6baf3bb PP	110	bt_field_class_unsigned_enumeration_mapping_get_range_by_index(
b6baf3bb PP	111	const bt_field_class_unsigned_enumeration_mapping *mapping,
78cf9df6 PP	112	uint64_t index, uint64_t lower, uint64_t upper);
	113
	114	extern void
b6baf3bb PP	115	bt_field_class_signed_enumeration_mapping_get_range_by_index(
b6baf3bb PP	116	const bt_field_class_signed_enumeration_mapping *mapping,
78cf9df6 PP	117	uint64_t index, int64_t lower, int64_t upper);
78cf9df6 PP	118
1091bb60	119	typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
fb25b9e3 PP	120	BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
fb25b9e3 PP	121	BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK,
1091bb60	122	} bt_field_class_enumeration_get_mapping_labels_for_value_status;
fb25b9e3	123
1091bb60 PP	124	extern bt_field_class_enumeration_get_mapping_labels_for_value_status
1091bb60 PP	125	bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
8eee8ea2	126	const bt_field_class *field_class, uint64_t value,
78cf9df6 PP	127	bt_field_class_enumeration_mapping_label_array *label_array,
	128	uint64_t *count);
	129
1091bb60 PP	130	extern bt_field_class_enumeration_get_mapping_labels_for_value_status
1091bb60 PP	131	bt_field_class_signed_enumeration_get_mapping_labels_for_value(
8eee8ea2	132	const bt_field_class *field_class, int64_t value,
78cf9df6 PP	133	bt_field_class_enumeration_mapping_label_array *label_array,
	134	uint64_t *count);
	135
	136	extern uint64_t bt_field_class_structure_get_member_count(
8eee8ea2	137	const bt_field_class *field_class);
78cf9df6	138
e24f271a PP	139	extern const bt_field_class_structure_member *
	140	bt_field_class_structure_borrow_member_by_index_const(
	141	const bt_field_class *field_class, uint64_t index);
78cf9df6	142
e24f271a PP	143	extern const bt_field_class_structure_member *
e24f271a PP	144	bt_field_class_structure_borrow_member_by_name_const(
8eee8ea2	145	const bt_field_class field_class, const char name);
78cf9df6	146
e24f271a PP	147	extern const char *bt_field_class_structure_member_get_name(
	148	const bt_field_class_structure_member *member);
	149
	150	extern const bt_field_class *
	151	bt_field_class_structure_member_borrow_field_class_const(
	152	const bt_field_class_structure_member *member);
	153
8eee8ea2	154	extern const bt_field_class *
78cf9df6	155	bt_field_class_array_borrow_element_field_class_const(
8eee8ea2	156	const bt_field_class *field_class);
78cf9df6 PP	157
78cf9df6 PP	158	extern uint64_t bt_field_class_static_array_get_length(
8eee8ea2	159	const bt_field_class *field_class);
78cf9df6	160
8eee8ea2	161	extern const bt_field_path *
78cf9df6	162	bt_field_class_dynamic_array_borrow_length_field_path_const(
8eee8ea2	163	const bt_field_class *field_class);
78cf9df6	164
8eee8ea2	165	extern const bt_field_path *
78cf9df6	166	bt_field_class_variant_borrow_selector_field_path_const(
8eee8ea2	167	const bt_field_class *field_class);
78cf9df6 PP	168
78cf9df6 PP	169	extern uint64_t bt_field_class_variant_get_option_count(
8eee8ea2	170	const bt_field_class *field_class);
78cf9df6	171
e24f271a PP	172	extern const bt_field_class_variant_option *
	173	bt_field_class_variant_borrow_option_by_index_const(
	174	const bt_field_class *field_class, uint64_t index);
78cf9df6	175
e24f271a PP	176	extern const bt_field_class_variant_option *
	177	bt_field_class_variant_borrow_option_by_name_const(
	178	const bt_field_class field_class, const char name);
	179
	180	extern const char *bt_field_class_variant_option_get_name(
	181	const bt_field_class_variant_option *option);
	182
	183	extern const bt_field_class *
	184	bt_field_class_variant_option_borrow_field_class_const(
	185	const bt_field_class_variant_option *option);
78cf9df6	186
8eee8ea2	187	extern void bt_field_class_get_ref(const bt_field_class *field_class);
8c6884d9	188
8eee8ea2	189	extern void bt_field_class_put_ref(const bt_field_class *field_class);
8c6884d9 PP	190
	191	#define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
	192	do { \
	193	bt_field_class_put_ref(_var); \
	194	(_var) = NULL; \
	195	} while (0)
	196
	197	#define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
	198	do { \
	199	bt_field_class_put_ref(_var_dst); \
	200	(_var_dst) = (_var_src); \
	201	(_var_src) = NULL; \
	202	} while (0)
	203
	204
78cf9df6 PP	205	#ifdef __cplusplus
	206	}
	207	#endif
	208
3fd40f46	209	#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */