[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

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,
};

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,
};

extern enum 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 enum 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_unsigned_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 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 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 void bt_field_class_structure_borrow_member_by_index_const(
		const bt_field_class *struct_field_class, uint64_t index,
		const char **name, const bt_field_class **field_class);

extern
const bt_field_class *
bt_field_class_structure_borrow_member_field_class_by_name_const(
		const bt_field_class *field_class, const char *name);

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 void bt_field_class_variant_borrow_option_by_index_const(
		const bt_field_class *variant_field_class, uint64_t index,
		const char **name, const bt_field_class **field_class);

extern
const bt_field_class *
bt_field_class_variant_borrow_option_field_class_by_name_const(
		const bt_field_class *field_class,
		const char *name);

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
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 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	*/
78cf9df6 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
78cf9df6 PP	45	enum bt_field_class_type {
	46	BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
	47	BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
	48	BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
	49	BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
	50	BT_FIELD_CLASS_TYPE_REAL,
	51	BT_FIELD_CLASS_TYPE_STRING,
	52	BT_FIELD_CLASS_TYPE_STRUCTURE,
	53	BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
	54	BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
	55	BT_FIELD_CLASS_TYPE_VARIANT,
	56	};
	57
	58	enum bt_field_class_integer_preferred_display_base {
	59	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
	60	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
	61	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
	62	BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
	63	};
	64
	65	extern enum bt_field_class_type bt_field_class_get_type(
8eee8ea2	66	const bt_field_class *field_class);
78cf9df6 PP	67
78cf9df6 PP	68	extern uint64_t bt_field_class_integer_get_field_value_range(
8eee8ea2	69	const bt_field_class *field_class);
78cf9df6 PP	70
	71	extern enum bt_field_class_integer_preferred_display_base
	72	bt_field_class_integer_get_preferred_display_base(
8eee8ea2	73	const bt_field_class *field_class);
78cf9df6 PP	74
78cf9df6 PP	75	extern bt_bool bt_field_class_real_is_single_precision(
8eee8ea2	76	const bt_field_class *field_class);
78cf9df6 PP	77
78cf9df6 PP	78	extern uint64_t bt_field_class_enumeration_get_mapping_count(
8eee8ea2	79	const bt_field_class *field_class);
78cf9df6 PP	80
78cf9df6 PP	81	extern void bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
8eee8ea2	82	const bt_field_class *field_class, uint64_t index,
78cf9df6	83	const char **label,
8eee8ea2	84	const bt_field_class_unsigned_enumeration_mapping_ranges **ranges);
78cf9df6 PP	85
78cf9df6 PP	86	extern void bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
8eee8ea2	87	const bt_field_class *field_class, uint64_t index,
78cf9df6	88	const char **label,
8eee8ea2	89	const bt_field_class_signed_enumeration_mapping_ranges **ranges);
78cf9df6 PP	90
	91	extern uint64_t
	92	bt_field_class_unsigned_enumeration_mapping_ranges_get_range_count(
8eee8ea2	93	const bt_field_class_unsigned_enumeration_mapping_ranges *ranges);
78cf9df6 PP	94
	95	extern uint64_t
	96	bt_field_class_signed_enumeration_mapping_ranges_get_range_count(
8eee8ea2	97	const bt_field_class_signed_enumeration_mapping_ranges *ranges);
78cf9df6 PP	98
	99	extern void
	100	bt_field_class_unsigned_enumeration_mapping_ranges_get_range_by_index(
8eee8ea2	101	const bt_field_class_unsigned_enumeration_mapping_ranges *ranges,
78cf9df6 PP	102	uint64_t index, uint64_t lower, uint64_t upper);
	103
	104	extern void
	105	bt_field_class_signed_enumeration_mapping_ranges_get_range_by_index(
8eee8ea2	106	const bt_field_class_unsigned_enumeration_mapping_ranges *ranges,
78cf9df6 PP	107	uint64_t index, int64_t lower, int64_t upper);
	108
	109	extern int bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
8eee8ea2	110	const bt_field_class *field_class, uint64_t value,
78cf9df6 PP	111	bt_field_class_enumeration_mapping_label_array *label_array,
	112	uint64_t *count);
	113
	114	extern int bt_field_class_signed_enumeration_get_mapping_labels_by_value(
8eee8ea2	115	const bt_field_class *field_class, int64_t value,
78cf9df6 PP	116	bt_field_class_enumeration_mapping_label_array *label_array,
	117	uint64_t *count);
	118
	119	extern uint64_t bt_field_class_structure_get_member_count(
8eee8ea2	120	const bt_field_class *field_class);
78cf9df6 PP	121
78cf9df6 PP	122	extern void bt_field_class_structure_borrow_member_by_index_const(
8eee8ea2 PP	123	const bt_field_class *struct_field_class, uint64_t index,
8eee8ea2 PP	124	const char name, const bt_field_class field_class);
78cf9df6 PP	125
78cf9df6 PP	126	extern
8eee8ea2	127	const bt_field_class *
78cf9df6	128	bt_field_class_structure_borrow_member_field_class_by_name_const(
8eee8ea2	129	const bt_field_class field_class, const char name);
78cf9df6	130
8eee8ea2	131	extern const bt_field_class *
78cf9df6	132	bt_field_class_array_borrow_element_field_class_const(
8eee8ea2	133	const bt_field_class *field_class);
78cf9df6 PP	134
78cf9df6 PP	135	extern uint64_t bt_field_class_static_array_get_length(
8eee8ea2	136	const bt_field_class *field_class);
78cf9df6	137
8eee8ea2	138	extern const bt_field_path *
78cf9df6	139	bt_field_class_dynamic_array_borrow_length_field_path_const(
8eee8ea2	140	const bt_field_class *field_class);
78cf9df6	141
8eee8ea2	142	extern const bt_field_path *
78cf9df6	143	bt_field_class_variant_borrow_selector_field_path_const(
8eee8ea2	144	const bt_field_class *field_class);
78cf9df6 PP	145
78cf9df6 PP	146	extern uint64_t bt_field_class_variant_get_option_count(
8eee8ea2	147	const bt_field_class *field_class);
78cf9df6 PP	148
78cf9df6 PP	149	extern void bt_field_class_variant_borrow_option_by_index_const(
8eee8ea2 PP	150	const bt_field_class *variant_field_class, uint64_t index,
8eee8ea2 PP	151	const char name, const bt_field_class field_class);
78cf9df6 PP	152
78cf9df6 PP	153	extern
8eee8ea2	154	const bt_field_class *
78cf9df6	155	bt_field_class_variant_borrow_option_field_class_by_name_const(
8eee8ea2	156	const bt_field_class *field_class,
78cf9df6 PP	157	const char *name);
78cf9df6 PP	158
8eee8ea2	159	extern void bt_field_class_get_ref(const bt_field_class *field_class);
8c6884d9	160
8eee8ea2	161	extern void bt_field_class_put_ref(const bt_field_class *field_class);
8c6884d9 PP	162
	163	#define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
	164	do { \
	165	bt_field_class_put_ref(_var); \
	166	(_var) = NULL; \
	167	} while (0)
	168
	169	#define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
	170	do { \
	171	bt_field_class_put_ref(_var_dst); \
	172	(_var_dst) = (_var_src); \
	173	(_var_src) = NULL; \
	174	} while (0)
	175
	176
78cf9df6 PP	177	#ifdef __cplusplus
	178	}
	179	#endif
	180
	181	#endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */