ICU 74.1 74.1

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
153 class U_I18N_API GregorianCalendar: public Calendar {
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
299 GregorianCalendar& operator=(const GregorianCalendar& right);
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
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
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
544 int32_t yearLength(void) const;
545
546 #endif /* U_HIDE_INTERNAL_API */
547
555 virtual UDate getEpochDay(UErrorCode& status);
556
578 virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const override;
579
588 virtual int32_t handleGetExtendedYear() override;
589
598 virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy) override;
599
600
616 virtual void handleComputeFields(int32_t julianDay, UErrorCode &status) override;
617
618 private:
626 static double computeJulianDayOfYear(UBool isGregorian, int32_t year,
627 UBool& isLeap);
628
633 UBool validateFields(void) const;
634
638 UBool boundsCheck(int32_t value, UCalendarDateFields field) const;
639
649 int32_t aggregateStamp(int32_t stamp_a, int32_t stamp_b);
650
658 UDate fGregorianCutover;
659
663 int32_t fCutoverJulianDay;
664
670 UDate fNormalizedGregorianCutover;// = gregorianCutover;
671
676 int32_t fGregorianCutoverYear;// = 1582;
677
685 static double millisToJulianDay(UDate millis);
686
694 static UDate julianDayToMillis(double julian);
695
700 UBool fIsGregorian;
701
707 UBool fInvertGregorian;
708
709
710 public: // internal implementation
711
716 virtual UBool haveDefaultCentury() const override;
717
722 virtual UDate defaultCenturyStart() const override;
723
728 virtual int32_t defaultCenturyStartYear() const override;
729 };
730
731 U_NAMESPACE_END
732
733 #endif /* #if !UCONFIG_NO_FORMATTING */
734
735 #endif /* U_SHOW_CPLUSPLUS_API */
736
737 #endif // _GREGOCAL
738 //eof
739
calendar.h
C++ API: Calendar object.
icu::Calendar
Calendar is an abstract base class for converting between a UDate object and a set of integer fields ...
Definition: calendar.h:189
icu::Calendar::EDateFields
EDateFields
Field IDs for date and time.
Definition: calendar.h:198
icu::Calendar::ELimitType
ELimitType
Limit enums.
Definition: calendar.h:1615
icu::GregorianCalendar
Concrete class which provides the standard calendar used by most of the world.
Definition: gregocal.h:153
icu::GregorianCalendar::getActualMinimum
int32_t getActualMinimum(EDateFields field, UErrorCode &status) const
Return the minimum value that this field could have, given the current date.
icu::GregorianCalendar::haveDefaultCentury
virtual UBool haveDefaultCentury() const override
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(UErrorCode &success)
Constructs a default GregorianCalendar using the current time in the default time zone with the defau...
icu::GregorianCalendar::handleGetLimit
virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const override
Subclass API for defining limits of different types.
icu::GregorianCalendar::handleGetExtendedYear
virtual int32_t handleGetExtendedYear() override
Return the extended year defined by the current fields.
icu::GregorianCalendar::handleComputeFields
virtual void handleComputeFields(int32_t julianDay, UErrorCode &status) override
Subclasses may override this method to compute several fields specific to each calendar system.
icu::GregorianCalendar::monthLength
virtual int32_t monthLength(int32_t month) const
return the length of the given month.
icu::GregorianCalendar::EEras
EEras
Useful constants for GregorianCalendar and TimeZone.
Definition: gregocal.h:160
icu::GregorianCalendar::getDynamicClassID
virtual UClassID getDynamicClassID(void) const override
Override Calendar Returns a unique class ID POLYMORPHICALLY.
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(TimeZone *zoneToAdopt, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the given time zone with the default loca...
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(const Locale &aLocale, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the default time zone with the given loca...
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(const TimeZone &zone, const Locale &aLocale, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the given time zone with the given locale...
icu::GregorianCalendar::defaultCenturyStart
virtual UDate defaultCenturyStart() const override
icu::GregorianCalendar::handleGetMonthLength
virtual int32_t handleGetMonthLength(int32_t extendedYear, int32_t month) const override
Return the number of days in the given month of the given extended year of this calendar system.
icu::GregorianCalendar::monthLength
virtual int32_t monthLength(int32_t month, int32_t year) const
return the length of the month according to the given year.
icu::GregorianCalendar::getType
virtual const char * getType() const override
Returns the calendar type name string for this Calendar object.
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(TimeZone *zoneToAdopt, const Locale &aLocale, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the given time zone with the given locale...
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second, UErrorCode &success)
Constructs a GregorianCalendar with the given AD date and time set for the default time zone with the...
icu::GregorianCalendar::handleGetExtendedYearFromWeekFields
virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy) override
Subclasses may override this to convert from week fields (YEAR_WOY and WEEK_OF_YEAR) to an extended y...
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(const TimeZone &zone, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the given time zone with the default loca...
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(const GregorianCalendar &source)
Copy constructor.
icu::GregorianCalendar::handleComputeMonthStart
virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month, UBool useMonth) const override
Return the Julian day number of day before the first day of the given month in the given extended yea...
icu::GregorianCalendar::internalGetEra
virtual int32_t internalGetEra() const
Return the ERA.
icu::GregorianCalendar::clone
virtual GregorianCalendar * clone() const override
Create and return a polymorphic copy of this calendar.
icu::GregorianCalendar::handleGetYearLength
virtual int32_t handleGetYearLength(int32_t eyear) const override
Return the number of days in the given extended year of this calendar system.
icu::GregorianCalendar::getActualMinimum
int32_t getActualMinimum(EDateFields field) const
Return the minimum value that this field could have, given the current date.
icu::GregorianCalendar::isLeapYear
UBool isLeapYear(int32_t year) const
Return true if the given year is a leap year.
icu::GregorianCalendar::defaultCenturyStartYear
virtual int32_t defaultCenturyStartYear() const override
icu::GregorianCalendar::~GregorianCalendar
virtual ~GregorianCalendar()
Destructor.
icu::GregorianCalendar::handleComputeJulianDay
virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField) override
Subclasses may override this.
icu::GregorianCalendar::getStaticClassID
static UClassID getStaticClassID(void)
Return the class ID for this class.
icu::GregorianCalendar::getActualMinimum
int32_t getActualMinimum(UCalendarDateFields field, UErrorCode &status) const override
Return the minimum value that this field could have, given the current date.
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, UErrorCode &success)
Constructs a GregorianCalendar with the given AD date and time set for the default time zone with the...
icu::GregorianCalendar::getActualMaximum
virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode &status) const override
Return the maximum value that this field could have, given the current date.
icu::GregorianCalendar::getEpochDay
virtual UDate getEpochDay(UErrorCode &status)
Return the day number with respect to the epoch.
icu::GregorianCalendar::isEquivalentTo
virtual UBool isEquivalentTo(const Calendar &other) const override
Returns true if the given Calendar object is equivalent to this one.
icu::GregorianCalendar::roll
virtual void roll(EDateFields field, int32_t amount, UErrorCode &status) override
(Overrides Calendar) Rolls up or down by the given amount in the specified field.
icu::GregorianCalendar::yearLength
int32_t yearLength(void) const
return the length of the year field.
icu::GregorianCalendar::operator=
GregorianCalendar & operator=(const GregorianCalendar &right)
Default assignment operator.
icu::GregorianCalendar::roll
virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode &status) override
(Overrides Calendar) Rolls up or down by the given amount in the specified field.
icu::GregorianCalendar::GregorianCalendar
GregorianCalendar(int32_t year, int32_t month, int32_t date, UErrorCode &success)
Constructs a GregorianCalendar with the given AD date set in the default time zone with the default l...
icu::GregorianCalendar::getGregorianChange
UDate getGregorianChange(void) const
Gets the Gregorian Calendar change date.
icu::GregorianCalendar::setGregorianChange
void setGregorianChange(UDate date, UErrorCode &success)
Sets the GregorianCalendar change date.
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
icu::TimeZone
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition: timezone.h:133
UCalendarDateFields
UCalendarDateFields
Possible fields in a UCalendar.
Definition: ucal.h:202
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:247
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition: uobject.h:96
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
U_I18N_API
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301
UDate
double UDate
Date and Time data type.
Definition: utypes.h:203