lib: standardize public header copyright notice
[babeltrace.git] / include / babeltrace2 / trace-ir / field-path-const.h
1 #ifndef BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H
2 #define BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H
3
4 /*
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
28 #endif
29
30 #include <stdint.h>
31
32 #include <babeltrace2/types.h>
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
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
43 typedef enum bt_scope {
44 BT_SCOPE_PACKET_CONTEXT,
45 BT_SCOPE_EVENT_COMMON_CONTEXT,
46 BT_SCOPE_EVENT_SPECIFIC_CONTEXT,
47 BT_SCOPE_EVENT_PAYLOAD,
48 } bt_scope;
49
50 extern bt_scope bt_field_path_get_root_scope(
51 const bt_field_path *field_path);
52
53 extern uint64_t bt_field_path_get_item_count(
54 const bt_field_path *field_path);
55
56 extern const bt_field_path_item *bt_field_path_borrow_item_by_index_const(
57 const bt_field_path *field_path, uint64_t index);
58
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
65 extern void bt_field_path_get_ref(const bt_field_path *field_path);
66
67 extern void bt_field_path_put_ref(const bt_field_path *field_path);
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
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif /* BABELTRACE2_TRACE_IR_FIELD_PATH_CONST_H */
This page took 0.035759 seconds and 4 git commands to generate.