1 /* 2 ****************************************************************************** 3 * * 4 * Copyright (C) 2003-2015, International Business Machines * 5 * Corporation and others. All Rights Reserved. * 6 * * 7 ****************************************************************************** 8 * file name: ulocdata.h 9 * encoding: US-ASCII 10 * tab size: 8 (not used) 11 * indentation:4 12 * 13 * created on: 2003Oct21 14 * created by: Ram Viswanadha 15 */ 16 17 #ifndef __ULOCDATA_H__ 18 #define __ULOCDATA_H__ 19 20 #include "unicode/ures.h" 21 #include "unicode/uloc.h" 22 #include "unicode/uset.h" 23 #include "unicode/localpointer.h" 24 25 /** 26 * \file 27 * \brief C API: Provides access to locale data. 28 */ 29 30 /** Forward declaration of the ULocaleData structure. @stable ICU 3.6 */ 31 struct ULocaleData; 32 33 /** A locale data object. @stable ICU 3.6 */ 34 typedef struct ULocaleData ULocaleData; 35 36 37 38 /** The possible types of exemplar character sets. 39 * @stable ICU 3.4 40 */ 41 typedef enum ULocaleDataExemplarSetType { 42 /** Basic set @stable ICU 3.4 */ 43 ULOCDATA_ES_STANDARD=0, 44 /** Auxiliary set @stable ICU 3.4 */ 45 ULOCDATA_ES_AUXILIARY=1, 46 /** Index Character set @stable ICU 4.8 */ 47 ULOCDATA_ES_INDEX=2, 48 /** Punctuation set @stable ICU 51 */ 49 ULOCDATA_ES_PUNCTUATION=3, 50 /** One higher than the last valid type @stable ICU 3.4 */ 51 ULOCDATA_ES_COUNT=4 52 } ULocaleDataExemplarSetType; 53 54 /** The possible types of delimiters. 55 * @stable ICU 3.4 56 */ 57 typedef enum ULocaleDataDelimiterType { 58 /** Quotation start @stable ICU 3.4 */ 59 ULOCDATA_QUOTATION_START = 0, 60 /** Quotation end @stable ICU 3.4 */ 61 ULOCDATA_QUOTATION_END = 1, 62 /** Alternate quotation start @stable ICU 3.4 */ 63 ULOCDATA_ALT_QUOTATION_START = 2, 64 /** Alternate quotation end @stable ICU 3.4 */ 65 ULOCDATA_ALT_QUOTATION_END = 3, 66 /** One higher than the last valid type @stable ICU 3.4 */ 67 ULOCDATA_DELIMITER_COUNT = 4 68 } ULocaleDataDelimiterType; 69 70 /** 71 * Opens a locale data object for the given locale 72 * 73 * @param localeID Specifies the locale associated with this locale 74 * data object. 75 * @param status Pointer to error status code. 76 * @stable ICU 3.4 77 */ 78 U_STABLE ULocaleData* U_EXPORT2 79 ulocdata_open(const char *localeID, UErrorCode *status); 80 81 /** 82 * Closes a locale data object. 83 * 84 * @param uld The locale data object to close 85 * @stable ICU 3.4 86 */ 87 U_STABLE void U_EXPORT2 88 ulocdata_close(ULocaleData *uld); 89 90 #if U_SHOW_CPLUSPLUS_API 91 92 U_NAMESPACE_BEGIN 93 94 /** 95 * \class LocalULocaleDataPointer 96 * "Smart pointer" class, closes a ULocaleData via ulocdata_close(). 97 * For most methods see the LocalPointerBase base class. 98 * 99 * @see LocalPointerBase 100 * @see LocalPointer 101 * @stable ICU 4.4 102 */ 103 U_DEFINE_LOCAL_OPEN_POINTER(LocalULocaleDataPointer, ULocaleData, ulocdata_close); 104 105 U_NAMESPACE_END 106 107 #endif 108 109 /** 110 * Sets the "no Substitute" attribute of the locale data 111 * object. If true, then any methods associated with the 112 * locale data object will return null when there is no 113 * data available for that method, given the locale ID 114 * supplied to ulocdata_open(). 115 * 116 * @param uld The locale data object to set. 117 * @param setting Value of the "no substitute" attribute. 118 * @stable ICU 3.4 119 */ 120 U_STABLE void U_EXPORT2 121 ulocdata_setNoSubstitute(ULocaleData *uld, UBool setting); 122 123 /** 124 * Retrieves the current "no Substitute" value of the locale data 125 * object. If true, then any methods associated with the 126 * locale data object will return null when there is no 127 * data available for that method, given the locale ID 128 * supplied to ulocdata_open(). 129 * 130 * @param uld Pointer to the The locale data object to set. 131 * @return UBool Value of the "no substitute" attribute. 132 * @stable ICU 3.4 133 */ 134 U_STABLE UBool U_EXPORT2 135 ulocdata_getNoSubstitute(ULocaleData *uld); 136 137 /** 138 * Returns the set of exemplar characters for a locale. 139 * 140 * @param uld Pointer to the locale data object from which the 141 * exemplar character set is to be retrieved. 142 * @param fillIn Pointer to a USet object to receive the 143 * exemplar character set for the given locale. Previous 144 * contents of fillIn are lost. <em>If fillIn is NULL, 145 * then a new USet is created and returned. The caller 146 * owns the result and must dispose of it by calling 147 * uset_close.</em> 148 * @param options Bitmask for options to apply to the exemplar pattern. 149 * Specify zero to retrieve the exemplar set as it is 150 * defined in the locale data. Specify 151 * USET_CASE_INSENSITIVE to retrieve a case-folded 152 * exemplar set. See uset_applyPattern for a complete 153 * list of valid options. The USET_IGNORE_SPACE bit is 154 * always set, regardless of the value of 'options'. 155 * @param extype Specifies the type of exemplar set to be retrieved. 156 * @param status Pointer to an input-output error code value; 157 * must not be NULL. Will be set to U_MISSING_RESOURCE_ERROR 158 * if the requested data is not available. 159 * @return USet* Either fillIn, or if fillIn is NULL, a pointer to 160 * a newly-allocated USet that the user must close. 161 * In case of error, NULL is returned. 162 * @stable ICU 3.4 163 */ 164 U_STABLE USet* U_EXPORT2 165 ulocdata_getExemplarSet(ULocaleData *uld, USet *fillIn, 166 uint32_t options, ULocaleDataExemplarSetType extype, UErrorCode *status); 167 168 /** 169 * Returns one of the delimiter strings associated with a locale. 170 * 171 * @param uld Pointer to the locale data object from which the 172 * delimiter string is to be retrieved. 173 * @param type the type of delimiter to be retrieved. 174 * @param result A pointer to a buffer to receive the result. 175 * @param resultLength The maximum size of result. 176 * @param status Pointer to an error code value 177 * @return int32_t The total buffer size needed; if greater than resultLength, 178 * the output was truncated. 179 * @stable ICU 3.4 180 */ 181 U_STABLE int32_t U_EXPORT2 182 ulocdata_getDelimiter(ULocaleData *uld, ULocaleDataDelimiterType type, UChar *result, int32_t resultLength, UErrorCode *status); 183 184 /** 185 * Enumeration for representing the measurement systems. 186 * @stable ICU 2.8 187 */ 188 typedef enum UMeasurementSystem { 189 UMS_SI, /**< Measurement system specified by SI otherwise known as Metric system. @stable ICU 2.8 */ 190 UMS_US, /**< Measurement system followed in the United States of America. @stable ICU 2.8 */ 191 UMS_UK, /**< Mix of metric and imperial units used in Great Britain. @stable ICU 55 */ 192 UMS_LIMIT 193 } UMeasurementSystem; 194 195 /** 196 * Returns the measurement system used in the locale specified by the localeID. 197 * Please note that this API will change in ICU 3.6 and will use an ulocdata object. 198 * 199 * @param localeID The id of the locale for which the measurement system to be retrieved. 200 * @param status Must be a valid pointer to an error code value, 201 * which must not indicate a failure before the function call. 202 * @return UMeasurementSystem the measurement system used in the locale. 203 * @stable ICU 2.8 204 */ 205 U_STABLE UMeasurementSystem U_EXPORT2 206 ulocdata_getMeasurementSystem(const char *localeID, UErrorCode *status); 207 208 /** 209 * Returns the element gives the normal business letter size, and customary units. 210 * The units for the numbers are always in <em>milli-meters</em>. 211 * For US since 8.5 and 11 do not yeild an integral value when converted to milli-meters, 212 * the values are rounded off. 213 * So for A4 size paper the height and width are 297 mm and 210 mm repectively, 214 * and for US letter size the height and width are 279 mm and 216 mm respectively. 215 * Please note that this API will change in ICU 3.6 and will use an ulocdata object. 216 * 217 * @param localeID The id of the locale for which the paper size information to be retrieved. 218 * @param height A pointer to int to recieve the height information. 219 * @param width A pointer to int to recieve the width information. 220 * @param status Must be a valid pointer to an error code value, 221 * which must not indicate a failure before the function call. 222 * @stable ICU 2.8 223 */ 224 U_STABLE void U_EXPORT2 225 ulocdata_getPaperSize(const char *localeID, int32_t *height, int32_t *width, UErrorCode *status); 226 227 /** 228 * Return the current CLDR version used by the library. 229 * @param versionArray fillin that will recieve the version number 230 * @param status error code - could be U_MISSING_RESOURCE_ERROR if the version was not found. 231 * @stable ICU 4.2 232 */ 233 U_STABLE void U_EXPORT2 234 ulocdata_getCLDRVersion(UVersionInfo versionArray, UErrorCode *status); 235 236 /** 237 * Returns locale display pattern associated with a locale. 238 * 239 * @param uld Pointer to the locale data object from which the 240 * exemplar character set is to be retrieved. 241 * @param pattern locale display pattern for locale. 242 * @param patternCapacity the size of the buffer to store the locale display 243 * pattern with. 244 * @param status Must be a valid pointer to an error code value, 245 * which must not indicate a failure before the function call. 246 * @return the actual buffer size needed for localeDisplayPattern. If it's greater 247 * than patternCapacity, the returned pattern will be truncated. 248 * 249 * @stable ICU 4.2 250 */ 251 U_STABLE int32_t U_EXPORT2 252 ulocdata_getLocaleDisplayPattern(ULocaleData *uld, 253 UChar *pattern, 254 int32_t patternCapacity, 255 UErrorCode *status); 256 257 258 /** 259 * Returns locale separator associated with a locale. 260 * 261 * @param uld Pointer to the locale data object from which the 262 * exemplar character set is to be retrieved. 263 * @param separator locale separator for locale. 264 * @param separatorCapacity the size of the buffer to store the locale 265 * separator with. 266 * @param status Must be a valid pointer to an error code value, 267 * which must not indicate a failure before the function call. 268 * @return the actual buffer size needed for localeSeparator. If it's greater 269 * than separatorCapacity, the returned separator will be truncated. 270 * 271 * @stable ICU 4.2 272 */ 273 U_STABLE int32_t U_EXPORT2 274 ulocdata_getLocaleSeparator(ULocaleData *uld, 275 UChar *separator, 276 int32_t separatorCapacity, 277 UErrorCode *status); 278 #endif 279