Make API CTF-agnostic

[babeltrace.git] / include / babeltrace / ctf-ir / fields.h

#ifndef BABELTRACE_CTF_IR_FIELDS_H
#define BABELTRACE_CTF_IR_FIELDS_H

/*
 * Babeltrace - CTF IR: Event Fields
 *
 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: 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
 */

#include <stdint.h>

/* For bt_bool */
#include <babeltrace/types.h>

/* For enum bt_field_type_id */
#include <babeltrace/ctf-ir/field-types.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_field;
struct bt_field_type;
struct bt_field_type_enumeration_mapping_iterator;

extern struct bt_field_type *bt_field_borrow_type(struct bt_field *field);

extern enum bt_field_type_id bt_field_get_type_id(struct bt_field *field);

extern int64_t bt_field_signed_integer_get_value(struct bt_field *field);

extern void bt_field_signed_integer_set_value(struct bt_field *field,
		int64_t value);

extern uint64_t bt_field_unsigned_integer_get_value(struct bt_field *field);

extern void bt_field_unsigned_integer_set_value(struct bt_field *field,
		uint64_t value);

extern double bt_field_real_get_value(struct bt_field *field);

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

extern int bt_field_unsigned_enumeration_get_mapping_labels(
		struct bt_field *field,
		bt_field_type_enumeration_mapping_label_array *label_array,
		uint64_t *count);

extern int bt_field_signed_enumeration_get_mapping_labels(
		struct bt_field *field,
		bt_field_type_enumeration_mapping_label_array *label_array,
		uint64_t *count);

extern const char *bt_field_string_get_value(struct bt_field *field);

extern uint64_t bt_field_string_get_length(struct bt_field *field);

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

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

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

extern int bt_field_string_clear(struct bt_field *field);

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

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

extern uint64_t bt_field_array_get_length(struct bt_field *field);

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

extern int bt_field_dynamic_array_set_length(struct bt_field *field,
		uint64_t length);

extern int bt_field_variant_select_option_field(struct bt_field *field,
		uint64_t index);

extern uint64_t bt_field_variant_get_selected_option_field_index(
		struct bt_field *field);

extern struct bt_field *bt_field_variant_borrow_selected_option_field(
		struct bt_field *field);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_CTF_IR_FIELDS_H */