ICU 73.2  73.2
gregocal.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 * Copyright (C) 1997-2013, International Business Machines Corporation and others.
5 * All Rights Reserved.
6 ********************************************************************************
7 *
8 * File GREGOCAL.H
9 *
10 * Modification History:
11 *
12 * Date Name Description
13 * 04/22/97 aliu Overhauled header.
14 * 07/28/98 stephen Sync with JDK 1.2
15 * 09/04/98 stephen Re-sync with JDK 8/31 putback
16 * 09/14/98 stephen Changed type of kOneDay, kOneWeek to double.
17 * Fixed bug in roll()
18 * 10/15/99 aliu Fixed j31, incorrect WEEK_OF_YEAR computation.
19 * Added documentation of WEEK_OF_YEAR computation.
20 * 10/15/99 aliu Fixed j32, cannot set date to Feb 29 2000 AD.
21 * {JDK bug 4210209 4209272}
22 * 11/07/2003 srl Update, clean up documentation.
23 ********************************************************************************
24 */
25 
26 #ifndef GREGOCAL_H
27 #define GREGOCAL_H
28 
29 #include "unicode/utypes.h"
30 
31 #if U_SHOW_CPLUSPLUS_API
32 
33 #if !UCONFIG_NO_FORMATTING
34 
35 #include "unicode/calendar.h"
36 
42 U_NAMESPACE_BEGIN
43 
154 public:
155 
160  enum EEras {
161  BC,
162  AD
163  };
164 
173  GregorianCalendar(UErrorCode& success);
174 
185  GregorianCalendar(TimeZone* zoneToAdopt, UErrorCode& success);
186 
196  GregorianCalendar(const TimeZone& zone, UErrorCode& success);
197 
207  GregorianCalendar(const Locale& aLocale, UErrorCode& success);
208 
220  GregorianCalendar(TimeZone* zoneToAdopt, const Locale& aLocale, UErrorCode& success);
221 
232  GregorianCalendar(const TimeZone& zone, const Locale& aLocale, UErrorCode& success);
233 
246  GregorianCalendar(int32_t year, int32_t month, int32_t date, UErrorCode& success);
247 
262  GregorianCalendar(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, UErrorCode& success);
263 
279  GregorianCalendar(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second, UErrorCode& success);
280 
285  virtual ~GregorianCalendar();
286 
292  GregorianCalendar(const GregorianCalendar& source);
293 
300 
306  virtual GregorianCalendar* clone() const override;
307 
317  void setGregorianChange(UDate date, UErrorCode& success);
318 
327  UDate getGregorianChange(void) const;
328 
344  UBool isLeapYear(int32_t year) const;
345 
353  virtual UBool isEquivalentTo(const Calendar& other) const override;
354 
355 #ifndef U_FORCE_HIDE_DEPRECATED_API
356 
367  virtual void roll(EDateFields field, int32_t amount, UErrorCode& status) override;
368 #endif // U_FORCE_HIDE_DEPRECATED_API
369 
381  virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode& status) override;
382 
383 #ifndef U_HIDE_DEPRECATED_API
384 
391  int32_t getActualMinimum(EDateFields field) const;
392 
401  int32_t getActualMinimum(EDateFields field, UErrorCode& status) const;
402 #endif /* U_HIDE_DEPRECATED_API */
403 
412  int32_t getActualMinimum(UCalendarDateFields field, UErrorCode &status) const override;
413 
424  virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode& status) const override;
425 
426 public:
427 
438  virtual UClassID getDynamicClassID(void) const override;
439 
451  static UClassID U_EXPORT2 getStaticClassID(void);
452 
463  virtual const char * getType() const override;
464 
465  private:
466  GregorianCalendar() = delete; // default constructor not implemented
467 
468  protected:
475  virtual int32_t internalGetEra() const;
476 
490  virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month,
491  UBool useMonth) const override;
492 
501  virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField) override;
502 
510  virtual int32_t handleGetMonthLength(int32_t extendedYear, int32_t month) const override;
511 
519  virtual int32_t handleGetYearLength(int32_t eyear) const override;
520 
527  virtual int32_t monthLength(int32_t month) const;
528 
536  virtual int32_t monthLength(int32_t month, int32_t year) const;
537 
538 #ifndef U_HIDE_INTERNAL_API
539 
545  int32_t yearLength(int32_t year) const;
546 
552  int32_t yearLength(void) const;
553 
561  void pinDayOfMonth(void);
562 #endif /* U_HIDE_INTERNAL_API */
563 
571  virtual UDate getEpochDay(UErrorCode& status);
572 
594  virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const override;
595 
604  virtual int32_t handleGetExtendedYear() override;
605 
614  virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy) override;
615 
616 
632  virtual void handleComputeFields(int32_t julianDay, UErrorCode &status) override;
633 
634  private:
642  static double computeJulianDayOfYear(UBool isGregorian, int32_t year,
643  UBool& isLeap);
644 
649  UBool validateFields(void) const;
650 
654  UBool boundsCheck(int32_t value, UCalendarDateFields field) const;
655 
665  int32_t aggregateStamp(int32_t stamp_a, int32_t stamp_b);
666 
674  UDate fGregorianCutover;
675 
679  int32_t fCutoverJulianDay;
680 
686  UDate fNormalizedGregorianCutover;// = gregorianCutover;
687 
692  int32_t fGregorianCutoverYear;// = 1582;
693 
701  static double millisToJulianDay(UDate millis);
702 
710  static UDate julianDayToMillis(double julian);
711 
716  UBool fIsGregorian;
717 
723  UBool fInvertGregorian;
724 
725 
726  public: // internal implementation
727 
732  virtual UBool haveDefaultCentury() const override;
733 
738  virtual UDate defaultCenturyStart() const override;
739 
744  virtual int32_t defaultCenturyStartYear() const override;
745 };
746 
747 U_NAMESPACE_END
748 
749 #endif /* #if !UCONFIG_NO_FORMATTING */
750 
751 #endif /* U_SHOW_CPLUSPLUS_API */
752 
753 #endif // _GREGOCAL
754 //eof
755 
UCalendarDateFields
Possible fields in a UCalendar.
Definition: ucal.h:202
virtual int32_t defaultCenturyStartYear() const =0
EEras
Useful constants for GregorianCalendar and TimeZone.
Definition: gregocal.h:160
virtual UClassID getDynamicClassID(void) const override=0
Returns a unique class ID POLYMORPHICALLY.
virtual void handleComputeFields(int32_t julianDay, UErrorCode &status)
Subclasses may override this method to compute several fields specific to each calendar system...
virtual Calendar * clone() const =0
Create and return a polymorphic copy of this calendar.
Calendar is an abstract base class for converting between a UDate object and a set of integer fields ...
Definition: calendar.h:189
double UDate
Date and Time data type.
Definition: utypes.h:203
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month, UBool useMonth) const =0
Return the Julian day number of day before the first day of the given month in the given extended yea...
virtual UBool isEquivalentTo(const Calendar &other) const
Returns true if the given Calendar object is equivalent to this one.
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:133
virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode &status) const
Return the maximum value that this field could have, given the current date.
virtual int32_t handleGetMonthLength(int32_t extendedYear, int32_t month) const
Return the number of days in the given month of the given extended year of this calendar system...
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:301
C++ API: Calendar object.
virtual UBool haveDefaultCentury() const =0
virtual const char * getType() const =0
Returns the calendar type name string for this Calendar object.
void roll(EDateFields field, UBool up, UErrorCode &status)
Time Field Rolling function.
Definition: calendar.h:2531
virtual int32_t handleGetYearLength(int32_t eyear) const
Return the number of days in the given extended year of this calendar system.
virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField)
Subclasses may override this.
Calendar & operator=(const Calendar &right)
Default assignment operator.
Concrete class which provides the standard calendar used by most of the world.
Definition: gregocal.h:153
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
Basic definitions for ICU, for both C and C++ APIs.
virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy)
Subclasses must override this to convert from week fields (YEAR_WOY and WEEK_OF_YEAR) to an extended ...
virtual UDate defaultCenturyStart() const =0
int32_t getActualMinimum(EDateFields field, UErrorCode &status) const
Return the minimum value that this field could have, given the current date.
virtual int32_t handleGetExtendedYear()=0
Return the extended year defined by the current fields.
virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const =0
Subclass API for defining limits of different types.
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:247
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195