[babeltrace.git] / src / lib / trace-ir / field-path.h

#ifndef BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL
#define BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL

/*
 * Copyright 2016-2018 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 "lib/object.h"
#include <babeltrace2/trace-ir/field-path.h>
#include "common/assert.h"
#include "common/macros.h"
#include <glib.h>

struct bt_field_path_item {
	enum bt_field_path_item_type type;
	uint64_t index;
};

struct bt_field_path {
	struct bt_object base;
	enum bt_field_path_scope root;

	/* Array of `struct bt_field_path_item` (items) */
	GArray *items;
};

BT_HIDDEN
struct bt_field_path *bt_field_path_create(void);

static inline
struct bt_field_path_item *bt_field_path_borrow_item_by_index_inline(
		const struct bt_field_path *field_path, uint64_t index)
{
	BT_ASSERT_DBG(field_path);
	BT_ASSERT_DBG(index < field_path->items->len);
	return &g_array_index(field_path->items, struct bt_field_path_item,
		index);
}

static inline
void bt_field_path_append_item(struct bt_field_path *field_path,
		struct bt_field_path_item *item)
{
	BT_ASSERT(field_path);
	BT_ASSERT(item);
	g_array_append_val(field_path->items, *item);
}

static inline
void bt_field_path_remove_last_item(struct bt_field_path *field_path)
{
	BT_ASSERT(field_path);
	BT_ASSERT(field_path->items->len > 0);
	g_array_set_size(field_path->items, field_path->items->len - 1);
}

static inline
const char *bt_field_path_item_type_string(enum bt_field_path_item_type type)
{
	switch (type) {
	case BT_FIELD_PATH_ITEM_TYPE_INDEX:
		return "INDEX";
	case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
		return "CURRENT_ARRAY_ELEMENT";
	default:
		return "(unknown)";
	}
};

#endif /* BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL */
Commit	Line	Data
56e18c4c PP	1	#ifndef BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL
56e18c4c PP	2	#define BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL
b011f6b0 PP	3
b011f6b0 PP	4	/*
e2f7325d	5	* Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
b011f6b0 PP	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	* The Common Trace Format (CTF) Specification is available at
	26	* http://www.efficios.com/ctf
	27	*/
	28
578e048b	29	#include "lib/object.h"
43c59509	30	#include <babeltrace2/trace-ir/field-path.h>
578e048b	31	#include "common/assert.h"
91d81473	32	#include "common/macros.h"
b011f6b0 PP	33	#include <glib.h>
b011f6b0 PP	34
66ddcddf PP	35	struct bt_field_path_item {
	36	enum bt_field_path_item_type type;
	37	uint64_t index;
	38	};
	39
50842bdc	40	struct bt_field_path {
b011f6b0	41	struct bt_object base;
e7ceb9df	42	enum bt_field_path_scope root;
b011f6b0	43
66ddcddf PP	44	/* Array of `struct bt_field_path_item` (items) */
66ddcddf PP	45	GArray *items;
b011f6b0 PP	46	};
	47
	48	BT_HIDDEN
50842bdc	49	struct bt_field_path *bt_field_path_create(void);
b011f6b0	50
44c440bc	51	static inline
66ddcddf	52	struct bt_field_path_item *bt_field_path_borrow_item_by_index_inline(
40f4ba76	53	const struct bt_field_path *field_path, uint64_t index)
44c440bc	54	{
98b15851 PP	55	BT_ASSERT_DBG(field_path);
98b15851 PP	56	BT_ASSERT_DBG(index < field_path->items->len);
66ddcddf PP	57	return &g_array_index(field_path->items, struct bt_field_path_item,
	58	index);
	59	}
	60
	61	static inline
	62	void bt_field_path_append_item(struct bt_field_path *field_path,
	63	struct bt_field_path_item *item)
	64	{
	65	BT_ASSERT(field_path);
	66	BT_ASSERT(item);
	67	g_array_append_val(field_path->items, *item);
	68	}
	69
	70	static inline
	71	void bt_field_path_remove_last_item(struct bt_field_path *field_path)
	72	{
	73	BT_ASSERT(field_path);
	74	BT_ASSERT(field_path->items->len > 0);
	75	g_array_set_size(field_path->items, field_path->items->len - 1);
44c440bc	76	}
b011f6b0	77
66ddcddf PP	78	static inline
	79	const char *bt_field_path_item_type_string(enum bt_field_path_item_type type)
	80	{
	81	switch (type) {
	82	case BT_FIELD_PATH_ITEM_TYPE_INDEX:
8a432889	83	return "INDEX";
66ddcddf	84	case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
8a432889	85	return "CURRENT_ARRAY_ELEMENT";
66ddcddf PP	86	default:
	87	return "(unknown)";
	88	}
	89	};
	90
56e18c4c	91	#endif /* BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL */