include/babeltrace/types.h

   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 /** @} */
  80
  81 #ifdef __cplusplus
  82 }
  83 #endif
  84
  85 #endif /* BABELTRACE_TYPES_H */