ICU 53.1  53.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dtfmtsym.h
Go to the documentation of this file.
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 
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,
293  DT_WIDTH_COUNT = 4
294  };
295 
304  const UnicodeString* getMonths(int32_t& count, DtContextType context, DtWidthType width) const;
305 
315  void setMonths(const UnicodeString* months, int32_t count, DtContextType context, DtWidthType width);
316 
323  const UnicodeString* getWeekdays(int32_t& count) const;
324 
325 
332  void setWeekdays(const UnicodeString* weekdays, int32_t count);
333 
341  const UnicodeString* getShortWeekdays(int32_t& count) const;
342 
350  void setShortWeekdays(const UnicodeString* abbrevWeekdays, int32_t count);
351 
360  const UnicodeString* getWeekdays(int32_t& count, DtContextType context, DtWidthType width) const;
361 
370  void setWeekdays(const UnicodeString* weekdays, int32_t count, DtContextType context, DtWidthType width);
371 
381  const UnicodeString* getQuarters(int32_t& count, DtContextType context, DtWidthType width) const;
382 
393  void setQuarters(const UnicodeString* quarters, int32_t count, DtContextType context, DtWidthType width);
394 
401  const UnicodeString* getAmPmStrings(int32_t& count) const;
402 
409  void setAmPmStrings(const UnicodeString* ampms, int32_t count);
410 
411 #ifndef U_HIDE_INTERNAL_API
412 
421  {
422  kLeapMonthPatternFormatWide,
423  kLeapMonthPatternFormatAbbrev,
424  kLeapMonthPatternFormatNarrow,
425  kLeapMonthPatternStandaloneWide,
426  kLeapMonthPatternStandaloneAbbrev,
427  kLeapMonthPatternStandaloneNarrow,
428  kLeapMonthPatternNumeric,
429  kMonthPatternsCount
430  };
431 
444  const UnicodeString* getLeapMonthPatterns(int32_t& count) const;
445 
446 #endif /* U_HIDE_INTERNAL_API */
447 
448 #ifndef U_HIDE_DEPRECATED_API
449 
456  const UnicodeString** getZoneStrings(int32_t& rowCount, int32_t& columnCount) const;
457 #endif /* U_HIDE_DEPRECATED_API */
458 
470  void setZoneStrings(const UnicodeString* const* strings, int32_t rowCount, int32_t columnCount);
471 
477  static const UChar * U_EXPORT2 getPatternUChars(void);
478 
489  UnicodeString& getLocalPatternChars(UnicodeString& result) const;
490 
497  void setLocalPatternChars(const UnicodeString& newLocalPatternChars);
498 
504  Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
505 
506  /* The following type and kCapContextUsageTypeCount cannot be #ifndef U_HIDE_INTERNAL_API,
507  they are needed for .h file declarations. */
513  {
514 #ifndef U_HIDE_INTERNAL_API
515  kCapContextUsageOther = 0,
516  kCapContextUsageMonthFormat, /* except narrow */
517  kCapContextUsageMonthStandalone, /* except narrow */
518  kCapContextUsageMonthNarrow,
519  kCapContextUsageDayFormat, /* except narrow */
520  kCapContextUsageDayStandalone, /* except narrow */
521  kCapContextUsageDayNarrow,
522  kCapContextUsageEraWide,
523  kCapContextUsageEraAbbrev,
524  kCapContextUsageEraNarrow,
525  kCapContextUsageZoneLong,
526  kCapContextUsageZoneShort,
527  kCapContextUsageMetazoneLong,
528  kCapContextUsageMetazoneShort,
529 #endif /* U_HIDE_INTERNAL_API */
530  kCapContextUsageTypeCount = 14
531  };
532 
538  virtual UClassID getDynamicClassID() const;
539 
545  static UClassID U_EXPORT2 getStaticClassID();
546 
547 private:
548 
549  friend class SimpleDateFormat;
550  friend class DateFormatSymbolsSingleSetter; // see udat.cpp
551 
555  UnicodeString* fEras;
556  int32_t fErasCount;
557 
561  UnicodeString* fEraNames;
562  int32_t fEraNamesCount;
563 
567  UnicodeString* fNarrowEras;
568  int32_t fNarrowErasCount;
569 
573  UnicodeString* fMonths;
574  int32_t fMonthsCount;
575 
579  UnicodeString* fShortMonths;
580  int32_t fShortMonthsCount;
581 
585  UnicodeString* fNarrowMonths;
586  int32_t fNarrowMonthsCount;
587 
591  UnicodeString* fStandaloneMonths;
592  int32_t fStandaloneMonthsCount;
593 
597  UnicodeString* fStandaloneShortMonths;
598  int32_t fStandaloneShortMonthsCount;
599 
603  UnicodeString* fStandaloneNarrowMonths;
604  int32_t fStandaloneNarrowMonthsCount;
605 
609  UnicodeString* fWeekdays;
610  int32_t fWeekdaysCount;
611 
615  UnicodeString* fShortWeekdays;
616  int32_t fShortWeekdaysCount;
617 
621  UnicodeString* fShorterWeekdays;
622  int32_t fShorterWeekdaysCount;
623 
627  UnicodeString* fNarrowWeekdays;
628  int32_t fNarrowWeekdaysCount;
629 
633  UnicodeString* fStandaloneWeekdays;
634  int32_t fStandaloneWeekdaysCount;
635 
639  UnicodeString* fStandaloneShortWeekdays;
640  int32_t fStandaloneShortWeekdaysCount;
641 
645  UnicodeString* fStandaloneShorterWeekdays;
646  int32_t fStandaloneShorterWeekdaysCount;
647 
651  UnicodeString* fStandaloneNarrowWeekdays;
652  int32_t fStandaloneNarrowWeekdaysCount;
653 
657  UnicodeString* fAmPms;
658  int32_t fAmPmsCount;
659 
663  UnicodeString *fQuarters;
664  int32_t fQuartersCount;
665 
669  UnicodeString *fShortQuarters;
670  int32_t fShortQuartersCount;
671 
675  UnicodeString *fStandaloneQuarters;
676  int32_t fStandaloneQuartersCount;
677 
681  UnicodeString *fStandaloneShortQuarters;
682  int32_t fStandaloneShortQuartersCount;
683 
687  UnicodeString *fLeapMonthPatterns;
688  int32_t fLeapMonthPatternsCount;
689 
693  UnicodeString* fShortYearNames;
694  int32_t fShortYearNamesCount;
695 
733  UnicodeString **fZoneStrings; // Zone string array set by setZoneStrings
734  UnicodeString **fLocaleZoneStrings; // Zone string array created by the locale
735  int32_t fZoneStringsRowCount;
736  int32_t fZoneStringsColCount;
737 
738  Locale fZSFLocale; // Locale used for getting ZoneStringFormat
739 
743  UnicodeString fLocalPatternChars;
744 
750  UBool fCapitalization[kCapContextUsageTypeCount][2];
751 
752 private:
756  char validLocale[ULOC_FULLNAME_CAPACITY];
757  char actualLocale[ULOC_FULLNAME_CAPACITY];
758 
759  DateFormatSymbols(); // default constructor not implemented
760 
770  void initializeData(const Locale& locale, const char *type, UErrorCode& status, UBool useLastResortData = FALSE);
771 
780  static void assignArray(UnicodeString*& dstArray,
781  int32_t& dstCount,
782  const UnicodeString* srcArray,
783  int32_t srcCount);
784 
795  static UBool arrayCompare(const UnicodeString* array1,
796  const UnicodeString* array2,
797  int32_t count);
798 
804  void createZoneStrings(const UnicodeString *const * otherStrings);
805 
809  void dispose(void);
810 
815  void copyData(const DateFormatSymbols& other);
816 
820  void initZoneStringsArray(void);
821 
825  void disposeZoneStrings(void);
826 
831  static UDateFormatField U_EXPORT2 getPatternCharIndex(UChar c);
832 
836  static UBool U_EXPORT2 isNumericField(UDateFormatField f, int32_t count);
837 
841  static UBool U_EXPORT2 isNumericPatternChar(UChar c, int32_t count);
842 };
843 
845 
846 #endif /* #if !UCONFIG_NO_FORMATTING */
847 
848 #endif // _DTFMTSYM
849 //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 – includi...
Definition: dtfmtsym.h:79
Short width is currently only supported for weekday names.
Definition: dtfmtsym.h:290
EMonthPatternType
Somewhat temporary constants for leap month pattern types, adequate for supporting just leap month pa...
Definition: dtfmtsym.h:420
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:487
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:707
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