]>
Commit | Line | Data |
---|---|---|
787c4390 | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
787c4390 UH |
3 | * |
4 | * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de> | |
5 | * | |
6 | * This program is free software; you can redistribute it and/or modify | |
7 | * it under the terms of the GNU General Public License as published by | |
8 | * the Free Software Foundation; either version 2 of the License, or | |
9 | * (at your option) any later version. | |
10 | * | |
11 | * This program is distributed in the hope that it will be useful, | |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | * GNU General Public License for more details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program; if not, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
6ec6c43b | 21 | #include <config.h> |
c1aae900 | 22 | #include <libsigrok/libsigrok.h> |
787c4390 | 23 | |
393fb9cb UH |
24 | /** |
25 | * @file | |
26 | * | |
c27e5f1e | 27 | * Version number querying functions, definitions, and macros. |
393fb9cb UH |
28 | */ |
29 | ||
7b870c38 UH |
30 | /** |
31 | * @defgroup grp_versions Versions | |
32 | * | |
c27e5f1e | 33 | * Version number querying functions, definitions, and macros. |
7b870c38 | 34 | * |
9fb5f2df UH |
35 | * This set of API calls returns two different version numbers related |
36 | * to libsigrok. The "package version" is the release version number of the | |
37 | * libsigrok tarball in the usual "major.minor.micro" format, e.g. "0.1.0". | |
38 | * | |
39 | * The "library version" is independent of that; it is the libtool version | |
40 | * number in the "current:revision:age" format, e.g. "2:0:0". | |
41 | * See http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning for details. | |
42 | * | |
43 | * Both version numbers (and/or individual components of them) can be | |
44 | * retrieved via the API calls at runtime, and/or they can be checked at | |
45 | * compile/preprocessor time using the respective macros. | |
46 | * | |
7b870c38 UH |
47 | * @{ |
48 | */ | |
49 | ||
9fb5f2df UH |
50 | /** |
51 | * Get the major libsigrok package version number. | |
52 | * | |
53 | * @return The major package version number. | |
54 | * | |
55 | * @since 0.1.0 | |
56 | */ | |
787c4390 UH |
57 | SR_API int sr_package_version_major_get(void) |
58 | { | |
59 | return SR_PACKAGE_VERSION_MAJOR; | |
60 | } | |
61 | ||
9fb5f2df UH |
62 | /** |
63 | * Get the minor libsigrok package version number. | |
64 | * | |
65 | * @return The minor package version number. | |
66 | * | |
67 | * @since 0.1.0 | |
68 | */ | |
787c4390 UH |
69 | SR_API int sr_package_version_minor_get(void) |
70 | { | |
71 | return SR_PACKAGE_VERSION_MINOR; | |
72 | } | |
73 | ||
9fb5f2df UH |
74 | /** |
75 | * Get the micro libsigrok package version number. | |
76 | * | |
77 | * @return The micro package version number. | |
78 | * | |
79 | * @since 0.1.0 | |
80 | */ | |
787c4390 UH |
81 | SR_API int sr_package_version_micro_get(void) |
82 | { | |
83 | return SR_PACKAGE_VERSION_MICRO; | |
84 | } | |
85 | ||
9fb5f2df UH |
86 | /** |
87 | * Get the libsigrok package version number as a string. | |
88 | * | |
89 | * @return The package version number string. The returned string is | |
90 | * static and thus should NOT be free'd by the caller. | |
91 | * | |
92 | * @since 0.1.0 | |
93 | */ | |
787c4390 UH |
94 | SR_API const char *sr_package_version_string_get(void) |
95 | { | |
96 | return SR_PACKAGE_VERSION_STRING; | |
97 | } | |
98 | ||
9fb5f2df UH |
99 | /** |
100 | * Get the "current" part of the libsigrok library version number. | |
101 | * | |
102 | * @return The "current" library version number. | |
103 | * | |
104 | * @since 0.1.0 | |
105 | */ | |
787c4390 UH |
106 | SR_API int sr_lib_version_current_get(void) |
107 | { | |
108 | return SR_LIB_VERSION_CURRENT; | |
109 | } | |
110 | ||
9fb5f2df UH |
111 | /** |
112 | * Get the "revision" part of the libsigrok library version number. | |
113 | * | |
114 | * @return The "revision" library version number. | |
115 | * | |
116 | * @since 0.1.0 | |
117 | */ | |
787c4390 UH |
118 | SR_API int sr_lib_version_revision_get(void) |
119 | { | |
120 | return SR_LIB_VERSION_REVISION; | |
121 | } | |
122 | ||
9fb5f2df UH |
123 | /** |
124 | * Get the "age" part of the libsigrok library version number. | |
125 | * | |
126 | * @return The "age" library version number. | |
127 | * | |
128 | * @since 0.1.0 | |
129 | */ | |
787c4390 UH |
130 | SR_API int sr_lib_version_age_get(void) |
131 | { | |
132 | return SR_LIB_VERSION_AGE; | |
133 | } | |
134 | ||
9fb5f2df UH |
135 | /** |
136 | * Get the libsigrok library version number as a string. | |
137 | * | |
138 | * @return The library version number string. The returned string is | |
139 | * static and thus should NOT be free'd by the caller. | |
140 | * | |
141 | * @since 0.1.0 | |
142 | */ | |
787c4390 UH |
143 | SR_API const char *sr_lib_version_string_get(void) |
144 | { | |
145 | return SR_LIB_VERSION_STRING; | |
146 | } | |
7b870c38 UH |
147 | |
148 | /** @} */ |