lib: make public reference count functions have strict types
[babeltrace.git] / include / babeltrace / trace-ir / field-path-const.h
CommitLineData
40f4ba76
PP
1#ifndef BABELTRACE_TRACE_IR_FIELD_PATH_CONST_H
2#define BABELTRACE_TRACE_IR_FIELD_PATH_CONST_H
b011f6b0
PP
3
4/*
44c440bc 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
544d0515 29#include <stdint.h>
b011f6b0
PP
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
50842bdc 35struct bt_field_path;
b011f6b0 36
44c440bc
PP
37enum bt_scope {
38 BT_SCOPE_PACKET_HEADER,
39 BT_SCOPE_PACKET_CONTEXT,
40 BT_SCOPE_EVENT_HEADER,
41 BT_SCOPE_EVENT_COMMON_CONTEXT,
42 BT_SCOPE_EVENT_SPECIFIC_CONTEXT,
43 BT_SCOPE_EVENT_PAYLOAD,
44};
269b496c 45
50842bdc 46extern enum bt_scope bt_field_path_get_root_scope(
40f4ba76 47 const struct bt_field_path *field_path);
269b496c 48
44c440bc 49extern uint64_t bt_field_path_get_index_count(
40f4ba76 50 const struct bt_field_path *field_path);
b011f6b0 51
44c440bc 52extern uint64_t bt_field_path_get_index_by_index(
40f4ba76 53 const struct bt_field_path *field_path, uint64_t index);
269b496c 54
c5b9b441
PP
55extern void bt_field_path_get_ref(const struct bt_field_path *field_path);
56
57extern void bt_field_path_put_ref(const struct bt_field_path *field_path);
58
59#define BT_FIELD_PATH_PUT_REF_AND_RESET(_var) \
60 do { \
61 bt_field_path_put_ref(_var); \
62 (_var) = NULL; \
63 } while (0)
64
65#define BT_FIELD_PATH_MOVE_REF(_var_dst, _var_src) \
66 do { \
67 bt_field_path_put_ref(_var_dst); \
68 (_var_dst) = (_var_src); \
69 (_var_src) = NULL; \
70 } while (0)
71
b011f6b0
PP
72#ifdef __cplusplus
73}
74#endif
75
40f4ba76 76#endif /* BABELTRACE_TRACE_IR_FIELD_PATH_CONST_H */
This page took 0.043111 seconds and 4 git commands to generate.