[deliverable/babeltrace.git] / include / babeltrace / 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_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>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum bt_field_class_status {
	BT_FIELD_CLASS_STATUS_OK = 0,
	BT_FIELD_CLASS_STATUS_NOMEM = -12,
} bt_field_class_status;

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 void bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
		const bt_field_class *field_class, uint64_t index,
		const char **label,
		const bt_field_class_unsigned_enumeration_mapping_ranges **ranges);

extern void bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
		const bt_field_class *field_class, uint64_t index,
		const char **label,
		const bt_field_class_signed_enumeration_mapping_ranges **ranges);

extern uint64_t
bt_field_class_unsigned_enumeration_mapping_ranges_get_range_count(
		const bt_field_class_unsigned_enumeration_mapping_ranges *ranges);

extern uint64_t
bt_field_class_signed_enumeration_mapping_ranges_get_range_count(
		const bt_field_class_signed_enumeration_mapping_ranges *ranges);

extern void
bt_field_class_unsigned_enumeration_mapping_ranges_get_range_by_index(
		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 bt_field_class_signed_enumeration_mapping_ranges *ranges,
		uint64_t index, int64_t *lower, int64_t *upper);

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 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 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 /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */
Commit	Line	Data
dadf29b9 PP	1	#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
	2	#define BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
	3
	4	/*
0554db57	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
dadf29b9 PP	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
dadf29b9 PP	7	*
dadf29b9 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
b9879703 PP	30	/*
	31	* For bt_bool, bt_field_class bt_field_path
	32	* bt_field_class_signed_enumeration_mapping_ranges
	33	* bt_field_class_unsigned_enumeration_mapping_ranges,
	34	* bt_field_class_enumeration_mapping_label_array
	35	*/
dadf29b9 PP	36	#include <babeltrace/types.h>
	37
	38	#include <stdint.h>
	39	#include <stddef.h>
	40
	41	#ifdef __cplusplus
	42	extern "C" {
	43	#endif
	44
b7c5b62e	45	typedef enum bt_field_class_status {
36a0a6ef PP	46	BT_FIELD_CLASS_STATUS_OK = 0,
36a0a6ef PP	47	BT_FIELD_CLASS_STATUS_NOMEM = -12,
b7c5b62e	48	} bt_field_class_status;
36a0a6ef	49
b7c5b62e	50	typedef enum bt_field_class_type {
dadf29b9 PP	51	BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
	52	BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
	53	BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
	54	BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
	55	BT_FIELD_CLASS_TYPE_REAL,
	56	BT_FIELD_CLASS_TYPE_STRING,
	57	BT_FIELD_CLASS_TYPE_STRUCTURE,
	58	BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
	59	BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
	60	BT_FIELD_CLASS_TYPE_VARIANT,
b7c5b62e	61	} bt_field_class_type;
dadf29b9	62
b7c5b62e	63	typedef enum bt_field_class_integer_preferred_display_base {
dadf29b9 PP	64	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
	65	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
	66	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
	67	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
b7c5b62e	68	} bt_field_class_integer_preferred_display_base;
dadf29b9	69
b7c5b62e	70	extern bt_field_class_type bt_field_class_get_type(
b9879703	71	const bt_field_class *field_class);
dadf29b9 PP	72
dadf29b9 PP	73	extern uint64_t bt_field_class_integer_get_field_value_range(
b9879703	74	const bt_field_class *field_class);
dadf29b9	75
b7c5b62e	76	extern bt_field_class_integer_preferred_display_base
dadf29b9	77	bt_field_class_integer_get_preferred_display_base(
b9879703	78	const bt_field_class *field_class);
dadf29b9 PP	79
dadf29b9 PP	80	extern bt_bool bt_field_class_real_is_single_precision(
b9879703	81	const bt_field_class *field_class);
dadf29b9 PP	82
dadf29b9 PP	83	extern uint64_t bt_field_class_enumeration_get_mapping_count(
b9879703	84	const bt_field_class *field_class);
dadf29b9 PP	85
dadf29b9 PP	86	extern void bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
b9879703	87	const bt_field_class *field_class, uint64_t index,
dadf29b9	88	const char **label,
b9879703	89	const bt_field_class_unsigned_enumeration_mapping_ranges **ranges);
dadf29b9 PP	90
dadf29b9 PP	91	extern void bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
b9879703	92	const bt_field_class *field_class, uint64_t index,
dadf29b9	93	const char **label,
b9879703	94	const bt_field_class_signed_enumeration_mapping_ranges **ranges);
dadf29b9 PP	95
	96	extern uint64_t
	97	bt_field_class_unsigned_enumeration_mapping_ranges_get_range_count(
b9879703	98	const bt_field_class_unsigned_enumeration_mapping_ranges *ranges);
dadf29b9 PP	99
	100	extern uint64_t
	101	bt_field_class_signed_enumeration_mapping_ranges_get_range_count(
b9879703	102	const bt_field_class_signed_enumeration_mapping_ranges *ranges);
dadf29b9 PP	103
	104	extern void
	105	bt_field_class_unsigned_enumeration_mapping_ranges_get_range_by_index(
b9879703	106	const bt_field_class_unsigned_enumeration_mapping_ranges *ranges,
dadf29b9 PP	107	uint64_t index, uint64_t lower, uint64_t upper);
	108
	109	extern void
	110	bt_field_class_signed_enumeration_mapping_ranges_get_range_by_index(
5a58b4f3	111	const bt_field_class_signed_enumeration_mapping_ranges *ranges,
dadf29b9 PP	112	uint64_t index, int64_t lower, int64_t upper);
dadf29b9 PP	113
b7c5b62e	114	extern bt_field_class_status
36a0a6ef	115	bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
b9879703	116	const bt_field_class *field_class, uint64_t value,
dadf29b9 PP	117	bt_field_class_enumeration_mapping_label_array *label_array,
	118	uint64_t *count);
	119
b7c5b62e	120	extern bt_field_class_status
36a0a6ef	121	bt_field_class_signed_enumeration_get_mapping_labels_by_value(
b9879703	122	const bt_field_class *field_class, int64_t value,
dadf29b9 PP	123	bt_field_class_enumeration_mapping_label_array *label_array,
	124	uint64_t *count);
	125
	126	extern uint64_t bt_field_class_structure_get_member_count(
b9879703	127	const bt_field_class *field_class);
dadf29b9	128
4cbed8e8 PP	129	extern const bt_field_class_structure_member *
	130	bt_field_class_structure_borrow_member_by_index_const(
	131	const bt_field_class *field_class, uint64_t index);
dadf29b9	132
4cbed8e8 PP	133	extern const bt_field_class_structure_member *
4cbed8e8 PP	134	bt_field_class_structure_borrow_member_by_name_const(
b9879703	135	const bt_field_class field_class, const char name);
dadf29b9	136
4cbed8e8 PP	137	extern const char *bt_field_class_structure_member_get_name(
	138	const bt_field_class_structure_member *member);
	139
	140	extern const bt_field_class *
	141	bt_field_class_structure_member_borrow_field_class_const(
	142	const bt_field_class_structure_member *member);
	143
b9879703	144	extern const bt_field_class *
dadf29b9	145	bt_field_class_array_borrow_element_field_class_const(
b9879703	146	const bt_field_class *field_class);
dadf29b9 PP	147
dadf29b9 PP	148	extern uint64_t bt_field_class_static_array_get_length(
b9879703	149	const bt_field_class *field_class);
dadf29b9	150
b9879703	151	extern const bt_field_path *
dadf29b9	152	bt_field_class_dynamic_array_borrow_length_field_path_const(
b9879703	153	const bt_field_class *field_class);
dadf29b9	154
b9879703	155	extern const bt_field_path *
dadf29b9	156	bt_field_class_variant_borrow_selector_field_path_const(
b9879703	157	const bt_field_class *field_class);
dadf29b9 PP	158
dadf29b9 PP	159	extern uint64_t bt_field_class_variant_get_option_count(
b9879703	160	const bt_field_class *field_class);
dadf29b9	161
4cbed8e8 PP	162	extern const bt_field_class_variant_option *
	163	bt_field_class_variant_borrow_option_by_index_const(
	164	const bt_field_class *field_class, uint64_t index);
dadf29b9	165
4cbed8e8 PP	166	extern const bt_field_class_variant_option *
	167	bt_field_class_variant_borrow_option_by_name_const(
	168	const bt_field_class field_class, const char name);
	169
	170	extern const char *bt_field_class_variant_option_get_name(
	171	const bt_field_class_variant_option *option);
	172
	173	extern const bt_field_class *
	174	bt_field_class_variant_option_borrow_field_class_const(
	175	const bt_field_class_variant_option *option);
dadf29b9	176
b9879703	177	extern void bt_field_class_get_ref(const bt_field_class *field_class);
317e35ec	178
b9879703	179	extern void bt_field_class_put_ref(const bt_field_class *field_class);
317e35ec PP	180
	181	#define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
	182	do { \
	183	bt_field_class_put_ref(_var); \
	184	(_var) = NULL; \
	185	} while (0)
	186
	187	#define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
	188	do { \
	189	bt_field_class_put_ref(_var_dst); \
	190	(_var_dst) = (_var_src); \
	191	(_var_src) = NULL; \
	192	} while (0)
	193
	194
dadf29b9 PP	195	#ifdef __cplusplus
	196	}
	197	#endif
	198
	199	#endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */