Commit | Line | Data |
---|---|---|
3fd40f46 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H |
2 | #define BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H | |
b011f6b0 PP |
3 | |
4 | /* | |
0dcb770f | 5 | * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation |
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. | |
b011f6b0 PP |
24 | */ |
25 | ||
9df34b44 PP |
26 | #ifndef __BT_IN_BABELTRACE_H |
27 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
28 | #endif | |
29 | ||
544d0515 | 30 | #include <stdint.h> |
b011f6b0 | 31 | |
71c5da58 | 32 | #include <babeltrace2/types.h> |
8eee8ea2 | 33 | |
b011f6b0 PP |
34 | #ifdef __cplusplus |
35 | extern "C" { | |
36 | #endif | |
37 | ||
1d4afa5f | 38 | typedef enum bt_field_path_item_type { |
5d2d8d18 PP |
39 | BT_FIELD_PATH_ITEM_TYPE_INDEX = 1 << 0, |
40 | BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT = 1 << 1, | |
41 | BT_FIELD_PATH_ITEM_TYPE_CURRENT_OPTION_CONTENT = 1 << 2, | |
1d4afa5f PP |
42 | } bt_field_path_item_type; |
43 | ||
056995e5 | 44 | typedef enum bt_field_path_scope { |
a0c6c1d7 PP |
45 | BT_FIELD_PATH_SCOPE_PACKET_CONTEXT = 0, |
46 | BT_FIELD_PATH_SCOPE_EVENT_COMMON_CONTEXT = 1, | |
47 | BT_FIELD_PATH_SCOPE_EVENT_SPECIFIC_CONTEXT = 2, | |
48 | BT_FIELD_PATH_SCOPE_EVENT_PAYLOAD = 3, | |
056995e5 PP |
49 | } bt_field_path_scope; |
50 | ||
51 | extern bt_field_path_scope bt_field_path_get_root_scope( | |
8eee8ea2 | 52 | const bt_field_path *field_path); |
269b496c | 53 | |
1d4afa5f | 54 | extern uint64_t bt_field_path_get_item_count( |
8eee8ea2 | 55 | const bt_field_path *field_path); |
b011f6b0 | 56 | |
1d4afa5f | 57 | extern const bt_field_path_item *bt_field_path_borrow_item_by_index_const( |
8eee8ea2 | 58 | const bt_field_path *field_path, uint64_t index); |
269b496c | 59 | |
1d4afa5f PP |
60 | extern bt_field_path_item_type bt_field_path_item_get_type( |
61 | const bt_field_path_item *field_path_item); | |
62 | ||
63 | extern uint64_t bt_field_path_item_index_get_index( | |
64 | const bt_field_path_item *field_path_item); | |
65 | ||
8eee8ea2 | 66 | extern void bt_field_path_get_ref(const bt_field_path *field_path); |
8c6884d9 | 67 | |
8eee8ea2 | 68 | extern void bt_field_path_put_ref(const bt_field_path *field_path); |
8c6884d9 PP |
69 | |
70 | #define BT_FIELD_PATH_PUT_REF_AND_RESET(_var) \ | |
71 | do { \ | |
72 | bt_field_path_put_ref(_var); \ | |
73 | (_var) = NULL; \ | |
74 | } while (0) | |
75 | ||
76 | #define BT_FIELD_PATH_MOVE_REF(_var_dst, _var_src) \ | |
77 | do { \ | |
78 | bt_field_path_put_ref(_var_dst); \ | |
79 | (_var_dst) = (_var_src); \ | |
80 | (_var_src) = NULL; \ | |
81 | } while (0) | |
82 | ||
b011f6b0 PP |
83 | #ifdef __cplusplus |
84 | } | |
85 | #endif | |
86 | ||
3fd40f46 | 87 | #endif /* BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H */ |