Split CTF IR and CTF writer APIs and implementations
[babeltrace.git] / include / babeltrace / ctf-ir / field-path-internal.h
CommitLineData
b011f6b0
PP
1#ifndef BABELTRACE_CTF_IR_FIELD_PATH_INTERNAL
2#define BABELTRACE_CTF_IR_FIELD_PATH_INTERNAL
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
3dca2276 31#include <babeltrace/common-internal.h>
b011f6b0 32#include <babeltrace/object-internal.h>
f6ccaed9 33#include <babeltrace/assert-internal.h>
b011f6b0
PP
34#include <glib.h>
35
50842bdc 36struct bt_field_path {
b011f6b0 37 struct bt_object base;
50842bdc 38 enum bt_scope root;
b011f6b0
PP
39
40 /*
41 * Array of integers (int) indicating the index in either
42 * structures, variants, arrays, or sequences that make up
43 * the path to a field type. -1 means the "current element
44 * of an array or sequence type".
45 */
46 GArray *indexes;
47};
48
49BT_HIDDEN
50842bdc 50struct bt_field_path *bt_field_path_create(void);
b011f6b0
PP
51
52BT_HIDDEN
50842bdc 53void bt_field_path_clear(struct bt_field_path *field_path);
b011f6b0
PP
54
55BT_HIDDEN
50842bdc
PP
56struct bt_field_path *bt_field_path_copy(
57 struct bt_field_path *path);
b011f6b0
PP
58
59#endif /* BABELTRACE_CTF_IR_FIELD_PATH_INTERNAL */
This page took 0.04396 seconds and 4 git commands to generate.