include/babeltrace2/version.h

   1 #ifndef BABELTRACE2_VERSION_H
   2 #define BABELTRACE2_VERSION_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 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /*!
  35 @defgroup api-version Library version
  36
  37 @brief
  38     Library version getters.
  39
  40 This module contains four functions to information about the library's
  41 version:
  42
  43 <dl>
  44   <dt>Major version</dt>
  45   <dd>bt_version_get_major()</dd>
  46
  47   <dt>Minor version</dt>
  48   <dd>bt_version_get_minor()</dd>
  49
  50   <dt>Patch version</dt>
  51   <dd>bt_version_get_patch()</dd>
  52
  53   <dt>\bt_dt_opt Development stage</dt>
  54   <dd>bt_version_get_development_stage()</dd>
  55
  56   <dt>\bt_dt_opt Version control system revision's description</dt>
  57   <dd>bt_version_get_vcs_revision_description()</dd>
  58
  59   <dt>\bt_dt_opt Release name</dt>
  60   <dd>bt_version_get_name()</dd>
  61
  62   <dt>\bt_dt_opt Release name's description</dt>
  63   <dd>bt_version_get_name_description()</dd>
  64 </dl>
  65 */
  66
  67 /*! @{ */
  68
  69 /*!
  70 @brief
  71     Returns the major version of libbabeltrace2.
  72
  73 @returns
  74     Major version of the library.
  75 */
  76 extern unsigned int bt_version_get_major(void);
  77
  78 /*!
  79 @brief
  80     Returns the minor version of libbabeltrace2.
  81
  82 @returns
  83     Minor version of the library.
  84 */
  85 extern unsigned int bt_version_get_minor(void);
  86
  87 /*!
  88 @brief
  89     Returns the patch version of libbabeltrace2.
  90
  91 @returns
  92     Patch version of the library.
  93 */
  94 extern unsigned int bt_version_get_patch(void);
  95
  96 /*!
  97 @brief
  98     Returns the development stage of libbabeltrace2's version.
  99
 100 The development stage \em can contain a version suffix such as
 101 <code>-pre5</code> or <code>-rc1</code>.
 102
 103 @returns
 104     Development stage of the library's version, or \c NULL if none.
 105 */
 106 extern const char *bt_version_get_development_stage(void);
 107
 108 /*!
 109 @brief
 110     Returns the version control system (VCS) revision's description of
 111     libbabeltrace2's version.
 112
 113 The VCS revision description is only available for a non-release build
 114 of the library.
 115
 116 @returns
 117     Version control system revision's description of the library's
 118     version, or \c NULL if none.
 119 */
 120 extern const char *bt_version_get_vcs_revision_description(void);
 121
 122 /*!
 123 @brief
 124     Returns libbabeltrace2's release name.
 125
 126 If the release name is not available, which can be the case for a
 127 development build, this function returns \c NULL.
 128
 129 @returns
 130     Library's release name, or \c NULL if not available.
 131
 132 @sa bt_version_get_name_description() &mdash;
 133     Returns the description of libbabeltrace2's release name.
 134 */
 135 extern const char *bt_version_get_name(void);
 136
 137 /*!
 138 @brief
 139     Returns libbabeltrace2's release name's description.
 140
 141 If the release name's description is not available, which can be the
 142 case for a development build, this function returns \c NULL.
 143
 144 @returns
 145     Library's release name's description, or \c NULL if not available.
 146
 147 @sa bt_version_get_name() &mdash;
 148     Returns libbabeltrace2's release name.
 149 */
 150 extern const char *bt_version_get_name_description(void);
 151
 152 /*! @} */
 153
 154 #ifdef __cplusplus
 155 }
 156 #endif
 157
 158 #endif /* BABELTRACE2_VERSION_H */