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

#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
#define BABELTRACE2_TRACE_IR_FIELD_CLASS_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>

/* For bt_bool, bt_field_class, bt_trace_class */
#include <babeltrace2/types.h>

/* For bt_field_class_integer_preferred_display_base */
#include <babeltrace2/trace-ir/field-class-const.h>

#ifdef __cplusplus
extern "C" {
#endif

extern bt_field_class *bt_field_class_unsigned_integer_create(
		bt_trace_class *trace_class);

extern bt_field_class *bt_field_class_signed_integer_create(
		bt_trace_class *trace_class);

extern void bt_field_class_integer_set_field_value_range(
		bt_field_class *field_class, uint64_t size);

extern void bt_field_class_integer_set_preferred_display_base(
		bt_field_class *field_class,
		bt_field_class_integer_preferred_display_base base);

extern bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class);

extern void bt_field_class_real_set_is_single_precision(
		bt_field_class *field_class,
		bt_bool is_single_precision);

extern bt_field_class *bt_field_class_unsigned_enumeration_create(
		bt_trace_class *trace_class);

extern bt_field_class *bt_field_class_signed_enumeration_create(
		bt_trace_class *trace_class);

typedef enum bt_field_class_enumeration_map_range_status {
	BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_OK			= __BT_FUNC_STATUS_OK,
} bt_field_class_enumeration_map_range_status;

extern bt_field_class_enumeration_map_range_status
bt_field_class_unsigned_enumeration_map_range(
		bt_field_class *field_class, const char *label,
		uint64_t range_lower, uint64_t range_upper);

extern bt_field_class_enumeration_map_range_status
bt_field_class_signed_enumeration_map_range(
		bt_field_class *field_class, const char *label,
		int64_t range_lower, int64_t range_upper);

extern bt_field_class *bt_field_class_string_create(
		bt_trace_class *trace_class);

extern bt_field_class *bt_field_class_structure_create(
		bt_trace_class *trace_class);

typedef enum bt_field_class_structure_append_member_status {
	BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_field_class_structure_append_member_status;

extern bt_field_class_structure_append_member_status
bt_field_class_structure_append_member(
		bt_field_class *struct_field_class,
		const char *name, bt_field_class *field_class);

extern bt_field_class_structure_member *
bt_field_class_structure_borrow_member_by_index(
		bt_field_class *field_class, uint64_t index);

extern bt_field_class_structure_member *
bt_field_class_structure_borrow_member_by_name(
		bt_field_class *field_class, const char *name);

extern bt_field_class *bt_field_class_static_array_create(
		bt_trace_class *trace_class,
		bt_field_class *elem_field_class, uint64_t length);

extern bt_field_class *bt_field_class_dynamic_array_create(
		bt_trace_class *trace_class,
		bt_field_class *elem_field_class);

extern bt_field_class *bt_field_class_array_borrow_element_field_class(
		bt_field_class *field_class);

typedef enum bt_field_class_dynamic_array_set_length_field_class_status {
	BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_OK			= __BT_FUNC_STATUS_OK,
} bt_field_class_dynamic_array_set_length_field_class_status;

extern bt_field_class_dynamic_array_set_length_field_class_status
bt_field_class_dynamic_array_set_length_field_class(
		bt_field_class *field_class,
		bt_field_class *length_field_class);

extern bt_field_class *bt_field_class_variant_create(
		bt_trace_class *trace_class);

typedef enum bt_field_class_variant_set_selector_field_class_status {
	BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_OK			= __BT_FUNC_STATUS_OK,
} bt_field_class_variant_set_selector_field_class_status;

extern bt_field_class_variant_set_selector_field_class_status
bt_field_class_variant_set_selector_field_class(bt_field_class *field_class,
		bt_field_class *selector_field_class);

typedef enum bt_field_class_variant_append_option_status {
	BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_OK			= __BT_FUNC_STATUS_OK,
} bt_field_class_variant_append_option_status;

extern bt_field_class_variant_append_option_status
bt_field_class_variant_append_option(
		bt_field_class *var_field_class,
		const char *name, bt_field_class *field_class);

extern bt_field_class_variant_option *
bt_field_class_variant_borrow_option_by_index(
		bt_field_class *field_class, uint64_t index);

extern bt_field_class_variant_option *
bt_field_class_variant_borrow_option_by_name(
		bt_field_class *field_class, const char *name);

extern bt_field_class *bt_field_class_variant_option_borrow_field_class(
		bt_field_class_variant_option *option);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */
Commit	Line	Data
	1	#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
	2	#define BABELTRACE2_TRACE_IR_FIELD_CLASS_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	7	*
	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
	30	#ifndef __BT_IN_BABELTRACE_H
	31	# error "Please include <babeltrace2/babeltrace.h> instead."
	32	#endif
	33
	34	#include <stdint.h>
	35	#include <stddef.h>
	36
	37	/* For bt_bool, bt_field_class, bt_trace_class */
	38	#include <babeltrace2/types.h>
	39
	40	/* For bt_field_class_integer_preferred_display_base */
	41	#include <babeltrace2/trace-ir/field-class-const.h>
	42
	43	#ifdef __cplusplus
	44	extern "C" {
	45	#endif
	46
	47	extern bt_field_class *bt_field_class_unsigned_integer_create(
	48	bt_trace_class *trace_class);
	49
	50	extern bt_field_class *bt_field_class_signed_integer_create(
	51	bt_trace_class *trace_class);
	52
	53	extern void bt_field_class_integer_set_field_value_range(
	54	bt_field_class *field_class, uint64_t size);
	55
	56	extern void bt_field_class_integer_set_preferred_display_base(
	57	bt_field_class *field_class,
	58	bt_field_class_integer_preferred_display_base base);
	59
	60	extern bt_field_class bt_field_class_real_create(bt_trace_class trace_class);
	61
	62	extern void bt_field_class_real_set_is_single_precision(
	63	bt_field_class *field_class,
	64	bt_bool is_single_precision);
	65
	66	extern bt_field_class *bt_field_class_unsigned_enumeration_create(
	67	bt_trace_class *trace_class);
	68
	69	extern bt_field_class *bt_field_class_signed_enumeration_create(
	70	bt_trace_class *trace_class);
	71
	72	typedef enum bt_field_class_enumeration_map_range_status {
	73	BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	74	BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_OK = __BT_FUNC_STATUS_OK,
	75	} bt_field_class_enumeration_map_range_status;
	76
	77	extern bt_field_class_enumeration_map_range_status
	78	bt_field_class_unsigned_enumeration_map_range(
	79	bt_field_class field_class, const char label,
	80	uint64_t range_lower, uint64_t range_upper);
	81
	82	extern bt_field_class_enumeration_map_range_status
	83	bt_field_class_signed_enumeration_map_range(
	84	bt_field_class field_class, const char label,
	85	int64_t range_lower, int64_t range_upper);
	86
	87	extern bt_field_class *bt_field_class_string_create(
	88	bt_trace_class *trace_class);
	89
	90	extern bt_field_class *bt_field_class_structure_create(
	91	bt_trace_class *trace_class);
	92
	93	typedef enum bt_field_class_structure_append_member_status {
	94	BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	95	BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK = __BT_FUNC_STATUS_OK,
	96	} bt_field_class_structure_append_member_status;
	97
	98	extern bt_field_class_structure_append_member_status
	99	bt_field_class_structure_append_member(
	100	bt_field_class *struct_field_class,
	101	const char name, bt_field_class field_class);
	102
	103	extern bt_field_class_structure_member *
	104	bt_field_class_structure_borrow_member_by_index(
	105	bt_field_class *field_class, uint64_t index);
	106
	107	extern bt_field_class_structure_member *
	108	bt_field_class_structure_borrow_member_by_name(
	109	bt_field_class field_class, const char name);
	110
	111	extern bt_field_class *bt_field_class_static_array_create(
	112	bt_trace_class *trace_class,
	113	bt_field_class *elem_field_class, uint64_t length);
	114
	115	extern bt_field_class *bt_field_class_dynamic_array_create(
	116	bt_trace_class *trace_class,
	117	bt_field_class *elem_field_class);
	118
	119	extern bt_field_class *bt_field_class_array_borrow_element_field_class(
	120	bt_field_class *field_class);
	121
	122	typedef enum bt_field_class_dynamic_array_set_length_field_class_status {
	123	BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	124	BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK,
	125	} bt_field_class_dynamic_array_set_length_field_class_status;
	126
	127	extern bt_field_class_dynamic_array_set_length_field_class_status
	128	bt_field_class_dynamic_array_set_length_field_class(
	129	bt_field_class *field_class,
	130	bt_field_class *length_field_class);
	131
	132	extern bt_field_class *bt_field_class_variant_create(
	133	bt_trace_class *trace_class);
	134
	135	typedef enum bt_field_class_variant_set_selector_field_class_status {
	136	BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	137	BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK,
	138	} bt_field_class_variant_set_selector_field_class_status;
	139
	140	extern bt_field_class_variant_set_selector_field_class_status
	141	bt_field_class_variant_set_selector_field_class(bt_field_class *field_class,
	142	bt_field_class *selector_field_class);
	143
	144	typedef enum bt_field_class_variant_append_option_status {
	145	BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	146	BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
	147	} bt_field_class_variant_append_option_status;
	148
	149	extern bt_field_class_variant_append_option_status
	150	bt_field_class_variant_append_option(
	151	bt_field_class *var_field_class,
	152	const char name, bt_field_class field_class);
	153
	154	extern bt_field_class_variant_option *
	155	bt_field_class_variant_borrow_option_by_index(
	156	bt_field_class *field_class, uint64_t index);
	157
	158	extern bt_field_class_variant_option *
	159	bt_field_class_variant_borrow_option_by_name(
	160	bt_field_class field_class, const char name);
	161
	162	extern bt_field_class *bt_field_class_variant_option_borrow_field_class(
	163	bt_field_class_variant_option *option);
	164
	165	#ifdef __cplusplus
	166	}
	167	#endif
	168
	169	#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */