ICU 78.3  78.3
calendar.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-2014, International Business Machines
6 * Corporation and others. All Rights Reserved.
7 ********************************************************************************
8 *
9 * File CALENDAR.H
10 *
11 * Modification History:
12 *
13 * Date Name Description
14 * 04/22/97 aliu Expanded and corrected comments and other header
15 * contents.
16 * 05/01/97 aliu Made equals(), before(), after() arguments const.
17 * 05/20/97 aliu Replaced fAreFieldsSet with fAreFieldsInSync and
18 * fAreAllFieldsSet.
19 * 07/27/98 stephen Sync up with JDK 1.2
20 * 11/15/99 weiv added YEAR_WOY and DOW_LOCAL
21 * to EDateFields
22 * 8/19/2002 srl Removed Javaisms
23 * 11/07/2003 srl Update, clean up documentation.
24 ********************************************************************************
25 */
26 
27 #ifndef CALENDAR_H
28 #define CALENDAR_H
29 
30 #include "unicode/utypes.h"
31 
32 #if U_SHOW_CPLUSPLUS_API
33 
38 #if !UCONFIG_NO_FORMATTING
39 
40 #include "unicode/uobject.h"
41 #include "unicode/locid.h"
42 #include "unicode/timezone.h"
43 #include "unicode/ucal.h"
44 #include "unicode/umisc.h"
45 
46 U_NAMESPACE_BEGIN
47 
48 class ICUServiceFactory;
49 
50 // Do not conditionalize the following with #ifndef U_HIDE_INTERNAL_API,
51 // it is a return type for a virtual method (@internal)
55 typedef int32_t UFieldResolutionTable[12][8];
56 
57 class BasicTimeZone;
189 class U_I18N_API_CLASS Calendar : public UObject {
190 public:
191 #ifndef U_FORCE_HIDE_DEPRECATED_API
192 
198  enum EDateFields {
199 #ifndef U_HIDE_DEPRECATED_API
200 /*
201  * ERA may be defined on other platforms. To avoid any potential problems undefined it here.
202  */
203 #ifdef ERA
204 #undef ERA
205 #endif
206  ERA, // Example: 0..1
207  YEAR, // Example: 1..big number
208  MONTH, // Example: 0..11
209  WEEK_OF_YEAR, // Example: 1..53
210  WEEK_OF_MONTH, // Example: 1..4
211  DATE, // Example: 1..31
212  DAY_OF_YEAR, // Example: 1..365
213  DAY_OF_WEEK, // Example: 1..7
214  DAY_OF_WEEK_IN_MONTH, // Example: 1..4, may be specified as -1
215  AM_PM, // Example: 0..1
216  HOUR, // Example: 0..11
217  HOUR_OF_DAY, // Example: 0..23
218  MINUTE, // Example: 0..59
219  SECOND, // Example: 0..59
220  MILLISECOND, // Example: 0..999
221  ZONE_OFFSET, // Example: -12*U_MILLIS_PER_HOUR..12*U_MILLIS_PER_HOUR
222  DST_OFFSET, // Example: 0 or U_MILLIS_PER_HOUR
223  YEAR_WOY, // 'Y' Example: 1..big number - Year of Week of Year
224  DOW_LOCAL, // 'e' Example: 1..7 - Day of Week / Localized
225 
226  EXTENDED_YEAR,
227  JULIAN_DAY,
228  MILLISECONDS_IN_DAY,
229  IS_LEAP_MONTH,
230 
231  FIELD_COUNT = UCAL_FIELD_COUNT // See ucal.h for other fields.
232 #endif /* U_HIDE_DEPRECATED_API */
233  };
234 #endif // U_FORCE_HIDE_DEPRECATED_API
235 
236 #ifndef U_HIDE_DEPRECATED_API
237 
243  enum EDaysOfWeek {
244  SUNDAY = 1,
245  MONDAY,
246  TUESDAY,
247  WEDNESDAY,
248  THURSDAY,
249  FRIDAY,
250  SATURDAY
251  };
252 
257  enum EMonths {
258  JANUARY,
259  FEBRUARY,
260  MARCH,
261  APRIL,
262  MAY,
263  JUNE,
264  JULY,
265  AUGUST,
266  SEPTEMBER,
267  OCTOBER,
268  NOVEMBER,
269  DECEMBER,
270  UNDECIMBER
271  };
272 
277  enum EAmpm {
278  AM,
279  PM
280  };
281 #endif /* U_HIDE_DEPRECATED_API */
282 
287  U_I18N_API virtual ~Calendar();
288 
295  U_I18N_API virtual Calendar* clone() const = 0;
296 
308  U_I18N_API static Calendar* U_EXPORT2 createInstance(UErrorCode& success);
309 
322  U_I18N_API static Calendar* U_EXPORT2 createInstance(TimeZone* zoneToAdopt, UErrorCode& success);
323 
335  U_I18N_API static Calendar* U_EXPORT2 createInstance(const TimeZone& zone, UErrorCode& success);
336 
347  U_I18N_API static Calendar* U_EXPORT2 createInstance(const Locale& aLocale, UErrorCode& success);
348 
362  U_I18N_API static Calendar* U_EXPORT2 createInstance(TimeZone* zoneToAdopt,
363  const Locale& aLocale,
364  UErrorCode& success);
365 
378  U_I18N_API static Calendar* U_EXPORT2 createInstance(const TimeZone& zone,
379  const Locale& aLocale,
380  UErrorCode& success);
381 
391  U_I18N_API static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
392 
409  U_I18N_API static StringEnumeration* U_EXPORT2 getKeywordValuesForLocale(const char* key,
410  const Locale& locale,
411  UBool commonlyUsed,
412  UErrorCode& status);
413 
421  U_I18N_API static UDate U_EXPORT2 getNow();
422 
436  U_I18N_API inline UDate getTime(UErrorCode& status) const { return getTimeInMillis(status); }
437 
448  U_I18N_API inline void setTime(UDate date, UErrorCode& status) { setTimeInMillis(date, status); }
449 
461  U_I18N_API virtual bool operator==(const Calendar& that) const;
462 
471  U_I18N_API bool operator!=(const Calendar& that) const { return !operator==(that); }
472 
483  U_I18N_API virtual UBool isEquivalentTo(const Calendar& other) const;
484 
499  U_I18N_API UBool equals(const Calendar& when, UErrorCode& status) const;
500 
514  U_I18N_API UBool before(const Calendar& when, UErrorCode& status) const;
515 
529  U_I18N_API UBool after(const Calendar& when, UErrorCode& status) const;
530 
531 #ifndef U_FORCE_HIDE_DEPRECATED_API
532 
552  U_I18N_API virtual void add(EDateFields field, int32_t amount, UErrorCode& status);
553 #endif // U_FORCE_HIDE_DEPRECATED_API
554 
575  U_I18N_API virtual void add(UCalendarDateFields field, int32_t amount, UErrorCode& status);
576 
577 #ifndef U_HIDE_DEPRECATED_API
578 
610  U_I18N_API inline void roll(EDateFields field, UBool up, UErrorCode& status);
611 #endif /* U_HIDE_DEPRECATED_API */
612 
645  U_I18N_API inline void roll(UCalendarDateFields field, UBool up, UErrorCode& status);
646 
647 #ifndef U_FORCE_HIDE_DEPRECATED_API
648 
679  U_I18N_API virtual void roll(EDateFields field, int32_t amount, UErrorCode& status);
680 #endif // U_FORCE_HIDE_DEPRECATED_API
681 
713  U_I18N_API virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode& status);
714 
715 #ifndef U_FORCE_HIDE_DEPRECATED_API
716 
771  U_I18N_API virtual int32_t fieldDifference(UDate when, EDateFields field, UErrorCode& status);
772 #endif // U_FORCE_HIDE_DEPRECATED_API
773 
829  U_I18N_API virtual int32_t fieldDifference(UDate when,
830  UCalendarDateFields field,
831  UErrorCode& status);
832 
841  U_I18N_API void adoptTimeZone(TimeZone* value);
842 
850  U_I18N_API void setTimeZone(const TimeZone& zone);
851 
860  U_I18N_API const TimeZone& getTimeZone() const;
861 
870  U_I18N_API TimeZone* orphanTimeZone();
871 
880  U_I18N_API virtual UBool inDaylightTime(UErrorCode& status) const;
881 
894  U_I18N_API void setLenient(UBool lenient);
895 
902  U_I18N_API UBool isLenient() const;
903 
924  U_I18N_API void setRepeatedWallTimeOption(UCalendarWallTimeOption option);
925 
935  U_I18N_API UCalendarWallTimeOption getRepeatedWallTimeOption() const;
936 
958  U_I18N_API void setSkippedWallTimeOption(UCalendarWallTimeOption option);
959 
970  U_I18N_API UCalendarWallTimeOption getSkippedWallTimeOption() const;
971 
978  U_I18N_API void setFirstDayOfWeek(UCalendarDaysOfWeek value);
979 
980 #ifndef U_HIDE_DEPRECATED_API
981 
987  U_I18N_API EDaysOfWeek getFirstDayOfWeek() const;
988 #endif /* U_HIDE_DEPRECATED_API */
989 
997  U_I18N_API UCalendarDaysOfWeek getFirstDayOfWeek(UErrorCode& status) const;
998 
1008  U_I18N_API void setMinimalDaysInFirstWeek(uint8_t value);
1009 
1019  U_I18N_API uint8_t getMinimalDaysInFirstWeek() const;
1020 
1021 #ifndef U_FORCE_HIDE_DEPRECATED_API
1022 
1030  U_I18N_API virtual int32_t getMinimum(EDateFields field) const;
1031 #endif // U_FORCE_HIDE_DEPRECATED_API
1032 
1041  U_I18N_API virtual int32_t getMinimum(UCalendarDateFields field) const;
1042 
1043 #ifndef U_FORCE_HIDE_DEPRECATED_API
1044 
1052  U_I18N_API virtual int32_t getMaximum(EDateFields field) const;
1053 #endif // U_FORCE_HIDE_DEPRECATED_API
1054 
1063  U_I18N_API virtual int32_t getMaximum(UCalendarDateFields field) const;
1064 
1065 #ifndef U_FORCE_HIDE_DEPRECATED_API
1066 
1074  U_I18N_API virtual int32_t getGreatestMinimum(EDateFields field) const;
1075 #endif // U_FORCE_HIDE_DEPRECATED_API
1076 
1085  U_I18N_API virtual int32_t getGreatestMinimum(UCalendarDateFields field) const;
1086 
1087 #ifndef U_FORCE_HIDE_DEPRECATED_API
1088 
1096  U_I18N_API virtual int32_t getLeastMaximum(EDateFields field) const;
1097 #endif // U_FORCE_HIDE_DEPRECATED_API
1098 
1107  U_I18N_API virtual int32_t getLeastMaximum(UCalendarDateFields field) const;
1108 
1109 #ifndef U_HIDE_DEPRECATED_API
1110 
1124  U_I18N_API int32_t getActualMinimum(EDateFields field, UErrorCode& status) const;
1125 #endif /* U_HIDE_DEPRECATED_API */
1126 
1141  U_I18N_API virtual int32_t getActualMinimum(UCalendarDateFields field, UErrorCode& status) const;
1142 
1159  U_I18N_API virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode& status) const;
1160 
1174  U_I18N_API int32_t get(UCalendarDateFields field, UErrorCode& status) const;
1175 
1184  U_I18N_API UBool isSet(UCalendarDateFields field) const;
1185 
1193  U_I18N_API void set(UCalendarDateFields field, int32_t value);
1194 
1205  U_I18N_API void set(int32_t year, int32_t month, int32_t date);
1206 
1219  U_I18N_API void set(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute);
1220 
1234  U_I18N_API void set(int32_t year, int32_t month, int32_t date,
1235  int32_t hour, int32_t minute, int32_t second);
1236 
1243  U_I18N_API void clear();
1244 
1254  U_I18N_API void clear(UCalendarDateFields field);
1255 
1271  U_I18N_API virtual UClassID getDynamicClassID() const override = 0;
1272 
1305  U_I18N_API virtual const char* getType() const = 0;
1306 
1323  U_I18N_API virtual UCalendarWeekdayType getDayOfWeekType(UCalendarDaysOfWeek dayOfWeek,
1324  UErrorCode& status) const;
1325 
1340  U_I18N_API virtual int32_t getWeekendTransition(UCalendarDaysOfWeek dayOfWeek,
1341  UErrorCode& status) const;
1342 
1352  U_I18N_API virtual UBool isWeekend(UDate date, UErrorCode& status) const;
1353 
1361  U_I18N_API virtual UBool isWeekend() const;
1362 
1377  U_I18N_API virtual bool inTemporalLeapYear(UErrorCode& status) const;
1378 
1397  U_I18N_API virtual const char* getTemporalMonthCode(UErrorCode& status) const;
1398 
1418  U_I18N_API virtual void setTemporalMonthCode(const char* temporalMonth, UErrorCode& status);
1419 
1420 protected:
1421 
1430  U_I18N_API Calendar(UErrorCode& success);
1431 
1438  U_I18N_API Calendar(const Calendar& source);
1439 
1446  U_I18N_API Calendar& operator=(const Calendar& right);
1447 
1458  U_I18N_API Calendar(TimeZone* zone, const Locale& aLocale, UErrorCode& success);
1459 
1469  U_I18N_API Calendar(const TimeZone& zone, const Locale& aLocale, UErrorCode& success);
1470 
1479  U_I18N_API virtual void computeTime(UErrorCode& status);
1480 
1492  U_I18N_API virtual void computeFields(UErrorCode& status);
1493 
1503  U_I18N_API double getTimeInMillis(UErrorCode& status) const;
1504 
1513  U_I18N_API void setTimeInMillis(double millis, UErrorCode& status);
1514 
1524  U_I18N_API void complete(UErrorCode& status);
1525 
1526 #ifndef U_HIDE_DEPRECATED_API
1527 
1535  U_I18N_API inline int32_t internalGet(EDateFields field) const { return fFields[field]; }
1536 #endif /* U_HIDE_DEPRECATED_API */
1537 
1538 #ifndef U_HIDE_INTERNAL_API
1539 
1549  U_I18N_API inline int32_t internalGet(UCalendarDateFields field, int32_t defaultValue) const {
1550  return fStamp[field] > kUnset ? fFields[field] : defaultValue;
1551  }
1552 
1561  U_I18N_API inline int32_t internalGet(UCalendarDateFields field) const { return fFields[field]; }
1562 
1568  U_I18N_API virtual bool isEra0CountingBackward() const { return false; }
1569 
1575  U_I18N_API virtual int32_t getRelatedYearDifference() const;
1576 
1577 #endif /* U_HIDE_INTERNAL_API */
1578 
1588  U_I18N_API virtual int32_t internalGetMonth(UErrorCode& status) const;
1589 
1603  U_I18N_API virtual int32_t internalGetMonth(int32_t defaultValue, UErrorCode& status) const;
1604 
1605 #ifndef U_HIDE_DEPRECATED_API
1606 
1615  U_I18N_API void internalSet(EDateFields field, int32_t value);
1616 #endif /* U_HIDE_DEPRECATED_API */
1617 
1627  U_I18N_API inline void internalSet(UCalendarDateFields field, int32_t value);
1628 
1635  U_I18N_API virtual void prepareGetActual(UCalendarDateFields field,
1636  UBool isMinimum,
1637  UErrorCode& status);
1638 
1643  enum ELimitType {
1644 #ifndef U_HIDE_INTERNAL_API
1645  UCAL_LIMIT_MINIMUM = 0,
1646  UCAL_LIMIT_GREATEST_MINIMUM,
1647  UCAL_LIMIT_LEAST_MAXIMUM,
1648  UCAL_LIMIT_MAXIMUM,
1649  UCAL_LIMIT_COUNT
1650 #endif /* U_HIDE_INTERNAL_API */
1651  };
1652 
1674  U_I18N_API virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const = 0;
1675 
1683  U_I18N_API virtual int32_t getLimit(UCalendarDateFields field, ELimitType limitType) const;
1684 
1700  U_I18N_API virtual int64_t handleComputeMonthStart(int32_t eyear,
1701  int32_t month,
1702  UBool useMonth,
1703  UErrorCode& status) const = 0;
1704 
1712  U_I18N_API virtual int32_t handleGetMonthLength(int32_t extendedYear,
1713  int32_t month,
1714  UErrorCode& status) const;
1715 
1723  U_I18N_API virtual int32_t handleGetYearLength(int32_t eyear, UErrorCode& status) const;
1724 
1734  U_I18N_API virtual int32_t handleGetExtendedYear(UErrorCode& status) = 0;
1735 
1745  U_I18N_API virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField, UErrorCode& status);
1746 
1755  U_I18N_API virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy,
1756  int32_t woy,
1757  UErrorCode& status);
1758 
1765  U_I18N_API virtual void validateField(UCalendarDateFields field, UErrorCode& status);
1766 
1767 #ifndef U_HIDE_INTERNAL_API
1768 
1775  U_I18N_API int32_t computeJulianDay(UErrorCode& status);
1776 
1784  U_I18N_API double computeMillisInDay();
1785 
1795  U_I18N_API int32_t computeZoneOffset(double millis, double millisInDay, UErrorCode& ec);
1796 
1805  U_I18N_API int32_t newestStamp(UCalendarDateFields start,
1806  UCalendarDateFields end,
1807  int32_t bestSoFar) const;
1808 
1815  U_I18N_API static constexpr int32_t kResolveSTOP = -1;
1816 
1826  U_I18N_API static constexpr int32_t kResolveRemap = 32;
1827 
1833  U_I18N_API static const UFieldResolutionTable kDatePrecedence[];
1834 
1840  U_I18N_API static const UFieldResolutionTable kYearPrecedence[];
1841 
1847  U_I18N_API static const UFieldResolutionTable kDOWPrecedence[];
1848 
1854  U_I18N_API static const UFieldResolutionTable kMonthPrecedence[];
1855 
1883  U_I18N_API UCalendarDateFields resolveFields(const UFieldResolutionTable* precedenceTable) const;
1884 #endif /* U_HIDE_INTERNAL_API */
1885 
1889  U_I18N_API virtual const UFieldResolutionTable* getFieldResolutionTable() const;
1890 
1891 #ifndef U_HIDE_INTERNAL_API
1892 
1897  U_I18N_API UCalendarDateFields newerField(UCalendarDateFields defaultField,
1898  UCalendarDateFields alternateField) const;
1899 #endif /* U_HIDE_INTERNAL_API */
1900 
1901 
1902 private:
1910  int32_t getActualHelper(UCalendarDateFields field, int32_t startValue, int32_t endValue, UErrorCode &status) const;
1911 
1912 protected:
1919  U_I18N_API UDate internalGetTime() const { return fTime; }
1920 
1928  U_I18N_API void internalSetTime(UDate time) { fTime = time; }
1929 
1934  int32_t fFields[UCAL_FIELD_COUNT];
1935 
1936 protected:
1940  enum {
1941  kUnset = 0,
1942  kInternallySet,
1943  kMinimumUserStamp
1944  };
1945 
1946 private:
1952  int8_t fStamp[UCAL_FIELD_COUNT];
1953 
1954 protected:
1979  U_I18N_API virtual void handleComputeFields(int32_t julianDay, UErrorCode& status);
1980 
1981 #ifndef U_HIDE_INTERNAL_API
1982 
1987  U_I18N_API int32_t getGregorianYear() const {
1988  return fGregorianYear;
1989  }
1990 
1996  U_I18N_API int32_t getGregorianMonth() const {
1997  return fGregorianMonth;
1998  }
1999 
2005  U_I18N_API int32_t getGregorianDayOfYear() const {
2006  return fGregorianDayOfYear;
2007  }
2008 
2014  U_I18N_API int32_t getGregorianDayOfMonth() const {
2015  return fGregorianDayOfMonth;
2016  }
2017 #endif /* U_HIDE_INTERNAL_API */
2018 
2027  U_I18N_API virtual int32_t getDefaultMonthInYear(int32_t eyear, UErrorCode& status);
2028 
2038  U_I18N_API virtual int32_t getDefaultDayInMonth(int32_t eyear, int32_t month, UErrorCode& status);
2039 
2040  //-------------------------------------------------------------------------
2041  // Protected utility methods for use by subclasses. These are very handy
2042  // for implementing add, roll, and computeFields.
2043  //-------------------------------------------------------------------------
2044 
2074  U_I18N_API virtual void pinField(UCalendarDateFields field, UErrorCode& status);
2075 
2119  U_I18N_API int32_t weekNumber(int32_t desiredDay, int32_t dayOfPeriod, int32_t dayOfWeek);
2120 
2121 #ifndef U_HIDE_INTERNAL_API
2122 
2152  U_I18N_API inline int32_t weekNumber(int32_t dayOfPeriod, int32_t dayOfWeek);
2153 
2158  U_I18N_API int32_t getLocalDOW(UErrorCode& status);
2159 #endif /* U_HIDE_INTERNAL_API */
2160 
2161 private:
2162 
2166  int8_t fNextStamp = kMinimumUserStamp;
2167 
2172  void recalculateStamp();
2173 
2177  UDate fTime = 0;
2178 
2183  TimeZone* fZone = nullptr;
2184 
2188  bool fIsTimeSet:1;
2189 
2199  bool fAreFieldsSet:1;
2200 
2205  bool fAreAllFieldsSet:1;
2206 
2213  bool fAreFieldsVirtuallySet:1;
2214 
2218  bool fLenient:1;
2219 
2224  UCalendarWallTimeOption fRepeatedWallTime:3; // Somehow MSVC need 3 bits for UCalendarWallTimeOption
2225 
2230  UCalendarWallTimeOption fSkippedWallTime:3; // Somehow MSVC need 3 bits for UCalendarWallTimeOption
2231 
2240  UCalendarDaysOfWeek fFirstDayOfWeek:4; // Somehow MSVC need 4 bits for
2241  // UCalendarDaysOfWeek
2242  UCalendarDaysOfWeek fWeekendOnset:4; // Somehow MSVC need 4 bits for
2243  // UCalendarDaysOfWeek
2244  UCalendarDaysOfWeek fWeekendCease:4; // Somehow MSVC need 4 bits for
2245  // UCalendarDaysOfWeek
2246  uint8_t fMinimalDaysInFirstWeek;
2247  int32_t fWeekendOnsetMillis;
2248  int32_t fWeekendCeaseMillis;
2249 
2260  void setWeekData(const Locale& desiredLocale, const char *type, UErrorCode& success);
2261 
2271  void updateTime(UErrorCode& status);
2272 
2278  int32_t fGregorianYear;
2279 
2285  int8_t fGregorianMonth;
2286 
2292  int8_t fGregorianDayOfMonth;
2293 
2299  int16_t fGregorianDayOfYear;
2300 
2301  /* calculations */
2302 
2303 protected:
2304 
2312  U_I18N_API void computeGregorianFields(int32_t julianDay, UErrorCode& ec);
2313 
2314 private:
2315 
2336  void computeWeekFields(UErrorCode &ec);
2337 
2338 
2346  void validateFields(UErrorCode &status);
2347 
2355  void validateField(UCalendarDateFields field, int32_t min, int32_t max, UErrorCode& status);
2356 
2357  protected:
2358 #ifndef U_HIDE_INTERNAL_API
2359 
2368  U_I18N_API static uint8_t julianDayToDayOfWeek(int32_t julian);
2369 #endif /* U_HIDE_INTERNAL_API */
2370 
2371  private:
2372  Locale validLocale;
2373  Locale actualLocale;
2374 
2375  public:
2376 #if !UCONFIG_NO_SERVICE
2377 
2381 #ifndef U_HIDE_INTERNAL_API
2382 
2388  U_I18N_API static StringEnumeration* getAvailableLocales();
2389 
2403  U_I18N_API static URegistryKey registerFactory(ICUServiceFactory* toAdopt, UErrorCode& status);
2404 
2420  U_I18N_API static UBool unregister(URegistryKey key, UErrorCode& status);
2421 #endif /* U_HIDE_INTERNAL_API */
2422 
2427  friend class CalendarFactory;
2428 
2433  friend class CalendarService;
2434 
2439  friend class DefaultCalendarFactory;
2440 #endif /* !UCONFIG_NO_SERVICE */
2441 
2446  U_I18N_API virtual UBool haveDefaultCentury() const = 0;
2447 
2452  U_I18N_API virtual UDate defaultCenturyStart() const = 0;
2453 
2458  U_I18N_API virtual int32_t defaultCenturyStartYear() const = 0;
2459 
2466  U_I18N_API Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;
2467 
2473  U_I18N_API virtual int32_t getRelatedYear(UErrorCode& status) const;
2474 
2480  U_I18N_API virtual void setRelatedYear(int32_t year);
2481 
2482 #ifndef U_HIDE_INTERNAL_API
2483 
2489  U_I18N_API const char* getLocaleID(ULocDataLocaleType type, UErrorCode& status) const;
2490 #endif /* U_HIDE_INTERNAL_API */
2491 
2492 private:
2497  BasicTimeZone* getBasicTimeZone() const;
2498 
2506  UBool getImmediatePreviousZoneTransition(UDate base, UDate *transitionTime, UErrorCode& status) const;
2507 
2508 public:
2509 #ifndef U_HIDE_INTERNAL_API
2510 
2518  U_I18N_API static Calendar* U_EXPORT2 makeInstance(const Locale& locale, UErrorCode& status);
2519 
2530  U_I18N_API static void U_EXPORT2 getCalendarTypeFromLocale(const Locale& locale,
2531  char* typeBuffer,
2532  int32_t typeBufferSize,
2533  UErrorCode& status);
2534 #endif /* U_HIDE_INTERNAL_API */
2535 };
2536 
2537 // -------------------------------------
2538 
2539 inline Calendar*
2540 Calendar::createInstance(TimeZone* zone, UErrorCode& errorCode)
2541 {
2542  // since the Locale isn't specified, use the default locale
2543  return createInstance(zone, Locale::getDefault(), errorCode);
2544 }
2545 
2546 // -------------------------------------
2547 
2548 inline void
2549 Calendar::roll(UCalendarDateFields field, UBool up, UErrorCode& status)
2550 {
2551  roll(field, static_cast<int32_t>(up ? +1 : -1), status);
2552 }
2553 
2554 #ifndef U_HIDE_DEPRECATED_API
2555 inline void
2556 Calendar::roll(EDateFields field, UBool up, UErrorCode& status)
2557 {
2558  roll(static_cast<UCalendarDateFields>(field), up, status);
2559 }
2560 #endif /* U_HIDE_DEPRECATED_API */
2561 
2562 
2563 // -------------------------------------
2564 
2570 inline void
2571 Calendar::internalSet(UCalendarDateFields field, int32_t value)
2572 {
2573  fFields[field] = value;
2574  fStamp[field] = kInternallySet;
2575 }
2576 
2583 #define DECLARE_OVERRIDE_SYSTEM_DEFAULT_CENTURY \
2584  virtual UBool haveDefaultCentury() const override; \
2585  virtual UDate defaultCenturyStart() const override; \
2586  virtual int32_t defaultCenturyStartYear() const override;
2587 
2588 #ifndef U_HIDE_INTERNAL_API
2589 inline int32_t Calendar::weekNumber(int32_t dayOfPeriod, int32_t dayOfWeek)
2590 {
2591  return weekNumber(dayOfPeriod, dayOfPeriod, dayOfWeek);
2592 }
2593 #endif /* U_HIDE_INTERNAL_API */
2594 
2595 U_NAMESPACE_END
2596 
2597 #endif /* #if !UCONFIG_NO_FORMATTING */
2598 
2599 #endif /* U_SHOW_CPLUSPLUS_API */
2600 
2601 #endif // _CALENDAR
U_I18N_API_CLASS
#define U_I18N_API_CLASS
Definition: utypes.h:457
icu::Calendar::ELimitType
ELimitType
Limit enums.
Definition: calendar.h:1643
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UCalendarWallTimeOption
UCalendarWallTimeOption
Options for handling ambiguous wall time at time zone offset transitions.
Definition: ucal.h:991
U_I18N_API
#define U_I18N_API
Definition: utypes.h:316
icu::Calendar
Calendar is an abstract base class for converting between a UDate object and a set of integer fields ...
Definition: calendar.h:189
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
icu::BasicTimeZone
BasicTimeZone is an abstract class extending TimeZone.
Definition: basictz.h:38
ULocDataLocaleType
ULocDataLocaleType
Constants for *_getLocale() Allow user to select whether she wants information on requested,...
Definition: uloc.h:338
icu::Calendar::internalGetTime
U_I18N_API UDate internalGetTime() const
Get the current time without recomputing.
Definition: calendar.h:1919
icu::Calendar::operator!=
U_I18N_API bool operator!=(const Calendar &that) const
Compares the inequality of two Calendar objects.
Definition: calendar.h:471
icu::Calendar::getGregorianYear
U_I18N_API int32_t getGregorianYear() const
Return the extended year on the Gregorian calendar as computed by computeGregorianFields().
Definition: calendar.h:1987
icu::TimeZone
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:133
icu::Calendar::getTime
U_I18N_API UDate getTime(UErrorCode &status) const
Gets this Calendar's time as milliseconds.
Definition: calendar.h:436
icu::Calendar::EAmpm
EAmpm
Useful constants for hour in 12-hour clock.
Definition: calendar.h:277
umisc.h
C API: Miscellaneous definitions.
timezone.h
C++ API: TimeZone object.
icu::Calendar::isEra0CountingBackward
virtual U_I18N_API bool isEra0CountingBackward() const
The year in this calendar is counting from 1 backward if the era is 0.
Definition: calendar.h:1568
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:222
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:509
icu::StringEnumeration
Base class for 'pure' C++ implementations of uenum api.
Definition: strenum.h:61
icu::UObject::getDynamicClassID
virtual UClassID getDynamicClassID() const
ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.
icu::Calendar::setTime
U_I18N_API void setTime(UDate date, UErrorCode &status)
Sets this Calendar's current time with the given UDate.
Definition: calendar.h:448
icu::Calendar::internalGet
U_I18N_API int32_t internalGet(UCalendarDateFields field, int32_t defaultValue) const
Gets the value for a given time field.
Definition: calendar.h:1549
ucal.h
C API: Calendar.
icu::Calendar::getGregorianDayOfYear
U_I18N_API int32_t getGregorianDayOfYear() const
Return the day of year (1-based) on the Gregorian calendar as computed by computeGregorianFields().
Definition: calendar.h:2005
icu::operator==
U_COMMON_API UBool operator==(const StringPiece &x, const StringPiece &y)
Global operator == for StringPiece.
UCalendarWeekdayType
UCalendarWeekdayType
Weekday types, as returned by ucal_getDayOfWeekType().
Definition: ucal.h:1455
icu::Calendar::internalGet
U_I18N_API int32_t internalGet(EDateFields field) const
Gets the value for a given time field.
Definition: calendar.h:1535
UCAL_FIELD_COUNT
@ UCAL_FIELD_COUNT
One more than the highest normal UCalendarDateFields value.
Definition: ucal.h:477
UCalendarDaysOfWeek
UCalendarDaysOfWeek
Useful constant for days of week.
Definition: ucal.h:502
UDate
double UDate
Date and Time data type.
Definition: utypes.h:218
icu::Calendar::internalGet
U_I18N_API int32_t internalGet(UCalendarDateFields field) const
Gets the value for a given time field.
Definition: calendar.h:1561
icu::UFieldResolutionTable
int32_t UFieldResolutionTable[12][8]
Definition: calendar.h:48
icu::Calendar::getGregorianMonth
U_I18N_API int32_t getGregorianMonth() const
Return the month (0-based) on the Gregorian calendar as computed by computeGregorianFields().
Definition: calendar.h:1996
UCalendarDateFields
UCalendarDateFields
Possible fields in a UCalendar.
Definition: ucal.h:202
icu::Calendar::EMonths
EMonths
Useful constants for month.
Definition: calendar.h:257
locid.h
C++ API: Locale ID object.
icu::Calendar::EDaysOfWeek
EDaysOfWeek
Useful constant for days of week.
Definition: calendar.h:243
uobject.h
C++ API: Common ICU base class UObject.
icu::Calendar::EDateFields
EDateFields
Field IDs for date and time.
Definition: calendar.h:198
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:198
icu::Calendar::internalSetTime
U_I18N_API void internalSetTime(UDate time)
Set the current time without affecting flags or fields.
Definition: calendar.h:1928
URegistryKey
const typedef void * URegistryKey
Opaque type returned by registerInstance, registerFactory and unregister for service registration.
Definition: umisc.h:57
icu::Calendar::getGregorianDayOfMonth
U_I18N_API int32_t getGregorianDayOfMonth() const
Return the day of month (1-based) on the Gregorian calendar as computed by computeGregorianFields().
Definition: calendar.h:2014
Generated by   doxygen 1.8.17