util/X86MAC64/include/unicode/timezone.h

   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
  36 /**
  37  * \file
  38  * \brief C++ API: TimeZone object
  39  */
  40
  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
  52 /**
  53  *
  54  * <code>TimeZone</code> represents a time zone offset, and also figures out daylight
  55  * savings.
  56  *
  57  * <p>
  58  * Typically, you get a <code>TimeZone</code> using <code>createDefault</code>
  59  * which creates a <code>TimeZone</code> based on the time zone where the program
  60  * is running. For example, for a program running in Japan, <code>createDefault</code>
  61  * creates a <code>TimeZone</code> object based on Japanese Standard Time.
  62  *
  63  * <p>
  64  * You can also get a <code>TimeZone</code> using <code>createTimeZone</code> along
  65  * with a time zone ID. For instance, the time zone ID for the US Pacific
  66  * Time zone is "America/Los_Angeles". So, you can get a Pacific Time <code>TimeZone</code> object
  67  * with:
  68  * \htmlonly<blockquote>\endhtmlonly
  69  * <pre>
  70  * TimeZone *tz = TimeZone::createTimeZone("America/Los_Angeles");
  71  * </pre>
  72  * \htmlonly</blockquote>\endhtmlonly
  73  * You can use the <code>createEnumeration</code> method to iterate through
  74  * all the supported time zone IDs, or the <code>getCanonicalID</code> method to check
  75  * if a time zone ID is supported or not.  You can then choose a
  76  * supported ID to get a <code>TimeZone</code>.
  77  * If the time zone you want is not represented by one of the
  78  * supported IDs, then you can create a custom time zone ID with
  79  * the following syntax:
  80  *
  81  * \htmlonly<blockquote>\endhtmlonly
  82  * <pre>
  83  * GMT[+|-]hh[[:]mm]
  84  * </pre>
  85  * \htmlonly</blockquote>\endhtmlonly
  86  *
  87  * For example, you might specify GMT+14:00 as a custom
  88  * time zone ID.  The <code>TimeZone</code> that is returned
  89  * when you specify a custom time zone ID uses the specified
  90  * offset from GMT(=UTC) and does not observe daylight saving
  91  * time. For example, you might specify GMT+14:00 as a custom
  92  * time zone ID to create a TimeZone representing 14 hours ahead
  93  * of GMT (with no daylight saving time). In addition,
  94  * <code>getCanonicalID</code> can also be used to
  95  * normalize a custom time zone ID.
  96  *
  97  * TimeZone is an abstract class representing a time zone.  A TimeZone is needed for
  98  * Calendar to produce local time for a particular time zone.  A TimeZone comprises
  99  * three basic pieces of information:
 100  * <ul>
 101  *    <li>A time zone offset; that, is the number of milliseconds to add or subtract
 102  *      from a time expressed in terms of GMT to convert it to the same time in that
 103  *      time zone (without taking daylight savings time into account).</li>
 104  *    <li>Logic necessary to take daylight savings time into account if daylight savings
 105  *      time is observed in that time zone (e.g., the days and hours on which daylight
 106  *      savings time begins and ends).</li>
 107  *    <li>An ID.  This is a text string that uniquely identifies the time zone.</li>
 108  * </ul>
 109  *
 110  * (Only the ID is actually implemented in TimeZone; subclasses of TimeZone may handle
 111  * daylight savings time and GMT offset in different ways.  Currently we have the following
 112  * TimeZone subclasses: RuleBasedTimeZone, SimpleTimeZone, and VTimeZone.)
 113  * <P>
 114  * The TimeZone class contains a static list containing a TimeZone object for every
 115  * combination of GMT offset and daylight-savings time rules currently in use in the
 116  * world, each with a unique ID.  Each ID consists of a region (usually a continent or
 117  * ocean) and a city in that region, separated by a slash, (for example, US Pacific
 118  * Time is "America/Los_Angeles.")  Because older versions of this class used
 119  * three- or four-letter abbreviations instead, there is also a table that maps the older
 120  * abbreviations to the newer ones (for example, "PST" maps to "America/Los_Angeles").
 121  * Anywhere the API requires an ID, you can use either form.
 122  * <P>
 123  * To create a new TimeZone, you call the factory function TimeZone::createTimeZone()
 124  * and pass it a time zone ID.  You can use the createEnumeration() function to
 125  * obtain a list of all the time zone IDs recognized by createTimeZone().
 126  * <P>
 127  * You can also use TimeZone::createDefault() to create a TimeZone.  This function uses
 128  * platform-specific APIs to produce a TimeZone for the time zone corresponding to
 129  * the client's computer's physical location.  For example, if you're in Japan (assuming
 130  * your machine is set up correctly), TimeZone::createDefault() will return a TimeZone
 131  * for Japanese Standard Time ("Asia/Tokyo").
 132  */
 133 class U_I18N_API TimeZone : public UObject {
 134 public:
 135     /**
 136      * @stable ICU 2.0
 137      */
 138     virtual ~TimeZone();
 139
 140     /**
 141      * Returns the "unknown" time zone.
 142      * It behaves like the GMT/UTC time zone but has the
 143      * <code>UCAL_UNKNOWN_ZONE_ID</code> = "Etc/Unknown".
 144      * createTimeZone() returns a mutable clone of this time zone if the input ID is not recognized.
 145      *
 146      * @return the "unknown" time zone.
 147      * @see UCAL_UNKNOWN_ZONE_ID
 148      * @see createTimeZone
 149      * @see getGMT
 150      * @stable ICU 49
 151      */
 152     static const TimeZone& U_EXPORT2 getUnknown();
 153
 154     /**
 155      * The GMT (=UTC) time zone has a raw offset of zero and does not use daylight
 156      * savings time. This is a commonly used time zone.
 157      *
 158      * <p>Note: For backward compatibility reason, the ID used by the time
 159      * zone returned by this method is "GMT", although the ICU's canonical
 160      * ID for the GMT time zone is "Etc/GMT".
 161      *
 162      * @return the GMT/UTC time zone.
 163      * @see getUnknown
 164      * @stable ICU 2.0
 165      */
 166     static const TimeZone* U_EXPORT2 getGMT(void);
 167
 168     /**
 169      * Creates a <code>TimeZone</code> for the given ID.
 170      * @param ID the ID for a <code>TimeZone</code>, such as "America/Los_Angeles",
 171      * or a custom ID such as "GMT-8:00".
 172      * @return the specified <code>TimeZone</code>, or a mutable clone of getUnknown()
 173      * if the given ID cannot be understood or if the given ID is "Etc/Unknown".
 174      * The return result is guaranteed to be non-NULL.
 175      * If you require that the specific zone asked for be returned,
 176      * compare the result with getUnknown() or check the ID of the return result.
 177      * @stable ICU 2.0
 178      */
 179     static TimeZone* U_EXPORT2 createTimeZone(const UnicodeString& ID);
 180
 181     /**
 182      * Returns an enumeration over system time zone IDs with the given
 183      * filter conditions.
 184      * @param zoneType      The system time zone type.
 185      * @param region        The ISO 3166 two-letter country code or UN M.49
 186      *                      three-digit area code. When NULL, no filtering
 187      *                      done by region.
 188      * @param rawOffset     An offset from GMT in milliseconds, ignoring
 189      *                      the effect of daylight savings time, if any.
 190      *                      When NULL, no filtering done by zone offset.
 191      * @param ec            Output param to filled in with a success or
 192      *                      an error.
 193      * @return an enumeration object, owned by the caller.
 194      * @stable ICU 4.8
 195      */
 196     static StringEnumeration* U_EXPORT2 createTimeZoneIDEnumeration(
 197         USystemTimeZoneType zoneType,
 198         const char* region,
 199         const int32_t* rawOffset,
 200         UErrorCode& ec);
 201
 202 #ifndef U_HIDE_DEPRECATED_API
 203     /**
 204      * Returns an enumeration over all recognized time zone IDs. (i.e.,
 205      * all strings that createTimeZone() accepts)
 206      *
 207      * @return an enumeration object, owned by the caller.
 208      * @deprecated ICU 70 Use createEnumeration(UErrorCode&) instead.
 209      */
 210     static StringEnumeration* U_EXPORT2 createEnumeration();
 211 #endif  // U_HIDE_DEPRECATED_API
 212
 213     /**
 214      * Returns an enumeration over all recognized time zone IDs. (i.e.,
 215      * all strings that createTimeZone() accepts)
 216      *
 217      * @param status Receives the status.
 218      * @return an enumeration object, owned by the caller.
 219      * @stable ICU 70
 220      */
 221     static StringEnumeration* U_EXPORT2 createEnumeration(UErrorCode& status);
 222
 223 #ifndef U_HIDE_DEPRECATED_API
 224     /**
 225      * Returns an enumeration over time zone IDs with a given raw
 226      * offset from GMT.  There may be several times zones with the
 227      * same GMT offset that differ in the way they handle daylight
 228      * savings time.  For example, the state of Arizona doesn't
 229      * observe daylight savings time.  If you ask for the time zone
 230      * IDs corresponding to GMT-7:00, you'll get back an enumeration
 231      * over two time zone IDs: "America/Denver," which corresponds to
 232      * Mountain Standard Time in the winter and Mountain Daylight Time
 233      * in the summer, and "America/Phoenix", which corresponds to
 234      * Mountain Standard Time year-round, even in the summer.
 235      *
 236      * @param rawOffset an offset from GMT in milliseconds, ignoring
 237      * the effect of daylight savings time, if any
 238      * @return an enumeration object, owned by the caller
 239      * @deprecated ICU 70 Use createEnumerationForRawOffset(int32_t,UErrorCode&) instead.
 240      */
 241     static StringEnumeration* U_EXPORT2 createEnumeration(int32_t rawOffset);
 242 #endif  // U_HIDE_DEPRECATED_API
 243
 244     /**
 245      * Returns an enumeration over time zone IDs with a given raw
 246      * offset from GMT.  There may be several times zones with the
 247      * same GMT offset that differ in the way they handle daylight
 248      * savings time.  For example, the state of Arizona doesn't
 249      * observe daylight savings time.  If you ask for the time zone
 250      * IDs corresponding to GMT-7:00, you'll get back an enumeration
 251      * over two time zone IDs: "America/Denver," which corresponds to
 252      * Mountain Standard Time in the winter and Mountain Daylight Time
 253      * in the summer, and "America/Phoenix", which corresponds to
 254      * Mountain Standard Time year-round, even in the summer.
 255      *
 256      * @param rawOffset an offset from GMT in milliseconds, ignoring
 257      * the effect of daylight savings time, if any
 258      * @param status Receives the status.
 259      * @return an enumeration object, owned by the caller
 260      * @stable ICU 70
 261      */
 262     static StringEnumeration* U_EXPORT2 createEnumerationForRawOffset(int32_t rawOffset, UErrorCode& status);
 263
 264 #ifndef U_HIDE_DEPRECATED_API
 265     /**
 266      * Returns an enumeration over time zone IDs associated with the
 267      * given region.  Some zones are affiliated with no region
 268      * (e.g., "UTC"); these may also be retrieved, as a group.
 269      *
 270      * @param region The ISO 3166 two-letter country code, or NULL to
 271      * retrieve zones not affiliated with any region.
 272      * @return an enumeration object, owned by the caller
 273      * @deprecated ICU 70 Use createEnumerationForRegion(const char*,UErrorCode&) instead.
 274      */
 275     static StringEnumeration* U_EXPORT2 createEnumeration(const char* region);
 276 #endif  // U_HIDE_DEPRECATED_API
 277
 278     /**
 279      * Returns an enumeration over time zone IDs associated with the
 280      * given region.  Some zones are affiliated with no region
 281      * (e.g., "UTC"); these may also be retrieved, as a group.
 282      *
 283      * @param region The ISO 3166 two-letter country code, or NULL to
 284      * retrieve zones not affiliated with any region.
 285      * @param status Receives the status.
 286      * @return an enumeration object, owned by the caller
 287      * @stable ICU 70
 288      */
 289     static StringEnumeration* U_EXPORT2 createEnumerationForRegion(const char* region, UErrorCode& status);
 290
 291     /**
 292      * Returns the number of IDs in the equivalency group that
 293      * includes the given ID.  An equivalency group contains zones
 294      * that have the same GMT offset and rules.
 295      *
 296      * <p>The returned count includes the given ID; it is always >= 1.
 297      * The given ID must be a system time zone.  If it is not, returns
 298      * zero.
 299      * @param id a system time zone ID
 300      * @return the number of zones in the equivalency group containing
 301      * 'id', or zero if 'id' is not a valid system ID
 302      * @see #getEquivalentID
 303      * @stable ICU 2.0
 304      */
 305     static int32_t U_EXPORT2 countEquivalentIDs(const UnicodeString& id);
 306
 307     /**
 308      * Returns an ID in the equivalency group that
 309      * includes the given ID.  An equivalency group contains zones
 310      * that have the same GMT offset and rules.
 311      *
 312      * <p>The given index must be in the range 0..n-1, where n is the
 313      * value returned by <code>countEquivalentIDs(id)</code>.  For
 314      * some value of 'index', the returned value will be equal to the
 315      * given id.  If the given id is not a valid system time zone, or
 316      * if 'index' is out of range, then returns an empty string.
 317      * @param id a system time zone ID
 318      * @param index a value from 0 to n-1, where n is the value
 319      * returned by <code>countEquivalentIDs(id)</code>
 320      * @return the ID of the index-th zone in the equivalency group
 321      * containing 'id', or an empty string if 'id' is not a valid
 322      * system ID or 'index' is out of range
 323      * @see #countEquivalentIDs
 324      * @stable ICU 2.0
 325      */
 326     static const UnicodeString U_EXPORT2 getEquivalentID(const UnicodeString& id,
 327                                                int32_t index);
 328
 329     /**
 330      * Creates an instance of TimeZone detected from the current host
 331      * system configuration. If the host system detection routines fail,
 332      * or if they specify a TimeZone or TimeZone offset which is not
 333      * recognized, then the special TimeZone "Etc/Unknown" is returned.
 334      *
 335      * Note that ICU4C does not change the default time zone unless
 336      * `TimeZone::adoptDefault(TimeZone*)` or
 337      * `TimeZone::setDefault(const TimeZone&)` is explicitly called by a
 338      * user. This method does not update the current ICU's default,
 339      * and may return a different TimeZone from the one returned by
 340      * `TimeZone::createDefault()`.
 341      *
 342      * <p>This function is not thread safe.</p>
 343      *
 344      * @return  A new instance of TimeZone detected from the current host system
 345      *          configuration.
 346      * @see adoptDefault
 347      * @see setDefault
 348      * @see createDefault
 349      * @see getUnknown
 350      * @stable ICU 55
 351      */
 352     static TimeZone* U_EXPORT2 detectHostTimeZone();
 353
 354     /**
 355      * Creates a new copy of the default TimeZone for this host. Unless the default time
 356      * zone has already been set using adoptDefault() or setDefault(), the default is
 357      * determined by querying the host system configuration. If the host system detection
 358      * routines fail, or if they specify a TimeZone or TimeZone offset which is not
 359      * recognized, then the special TimeZone "Etc/Unknown" is instantiated and made the
 360      * default.
 361      *
 362      * @return   A default TimeZone. Clients are responsible for deleting the time zone
 363      *           object returned.
 364      * @see getUnknown
 365      * @stable ICU 2.0
 366      */
 367     static TimeZone* U_EXPORT2 createDefault(void);
 368
 369 #ifndef U_HIDE_INTERNAL_API
 370     /**
 371      * If the locale contains the timezone keyword, creates a copy of that TimeZone.
 372      * Otherwise, create the default timezone.
 373      *
 374      * @param locale a locale which may contains 'timezone' keyword/value.
 375      * @return   A TimeZone. Clients are responsible for deleting the time zone
 376      *           object returned.
 377      * @internal
 378      */
 379     static TimeZone* U_EXPORT2 forLocaleOrDefault(const Locale& locale);
 380 #endif  /* U_HIDE_INTERNAL_API */
 381
 382     /**
 383      * Sets the default time zone (i.e., what's returned by createDefault()) to be the
 384      * specified time zone.  If NULL is specified for the time zone, the default time
 385      * zone is set to the default host time zone.  This call adopts the TimeZone object
 386      * passed in; the client is no longer responsible for deleting it.
 387      *
 388      * @param zone  A pointer to the new TimeZone object to use as the default.
 389      * @stable ICU 2.0
 390      */
 391     static void U_EXPORT2 adoptDefault(TimeZone* zone);
 392
 393 #ifndef U_HIDE_SYSTEM_API
 394     /**
 395      * Same as adoptDefault(), except that the TimeZone object passed in is NOT adopted;
 396      * the caller remains responsible for deleting it.
 397      *
 398      * @param zone  The given timezone.
 399      * @system
 400      * @stable ICU 2.0
 401      */
 402     static void U_EXPORT2 setDefault(const TimeZone& zone);
 403 #endif  /* U_HIDE_SYSTEM_API */
 404
 405     /**
 406      * Returns the timezone data version currently used by ICU.
 407      * @param status Output param to filled in with a success or an error.
 408      * @return the version string, such as "2007f"
 409      * @stable ICU 3.8
 410      */
 411     static const char* U_EXPORT2 getTZDataVersion(UErrorCode& status);
 412
 413     /**
 414      * Returns the canonical system timezone ID or the normalized
 415      * custom time zone ID for the given time zone ID.
 416      * @param id            The input time zone ID to be canonicalized.
 417      * @param canonicalID   Receives the canonical system time zone ID
 418      *                      or the custom time zone ID in normalized format.
 419      * @param status        Receives the status.  When the given time zone ID
 420      *                      is neither a known system time zone ID nor a
 421      *                      valid custom time zone ID, U_ILLEGAL_ARGUMENT_ERROR
 422      *                      is set.
 423      * @return A reference to the result.
 424      * @stable ICU 4.0
 425      */
 426     static UnicodeString& U_EXPORT2 getCanonicalID(const UnicodeString& id,
 427         UnicodeString& canonicalID, UErrorCode& status);
 428
 429     /**
 430      * Returns the canonical system time zone ID or the normalized
 431      * custom time zone ID for the given time zone ID.
 432      * @param id            The input time zone ID to be canonicalized.
 433      * @param canonicalID   Receives the canonical system time zone ID
 434      *                      or the custom time zone ID in normalized format.
 435      * @param isSystemID    Receives if the given ID is a known system
 436      *                      time zone ID.
 437      * @param status        Receives the status.  When the given time zone ID
 438      *                      is neither a known system time zone ID nor a
 439      *                      valid custom time zone ID, U_ILLEGAL_ARGUMENT_ERROR
 440      *                      is set.
 441      * @return A reference to the result.
 442      * @stable ICU 4.0
 443      */
 444     static UnicodeString& U_EXPORT2 getCanonicalID(const UnicodeString& id,
 445         UnicodeString& canonicalID, UBool& isSystemID, UErrorCode& status);
 446
 447     /**
 448     * Converts a system time zone ID to an equivalent Windows time zone ID. For example,
 449     * Windows time zone ID "Pacific Standard Time" is returned for input "America/Los_Angeles".
 450     *
 451     * <p>There are system time zones that cannot be mapped to Windows zones. When the input
 452     * system time zone ID is unknown or unmappable to a Windows time zone, then the result will be
 453     * empty, but the operation itself remains successful (no error status set on return).
 454     *
 455     * <p>This implementation utilizes <a href="http://unicode.org/cldr/charts/supplemental/zone_tzid.html">
 456     * Zone-Tzid mapping data</a>. The mapping data is updated time to time. To get the latest changes,
 457     * please read the ICU user guide section <a href="https://unicode-org.github.io/icu/userguide/datetime/timezone#updating-the-time-zone-data">
 458     * Updating the Time Zone Data</a>.
 459     *
 460     * @param id        A system time zone ID.
 461     * @param winid     Receives a Windows time zone ID. When the input system time zone ID is unknown
 462     *                  or unmappable to a Windows time zone ID, then an empty string is set on return.
 463     * @param status    Receives the status.
 464     * @return          A reference to the result (<code>winid</code>).
 465     * @see getIDForWindowsID
 466     *
 467     * @stable ICU 52
 468     */
 469     static UnicodeString& U_EXPORT2 getWindowsID(const UnicodeString& id,
 470         UnicodeString& winid, UErrorCode& status);
 471
 472     /**
 473     * Converts a Windows time zone ID to an equivalent system time zone ID
 474     * for a region. For example, system time zone ID "America/Los_Angeles" is returned
 475     * for input Windows ID "Pacific Standard Time" and region "US" (or <code>null</code>),
 476     * "America/Vancouver" is returned for the same Windows ID "Pacific Standard Time" and
 477     * region "CA".
 478     *
 479     * <p>Not all Windows time zones can be mapped to system time zones. When the input
 480     * Windows time zone ID is unknown or unmappable to a system time zone, then the result
 481     * will be empty, but the operation itself remains successful (no error status set on return).
 482     *
 483     * <p>This implementation utilizes <a href="http://unicode.org/cldr/charts/supplemental/zone_tzid.html">
 484     * Zone-Tzid mapping data</a>. The mapping data is updated time to time. To get the latest changes,
 485     * please read the ICU user guide section <a href="https://unicode-org.github.io/icu/userguide/datetime/timezone#updating-the-time-zone-data">
 486     * Updating the Time Zone Data</a>.
 487     *
 488     * @param winid     A Windows time zone ID.
 489     * @param region    A null-terminated region code, or <code>NULL</code> if no regional preference.
 490     * @param id        Receives a system time zone ID. When the input Windows time zone ID is unknown
 491     *                  or unmappable to a system time zone ID, then an empty string is set on return.
 492     * @param status    Receives the status.
 493     * @return          A reference to the result (<code>id</code>).
 494     * @see getWindowsID
 495     *
 496     * @stable ICU 52
 497     */
 498     static UnicodeString& U_EXPORT2 getIDForWindowsID(const UnicodeString& winid, const char* region,
 499         UnicodeString& id, UErrorCode& status);
 500
 501     /**
 502      * Returns true if the two TimeZones are equal.  (The TimeZone version only compares
 503      * IDs, but subclasses are expected to also compare the fields they add.)
 504      *
 505      * @param that  The TimeZone object to be compared with.
 506      * @return      true if the given TimeZone is equal to this TimeZone; false
 507      *              otherwise.
 508      * @stable ICU 2.0
 509      */
 510     virtual bool operator==(const TimeZone& that) const;
 511
 512     /**
 513      * Returns true if the two TimeZones are NOT equal; that is, if operator==() returns
 514      * false.
 515      *
 516      * @param that  The TimeZone object to be compared with.
 517      * @return      true if the given TimeZone is not equal to this TimeZone; false
 518      *              otherwise.
 519      * @stable ICU 2.0
 520      */
 521     bool operator!=(const TimeZone& that) const {return !operator==(that);}
 522
 523     /**
 524      * Returns the TimeZone's adjusted GMT offset (i.e., the number of milliseconds to add
 525      * to GMT to get local time in this time zone, taking daylight savings time into
 526      * account) as of a particular reference date.  The reference date is used to determine
 527      * whether daylight savings time is in effect and needs to be figured into the offset
 528      * that is returned (in other words, what is the adjusted GMT offset in this time zone
 529      * at this particular date and time?).  For the time zones produced by createTimeZone(),
 530      * the reference data is specified according to the Gregorian calendar, and the date
 531      * and time fields are local standard time.
 532      *
 533      * <p>Note: Don't call this method. Instead, call the getOffset(UDate...) overload,
 534      * which returns both the raw and the DST offset for a given time. This method
 535      * is retained only for backward compatibility.
 536      *
 537      * @param era        The reference date's era
 538      * @param year       The reference date's year
 539      * @param month      The reference date's month (0-based; 0 is January)
 540      * @param day        The reference date's day-in-month (1-based)
 541      * @param dayOfWeek  The reference date's day-of-week (1-based; 1 is Sunday)
 542      * @param millis     The reference date's milliseconds in day, local standard time
 543      * @param status     Output param to filled in with a success or an error.
 544      * @return           The offset in milliseconds to add to GMT to get local time.
 545      * @stable ICU 2.0
 546      */
 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
 550     /**
 551      * Gets the time zone offset, for current date, modified in case of
 552      * daylight savings. This is the offset to add *to* UTC to get local time.
 553      *
 554      * <p>Note: Don't call this method. Instead, call the getOffset(UDate...) overload,
 555      * which returns both the raw and the DST offset for a given time. This method
 556      * is retained only for backward compatibility.
 557      *
 558      * @param era the era of the given date.
 559      * @param year the year in the given date.
 560      * @param month the month in the given date.
 561      * Month is 0-based. e.g., 0 for January.
 562      * @param day the day-in-month of the given date.
 563      * @param dayOfWeek the day-of-week of the given date.
 564      * @param milliseconds the millis in day in <em>standard</em> local time.
 565      * @param monthLength the length of the given month in days.
 566      * @param status     Output param to filled in with a success or an error.
 567      * @return the offset to add *to* GMT to get local time.
 568      * @stable ICU 2.0
 569      */
 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
 574     /**
 575      * Returns the time zone raw and GMT offset for the given moment
 576      * in time.  Upon return, local-millis = GMT-millis + rawOffset +
 577      * dstOffset.  All computations are performed in the proleptic
 578      * Gregorian calendar.  The default implementation in the TimeZone
 579      * class delegates to the 8-argument getOffset().
 580      *
 581      * @param date moment in time for which to return offsets, in
 582      * units of milliseconds from January 1, 1970 0:00 GMT, either GMT
 583      * time or local wall time, depending on `local'.
 584      * @param local if true, `date' is local wall time; otherwise it
 585      * is in GMT time.
 586      * @param rawOffset output parameter to receive the raw offset, that
 587      * is, the offset not including DST adjustments
 588      * @param dstOffset output parameter to receive the DST offset,
 589      * that is, the offset to be added to `rawOffset' to obtain the
 590      * total offset between local and GMT time. If DST is not in
 591      * effect, this value is zero; otherwise it is a positive value,
 592      * typically one hour.
 593      * @param ec input-output error code
 594      *
 595      * @stable ICU 2.8
 596      */
 597     virtual void getOffset(UDate date, UBool local, int32_t& rawOffset,
 598                            int32_t& dstOffset, UErrorCode& ec) const;
 599
 600     /**
 601      * Sets the TimeZone's raw GMT offset (i.e., the number of milliseconds to add
 602      * to GMT to get local time, before taking daylight savings time into account).
 603      *
 604      * @param offsetMillis  The new raw GMT offset for this time zone.
 605      * @stable ICU 2.0
 606      */
 607     virtual void setRawOffset(int32_t offsetMillis) = 0;
 608
 609     /**
 610      * Returns the TimeZone's raw GMT offset (i.e., the number of milliseconds to add
 611      * to GMT to get local time, before taking daylight savings time into account).
 612      *
 613      * @return   The TimeZone's raw GMT offset.
 614      * @stable ICU 2.0
 615      */
 616     virtual int32_t getRawOffset(void) const = 0;
 617
 618     /**
 619      * Fills in "ID" with the TimeZone's ID.
 620      *
 621      * @param ID  Receives this TimeZone's ID.
 622      * @return    A reference to 'ID'
 623      * @stable ICU 2.0
 624      */
 625     UnicodeString& getID(UnicodeString& ID) const;
 626
 627     /**
 628      * Sets the TimeZone's ID to the specified value.  This doesn't affect any other
 629      * fields (for example, if you say<
 630      * blockquote><pre>
 631      * .     TimeZone* foo = TimeZone::createTimeZone("America/New_York");
 632      * .     foo.setID("America/Los_Angeles");
 633      * </pre>\htmlonly</blockquote>\endhtmlonly
 634      * the time zone's GMT offset and daylight-savings rules don't change to those for
 635      * Los Angeles.  They're still those for New York.  Only the ID has changed.)
 636      *
 637      * @param ID  The new time zone ID.
 638      * @stable ICU 2.0
 639      */
 640     void setID(const UnicodeString& ID);
 641
 642     /**
 643      * Enum for use with getDisplayName
 644      * @stable ICU 2.4
 645      */
 646     enum EDisplayType {
 647         /**
 648          * Selector for short display name
 649          * @stable ICU 2.4
 650          */
 651         SHORT = 1,
 652         /**
 653          * Selector for long display name
 654          * @stable ICU 2.4
 655          */
 656         LONG,
 657         /**
 658          * Selector for short generic display name
 659          * @stable ICU 4.4
 660          */
 661         SHORT_GENERIC,
 662         /**
 663          * Selector for long generic display name
 664          * @stable ICU 4.4
 665          */
 666         LONG_GENERIC,
 667         /**
 668          * Selector for short display name derived
 669          * from time zone offset
 670          * @stable ICU 4.4
 671          */
 672         SHORT_GMT,
 673         /**
 674          * Selector for long display name derived
 675          * from time zone offset
 676          * @stable ICU 4.4
 677          */
 678         LONG_GMT,
 679         /**
 680          * Selector for short display name derived
 681          * from the time zone's fallback name
 682          * @stable ICU 4.4
 683          */
 684         SHORT_COMMONLY_USED,
 685         /**
 686          * Selector for long display name derived
 687          * from the time zone's fallback name
 688          * @stable ICU 4.4
 689          */
 690         GENERIC_LOCATION
 691     };
 692
 693     /**
 694      * Returns a name of this time zone suitable for presentation to the user
 695      * in the default locale.
 696      * This method returns the long name, not including daylight savings.
 697      * If the display name is not available for the locale,
 698      * then this method returns a string in the localized GMT offset format
 699      * such as <code>GMT[+-]HH:mm</code>.
 700      * @param result the human-readable name of this time zone in the default locale.
 701      * @return       A reference to 'result'.
 702      * @stable ICU 2.0
 703      */
 704     UnicodeString& getDisplayName(UnicodeString& result) const;
 705
 706     /**
 707      * Returns a name of this time zone suitable for presentation to the user
 708      * in the specified locale.
 709      * This method returns the long name, not including daylight savings.
 710      * If the display name is not available for the locale,
 711      * then this method returns a string in the localized GMT offset format
 712      * such as <code>GMT[+-]HH:mm</code>.
 713      * @param locale the locale in which to supply the display name.
 714      * @param result the human-readable name of this time zone in the given locale
 715      *               or in the default locale if the given locale is not recognized.
 716      * @return       A reference to 'result'.
 717      * @stable ICU 2.0
 718      */
 719     UnicodeString& getDisplayName(const Locale& locale, UnicodeString& result) const;
 720
 721     /**
 722      * Returns a name of this time zone suitable for presentation to the user
 723      * in the default locale.
 724      * If the display name is not available for the locale,
 725      * then this method returns a string in the localized GMT offset format
 726      * such as <code>GMT[+-]HH:mm</code>.
 727      * @param inDaylight if true, return the daylight savings name.
 728      * @param style
 729      * @param result the human-readable name of this time zone in the default locale.
 730      * @return       A reference to 'result'.
 731      * @stable ICU 2.0
 732      */
 733     UnicodeString& getDisplayName(UBool inDaylight, EDisplayType style, UnicodeString& result) const;
 734
 735     /**
 736      * Returns a name of this time zone suitable for presentation to the user
 737      * in the specified locale.
 738      * If the display name is not available for the locale,
 739      * then this method returns a string in the localized GMT offset format
 740      * such as <code>GMT[+-]HH:mm</code>.
 741      * @param inDaylight if true, return the daylight savings name.
 742      * @param style
 743      * @param locale the locale in which to supply the display name.
 744      * @param result the human-readable name of this time zone in the given locale
 745      *               or in the default locale if the given locale is not recognized.
 746      * @return       A reference to 'result'.
 747      * @stable ICU 2.0
 748      */
 749     UnicodeString& getDisplayName(UBool inDaylight, EDisplayType style, const Locale& locale, UnicodeString& result) const;
 750
 751     /**
 752      * Queries if this time zone uses daylight savings time.
 753      * @return true if this time zone uses daylight savings time,
 754      * false, otherwise.
 755      * <p><strong>Note:</strong>The default implementation of
 756      * ICU TimeZone uses the tz database, which supports historic
 757      * rule changes, for system time zones. With the implementation,
 758      * there are time zones that used daylight savings time in the
 759      * past, but no longer used currently. For example, Asia/Tokyo has
 760      * never used daylight savings time since 1951. Most clients would
 761      * expect that this method to return <code>false</code> for such case.
 762      * The default implementation of this method returns <code>true</code>
 763      * when the time zone uses daylight savings time in the current
 764      * (Gregorian) calendar year.
 765      * <p>In Java 7, <code>observesDaylightTime()</code> was added in
 766      * addition to <code>useDaylightTime()</code>. In Java, <code>useDaylightTime()</code>
 767      * only checks if daylight saving time is observed by the last known
 768      * rule. This specification might not be what most users would expect
 769      * if daylight saving time is currently observed, but not scheduled
 770      * in future. In this case, Java's <code>userDaylightTime()</code> returns
 771      * <code>false</code>. To resolve the issue, Java 7 added <code>observesDaylightTime()</code>,
 772      * which takes the current rule into account. The method <code>observesDaylightTime()</code>
 773      * was added in ICU4J for supporting API signature compatibility with JDK.
 774      * In general, ICU4C also provides JDK compatible methods, but the current
 775      * implementation <code>userDaylightTime()</code> serves the purpose
 776      * (takes the current rule into account), <code>observesDaylightTime()</code>
 777      * is not added in ICU4C. In addition to <code>useDaylightTime()</code>, ICU4C
 778      * <code>BasicTimeZone</code> class (Note that <code>TimeZone::createTimeZone(const UnicodeString &ID)</code>
 779      * always returns a <code>BasicTimeZone</code>) provides a series of methods allowing
 780      * historic and future time zone rule iteration, so you can check if daylight saving
 781      * time is observed or not within a given period.
 782      *
 783      * @stable ICU 2.0
 784      */
 785     virtual UBool useDaylightTime(void) const = 0;
 786
 787 #ifndef U_FORCE_HIDE_DEPRECATED_API
 788     /**
 789      * Queries if the given date is in daylight savings time in
 790      * this time zone.
 791      * This method is wasteful since it creates a new GregorianCalendar and
 792      * deletes it each time it is called. This is a deprecated method
 793      * and provided only for Java compatibility.
 794      *
 795      * @param date the given UDate.
 796      * @param status Output param filled in with success/error code.
 797      * @return true if the given date is in daylight savings time,
 798      * false, otherwise.
 799      * @deprecated ICU 2.4. Use Calendar::inDaylightTime() instead.
 800      */
 801     virtual UBool inDaylightTime(UDate date, UErrorCode& status) const = 0;
 802 #endif  // U_FORCE_HIDE_DEPRECATED_API
 803
 804     /**
 805      * Returns true if this zone has the same rule and offset as another zone.
 806      * That is, if this zone differs only in ID, if at all.
 807      * @param other the <code>TimeZone</code> object to be compared with
 808      * @return true if the given zone is the same as this one,
 809      * with the possible exception of the ID
 810      * @stable ICU 2.0
 811      */
 812     virtual UBool hasSameRules(const TimeZone& other) const;
 813
 814     /**
 815      * Clones TimeZone objects polymorphically. Clients are responsible for deleting
 816      * the TimeZone object cloned.
 817      *
 818      * @return   A new copy of this TimeZone object.
 819      * @stable ICU 2.0
 820      */
 821     virtual TimeZone* clone() const = 0;
 822
 823     /**
 824      * Return the class ID for this class.  This is useful only for
 825      * comparing to a return value from getDynamicClassID().
 826      * @return The class ID for all objects of this class.
 827      * @stable ICU 2.0
 828      */
 829     static UClassID U_EXPORT2 getStaticClassID(void);
 830
 831     /**
 832      * Returns a unique class ID POLYMORPHICALLY. This method is to
 833      * implement a simple version of RTTI, since not all C++ compilers support genuine
 834      * RTTI. Polymorphic operator==() and clone() methods call this method.
 835      * <P>
 836      * Concrete subclasses of TimeZone must use the UOBJECT_DEFINE_RTTI_IMPLEMENTATION
 837      *  macro from uobject.h in their implementation to provide correct RTTI information.
 838      * @return   The class ID for this object. All objects of a given class have the
 839      *           same class ID. Objects of other classes have different class IDs.
 840      * @stable ICU 2.0
 841      */
 842     virtual UClassID getDynamicClassID(void) const override = 0;
 843
 844     /**
 845      * Returns the amount of time to be added to local standard time
 846      * to get local wall clock time.
 847      * <p>
 848      * The default implementation always returns 3600000 milliseconds
 849      * (i.e., one hour) if this time zone observes Daylight Saving
 850      * Time. Otherwise, 0 (zero) is returned.
 851      * <p>
 852      * If an underlying TimeZone implementation subclass supports
 853      * historical Daylight Saving Time changes, this method returns
 854      * the known latest daylight saving value.
 855      *
 856      * @return the amount of saving time in milliseconds
 857      * @stable ICU 3.6
 858      */
 859     virtual int32_t getDSTSavings() const;
 860
 861     /**
 862      * Gets the region code associated with the given
 863      * system time zone ID. The region code is either ISO 3166
 864      * 2-letter country code or UN M.49 3-digit area code.
 865      * When the time zone is not associated with a specific location,
 866      * for example - "Etc/UTC", "EST5EDT", then this method returns
 867      * "001" (UN M.49 area code for World).
 868      *
 869      * @param id            The system time zone ID.
 870      * @param region        Output buffer for receiving the region code.
 871      * @param capacity      The size of the output buffer.
 872      * @param status        Receives the status.  When the given time zone ID
 873      *                      is not a known system time zone ID,
 874      *                      U_ILLEGAL_ARGUMENT_ERROR is set.
 875      * @return The length of the output region code.
 876      * @stable ICU 4.8
 877      */
 878     static int32_t U_EXPORT2 getRegion(const UnicodeString& id,
 879         char *region, int32_t capacity, UErrorCode& status);
 880
 881 protected:
 882
 883     /**
 884      * Default constructor.  ID is initialized to the empty string.
 885      * @stable ICU 2.0
 886      */
 887     TimeZone();
 888
 889     /**
 890      * Construct a TimeZone with a given ID.
 891      * @param id a system time zone ID
 892      * @stable ICU 2.0
 893      */
 894     TimeZone(const UnicodeString &id);
 895
 896     /**
 897      * Copy constructor.
 898      * @param source the object to be copied.
 899      * @stable ICU 2.0
 900      */
 901     TimeZone(const TimeZone& source);
 902
 903     /**
 904      * Default assignment operator.
 905      * @param right the object to be copied.
 906      * @stable ICU 2.0
 907      */
 908     TimeZone& operator=(const TimeZone& right);
 909
 910 #ifndef U_HIDE_INTERNAL_API
 911     /**
 912      * Utility function. For internally loading rule data.
 913      * @param top Top resource bundle for tz data
 914      * @param ruleid ID of rule to load
 915      * @param oldbundle Old bundle to reuse or NULL
 916      * @param status Status parameter
 917      * @return either a new bundle or *oldbundle
 918      * @internal
 919      */
 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
 929     /**
 930      * Finds the given ID in the Olson tzdata. If the given ID is found in the tzdata,
 931      * returns the pointer to the ID resource. This method is exposed through ZoneMeta class
 932      * for ICU internal implementation and useful for building hashtable using a time zone
 933      * ID as a key.
 934      * @param id zone id string
 935      * @return the pointer of the ID resource, or NULL.
 936      */
 937     static const char16_t* findID(const UnicodeString& id);
 938
 939     /**
 940      * Resolve a link in Olson tzdata.  When the given id is known and it's not a link,
 941      * the id itself is returned.  When the given id is known and it is a link, then
 942      * dereferenced zone id is returned.  When the given id is unknown, then it returns
 943      * NULL.
 944      * @param id zone id string
 945      * @return the dereferenced zone or NULL
 946      */
 947     static const char16_t* dereferOlsonLink(const UnicodeString& id);
 948
 949     /**
 950      * Returns the region code associated with the given zone,
 951      * or NULL if the zone is not known.
 952      * @param id zone id string
 953      * @return the region associated with the given zone
 954      */
 955     static const char16_t* getRegion(const UnicodeString& id);
 956
 957   public:
 958 #ifndef U_HIDE_INTERNAL_API
 959     /**
 960      * Returns the region code associated with the given zone,
 961      * or NULL if the zone is not known.
 962      * @param id zone id string
 963      * @param status Status parameter
 964      * @return the region associated with the given zone
 965      * @internal
 966      */
 967     static const char16_t* getRegion(const UnicodeString& id, UErrorCode& status);
 968 #endif  /* U_HIDE_INTERNAL_API */
 969
 970   private:
 971     /**
 972      * Parses the given custom time zone identifier
 973      * @param id id A string of the form GMT[+-]hh:mm, GMT[+-]hhmm, or
 974      * GMT[+-]hh.
 975      * @param sign Receives parsed sign, 1 for positive, -1 for negative.
 976      * @param hour Receives parsed hour field
 977      * @param minute Receives parsed minute field
 978      * @param second Receives parsed second field
 979      * @return Returns true when the given custom id is valid.
 980      */
 981     static UBool parseCustomID(const UnicodeString& id, int32_t& sign, int32_t& hour,
 982         int32_t& minute, int32_t& second);
 983
 984     /**
 985      * Parse a custom time zone identifier and return the normalized
 986      * custom time zone identifier for the given custom id string.
 987      * @param id a string of the form GMT[+-]hh:mm, GMT[+-]hhmm, or
 988      * GMT[+-]hh.
 989      * @param normalized Receives the normalized custom ID
 990      * @param status Receives the status.  When the input ID string is invalid,
 991      * U_ILLEGAL_ARGUMENT_ERROR is set.
 992      * @return The normalized custom id string.
 993     */
 994     static UnicodeString& getCustomID(const UnicodeString& id, UnicodeString& normalized,
 995         UErrorCode& status);
 996
 997     /**
 998      * Returns the normalized custom time zone ID for the given offset fields.
 999      * @param hour offset hours
1000      * @param min offset minutes
1001      * @param sec offset seconds
1002      * @param negative sign of the offset, true for negative offset.
1003      * @param id Receives the format result (normalized custom ID)
1004      * @return The reference to id
1005      */
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