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