Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H |
2 | #define BABELTRACE2_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 | ||
4fa90f32 PP |
29 | #ifndef __BT_IN_BABELTRACE_H |
30 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
31 | #endif | |
32 | ||
544d0515 | 33 | #include <stdint.h> |
b011f6b0 | 34 | |
3fadfbc0 | 35 | #include <babeltrace2/types.h> |
b19ff26f | 36 | |
b011f6b0 PP |
37 | #ifdef __cplusplus |
38 | extern "C" { | |
39 | #endif | |
40 | ||
66ddcddf PP |
41 | typedef enum bt_field_path_item_type { |
42 | BT_FIELD_PATH_ITEM_TYPE_INDEX, | |
43 | BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT, | |
44 | } bt_field_path_item_type; | |
45 | ||
4cdfc5e8 | 46 | typedef enum bt_scope { |
44c440bc | 47 | BT_SCOPE_PACKET_CONTEXT, |
44c440bc PP |
48 | BT_SCOPE_EVENT_COMMON_CONTEXT, |
49 | BT_SCOPE_EVENT_SPECIFIC_CONTEXT, | |
50 | BT_SCOPE_EVENT_PAYLOAD, | |
4cdfc5e8 | 51 | } bt_scope; |
269b496c | 52 | |
4cdfc5e8 | 53 | extern bt_scope bt_field_path_get_root_scope( |
b19ff26f | 54 | const bt_field_path *field_path); |
269b496c | 55 | |
66ddcddf | 56 | extern uint64_t bt_field_path_get_item_count( |
b19ff26f | 57 | const bt_field_path *field_path); |
b011f6b0 | 58 | |
66ddcddf | 59 | extern const bt_field_path_item *bt_field_path_borrow_item_by_index_const( |
b19ff26f | 60 | const bt_field_path *field_path, uint64_t index); |
269b496c | 61 | |
66ddcddf PP |
62 | extern bt_field_path_item_type bt_field_path_item_get_type( |
63 | const bt_field_path_item *field_path_item); | |
64 | ||
65 | extern uint64_t bt_field_path_item_index_get_index( | |
66 | const bt_field_path_item *field_path_item); | |
67 | ||
b19ff26f | 68 | extern void bt_field_path_get_ref(const bt_field_path *field_path); |
c5b9b441 | 69 | |
b19ff26f | 70 | extern void bt_field_path_put_ref(const bt_field_path *field_path); |
c5b9b441 PP |
71 | |
72 | #define BT_FIELD_PATH_PUT_REF_AND_RESET(_var) \ | |
73 | do { \ | |
74 | bt_field_path_put_ref(_var); \ | |
75 | (_var) = NULL; \ | |
76 | } while (0) | |
77 | ||
78 | #define BT_FIELD_PATH_MOVE_REF(_var_dst, _var_src) \ | |
79 | do { \ | |
80 | bt_field_path_put_ref(_var_dst); \ | |
81 | (_var_dst) = (_var_src); \ | |
82 | (_var_src) = NULL; \ | |
83 | } while (0) | |
84 | ||
b011f6b0 PP |
85 | #ifdef __cplusplus |
86 | } | |
87 | #endif | |
88 | ||
924dc299 | 89 | #endif /* BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H */ |