ICU 70.1  70.1
timezone.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 * Copyright (c) 1997-2016, International Business Machines Corporation
5 * and others. All Rights Reserved.
6 **************************************************************************
7 *
8 * File TIMEZONE.H
9 *
10 * Modification History:
11 *
12 * Date Name Description
13 * 04/21/97 aliu Overhauled header.
14 * 07/09/97 helena Changed createInstance to createDefault.
15 * 08/06/97 aliu Removed dependency on internal header for Hashtable.
16 * 08/10/98 stephen Changed getDisplayName() API conventions to match
17 * 08/19/98 stephen Changed createTimeZone() to never return 0
18 * 09/02/98 stephen Sync to JDK 1.2 8/31
19 * - Added getOffset(... monthlen ...)
20 * - Added hasSameRules()
21 * 09/15/98 stephen Added getStaticClassID
22 * 12/03/99 aliu Moved data out of static table into icudata.dll.
23 * Hashtable replaced by new static data structures.
24 * 12/14/99 aliu Made GMT public.
25 * 08/15/01 grhoten Made GMT private and added the getGMT() function
26 **************************************************************************
27 */
28 
29 #ifndef TIMEZONE_H
30 #define TIMEZONE_H
31 
32 #include "unicode/utypes.h"
33 
34 #if U_SHOW_CPLUSPLUS_API
35 
41 #if !UCONFIG_NO_FORMATTING
42 
43 #include "unicode/uobject.h"
44 #include "unicode/unistr.h"
45 #include "unicode/ures.h"
46 #include "unicode/ucal.h"
47 
48 U_NAMESPACE_BEGIN
49 
50 class StringEnumeration;
51 
133 class U_I18N_API TimeZone : public UObject {
134 public:
138  virtual ~TimeZone();
139 
152  static const TimeZone& U_EXPORT2 getUnknown();
153 
166  static const TimeZone* U_EXPORT2 getGMT(void);
167 
179  static TimeZone* U_EXPORT2 createTimeZone(const UnicodeString& ID);
180 
197  USystemTimeZoneType zoneType,
198  const char* region,
199  const int32_t* rawOffset,
200  UErrorCode& ec);
201 
202 #ifndef U_HIDE_DEPRECATED_API
211 #endif // U_HIDE_DEPRECATED_API
212 
221  static StringEnumeration* U_EXPORT2 createEnumeration(UErrorCode& status);
222 
223 #ifndef U_HIDE_DEPRECATED_API
241  static StringEnumeration* U_EXPORT2 createEnumeration(int32_t rawOffset);
242 #endif // U_HIDE_DEPRECATED_API
243 
262  static StringEnumeration* U_EXPORT2 createEnumerationForRawOffset(int32_t rawOffset, UErrorCode& status);
263 
264 #ifndef U_HIDE_DEPRECATED_API
275  static StringEnumeration* U_EXPORT2 createEnumeration(const char* region);
276 #endif // U_HIDE_DEPRECATED_API
277 
289  static StringEnumeration* U_EXPORT2 createEnumerationForRegion(const char* region, UErrorCode& status);
290 
305  static int32_t U_EXPORT2 countEquivalentIDs(const UnicodeString& id);
306 
326  static const UnicodeString U_EXPORT2 getEquivalentID(const UnicodeString& id,
327  int32_t index);
328 
352  static TimeZone* U_EXPORT2 detectHostTimeZone();
353 
367  static TimeZone* U_EXPORT2 createDefault(void);
368 
369 #ifndef U_HIDE_INTERNAL_API
379  static TimeZone* U_EXPORT2 forLocaleOrDefault(const Locale& locale);
380 #endif /* U_HIDE_INTERNAL_API */
381 
391  static void U_EXPORT2 adoptDefault(TimeZone* zone);
392 
393 #ifndef U_HIDE_SYSTEM_API
402  static void U_EXPORT2 setDefault(const TimeZone& zone);
403 #endif /* U_HIDE_SYSTEM_API */
404 
411  static const char* U_EXPORT2 getTZDataVersion(UErrorCode& status);
412 
426  static UnicodeString& U_EXPORT2 getCanonicalID(const UnicodeString& id,
427  UnicodeString& canonicalID, UErrorCode& status);
428 
444  static UnicodeString& U_EXPORT2 getCanonicalID(const UnicodeString& id,
445  UnicodeString& canonicalID, UBool& isSystemID, UErrorCode& status);
446 
469  static UnicodeString& U_EXPORT2 getWindowsID(const UnicodeString& id,
470  UnicodeString& winid, UErrorCode& status);
471 
498  static UnicodeString& U_EXPORT2 getIDForWindowsID(const UnicodeString& winid, const char* region,
499  UnicodeString& id, UErrorCode& status);
500 
510  virtual bool operator==(const TimeZone& that) const;
511 
521  bool operator!=(const TimeZone& that) const {return !operator==(that);}
522 
547  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
548  uint8_t dayOfWeek, int32_t millis, UErrorCode& status) const = 0;
549 
570  virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day,
571  uint8_t dayOfWeek, int32_t milliseconds,
572  int32_t monthLength, UErrorCode& status) const = 0;
573 
597  virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
598  int32_t& dstOffset, UErrorCode& ec) const;
599 
607  virtual void setRawOffset(int32_t offsetMillis) = 0;
608 
616  virtual int32_t getRawOffset(void) const = 0;
617 
625  UnicodeString& getID(UnicodeString& ID) const;
626 
640  void setID(const UnicodeString& ID);
641 
651  SHORT = 1,
690  GENERIC_LOCATION
691  };
692 
705 
719  UnicodeString& getDisplayName(const Locale& locale, UnicodeString& result) const;
720 
733  UnicodeString& getDisplayName(UBool inDaylight, EDisplayType style, UnicodeString& result) const;
734 
749  UnicodeString& getDisplayName(UBool inDaylight, EDisplayType style, const Locale& locale, UnicodeString& result) const;
750 
785  virtual UBool useDaylightTime(void) const = 0;
786 
787 #ifndef U_FORCE_HIDE_DEPRECATED_API
801  virtual UBool inDaylightTime(UDate date, UErrorCode& status) const = 0;
802 #endif // U_FORCE_HIDE_DEPRECATED_API
803 
812  virtual UBool hasSameRules(const TimeZone& other) const;
813 
821  virtual TimeZone* clone() const = 0;
822 
829  static UClassID U_EXPORT2 getStaticClassID(void);
830 
842  virtual UClassID getDynamicClassID(void) const override = 0;
843 
859  virtual int32_t getDSTSavings() const;
860 
878  static int32_t U_EXPORT2 getRegion(const UnicodeString& id,
879  char *region, int32_t capacity, UErrorCode& status);
880 
881 protected:
882 
888 
895 
901  TimeZone(const TimeZone& source);
902 
908  TimeZone& operator=(const TimeZone& right);
909 
910 #ifndef U_HIDE_INTERNAL_API
920  static UResourceBundle* loadRule(const UResourceBundle* top, const UnicodeString& ruleid, UResourceBundle* oldbundle, UErrorCode&status);
921 #endif /* U_HIDE_INTERNAL_API */
922 
923 private:
924  friend class ZoneMeta;
925 
926 
927  static TimeZone* createCustomTimeZone(const UnicodeString&); // Creates a time zone based on the string.
928 
937  static const char16_t* findID(const UnicodeString& id);
938 
947  static const char16_t* dereferOlsonLink(const UnicodeString& id);
948 
955  static const char16_t* getRegion(const UnicodeString& id);
956 
957  public:
958 #ifndef U_HIDE_INTERNAL_API
967  static const char16_t* getRegion(const UnicodeString& id, UErrorCode& status);
968 #endif /* U_HIDE_INTERNAL_API */
969 
970  private:
981  static UBool parseCustomID(const UnicodeString& id, int32_t& sign, int32_t& hour,
982  int32_t& minute, int32_t& second);
983 
994  static UnicodeString& getCustomID(const UnicodeString& id, UnicodeString& normalized,
995  UErrorCode& status);
996 
1006  static UnicodeString& formatCustomID(int32_t hour, int32_t min, int32_t sec,
1007  UBool negative, UnicodeString& id);
1008 
1009  UnicodeString fID; // this time zone's ID
1010 
1011  friend class TZEnumeration;
1012 };
1013 
1014 
1015 // -------------------------------------
1016 
1017 inline UnicodeString&
1018 TimeZone::getID(UnicodeString& ID) const
1019 {
1020  ID = fID;
1021  return ID;
1022 }
1023 
1024 // -------------------------------------
1025 
1026 inline void
1027 TimeZone::setID(const UnicodeString& ID)
1028 {
1029  fID = ID;
1030 }
1031 U_NAMESPACE_END
1032 
1033 #endif /* #if !UCONFIG_NO_FORMATTING */
1034 
1035 #endif /* U_SHOW_CPLUSPLUS_API */
1036 
1037 #endif //_TIMEZONE
1038 //eof
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:61
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:133
EDisplayType
Enum for use with getDisplayName.
Definition: timezone.h:646
@ SHORT_COMMONLY_USED
Selector for short display name derived from the time zone's fallback name.
Definition: timezone.h:684
@ LONG_GMT
Selector for long display name derived from time zone offset.
Definition: timezone.h:678
@ SHORT_GENERIC
Selector for short generic display name.
Definition: timezone.h:661
@ LONG
Selector for long display name.
Definition: timezone.h:656
@ SHORT_GMT
Selector for short display name derived from time zone offset.
Definition: timezone.h:672
@ LONG_GENERIC
Selector for long generic display name.
Definition: timezone.h:666
static UnicodeString & getIDForWindowsID(const UnicodeString &winid, const char *region, UnicodeString &id, UErrorCode &status)
Converts a Windows time zone ID to an equivalent system time zone ID for a region.
static int32_t getRegion(const UnicodeString &id, char *region, int32_t capacity, UErrorCode &status)
Gets the region code associated with the given system time zone ID.
static UClassID getStaticClassID(void)
Return the class ID for this class.
virtual void setRawOffset(int32_t offsetMillis)=0
Sets the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local time,...
virtual TimeZone * clone() const =0
Clones TimeZone objects polymorphically.
static void setDefault(const TimeZone &zone)
Same as adoptDefault(), except that the TimeZone object passed in is NOT adopted; the caller remains ...
virtual bool operator==(const TimeZone &that) const
Returns true if the two TimeZones are equal.
static UnicodeString & getWindowsID(const UnicodeString &id, UnicodeString &winid, UErrorCode &status)
Converts a system time zone ID to an equivalent Windows time zone ID.
static StringEnumeration * createEnumerationForRawOffset(int32_t rawOffset, UErrorCode &status)
Returns an enumeration over time zone IDs with a given raw offset from GMT.
UnicodeString & getDisplayName(UBool inDaylight, EDisplayType style, UnicodeString &result) const
Returns a name of this time zone suitable for presentation to the user in the default locale.
static TimeZone * createTimeZone(const UnicodeString &ID)
Creates a TimeZone for the given ID.
virtual int32_t getRawOffset(void) const =0
Returns the TimeZone's raw GMT offset (i.e., the number of milliseconds to add to GMT to get local ti...
UnicodeString & getDisplayName(const Locale &locale, UnicodeString &result) const
Returns a name of this time zone suitable for presentation to the user in the specified locale.
TimeZone(const TimeZone &source)
Copy constructor.
static const char * getTZDataVersion(UErrorCode &status)
Returns the timezone data version currently used by ICU.
virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t millis, UErrorCode &status) const =0
Returns the TimeZone's adjusted GMT offset (i.e., the number of milliseconds to add to GMT to get loc...
static TimeZone * detectHostTimeZone()
Creates an instance of TimeZone detected from the current host system configuration.
TimeZone(const UnicodeString &id)
Construct a TimeZone with a given ID.
static UResourceBundle * loadRule(const UResourceBundle *top, const UnicodeString &ruleid, UResourceBundle *oldbundle, UErrorCode &status)
Utility function.
static StringEnumeration * createTimeZoneIDEnumeration(USystemTimeZoneType zoneType, const char *region, const int32_t *rawOffset, UErrorCode &ec)
Returns an enumeration over system time zone IDs with the given filter conditions.
TimeZone & operator=(const TimeZone &right)
Default assignment operator.
UnicodeString & getDisplayName(UnicodeString &result) const
Returns a name of this time zone suitable for presentation to the user in the default locale.
virtual UBool useDaylightTime(void) const =0
Queries if this time zone uses daylight savings time.
static TimeZone * forLocaleOrDefault(const Locale &locale)
If the locale contains the timezone keyword, creates a copy of that TimeZone.
static const char16_t * getRegion(const UnicodeString &id, UErrorCode &status)
Returns the region code associated with the given zone, or NULL if the zone is not known.
virtual UBool hasSameRules(const TimeZone &other) const
Returns true if this zone has the same rule and offset as another zone.
UnicodeString & getDisplayName(UBool inDaylight, EDisplayType style, const Locale &locale, UnicodeString &result) const
Returns a name of this time zone suitable for presentation to the user in the specified locale.
static int32_t countEquivalentIDs(const UnicodeString &id)
Returns the number of IDs in the equivalency group that includes the given ID.
static void adoptDefault(TimeZone *zone)
Sets the default time zone (i.e., what's returned by createDefault()) to be the specified time zone.
TimeZone()
Default constructor.
static UnicodeString & getCanonicalID(const UnicodeString &id, UnicodeString &canonicalID, UErrorCode &status)
Returns the canonical system timezone ID or the normalized custom time zone ID for the given time zon...
static StringEnumeration * createEnumeration(UErrorCode &status)
Returns an enumeration over all recognized time zone IDs.
static StringEnumeration * createEnumeration(int32_t rawOffset)
Returns an enumeration over time zone IDs with a given raw offset from GMT.
bool operator!=(const TimeZone &that) const
Returns true if the two TimeZones are NOT equal; that is, if operator==() returns false.
Definition: timezone.h:521
virtual int32_t getOffset(uint8_t era, int32_t year, int32_t month, int32_t day, uint8_t dayOfWeek, int32_t milliseconds, int32_t monthLength, UErrorCode &status) const =0
Gets the time zone offset, for current date, modified in case of daylight savings.
static const TimeZone * getGMT(void)
The GMT (=UTC) time zone has a raw offset of zero and does not use daylight savings time.
static StringEnumeration * createEnumeration(const char *region)
Returns an enumeration over time zone IDs associated with the given region.
static StringEnumeration * createEnumeration()
Returns an enumeration over all recognized time zone IDs.
static TimeZone * createDefault(void)
Creates a new copy of the default TimeZone for this host.
static const UnicodeString getEquivalentID(const UnicodeString &id, int32_t index)
Returns an ID in the equivalency group that includes the given ID.
static UnicodeString & getCanonicalID(const UnicodeString &id, UnicodeString &canonicalID, UBool &isSystemID, UErrorCode &status)
Returns the canonical system time zone ID or the normalized custom time zone ID for the given time zo...
virtual UBool inDaylightTime(UDate date, UErrorCode &status) const =0
Queries if the given date is in daylight savings time in this time zone.
static const TimeZone & getUnknown()
Returns the "unknown" time zone.
virtual UClassID getDynamicClassID(void) const override=0
Returns a unique class ID POLYMORPHICALLY.
virtual ~TimeZone()
static StringEnumeration * createEnumerationForRegion(const char *region, UErrorCode &status)
Returns an enumeration over time zone IDs associated with the given region.
virtual int32_t getDSTSavings() const
Returns the amount of time to be added to local standard time to get local wall clock time.
virtual void getOffset(UDate date, UBool local, int32_t &rawOffset, int32_t &dstOffset, UErrorCode &ec) const
Returns the time zone raw and GMT offset for the given moment in time.
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
U_EXPORT UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
C API: Calendar.
USystemTimeZoneType
System time zone type constants used by filtering zones in ucal_openTimeZoneIDEnumeration.
Definition: ucal.h:553
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
C++ API: Unicode String.
C++ API: Common ICU base class UObject.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
C API: Resource Bundle.
struct UResourceBundle UResourceBundle
Definition: ures.h:62
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301
double UDate
Date and Time data type.
Definition: utypes.h:203