ICU 59.1  59.1
tmutfmt.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) 2008-2014, Google, International Business Machines Corporation
6  * and others. All Rights Reserved.
7  *******************************************************************************
8  */
9 
10 #ifndef __TMUTFMT_H__
11 #define __TMUTFMT_H__
12 
13 #include "unicode/utypes.h"
14 
21 #if !UCONFIG_NO_FORMATTING
22 #ifndef U_HIDE_DEPRECATED_API
23 
24 #include "unicode/unistr.h"
25 #include "unicode/tmunit.h"
26 #include "unicode/tmutamt.h"
27 #include "unicode/measfmt.h"
28 #include "unicode/numfmt.h"
29 #include "unicode/plurrule.h"
30 
31 
46 };
51 
52 class Hashtable;
53 class UVector;
54 
55 struct TimeUnitFormatReadSink;
56 
88 public:
89 
95  TimeUnitFormat(UErrorCode& status);
96 
101  TimeUnitFormat(const Locale& locale, UErrorCode& status);
102 
107  TimeUnitFormat(const Locale& locale, UTimeUnitFormatStyle style, UErrorCode& status);
108 
114 
119  virtual ~TimeUnitFormat();
120 
127  virtual Format* clone(void) const;
128 
133  TimeUnitFormat& operator=(const TimeUnitFormat& other);
134 
142  UBool operator!=(const Format& other) const;
143 
150  void setLocale(const Locale& locale, UErrorCode& status);
151 
152 
159  void setNumberFormat(const NumberFormat& format, UErrorCode& status);
160 
166  virtual void parseObject(const UnicodeString& source,
167  Formattable& result,
168  ParsePosition& pos) const;
169 
181  static UClassID U_EXPORT2 getStaticClassID(void);
182 
194  virtual UClassID getDynamicClassID(void) const;
195 
196 private:
197  Hashtable* fTimeUnitToCountToPatterns[TimeUnit::UTIMEUNIT_FIELD_COUNT];
198  UTimeUnitFormatStyle fStyle;
199 
200  void create(UTimeUnitFormatStyle style, UErrorCode& status);
201 
202  // it might actually be simpler to make them Decimal Formats later.
203  // initialize all private data members
204  void setup(UErrorCode& status);
205 
206  // initialize data member without fill in data for fTimeUnitToCountToPattern
207  void initDataMembers(UErrorCode& status);
208 
209  // initialize fTimeUnitToCountToPatterns from current locale's resource.
210  void readFromCurrentLocale(UTimeUnitFormatStyle style, const char* key, const UVector& pluralCounts,
211  UErrorCode& status);
212 
213  // check completeness of fTimeUnitToCountToPatterns against all time units,
214  // and all plural rules, fill in fallback as necessary.
215  void checkConsistency(UTimeUnitFormatStyle style, const char* key, UErrorCode& status);
216 
217  // fill in fTimeUnitToCountToPatterns from locale fall-back chain
218  void searchInLocaleChain(UTimeUnitFormatStyle style, const char* key, const char* localeName,
220  const char*, Hashtable*, UErrorCode&);
221 
222  // initialize hash table
223  Hashtable* initHash(UErrorCode& status);
224 
225  // delete hash table
226  void deleteHash(Hashtable* htable);
227 
228  // copy hash table
229  void copyHash(const Hashtable* source, Hashtable* target, UErrorCode& status);
230  // get time unit name, such as "year", from time unit field enum, such as
231  // UTIMEUNIT_YEAR.
232  static const char* getTimeUnitName(TimeUnit::UTimeUnitFields field, UErrorCode& status);
233 
234  friend struct TimeUnitFormatReadSink;
235 };
236 
237 inline UBool
238 TimeUnitFormat::operator!=(const Format& other) const {
239  return !operator==(other);
240 }
241 
243 
244 #endif /* U_HIDE_DEPRECATED_API */
245 #endif /* #if !UCONFIG_NO_FORMATTING */
246 
247 #endif // __TMUTFMT_H__
248 //eof
Format or parse a TimeUnitAmount, using plural rules for the units where available.
Definition: tmutfmt.h:87
Base class for all formats.
Definition: format.h:96
UTimeUnitFields
Constants for all the time units we supported.
Definition: tmunit.h:38
static UClassID getStaticClassID(void)
Return the class ID for this class.
UBool operator!=(const Format &other) const
Return true if the given Format objects are not semantically equal.
Definition: format.h:121
virtual void parseObject(const UnicodeString &source, Formattable &reslt, ParsePosition &pos) const
Parse a string to produce an object.
A formatter for measure objects.
Definition: measfmt.h:97
Abstract base class for all number formats.
Definition: numfmt.h:169
C++ API: Unicode String.
virtual UClassID getDynamicClassID(void) const
Returns a unique class ID POLYMORPHICALLY.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:93
MeasureFormat & operator=(const MeasureFormat &rhs)
Assignment operator.
C++ API: PluralRules object.
C++ API: time unit object.
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:360
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:131
UTimeUnitFormatStyle
Constants for various styles.
Definition: tmutfmt.h:39
One more than the highest normal UTimeUnitFields value.
Definition: tmunit.h:51
C++ API: Formatter for measure objects.
C++ API: time unit amount object.
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:132
virtual Format * clone() const
Clones this object polymorphically.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:396
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition: parsepos.h:49
Basic definitions for ICU, for both C and C++ APIs.
UBool operator!=(const Format &other) const
Return true if the given Format objects are not semantically equal.
Definition: tmutfmt.h:238
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition: fmtable.h:68
C++ API: Abstract base class for all number formats.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:236
virtual UBool operator==(const Format &other) const
Return true if given Format objects are semantically equal.
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:188