ICU 74.1 74.1

dtfmtsym.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 ********************************************************************************
5 * Copyright (C) 1997-2016, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 ********************************************************************************
8 *
9 * File DTFMTSYM.H
10 *
11 * Modification History:
12 *
13 * Date Name Description
14 * 02/19/97 aliu Converted from java.
15 * 07/21/98 stephen Added getZoneIndex()
16 * Changed to match C++ conventions
17 ********************************************************************************
18 */
19
20 #ifndef DTFMTSYM_H
21 #define DTFMTSYM_H
22
23 #include "unicode/utypes.h"
24
25 #if U_SHOW_CPLUSPLUS_API
26
27 #if !UCONFIG_NO_FORMATTING
28
29 #include "unicode/calendar.h"
30 #include "unicode/strenum.h"
31 #include "unicode/uobject.h"
32 #include "unicode/locid.h"
33 #include "unicode/udat.h"
34 #include "unicode/ures.h"
35
41 U_NAMESPACE_BEGIN
42
43 /* forward declaration */
44 class SimpleDateFormat;
45 class Hashtable;
46
84 class U_I18N_API DateFormatSymbols final : public UObject {
85 public:
99 DateFormatSymbols(UErrorCode& status);
100
111 DateFormatSymbols(const Locale& locale,
112 UErrorCode& status);
113
114 #ifndef U_HIDE_INTERNAL_API
131 DateFormatSymbols(const char *type, UErrorCode& status);
132
146 DateFormatSymbols(const Locale& locale,
147 const char *type,
148 UErrorCode& status);
149 #endif /* U_HIDE_INTERNAL_API */
150
155 DateFormatSymbols(const DateFormatSymbols&);
156
161 DateFormatSymbols& operator=(const DateFormatSymbols&);
162
168 virtual ~DateFormatSymbols();
169
177 bool operator==(const DateFormatSymbols& other) const;
178
186 bool operator!=(const DateFormatSymbols& other) const { return !operator==(other); }
187
195 const UnicodeString* getEras(int32_t& count) const;
196
203 void setEras(const UnicodeString* eras, int32_t count);
204
212 const UnicodeString* getEraNames(int32_t& count) const;
213
220 void setEraNames(const UnicodeString* eraNames, int32_t count);
221
229 const UnicodeString* getNarrowEras(int32_t& count) const;
230
237 void setNarrowEras(const UnicodeString* narrowEras, int32_t count);
238
245 const UnicodeString* getMonths(int32_t& count) const;
246
254 void setMonths(const UnicodeString* months, int32_t count);
255
263 const UnicodeString* getShortMonths(int32_t& count) const;
264
271 void setShortMonths(const UnicodeString* shortMonths, int32_t count);
272
277 enum DtContextType {
278 FORMAT,
279 STANDALONE,
280 #ifndef U_HIDE_DEPRECATED_API
285 DT_CONTEXT_COUNT
286 #endif // U_HIDE_DEPRECATED_API
287 };
288
293 enum DtWidthType {
294 ABBREVIATED,
295 WIDE,
296 NARROW,
301 SHORT,
302 #ifndef U_HIDE_DEPRECATED_API
307 DT_WIDTH_COUNT = 4
308 #endif // U_HIDE_DEPRECATED_API
309 };
310
319 const UnicodeString* getMonths(int32_t& count, DtContextType context, DtWidthType width) const;
320
330 void setMonths(const UnicodeString* months, int32_t count, DtContextType context, DtWidthType width);
331
338 const UnicodeString* getWeekdays(int32_t& count) const;
339
340
347 void setWeekdays(const UnicodeString* weekdays, int32_t count);
348
356 const UnicodeString* getShortWeekdays(int32_t& count) const;
357
365 void setShortWeekdays(const UnicodeString* abbrevWeekdays, int32_t count);
366
375 const UnicodeString* getWeekdays(int32_t& count, DtContextType context, DtWidthType width) const;
376
385 void setWeekdays(const UnicodeString* weekdays, int32_t count, DtContextType context, DtWidthType width);
386
395 const UnicodeString* getQuarters(int32_t& count, DtContextType context, DtWidthType width) const;
396
406 void setQuarters(const UnicodeString* quarters, int32_t count, DtContextType context, DtWidthType width);
407
414 const UnicodeString* getAmPmStrings(int32_t& count) const;
415
422 void setAmPmStrings(const UnicodeString* ampms, int32_t count);
423
424 #ifndef U_HIDE_INTERNAL_API
430 static const char16_t DEFAULT_TIME_SEPARATOR = 0x003a; // ':'
431
436 static const char16_t ALTERNATE_TIME_SEPARATOR = 0x002e; // '.'
437
444 UnicodeString& getTimeSeparatorString(UnicodeString& result) const;
445
451 void setTimeSeparatorString(const UnicodeString& newTimeSeparator);
452 #endif /* U_HIDE_INTERNAL_API */
453
464 const UnicodeString* getYearNames(int32_t& count,
465 DtContextType context, DtWidthType width) const;
466
476 void setYearNames(const UnicodeString* yearNames, int32_t count,
477 DtContextType context, DtWidthType width);
478
489 const UnicodeString* getZodiacNames(int32_t& count,
490 DtContextType context, DtWidthType width) const;
491
501 void setZodiacNames(const UnicodeString* zodiacNames, int32_t count,
502 DtContextType context, DtWidthType width);
503
504 #ifndef U_HIDE_INTERNAL_API
513 enum EMonthPatternType
514 {
515 kLeapMonthPatternFormatWide,
516 kLeapMonthPatternFormatAbbrev,
517 kLeapMonthPatternFormatNarrow,
518 kLeapMonthPatternStandaloneWide,
519 kLeapMonthPatternStandaloneAbbrev,
520 kLeapMonthPatternStandaloneNarrow,
521 kLeapMonthPatternNumeric,
522 kMonthPatternsCount
523 };
524
537 const UnicodeString* getLeapMonthPatterns(int32_t& count) const;
538
539 #endif /* U_HIDE_INTERNAL_API */
540
541 #ifndef U_HIDE_DEPRECATED_API
549 const UnicodeString** getZoneStrings(int32_t& rowCount, int32_t& columnCount) const;
550 #endif /* U_HIDE_DEPRECATED_API */
551
563 void setZoneStrings(const UnicodeString* const* strings, int32_t rowCount, int32_t columnCount);
564
570 static const char16_t * U_EXPORT2 getPatternUChars(void);
571
582 UnicodeString& getLocalPatternChars(UnicodeString& result) const;
583
590 void setLocalPatternChars(const UnicodeString& newLocalPatternChars);
591
597 Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
598
599 /* The following type and kCapContextUsageTypeCount cannot be #ifndef U_HIDE_INTERNAL_API,
600 they are needed for .h file declarations. */
605 enum ECapitalizationContextUsageType
606 {
607 #ifndef U_HIDE_INTERNAL_API
608 kCapContextUsageOther = 0,
609 kCapContextUsageMonthFormat, /* except narrow */
610 kCapContextUsageMonthStandalone, /* except narrow */
611 kCapContextUsageMonthNarrow,
612 kCapContextUsageDayFormat, /* except narrow */
613 kCapContextUsageDayStandalone, /* except narrow */
614 kCapContextUsageDayNarrow,
615 kCapContextUsageEraWide,
616 kCapContextUsageEraAbbrev,
617 kCapContextUsageEraNarrow,
618 kCapContextUsageZoneLong,
619 kCapContextUsageZoneShort,
620 kCapContextUsageMetazoneLong,
621 kCapContextUsageMetazoneShort,
622 #endif /* U_HIDE_INTERNAL_API */
623 kCapContextUsageTypeCount = 14
624 };
625
631 virtual UClassID getDynamicClassID() const override;
632
638 static UClassID U_EXPORT2 getStaticClassID();
639
640 private:
641
642 friend class SimpleDateFormat;
643 friend class DateFormatSymbolsSingleSetter; // see udat.cpp
644
648 UnicodeString* fEras;
649 int32_t fErasCount;
650
654 UnicodeString* fEraNames;
655 int32_t fEraNamesCount;
656
660 UnicodeString* fNarrowEras;
661 int32_t fNarrowErasCount;
662
666 UnicodeString* fMonths;
667 int32_t fMonthsCount;
668
672 UnicodeString* fShortMonths;
673 int32_t fShortMonthsCount;
674
678 UnicodeString* fNarrowMonths;
679 int32_t fNarrowMonthsCount;
680
684 UnicodeString* fStandaloneMonths;
685 int32_t fStandaloneMonthsCount;
686
690 UnicodeString* fStandaloneShortMonths;
691 int32_t fStandaloneShortMonthsCount;
692
696 UnicodeString* fStandaloneNarrowMonths;
697 int32_t fStandaloneNarrowMonthsCount;
698
702 UnicodeString* fWeekdays;
703 int32_t fWeekdaysCount;
704
708 UnicodeString* fShortWeekdays;
709 int32_t fShortWeekdaysCount;
710
714 UnicodeString* fShorterWeekdays;
715 int32_t fShorterWeekdaysCount;
716
720 UnicodeString* fNarrowWeekdays;
721 int32_t fNarrowWeekdaysCount;
722
726 UnicodeString* fStandaloneWeekdays;
727 int32_t fStandaloneWeekdaysCount;
728
732 UnicodeString* fStandaloneShortWeekdays;
733 int32_t fStandaloneShortWeekdaysCount;
734
738 UnicodeString* fStandaloneShorterWeekdays;
739 int32_t fStandaloneShorterWeekdaysCount;
740
744 UnicodeString* fStandaloneNarrowWeekdays;
745 int32_t fStandaloneNarrowWeekdaysCount;
746
750 UnicodeString* fAmPms;
751 int32_t fAmPmsCount;
752
756 UnicodeString* fNarrowAmPms;
757 int32_t fNarrowAmPmsCount;
758
762 UnicodeString fTimeSeparator;
763
767 UnicodeString *fQuarters;
768 int32_t fQuartersCount;
769
773 UnicodeString *fShortQuarters;
774 int32_t fShortQuartersCount;
775
780 UnicodeString *fNarrowQuarters;
781 int32_t fNarrowQuartersCount;
782
786 UnicodeString *fStandaloneQuarters;
787 int32_t fStandaloneQuartersCount;
788
792 UnicodeString *fStandaloneShortQuarters;
793 int32_t fStandaloneShortQuartersCount;
794
799 UnicodeString *fStandaloneNarrowQuarters;
800 int32_t fStandaloneNarrowQuartersCount;
801
805 UnicodeString *fLeapMonthPatterns;
806 int32_t fLeapMonthPatternsCount;
807
813 UnicodeString *fShortYearNames;
814 int32_t fShortYearNamesCount;
815
821 UnicodeString *fShortZodiacNames;
822 int32_t fShortZodiacNamesCount;
823
861 UnicodeString **fZoneStrings; // Zone string array set by setZoneStrings
862 UnicodeString **fLocaleZoneStrings; // Zone string array created by the locale
863 int32_t fZoneStringsRowCount;
864 int32_t fZoneStringsColCount;
865
866 Locale fZSFLocale; // Locale used for getting ZoneStringFormat
867
871 UnicodeString fLocalPatternChars;
872
878 UBool fCapitalization[kCapContextUsageTypeCount][2];
879
883 UnicodeString *fAbbreviatedDayPeriods;
884 int32_t fAbbreviatedDayPeriodsCount;
885
889 UnicodeString *fWideDayPeriods;
890 int32_t fWideDayPeriodsCount;
891
895 UnicodeString *fNarrowDayPeriods;
896 int32_t fNarrowDayPeriodsCount;
897
901 UnicodeString *fStandaloneAbbreviatedDayPeriods;
902 int32_t fStandaloneAbbreviatedDayPeriodsCount;
903
907 UnicodeString *fStandaloneWideDayPeriods;
908 int32_t fStandaloneWideDayPeriodsCount;
909
913 UnicodeString *fStandaloneNarrowDayPeriods;
914 int32_t fStandaloneNarrowDayPeriodsCount;
915
916 private:
920 char validLocale[ULOC_FULLNAME_CAPACITY];
921 char actualLocale[ULOC_FULLNAME_CAPACITY];
922
923 DateFormatSymbols() = delete; // default constructor not implemented
924
934 void initializeData(const Locale& locale, const char *type,
935 UErrorCode& status, UBool useLastResortData = false);
936
945 static void assignArray(UnicodeString*& dstArray,
946 int32_t& dstCount,
947 const UnicodeString* srcArray,
948 int32_t srcCount);
949
960 static UBool arrayCompare(const UnicodeString* array1,
961 const UnicodeString* array2,
962 int32_t count);
963
969 void createZoneStrings(const UnicodeString *const * otherStrings);
970
974 void dispose(void);
975
980 void copyData(const DateFormatSymbols& other);
981
985 void initZoneStringsArray(void);
986
990 void disposeZoneStrings(void);
991
996 static UDateFormatField U_EXPORT2 getPatternCharIndex(char16_t c);
997
1001 static UBool U_EXPORT2 isNumericField(UDateFormatField f, int32_t count);
1002
1006 static UBool U_EXPORT2 isNumericPatternChar(char16_t c, int32_t count);
1007 public:
1008 #ifndef U_HIDE_INTERNAL_API
1020 static DateFormatSymbols * U_EXPORT2 createForLocale(
1021 const Locale &locale, UErrorCode &status);
1022 #endif /* U_HIDE_INTERNAL_API */
1023 };
1024
1025 U_NAMESPACE_END
1026
1027 #endif /* #if !UCONFIG_NO_FORMATTING */
1028
1029 #endif /* U_SHOW_CPLUSPLUS_API */
1030
1031 #endif // _DTFMTSYM
1032 //eof
calendar.h
C++ API: Calendar object.
icu::DateFormatSymbols
DateFormatSymbols is a public class for encapsulating localizable date-time formatting data – includi...
Definition: dtfmtsym.h:84
icu::DateFormatSymbols::getAmPmStrings
const UnicodeString * getAmPmStrings(int32_t &count) const
Gets AM/PM strings.
icu::DateFormatSymbols::setYearNames
void setYearNames(const UnicodeString *yearNames, int32_t count, DtContextType context, DtWidthType width)
Sets cyclic year name strings by width and context.
icu::DateFormatSymbols::setWeekdays
void setWeekdays(const UnicodeString *weekdays, int32_t count)
Sets wide weekday strings.
icu::DateFormatSymbols::getQuarters
const UnicodeString * getQuarters(int32_t &count, DtContextType context, DtWidthType width) const
Gets quarter strings by width and context.
icu::DateFormatSymbols::setShortMonths
void setShortMonths(const UnicodeString *shortMonths, int32_t count)
Sets short month strings.
icu::DateFormatSymbols::setLocalPatternChars
void setLocalPatternChars(const UnicodeString &newLocalPatternChars)
Sets localized date-time pattern characters.
icu::DateFormatSymbols::DateFormatSymbols
DateFormatSymbols(const char *type, UErrorCode &status)
Construct a DateFormatSymbols object by loading format data from resources for the default locale,...
icu::DateFormatSymbols::createForLocale
static DateFormatSymbols * createForLocale(const Locale &locale, UErrorCode &status)
Gets a DateFormatSymbols by locale.
icu::DateFormatSymbols::getLocalPatternChars
UnicodeString & getLocalPatternChars(UnicodeString &result) const
Gets localized date-time pattern characters.
icu::DateFormatSymbols::getEras
const UnicodeString * getEras(int32_t &count) const
Gets abbreviated era strings.
icu::DateFormatSymbols::getLocale
Locale getLocale(ULocDataLocaleType type, UErrorCode &status) const
Returns the locale for this object.
icu::DateFormatSymbols::getWeekdays
const UnicodeString * getWeekdays(int32_t &count, DtContextType context, DtWidthType width) const
Gets weekday strings by width and context.
icu::DateFormatSymbols::setEras
void setEras(const UnicodeString *eras, int32_t count)
Sets abbreviated era strings.
icu::DateFormatSymbols::setQuarters
void setQuarters(const UnicodeString *quarters, int32_t count, DtContextType context, DtWidthType width)
Sets quarter strings by width and context.
icu::DateFormatSymbols::getEraNames
const UnicodeString * getEraNames(int32_t &count) const
Gets era name strings.
icu::DateFormatSymbols::operator!=
bool operator!=(const DateFormatSymbols &other) const
Return true if another object is semantically unequal to this one.
Definition: dtfmtsym.h:186
icu::DateFormatSymbols::DateFormatSymbols
DateFormatSymbols(UErrorCode &status)
Construct a DateFormatSymbols object by loading format data from resources for the default locale,...
icu::DateFormatSymbols::setAmPmStrings
void setAmPmStrings(const UnicodeString *ampms, int32_t count)
Sets ampm strings.
icu::DateFormatSymbols::DtWidthType
DtWidthType
Selector for date formatting width.
Definition: dtfmtsym.h:293
icu::DateFormatSymbols::SHORT
@ SHORT
Short width is currently only supported for weekday names.
Definition: dtfmtsym.h:301
icu::DateFormatSymbols::operator=
DateFormatSymbols & operator=(const DateFormatSymbols &)
Assignment operator.
icu::DateFormatSymbols::getNarrowEras
const UnicodeString * getNarrowEras(int32_t &count) const
Gets narrow era strings.
icu::DateFormatSymbols::getShortWeekdays
const UnicodeString * getShortWeekdays(int32_t &count) const
Gets abbreviated weekday strings.
icu::DateFormatSymbols::setShortWeekdays
void setShortWeekdays(const UnicodeString *abbrevWeekdays, int32_t count)
Sets abbreviated weekday strings.
icu::DateFormatSymbols::getYearNames
const UnicodeString * getYearNames(int32_t &count, DtContextType context, DtWidthType width) const
Gets cyclic year name strings if the calendar has them, by width and context.
icu::DateFormatSymbols::getWeekdays
const UnicodeString * getWeekdays(int32_t &count) const
Gets wide weekday strings.
icu::DateFormatSymbols::getMonths
const UnicodeString * getMonths(int32_t &count) const
Gets month strings.
icu::DateFormatSymbols::getMonths
const UnicodeString * getMonths(int32_t &count, DtContextType context, DtWidthType width) const
Gets month strings by width and context.
icu::DateFormatSymbols::DateFormatSymbols
DateFormatSymbols(const Locale &locale, const char *type, UErrorCode &status)
Construct a DateFormatSymbols object by loading format data from resources for the given locale,...
icu::DateFormatSymbols::getZodiacNames
const UnicodeString * getZodiacNames(int32_t &count, DtContextType context, DtWidthType width) const
Gets calendar zodiac name strings if the calendar has them, by width and context.
icu::DateFormatSymbols::setZoneStrings
void setZoneStrings(const UnicodeString *const *strings, int32_t rowCount, int32_t columnCount)
Sets timezone strings.
icu::DateFormatSymbols::setNarrowEras
void setNarrowEras(const UnicodeString *narrowEras, int32_t count)
Sets narrow era strings.
icu::DateFormatSymbols::getPatternUChars
static const char16_t * getPatternUChars(void)
Get the non-localized date-time pattern characters.
icu::DateFormatSymbols::operator==
bool operator==(const DateFormatSymbols &other) const
Return true if another object is semantically equal to this one.
icu::DateFormatSymbols::getLeapMonthPatterns
const UnicodeString * getLeapMonthPatterns(int32_t &count) const
Somewhat temporary function for getting complete set of leap month patterns for all contexts & widths...
icu::DateFormatSymbols::DateFormatSymbols
DateFormatSymbols(const DateFormatSymbols &)
Copy constructor.
icu::DateFormatSymbols::getDynamicClassID
virtual UClassID getDynamicClassID() const override
ICU "poor man's RTTI", returns a UClassID for the actual class.
icu::DateFormatSymbols::setEraNames
void setEraNames(const UnicodeString *eraNames, int32_t count)
Sets era name strings.
icu::DateFormatSymbols::setMonths
void setMonths(const UnicodeString *months, int32_t count, DtContextType context, DtWidthType width)
Sets month strings by width and context.
icu::DateFormatSymbols::setTimeSeparatorString
void setTimeSeparatorString(const UnicodeString &newTimeSeparator)
Sets the time separator string.
icu::DateFormatSymbols::setZodiacNames
void setZodiacNames(const UnicodeString *zodiacNames, int32_t count, DtContextType context, DtWidthType width)
Sets calendar zodiac name strings by width and context.
icu::DateFormatSymbols::~DateFormatSymbols
virtual ~DateFormatSymbols()
Destructor.
icu::DateFormatSymbols::getStaticClassID
static UClassID getStaticClassID()
ICU "poor man's RTTI", returns a UClassID for this class.
icu::DateFormatSymbols::getTimeSeparatorString
UnicodeString & getTimeSeparatorString(UnicodeString &result) const
Gets the time separator string.
icu::DateFormatSymbols::setMonths
void setMonths(const UnicodeString *months, int32_t count)
Sets month strings.
icu::DateFormatSymbols::setWeekdays
void setWeekdays(const UnicodeString *weekdays, int32_t count, DtContextType context, DtWidthType width)
Sets weekday strings by width and context.
icu::DateFormatSymbols::DtContextType
DtContextType
Selector for date formatting context.
Definition: dtfmtsym.h:277
icu::DateFormatSymbols::ECapitalizationContextUsageType
ECapitalizationContextUsageType
Constants for capitalization context usage types.
Definition: dtfmtsym.h:606
icu::DateFormatSymbols::DateFormatSymbols
DateFormatSymbols(const Locale &locale, UErrorCode &status)
Construct a DateFormatSymbols object by loading format data from resources for the given locale,...
icu::DateFormatSymbols::EMonthPatternType
EMonthPatternType
Somewhat temporary constants for leap month pattern types, adequate for supporting just leap month pa...
Definition: dtfmtsym.h:514
icu::DateFormatSymbols::getShortMonths
const UnicodeString * getShortMonths(int32_t &count) const
Gets short month strings.
icu::DateFormatSymbols::getZoneStrings
const UnicodeString ** getZoneStrings(int32_t &rowCount, int32_t &columnCount) const
Gets timezone strings.
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
icu::SimpleDateFormat
SimpleDateFormat is a concrete class for formatting and parsing dates in a language-independent manne...
Definition: smpdtfmt.h:727
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
locid.h
C++ API: Locale ID object.
icu::operator==
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
strenum.h
C++ API: String Enumeration.
udat.h
C API: DateFormat.
UDateFormatField
UDateFormatField
FieldPosition and UFieldPosition selectors for format fields defined by DateFormat and UDateFormat.
Definition: udat.h:515
ULOC_FULLNAME_CAPACITY
#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:264
ULocDataLocaleType
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
Definition: uloc.h:338
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:247
uobject.h
C++ API: Common ICU base class UObject.
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
ures.h
C API: Resource Bundle.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
U_I18N_API
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301