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

#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
#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>
 *
 * 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
 */

/*
 * 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 <babeltrace2/types.h>

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

/* For __BT_FUNC_STATUS_* */
#define __BT_FUNC_STATUS_ENABLE
#include <babeltrace2/func-status.h>
#undef __BT_FUNC_STATUS_ENABLE

#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

#include <babeltrace2/undef-func-status.h>

#endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */
Commit	Line	Data
78cf9df6 PP	1	#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
	2	#define BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
	3
	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
8eee8ea2	30	/*
b6baf3bb PP	31	* For bt_bool, bt_field_class, bt_field_path,
	32	* bt_field_class_enumeration_mapping,
	33	* bt_field_class_unsigned_enumeration_mapping,
	34	* bt_field_class_signed_enumeration_mapping,
8470daa9	35	* bt_field_class_enumeration_mapping_label_array, __BT_UPCAST_CONST
8eee8ea2	36	*/
71c5da58	37	#include <babeltrace2/types.h>
78cf9df6 PP	38
	39	#include <stdint.h>
	40	#include <stddef.h>
	41
fb25b9e3 PP	42	/* For __BT_FUNC_STATUS_* */
	43	#define __BT_FUNC_STATUS_ENABLE
	44	#include <babeltrace2/func-status.h>
	45	#undef __BT_FUNC_STATUS_ENABLE
	46
78cf9df6 PP	47	#ifdef __cplusplus
	48	extern "C" {
	49	#endif
	50
ee78f405	51	typedef enum bt_field_class_type {
78cf9df6 PP	52	BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
	53	BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
	54	BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
	55	BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
	56	BT_FIELD_CLASS_TYPE_REAL,
	57	BT_FIELD_CLASS_TYPE_STRING,
	58	BT_FIELD_CLASS_TYPE_STRUCTURE,
	59	BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
	60	BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
	61	BT_FIELD_CLASS_TYPE_VARIANT,
ee78f405	62	} bt_field_class_type;
78cf9df6	63
ee78f405	64	typedef enum bt_field_class_integer_preferred_display_base {
78cf9df6 PP	65	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
	66	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
	67	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
	68	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
ee78f405	69	} bt_field_class_integer_preferred_display_base;
78cf9df6	70
ee78f405	71	extern bt_field_class_type bt_field_class_get_type(
8eee8ea2	72	const bt_field_class *field_class);
78cf9df6 PP	73
78cf9df6 PP	74	extern uint64_t bt_field_class_integer_get_field_value_range(
8eee8ea2	75	const bt_field_class *field_class);
78cf9df6	76
ee78f405	77	extern bt_field_class_integer_preferred_display_base
78cf9df6	78	bt_field_class_integer_get_preferred_display_base(
8eee8ea2	79	const bt_field_class *field_class);
78cf9df6 PP	80
78cf9df6 PP	81	extern bt_bool bt_field_class_real_is_single_precision(
8eee8ea2	82	const bt_field_class *field_class);
78cf9df6 PP	83
78cf9df6 PP	84	extern uint64_t bt_field_class_enumeration_get_mapping_count(
8eee8ea2	85	const bt_field_class *field_class);
78cf9df6	86
b6baf3bb PP	87	extern const bt_field_class_unsigned_enumeration_mapping *
	88	bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
	89	const bt_field_class *field_class, uint64_t index);
	90
	91	extern const bt_field_class_signed_enumeration_mapping *
	92	bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
	93	const bt_field_class *field_class, uint64_t index);
	94
	95	static inline
	96	const bt_field_class_enumeration_mapping *
	97	bt_field_class_unsigned_enumeration_mapping_as_mapping_const(
	98	const bt_field_class_unsigned_enumeration_mapping *mapping)
	99	{
8470daa9	100	return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
b6baf3bb	101	}
78cf9df6	102
b6baf3bb PP	103	static inline
	104	const bt_field_class_enumeration_mapping *
	105	bt_field_class_signed_enumeration_mapping_as_mapping_const(
	106	const bt_field_class_signed_enumeration_mapping *mapping)
	107	{
8470daa9	108	return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
b6baf3bb	109	}
78cf9df6	110
b6baf3bb PP	111	extern const char *bt_field_class_enumeration_mapping_get_label(
b6baf3bb PP	112	const bt_field_class_enumeration_mapping *mapping);
78cf9df6	113
b6baf3bb PP	114	extern uint64_t bt_field_class_enumeration_mapping_get_range_count(
b6baf3bb PP	115	const bt_field_class_enumeration_mapping *mapping);
78cf9df6 PP	116
78cf9df6 PP	117	extern void
b6baf3bb PP	118	bt_field_class_unsigned_enumeration_mapping_get_range_by_index(
b6baf3bb PP	119	const bt_field_class_unsigned_enumeration_mapping *mapping,
78cf9df6 PP	120	uint64_t index, uint64_t lower, uint64_t upper);
	121
	122	extern void
b6baf3bb PP	123	bt_field_class_signed_enumeration_mapping_get_range_by_index(
b6baf3bb PP	124	const bt_field_class_signed_enumeration_mapping *mapping,
78cf9df6 PP	125	uint64_t index, int64_t lower, int64_t upper);
78cf9df6 PP	126
1091bb60	127	typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
fb25b9e3 PP	128	BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
fb25b9e3 PP	129	BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK,
1091bb60	130	} bt_field_class_enumeration_get_mapping_labels_for_value_status;
fb25b9e3	131
1091bb60 PP	132	extern bt_field_class_enumeration_get_mapping_labels_for_value_status
1091bb60 PP	133	bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
8eee8ea2	134	const bt_field_class *field_class, uint64_t value,
78cf9df6 PP	135	bt_field_class_enumeration_mapping_label_array *label_array,
	136	uint64_t *count);
	137
1091bb60 PP	138	extern bt_field_class_enumeration_get_mapping_labels_for_value_status
1091bb60 PP	139	bt_field_class_signed_enumeration_get_mapping_labels_for_value(
8eee8ea2	140	const bt_field_class *field_class, int64_t value,
78cf9df6 PP	141	bt_field_class_enumeration_mapping_label_array *label_array,
	142	uint64_t *count);
	143
	144	extern uint64_t bt_field_class_structure_get_member_count(
8eee8ea2	145	const bt_field_class *field_class);
78cf9df6	146
e24f271a PP	147	extern const bt_field_class_structure_member *
	148	bt_field_class_structure_borrow_member_by_index_const(
	149	const bt_field_class *field_class, uint64_t index);
78cf9df6	150
e24f271a PP	151	extern const bt_field_class_structure_member *
e24f271a PP	152	bt_field_class_structure_borrow_member_by_name_const(
8eee8ea2	153	const bt_field_class field_class, const char name);
78cf9df6	154
e24f271a PP	155	extern const char *bt_field_class_structure_member_get_name(
	156	const bt_field_class_structure_member *member);
	157
	158	extern const bt_field_class *
	159	bt_field_class_structure_member_borrow_field_class_const(
	160	const bt_field_class_structure_member *member);
	161
8eee8ea2	162	extern const bt_field_class *
78cf9df6	163	bt_field_class_array_borrow_element_field_class_const(
8eee8ea2	164	const bt_field_class *field_class);
78cf9df6 PP	165
78cf9df6 PP	166	extern uint64_t bt_field_class_static_array_get_length(
8eee8ea2	167	const bt_field_class *field_class);
78cf9df6	168
8eee8ea2	169	extern const bt_field_path *
78cf9df6	170	bt_field_class_dynamic_array_borrow_length_field_path_const(
8eee8ea2	171	const bt_field_class *field_class);
78cf9df6	172
8eee8ea2	173	extern const bt_field_path *
78cf9df6	174	bt_field_class_variant_borrow_selector_field_path_const(
8eee8ea2	175	const bt_field_class *field_class);
78cf9df6 PP	176
78cf9df6 PP	177	extern uint64_t bt_field_class_variant_get_option_count(
8eee8ea2	178	const bt_field_class *field_class);
78cf9df6	179
e24f271a PP	180	extern const bt_field_class_variant_option *
	181	bt_field_class_variant_borrow_option_by_index_const(
	182	const bt_field_class *field_class, uint64_t index);
78cf9df6	183
e24f271a PP	184	extern const bt_field_class_variant_option *
	185	bt_field_class_variant_borrow_option_by_name_const(
	186	const bt_field_class field_class, const char name);
	187
	188	extern const char *bt_field_class_variant_option_get_name(
	189	const bt_field_class_variant_option *option);
	190
	191	extern const bt_field_class *
	192	bt_field_class_variant_option_borrow_field_class_const(
	193	const bt_field_class_variant_option *option);
78cf9df6	194
8eee8ea2	195	extern void bt_field_class_get_ref(const bt_field_class *field_class);
8c6884d9	196
8eee8ea2	197	extern void bt_field_class_put_ref(const bt_field_class *field_class);
8c6884d9 PP	198
	199	#define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
	200	do { \
	201	bt_field_class_put_ref(_var); \
	202	(_var) = NULL; \
	203	} while (0)
	204
	205	#define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
	206	do { \
	207	bt_field_class_put_ref(_var_dst); \
	208	(_var_dst) = (_var_src); \
	209	(_var_src) = NULL; \
	210	} while (0)
	211
	212
78cf9df6 PP	213	#ifdef __cplusplus
	214	}
	215	#endif
	216
fb25b9e3 PP	217	#include <babeltrace2/undef-func-status.h>
fb25b9e3 PP	218
78cf9df6	219	#endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */