ICU 4.8.1.1  4.8.1.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
calendar.h
Go to the documentation of this file.
1 /*
2 ********************************************************************************
3 * Copyright (C) 1997-2011, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 ********************************************************************************
6 *
7 * File CALENDAR.H
8 *
9 * Modification History:
10 *
11 * Date Name Description
12 * 04/22/97 aliu Expanded and corrected comments and other header
13 * contents.
14 * 05/01/97 aliu Made equals(), before(), after() arguments const.
15 * 05/20/97 aliu Replaced fAreFieldsSet with fAreFieldsInSync and
16 * fAreAllFieldsSet.
17 * 07/27/98 stephen Sync up with JDK 1.2
18 * 11/15/99 weiv added YEAR_WOY and DOW_LOCAL
19 * to EDateFields
20 * 8/19/2002 srl Removed Javaisms
21 * 11/07/2003 srl Update, clean up documentation.
22 ********************************************************************************
23 */
24 
25 #ifndef CALENDAR_H
26 #define CALENDAR_H
27 
28 #include "unicode/utypes.h"
29 
34 #if !UCONFIG_NO_FORMATTING
35 
36 #include "unicode/uobject.h"
37 #include "unicode/locid.h"
38 #include "unicode/timezone.h"
39 #include "unicode/ucal.h"
40 #include "unicode/umisc.h"
41 
43 
44 class ICUServiceFactory;
45 
49 typedef int32_t UFieldResolutionTable[12][8];
50 
165 class U_I18N_API Calendar : public UObject {
166 public:
167 
174  enum EDateFields {
175 #ifndef U_HIDE_DEPRECATED_API
176 /*
177  * ERA may be defined on other platforms. To avoid any potential problems undefined it here.
178  */
179 #ifdef ERA
180 #undef ERA
181 #endif
182  ERA, // Example: 0..1
183  YEAR, // Example: 1..big number
184  MONTH, // Example: 0..11
185  WEEK_OF_YEAR, // Example: 1..53
186  WEEK_OF_MONTH, // Example: 1..4
187  DATE, // Example: 1..31
188  DAY_OF_YEAR, // Example: 1..365
189  DAY_OF_WEEK, // Example: 1..7
190  DAY_OF_WEEK_IN_MONTH, // Example: 1..4, may be specified as -1
191  AM_PM, // Example: 0..1
192  HOUR, // Example: 0..11
193  HOUR_OF_DAY, // Example: 0..23
194  MINUTE, // Example: 0..59
195  SECOND, // Example: 0..59
196  MILLISECOND, // Example: 0..999
197  ZONE_OFFSET, // Example: -12*U_MILLIS_PER_HOUR..12*U_MILLIS_PER_HOUR
198  DST_OFFSET, // Example: 0 or U_MILLIS_PER_HOUR
199  YEAR_WOY, // 'Y' Example: 1..big number - Year of Week of Year
200  DOW_LOCAL, // 'e' Example: 1..7 - Day of Week / Localized
201 
202  EXTENDED_YEAR,
203  JULIAN_DAY,
204  MILLISECONDS_IN_DAY,
205  IS_LEAP_MONTH,
206 
207  FIELD_COUNT = UCAL_FIELD_COUNT // See ucal.h for other fields.
208 #endif /* U_HIDE_DEPRECATED_API */
209  };
210 
217  enum EDaysOfWeek {
218 #ifndef U_HIDE_DEPRECATED_API
219  SUNDAY = 1,
220  MONDAY,
221  TUESDAY,
222  WEDNESDAY,
223  THURSDAY,
224  FRIDAY,
225  SATURDAY
226 #endif /* U_HIDE_DEPRECATED_API */
227  };
228 
233  enum EMonths {
234 #ifndef U_HIDE_DEPRECATED_API
235  JANUARY,
236  FEBRUARY,
237  MARCH,
238  APRIL,
239  MAY,
240  JUNE,
241  JULY,
242  AUGUST,
243  SEPTEMBER,
244  OCTOBER,
245  NOVEMBER,
246  DECEMBER,
247  UNDECIMBER
248 #endif /* U_HIDE_DEPRECATED_API */
249  };
250 
255  enum EAmpm {
256 #ifndef U_HIDE_DEPRECATED_API
257  AM,
258  PM
259 #endif /* U_HIDE_DEPRECATED_API */
260  };
261 
266  virtual ~Calendar();
267 
274  virtual Calendar* clone(void) const = 0;
275 
287  static Calendar* U_EXPORT2 createInstance(UErrorCode& success);
288 
301  static Calendar* U_EXPORT2 createInstance(TimeZone* zoneToAdopt, UErrorCode& success);
302 
314  static Calendar* U_EXPORT2 createInstance(const TimeZone& zone, UErrorCode& success);
315 
326  static Calendar* U_EXPORT2 createInstance(const Locale& aLocale, UErrorCode& success);
327 
341  static Calendar* U_EXPORT2 createInstance(TimeZone* zoneToAdopt, const Locale& aLocale, UErrorCode& success);
342 
355  static Calendar* U_EXPORT2 createInstance(const TimeZone& zoneToAdopt, const Locale& aLocale, UErrorCode& success);
356 
366  static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
367 
368 
385  static StringEnumeration* U_EXPORT2 getKeywordValuesForLocale(const char* key,
386  const Locale& locale, UBool commonlyUsed, UErrorCode& status);
387 
395  static UDate U_EXPORT2 getNow(void);
396 
410  inline UDate getTime(UErrorCode& status) const { return getTimeInMillis(status); }
411 
422  inline void setTime(UDate date, UErrorCode& status) { setTimeInMillis(date, status); }
423 
435  virtual UBool operator==(const Calendar& that) const;
436 
445  UBool operator!=(const Calendar& that) const {return !operator==(that);}
446 
457  virtual UBool isEquivalentTo(const Calendar& other) const;
458 
473  UBool equals(const Calendar& when, UErrorCode& status) const;
474 
488  UBool before(const Calendar& when, UErrorCode& status) const;
489 
503  UBool after(const Calendar& when, UErrorCode& status) const;
504 
522  virtual void add(EDateFields field, int32_t amount, UErrorCode& status);
523 
541  virtual void add(UCalendarDateFields field, int32_t amount, UErrorCode& status);
542 
566  inline void roll(EDateFields field, UBool up, UErrorCode& status);
567 
591  inline void roll(UCalendarDateFields field, UBool up, UErrorCode& status);
592 
615  virtual void roll(EDateFields field, int32_t amount, UErrorCode& status);
616 
639  virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode& status);
640 
696  virtual int32_t fieldDifference(UDate when, EDateFields field, UErrorCode& status);
697 
753  virtual int32_t fieldDifference(UDate when, UCalendarDateFields field, UErrorCode& status);
754 
763  void adoptTimeZone(TimeZone* value);
764 
772  void setTimeZone(const TimeZone& zone);
773 
782  const TimeZone& getTimeZone(void) const;
783 
792  TimeZone* orphanTimeZone(void);
793 
802  virtual UBool inDaylightTime(UErrorCode& status) const = 0;
803 
816  void setLenient(UBool lenient);
817 
824  UBool isLenient(void) const;
825 
832  void setFirstDayOfWeek(EDaysOfWeek value);
833 
840  void setFirstDayOfWeek(UCalendarDaysOfWeek value);
841 
848  EDaysOfWeek getFirstDayOfWeek(void) const;
849 
857  UCalendarDaysOfWeek getFirstDayOfWeek(UErrorCode &status) const;
858 
868  void setMinimalDaysInFirstWeek(uint8_t value);
869 
879  uint8_t getMinimalDaysInFirstWeek(void) const;
880 
889  virtual int32_t getMinimum(EDateFields field) const;
890 
899  virtual int32_t getMinimum(UCalendarDateFields field) const;
900 
909  virtual int32_t getMaximum(EDateFields field) const;
910 
919  virtual int32_t getMaximum(UCalendarDateFields field) const;
920 
929  virtual int32_t getGreatestMinimum(EDateFields field) const;
930 
939  virtual int32_t getGreatestMinimum(UCalendarDateFields field) const;
940 
949  virtual int32_t getLeastMaximum(EDateFields field) const;
950 
959  virtual int32_t getLeastMaximum(UCalendarDateFields field) const;
960 
975  int32_t getActualMinimum(EDateFields field, UErrorCode& status) const;
976 
991  virtual int32_t getActualMinimum(UCalendarDateFields field, UErrorCode& status) const;
992 
1009  int32_t getActualMaximum(EDateFields field, UErrorCode& status) const;
1010 
1027  virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode& status) const;
1028 
1042  int32_t get(EDateFields field, UErrorCode& status) const;
1043 
1057  int32_t get(UCalendarDateFields field, UErrorCode& status) const;
1058 
1067  UBool isSet(EDateFields field) const;
1068 
1077  UBool isSet(UCalendarDateFields field) const;
1078 
1086  void set(EDateFields field, int32_t value);
1087 
1095  void set(UCalendarDateFields field, int32_t value);
1096 
1107  void set(int32_t year, int32_t month, int32_t date);
1108 
1121  void set(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute);
1122 
1136  void set(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second);
1137 
1144  void clear(void);
1145 
1154  void clear(EDateFields field);
1155 
1164  void clear(UCalendarDateFields field);
1165 
1181  virtual UClassID getDynamicClassID(void) const = 0;
1182 
1191  virtual const char * getType() const = 0;
1192 
1208  virtual UCalendarWeekdayType getDayOfWeekType(UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const;
1209 
1224  virtual int32_t getWeekendTransition(UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const;
1225 
1235  virtual UBool isWeekend(UDate date, UErrorCode &status) const;
1236 
1244  virtual UBool isWeekend(void) const;
1245 
1246 protected:
1247 
1256  Calendar(UErrorCode& success);
1257 
1264  Calendar(const Calendar& source);
1265 
1272  Calendar& operator=(const Calendar& right);
1273 
1284  Calendar(TimeZone* zone, const Locale& aLocale, UErrorCode& success);
1285 
1295  Calendar(const TimeZone& zone, const Locale& aLocale, UErrorCode& success);
1296 
1305  virtual void computeTime(UErrorCode& status);
1306 
1318  virtual void computeFields(UErrorCode& status);
1319 
1329  double getTimeInMillis(UErrorCode& status) const;
1330 
1339  void setTimeInMillis( double millis, UErrorCode& status );
1340 
1350  void complete(UErrorCode& status);
1351 
1360  inline int32_t internalGet(EDateFields field) const {return fFields[field];}
1361 
1372  inline int32_t internalGet(UCalendarDateFields field, int32_t defaultValue) const {return fStamp[field]>kUnset ? fFields[field] : defaultValue;}
1373 
1382  inline int32_t internalGet(UCalendarDateFields field) const {return fFields[field];}
1383 
1393  void internalSet(EDateFields field, int32_t value);
1394 
1404  inline void internalSet(UCalendarDateFields field, int32_t value);
1405 
1412  virtual void prepareGetActual(UCalendarDateFields field, UBool isMinimum, UErrorCode &status);
1413 
1418  enum ELimitType {
1419  UCAL_LIMIT_MINIMUM = 0,
1420  UCAL_LIMIT_GREATEST_MINIMUM,
1421  UCAL_LIMIT_LEAST_MAXIMUM,
1422  UCAL_LIMIT_MAXIMUM,
1423  UCAL_LIMIT_COUNT
1424  };
1425 
1447  virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const = 0;
1448 
1456  virtual int32_t getLimit(UCalendarDateFields field, ELimitType limitType) const;
1457 
1458 
1472  virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month,
1473  UBool useMonth) const = 0;
1474 
1482  virtual int32_t handleGetMonthLength(int32_t extendedYear, int32_t month) const ;
1483 
1491  virtual int32_t handleGetYearLength(int32_t eyear) const;
1492 
1493 
1502  virtual int32_t handleGetExtendedYear() = 0;
1503 
1512  virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField);
1513 
1522  virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy);
1523 
1530  int32_t computeJulianDay();
1531 
1539  int32_t computeMillisInDay();
1540 
1550  int32_t computeZoneOffset(double millis, int32_t millisInDay, UErrorCode &ec);
1551 
1552 
1561  int32_t newestStamp(UCalendarDateFields start, UCalendarDateFields end, int32_t bestSoFar) const;
1562 
1568  enum {
1570  kResolveSTOP = -1,
1572  kResolveRemap = 32
1573  };
1574 
1580  static const UFieldResolutionTable kDatePrecedence[];
1581 
1587  static const UFieldResolutionTable kYearPrecedence[];
1588 
1594  static const UFieldResolutionTable kDOWPrecedence[];
1595 
1623  UCalendarDateFields resolveFields(const UFieldResolutionTable *precedenceTable);
1624 
1625 
1629  virtual const UFieldResolutionTable* getFieldResolutionTable() const;
1630 
1636  UCalendarDateFields newerField(UCalendarDateFields defaultField, UCalendarDateFields alternateField) const;
1637 
1638 
1639 private:
1648  int32_t getActualHelper(UCalendarDateFields field, int32_t startValue, int32_t endValue, UErrorCode &status) const;
1649 
1650 
1651 protected:
1657 
1669 
1676 
1685 
1692  UDate internalGetTime(void) const { return fTime; }
1693 
1701  void internalSetTime(UDate time) { fTime = time; }
1702 
1707  int32_t fFields[UCAL_FIELD_COUNT];
1708 
1714 
1718  enum {
1719  kUnset = 0,
1720  kInternallySet,
1721  kMinimumUserStamp
1722  };
1723 
1730  int32_t fStamp[UCAL_FIELD_COUNT];
1731 
1756  virtual void handleComputeFields(int32_t julianDay, UErrorCode &status);
1757 
1763  int32_t getGregorianYear() const {
1764  return fGregorianYear;
1765  }
1766 
1772  int32_t getGregorianMonth() const {
1773  return fGregorianMonth;
1774  }
1775 
1781  int32_t getGregorianDayOfYear() const {
1782  return fGregorianDayOfYear;
1783  }
1784 
1790  int32_t getGregorianDayOfMonth() const {
1791  return fGregorianDayOfMonth;
1792  }
1793 
1800  virtual int32_t getDefaultMonthInYear(int32_t eyear) ;
1801 
1802 
1810  virtual int32_t getDefaultDayInMonth(int32_t eyear, int32_t month);
1811 
1812  //-------------------------------------------------------------------------
1813  // Protected utility methods for use by subclasses. These are very handy
1814  // for implementing add, roll, and computeFields.
1815  //-------------------------------------------------------------------------
1816 
1846  virtual void pinField(UCalendarDateFields field, UErrorCode& status);
1847 
1891  int32_t weekNumber(int32_t desiredDay, int32_t dayOfPeriod, int32_t dayOfWeek);
1892 
1893 
1924  inline int32_t weekNumber(int32_t dayOfPeriod, int32_t dayOfWeek);
1925 
1930  int32_t getLocalDOW();
1931 
1932 private:
1933 
1937  int32_t fNextStamp;// = MINIMUM_USER_STAMP;
1938 
1943  void recalculateStamp();
1944 
1948  UDate fTime;
1949 
1953  UBool fLenient;
1954 
1959  TimeZone* fZone;
1960 
1969  UCalendarDaysOfWeek fFirstDayOfWeek;
1970  uint8_t fMinimalDaysInFirstWeek;
1971  UCalendarDaysOfWeek fWeekendOnset;
1972  int32_t fWeekendOnsetMillis;
1973  UCalendarDaysOfWeek fWeekendCease;
1974  int32_t fWeekendCeaseMillis;
1975 
1986  void setWeekData(const Locale& desiredLocale, const char *type, UErrorCode& success);
1987 
1997  void updateTime(UErrorCode& status);
1998 
2004  int32_t fGregorianYear;
2005 
2011  int32_t fGregorianMonth;
2012 
2018  int32_t fGregorianDayOfYear;
2019 
2025  int32_t fGregorianDayOfMonth;
2026 
2027  /* calculations */
2028 
2035  void computeGregorianAndDOWFields(int32_t julianDay, UErrorCode &ec);
2036 
2037 protected:
2038 
2046  void computeGregorianFields(int32_t julianDay, UErrorCode &ec);
2047 
2048 private:
2049 
2070  void computeWeekFields(UErrorCode &ec);
2071 
2072 
2081  void validateFields(UErrorCode &status);
2082 
2091  virtual void validateField(UCalendarDateFields field, UErrorCode &status);
2092 
2101  void validateField(UCalendarDateFields field, int32_t min, int32_t max, UErrorCode& status);
2102 
2103  protected:
2113  static uint8_t julianDayToDayOfWeek(double julian);
2114 
2115  private:
2116  char validLocale[ULOC_FULLNAME_CAPACITY];
2117  char actualLocale[ULOC_FULLNAME_CAPACITY];
2118 
2119  public:
2120 #if !UCONFIG_NO_SERVICE
2121 
2131  static StringEnumeration* getAvailableLocales(void);
2132 
2141  static URegistryKey registerFactory(ICUServiceFactory* toAdopt, UErrorCode& status);
2142 
2153  static UBool unregister(URegistryKey key, UErrorCode& status);
2154 
2159  friend class CalendarFactory;
2160 
2165  friend class CalendarService;
2166 
2171  friend class DefaultCalendarFactory;
2172 #endif /* !UCONFIG_NO_SERVICE */
2173 
2178  virtual UBool haveDefaultCentury() const = 0;
2179 
2184  virtual UDate defaultCenturyStart() const = 0;
2189  virtual int32_t defaultCenturyStartYear() const = 0;
2190 
2197  Locale getLocale(ULocDataLocaleType type, UErrorCode &status) const;
2198 
2205  const char* getLocaleID(ULocDataLocaleType type, UErrorCode &status) const;
2206 
2207 };
2208 
2209 // -------------------------------------
2210 
2211 inline Calendar*
2213 {
2214  // since the Locale isn't specified, use the default locale
2215  return createInstance(zone, Locale::getDefault(), errorCode);
2216 }
2217 
2218 // -------------------------------------
2219 
2220 inline void
2222 {
2223  roll(field, (int32_t)(up ? +1 : -1), status);
2224 }
2225 
2226 inline void
2228 {
2229  roll((UCalendarDateFields) field, up, status);
2230 }
2231 
2232 
2233 // -------------------------------------
2234 
2240 inline void
2242 {
2243  fFields[field] = value;
2244  fStamp[field] = kInternallySet;
2245  fIsSet[field] = TRUE; // Remove later
2246 }
2247 
2248 inline int32_t Calendar::weekNumber(int32_t dayOfPeriod, int32_t dayOfWeek)
2249 {
2250  return weekNumber(dayOfPeriod, dayOfPeriod, dayOfWeek);
2251 }
2252 
2253 
2255 
2256 #endif /* #if !UCONFIG_NO_FORMATTING */
2257 
2258 #endif // _CALENDAR