Document libbabeltrace2's C API
[babeltrace.git] / src / lib / trace-ir / field-path.h
CommitLineData
108b91d0
PP
1#ifndef BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL
2#define BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL
b011f6b0
PP
3
4/*
f2b0325d 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
57952005 29#include "lib/object.h"
7704a0af 30#include <babeltrace2/trace-ir/field-path.h>
57952005 31#include "common/assert.h"
85e7137b 32#include "common/macros.h"
b011f6b0
PP
33#include <glib.h>
34
1d4afa5f
PP
35struct bt_field_path_item {
36 enum bt_field_path_item_type type;
37 uint64_t index;
38};
39
839d52a5 40struct bt_field_path {
b011f6b0 41 struct bt_object base;
056995e5 42 enum bt_field_path_scope root;
b011f6b0 43
1d4afa5f
PP
44 /* Array of `struct bt_field_path_item` (items) */
45 GArray *items;
b011f6b0
PP
46};
47
48BT_HIDDEN
839d52a5 49struct bt_field_path *bt_field_path_create(void);
b011f6b0 50
7b33a0e0 51static inline
1d4afa5f 52struct bt_field_path_item *bt_field_path_borrow_item_by_index_inline(
78cf9df6 53 const struct bt_field_path *field_path, uint64_t index)
7b33a0e0 54{
ec4a3354
PP
55 BT_ASSERT_DBG(field_path);
56 BT_ASSERT_DBG(index < field_path->items->len);
1d4afa5f
PP
57 return &g_array_index(field_path->items, struct bt_field_path_item,
58 index);
59}
60
61static inline
62void 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
70static inline
71void 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);
7b33a0e0 76}
b011f6b0 77
1d4afa5f
PP
78static inline
79const 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:
e05f8464 83 return "INDEX";
1d4afa5f 84 case BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT:
e05f8464 85 return "CURRENT_ARRAY_ELEMENT";
1d4afa5f
PP
86 default:
87 return "(unknown)";
88 }
89};
90
108b91d0 91#endif /* BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL */
This page took 0.08089 seconds and 4 git commands to generate.