os/textandloc/fontservices/textshaperplugin/IcuSource/common/unicode/uversion.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/*
sl@0
     2
*******************************************************************************
sl@0
     3
*   Copyright (C) 2000-2005, International Business Machines
sl@0
     4
*   Corporation and others.  All Rights Reserved.
sl@0
     5
*******************************************************************************
sl@0
     6
*
sl@0
     7
*   file name:  uversion.h
sl@0
     8
*   encoding:   US-ASCII
sl@0
     9
*   tab size:   8 (not used)
sl@0
    10
*   indentation:4
sl@0
    11
*
sl@0
    12
*   Created by: Vladimir Weinstein
sl@0
    13
*
sl@0
    14
*  Contains all the important version numbers for ICU. 
sl@0
    15
*  Gets included by utypes.h and Windows .rc files
sl@0
    16
*/
sl@0
    17
sl@0
    18
/**
sl@0
    19
 * \file
sl@0
    20
 * \brief C API: Contains all the important version numbers for ICU. 
sl@0
    21
 */
sl@0
    22
/*===========================================================================*/
sl@0
    23
/* Main ICU version information                                              */
sl@0
    24
/*===========================================================================*/
sl@0
    25
sl@0
    26
#ifndef UVERSION_H
sl@0
    27
#define UVERSION_H
sl@0
    28
sl@0
    29
/**
sl@0
    30
 * IMPORTANT: When updating version, the following things need to be done:
sl@0
    31
 * source/common/unicode/uversion.h - this file: update major, minor,
sl@0
    32
 *        patchlevel, suffix, version, short version constants, namespace,
sl@0
    33
 *                                                             and copyright
sl@0
    34
 * source/common/common.vcproj - update 'Output file name' on the link tab so
sl@0
    35
 *                   that it contains the new major/minor combination
sl@0
    36
 * source/i18n/i18n.vcproj - same as for the common.vcproj
sl@0
    37
 * source/layout/layout.vcproj - same as for the common.vcproj
sl@0
    38
 * source/stubdata/stubdata.vcproj - same as for the common.vcproj
sl@0
    39
 * source/io/io.vcproj - same as for the common.vcproj
sl@0
    40
 * source/data/makedata.mak - change U_ICUDATA_NAME so that it contains
sl@0
    41
 *                            the new major/minor combination
sl@0
    42
 * source/tools/genren/genren.pl - use this script according to the README
sl@0
    43
 *                    in that folder                                         
sl@0
    44
 */
sl@0
    45
sl@0
    46
#include "unicode/umachine.h"
sl@0
    47
sl@0
    48
/** The standard copyright notice that gets compiled into each library. 
sl@0
    49
 *  This value will change in the subsequent releases of ICU
sl@0
    50
 *  @stable ICU 2.4
sl@0
    51
 */
sl@0
    52
#define U_COPYRIGHT_STRING \
sl@0
    53
  " Copyright (C) 2005, International Business Machines Corporation and others. All Rights Reserved. "
sl@0
    54
sl@0
    55
/** Maximum length of the copyright string.
sl@0
    56
 *  @stable ICU 2.4
sl@0
    57
 */
sl@0
    58
#define U_COPYRIGHT_STRING_LENGTH  128
sl@0
    59
sl@0
    60
/** The current ICU major version as an integer. 
sl@0
    61
 *  This value will change in the subsequent releases of ICU
sl@0
    62
 *  @stable ICU 2.4
sl@0
    63
 */
sl@0
    64
#define U_ICU_VERSION_MAJOR_NUM 3
sl@0
    65
sl@0
    66
/** The current ICU minor version as an integer. 
sl@0
    67
 *  This value will change in the subsequent releases of ICU
sl@0
    68
 *  @stable ICU 2.6
sl@0
    69
 */
sl@0
    70
#define U_ICU_VERSION_MINOR_NUM 4
sl@0
    71
sl@0
    72
/** The current ICU patchlevel version as an integer.  
sl@0
    73
 *  This value will change in the subsequent releases of ICU
sl@0
    74
 *  @stable ICU 2.4
sl@0
    75
 */
sl@0
    76
#define U_ICU_VERSION_PATCHLEVEL_NUM 0
sl@0
    77
sl@0
    78
/** Glued version suffix for renamers 
sl@0
    79
 *  This value will change in the subsequent releases of ICU
sl@0
    80
 *  @stable ICU 2.6
sl@0
    81
 */
sl@0
    82
#define U_ICU_VERSION_SUFFIX _3_4
sl@0
    83
sl@0
    84
/** The current ICU library version as a dotted-decimal string. The patchlevel
sl@0
    85
 *  only appears in this string if it non-zero. 
sl@0
    86
 *  This value will change in the subsequent releases of ICU
sl@0
    87
 *  @stable ICU 2.4
sl@0
    88
 */
sl@0
    89
#define U_ICU_VERSION "3.4"
sl@0
    90
sl@0
    91
/** The current ICU library major/minor version as a string without dots, for library name suffixes. 
sl@0
    92
 *  This value will change in the subsequent releases of ICU
sl@0
    93
 *  @stable ICU 2.6
sl@0
    94
 */
sl@0
    95
#define U_ICU_VERSION_SHORT "34"
sl@0
    96
sl@0
    97
/** An ICU version consists of up to 4 numbers from 0..255.
sl@0
    98
 *  @stable ICU 2.4
sl@0
    99
 */
sl@0
   100
#define U_MAX_VERSION_LENGTH 4
sl@0
   101
sl@0
   102
/** In a string, ICU version fields are delimited by dots.
sl@0
   103
 *  @stable ICU 2.4
sl@0
   104
 */
sl@0
   105
#define U_VERSION_DELIMITER '.'
sl@0
   106
sl@0
   107
/** The maximum length of an ICU version string.
sl@0
   108
 *  @stable ICU 2.4
sl@0
   109
 */
sl@0
   110
#define U_MAX_VERSION_STRING_LENGTH 20
sl@0
   111
sl@0
   112
/** The binary form of a version on ICU APIs is an array of 4 uint8_t.
sl@0
   113
 *  @stable ICU 2.4
sl@0
   114
 */
sl@0
   115
typedef uint8_t UVersionInfo[U_MAX_VERSION_LENGTH];
sl@0
   116
sl@0
   117
#if U_HAVE_NAMESPACE && defined(XP_CPLUSPLUS)
sl@0
   118
#if U_DISABLE_RENAMING
sl@0
   119
#define U_ICU_NAMESPACE icu
sl@0
   120
namespace U_ICU_NAMESPACE { }
sl@0
   121
#else
sl@0
   122
#define U_ICU_NAMESPACE icu_3_4
sl@0
   123
namespace U_ICU_NAMESPACE { }
sl@0
   124
namespace icu = U_ICU_NAMESPACE;
sl@0
   125
#endif
sl@0
   126
U_NAMESPACE_USE
sl@0
   127
#endif
sl@0
   128
sl@0
   129
sl@0
   130
/*===========================================================================*/
sl@0
   131
/* General version helper functions. Definitions in putil.c                  */
sl@0
   132
/*===========================================================================*/
sl@0
   133
sl@0
   134
/**
sl@0
   135
 * Parse a string with dotted-decimal version information and
sl@0
   136
 * fill in a UVersionInfo structure with the result.
sl@0
   137
 * Definition of this function lives in putil.c
sl@0
   138
 *
sl@0
   139
 * @param versionArray The destination structure for the version information.
sl@0
   140
 * @param versionString A string with dotted-decimal version information,
sl@0
   141
 *                      with up to four non-negative number fields with
sl@0
   142
 *                      values of up to 255 each.
sl@0
   143
 * @stable ICU 2.4
sl@0
   144
 */
sl@0
   145
U_STABLE void U_EXPORT2
sl@0
   146
u_versionFromString(UVersionInfo versionArray, const char *versionString);
sl@0
   147
sl@0
   148
/**
sl@0
   149
 * Write a string with dotted-decimal version information according
sl@0
   150
 * to the input UVersionInfo.
sl@0
   151
 * Definition of this function lives in putil.c
sl@0
   152
 *
sl@0
   153
 * @param versionArray The version information to be written as a string.
sl@0
   154
 * @param versionString A string buffer that will be filled in with
sl@0
   155
 *                      a string corresponding to the numeric version
sl@0
   156
 *                      information in versionArray.
sl@0
   157
 *                      The buffer size must be at least U_MAX_VERSION_STRING_LENGTH.
sl@0
   158
 * @stable ICU 2.4
sl@0
   159
 */
sl@0
   160
U_STABLE void U_EXPORT2
sl@0
   161
u_versionToString(UVersionInfo versionArray, char *versionString);
sl@0
   162
sl@0
   163
/**
sl@0
   164
 * Gets the ICU release version.  The version array stores the version information
sl@0
   165
 * for ICU.  For example, release "1.3.31.2" is then represented as 0x01031F02.
sl@0
   166
 * Definition of this function lives in putil.c
sl@0
   167
 *
sl@0
   168
 * @param versionArray the version # information, the result will be filled in
sl@0
   169
 * @stable ICU 2.0
sl@0
   170
 */
sl@0
   171
U_STABLE void U_EXPORT2
sl@0
   172
u_getVersion(UVersionInfo versionArray);
sl@0
   173
sl@0
   174
sl@0
   175
/*===========================================================================
sl@0
   176
 * ICU collation framework version information                               
sl@0
   177
 * Version info that can be obtained from a collator is affected by these    
sl@0
   178
 * numbers in a secret and magic way. Please use collator version as whole
sl@0
   179
 *===========================================================================
sl@0
   180
 */
sl@0
   181
sl@0
   182
/** Collation runtime version (sort key generator, strcoll). 
sl@0
   183
 * If the version is different, sortkeys for the same string could be different 
sl@0
   184
 * version 2 was in ICU 1.8.1. changed is: compression intervals, French secondary 
sl@0
   185
 * compression, generating quad level always when strength is quad or more 
sl@0
   186
 * version 4 - ICU 2.2 - tracking UCA changes, ignore completely ignorables 
sl@0
   187
 * in contractions, ignore primary ignorables after shifted 
sl@0
   188
 * version 5 - ICU 2.8 - changed implicit generation code
sl@0
   189
 * version 6 - ICU 3.4 - with the UCA 4.1, Thai tag is no longer generated or used
sl@0
   190
 * This value may change in the subsequent releases of ICU
sl@0
   191
 * @stable ICU 2.4
sl@0
   192
 */
sl@0
   193
#define UCOL_RUNTIME_VERSION 6
sl@0
   194
sl@0
   195
/** Builder code version. When this is different, same tailoring might result
sl@0
   196
 * in assigning different collation elements to code points                  
sl@0
   197
 * version 2 was in ICU 1.8.1. added support for prefixes, tweaked canonical 
sl@0
   198
 * closure. However, the tailorings should probably get same CEs assigned    
sl@0
   199
 * version 5 - ICU 2.2 - fixed some bugs, renamed some indirect values.      
sl@0
   200
 * version 6 - ICU 2.8 - fixed bug in builder that allowed 0xFF in primary values
sl@0
   201
 * version 7 - ICU 3.4 - with the UCA 4.1 Thai tag is no longer processed, complete ignorables
sl@0
   202
 *                       now break contractions
sl@0
   203
 * Backward compatible with the old rules. 
sl@0
   204
 * This value may change in the subsequent releases of ICU
sl@0
   205
 * @stable ICU 2.4
sl@0
   206
 */
sl@0
   207
#define UCOL_BUILDER_VERSION 7
sl@0
   208
sl@0
   209
/** *** Removed *** Instead we use the data we read from FractionalUCA.txt
sl@0
   210
 * This is the version of FractionalUCA.txt tailoring rules
sl@0
   211
 * Version 1 was in ICU 1.8.1. Version two contains canonical closure for
sl@0
   212
 * supplementary code points 
sl@0
   213
 * Version 4 in ICU 2.2, following UCA=3.1.1d6, UCD=3.2.0 
sl@0
   214
 * This value may change in the subsequent releases of ICU
sl@0
   215
 * @stable ICU 2.4
sl@0
   216
 */
sl@0
   217
/*#define UCOL_FRACTIONAL_UCA_VERSION 4*/
sl@0
   218
sl@0
   219
/** This is the version of the tailorings 
sl@0
   220
 *  This value may change in the subsequent releases of ICU
sl@0
   221
 *  @stable ICU 2.4
sl@0
   222
 */
sl@0
   223
#define UCOL_TAILORINGS_VERSION 1
sl@0
   224
sl@0
   225
#endif