icuSources/i18n/unicode/dtfmtsym.h

   1 /*
   2 ********************************************************************************
   3 *   Copyright (C) 1997-2014, 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 : 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      * Somewhat temporary constants for leap month pattern types, adequate for supporting
 414      * just leap month patterns as needed for Chinese lunar calendar.
 415      * Eventually we will add full support for different month pattern types (needed for
 416      * other calendars such as Hindu) at which point this approach will be replaced by a
 417      * more complete approach.
 418      * @internal
 419      */
 420     enum EMonthPatternType
 421     {
 422         kLeapMonthPatternFormatWide,
 423         kLeapMonthPatternFormatAbbrev,
 424         kLeapMonthPatternFormatNarrow,
 425         kLeapMonthPatternStandaloneWide,
 426         kLeapMonthPatternStandaloneAbbrev,
 427         kLeapMonthPatternStandaloneNarrow,
 428         kLeapMonthPatternNumeric,
 429         kMonthPatternsCount
 430     };
 431
 432     /**
 433      * Somewhat temporary function for getting complete set of leap month patterns for all
 434      * contexts & widths, indexed by EMonthPatternType values. Returns NULL if calendar
 435      * does not have leap month patterns. Note, there is currently no setter for this.
 436      * Eventually we will add full support for different month pattern types (needed for
 437      * other calendars such as Hindu) at which point this approach will be replaced by a
 438      * more complete approach.
 439      * @param count        Filled in with length of the array (may be 0).
 440      * @return             The leap month patterns (DateFormatSymbols retains ownership).
 441      *                     May be NULL if there are no leap month patterns for this calendar.
 442      * @internal
 443      */
 444     const UnicodeString* getLeapMonthPatterns(int32_t& count) const;
 445
 446     /**
 447      * Apple addition to get zodiac names. Returns NULL if calendar
 448      * does not have zodiac names. Note, there is currently no setter for this.
 449      * @param count        Filled in with length of the array (may be 0).
 450      * @return             The zodiac names (DateFormatSymbols retains ownership).
 451      *                     May be NULL if there are no zodiac names for this calendar.
 452      * @internal
 453      */
 454     const UnicodeString* getZodiacNames(int32_t& count) const;
 455
 456 #endif  /* U_HIDE_INTERNAL_API */
 457
 458 #ifndef U_HIDE_DEPRECATED_API
 459     /**
 460      * Gets timezone strings. These strings are stored in a 2-dimensional array.
 461      * @param rowCount      Output param to receive number of rows.
 462      * @param columnCount   Output param to receive number of columns.
 463      * @return              The timezone strings as a 2-d array. (DateFormatSymbols retains ownership.)
 464      * @deprecated ICU 3.6
 465      */
 466     const UnicodeString** getZoneStrings(int32_t& rowCount, int32_t& columnCount) const;
 467 #endif  /* U_HIDE_DEPRECATED_API */
 468
 469     /**
 470      * Sets timezone strings. These strings are stored in a 2-dimensional array.
 471      * <p><b>Note:</b> SimpleDateFormat no longer use the zone strings stored in
 472      * a DateFormatSymbols. Therefore, the time zone strings set by this mthod
 473      * have no effects in an instance of SimpleDateFormat for formatting time
 474      * zones.
 475      * @param strings       The timezone strings as a 2-d array to be copied. (not adopted; caller retains ownership)
 476      * @param rowCount      The number of rows (count of first index).
 477      * @param columnCount   The number of columns (count of second index).
 478      * @stable ICU 2.0
 479      */
 480     void setZoneStrings(const UnicodeString* const* strings, int32_t rowCount, int32_t columnCount);
 481
 482     /**
 483      * Get the non-localized date-time pattern characters.
 484      * @return    the non-localized date-time pattern characters
 485      * @stable ICU 2.0
 486      */
 487     static const UChar * U_EXPORT2 getPatternUChars(void);
 488
 489     /**
 490      * Gets localized date-time pattern characters. For example: 'u', 't', etc.
 491      * <p>
 492      * Note: ICU no longer provides localized date-time pattern characters for a locale
 493      * starting ICU 3.8.  This method returns the non-localized date-time pattern
 494      * characters unless user defined localized data is set by setLocalPatternChars.
 495      * @param result    Output param which will receive the localized date-time pattern characters.
 496      * @return          A reference to 'result'.
 497      * @stable ICU 2.0
 498      */
 499     UnicodeString& getLocalPatternChars(UnicodeString& result) const;
 500
 501     /**
 502      * Sets localized date-time pattern characters. For example: 'u', 't', etc.
 503      * @param newLocalPatternChars the new localized date-time
 504      * pattern characters.
 505      * @stable ICU 2.0
 506      */
 507     void setLocalPatternChars(const UnicodeString& newLocalPatternChars);
 508
 509     /**
 510      * Returns the locale for this object. Two flavors are available:
 511      * valid and actual locale.
 512      * @stable ICU 2.8
 513      */
 514     Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
 515
 516     /* The following type and kCapContextUsageTypeCount cannot be #ifndef U_HIDE_INTERNAL_API,
 517        they are needed for .h file declarations. */
 518     /**
 519      * Constants for capitalization context usage types.
 520      * @internal
 521      */
 522     enum ECapitalizationContextUsageType
 523     {
 524 #ifndef U_HIDE_INTERNAL_API
 525         kCapContextUsageOther = 0,
 526         kCapContextUsageMonthFormat,     /* except narrow */
 527         kCapContextUsageMonthStandalone, /* except narrow */
 528         kCapContextUsageMonthNarrow,
 529         kCapContextUsageDayFormat,     /* except narrow */
 530         kCapContextUsageDayStandalone, /* except narrow */
 531         kCapContextUsageDayNarrow,
 532         kCapContextUsageEraWide,
 533         kCapContextUsageEraAbbrev,
 534         kCapContextUsageEraNarrow,
 535         kCapContextUsageZoneLong,
 536         kCapContextUsageZoneShort,
 537         kCapContextUsageMetazoneLong,
 538         kCapContextUsageMetazoneShort,
 539 #endif /* U_HIDE_INTERNAL_API */
 540         kCapContextUsageTypeCount = 14
 541     };
 542
 543     /**
 544      * ICU "poor man's RTTI", returns a UClassID for the actual class.
 545      *
 546      * @stable ICU 2.2
 547      */
 548     virtual UClassID getDynamicClassID() const;
 549
 550     /**
 551      * ICU "poor man's RTTI", returns a UClassID for this class.
 552      *
 553      * @stable ICU 2.2
 554      */
 555     static UClassID U_EXPORT2 getStaticClassID();
 556
 557 private:
 558
 559     friend class SimpleDateFormat;
 560     friend class DateFormatSymbolsSingleSetter; // see udat.cpp
 561
 562     /**
 563      * Abbreviated era strings. For example: "AD" and "BC".
 564      */
 565     UnicodeString*  fEras;
 566     int32_t         fErasCount;
 567
 568     /**
 569      * Era name strings. For example: "Anno Domini" and "Before Christ".
 570      */
 571     UnicodeString*  fEraNames;
 572     int32_t         fEraNamesCount;
 573
 574     /**
 575      * Narrow era strings. For example: "A" and "B".
 576      */
 577     UnicodeString*  fNarrowEras;
 578     int32_t         fNarrowErasCount;
 579
 580     /**
 581      * Month strings. For example: "January", "February", etc.
 582      */
 583     UnicodeString*  fMonths;
 584     int32_t         fMonthsCount;
 585
 586     /**
 587      * Short month strings. For example: "Jan", "Feb", etc.
 588      */
 589     UnicodeString*  fShortMonths;
 590     int32_t         fShortMonthsCount;
 591
 592     /**
 593      * Narrow month strings. For example: "J", "F", etc.
 594      */
 595     UnicodeString*  fNarrowMonths;
 596     int32_t         fNarrowMonthsCount;
 597
 598     /**
 599      * Standalone Month strings. For example: "January", "February", etc.
 600      */
 601     UnicodeString*  fStandaloneMonths;
 602     int32_t         fStandaloneMonthsCount;
 603
 604     /**
 605      * Standalone Short month strings. For example: "Jan", "Feb", etc.
 606      */
 607     UnicodeString*  fStandaloneShortMonths;
 608     int32_t         fStandaloneShortMonthsCount;
 609
 610     /**
 611      * Standalone Narrow month strings. For example: "J", "F", etc.
 612      */
 613     UnicodeString*  fStandaloneNarrowMonths;
 614     int32_t         fStandaloneNarrowMonthsCount;
 615
 616     /**
 617      * CLDR-style format wide weekday strings. For example: "Sunday", "Monday", etc.
 618      */
 619     UnicodeString*  fWeekdays;
 620     int32_t         fWeekdaysCount;
 621
 622     /**
 623      * CLDR-style format abbreviated (not short) weekday strings. For example: "Sun", "Mon", etc.
 624      */
 625     UnicodeString*  fShortWeekdays;
 626     int32_t         fShortWeekdaysCount;
 627
 628     /**
 629      * CLDR-style format short weekday strings. For example: "Su", "Mo", etc.
 630      */
 631     UnicodeString*  fShorterWeekdays;
 632     int32_t         fShorterWeekdaysCount;
 633
 634     /**
 635      * CLDR-style format narrow weekday strings. For example: "S", "M", etc.
 636      */
 637     UnicodeString*  fNarrowWeekdays;
 638     int32_t         fNarrowWeekdaysCount;
 639
 640     /**
 641      * CLDR-style standalone wide weekday strings. For example: "Sunday", "Monday", etc.
 642      */
 643     UnicodeString*  fStandaloneWeekdays;
 644     int32_t         fStandaloneWeekdaysCount;
 645
 646     /**
 647      * CLDR-style standalone abbreviated (not short) weekday strings. For example: "Sun", "Mon", etc.
 648      */
 649     UnicodeString*  fStandaloneShortWeekdays;
 650     int32_t         fStandaloneShortWeekdaysCount;
 651
 652     /**
 653      * CLDR-style standalone short weekday strings. For example: "Su", "Mo", etc.
 654      */
 655     UnicodeString*  fStandaloneShorterWeekdays;
 656     int32_t         fStandaloneShorterWeekdaysCount;
 657
 658     /**
 659      * Standalone Narrow weekday strings. For example: "Sun", "Mon", etc.
 660      */
 661     UnicodeString*  fStandaloneNarrowWeekdays;
 662     int32_t         fStandaloneNarrowWeekdaysCount;
 663
 664     /**
 665      * Ampm strings. For example: "AM" and "PM".
 666      */
 667     UnicodeString*  fAmPms;
 668     int32_t         fAmPmsCount;
 669
 670     /**
 671      * Quarter strings. For example: "1st quarter", "2nd quarter", etc.
 672      */
 673     UnicodeString  *fQuarters;
 674     int32_t         fQuartersCount;
 675
 676     /**
 677      * Short quarters. For example: "Q1", "Q2", etc.
 678      */
 679     UnicodeString  *fShortQuarters;
 680     int32_t         fShortQuartersCount;
 681
 682     /**
 683      * Standalone quarter strings. For example: "1st quarter", "2nd quarter", etc.
 684      */
 685     UnicodeString  *fStandaloneQuarters;
 686     int32_t         fStandaloneQuartersCount;
 687
 688     /**
 689      * Standalone short quarter strings. For example: "Q1", "Q2", etc.
 690      */
 691     UnicodeString  *fStandaloneShortQuarters;
 692     int32_t         fStandaloneShortQuartersCount;
 693
 694     /**
 695      * All leap month patterns, for example "{0}bis".
 696      */
 697     UnicodeString  *fLeapMonthPatterns;
 698     int32_t         fLeapMonthPatternsCount;
 699
 700     /**
 701      * (Format) Short cyclic year names, for example: "jia-zi", "yi-chou", ... "gui-hai"
 702      */
 703     UnicodeString*  fShortYearNames;
 704     int32_t         fShortYearNamesCount;
 705
 706     /**
 707      * (Format) Short cyclic zodiac names - Apple addition for now
 708      */
 709     UnicodeString*  fShortZodiacNames;
 710     int32_t         fShortZodiacNamesCount;
 711
 712     /**
 713      * Localized names of time zones in this locale.  This is a
 714      * two-dimensional array of strings of size n by m,
 715      * where m is at least 5 and up to 7.  Each of the n rows is an
 716      * entry containing the localized names for a single TimeZone.
 717      *
 718      * Each such row contains (with i ranging from 0..n-1):
 719      *
 720      * zoneStrings[i][0] - time zone ID
 721      *  example: America/Los_Angeles
 722      * zoneStrings[i][1] - long name of zone in standard time
 723      *  example: Pacific Standard Time
 724      * zoneStrings[i][2] - short name of zone in standard time
 725      *  example: PST
 726      * zoneStrings[i][3] - long name of zone in daylight savings time
 727      *  example: Pacific Daylight Time
 728      * zoneStrings[i][4] - short name of zone in daylight savings time
 729      *  example: PDT
 730      * zoneStrings[i][5] - location name of zone
 731      *  example: United States (Los Angeles)
 732      * zoneStrings[i][6] - long generic name of zone
 733      *  example: Pacific Time
 734      * zoneStrings[i][7] - short generic of zone
 735      *  example: PT
 736      *
 737      * The zone ID is not localized; it corresponds to the ID
 738      * value associated with a system time zone object.  All other entries
 739      * are localized names.  If a zone does not implement daylight savings
 740      * time, the daylight savings time names are ignored.
 741      *
 742      * Note:CLDR 1.5 introduced metazone and its historical mappings.
 743      * This simple two-dimensional array is no longer sufficient to represent
 744      * localized names and its historic changes.  Since ICU 3.8.1, localized
 745      * zone names extracted from ICU locale data is stored in a ZoneStringFormat
 746      * instance.  But we still need to support the old way of customizing
 747      * localized zone names, so we keep this field for the purpose.
 748      */
 749     UnicodeString   **fZoneStrings;         // Zone string array set by setZoneStrings
 750     UnicodeString   **fLocaleZoneStrings;   // Zone string array created by the locale
 751     int32_t         fZoneStringsRowCount;
 752     int32_t         fZoneStringsColCount;
 753
 754     Locale                  fZSFLocale;         // Locale used for getting ZoneStringFormat
 755
 756     /**
 757      * Localized date-time pattern characters. For example: use 'u' as 'y'.
 758      */
 759     UnicodeString   fLocalPatternChars;
 760
 761     /**
 762      * Capitalization transforms. For each usage type, the first array element indicates
 763      * whether to titlecase for uiListOrMenu context, the second indicates whether to
 764      * titlecase for stand-alone context.
 765      */
 766      UBool fCapitalization[kCapContextUsageTypeCount][2];
 767
 768 private:
 769     /** valid/actual locale information
 770      *  these are always ICU locales, so the length should not be a problem
 771      */
 772     char validLocale[ULOC_FULLNAME_CAPACITY];
 773     char actualLocale[ULOC_FULLNAME_CAPACITY];
 774
 775     DateFormatSymbols(); // default constructor not implemented
 776
 777     /**
 778      * Called by the constructors to actually load data from the resources
 779      *
 780      * @param locale               The locale to get symbols for.
 781      * @param type                 Calendar Type (as from Calendar::getType())
 782      * @param status               Input/output parameter, set to success or
 783      *                             failure code upon return.
 784      * @param useLastResortData    determine if use last resort data
 785      */
 786     void initializeData(const Locale& locale, const char *type, UErrorCode& status, UBool useLastResortData = FALSE);
 787
 788     /**
 789      * Copy or alias an array in another object, as appropriate.
 790      *
 791      * @param dstArray    the copy destination array.
 792      * @param dstCount    fill in with the lenth of 'dstArray'.
 793      * @param srcArray    the source array to be copied.
 794      * @param srcCount    the length of items to be copied from the 'srcArray'.
 795      */
 796     static void assignArray(UnicodeString*& dstArray,
 797                             int32_t& dstCount,
 798                             const UnicodeString* srcArray,
 799                             int32_t srcCount);
 800
 801     /**
 802      * Return true if the given arrays' contents are equal, or if the arrays are
 803      * identical (pointers are equal).
 804      *
 805      * @param array1   one array to be compared with.
 806      * @param array2   another array to be compared with.
 807      * @param count    the length of items to be copied.
 808      * @return         true if the given arrays' contents are equal, or if the arrays are
 809      *                 identical (pointers are equal).
 810      */
 811     static UBool arrayCompare(const UnicodeString* array1,
 812                              const UnicodeString* array2,
 813                              int32_t count);
 814
 815     /**
 816      * Create a copy, in fZoneStrings, of the given zone strings array. The
 817      * member variables fZoneStringsRowCount and fZoneStringsColCount should be
 818      * set already by the caller.
 819      */
 820     void createZoneStrings(const UnicodeString *const * otherStrings);
 821
 822     /**
 823      * Delete all the storage owned by this object.
 824      */
 825     void dispose(void);
 826
 827     /**
 828      * Copy all of the other's data to this.
 829      * @param other the object to be copied.
 830      */
 831     void copyData(const DateFormatSymbols& other);
 832
 833     /**
 834      * Create zone strings array by locale if not yet available
 835      */
 836     void initZoneStringsArray(void);
 837
 838     /**
 839      * Delete just the zone strings.
 840      */
 841     void disposeZoneStrings(void);
 842
 843     /**
 844      * Returns the date format field index of the pattern character c,
 845      * or UDAT_FIELD_COUNT if c is not a pattern character.
 846      */
 847     static UDateFormatField U_EXPORT2 getPatternCharIndex(UChar c);
 848
 849     /**
 850      * Returns TRUE if f (with its pattern character repeated count times) is a numeric field.
 851      */
 852     static UBool U_EXPORT2 isNumericField(UDateFormatField f, int32_t count);
 853
 854     /**
 855      * Returns TRUE if c (repeated count times) is the pattern character for a numeric field.
 856      */
 857     static UBool U_EXPORT2 isNumericPatternChar(UChar c, int32_t count);
 858 };
 859
 860 U_NAMESPACE_END
 861
 862 #endif /* #if !UCONFIG_NO_FORMATTING */
 863
 864 #endif // _DTFMTSYM
 865 //eof