| 1 | #ifndef BABELTRACE_TYPES_H |
| 2 | #define BABELTRACE_TYPES_H |
| 3 | |
| 4 | /* |
| 5 | * Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com> |
| 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 | #include <stdint.h> |
| 27 | |
| 28 | #ifdef __cplusplus |
| 29 | extern "C" { |
| 30 | #endif |
| 31 | |
| 32 | /** |
| 33 | @defgroup ctypes Babeltrace C types |
| 34 | @ingroup apiref |
| 35 | @brief Babeltrace C types. |
| 36 | |
| 37 | @code |
| 38 | #include <babeltrace/types.h> |
| 39 | @endcode |
| 40 | |
| 41 | This header contains custom type definitions used across the library. |
| 42 | |
| 43 | @file |
| 44 | @brief Babeltrace C types. |
| 45 | @sa ctypes |
| 46 | |
| 47 | @addtogroup ctypes |
| 48 | @{ |
| 49 | */ |
| 50 | |
| 51 | /// False boolean value for the #bt_bool type. |
| 52 | #define BT_FALSE 0 |
| 53 | |
| 54 | /// True boolean value for the #bt_bool type. |
| 55 | #define BT_TRUE 1 |
| 56 | |
| 57 | /** |
| 58 | @brief Babeltrace's boolean type. |
| 59 | |
| 60 | Use only the #BT_FALSE and #BT_TRUE definitions for #bt_bool parameters. |
| 61 | It is guaranteed that the library functions which return a #bt_bool |
| 62 | value return either #BT_FALSE or #BT_TRUE. |
| 63 | |
| 64 | You can always test the truthness of a #bt_bool value directly, without |
| 65 | comparing it to #BT_TRUE directly: |
| 66 | |
| 67 | @code |
| 68 | bt_bool ret = bt_some_function(...); |
| 69 | |
| 70 | if (ret) { |
| 71 | // ret is true |
| 72 | } |
| 73 | @endcode |
| 74 | */ |
| 75 | typedef int bt_bool; |
| 76 | |
| 77 | typedef const uint8_t *bt_uuid; |
| 78 | |
| 79 | typedef struct bt_clock_class bt_clock_class; |
| 80 | typedef struct bt_clock_snapshot bt_clock_snapshot; |
| 81 | typedef struct bt_component bt_component; |
| 82 | typedef struct bt_component_class bt_component_class; |
| 83 | typedef struct bt_component_class_filter bt_component_class_filter; |
| 84 | typedef struct bt_component_class_sink bt_component_class_sink; |
| 85 | typedef struct bt_component_class_source bt_component_class_source; |
| 86 | typedef struct bt_component_filter bt_component_filter; |
| 87 | typedef struct bt_component_graph bt_component_graph; |
| 88 | typedef struct bt_component_sink bt_component_sink; |
| 89 | typedef struct bt_component_source bt_component_source; |
| 90 | typedef struct bt_connection bt_connection; |
| 91 | typedef struct bt_event bt_event; |
| 92 | typedef struct bt_event_class bt_event_class; |
| 93 | typedef struct bt_event_header_field bt_event_header_field; |
| 94 | typedef struct bt_field bt_field; |
| 95 | typedef struct bt_field_class bt_field_class; |
| 96 | typedef struct bt_field_class_signed_enumeration_mapping_ranges bt_field_class_signed_enumeration_mapping_ranges; |
| 97 | typedef struct bt_field_class_unsigned_enumeration_mapping_ranges bt_field_class_unsigned_enumeration_mapping_ranges; |
| 98 | typedef struct bt_field_path bt_field_path; |
| 99 | typedef struct bt_graph bt_graph; |
| 100 | typedef struct bt_message bt_message; |
| 101 | typedef struct bt_message_iterator bt_message_iterator; |
| 102 | typedef struct bt_object bt_object; |
| 103 | typedef struct bt_packet bt_packet; |
| 104 | typedef struct bt_packet_context_field bt_packet_context_field; |
| 105 | typedef struct bt_packet_header_field bt_packet_header_field; |
| 106 | typedef struct bt_plugin bt_plugin; |
| 107 | typedef struct bt_plugin_set bt_plugin_set; |
| 108 | typedef struct bt_plugin_so_shared_lib_handle bt_plugin_so_shared_lib_handle; |
| 109 | typedef struct bt_port bt_port; |
| 110 | typedef struct bt_port_input bt_port_input; |
| 111 | typedef struct bt_port_output bt_port_output; |
| 112 | typedef struct bt_port_output_message_iterator bt_port_output_message_iterator; |
| 113 | typedef struct bt_query_executor bt_query_executor; |
| 114 | typedef struct bt_self_component bt_self_component; |
| 115 | typedef struct bt_self_component_class_filter bt_self_component_class_filter; |
| 116 | typedef struct bt_self_component_class_sink bt_self_component_class_sink; |
| 117 | typedef struct bt_self_component_class_source bt_self_component_class_source; |
| 118 | typedef struct bt_self_component_filter bt_self_component_filter; |
| 119 | typedef struct bt_self_component_port bt_self_component_port; |
| 120 | typedef struct bt_self_component_port_input bt_self_component_port_input; |
| 121 | typedef struct bt_self_component_port_input_message_iterator bt_self_component_port_input_message_iterator; |
| 122 | typedef struct bt_self_component_port_output bt_self_component_port_output; |
| 123 | typedef struct bt_self_component_sink bt_self_component_sink; |
| 124 | typedef struct bt_self_component_source bt_self_component_source; |
| 125 | typedef struct bt_self_message_iterator bt_self_message_iterator; |
| 126 | typedef struct bt_self_port bt_self_port; |
| 127 | typedef struct bt_self_port_input bt_self_port_input; |
| 128 | typedef struct bt_self_port_output bt_self_port_output; |
| 129 | typedef struct bt_stream bt_stream; |
| 130 | typedef struct bt_stream_class bt_stream_class; |
| 131 | typedef struct bt_trace bt_trace; |
| 132 | typedef struct bt_trace_class bt_trace_class; |
| 133 | typedef struct bt_value bt_value; |
| 134 | |
| 135 | typedef const char * const *bt_field_class_enumeration_mapping_label_array; |
| 136 | typedef const struct bt_message **bt_message_array_const; |
| 137 | |
| 138 | /** @} */ |
| 139 | |
| 140 | #ifdef __cplusplus |
| 141 | } |
| 142 | #endif |
| 143 | |
| 144 | #endif /* BABELTRACE_TYPES_H */ |