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

#ifndef BABELTRACE2_TRACE_IR_FIELD_H
#define BABELTRACE2_TRACE_IR_FIELD_H

/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * 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.
 */

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

#include <stdint.h>

#include <babeltrace2/types.h>

#ifdef __cplusplus
extern "C" {
#endif

extern bt_field_class *bt_field_borrow_class(bt_field *field);

extern void bt_field_bool_set_value(bt_field *field, bt_bool value);

extern void bt_field_bit_array_set_value_as_integer(bt_field *field,
		uint64_t value);

extern void bt_field_integer_signed_set_value(bt_field *field,
		int64_t value);

extern void bt_field_integer_unsigned_set_value(bt_field *field,
		uint64_t value);

extern void bt_field_real_set_value(bt_field *field, double value);

typedef enum bt_field_string_set_value_status {
	BT_FIELD_STRING_SET_VALUE_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_FIELD_STRING_SET_VALUE_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_field_string_set_value_status;

extern bt_field_string_set_value_status bt_field_string_set_value(
		bt_field *field, const char *value);

typedef enum bt_field_string_append_status {
	BT_FIELD_STRING_APPEND_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_FIELD_STRING_APPEND_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_field_string_append_status;

extern bt_field_string_append_status bt_field_string_append(
		bt_field *field, const char *value);

extern bt_field_string_append_status bt_field_string_append_with_length(
		bt_field *field, const char *value, uint64_t length);

extern void bt_field_string_clear(bt_field *field);

extern bt_field *bt_field_structure_borrow_member_field_by_index(
		bt_field *field, uint64_t index);

extern bt_field *bt_field_structure_borrow_member_field_by_name(
		bt_field *field, const char *name);

extern bt_field *bt_field_array_borrow_element_field_by_index(
		bt_field *field, uint64_t index);

typedef enum bt_field_array_dynamic_set_length_status {
	BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_field_array_dynamic_set_length_status;

extern bt_field_array_dynamic_set_length_status
bt_field_array_dynamic_set_length(
		bt_field *field, uint64_t length);

extern void bt_field_option_set_has_field(bt_field *field, bt_bool has_field);

extern bt_field *bt_field_option_borrow_field(bt_field *field);

typedef enum bt_field_variant_select_option_field_by_index_status {
	BT_FIELD_VARIANT_SELECT_OPTION_FIELD_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_field_variant_select_option_field_by_index_status;

extern bt_field_variant_select_option_field_by_index_status
bt_field_variant_select_option_field_by_index(
		bt_field *field, uint64_t index);

extern bt_field *bt_field_variant_borrow_selected_option_field(
		bt_field *field);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_TRACE_IR_FIELD_H */
Commit	Line	Data
	1	#ifndef BABELTRACE2_TRACE_IR_FIELD_H
	2	#define BABELTRACE2_TRACE_IR_FIELD_H
	3
	4	/*
	5	* Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
	26	#ifndef __BT_IN_BABELTRACE_H
	27	# error "Please include <babeltrace2/babeltrace.h> instead."
	28	#endif
	29
	30	#include <stdint.h>
	31
	32	#include <babeltrace2/types.h>
	33
	34	#ifdef __cplusplus
	35	extern "C" {
	36	#endif
	37
	38	extern bt_field_class bt_field_borrow_class(bt_field field);
	39
	40	extern void bt_field_bool_set_value(bt_field *field, bt_bool value);
	41
	42	extern void bt_field_bit_array_set_value_as_integer(bt_field *field,
	43	uint64_t value);
	44
	45	extern void bt_field_integer_signed_set_value(bt_field *field,
	46	int64_t value);
	47
	48	extern void bt_field_integer_unsigned_set_value(bt_field *field,
	49	uint64_t value);
	50
	51	extern void bt_field_real_set_value(bt_field *field, double value);
	52
	53	typedef enum bt_field_string_set_value_status {
	54	BT_FIELD_STRING_SET_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	55	BT_FIELD_STRING_SET_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK,
	56	} bt_field_string_set_value_status;
	57
	58	extern bt_field_string_set_value_status bt_field_string_set_value(
	59	bt_field field, const char value);
	60
	61	typedef enum bt_field_string_append_status {
	62	BT_FIELD_STRING_APPEND_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	63	BT_FIELD_STRING_APPEND_STATUS_OK = __BT_FUNC_STATUS_OK,
	64	} bt_field_string_append_status;
	65
	66	extern bt_field_string_append_status bt_field_string_append(
	67	bt_field field, const char value);
	68
	69	extern bt_field_string_append_status bt_field_string_append_with_length(
	70	bt_field field, const char value, uint64_t length);
	71
	72	extern void bt_field_string_clear(bt_field *field);
	73
	74	extern bt_field *bt_field_structure_borrow_member_field_by_index(
	75	bt_field *field, uint64_t index);
	76
	77	extern bt_field *bt_field_structure_borrow_member_field_by_name(
	78	bt_field field, const char name);
	79
	80	extern bt_field *bt_field_array_borrow_element_field_by_index(
	81	bt_field *field, uint64_t index);
	82
	83	typedef enum bt_field_array_dynamic_set_length_status {
	84	BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	85	BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_OK = __BT_FUNC_STATUS_OK,
	86	} bt_field_array_dynamic_set_length_status;
	87
	88	extern bt_field_array_dynamic_set_length_status
	89	bt_field_array_dynamic_set_length(
	90	bt_field *field, uint64_t length);
	91
	92	extern void bt_field_option_set_has_field(bt_field *field, bt_bool has_field);
	93
	94	extern bt_field bt_field_option_borrow_field(bt_field field);
	95
	96	typedef enum bt_field_variant_select_option_field_by_index_status {
	97	BT_FIELD_VARIANT_SELECT_OPTION_FIELD_STATUS_OK = __BT_FUNC_STATUS_OK,
	98	} bt_field_variant_select_option_field_by_index_status;
	99
	100	extern bt_field_variant_select_option_field_by_index_status
	101	bt_field_variant_select_option_field_by_index(
	102	bt_field *field, uint64_t index);
	103
	104	extern bt_field *bt_field_variant_borrow_selected_option_field(
	105	bt_field *field);
	106
	107	#ifdef __cplusplus
	108	}
	109	#endif
	110
	111	#endif /* BABELTRACE2_TRACE_IR_FIELD_H */