File: version.c

package info (click to toggle)
libsigrok 0.3.0-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd, sid, stretch
  • size: 4,220 kB
  • ctags: 4,609
  • sloc: ansic: 40,159; sh: 11,626; makefile: 324
file content (147 lines) | stat: -rw-r--r-- 3,653 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include "libsigrok.h"

/**
 * @file
 *
 * Version number querying functions, definitions, and macros.
 */

/**
 * @defgroup grp_versions Versions
 *
 * Version number querying functions, definitions, and macros.
 *
 * This set of API calls returns two different version numbers related
 * to libsigrok. The "package version" is the release version number of the
 * libsigrok tarball in the usual "major.minor.micro" format, e.g. "0.1.0".
 *
 * The "library version" is independent of that; it is the libtool version
 * number in the "current:revision:age" format, e.g. "2:0:0".
 * See http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning for details.
 *
 * Both version numbers (and/or individual components of them) can be
 * retrieved via the API calls at runtime, and/or they can be checked at
 * compile/preprocessor time using the respective macros.
 *
 * @{
 */

/**
 * Get the major libsigrok package version number.
 *
 * @return The major package version number.
 *
 * @since 0.1.0
 */
SR_API int sr_package_version_major_get(void)
{
	return SR_PACKAGE_VERSION_MAJOR;
}

/**
 * Get the minor libsigrok package version number.
 *
 * @return The minor package version number.
 *
 * @since 0.1.0
 */
SR_API int sr_package_version_minor_get(void)
{
	return SR_PACKAGE_VERSION_MINOR;
}

/**
 * Get the micro libsigrok package version number.
 *
 * @return The micro package version number.
 *
 * @since 0.1.0
 */
SR_API int sr_package_version_micro_get(void)
{
	return SR_PACKAGE_VERSION_MICRO;
}

/**
 * Get the libsigrok package version number as a string.
 *
 * @return The package version number string. The returned string is
 *         static and thus should NOT be free'd by the caller.
 *
 * @since 0.1.0
 */
SR_API const char *sr_package_version_string_get(void)
{
	return SR_PACKAGE_VERSION_STRING;
}

/**
 * Get the "current" part of the libsigrok library version number.
 *
 * @return The "current" library version number.
 *
 * @since 0.1.0
 */
SR_API int sr_lib_version_current_get(void)
{
	return SR_LIB_VERSION_CURRENT;
}

/**
 * Get the "revision" part of the libsigrok library version number.
 *
 * @return The "revision" library version number.
 *
 * @since 0.1.0
 */
SR_API int sr_lib_version_revision_get(void)
{
	return SR_LIB_VERSION_REVISION;
}

/**
 * Get the "age" part of the libsigrok library version number.
 *
 * @return The "age" library version number.
 *
 * @since 0.1.0
 */
SR_API int sr_lib_version_age_get(void)
{
	return SR_LIB_VERSION_AGE;
}

/**
 * Get the libsigrok library version number as a string.
 *
 * @return The library version number string. The returned string is
 *         static and thus should NOT be free'd by the caller.
 *
 * @since 0.1.0
 */
SR_API const char *sr_lib_version_string_get(void)
{
	return SR_LIB_VERSION_STRING;
}

/** @} */