ICU 62.1 62.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 !UCONFIG_NO_FORMATTING
32
33#include "unicode/calendar.h"
34
41
152public:
153
158 enum EEras {
159 BC,
160 AD
161 };
162
172
184
195
206
219
231
244 GregorianCalendar(int32_t year, int32_t month, int32_t date, UErrorCode& success);
245
260 GregorianCalendar(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, UErrorCode& success);
261
277 GregorianCalendar(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second, UErrorCode& success);
278
284
291
298
304 virtual Calendar* clone(void) const;
305
316
326
342 UBool isLeapYear(int32_t year) const;
343
351 virtual UBool isEquivalentTo(const Calendar& other) const;
352
364 virtual void roll(EDateFields field, int32_t amount, UErrorCode& status);
365
377 virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode& status);
378
379#ifndef U_HIDE_DEPRECATED_API
387 int32_t getActualMinimum(EDateFields field) const;
388
398#endif /* U_HIDE_DEPRECATED_API */
399
409
410#ifndef U_HIDE_DEPRECATED_API
420 int32_t getActualMaximum(EDateFields field) const;
421#endif /* U_HIDE_DEPRECATED_API */
422
434
445
446public:
447
458 virtual UClassID getDynamicClassID(void) const;
459
472
483 virtual const char * getType() const;
484
485 private:
486 GregorianCalendar(); // default constructor not implemented
487
488 protected:
495 virtual int32_t internalGetEra() const;
496
510 virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month,
511 UBool useMonth) const;
512
522
530 virtual int32_t handleGetMonthLength(int32_t extendedYear, int32_t month) const;
531
539 virtual int32_t handleGetYearLength(int32_t eyear) const;
540
547 virtual int32_t monthLength(int32_t month) const;
548
556 virtual int32_t monthLength(int32_t month, int32_t year) const;
557
558#ifndef U_HIDE_INTERNAL_API
565 int32_t yearLength(int32_t year) const;
566
572 int32_t yearLength(void) const;
573
581 void pinDayOfMonth(void);
582#endif /* U_HIDE_INTERNAL_API */
583
592
615
624 virtual int32_t handleGetExtendedYear();
625
634 virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy);
635
636
653
654 private:
662 static double computeJulianDayOfYear(UBool isGregorian, int32_t year,
663 UBool& isLeap);
664
669 UBool validateFields(void) const;
670
674 UBool boundsCheck(int32_t value, UCalendarDateFields field) const;
675
685 int32_t aggregateStamp(int32_t stamp_a, int32_t stamp_b);
686
694 UDate fGregorianCutover;
695
699 int32_t fCutoverJulianDay;
700
706 UDate fNormalizedGregorianCutover;// = gregorianCutover;
707
712 int32_t fGregorianCutoverYear;// = 1582;
713
718 int32_t fGregorianCutoverJulianDay;// = 2299161;
719
727 static double millisToJulianDay(UDate millis);
728
736 static UDate julianDayToMillis(double julian);
737
742 UBool fIsGregorian;
743
749 UBool fInvertGregorian;
750
751
752 public: // internal implementation
753
758 virtual UBool haveDefaultCentury() const;
759
764 virtual UDate defaultCenturyStart() const;
765
770 virtual int32_t defaultCenturyStartYear() const;
771};
772
774
775#endif /* #if !UCONFIG_NO_FORMATTING */
776
777#endif // _GREGOCAL
778//eof
779
C++ API: Calendar object.
Calendar is an abstract base class for converting between a UDate object and a set of integer fields ...
Definition calendar.h:202
EDateFields
Field IDs for date and time.
Definition calendar.h:211
ELimitType
Limit enums.
Definition calendar.h:1610
Concrete class which provides the standard calendar used by most of the world.
Definition gregocal.h:151
int32_t yearLength(int32_t year) const
return the length of the given year.
virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField)
Subclasses may override this.
int32_t getActualMinimum(EDateFields field, UErrorCode &status) const
Return the minimum value that this field could have, given the current date.
GregorianCalendar(UErrorCode &success)
Constructs a default GregorianCalendar using the current time in the default time zone with the defau...
virtual UDate defaultCenturyStart() const
int32_t getActualMinimum(UCalendarDateFields field, UErrorCode &status) const
Return the minimum value that this field could have, given the current date.
virtual int32_t monthLength(int32_t month) const
return the length of the given month.
virtual UClassID getDynamicClassID(void) const
Override Calendar Returns a unique class ID POLYMORPHICALLY.
EEras
Useful constants for GregorianCalendar and TimeZone.
Definition gregocal.h:158
GregorianCalendar & operator=(const GregorianCalendar &right)
Default assignment operator.
GregorianCalendar(TimeZone *zoneToAdopt, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the given time zone with the default loca...
GregorianCalendar(const Locale &aLocale, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the default time zone with the given loca...
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...
virtual int32_t monthLength(int32_t month, int32_t year) const
return the length of the month according to the given year.
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...
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...
void pinDayOfMonth(void)
After adjustments such as add(MONTH), add(YEAR), we don't want the month to jump around.
GregorianCalendar(const TimeZone &zone, UErrorCode &success)
Constructs a GregorianCalendar based on the current time in the given time zone with the default loca...
virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode &status)
(Overrides Calendar) Rolls up or down by the given amount in the specified field.
GregorianCalendar(const GregorianCalendar &source)
Copy constructor.
virtual int32_t handleGetYearLength(int32_t eyear) const
Return the number of days in the given extended year of this calendar system.
virtual UBool haveDefaultCentury() const
virtual Calendar * clone(void) const
Create and return a polymorphic copy of this calendar.
virtual int32_t internalGetEra() const
Return the ERA.
virtual int32_t defaultCenturyStartYear() const
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.
virtual UBool isEquivalentTo(const Calendar &other) const
Returns TRUE if the given Calendar object is equivalent to this one.
virtual int32_t handleGetExtendedYear()
Return the extended year defined by the current fields.
int32_t getActualMinimum(EDateFields field) const
Return the minimum value that this field could have, given the current date.
UBool isLeapYear(int32_t year) const
Return true if the given year is a leap year.
virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const
Subclass API for defining limits of different types.
virtual ~GregorianCalendar()
Destructor.
static UClassID getStaticClassID(void)
Return the class ID for this class.
virtual UBool inDaylightTime(UErrorCode &status) const
(Overrides Calendar) Return true if the current date for this Calendar is in Daylight Savings Time.
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...
virtual UDate getEpochDay(UErrorCode &status)
Return the day number with respect to the epoch.
virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy)
Subclasses may override this to convert from week fields (YEAR_WOY and WEEK_OF_YEAR) to an extended y...
virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode &status) const
Return the maximum value that this field could have, given the current date.
int32_t yearLength(void) const
return the length of the year field.
virtual void roll(EDateFields field, int32_t amount, UErrorCode &status)
(Overrides Calendar) Rolls up or down by the given amount in the specified field.
virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month, UBool useMonth) const
Return the Julian day number of day before the first day of the given month in the given extended yea...
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...
UDate getGregorianChange(void) const
Gets the Gregorian Calendar change date.
void setGregorianChange(UDate date, UErrorCode &success)
Sets the GregorianCalendar change date.
virtual const char * getType() const
Returns the calendar type name string for this Calendar object.
virtual void handleComputeFields(int32_t julianDay, UErrorCode &status)
Subclasses may override this method to compute several fields specific to each calendar system.
int32_t getActualMaximum(EDateFields field) const
Return the maximum value that this field could have, given the current date.
"Smart pointer" base class; do not use directly: use LocalPointer etc.
A Locale object represents a specific geographical, political, or cultural region.
Definition locid.h:188
TimeZone represents a time zone offset, and also figures out daylight savings.
Definition timezone.h:131
UCalendarDateFields
Possible fields in a UCalendar.
Definition ucal.h:185
int8_t UBool
The ICU boolean type.
Definition umachine.h:236
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition uobject.h:93
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:360
double UDate
Date and Time data type.
Definition utypes.h:203
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:138
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:137