| 1 | /* |
| 2 | * The MIT License (MIT) |
| 3 | * |
| 4 | * Copyright (c) 2018 Francis Deslauriers <francis.deslauriers@efficios.com> |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to deal |
| 8 | * in the Software without restriction, including without limitation the rights |
| 9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | * copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in |
| 14 | * all copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 22 | * THE SOFTWARE. |
| 23 | */ |
| 24 | |
| 25 | /* From field-path-const.h */ |
| 26 | |
| 27 | typedef enum bt_field_path_item_type { |
| 28 | BT_FIELD_PATH_ITEM_TYPE_INDEX, |
| 29 | BT_FIELD_PATH_ITEM_TYPE_CURRENT_ARRAY_ELEMENT, |
| 30 | } bt_field_path_item_type; |
| 31 | |
| 32 | typedef enum bt_scope { |
| 33 | BT_SCOPE_PACKET_CONTEXT, |
| 34 | BT_SCOPE_EVENT_COMMON_CONTEXT, |
| 35 | BT_SCOPE_EVENT_SPECIFIC_CONTEXT, |
| 36 | BT_SCOPE_EVENT_PAYLOAD, |
| 37 | } bt_scope; |
| 38 | |
| 39 | extern bt_scope bt_field_path_get_root_scope( |
| 40 | const bt_field_path *field_path); |
| 41 | |
| 42 | extern uint64_t bt_field_path_get_item_count( |
| 43 | const bt_field_path *field_path); |
| 44 | |
| 45 | extern const bt_field_path_item *bt_field_path_borrow_item_by_index_const( |
| 46 | const bt_field_path *field_path, uint64_t index); |
| 47 | |
| 48 | extern bt_field_path_item_type bt_field_path_item_get_type( |
| 49 | const bt_field_path_item *field_path_item); |
| 50 | |
| 51 | extern uint64_t bt_field_path_item_index_get_index( |
| 52 | const bt_field_path_item *field_path_item); |
| 53 | |
| 54 | extern void bt_field_path_get_ref(const bt_field_path *field_path); |
| 55 | |
| 56 | extern void bt_field_path_put_ref(const bt_field_path *field_path); |