[babeltrace.git] / include / babeltrace2 / version.h

#ifndef BABELTRACE2_VERSION_H
#define BABELTRACE2_VERSION_H

/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif

#ifdef __cplusplus
extern "C" {
#endif

/*!
@defgroup api-version Library version

@brief
    Library version getters.

This module contains four functions to get the four parts of the
library's version:

<dl>
  <dt>Major version</dt>
  <dd>bt_version_get_major()</dd>

  <dt>Minor version</dt>
  <dd>bt_version_get_minor()</dd>

  <dt>Patch version</dt>
  <dd>bt_version_get_patch()</dd>

  <dt>Extra information</dt>
  <dd>bt_version_get_extra()</dd>
</dl>
*/

/*! @{ */

/*!
@brief
    Returns the major version of libbabeltrace2.

@returns
    Major version of the library.
*/
extern unsigned int bt_version_get_major(void);

/*!
@brief
    Returns the minor version of libbabeltrace2.

@returns
    Minor version of the library.
*/
extern unsigned int bt_version_get_minor(void);

/*!
@brief
    Returns the patch version of libbabeltrace2.

@returns
    Patch version of the library.
*/
extern unsigned int bt_version_get_patch(void);

/*!
@brief
    Returns extra information about the version of libbabeltrace2.

This extra information can contain a version suffix such as
<code>-pre5</code> or <code>-rc1</code>.

@returns
    @parblock
    Extra information about the library's version.

    Cannot be \c NULL.

    Can be an empty string if there's no extra information.
    @endparblock
*/
extern const char *bt_version_get_extra(void);

/*! @} */

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_VERSION_H */
Commit	Line	Data
924dc299 PP	1	#ifndef BABELTRACE2_VERSION_H
924dc299 PP	2	#define BABELTRACE2_VERSION_H
7a6224c4 PP	3
7a6224c4 PP	4	/*
bbb7b5f0	5	* Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
7a6224c4 PP	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
4fa90f32 PP	26	#ifndef __BT_IN_BABELTRACE_H
	27	# error "Please include <babeltrace2/babeltrace.h> instead."
	28	#endif
	29
9d408fca PP	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
43c59509 PP	34	/*!
	35	@defgroup api-version Library version
	36
	37	@brief
	38	Library version getters.
	39
	40	This module contains four functions to get the four parts of the
	41	library's 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>Extra information</dt>
	54	<dd>bt_version_get_extra()</dd>
	55	</dl>
	56	*/
	57
	58	/! @{ /
	59
	60	/*!
	61	@brief
	62	Returns the major version of libbabeltrace2.
	63
	64	@returns
	65	Major version of the library.
	66	*/
78deb913	67	extern unsigned int bt_version_get_major(void);
43c59509 PP	68
	69	/*!
	70	@brief
	71	Returns the minor version of libbabeltrace2.
	72
	73	@returns
	74	Minor version of the library.
	75	*/
78deb913	76	extern unsigned int bt_version_get_minor(void);
43c59509 PP	77
	78	/*!
	79	@brief
	80	Returns the patch version of libbabeltrace2.
	81
	82	@returns
	83	Patch version of the library.
	84	*/
78deb913	85	extern unsigned int bt_version_get_patch(void);
43c59509 PP	86
	87	/*!
	88	@brief
	89	Returns extra information about the version of libbabeltrace2.
	90
	91	This extra information can contain a version suffix such as
	92	<code>-pre5</code> or <code>-rc1</code>.
	93
	94	@returns
	95	@parblock
	96	Extra information about the library's version.
	97
	98	Cannot be \c NULL.
	99
	100	Can be an empty string if there's no extra information.
	101	@endparblock
	102	*/
7a6224c4 PP	103	extern const char *bt_version_get_extra(void);
7a6224c4 PP	104
43c59509 PP	105	/! @} /
43c59509 PP	106
9d408fca PP	107	#ifdef __cplusplus
	108	}
	109	#endif
	110
924dc299	111	#endif /* BABELTRACE2_VERSION_H */