lib: fully detach CTF IR and CTF writer implementations
[babeltrace.git] / include / babeltrace / ctf-writer / field-path-internal.h
CommitLineData
16ca5ff0
PP
1#ifndef BABELTRACE_CTF_WRITER_FIELD_PATH_INTERNAL
2#define BABELTRACE_CTF_WRITER_FIELD_PATH_INTERNAL
3
4/*
5 * BabelTrace - CTF writer: 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/common-internal.h>
32#include <babeltrace/object-internal.h>
33#include <babeltrace/assert-internal.h>
34#include <babeltrace/ctf-writer/field-types.h>
35#include <glib.h>
36
37struct bt_ctf_field_path {
38 struct bt_object base;
39 enum bt_ctf_scope root;
40
41 /*
42 * Array of integers (int) indicating the index in either
43 * structures, variants, arrays, or sequences that make up
44 * the path to a field type. -1 means the "current element
45 * of an array or sequence type".
46 */
47 GArray *indexes;
48};
49
50BT_HIDDEN
51struct bt_ctf_field_path *bt_ctf_field_path_create(void);
52
53BT_HIDDEN
54void bt_ctf_field_path_clear(struct bt_ctf_field_path *field_path);
55
56BT_HIDDEN
57struct bt_ctf_field_path *bt_ctf_field_path_copy(
58 struct bt_ctf_field_path *path);
59
60BT_HIDDEN enum bt_ctf_scope bt_ctf_field_path_get_root_scope(
61 const struct bt_ctf_field_path *field_path);
62
63BT_HIDDEN int64_t bt_ctf_field_path_get_index_count(
64 const struct bt_ctf_field_path *field_path);
65
66BT_HIDDEN int bt_ctf_field_path_get_index(
67 const struct bt_ctf_field_path *field_path, uint64_t index);
68
69#endif /* BABELTRACE_CTF_WRITER_FIELD_PATH_INTERNAL */
This page took 0.02808 seconds and 4 git commands to generate.