ICU 52.1  52.1
dtfmtsym.h
Go to the documentation of this file.
1 /*
2 ********************************************************************************
3 * Copyright (C) 1997-2013, 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 
37 
38 /* forward declaration */
39 class SimpleDateFormat;
40 class Hashtable;
41 
80 public:
95 
106  DateFormatSymbols(const Locale& locale,
107  UErrorCode& status);
108 
109 #ifndef U_HIDE_INTERNAL_API
110 
126  DateFormatSymbols(const char *type, UErrorCode& status);
127 
141  DateFormatSymbols(const Locale& locale,
142  const char *type,
143  UErrorCode& status);
144 #endif /* U_HIDE_INTERNAL_API */
145 
151 
156  DateFormatSymbols& operator=(const DateFormatSymbols&);
157 
163  virtual ~DateFormatSymbols();
164 
172  UBool operator==(const DateFormatSymbols& other) const;
173 
181  UBool operator!=(const DateFormatSymbols& other) const { return !operator==(other); }
182 
190  const UnicodeString* getEras(int32_t& count) const;
191 
198  void setEras(const UnicodeString* eras, int32_t count);
199 
207  const UnicodeString* getEraNames(int32_t& count) const;
208 
215  void setEraNames(const UnicodeString* eraNames, int32_t count);
216 
224  const UnicodeString* getNarrowEras(int32_t& count) const;
225 
232  void setNarrowEras(const UnicodeString* narrowEras, int32_t count);
233 
240  const UnicodeString* getMonths(int32_t& count) const;
241 
249  void setMonths(const UnicodeString* months, int32_t count);
250 
258  const UnicodeString* getShortMonths(int32_t& count) const;
259 
266  void setShortMonths(const UnicodeString* shortMonths, int32_t count);
267 
273  FORMAT,
274  STANDALONE,
275  DT_CONTEXT_COUNT
276  };
277 
282  enum DtWidthType {
283  ABBREVIATED,
284  WIDE,
285  NARROW,
286 #ifndef U_HIDE_DRAFT_API
287 
292 #endif /* U_HIDE_DRAFT_API */
293 
295  DT_WIDTH_COUNT = 4
296  };
297 
306  const UnicodeString* getMonths(int32_t& count, DtContextType context, DtWidthType width) const;
307 
317  void setMonths(const UnicodeString* months, int32_t count, DtContextType context, DtWidthType width);
318 
325  const UnicodeString* getWeekdays(int32_t& count) const;
326 
327 
334  void setWeekdays(const UnicodeString* weekdays, int32_t count);
335 
343  const UnicodeString* getShortWeekdays(int32_t& count) const;
344 
352  void setShortWeekdays(const UnicodeString* abbrevWeekdays, int32_t count);
353 
362  const UnicodeString* getWeekdays(int32_t& count, DtContextType context, DtWidthType width) const;
363 
372  void setWeekdays(const UnicodeString* weekdays, int32_t count, DtContextType context, DtWidthType width);
373 
383  const UnicodeString* getQuarters(int32_t& count, DtContextType context, DtWidthType width) const;
384 
395  void setQuarters(const UnicodeString* quarters, int32_t count, DtContextType context, DtWidthType width);
396 
403  const UnicodeString* getAmPmStrings(int32_t& count) const;
404 
411  void setAmPmStrings(const UnicodeString* ampms, int32_t count);
412 
413 #ifndef U_HIDE_INTERNAL_API
414 
423  {
424  kLeapMonthPatternFormatWide,
425  kLeapMonthPatternFormatAbbrev,
426  kLeapMonthPatternFormatNarrow,
427  kLeapMonthPatternStandaloneWide,
428  kLeapMonthPatternStandaloneAbbrev,
429  kLeapMonthPatternStandaloneNarrow,
430  kLeapMonthPatternNumeric,
431  kMonthPatternsCount
432  };
433 
446  const UnicodeString* getLeapMonthPatterns(int32_t& count) const;
447 
448 #endif /* U_HIDE_INTERNAL_API */
449 
450 #ifndef U_HIDE_DEPRECATED_API
451 
458  const UnicodeString** getZoneStrings(int32_t& rowCount, int32_t& columnCount) const;
459 #endif /* U_HIDE_DEPRECATED_API */
460 
472  void setZoneStrings(const UnicodeString* const* strings, int32_t rowCount, int32_t columnCount);
473 
479  static const UChar * U_EXPORT2 getPatternUChars(void);
480 
491  UnicodeString& getLocalPatternChars(UnicodeString& result) const;
492 
499  void setLocalPatternChars(const UnicodeString& newLocalPatternChars);
500 
506  Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
507 
513  {
514  kCapContextUsageOther,
515  kCapContextUsageMonthFormat, /* except narrow */
516  kCapContextUsageMonthStandalone, /* except narrow */
517  kCapContextUsageMonthNarrow,
518  kCapContextUsageDayFormat, /* except narrow */
519  kCapContextUsageDayStandalone, /* except narrow */
520  kCapContextUsageDayNarrow,
521  kCapContextUsageEraWide,
522  kCapContextUsageEraAbbrev,
523  kCapContextUsageEraNarrow,
524  kCapContextUsageZoneLong,
525  kCapContextUsageZoneShort,
526  kCapContextUsageMetazoneLong,
527  kCapContextUsageMetazoneShort,
528  kCapContextUsageTypeCount
529  };
530 
536  virtual UClassID getDynamicClassID() const;
537 
543  static UClassID U_EXPORT2 getStaticClassID();
544 
545 private:
546 
547  friend class SimpleDateFormat;
548  friend class DateFormatSymbolsSingleSetter; // see udat.cpp
549 
553  UnicodeString* fEras;
554  int32_t fErasCount;
555 
559  UnicodeString* fEraNames;
560  int32_t fEraNamesCount;
561 
565  UnicodeString* fNarrowEras;
566  int32_t fNarrowErasCount;
567 
571  UnicodeString* fMonths;
572  int32_t fMonthsCount;
573 
577  UnicodeString* fShortMonths;
578  int32_t fShortMonthsCount;
579 
583  UnicodeString* fNarrowMonths;
584  int32_t fNarrowMonthsCount;
585 
589  UnicodeString* fStandaloneMonths;
590  int32_t fStandaloneMonthsCount;
591 
595  UnicodeString* fStandaloneShortMonths;
596  int32_t fStandaloneShortMonthsCount;
597 
601  UnicodeString* fStandaloneNarrowMonths;
602  int32_t fStandaloneNarrowMonthsCount;
603 
607  UnicodeString* fWeekdays;
608  int32_t fWeekdaysCount;
609 
613  UnicodeString* fShortWeekdays;
614  int32_t fShortWeekdaysCount;
615 
619  UnicodeString* fShorterWeekdays;
620  int32_t fShorterWeekdaysCount;
621 
625  UnicodeString* fNarrowWeekdays;
626  int32_t fNarrowWeekdaysCount;
627 
631  UnicodeString* fStandaloneWeekdays;
632  int32_t fStandaloneWeekdaysCount;
633 
637  UnicodeString* fStandaloneShortWeekdays;
638  int32_t fStandaloneShortWeekdaysCount;
639 
643  UnicodeString* fStandaloneShorterWeekdays;
644  int32_t fStandaloneShorterWeekdaysCount;
645 
649  UnicodeString* fStandaloneNarrowWeekdays;
650  int32_t fStandaloneNarrowWeekdaysCount;
651 
655  UnicodeString* fAmPms;
656  int32_t fAmPmsCount;
657 
661  UnicodeString *fQuarters;
662  int32_t fQuartersCount;
663 
667  UnicodeString *fShortQuarters;
668  int32_t fShortQuartersCount;
669 
673  UnicodeString *fStandaloneQuarters;
674  int32_t fStandaloneQuartersCount;
675 
679  UnicodeString *fStandaloneShortQuarters;
680  int32_t fStandaloneShortQuartersCount;
681 
685  UnicodeString *fLeapMonthPatterns;
686  int32_t fLeapMonthPatternsCount;
687 
691  UnicodeString* fShortYearNames;
692  int32_t fShortYearNamesCount;
693 
731  UnicodeString **fZoneStrings; // Zone string array set by setZoneStrings
732  UnicodeString **fLocaleZoneStrings; // Zone string array created by the locale
733  int32_t fZoneStringsRowCount;
734  int32_t fZoneStringsColCount;
735 
736  Locale fZSFLocale; // Locale used for getting ZoneStringFormat
737 
741  UnicodeString fLocalPatternChars;
742 
748  UBool fCapitalization[kCapContextUsageTypeCount][2];
749 
750 private:
754  char validLocale[ULOC_FULLNAME_CAPACITY];
755  char actualLocale[ULOC_FULLNAME_CAPACITY];
756 
757  DateFormatSymbols(); // default constructor not implemented
758 
768  void initializeData(const Locale& locale, const char *type, UErrorCode& status, UBool useLastResortData = FALSE);
769 
778  static void assignArray(UnicodeString*& dstArray,
779  int32_t& dstCount,
780  const UnicodeString* srcArray,
781  int32_t srcCount);
782 
793  static UBool arrayCompare(const UnicodeString* array1,
794  const UnicodeString* array2,
795  int32_t count);
796 
802  void createZoneStrings(const UnicodeString *const * otherStrings);
803 
807  void dispose(void);
808 
813  void copyData(const DateFormatSymbols& other);
814 
818  void initZoneStringsArray(void);
819 
823  void disposeZoneStrings(void);
824 
829  static UDateFormatField U_EXPORT2 getPatternCharIndex(UChar c);
830 
834  static UBool U_EXPORT2 isNumericField(UDateFormatField f, int32_t count);
835 
839  static UBool U_EXPORT2 isNumericPatternChar(UChar c, int32_t count);
840 };
841 
843 
844 #endif /* #if !UCONFIG_NO_FORMATTING */
845 
846 #endif // _DTFMTSYM
847 //eof
virtual UClassID getDynamicClassID() const
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.
DateFormatSymbols is a public class for encapsulating localizable date-time formatting data – includ...
Definition: dtfmtsym.h:79
Short width is currently only supported for weekday names.
Definition: dtfmtsym.h:291
EMonthPatternType
Somewhat temporary constants for leap month pattern types, adequate for supporting just leap month pa...
Definition: dtfmtsym.h:422
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:91
#define ULOC_FULLNAME_CAPACITY
Useful constant for the maximum size of the whole locale ID (including the terminating NULL and all k...
Definition: uloc.h:262
DtContextType
Selector for date formatting context.
Definition: dtfmtsym.h:272
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:358
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
C++ API: Calendar object.
C API: DateFormat.
C++ API: Common ICU base class UObject.
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:278
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
UDateFormatField
FieldPosition and UFieldPosition selectors for format fields defined by DateFormat and UDateFormat...
Definition: udat.h:495
DtWidthType
Selector for date formatting width.
Definition: dtfmtsym.h:282
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
SimpleDateFormat is a concrete class for formatting and parsing dates in a language-independent manne...
Definition: smpdtfmt.h:705
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested...
Definition: uloc.h:336
C++ API: Locale ID object.
Basic definitions for ICU, for both C and C++ APIs.
UBool operator!=(const DateFormatSymbols &other) const
Return true if another object is semantically unequal to this one.
Definition: dtfmtsym.h:181
#define FALSE
The FALSE value of a UBool.
Definition: umachine.h:208
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:245
ECapitalizationContextUsageType
Constants for capitalization context usage types.
Definition: dtfmtsym.h:512
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:221
C API: Resource Bundle.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:200
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:185