1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
4 *******************************************************************************
5 * Copyright (C) 2000-2011, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 *******************************************************************************
9 * file name: uversion.h
11 * tab size: 8 (not used)
14 * Created by: Vladimir Weinstein
16 * Gets included by utypes.h and Windows .rc files
21 * \brief C API: API for accessing ICU version numbers.
23 /*===========================================================================*/
24 /* Main ICU version information */
25 /*===========================================================================*/
30 #include "unicode/umachine.h"
32 /* Actual version info lives in uvernum.h */
33 #include "unicode/uvernum.h"
35 /** Maximum length of the copyright string.
38 #define U_COPYRIGHT_STRING_LENGTH 128
40 /** An ICU version consists of up to 4 numbers from 0..255.
43 #define U_MAX_VERSION_LENGTH 4
45 /** In a string, ICU version fields are delimited by dots.
48 #define U_VERSION_DELIMITER '.'
50 /** The maximum length of an ICU version string.
53 #define U_MAX_VERSION_STRING_LENGTH 20
55 /** The binary form of a version on ICU APIs is an array of 4 uint8_t.
56 * To compare two versions, use memcmp(v1,v2,sizeof(UVersionInfo)).
59 typedef uint8_t UVersionInfo[U_MAX_VERSION_LENGTH];
61 /*===========================================================================*/
62 /* C++ namespace if supported. Versioned unless versioning is disabled. */
63 /*===========================================================================*/
66 * \def U_NAMESPACE_BEGIN
67 * This is used to begin a declaration of a public ICU C++ API.
68 * When not compiling for C++, it does nothing.
69 * When compiling for C++, it begins an extern "C++" linkage block (to protect
70 * against cases in which an external client includes ICU header files inside
71 * an extern "C" linkage block).
73 * It also begins a versioned-ICU-namespace block.
78 * \def U_NAMESPACE_END
79 * This is used to end a declaration of a public ICU C++ API.
80 * When not compiling for C++, it does nothing.
81 * When compiling for C++, it ends the extern "C++" block begun by
84 * It also ends the versioned-ICU-namespace block begun by U_NAMESPACE_BEGIN.
89 * \def U_NAMESPACE_USE
90 * This is used to specify that the rest of the code uses the
91 * public ICU C++ API namespace.
92 * This is invoked by default; we recommend that you turn it off:
93 * See the "Recommended Build Options" section of the ICU4C readme
94 * (http://source.icu-project.org/repos/icu/icu/trunk/readme.html#RecBuild)
99 * \def U_NAMESPACE_QUALIFIER
100 * This is used to qualify that a function or class is part of
101 * the public ICU C++ API namespace.
103 * This macro is unnecessary since ICU 49 requires namespace support.
104 * You can just use "icu::" instead.
108 /* Define namespace symbols if the compiler supports it. */
110 # if U_DISABLE_RENAMING
111 # define U_ICU_NAMESPACE icu
112 namespace U_ICU_NAMESPACE { }
114 # define U_ICU_NAMESPACE U_ICU_ENTRY_POINT_RENAME(icu)
115 namespace U_ICU_NAMESPACE { }
116 namespace icu = U_ICU_NAMESPACE;
119 # define U_NAMESPACE_BEGIN extern "C++" { namespace U_ICU_NAMESPACE {
120 # define U_NAMESPACE_END } }
121 # define U_NAMESPACE_USE using namespace U_ICU_NAMESPACE;
122 # define U_NAMESPACE_QUALIFIER U_ICU_NAMESPACE::
124 # ifndef U_USING_ICU_NAMESPACE
125 # define U_USING_ICU_NAMESPACE 1
127 # if U_USING_ICU_NAMESPACE
131 # define U_NAMESPACE_BEGIN
132 # define U_NAMESPACE_END
133 # define U_NAMESPACE_USE
134 # define U_NAMESPACE_QUALIFIER
137 /*===========================================================================*/
138 /* General version helper functions. Definitions in putil.c */
139 /*===========================================================================*/
142 * Parse a string with dotted-decimal version information and
143 * fill in a UVersionInfo structure with the result.
144 * Definition of this function lives in putil.c
146 * @param versionArray The destination structure for the version information.
147 * @param versionString A string with dotted-decimal version information,
148 * with up to four non-negative number fields with
149 * values of up to 255 each.
152 U_STABLE void U_EXPORT2
153 u_versionFromString(UVersionInfo versionArray, const char *versionString);
156 * Parse a Unicode string with dotted-decimal version information and
157 * fill in a UVersionInfo structure with the result.
158 * Definition of this function lives in putil.c
160 * @param versionArray The destination structure for the version information.
161 * @param versionString A Unicode string with dotted-decimal version
162 * information, with up to four non-negative number
163 * fields with values of up to 255 each.
166 U_STABLE void U_EXPORT2
167 u_versionFromUString(UVersionInfo versionArray, const UChar *versionString);
171 * Write a string with dotted-decimal version information according
172 * to the input UVersionInfo.
173 * Definition of this function lives in putil.c
175 * @param versionArray The version information to be written as a string.
176 * @param versionString A string buffer that will be filled in with
177 * a string corresponding to the numeric version
178 * information in versionArray.
179 * The buffer size must be at least U_MAX_VERSION_STRING_LENGTH.
182 U_STABLE void U_EXPORT2
183 u_versionToString(const UVersionInfo versionArray, char *versionString);
186 * Gets the ICU release version. The version array stores the version information
187 * for ICU. For example, release "1.3.31.2" is then represented as 0x01031F02.
188 * Definition of this function lives in putil.c
190 * @param versionArray the version # information, the result will be filled in
193 U_STABLE void U_EXPORT2
194 u_getVersion(UVersionInfo versionArray);