lib: rename "begin" to "beginning" when used as a noun
[babeltrace.git] / include / babeltrace / trace-ir / field-path-internal.h
CommitLineData
56e18c4c
PP
1#ifndef BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL
2#define BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL
b011f6b0
PP
3
4/*
b011f6b0
PP
5 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
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
29#include <babeltrace/object-internal.h>
40f4ba76 30#include <babeltrace/trace-ir/field-path-const.h>
f6ccaed9 31#include <babeltrace/assert-internal.h>
b011f6b0
PP
32#include <glib.h>
33
50842bdc 34struct bt_field_path {
b011f6b0 35 struct bt_object base;
50842bdc 36 enum bt_scope root;
b011f6b0 37
44c440bc 38 /* Array of `uint64_t` (indexes) */
b011f6b0
PP
39 GArray *indexes;
40};
41
42BT_HIDDEN
50842bdc 43struct bt_field_path *bt_field_path_create(void);
b011f6b0 44
44c440bc
PP
45static inline
46uint64_t bt_field_path_get_index_by_index_inline(
40f4ba76 47 const struct bt_field_path *field_path, uint64_t index)
44c440bc
PP
48{
49 BT_ASSERT(field_path);
50 BT_ASSERT(index < field_path->indexes->len);
51 return g_array_index(field_path->indexes, uint64_t, index);
52}
b011f6b0 53
56e18c4c 54#endif /* BABELTRACE_TRACE_IR_FIELD_PATH_INTERNAL */
This page took 0.043287 seconds and 4 git commands to generate.