icuSources/i18n/unicode/dtfmtsym.h

   1 /*
   2 ********************************************************************************
   3 *   Copyright (C) 1997-2016, International Business Machines
   4 *   Corporation and others.  All Rights Reserved.
   5 ********************************************************************************
   6 *
   7 * File DTFMTSYM.H
   8 *
   9 * Modification History:
  10 *
  11 *   Date        Name        Description
  12 *   02/19/97    aliu        Converted from java.
  13 *    07/21/98    stephen        Added getZoneIndex()
  14 *                            Changed to match C++ conventions
  15 ********************************************************************************
  16 */
  17
  18 #ifndef DTFMTSYM_H
  19 #define DTFMTSYM_H
  20
  21 #include "unicode/utypes.h"
  22
  23 #if !UCONFIG_NO_FORMATTING
  24
  25 #include "unicode/calendar.h"
  26 #include "unicode/uobject.h"
  27 #include "unicode/locid.h"
  28 #include "unicode/udat.h"
  29 #include "unicode/ures.h"
  30
  31 /**
  32  * \file
  33  * \brief C++ API: Symbols for formatting dates.
  34  */
  35
  36 U_NAMESPACE_BEGIN
  37
  38 /* forward declaration */
  39 class SimpleDateFormat;
  40 class Hashtable;
  41
  42 /**
  43  * DateFormatSymbols is a public class for encapsulating localizable date-time
  44  * formatting data -- including timezone data. DateFormatSymbols is used by
  45  * DateFormat and SimpleDateFormat.
  46  * <P>
  47  * Rather than first creating a DateFormatSymbols to get a date-time formatter
  48  * by using a SimpleDateFormat constructor, clients are encouraged to create a
  49  * date-time formatter using the getTimeInstance(), getDateInstance(), or
  50  * getDateTimeInstance() method in DateFormat. Each of these methods can return a
  51  * date/time formatter initialized with a default format pattern along with the
  52  * date-time formatting data for a given or default locale. After a formatter is
  53  * created, clients may modify the format pattern using the setPattern function
  54  * as so desired. For more information on using these formatter factory
  55  * functions, see DateFormat.
  56  * <P>
  57  * If clients decide to create a date-time formatter with a particular format
  58  * pattern and locale, they can do so with new SimpleDateFormat(aPattern,
  59  * new DateFormatSymbols(aLocale)).  This will load the appropriate date-time
  60  * formatting data from the locale.
  61  * <P>
  62  * DateFormatSymbols objects are clonable. When clients obtain a
  63  * DateFormatSymbols object, they can feel free to modify the date-time
  64  * formatting data as necessary. For instance, clients can
  65  * replace the localized date-time format pattern characters with the ones that
  66  * they feel easy to remember. Or they can change the representative cities
  67  * originally picked by default to using their favorite ones.
  68  * <P>
  69  * DateFormatSymbols are not expected to be subclassed. Data for a calendar is
  70  * loaded out of resource bundles.  The 'type' parameter indicates the type of
  71  * calendar, for example, "gregorian" or "japanese".  If the type is not gregorian
  72  * (or NULL, or an empty string) then the type is appended to the resource name,
  73  * for example,  'Eras_japanese' instead of 'Eras'.   If the resource 'Eras_japanese' did
  74  * not exist (even in root), then this class will fall back to just 'Eras', that is,
  75  * Gregorian data.  Therefore, the calendar implementor MUST ensure that the root
  76  * locale at least contains any resources that are to be particularized for the
  77  * calendar type.
  78  */
  79 class U_I18N_API DateFormatSymbols U_FINAL : public UObject  {
  80 public:
  81     /**
  82      * Construct a DateFormatSymbols object by loading format data from
  83      * resources for the default locale, in the default calendar (Gregorian).
  84      * <P>
  85      * NOTE: This constructor will never fail; if it cannot get resource
  86      * data for the default locale, it will return a last-resort object
  87      * based on hard-coded strings.
  88      *
  89      * @param status    Status code.  Failure
  90      *                  results if the resources for the default cannot be
  91      *                  found or cannot be loaded
  92      * @stable ICU 2.0
  93      */
  94     DateFormatSymbols(UErrorCode& status);
  95
  96     /**
  97      * Construct a DateFormatSymbols object by loading format data from
  98      * resources for the given locale, in the default calendar (Gregorian).
  99      *
 100      * @param locale    Locale to load format data from.
 101      * @param status    Status code.  Failure
 102      *                  results if the resources for the locale cannot be
 103      *                  found or cannot be loaded
 104      * @stable ICU 2.0
 105      */
 106     DateFormatSymbols(const Locale& locale,
 107                       UErrorCode& status);
 108
 109 #ifndef U_HIDE_INTERNAL_API
 110     /**
 111      * Construct a DateFormatSymbols object by loading format data from
 112      * resources for the default locale, in the default calendar (Gregorian).
 113      * <P>
 114      * NOTE: This constructor will never fail; if it cannot get resource
 115      * data for the default locale, it will return a last-resort object
 116      * based on hard-coded strings.
 117      *
 118      * @param type      Type of calendar (as returned by Calendar::getType).
 119      *                  Will be used to access the correct set of strings.
 120      *                  (NULL or empty string defaults to "gregorian".)
 121      * @param status    Status code.  Failure
 122      *                  results if the resources for the default cannot be
 123      *                  found or cannot be loaded
 124      * @internal
 125      */
 126     DateFormatSymbols(const char *type, UErrorCode& status);
 127
 128     /**
 129      * Construct a DateFormatSymbols object by loading format data from
 130      * resources for the given locale, in the default calendar (Gregorian).
 131      *
 132      * @param locale    Locale to load format data from.
 133      * @param type      Type of calendar (as returned by Calendar::getType).
 134      *                  Will be used to access the correct set of strings.
 135      *                  (NULL or empty string defaults to "gregorian".)
 136      * @param status    Status code.  Failure
 137      *                  results if the resources for the locale cannot be
 138      *                  found or cannot be loaded
 139      * @internal
 140      */
 141     DateFormatSymbols(const Locale& locale,
 142                       const char *type,
 143                       UErrorCode& status);
 144 #endif  /* U_HIDE_INTERNAL_API */
 145
 146     /**
 147      * Copy constructor.
 148      * @stable ICU 2.0
 149      */
 150     DateFormatSymbols(const DateFormatSymbols&);
 151
 152     /**
 153      * Assignment operator.
 154      * @stable ICU 2.0
 155      */
 156     DateFormatSymbols& operator=(const DateFormatSymbols&);
 157
 158     /**
 159      * Destructor. This is nonvirtual because this class is not designed to be
 160      * subclassed.
 161      * @stable ICU 2.0
 162      */
 163     virtual ~DateFormatSymbols();
 164
 165     /**
 166      * Return true if another object is semantically equal to this one.
 167      *
 168      * @param other    the DateFormatSymbols object to be compared with.
 169      * @return         true if other is semantically equal to this.
 170      * @stable ICU 2.0
 171      */
 172     UBool operator==(const DateFormatSymbols& other) const;
 173
 174     /**
 175      * Return true if another object is semantically unequal to this one.
 176      *
 177      * @param other    the DateFormatSymbols object to be compared with.
 178      * @return         true if other is semantically unequal to this.
 179      * @stable ICU 2.0
 180      */
 181     UBool operator!=(const DateFormatSymbols& other) const { return !operator==(other); }
 182
 183     /**
 184      * Gets abbreviated era strings. For example: "AD" and "BC".
 185      *
 186      * @param count    Filled in with length of the array.
 187      * @return         the era strings.
 188      * @stable ICU 2.0
 189      */
 190     const UnicodeString* getEras(int32_t& count) const;
 191
 192     /**
 193      * Sets abbreviated era strings. For example: "AD" and "BC".
 194      * @param eras  Array of era strings (DateFormatSymbols retains ownership.)
 195      * @param count Filled in with length of the array.
 196      * @stable ICU 2.0
 197      */
 198     void setEras(const UnicodeString* eras, int32_t count);
 199
 200     /**
 201      * Gets era name strings. For example: "Anno Domini" and "Before Christ".
 202      *
 203      * @param count    Filled in with length of the array.
 204      * @return         the era name strings.
 205      * @stable ICU 3.4
 206      */
 207     const UnicodeString* getEraNames(int32_t& count) const;
 208
 209     /**
 210      * Sets era name strings. For example: "Anno Domini" and "Before Christ".
 211      * @param eraNames  Array of era name strings (DateFormatSymbols retains ownership.)
 212      * @param count Filled in with length of the array.
 213      * @stable ICU 3.6
 214      */
 215     void setEraNames(const UnicodeString* eraNames, int32_t count);
 216
 217     /**
 218      * Gets narrow era strings. For example: "A" and "B".
 219      *
 220      * @param count    Filled in with length of the array.
 221      * @return         the narrow era strings.
 222      * @stable ICU 4.2
 223      */
 224     const UnicodeString* getNarrowEras(int32_t& count) const;
 225
 226     /**
 227      * Sets narrow era strings. For example: "A" and "B".
 228      * @param narrowEras  Array of narrow era strings (DateFormatSymbols retains ownership.)
 229      * @param count Filled in with length of the array.
 230      * @stable ICU 4.2
 231      */
 232     void setNarrowEras(const UnicodeString* narrowEras, int32_t count);
 233
 234     /**
 235      * Gets month strings. For example: "January", "February", etc.
 236      * @param count Filled in with length of the array.
 237      * @return the month strings. (DateFormatSymbols retains ownership.)
 238      * @stable ICU 2.0
 239      */
 240     const UnicodeString* getMonths(int32_t& count) const;
 241
 242     /**
 243      * Sets month strings. For example: "January", "February", etc.
 244      *
 245      * @param months    the new month strings. (not adopted; caller retains ownership)
 246      * @param count     Filled in with length of the array.
 247      * @stable ICU 2.0
 248      */
 249     void setMonths(const UnicodeString* months, int32_t count);
 250
 251     /**
 252      * Gets short month strings. For example: "Jan", "Feb", etc.
 253      *
 254      * @param count Filled in with length of the array.
 255      * @return the short month strings. (DateFormatSymbols retains ownership.)
 256      * @stable ICU 2.0
 257      */
 258     const UnicodeString* getShortMonths(int32_t& count) const;
 259
 260     /**
 261      * Sets short month strings. For example: "Jan", "Feb", etc.
 262      * @param count        Filled in with length of the array.
 263      * @param shortMonths  the new short month strings. (not adopted; caller retains ownership)
 264      * @stable ICU 2.0
 265      */
 266     void setShortMonths(const UnicodeString* shortMonths, int32_t count);
 267
 268     /**
 269      * Selector for date formatting context
 270      * @stable ICU 3.6
 271      */
 272     enum DtContextType {
 273          FORMAT,
 274          STANDALONE,
 275          DT_CONTEXT_COUNT
 276     };
 277
 278     /**
 279      * Selector for date formatting width
 280      * @stable ICU 3.6
 281      */
 282     enum DtWidthType {
 283          ABBREVIATED,
 284          WIDE,
 285          NARROW,
 286          /**
 287           * Short width is currently only supported for weekday names.
 288           * @stable ICU 51
 289           */
 290          SHORT,
 291          /**
 292           */
 293          DT_WIDTH_COUNT = 4
 294     };
 295
 296     /**
 297      * Gets month strings by width and context. For example: "January", "February", etc.
 298      * @param count Filled in with length of the array.
 299      * @param context The formatting context, either FORMAT or STANDALONE
 300      * @param width   The width of returned strings, either WIDE, ABBREVIATED, or NARROW.
 301      * @return the month strings. (DateFormatSymbols retains ownership.)
 302      * @stable ICU 3.4
 303      */
 304     const UnicodeString* getMonths(int32_t& count, DtContextType context, DtWidthType width) const;
 305
 306     /**
 307      * Sets month strings by width and context. For example: "January", "February", etc.
 308      *
 309      * @param months  The new month strings. (not adopted; caller retains ownership)
 310      * @param count   Filled in with length of the array.
 311      * @param context The formatting context, either FORMAT or STANDALONE
 312      * @param width   The width of returned strings, either WIDE, ABBREVIATED, or NARROW.
 313      * @stable ICU 3.6
 314      */
 315     void setMonths(const UnicodeString* months, int32_t count, DtContextType context, DtWidthType width);
 316
 317     /**
 318      * Gets wide weekday strings. For example: "Sunday", "Monday", etc.
 319      * @param count        Filled in with length of the array.
 320      * @return the weekday strings. (DateFormatSymbols retains ownership.)
 321      * @stable ICU 2.0
 322      */
 323     const UnicodeString* getWeekdays(int32_t& count) const;
 324
 325
 326     /**
 327      * Sets wide weekday strings. For example: "Sunday", "Monday", etc.
 328      * @param weekdays     the new weekday strings. (not adopted; caller retains ownership)
 329      * @param count        Filled in with length of the array.
 330      * @stable ICU 2.0
 331      */
 332     void setWeekdays(const UnicodeString* weekdays, int32_t count);
 333
 334     /**
 335      * Gets abbreviated weekday strings. For example: "Sun", "Mon", etc. (Note: The method name is
 336      * misleading; it does not get the CLDR-style "short" weekday strings, e.g. "Su", "Mo", etc.)
 337      * @param count        Filled in with length of the array.
 338      * @return             the abbreviated weekday strings. (DateFormatSymbols retains ownership.)
 339      * @stable ICU 2.0
 340      */
 341     const UnicodeString* getShortWeekdays(int32_t& count) const;
 342
 343     /**
 344      * Sets abbreviated weekday strings. For example: "Sun", "Mon", etc. (Note: The method name is
 345      * misleading; it does not set the CLDR-style "short" weekday strings, e.g. "Su", "Mo", etc.)
 346      * @param abbrevWeekdays  the new abbreviated weekday strings. (not adopted; caller retains ownership)
 347      * @param count           Filled in with length of the array.
 348      * @stable ICU 2.0
 349      */
 350     void setShortWeekdays(const UnicodeString* abbrevWeekdays, int32_t count);
 351
 352     /**
 353      * Gets weekday strings by width and context. For example: "Sunday", "Monday", etc.
 354      * @param count   Filled in with length of the array.
 355      * @param context The formatting context, either FORMAT or STANDALONE
 356      * @param width   The width of returned strings, either WIDE, ABBREVIATED, SHORT, or NARROW
 357      * @return the month strings. (DateFormatSymbols retains ownership.)
 358      * @stable ICU 3.4
 359      */
 360     const UnicodeString* getWeekdays(int32_t& count, DtContextType context, DtWidthType width) const;
 361
 362     /**
 363      * Sets weekday strings by width and context. For example: "Sunday", "Monday", etc.
 364      * @param weekdays  The new weekday strings. (not adopted; caller retains ownership)
 365      * @param count     Filled in with length of the array.
 366      * @param context   The formatting context, either FORMAT or STANDALONE
 367      * @param width     The width of returned strings, either WIDE, ABBREVIATED, SHORT, or NARROW
 368      * @stable ICU 3.6
 369      */
 370     void setWeekdays(const UnicodeString* weekdays, int32_t count, DtContextType context, DtWidthType width);
 371
 372     /**
 373      * Gets quarter strings by width and context. For example: "1st Quarter", "2nd Quarter", etc.
 374      * @param count Filled in with length of the array.
 375      * @param context The formatting context, either FORMAT or STANDALONE
 376      * @param width   The width of returned strings, either WIDE or ABBREVIATED. There
 377      *                are no NARROW quarters.
 378      * @return the quarter strings. (DateFormatSymbols retains ownership.)
 379      * @stable ICU 3.6
 380      */
 381     const UnicodeString* getQuarters(int32_t& count, DtContextType context, DtWidthType width) const;
 382
 383     /**
 384      * Sets quarter strings by width and context. For example: "1st Quarter", "2nd Quarter", etc.
 385      *
 386      * @param quarters  The new quarter strings. (not adopted; caller retains ownership)
 387      * @param count   Filled in with length of the array.
 388      * @param context The formatting context, either FORMAT or STANDALONE
 389      * @param width   The width of returned strings, either WIDE or ABBREVIATED. There
 390      *                are no NARROW quarters.
 391      * @stable ICU 3.6
 392      */
 393     void setQuarters(const UnicodeString* quarters, int32_t count, DtContextType context, DtWidthType width);
 394
 395     /**
 396      * Gets AM/PM strings. For example: "AM" and "PM".
 397      * @param count        Filled in with length of the array.
 398      * @return             the weekday strings. (DateFormatSymbols retains ownership.)
 399      * @stable ICU 2.0
 400      */
 401     const UnicodeString* getAmPmStrings(int32_t& count) const;
 402
 403     /**
 404      * Sets ampm strings. For example: "AM" and "PM".
 405      * @param ampms        the new ampm strings. (not adopted; caller retains ownership)
 406      * @param count        Filled in with length of the array.
 407      * @stable ICU 2.0
 408      */
 409     void setAmPmStrings(const UnicodeString* ampms, int32_t count);
 410
 411 #ifndef U_HIDE_INTERNAL_API
 412     /**
 413      * This default time separator is used for formatting when the locale
 414      * doesn't specify any time separator, and always recognized when parsing.
 415      * @internal
 416      */
 417     static const UChar DEFAULT_TIME_SEPARATOR = 0x003a;  // ':'
 418
 419     /**
 420      * This alternate time separator is always recognized when parsing.
 421      * @internal
 422      */
 423     static const UChar ALTERNATE_TIME_SEPARATOR = 0x002e;  // '.'
 424
 425     /**
 426      * Gets the time separator string. For example: ":".
 427      * @param result Output param which will receive the time separator string.
 428      * @return       A reference to 'result'.
 429      * @internal
 430      */
 431     UnicodeString& getTimeSeparatorString(UnicodeString& result) const;
 432
 433     /**
 434      * Sets the time separator string. For example: ":".
 435      * @param newTimeSeparator the new time separator string.
 436      * @internal
 437      */
 438     void setTimeSeparatorString(const UnicodeString& newTimeSeparator);
 439 #endif  /* U_HIDE_INTERNAL_API */
 440
 441     /**
 442      * Gets cyclic year name strings if the calendar has them, by width and context.
 443      * For example: "jia-zi", "yi-chou", etc.
 444      * @param count     Filled in with length of the array.
 445      * @param context   The usage context: FORMAT, STANDALONE.
 446      * @param width     The requested name width: WIDE, ABBREVIATED, NARROW.
 447      * @return          The year name strings (DateFormatSymbols retains ownership),
 448      *                  or null if they are not available for this calendar.
 449      * @stable ICU 54
 450      */
 451     const UnicodeString* getYearNames(int32_t& count,
 452                             DtContextType context, DtWidthType width) const;
 453
 454     /**
 455      * Sets cyclic year name strings by width and context. For example: "jia-zi", "yi-chou", etc.
 456      *
 457      * @param yearNames The new cyclic year name strings (not adopted; caller retains ownership).
 458      * @param count     The length of the array.
 459      * @param context   The usage context: FORMAT, STANDALONE (currently only FORMAT is supported).
 460      * @param width     The name width: WIDE, ABBREVIATED, NARROW (currently only ABBREVIATED is supported).
 461      * @stable ICU 54
 462      */
 463     void setYearNames(const UnicodeString* yearNames, int32_t count,
 464                             DtContextType context, DtWidthType width);
 465
 466     /**
 467      * Gets calendar zodiac name strings if the calendar has them, by width and context.
 468      * For example: "Rat", "Ox", "Tiger", etc.
 469      * @param count     Filled in with length of the array.
 470      * @param context   The usage context: FORMAT, STANDALONE.
 471      * @param width     The requested name width: WIDE, ABBREVIATED, NARROW.
 472      * @return          The zodiac name strings (DateFormatSymbols retains ownership),
 473      *                  or null if they are not available for this calendar.
 474      * @stable ICU 54
 475      */
 476     const UnicodeString* getZodiacNames(int32_t& count,
 477                             DtContextType context, DtWidthType width) const;
 478
 479     /**
 480      * Sets calendar zodiac name strings by width and context. For example: "Rat", "Ox", "Tiger", etc.
 481      *
 482      * @param zodiacNames The new zodiac name strings (not adopted; caller retains ownership).
 483      * @param count     The length of the array.
 484      * @param context   The usage context: FORMAT, STANDALONE (currently only FORMAT is supported).
 485      * @param width     The name width: WIDE, ABBREVIATED, NARROW (currently only ABBREVIATED is supported).
 486      * @stable ICU 54
 487      */
 488     void setZodiacNames(const UnicodeString* zodiacNames, int32_t count,
 489                             DtContextType context, DtWidthType width);
 490
 491 #ifndef U_HIDE_INTERNAL_API
 492     /**
 493      * Somewhat temporary constants for leap month pattern types, adequate for supporting
 494      * just leap month patterns as needed for Chinese lunar calendar.
 495      * Eventually we will add full support for different month pattern types (needed for
 496      * other calendars such as Hindu) at which point this approach will be replaced by a
 497      * more complete approach.
 498      * @internal
 499      */
 500     enum EMonthPatternType
 501     {
 502         kLeapMonthPatternFormatWide,
 503         kLeapMonthPatternFormatAbbrev,
 504         kLeapMonthPatternFormatNarrow,
 505         kLeapMonthPatternStandaloneWide,
 506         kLeapMonthPatternStandaloneAbbrev,
 507         kLeapMonthPatternStandaloneNarrow,
 508         kLeapMonthPatternNumeric,
 509         kMonthPatternsCount
 510     };
 511
 512     /**
 513      * Somewhat temporary function for getting complete set of leap month patterns for all
 514      * contexts & widths, indexed by EMonthPatternType values. Returns NULL if calendar
 515      * does not have leap month patterns. Note, there is currently no setter for this.
 516      * Eventually we will add full support for different month pattern types (needed for
 517      * other calendars such as Hindu) at which point this approach will be replaced by a
 518      * more complete approach.
 519      * @param count        Filled in with length of the array (may be 0).
 520      * @return             The leap month patterns (DateFormatSymbols retains ownership).
 521      *                     May be NULL if there are no leap month patterns for this calendar.
 522      * @internal
 523      */
 524     const UnicodeString* getLeapMonthPatterns(int32_t& count) const;
 525
 526 #endif  /* U_HIDE_INTERNAL_API */
 527
 528 #ifndef U_HIDE_DEPRECATED_API
 529     /**
 530      * Gets timezone strings. These strings are stored in a 2-dimensional array.
 531      * @param rowCount      Output param to receive number of rows.
 532      * @param columnCount   Output param to receive number of columns.
 533      * @return              The timezone strings as a 2-d array. (DateFormatSymbols retains ownership.)
 534      * @deprecated ICU 3.6
 535      */
 536     const UnicodeString** getZoneStrings(int32_t& rowCount, int32_t& columnCount) const;
 537 #endif  /* U_HIDE_DEPRECATED_API */
 538
 539     /**
 540      * Sets timezone strings. These strings are stored in a 2-dimensional array.
 541      * <p><b>Note:</b> SimpleDateFormat no longer use the zone strings stored in
 542      * a DateFormatSymbols. Therefore, the time zone strings set by this mthod
 543      * have no effects in an instance of SimpleDateFormat for formatting time
 544      * zones.
 545      * @param strings       The timezone strings as a 2-d array to be copied. (not adopted; caller retains ownership)
 546      * @param rowCount      The number of rows (count of first index).
 547      * @param columnCount   The number of columns (count of second index).
 548      * @stable ICU 2.0
 549      */
 550     void setZoneStrings(const UnicodeString* const* strings, int32_t rowCount, int32_t columnCount);
 551
 552     /**
 553      * Get the non-localized date-time pattern characters.
 554      * @return    the non-localized date-time pattern characters
 555      * @stable ICU 2.0
 556      */
 557     static const UChar * U_EXPORT2 getPatternUChars(void);
 558
 559     /**
 560      * Gets localized date-time pattern characters. For example: 'u', 't', etc.
 561      * <p>
 562      * Note: ICU no longer provides localized date-time pattern characters for a locale
 563      * starting ICU 3.8.  This method returns the non-localized date-time pattern
 564      * characters unless user defined localized data is set by setLocalPatternChars.
 565      * @param result    Output param which will receive the localized date-time pattern characters.
 566      * @return          A reference to 'result'.
 567      * @stable ICU 2.0
 568      */
 569     UnicodeString& getLocalPatternChars(UnicodeString& result) const;
 570
 571     /**
 572      * Sets localized date-time pattern characters. For example: 'u', 't', etc.
 573      * @param newLocalPatternChars the new localized date-time
 574      * pattern characters.
 575      * @stable ICU 2.0
 576      */
 577     void setLocalPatternChars(const UnicodeString& newLocalPatternChars);
 578
 579     /**
 580      * Returns the locale for this object. Two flavors are available:
 581      * valid and actual locale.
 582      * @stable ICU 2.8
 583      */
 584     Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
 585
 586     /* The following type and kCapContextUsageTypeCount cannot be #ifndef U_HIDE_INTERNAL_API,
 587        they are needed for .h file declarations. */
 588     /**
 589      * Constants for capitalization context usage types.
 590      * @internal
 591      */
 592     enum ECapitalizationContextUsageType
 593     {
 594 #ifndef U_HIDE_INTERNAL_API
 595         kCapContextUsageOther = 0,
 596         kCapContextUsageMonthFormat,     /* except narrow */
 597         kCapContextUsageMonthStandalone, /* except narrow */
 598         kCapContextUsageMonthNarrow,
 599         kCapContextUsageDayFormat,     /* except narrow */
 600         kCapContextUsageDayStandalone, /* except narrow */
 601         kCapContextUsageDayNarrow,
 602         kCapContextUsageEraWide,
 603         kCapContextUsageEraAbbrev,
 604         kCapContextUsageEraNarrow,
 605         kCapContextUsageZoneLong,
 606         kCapContextUsageZoneShort,
 607         kCapContextUsageMetazoneLong,
 608         kCapContextUsageMetazoneShort,
 609 #endif /* U_HIDE_INTERNAL_API */
 610         kCapContextUsageTypeCount = 14
 611     };
 612
 613     /**
 614      * ICU "poor man's RTTI", returns a UClassID for the actual class.
 615      *
 616      * @stable ICU 2.2
 617      */
 618     virtual UClassID getDynamicClassID() const;
 619
 620     /**
 621      * ICU "poor man's RTTI", returns a UClassID for this class.
 622      *
 623      * @stable ICU 2.2
 624      */
 625     static UClassID U_EXPORT2 getStaticClassID();
 626
 627 private:
 628
 629     friend class SimpleDateFormat;
 630     friend class DateFormatSymbolsSingleSetter; // see udat.cpp
 631
 632     /**
 633      * Abbreviated era strings. For example: "AD" and "BC".
 634      */
 635     UnicodeString*  fEras;
 636     int32_t         fErasCount;
 637
 638     /**
 639      * Era name strings. For example: "Anno Domini" and "Before Christ".
 640      */
 641     UnicodeString*  fEraNames;
 642     int32_t         fEraNamesCount;
 643
 644     /**
 645      * Narrow era strings. For example: "A" and "B".
 646      */
 647     UnicodeString*  fNarrowEras;
 648     int32_t         fNarrowErasCount;
 649
 650     /**
 651      * Month strings. For example: "January", "February", etc.
 652      */
 653     UnicodeString*  fMonths;
 654     int32_t         fMonthsCount;
 655
 656     /**
 657      * Short month strings. For example: "Jan", "Feb", etc.
 658      */
 659     UnicodeString*  fShortMonths;
 660     int32_t         fShortMonthsCount;
 661
 662     /**
 663      * Narrow month strings. For example: "J", "F", etc.
 664      */
 665     UnicodeString*  fNarrowMonths;
 666     int32_t         fNarrowMonthsCount;
 667
 668     /**
 669      * Standalone Month strings. For example: "January", "February", etc.
 670      */
 671     UnicodeString*  fStandaloneMonths;
 672     int32_t         fStandaloneMonthsCount;
 673
 674     /**
 675      * Standalone Short month strings. For example: "Jan", "Feb", etc.
 676      */
 677     UnicodeString*  fStandaloneShortMonths;
 678     int32_t         fStandaloneShortMonthsCount;
 679
 680     /**
 681      * Standalone Narrow month strings. For example: "J", "F", etc.
 682      */
 683     UnicodeString*  fStandaloneNarrowMonths;
 684     int32_t         fStandaloneNarrowMonthsCount;
 685
 686     /**
 687      * CLDR-style format wide weekday strings. For example: "Sunday", "Monday", etc.
 688      */
 689     UnicodeString*  fWeekdays;
 690     int32_t         fWeekdaysCount;
 691
 692     /**
 693      * CLDR-style format abbreviated (not short) weekday strings. For example: "Sun", "Mon", etc.
 694      */
 695     UnicodeString*  fShortWeekdays;
 696     int32_t         fShortWeekdaysCount;
 697
 698     /**
 699      * CLDR-style format short weekday strings. For example: "Su", "Mo", etc.
 700      */
 701     UnicodeString*  fShorterWeekdays;
 702     int32_t         fShorterWeekdaysCount;
 703
 704     /**
 705      * CLDR-style format narrow weekday strings. For example: "S", "M", etc.
 706      */
 707     UnicodeString*  fNarrowWeekdays;
 708     int32_t         fNarrowWeekdaysCount;
 709
 710     /**
 711      * CLDR-style standalone wide weekday strings. For example: "Sunday", "Monday", etc.
 712      */
 713     UnicodeString*  fStandaloneWeekdays;
 714     int32_t         fStandaloneWeekdaysCount;
 715
 716     /**
 717      * CLDR-style standalone abbreviated (not short) weekday strings. For example: "Sun", "Mon", etc.
 718      */
 719     UnicodeString*  fStandaloneShortWeekdays;
 720     int32_t         fStandaloneShortWeekdaysCount;
 721
 722     /**
 723      * CLDR-style standalone short weekday strings. For example: "Su", "Mo", etc.
 724      */
 725     UnicodeString*  fStandaloneShorterWeekdays;
 726     int32_t         fStandaloneShorterWeekdaysCount;
 727
 728     /**
 729      * Standalone Narrow weekday strings. For example: "Sun", "Mon", etc.
 730      */
 731     UnicodeString*  fStandaloneNarrowWeekdays;
 732     int32_t         fStandaloneNarrowWeekdaysCount;
 733
 734     /**
 735      * Ampm strings. For example: "AM" and "PM".
 736      */
 737     UnicodeString*  fAmPms;
 738     int32_t         fAmPmsCount;
 739
 740     /**
 741      * Narrow Ampm strings. For example: "a" and "p".
 742      */
 743     UnicodeString*  fNarrowAmPms;
 744     int32_t         fNarrowAmPmsCount;
 745
 746     /**
 747      * Time separator string. For example: ":".
 748      */
 749     UnicodeString   fTimeSeparator;
 750
 751     /**
 752      * Quarter strings. For example: "1st quarter", "2nd quarter", etc.
 753      */
 754     UnicodeString  *fQuarters;
 755     int32_t         fQuartersCount;
 756
 757     /**
 758      * Short quarters. For example: "Q1", "Q2", etc.
 759      */
 760     UnicodeString  *fShortQuarters;
 761     int32_t         fShortQuartersCount;
 762
 763     /**
 764      * Standalone quarter strings. For example: "1st quarter", "2nd quarter", etc.
 765      */
 766     UnicodeString  *fStandaloneQuarters;
 767     int32_t         fStandaloneQuartersCount;
 768
 769     /**
 770      * Standalone short quarter strings. For example: "Q1", "Q2", etc.
 771      */
 772     UnicodeString  *fStandaloneShortQuarters;
 773     int32_t         fStandaloneShortQuartersCount;
 774
 775     /**
 776      * All leap month patterns, for example "{0}bis".
 777      */
 778     UnicodeString  *fLeapMonthPatterns;
 779     int32_t         fLeapMonthPatternsCount;
 780
 781     /**
 782      * Cyclic year names, for example: "jia-zi", "yi-chou", ... "gui-hai";
 783      * currently we only have data for format/abbreviated.
 784      * For the others, just get from format/abbreviated, ignore set.
 785      */
 786     UnicodeString  *fShortYearNames;
 787     int32_t         fShortYearNamesCount;
 788
 789     /**
 790      * Cyclic zodiac names, for example "Rat", "Ox", "Tiger", etc.;
 791      * currently we only have data for format/abbreviated.
 792      * For the others, just get from format/abbreviated, ignore set.
 793      */
 794     UnicodeString  *fShortZodiacNames;
 795     int32_t         fShortZodiacNamesCount;
 796
 797     /**
 798      * Localized names of time zones in this locale.  This is a
 799      * two-dimensional array of strings of size n by m,
 800      * where m is at least 5 and up to 7.  Each of the n rows is an
 801      * entry containing the localized names for a single TimeZone.
 802      *
 803      * Each such row contains (with i ranging from 0..n-1):
 804      *
 805      * zoneStrings[i][0] - time zone ID
 806      *  example: America/Los_Angeles
 807      * zoneStrings[i][1] - long name of zone in standard time
 808      *  example: Pacific Standard Time
 809      * zoneStrings[i][2] - short name of zone in standard time
 810      *  example: PST
 811      * zoneStrings[i][3] - long name of zone in daylight savings time
 812      *  example: Pacific Daylight Time
 813      * zoneStrings[i][4] - short name of zone in daylight savings time
 814      *  example: PDT
 815      * zoneStrings[i][5] - location name of zone
 816      *  example: United States (Los Angeles)
 817      * zoneStrings[i][6] - long generic name of zone
 818      *  example: Pacific Time
 819      * zoneStrings[i][7] - short generic of zone
 820      *  example: PT
 821      *
 822      * The zone ID is not localized; it corresponds to the ID
 823      * value associated with a system time zone object.  All other entries
 824      * are localized names.  If a zone does not implement daylight savings
 825      * time, the daylight savings time names are ignored.
 826      *
 827      * Note:CLDR 1.5 introduced metazone and its historical mappings.
 828      * This simple two-dimensional array is no longer sufficient to represent
 829      * localized names and its historic changes.  Since ICU 3.8.1, localized
 830      * zone names extracted from ICU locale data is stored in a ZoneStringFormat
 831      * instance.  But we still need to support the old way of customizing
 832      * localized zone names, so we keep this field for the purpose.
 833      */
 834     UnicodeString   **fZoneStrings;         // Zone string array set by setZoneStrings
 835     UnicodeString   **fLocaleZoneStrings;   // Zone string array created by the locale
 836     int32_t         fZoneStringsRowCount;
 837     int32_t         fZoneStringsColCount;
 838
 839     Locale                  fZSFLocale;         // Locale used for getting ZoneStringFormat
 840
 841     /**
 842      * Localized date-time pattern characters. For example: use 'u' as 'y'.
 843      */
 844     UnicodeString   fLocalPatternChars;
 845
 846     /**
 847      * Capitalization transforms. For each usage type, the first array element indicates
 848      * whether to titlecase for uiListOrMenu context, the second indicates whether to
 849      * titlecase for stand-alone context.
 850      */
 851      UBool fCapitalization[kCapContextUsageTypeCount][2];
 852
 853     /**
 854      * Abbreviated (== short) day period strings.
 855      */
 856     UnicodeString  *fAbbreviatedDayPeriods;
 857     int32_t         fAbbreviatedDayPeriodsCount;
 858
 859     /**
 860      * Wide day period strings.
 861      */
 862     UnicodeString  *fWideDayPeriods;
 863     int32_t         fWideDayPeriodsCount;
 864
 865     /**
 866      * Narrow day period strings.
 867      */
 868     UnicodeString  *fNarrowDayPeriods;
 869     int32_t         fNarrowDayPeriodsCount;
 870
 871     /**
 872      * Stand-alone abbreviated (== short) day period strings.
 873      */
 874     UnicodeString  *fStandaloneAbbreviatedDayPeriods;
 875     int32_t         fStandaloneAbbreviatedDayPeriodsCount;
 876
 877     /**
 878      * Stand-alone wide day period strings.
 879      */
 880     UnicodeString  *fStandaloneWideDayPeriods;
 881     int32_t         fStandaloneWideDayPeriodsCount;
 882
 883     /**
 884      * Stand-alone narrow day period strings.
 885      */
 886     UnicodeString  *fStandaloneNarrowDayPeriods;
 887     int32_t         fStandaloneNarrowDayPeriodsCount;
 888
 889 private:
 890     /** valid/actual locale information
 891      *  these are always ICU locales, so the length should not be a problem
 892      */
 893     char validLocale[ULOC_FULLNAME_CAPACITY];
 894     char actualLocale[ULOC_FULLNAME_CAPACITY];
 895
 896     DateFormatSymbols(); // default constructor not implemented
 897
 898     /**
 899      * Called by the constructors to actually load data from the resources
 900      *
 901      * @param locale               The locale to get symbols for.
 902      * @param type                 Calendar Type (as from Calendar::getType())
 903      * @param status               Input/output parameter, set to success or
 904      *                             failure code upon return.
 905      * @param useLastResortData    determine if use last resort data
 906      */
 907     void initializeData(const Locale& locale, const char *type, UErrorCode& status, UBool useLastResortData = FALSE);
 908
 909     /**
 910      * Copy or alias an array in another object, as appropriate.
 911      *
 912      * @param dstArray    the copy destination array.
 913      * @param dstCount    fill in with the lenth of 'dstArray'.
 914      * @param srcArray    the source array to be copied.
 915      * @param srcCount    the length of items to be copied from the 'srcArray'.
 916      */
 917     static void assignArray(UnicodeString*& dstArray,
 918                             int32_t& dstCount,
 919                             const UnicodeString* srcArray,
 920                             int32_t srcCount);
 921
 922     /**
 923      * Return true if the given arrays' contents are equal, or if the arrays are
 924      * identical (pointers are equal).
 925      *
 926      * @param array1   one array to be compared with.
 927      * @param array2   another array to be compared with.
 928      * @param count    the length of items to be copied.
 929      * @return         true if the given arrays' contents are equal, or if the arrays are
 930      *                 identical (pointers are equal).
 931      */
 932     static UBool arrayCompare(const UnicodeString* array1,
 933                              const UnicodeString* array2,
 934                              int32_t count);
 935
 936     /**
 937      * Create a copy, in fZoneStrings, of the given zone strings array. The
 938      * member variables fZoneStringsRowCount and fZoneStringsColCount should be
 939      * set already by the caller.
 940      */
 941     void createZoneStrings(const UnicodeString *const * otherStrings);
 942
 943     /**
 944      * Delete all the storage owned by this object.
 945      */
 946     void dispose(void);
 947
 948     /**
 949      * Copy all of the other's data to this.
 950      * @param other the object to be copied.
 951      */
 952     void copyData(const DateFormatSymbols& other);
 953
 954     /**
 955      * Create zone strings array by locale if not yet available
 956      */
 957     void initZoneStringsArray(void);
 958
 959     /**
 960      * Delete just the zone strings.
 961      */
 962     void disposeZoneStrings(void);
 963
 964     /**
 965      * Returns the date format field index of the pattern character c,
 966      * or UDAT_FIELD_COUNT if c is not a pattern character.
 967      */
 968     static UDateFormatField U_EXPORT2 getPatternCharIndex(UChar c);
 969
 970     /**
 971      * Returns TRUE if f (with its pattern character repeated count times) is a numeric field.
 972      */
 973     static UBool U_EXPORT2 isNumericField(UDateFormatField f, int32_t count);
 974
 975     /**
 976      * Returns TRUE if c (repeated count times) is the pattern character for a numeric field.
 977      */
 978     static UBool U_EXPORT2 isNumericPatternChar(UChar c, int32_t count);
 979 public:
 980 #ifndef U_HIDE_INTERNAL_API
 981     /**
 982      * Gets a DateFormatSymbols by locale.
 983      * Unlike the constructors which always use gregorian calendar, this
 984      * method uses the calendar in the locale. If the locale contains no
 985      * explicit calendar, this method uses the default calendar for that
 986      * locale.
 987      * @param locale the locale.
 988      * @param status error returned here.
 989      * @return the new DateFormatSymbols which the caller owns.
 990      * @internal For ICU use only.
 991      */
 992     static DateFormatSymbols * U_EXPORT2 createForLocale(
 993             const Locale &locale, UErrorCode &status);
 994
 995     /**
 996      * Apple addition
 997      * Get whether to capitalize based on usage.
 998      * @param usage the usage.
 999      * @param context 0 for menu, 1 for standalone
1000      * @return TRUE to capitalize, FALSE otherwise
1001      * @internal For ICU use only.
1002      */
1003     UBool capitalizeForUsage(ECapitalizationContextUsageType usage, int32_t context) const;
1004 #endif  /* U_HIDE_INTERNAL_API */
1005 };
1006
1007 inline UBool
1008 DateFormatSymbols::capitalizeForUsage(DateFormatSymbols::ECapitalizationContextUsageType usage, int32_t context) const
1009 {
1010     return fCapitalization[usage][context];
1011 }
1012
1013 U_NAMESPACE_END
1014
1015 #endif /* #if !UCONFIG_NO_FORMATTING */
1016
1017 #endif // _DTFMTSYM
1018 //eof