[babeltrace.git] / include / babeltrace / ctf-ir / field-path.h

#ifndef BABELTRACE_CTF_IR_FIELD_PATH
#define BABELTRACE_CTF_IR_FIELD_PATH

/*
 * BabelTrace - CTF IR: Field path
 *
 * Copyright 2016 Philippe Proulx <pproulx@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 <babeltrace/ctf-ir/field-types.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_ctf_field_path;

/*
 * bt_ctf_field_path_get_root_scope: get the root node of a field path.
 *
 * Get the field path's root node.
 *
 * @param field_path Field path.
 *
 * Returns the root node of a field path, or BT_CTF_SCOPE_UNKNOWN on error.
 */
BT_HIDDEN
enum bt_ctf_scope bt_ctf_field_path_get_root_scope(
		const struct bt_ctf_field_path *field_path);

/*
 * bt_ctf_field_path_get_index_count: get the number of indexes of a field path.
 *
 * Get the number of indexes of a field path.
 *
 * @param field_path Field path.
 *
 * Returns the field path's index count, or a negative value on error.
 */
BT_HIDDEN
int bt_ctf_field_path_get_index_count(
		const struct bt_ctf_field_path *field_path);

/*
 * bt_ctf_field_path_get_index: get the field path's index at a specific index.
 *
 * Get the field path's index at a specific index.
 *
 * @param field_path Field path.
 * @param index Index.
 *
 * Returns a field path index, or INT_MIN on error.
 */
BT_HIDDEN
int bt_ctf_field_path_get_index(
		const struct bt_ctf_field_path *field_path,
		int index);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_CTF_IR_FIELD_PATH */
Commit	Line	Data
1c822dfb JG	1	#ifndef BABELTRACE_CTF_IR_FIELD_PATH
	2	#define BABELTRACE_CTF_IR_FIELD_PATH
	3
	4	/*
	5	* BabelTrace - CTF IR: Field path
	6	*
	7	* Copyright 2016 Philippe Proulx <pproulx@efficios.com>
	8	*
	9	* Permission is hereby granted, free of charge, to any person obtaining a copy
	10	* of this software and associated documentation files (the "Software"), to deal
	11	* in the Software without restriction, including without limitation the rights
	12	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	13	* copies of the Software, and to permit persons to whom the Software is
	14	* furnished to do so, subject to the following conditions:
	15	*
	16	* The above copyright notice and this permission notice shall be included in
	17	* all copies or substantial portions of the Software.
	18	*
	19	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	20	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	21	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	22	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	23	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	24	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	25	* SOFTWARE.
	26	*
	27	* The Common Trace Format (CTF) Specification is available at
	28	* http://www.efficios.com/ctf
	29	*/
	30
	31	#include <babeltrace/ctf-ir/field-types.h>
	32
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
	37	struct bt_ctf_field_path;
	38
	39	/*
	40	* bt_ctf_field_path_get_root_scope: get the root node of a field path.
	41	*
	42	* Get the field path's root node.
	43	*
	44	* @param field_path Field path.
	45	*
	46	* Returns the root node of a field path, or BT_CTF_SCOPE_UNKNOWN on error.
	47	*/
6ccf68e9 JG	48	BT_HIDDEN
6ccf68e9 JG	49	enum bt_ctf_scope bt_ctf_field_path_get_root_scope(
1c822dfb JG	50	const struct bt_ctf_field_path *field_path);
	51
	52	/*
	53	* bt_ctf_field_path_get_index_count: get the number of indexes of a field path.
	54	*
	55	* Get the number of indexes of a field path.
	56	*
	57	* @param field_path Field path.
	58	*
	59	* Returns the field path's index count, or a negative value on error.
	60	*/
6ccf68e9 JG	61	BT_HIDDEN
6ccf68e9 JG	62	int bt_ctf_field_path_get_index_count(
1c822dfb JG	63	const struct bt_ctf_field_path *field_path);
	64
	65	/*
	66	* bt_ctf_field_path_get_index: get the field path's index at a specific index.
	67	*
	68	* Get the field path's index at a specific index.
	69	*
	70	* @param field_path Field path.
	71	* @param index Index.
	72	*
	73	* Returns a field path index, or INT_MIN on error.
	74	*/
6ccf68e9 JG	75	BT_HIDDEN
6ccf68e9 JG	76	int bt_ctf_field_path_get_index(
1c822dfb JG	77	const struct bt_ctf_field_path *field_path,
	78	int index);
	79
	80	#ifdef __cplusplus
	81	}
	82	#endif
	83
	84	#endif /* BABELTRACE_CTF_IR_FIELD_PATH */