icuSources/i18n/unicode/ulocdata.h

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