1 /*
2 ********************************************************************************
3 * Copyright (C) 1997-2012, 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
30 /**
31 * \file
32 * \brief C++ API: Calendar object
33 */
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
42 U_NAMESPACE_BEGIN
43
44 class ICUServiceFactory;
45
46 /**
47 * @internal
48 */
49 typedef int32_t UFieldResolutionTable[12][8];
50
51 class BasicTimeZone;
52 /**
53 * <code>Calendar</code> is an abstract base class for converting between
54 * a <code>UDate</code> object and a set of integer fields such as
55 * <code>YEAR</code>, <code>MONTH</code>, <code>DAY</code>, <code>HOUR</code>,
56 * and so on. (A <code>UDate</code> object represents a specific instant in
57 * time with millisecond precision. See UDate
58 * for information about the <code>UDate</code> class.)
59 *
60 * <p>
61 * Subclasses of <code>Calendar</code> interpret a <code>UDate</code>
62 * according to the rules of a specific calendar system.
63 * The most commonly used subclass of <code>Calendar</code> is
64 * <code>GregorianCalendar</code>. Other subclasses could represent
65 * the various types of lunar calendars in use in many parts of the world.
66 *
67 * <p>
68 * <b>NOTE</b>: (ICU 2.6) The subclass interface should be considered unstable
69 * - it WILL change.
70 *
71 * <p>
72 * Like other locale-sensitive classes, <code>Calendar</code> provides a
73 * static method, <code>createInstance</code>, for getting a generally useful
74 * object of this type. <code>Calendar</code>'s <code>createInstance</code> method
75 * returns the appropriate <code>Calendar</code> subclass whose
76 * time fields have been initialized with the current date and time:
77 * \htmlonly<blockquote>\endhtmlonly
78 * <pre>
79 * Calendar *rightNow = Calendar::createInstance(errCode);
80 * </pre>
81 * \htmlonly</blockquote>\endhtmlonly
82 *
83 * <p>
84 * A <code>Calendar</code> object can produce all the time field values
85 * needed to implement the date-time formatting for a particular language
86 * and calendar style (for example, Japanese-Gregorian, Japanese-Traditional).
87 *
88 * <p>
89 * When computing a <code>UDate</code> from time fields, some special circumstances
90 * may arise: there may be insufficient information to compute the
91 * <code>UDate</code> (such as only year and month but no day in the month),
92 * there may be inconsistent information (such as "Tuesday, July 15, 1996"
93 * -- July 15, 1996 is actually a Monday), or the input time might be ambiguous
94 * because of time zone transition.
95 *
96 * <p>
97 * <strong>Insufficient information.</strong> The calendar will use default
98 * information to specify the missing fields. This may vary by calendar; for
99 * the Gregorian calendar, the default for a field is the same as that of the
100 * start of the epoch: i.e., YEAR = 1970, MONTH = JANUARY, DATE = 1, etc.
101 *
102 * <p>
103 * <strong>Inconsistent information.</strong> If fields conflict, the calendar
104 * will give preference to fields set more recently. For example, when
105 * determining the day, the calendar will look for one of the following
106 * combinations of fields. The most recent combination, as determined by the
107 * most recently set single field, will be used.
108 *
109 * \htmlonly<blockquote>\endhtmlonly
110 * <pre>
111 * MONTH + DAY_OF_MONTH
112 * MONTH + WEEK_OF_MONTH + DAY_OF_WEEK
113 * MONTH + DAY_OF_WEEK_IN_MONTH + DAY_OF_WEEK
114 * DAY_OF_YEAR
115 * DAY_OF_WEEK + WEEK_OF_YEAR
116 * </pre>
117 * \htmlonly</blockquote>\endhtmlonly
118 *
119 * For the time of day:
120 *
121 * \htmlonly<blockquote>\endhtmlonly
122 * <pre>
123 * HOUR_OF_DAY
124 * AM_PM + HOUR
125 * </pre>
126 * \htmlonly</blockquote>\endhtmlonly
127 *
128 * <p>
129 * <strong>Ambiguous Wall Clock Time.</strong> When time offset from UTC has
130 * changed, it produces ambiguous time slot around the transition. For example,
131 * many US locations observe daylight saving time. On the date switching to daylight
132 * saving time in US, wall clock time jumps from 1:00 AM (standard) to 2:00 AM
133 * (daylight). Therefore, wall clock time from 1:00 AM to 1:59 AM do not exist on
134 * the date. When the input wall time fall into this missing time slot, the ICU
135 * Calendar resolves the time using the UTC offset before the transition by default.
136 * In this example, 1:30 AM is interpreted as 1:30 AM standard time (non-exist),
137 * so the final result will be 2:30 AM daylight time.
138 *
139 * <p>On the date switching back to standard time, wall clock time is moved back one
140 * hour at 2:00 AM. So wall clock time from 1:00 AM to 1:59 AM occur twice. In this
141 * case, the ICU Calendar resolves the time using the UTC offset after the transition
142 * by default. For example, 1:30 AM on the date is resolved as 1:30 AM standard time.
143 *
144 * <p>Ambiguous wall clock time resolution behaviors can be customized by Calendar APIs
145 * {@link #setRepeatedWallTimeOption} and {@link #setSkippedWallTimeOption}.
146 * These methods are available in ICU 49 or later versions.
147 *
148 * <p>
149 * <strong>Note:</strong> for some non-Gregorian calendars, different
150 * fields may be necessary for complete disambiguation. For example, a full
151 * specification of the historial Arabic astronomical calendar requires year,
152 * month, day-of-month <em>and</em> day-of-week in some cases.
153 *
154 * <p>
155 * <strong>Note:</strong> There are certain possible ambiguities in
156 * interpretation of certain singular times, which are resolved in the
157 * following ways:
158 * <ol>
159 * <li> 24:00:00 "belongs" to the following day. That is,
160 * 23:59 on Dec 31, 1969 < 24:00 on Jan 1, 1970 < 24:01:00 on Jan 1, 1970
161 *
162 * <li> Although historically not precise, midnight also belongs to "am",
163 * and noon belongs to "pm", so on the same day,
164 * 12:00 am (midnight) < 12:01 am, and 12:00 pm (noon) < 12:01 pm
165 * </ol>
166 *
167 * <p>
168 * The date or time format strings are not part of the definition of a
169 * calendar, as those must be modifiable or overridable by the user at
170 * runtime. Use {@link DateFormat}
171 * to format dates.
172 *
173 * <p>
174 * <code>Calendar</code> provides an API for field "rolling", where fields
175 * can be incremented or decremented, but wrap around. For example, rolling the
176 * month up in the date <code>December 12, <b>1996</b></code> results in
177 * <code>January 12, <b>1996</b></code>.
178 *
179 * <p>
180 * <code>Calendar</code> also provides a date arithmetic function for
181 * adding the specified (signed) amount of time to a particular time field.
182 * For example, subtracting 5 days from the date <code>September 12, 1996</code>
183 * results in <code>September 7, 1996</code>.
184 *
185 * <p><big><b>Supported range</b></big>
186 *
187 * <p>The allowable range of <code>Calendar</code> has been
188 * narrowed. <code>GregorianCalendar</code> used to attempt to support
189 * the range of dates with millisecond values from
190 * <code>Long.MIN_VALUE</code> to <code>Long.MAX_VALUE</code>.
191 * The new <code>Calendar</code> protocol specifies the
192 * maximum range of supportable dates as those having Julian day numbers
193 * of <code>-0x7F000000</code> to <code>+0x7F000000</code>. This
194 * corresponds to years from ~5,800,000 BCE to ~5,800,000 CE. Programmers
195 * should use the protected constants in <code>Calendar</code> to
196 * specify an extremely early or extremely late date.</p>
197 *
198 * @stable ICU 2.0
199 */
200 class U_I18N_API Calendar : public UObject {
201 public:
202
203 /**
204 * Field IDs for date and time. Used to specify date/time fields. ERA is calendar
205 * specific. Example ranges given are for illustration only; see specific Calendar
206 * subclasses for actual ranges.
207 * @deprecated ICU 2.6. Use C enum UCalendarDateFields defined in ucal.h
208 */
209 enum EDateFields {
210 #ifndef U_HIDE_DEPRECATED_API
211 /*
212 * ERA may be defined on other platforms. To avoid any potential problems undefined it here.
213 */
214 #ifdef ERA
215 #undef ERA
216 #endif
217 ERA, // Example: 0..1
218 YEAR, // Example: 1..big number
219 MONTH, // Example: 0..11
220 WEEK_OF_YEAR, // Example: 1..53
221 WEEK_OF_MONTH, // Example: 1..4
222 DATE, // Example: 1..31
223 DAY_OF_YEAR, // Example: 1..365
224 DAY_OF_WEEK, // Example: 1..7
225 DAY_OF_WEEK_IN_MONTH, // Example: 1..4, may be specified as -1
226 AM_PM, // Example: 0..1
227 HOUR, // Example: 0..11
228 HOUR_OF_DAY, // Example: 0..23
229 MINUTE, // Example: 0..59
230 SECOND, // Example: 0..59
231 MILLISECOND, // Example: 0..999
232 ZONE_OFFSET, // Example: -12*U_MILLIS_PER_HOUR..12*U_MILLIS_PER_HOUR
233 DST_OFFSET, // Example: 0 or U_MILLIS_PER_HOUR
234 YEAR_WOY, // 'Y' Example: 1..big number - Year of Week of Year
235 DOW_LOCAL, // 'e' Example: 1..7 - Day of Week / Localized
236
237 EXTENDED_YEAR,
238 JULIAN_DAY,
239 MILLISECONDS_IN_DAY,
240 IS_LEAP_MONTH,
241
242 FIELD_COUNT = UCAL_FIELD_COUNT // See ucal.h for other fields.
243 #endif /* U_HIDE_DEPRECATED_API */
244 };
245
246 #ifndef U_HIDE_DEPRECATED_API
247 /**
248 * Useful constant for days of week. Note: Calendar day-of-week is 1-based. Clients
249 * who create locale resources for the field of first-day-of-week should be aware of
250 * this. For instance, in US locale, first-day-of-week is set to 1, i.e., SUNDAY.
251 * @deprecated ICU 2.6. Use C enum UCalendarDaysOfWeek defined in ucal.h
252 */
253 enum EDaysOfWeek {
254 SUNDAY = 1,
255 MONDAY,
256 TUESDAY,
257 WEDNESDAY,
258 THURSDAY,
259 FRIDAY,
260 SATURDAY
261 };
262
263 /**
264 * Useful constants for month. Note: Calendar month is 0-based.
265 * @deprecated ICU 2.6. Use C enum UCalendarMonths defined in ucal.h
266 */
267 enum EMonths {
268 JANUARY,
269 FEBRUARY,
270 MARCH,
271 APRIL,
272 MAY,
273 JUNE,
274 JULY,
275 AUGUST,
276 SEPTEMBER,
277 OCTOBER,
278 NOVEMBER,
279 DECEMBER,
280 UNDECIMBER
281 };
282
283 /**
284 * Useful constants for hour in 12-hour clock. Used in GregorianCalendar.
285 * @deprecated ICU 2.6. Use C enum UCalendarAMPMs defined in ucal.h
286 */
287 enum EAmpm {
288 AM,
289 PM
290 };
291 #endif /* U_HIDE_DEPRECATED_API */
292
293 /**
294 * destructor
295 * @stable ICU 2.0
296 */
297 virtual ~Calendar();
298
299 /**
300 * Create and return a polymorphic copy of this calendar.
301 *
302 * @return a polymorphic copy of this calendar.
303 * @stable ICU 2.0
304 */
305 virtual Calendar* clone(void) const = 0;
306
307 /**
308 * Creates a Calendar using the default timezone and locale. Clients are responsible
309 * for deleting the object returned.
310 *
311 * @param success Indicates the success/failure of Calendar creation. Filled in
312 * with U_ZERO_ERROR if created successfully, set to a failure result
313 * otherwise. U_MISSING_RESOURCE_ERROR will be returned if the resource data
314 * requests a calendar type which has not been installed.
315 * @return A Calendar if created successfully. NULL otherwise.
316 * @stable ICU 2.0
317 */
318 static Calendar* U_EXPORT2 createInstance(UErrorCode& success);
319
320 /**
321 * Creates a Calendar using the given timezone and the default locale.
322 * The Calendar takes ownership of zoneToAdopt; the
323 * client must not delete it.
324 *
325 * @param zoneToAdopt The given timezone to be adopted.
326 * @param success Indicates the success/failure of Calendar creation. Filled in
327 * with U_ZERO_ERROR if created successfully, set to a failure result
328 * otherwise.
329 * @return A Calendar if created successfully. NULL otherwise.
330 * @stable ICU 2.0
331 */
332 static Calendar* U_EXPORT2 createInstance(TimeZone* zoneToAdopt, UErrorCode& success);
333
334 /**
335 * Creates a Calendar using the given timezone and the default locale. The TimeZone
336 * is _not_ adopted; the client is still responsible for deleting it.
337 *
338 * @param zone The timezone.
339 * @param success Indicates the success/failure of Calendar creation. Filled in
340 * with U_ZERO_ERROR if created successfully, set to a failure result
341 * otherwise.
342 * @return A Calendar if created successfully. NULL otherwise.
343 * @stable ICU 2.0
344 */
345 static Calendar* U_EXPORT2 createInstance(const TimeZone& zone, UErrorCode& success);
346
347 /**
348 * Creates a Calendar using the default timezone and the given locale.
349 *
350 * @param aLocale The given locale.
351 * @param success Indicates the success/failure of Calendar creation. Filled in
352 * with U_ZERO_ERROR if created successfully, set to a failure result
353 * otherwise.
354 * @return A Calendar if created successfully. NULL otherwise.
355 * @stable ICU 2.0
356 */
357 static Calendar* U_EXPORT2 createInstance(const Locale& aLocale, UErrorCode& success);
358
359 /**
360 * Creates a Calendar using the given timezone and given locale.
361 * The Calendar takes ownership of zoneToAdopt; the
362 * client must not delete it.
363 *
364 * @param zoneToAdopt The given timezone to be adopted.
365 * @param aLocale The given locale.
366 * @param success Indicates the success/failure of Calendar creation. Filled in
367 * with U_ZERO_ERROR if created successfully, set to a failure result
368 * otherwise.
369 * @return A Calendar if created successfully. NULL otherwise.
370 * @stable ICU 2.0
371 */
372 static Calendar* U_EXPORT2 createInstance(TimeZone* zoneToAdopt, const Locale& aLocale, UErrorCode& success);
373
374 /**
375 * Gets a Calendar using the given timezone and given locale. The TimeZone
376 * is _not_ adopted; the client is still responsible for deleting it.
377 *
378 * @param zone The given timezone.
379 * @param aLocale The given locale.
380 * @param success Indicates the success/failure of Calendar creation. Filled in
381 * with U_ZERO_ERROR if created successfully, set to a failure result
382 * otherwise.
383 * @return A Calendar if created successfully. NULL otherwise.
384 * @stable ICU 2.0
385 */
386 static Calendar* U_EXPORT2 createInstance(const TimeZone& zone, const Locale& aLocale, UErrorCode& success);
387
388 /**
389 * Returns a list of the locales for which Calendars are installed.
390 *
391 * @param count Number of locales returned.
392 * @return An array of Locale objects representing the set of locales for which
393 * Calendars are installed. The system retains ownership of this list;
394 * the caller must NOT delete it. Does not include user-registered Calendars.
395 * @stable ICU 2.0
396 */
397 static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
398
399
400 /**
401 * Given a key and a locale, returns an array of string values in a preferred
402 * order that would make a difference. These are all and only those values where
403 * the open (creation) of the service with the locale formed from the input locale
404 * plus input keyword and that value has different behavior than creation with the
405 * input locale alone.
406 * @param key one of the keys supported by this service. For now, only
407 * "calendar" is supported.
408 * @param locale the locale
409 * @param commonlyUsed if set to true it will return only commonly used values
410 * with the given locale in preferred order. Otherwise,
411 * it will return all the available values for the locale.
412 * @param status ICU Error Code
413 * @return a string enumeration over keyword values for the given key and the locale.
414 * @stable ICU 4.2
415 */
416 static StringEnumeration* U_EXPORT2 getKeywordValuesForLocale(const char* key,
417 const Locale& locale, UBool commonlyUsed, UErrorCode& status);
418
419 /**
420 * Returns the current UTC (GMT) time measured in milliseconds since 0:00:00 on 1/1/70
421 * (derived from the system time).
422 *
423 * @return The current UTC time in milliseconds.
424 * @stable ICU 2.0
425 */
426 static UDate U_EXPORT2 getNow(void);
427
428 /**
429 * Gets this Calendar's time as milliseconds. May involve recalculation of time due
430 * to previous calls to set time field values. The time specified is non-local UTC
431 * (GMT) time. Although this method is const, this object may actually be changed
432 * (semantically const).
433 *
434 * @param status Output param set to success/failure code on exit. If any value
435 * previously set in the time field is invalid or restricted by
436 * leniency, this will be set to an error status.
437 * @return The current time in UTC (GMT) time, or zero if the operation
438 * failed.
439 * @stable ICU 2.0
440 */
getTime(UErrorCode & status)441 inline UDate getTime(UErrorCode& status) const { return getTimeInMillis(status); }
442
443 /**
444 * Sets this Calendar's current time with the given UDate. The time specified should
445 * be in non-local UTC (GMT) time.
446 *
447 * @param date The given UDate in UTC (GMT) time.
448 * @param status Output param set to success/failure code on exit. If any value
449 * set in the time field is invalid or restricted by
450 * leniency, this will be set to an error status.
451 * @stable ICU 2.0
452 */
setTime(UDate date,UErrorCode & status)453 inline void setTime(UDate date, UErrorCode& status) { setTimeInMillis(date, status); }
454
455 /**
456 * Compares the equality of two Calendar objects. Objects of different subclasses
457 * are considered unequal. This comparison is very exacting; two Calendar objects
458 * must be in exactly the same state to be considered equal. To compare based on the
459 * represented time, use equals() instead.
460 *
461 * @param that The Calendar object to be compared with.
462 * @return True if the given Calendar is the same as this Calendar; false
463 * otherwise.
464 * @stable ICU 2.0
465 */
466 virtual UBool operator==(const Calendar& that) const;
467
468 /**
469 * Compares the inequality of two Calendar objects.
470 *
471 * @param that The Calendar object to be compared with.
472 * @return True if the given Calendar is not the same as this Calendar; false
473 * otherwise.
474 * @stable ICU 2.0
475 */
476 UBool operator!=(const Calendar& that) const {return !operator==(that);}
477
478 /**
479 * Returns TRUE if the given Calendar object is equivalent to this
480 * one. An equivalent Calendar will behave exactly as this one
481 * does, but it may be set to a different time. By contrast, for
482 * the operator==() method to return TRUE, the other Calendar must
483 * be set to the same time.
484 *
485 * @param other the Calendar to be compared with this Calendar
486 * @stable ICU 2.4
487 */
488 virtual UBool isEquivalentTo(const Calendar& other) const;
489
490 /**
491 * Compares the Calendar time, whereas Calendar::operator== compares the equality of
492 * Calendar objects.
493 *
494 * @param when The Calendar to be compared with this Calendar. Although this is a
495 * const parameter, the object may be modified physically
496 * (semantically const).
497 * @param status Output param set to success/failure code on exit. If any value
498 * previously set in the time field is invalid or restricted by
499 * leniency, this will be set to an error status.
500 * @return True if the current time of this Calendar is equal to the time of
501 * Calendar when; false otherwise.
502 * @stable ICU 2.0
503 */
504 UBool equals(const Calendar& when, UErrorCode& status) const;
505
506 /**
507 * Returns true if this Calendar's current time is before "when"'s current time.
508 *
509 * @param when The Calendar to be compared with this Calendar. Although this is a
510 * const parameter, the object may be modified physically
511 * (semantically const).
512 * @param status Output param set to success/failure code on exit. If any value
513 * previously set in the time field is invalid or restricted by
514 * leniency, this will be set to an error status.
515 * @return True if the current time of this Calendar is before the time of
516 * Calendar when; false otherwise.
517 * @stable ICU 2.0
518 */
519 UBool before(const Calendar& when, UErrorCode& status) const;
520
521 /**
522 * Returns true if this Calendar's current time is after "when"'s current time.
523 *
524 * @param when The Calendar to be compared with this Calendar. Although this is a
525 * const parameter, the object may be modified physically
526 * (semantically const).
527 * @param status Output param set to success/failure code on exit. If any value
528 * previously set in the time field is invalid or restricted by
529 * leniency, this will be set to an error status.
530 * @return True if the current time of this Calendar is after the time of
531 * Calendar when; false otherwise.
532 * @stable ICU 2.0
533 */
534 UBool after(const Calendar& when, UErrorCode& status) const;
535
536 /**
537 * UDate Arithmetic function. Adds the specified (signed) amount of time to the given
538 * time field, based on the calendar's rules. For example, to subtract 5 days from
539 * the current time of the calendar, call add(Calendar::DATE, -5). When adding on
540 * the month or Calendar::MONTH field, other fields like date might conflict and
541 * need to be changed. For instance, adding 1 month on the date 01/31/96 will result
542 * in 02/29/96.
543 * Adding a positive value always means moving forward in time, so for the Gregorian calendar,
544 * starting with 100 BC and adding +1 to year results in 99 BC (even though this actually reduces
545 * the numeric value of the field itself).
546 *
547 * @param field Specifies which date field to modify.
548 * @param amount The amount of time to be added to the field, in the natural unit
549 * for that field (e.g., days for the day fields, hours for the hour
550 * field.)
551 * @param status Output param set to success/failure code on exit. If any value
552 * previously set in the time field is invalid or restricted by
553 * leniency, this will be set to an error status.
554 * @deprecated ICU 2.6. use add(UCalendarDateFields field, int32_t amount, UErrorCode& status) instead.
555 */
556 virtual void add(EDateFields field, int32_t amount, UErrorCode& status);
557
558 /**
559 * UDate Arithmetic function. Adds the specified (signed) amount of time to the given
560 * time field, based on the calendar's rules. For example, to subtract 5 days from
561 * the current time of the calendar, call add(Calendar::DATE, -5). When adding on
562 * the month or Calendar::MONTH field, other fields like date might conflict and
563 * need to be changed. For instance, adding 1 month on the date 01/31/96 will result
564 * in 02/29/96.
565 * Adding a positive value always means moving forward in time, so for the Gregorian calendar,
566 * starting with 100 BC and adding +1 to year results in 99 BC (even though this actually reduces
567 * the numeric value of the field itself).
568 *
569 * @param field Specifies which date field to modify.
570 * @param amount The amount of time to be added to the field, in the natural unit
571 * for that field (e.g., days for the day fields, hours for the hour
572 * field.)
573 * @param status Output param set to success/failure code on exit. If any value
574 * previously set in the time field is invalid or restricted by
575 * leniency, this will be set to an error status.
576 * @stable ICU 2.6.
577 */
578 virtual void add(UCalendarDateFields field, int32_t amount, UErrorCode& status);
579
580 #ifndef U_HIDE_DEPRECATED_API
581 /**
582 * Time Field Rolling function. Rolls (up/down) a single unit of time on the given
583 * time field. For example, to roll the current date up by one day, call
584 * roll(Calendar::DATE, true). When rolling on the year or Calendar::YEAR field, it
585 * will roll the year value in the range between getMinimum(Calendar::YEAR) and the
586 * value returned by getMaximum(Calendar::YEAR). When rolling on the month or
587 * Calendar::MONTH field, other fields like date might conflict and, need to be
588 * changed. For instance, rolling the month up on the date 01/31/96 will result in
589 * 02/29/96. Rolling up always means rolling forward in time (unless the limit of the
590 * field is reached, in which case it may pin or wrap), so for Gregorian calendar,
591 * starting with 100 BC and rolling the year up results in 99 BC.
592 * When eras have a definite beginning and end (as in the Chinese calendar, or as in
593 * most eras in the Japanese calendar) then rolling the year past either limit of the
594 * era will cause the year to wrap around. When eras only have a limit at one end,
595 * then attempting to roll the year past that limit will result in pinning the year
596 * at that limit. Note that for most calendars in which era 0 years move forward in
597 * time (such as Buddhist, Hebrew, or Islamic), it is possible for add or roll to
598 * result in negative years for era 0 (that is the only way to represent years before
599 * the calendar epoch).
600 * When rolling on the hour-in-day or Calendar::HOUR_OF_DAY field, it will roll the
601 * hour value in the range between 0 and 23, which is zero-based.
602 * <P>
603 * NOTE: Do not use this method -- use roll(EDateFields, int, UErrorCode&) instead.
604 *
605 * @param field The time field.
606 * @param up Indicates if the value of the specified time field is to be rolled
607 * up or rolled down. Use true if rolling up, false otherwise.
608 * @param status Output param set to success/failure code on exit. If any value
609 * previously set in the time field is invalid or restricted by
610 * leniency, this will be set to an error status.
611 * @deprecated ICU 2.6. Use roll(UCalendarDateFields field, UBool up, UErrorCode& status) instead.
612 */
613 inline void roll(EDateFields field, UBool up, UErrorCode& status);
614 #endif /* U_HIDE_DEPRECATED_API */
615
616 /**
617 * Time Field Rolling function. Rolls (up/down) a single unit of time on the given
618 * time field. For example, to roll the current date up by one day, call
619 * roll(Calendar::DATE, true). When rolling on the year or Calendar::YEAR field, it
620 * will roll the year value in the range between getMinimum(Calendar::YEAR) and the
621 * value returned by getMaximum(Calendar::YEAR). When rolling on the month or
622 * Calendar::MONTH field, other fields like date might conflict and, need to be
623 * changed. For instance, rolling the month up on the date 01/31/96 will result in
624 * 02/29/96. Rolling up always means rolling forward in time (unless the limit of the
625 * field is reached, in which case it may pin or wrap), so for Gregorian calendar,
626 * starting with 100 BC and rolling the year up results in 99 BC.
627 * When eras have a definite beginning and end (as in the Chinese calendar, or as in
628 * most eras in the Japanese calendar) then rolling the year past either limit of the
629 * era will cause the year to wrap around. When eras only have a limit at one end,
630 * then attempting to roll the year past that limit will result in pinning the year
631 * at that limit. Note that for most calendars in which era 0 years move forward in
632 * time (such as Buddhist, Hebrew, or Islamic), it is possible for add or roll to
633 * result in negative years for era 0 (that is the only way to represent years before
634 * the calendar epoch).
635 * When rolling on the hour-in-day or Calendar::HOUR_OF_DAY field, it will roll the
636 * hour value in the range between 0 and 23, which is zero-based.
637 * <P>
638 * NOTE: Do not use this method -- use roll(UCalendarDateFields, int, UErrorCode&) instead.
639 *
640 * @param field The time field.
641 * @param up Indicates if the value of the specified time field is to be rolled
642 * up or rolled down. Use true if rolling up, false otherwise.
643 * @param status Output param set to success/failure code on exit. If any value
644 * previously set in the time field is invalid or restricted by
645 * leniency, this will be set to an error status.
646 * @stable ICU 2.6.
647 */
648 inline void roll(UCalendarDateFields field, UBool up, UErrorCode& status);
649
650 /**
651 * Time Field Rolling function. Rolls by the given amount on the given
652 * time field. For example, to roll the current date up by one day, call
653 * roll(Calendar::DATE, +1, status). When rolling on the month or
654 * Calendar::MONTH field, other fields like date might conflict and, need to be
655 * changed. For instance, rolling the month up on the date 01/31/96 will result in
656 * 02/29/96. Rolling by a positive value always means rolling forward in time (unless
657 * the limit of the field is reached, in which case it may pin or wrap), so for
658 * Gregorian calendar, starting with 100 BC and rolling the year by + 1 results in 99 BC.
659 * When eras have a definite beginning and end (as in the Chinese calendar, or as in
660 * most eras in the Japanese calendar) then rolling the year past either limit of the
661 * era will cause the year to wrap around. When eras only have a limit at one end,
662 * then attempting to roll the year past that limit will result in pinning the year
663 * at that limit. Note that for most calendars in which era 0 years move forward in
664 * time (such as Buddhist, Hebrew, or Islamic), it is possible for add or roll to
665 * result in negative years for era 0 (that is the only way to represent years before
666 * the calendar epoch).
667 * When rolling on the hour-in-day or Calendar::HOUR_OF_DAY field, it will roll the
668 * hour value in the range between 0 and 23, which is zero-based.
669 * <P>
670 * The only difference between roll() and add() is that roll() does not change
671 * the value of more significant fields when it reaches the minimum or maximum
672 * of its range, whereas add() does.
673 *
674 * @param field The time field.
675 * @param amount Indicates amount to roll.
676 * @param status Output param set to success/failure code on exit. If any value
677 * previously set in the time field is invalid, this will be set to
678 * an error status.
679 * @deprecated ICU 2.6. Use roll(UCalendarDateFields field, int32_t amount, UErrorCode& status) instead.
680 */
681 virtual void roll(EDateFields field, int32_t amount, UErrorCode& status);
682
683 /**
684 * Time Field Rolling function. Rolls by the given amount on the given
685 * time field. For example, to roll the current date up by one day, call
686 * roll(Calendar::DATE, +1, status). When rolling on the month or
687 * Calendar::MONTH field, other fields like date might conflict and, need to be
688 * changed. For instance, rolling the month up on the date 01/31/96 will result in
689 * 02/29/96. Rolling by a positive value always means rolling forward in time (unless
690 * the limit of the field is reached, in which case it may pin or wrap), so for
691 * Gregorian calendar, starting with 100 BC and rolling the year by + 1 results in 99 BC.
692 * When eras have a definite beginning and end (as in the Chinese calendar, or as in
693 * most eras in the Japanese calendar) then rolling the year past either limit of the
694 * era will cause the year to wrap around. When eras only have a limit at one end,
695 * then attempting to roll the year past that limit will result in pinning the year
696 * at that limit. Note that for most calendars in which era 0 years move forward in
697 * time (such as Buddhist, Hebrew, or Islamic), it is possible for add or roll to
698 * result in negative years for era 0 (that is the only way to represent years before
699 * the calendar epoch).
700 * When rolling on the hour-in-day or Calendar::HOUR_OF_DAY field, it will roll the
701 * hour value in the range between 0 and 23, which is zero-based.
702 * <P>
703 * The only difference between roll() and add() is that roll() does not change
704 * the value of more significant fields when it reaches the minimum or maximum
705 * of its range, whereas add() does.
706 *
707 * @param field The time field.
708 * @param amount Indicates amount to roll.
709 * @param status Output param set to success/failure code on exit. If any value
710 * previously set in the time field is invalid, this will be set to
711 * an error status.
712 * @stable ICU 2.6.
713 */
714 virtual void roll(UCalendarDateFields field, int32_t amount, UErrorCode& status);
715
716 /**
717 * Return the difference between the given time and the time this
718 * calendar object is set to. If this calendar is set
719 * <em>before</em> the given time, the returned value will be
720 * positive. If this calendar is set <em>after</em> the given
721 * time, the returned value will be negative. The
722 * <code>field</code> parameter specifies the units of the return
723 * value. For example, if <code>fieldDifference(when,
724 * Calendar::MONTH)</code> returns 3, then this calendar is set to
725 * 3 months before <code>when</code>, and possibly some addition
726 * time less than one month.
727 *
728 * <p>As a side effect of this call, this calendar is advanced
729 * toward <code>when</code> by the given amount. That is, calling
730 * this method has the side effect of calling <code>add(field,
731 * n)</code>, where <code>n</code> is the return value.
732 *
733 * <p>Usage: To use this method, call it first with the largest
734 * field of interest, then with progressively smaller fields. For
735 * example:
736 *
737 * <pre>
738 * int y = cal->fieldDifference(when, Calendar::YEAR, err);
739 * int m = cal->fieldDifference(when, Calendar::MONTH, err);
740 * int d = cal->fieldDifference(when, Calendar::DATE, err);</pre>
741 *
742 * computes the difference between <code>cal</code> and
743 * <code>when</code> in years, months, and days.
744 *
745 * <p>Note: <code>fieldDifference()</code> is
746 * <em>asymmetrical</em>. That is, in the following code:
747 *
748 * <pre>
749 * cal->setTime(date1, err);
750 * int m1 = cal->fieldDifference(date2, Calendar::MONTH, err);
751 * int d1 = cal->fieldDifference(date2, Calendar::DATE, err);
752 * cal->setTime(date2, err);
753 * int m2 = cal->fieldDifference(date1, Calendar::MONTH, err);
754 * int d2 = cal->fieldDifference(date1, Calendar::DATE, err);</pre>
755 *
756 * one might expect that <code>m1 == -m2 && d1 == -d2</code>.
757 * However, this is not generally the case, because of
758 * irregularities in the underlying calendar system (e.g., the
759 * Gregorian calendar has a varying number of days per month).
760 *
761 * @param when the date to compare this calendar's time to
762 * @param field the field in which to compute the result
763 * @param status Output param set to success/failure code on exit. If any value
764 * previously set in the time field is invalid, this will be set to
765 * an error status.
766 * @return the difference, either positive or negative, between
767 * this calendar's time and <code>when</code>, in terms of
768 * <code>field</code>.
769 * @deprecated ICU 2.6. Use fieldDifference(UDate when, UCalendarDateFields field, UErrorCode& status).
770 */
771 virtual int32_t fieldDifference(UDate when, EDateFields field, UErrorCode& status);
772
773 /**
774 * Return the difference between the given time and the time this
775 * calendar object is set to. If this calendar is set
776 * <em>before</em> the given time, the returned value will be
777 * positive. If this calendar is set <em>after</em> the given
778 * time, the returned value will be negative. The
779 * <code>field</code> parameter specifies the units of the return
780 * value. For example, if <code>fieldDifference(when,
781 * Calendar::MONTH)</code> returns 3, then this calendar is set to
782 * 3 months before <code>when</code>, and possibly some addition
783 * time less than one month.
784 *
785 * <p>As a side effect of this call, this calendar is advanced
786 * toward <code>when</code> by the given amount. That is, calling
787 * this method has the side effect of calling <code>add(field,
788 * n)</code>, where <code>n</code> is the return value.
789 *
790 * <p>Usage: To use this method, call it first with the largest
791 * field of interest, then with progressively smaller fields. For
792 * example:
793 *
794 * <pre>
795 * int y = cal->fieldDifference(when, Calendar::YEAR, err);
796 * int m = cal->fieldDifference(when, Calendar::MONTH, err);
797 * int d = cal->fieldDifference(when, Calendar::DATE, err);</pre>
798 *
799 * computes the difference between <code>cal</code> and
800 * <code>when</code> in years, months, and days.
801 *
802 * <p>Note: <code>fieldDifference()</code> is
803 * <em>asymmetrical</em>. That is, in the following code:
804 *
805 * <pre>
806 * cal->setTime(date1, err);
807 * int m1 = cal->fieldDifference(date2, Calendar::MONTH, err);
808 * int d1 = cal->fieldDifference(date2, Calendar::DATE, err);
809 * cal->setTime(date2, err);
810 * int m2 = cal->fieldDifference(date1, Calendar::MONTH, err);
811 * int d2 = cal->fieldDifference(date1, Calendar::DATE, err);</pre>
812 *
813 * one might expect that <code>m1 == -m2 && d1 == -d2</code>.
814 * However, this is not generally the case, because of
815 * irregularities in the underlying calendar system (e.g., the
816 * Gregorian calendar has a varying number of days per month).
817 *
818 * @param when the date to compare this calendar's time to
819 * @param field the field in which to compute the result
820 * @param status Output param set to success/failure code on exit. If any value
821 * previously set in the time field is invalid, this will be set to
822 * an error status.
823 * @return the difference, either positive or negative, between
824 * this calendar's time and <code>when</code>, in terms of
825 * <code>field</code>.
826 * @stable ICU 2.6.
827 */
828 virtual int32_t fieldDifference(UDate when, UCalendarDateFields field, UErrorCode& status);
829
830 /**
831 * Sets the calendar's time zone to be the one passed in. The Calendar takes ownership
832 * of the TimeZone; the caller is no longer responsible for deleting it. If the
833 * given time zone is NULL, this function has no effect.
834 *
835 * @param value The given time zone.
836 * @stable ICU 2.0
837 */
838 void adoptTimeZone(TimeZone* value);
839
840 /**
841 * Sets the calendar's time zone to be the same as the one passed in. The TimeZone
842 * passed in is _not_ adopted; the client is still responsible for deleting it.
843 *
844 * @param zone The given time zone.
845 * @stable ICU 2.0
846 */
847 void setTimeZone(const TimeZone& zone);
848
849 /**
850 * Returns a reference to the time zone owned by this calendar. The returned reference
851 * is only valid until clients make another call to adoptTimeZone or setTimeZone,
852 * or this Calendar is destroyed.
853 *
854 * @return The time zone object associated with this calendar.
855 * @stable ICU 2.0
856 */
857 const TimeZone& getTimeZone(void) const;
858
859 /**
860 * Returns the time zone owned by this calendar. The caller owns the returned object
861 * and must delete it when done. After this call, the new time zone associated
862 * with this Calendar is the default TimeZone as returned by TimeZone::createDefault().
863 *
864 * @return The time zone object which was associated with this calendar.
865 * @stable ICU 2.0
866 */
867 TimeZone* orphanTimeZone(void);
868
869 /**
870 * Queries if the current date for this Calendar is in Daylight Savings Time.
871 *
872 * @param status Fill-in parameter which receives the status of this operation.
873 * @return True if the current date for this Calendar is in Daylight Savings Time,
874 * false, otherwise.
875 * @stable ICU 2.0
876 */
877 virtual UBool inDaylightTime(UErrorCode& status) const = 0;
878
879 /**
880 * Specifies whether or not date/time interpretation is to be lenient. With lenient
881 * interpretation, a date such as "February 942, 1996" will be treated as being
882 * equivalent to the 941st day after February 1, 1996. With strict interpretation,
883 * such dates will cause an error when computing time from the time field values
884 * representing the dates.
885 *
886 * @param lenient True specifies date/time interpretation to be lenient.
887 *
888 * @see DateFormat#setLenient
889 * @stable ICU 2.0
890 */
891 void setLenient(UBool lenient);
892
893 /**
894 * Tells whether date/time interpretation is to be lenient.
895 *
896 * @return True tells that date/time interpretation is to be lenient.
897 * @stable ICU 2.0
898 */
899 UBool isLenient(void) const;
900
901 #ifndef U_HIDE_DRAFT_API
902 /**
903 * Sets the behavior for handling wall time repeating multiple times
904 * at negative time zone offset transitions. For example, 1:30 AM on
905 * November 6, 2011 in US Eastern time (Ameirca/New_York) occurs twice;
906 * 1:30 AM EDT, then 1:30 AM EST one hour later. When <code>UCAL_WALLTIME_FIRST</code>
907 * is used, the wall time 1:30AM in this example will be interpreted as 1:30 AM EDT
908 * (first occurrence). When <code>UCAL_WALLTIME_LAST</code> is used, it will be
909 * interpreted as 1:30 AM EST (last occurrence). The default value is
910 * <code>UCAL_WALLTIME_LAST</code>.
911 * <p>
912 * <b>Note:</b>When <code>UCAL_WALLTIME_NEXT_VALID</code> is not a valid
913 * option for this. When the argument is neither <code>UCAL_WALLTIME_FIRST</code>
914 * nor <code>UCAL_WALLTIME_LAST</code>, this method has no effect and will keep
915 * the current setting.
916 *
917 * @param option the behavior for handling repeating wall time, either
918 * <code>UCAL_WALLTIME_FIRST</code> or <code>UCAL_WALLTIME_LAST</code>.
919 * @see #getRepeatedWallTimeOption
920 * @draft ICU 49
921 */
922 void setRepeatedWallTimeOption(UCalendarWallTimeOption option);
923
924 /**
925 * Gets the behavior for handling wall time repeating multiple times
926 * at negative time zone offset transitions.
927 *
928 * @return the behavior for handling repeating wall time, either
929 * <code>UCAL_WALLTIME_FIRST</code> or <code>UCAL_WALLTIME_LAST</code>.
930 * @see #setRepeatedWallTimeOption
931 * @draft ICU 49
932 */
933 UCalendarWallTimeOption getRepeatedWallTimeOption(void) const;
934
935 /**
936 * Sets the behavior for handling skipped wall time at positive time zone offset
937 * transitions. For example, 2:30 AM on March 13, 2011 in US Eastern time (America/New_York)
938 * does not exist because the wall time jump from 1:59 AM EST to 3:00 AM EDT. When
939 * <code>UCAL_WALLTIME_FIRST</code> is used, 2:30 AM is interpreted as 30 minutes before 3:00 AM
940 * EDT, therefore, it will be resolved as 1:30 AM EST. When <code>UCAL_WALLTIME_LAST</code>
941 * is used, 2:30 AM is interpreted as 31 minutes after 1:59 AM EST, therefore, it will be
942 * resolved as 3:30 AM EDT. When <code>UCAL_WALLTIME_NEXT_VALID</code> is used, 2:30 AM will
943 * be resolved as next valid wall time, that is 3:00 AM EDT. The default value is
944 * <code>UCAL_WALLTIME_LAST</code>.
945 * <p>
946 * <b>Note:</b>This option is effective only when this calendar is lenient.
947 * When the calendar is strict, such non-existing wall time will cause an error.
948 *
949 * @param option the behavior for handling skipped wall time at positive time zone
950 * offset transitions, one of <code>UCAL_WALLTIME_FIRST</code>, <code>UCAL_WALLTIME_LAST</code> and
951 * <code>UCAL_WALLTIME_NEXT_VALID</code>.
952 * @see #getSkippedWallTimeOption
953 *
954 * @draft ICU 49
955 */
956 void setSkippedWallTimeOption(UCalendarWallTimeOption option);
957
958 /**
959 * Gets the behavior for handling skipped wall time at positive time zone offset
960 * transitions.
961 *
962 * @return the behavior for handling skipped wall time, one of
963 * <code>UCAL_WALLTIME_FIRST</code>, <code>UCAL_WALLTIME_LAST</code>
964 * and <code>UCAL_WALLTIME_NEXT_VALID</code>.
965 * @see #setSkippedWallTimeOption
966 * @draft ICU 49
967 */
968 UCalendarWallTimeOption getSkippedWallTimeOption(void) const;
969 #endif /* U_HIDE_DRAFT_API */
970
971 #ifndef U_HIDE_DEPRECATED_API
972 /**
973 * Sets what the first day of the week is; e.g., Sunday in US, Monday in France.
974 *
975 * @param value The given first day of the week.
976 * @deprecated ICU 2.6. Use setFirstDayOfWeek(UCalendarDaysOfWeek value) instead.
977 */
978 void setFirstDayOfWeek(EDaysOfWeek value);
979 #endif /* U_HIDE_DEPRECATED_API */
980
981 /**
982 * Sets what the first day of the week is; e.g., Sunday in US, Monday in France.
983 *
984 * @param value The given first day of the week.
985 * @stable ICU 2.6.
986 */
987 void setFirstDayOfWeek(UCalendarDaysOfWeek value);
988
989 #ifndef U_HIDE_DEPRECATED_API
990 /**
991 * Gets what the first day of the week is; e.g., Sunday in US, Monday in France.
992 *
993 * @return The first day of the week.
994 * @deprecated ICU 2.6 use the overload with error code
995 */
996 EDaysOfWeek getFirstDayOfWeek(void) const;
997 #endif /* U_HIDE_DEPRECATED_API */
998
999 /**
1000 * Gets what the first day of the week is; e.g., Sunday in US, Monday in France.
1001 *
1002 * @param status error code
1003 * @return The first day of the week.
1004 * @stable ICU 2.6
1005 */
1006 UCalendarDaysOfWeek getFirstDayOfWeek(UErrorCode &status) const;
1007
1008 /**
1009 * Sets what the minimal days required in the first week of the year are; For
1010 * example, if the first week is defined as one that contains the first day of the
1011 * first month of a year, call the method with value 1. If it must be a full week,
1012 * use value 7.
1013 *
1014 * @param value The given minimal days required in the first week of the year.
1015 * @stable ICU 2.0
1016 */
1017 void setMinimalDaysInFirstWeek(uint8_t value);
1018
1019 /**
1020 * Gets what the minimal days required in the first week of the year are; e.g., if
1021 * the first week is defined as one that contains the first day of the first month
1022 * of a year, getMinimalDaysInFirstWeek returns 1. If the minimal days required must
1023 * be a full week, getMinimalDaysInFirstWeek returns 7.
1024 *
1025 * @return The minimal days required in the first week of the year.
1026 * @stable ICU 2.0
1027 */
1028 uint8_t getMinimalDaysInFirstWeek(void) const;
1029
1030 /**
1031 * Gets the minimum value for the given time field. e.g., for Gregorian
1032 * DAY_OF_MONTH, 1.
1033 *
1034 * @param field The given time field.
1035 * @return The minimum value for the given time field.
1036 * @deprecated ICU 2.6. Use getMinimum(UCalendarDateFields field) instead.
1037 */
1038 virtual int32_t getMinimum(EDateFields field) const;
1039
1040 /**
1041 * Gets the minimum value for the given time field. e.g., for Gregorian
1042 * DAY_OF_MONTH, 1.
1043 *
1044 * @param field The given time field.
1045 * @return The minimum value for the given time field.
1046 * @stable ICU 2.6.
1047 */
1048 virtual int32_t getMinimum(UCalendarDateFields field) const;
1049
1050 /**
1051 * Gets the maximum value for the given time field. e.g. for Gregorian DAY_OF_MONTH,
1052 * 31.
1053 *
1054 * @param field The given time field.
1055 * @return The maximum value for the given time field.
1056 * @deprecated ICU 2.6. Use getMaximum(UCalendarDateFields field) instead.
1057 */
1058 virtual int32_t getMaximum(EDateFields field) const;
1059
1060 /**
1061 * Gets the maximum value for the given time field. e.g. for Gregorian DAY_OF_MONTH,
1062 * 31.
1063 *
1064 * @param field The given time field.
1065 * @return The maximum value for the given time field.
1066 * @stable ICU 2.6.
1067 */
1068 virtual int32_t getMaximum(UCalendarDateFields field) const;
1069
1070 /**
1071 * Gets the highest minimum value for the given field if varies. Otherwise same as
1072 * getMinimum(). For Gregorian, no difference.
1073 *
1074 * @param field The given time field.
1075 * @return The highest minimum value for the given time field.
1076 * @deprecated ICU 2.6. Use getGreatestMinimum(UCalendarDateFields field) instead.
1077 */
1078 virtual int32_t getGreatestMinimum(EDateFields field) const;
1079
1080 /**
1081 * Gets the highest minimum value for the given field if varies. Otherwise same as
1082 * getMinimum(). For Gregorian, no difference.
1083 *
1084 * @param field The given time field.
1085 * @return The highest minimum value for the given time field.
1086 * @stable ICU 2.6.
1087 */
1088 virtual int32_t getGreatestMinimum(UCalendarDateFields field) const;
1089
1090 /**
1091 * Gets the lowest maximum value for the given field if varies. Otherwise same as
1092 * getMaximum(). e.g., for Gregorian DAY_OF_MONTH, 28.
1093 *
1094 * @param field The given time field.
1095 * @return The lowest maximum value for the given time field.
1096 * @deprecated ICU 2.6. Use getLeastMaximum(UCalendarDateFields field) instead.
1097 */
1098 virtual int32_t getLeastMaximum(EDateFields field) const;
1099
1100 /**
1101 * Gets the lowest maximum value for the given field if varies. Otherwise same as
1102 * getMaximum(). e.g., for Gregorian DAY_OF_MONTH, 28.
1103 *
1104 * @param field The given time field.
1105 * @return The lowest maximum value for the given time field.
1106 * @stable ICU 2.6.
1107 */
1108 virtual int32_t getLeastMaximum(UCalendarDateFields field) const;
1109
1110 #ifndef U_HIDE_DEPRECATED_API
1111 /**
1112 * Return the minimum value that this field could have, given the current date.
1113 * For the Gregorian calendar, this is the same as getMinimum() and getGreatestMinimum().
1114 *
1115 * The version of this function on Calendar uses an iterative algorithm to determine the
1116 * actual minimum value for the field. There is almost always a more efficient way to
1117 * accomplish this (in most cases, you can simply return getMinimum()). GregorianCalendar
1118 * overrides this function with a more efficient implementation.
1119 *
1120 * @param field the field to determine the minimum of
1121 * @param status Fill-in parameter which receives the status of this operation.
1122 * @return the minimum of the given field for the current date of this Calendar
1123 * @deprecated ICU 2.6. Use getActualMinimum(UCalendarDateFields field, UErrorCode& status) instead.
1124 */
1125 int32_t getActualMinimum(EDateFields field, UErrorCode& status) const;
1126 #endif /* U_HIDE_DEPRECATED_API */
1127
1128 /**
1129 * Return the minimum value that this field could have, given the current date.
1130 * For the Gregorian calendar, this is the same as getMinimum() and getGreatestMinimum().
1131 *
1132 * The version of this function on Calendar uses an iterative algorithm to determine the
1133 * actual minimum value for the field. There is almost always a more efficient way to
1134 * accomplish this (in most cases, you can simply return getMinimum()). GregorianCalendar
1135 * overrides this function with a more efficient implementation.
1136 *
1137 * @param field the field to determine the minimum of
1138 * @param status Fill-in parameter which receives the status of this operation.
1139 * @return the minimum of the given field for the current date of this Calendar
1140 * @stable ICU 2.6.
1141 */
1142 virtual int32_t getActualMinimum(UCalendarDateFields field, UErrorCode& status) const;
1143
1144 #ifndef U_HIDE_DEPRECATED_API
1145 /**
1146 * Return the maximum value that this field could have, given the current date.
1147 * For example, with the date "Feb 3, 1997" and the DAY_OF_MONTH field, the actual
1148 * maximum would be 28; for "Feb 3, 1996" it s 29. Similarly for a Hebrew calendar,
1149 * for some years the actual maximum for MONTH is 12, and for others 13.
1150 *
1151 * The version of this function on Calendar uses an iterative algorithm to determine the
1152 * actual maximum value for the field. There is almost always a more efficient way to
1153 * accomplish this (in most cases, you can simply return getMaximum()). GregorianCalendar
1154 * overrides this function with a more efficient implementation.
1155 *
1156 * @param field the field to determine the maximum of
1157 * @param status Fill-in parameter which receives the status of this operation.
1158 * @return the maximum of the given field for the current date of this Calendar
1159 * @deprecated ICU 2.6. Use getActualMaximum(UCalendarDateFields field, UErrorCode& status) instead.
1160 */
1161 int32_t getActualMaximum(EDateFields field, UErrorCode& status) const;
1162 #endif /* U_HIDE_DEPRECATED_API */
1163
1164 /**
1165 * Return the maximum value that this field could have, given the current date.
1166 * For example, with the date "Feb 3, 1997" and the DAY_OF_MONTH field, the actual
1167 * maximum would be 28; for "Feb 3, 1996" it s 29. Similarly for a Hebrew calendar,
1168 * for some years the actual maximum for MONTH is 12, and for others 13.
1169 *
1170 * The version of this function on Calendar uses an iterative algorithm to determine the
1171 * actual maximum value for the field. There is almost always a more efficient way to
1172 * accomplish this (in most cases, you can simply return getMaximum()). GregorianCalendar
1173 * overrides this function with a more efficient implementation.
1174 *
1175 * @param field the field to determine the maximum of
1176 * @param status Fill-in parameter which receives the status of this operation.
1177 * @return the maximum of the given field for the current date of this Calendar
1178 * @stable ICU 2.6.
1179 */
1180 virtual int32_t getActualMaximum(UCalendarDateFields field, UErrorCode& status) const;
1181
1182 #ifndef U_HIDE_DEPRECATED_API
1183 /**
1184 * Gets the value for a given time field. Recalculate the current time field values
1185 * if the time value has been changed by a call to setTime(). Return zero for unset
1186 * fields if any fields have been explicitly set by a call to set(). To force a
1187 * recomputation of all fields regardless of the previous state, call complete().
1188 * This method is semantically const, but may alter the object in memory.
1189 *
1190 * @param field The given time field.
1191 * @param status Fill-in parameter which receives the status of the operation.
1192 * @return The value for the given time field, or zero if the field is unset,
1193 * and set() has been called for any other field.
1194 * @deprecated ICU 2.6. Use get(UCalendarDateFields field, UErrorCode& status) instead.
1195 */
1196 int32_t get(EDateFields field, UErrorCode& status) const;
1197 #endif /* U_HIDE_DEPRECATED_API */
1198
1199 /**
1200 * Gets the value for a given time field. Recalculate the current time field values
1201 * if the time value has been changed by a call to setTime(). Return zero for unset
1202 * fields if any fields have been explicitly set by a call to set(). To force a
1203 * recomputation of all fields regardless of the previous state, call complete().
1204 * This method is semantically const, but may alter the object in memory.
1205 *
1206 * @param field The given time field.
1207 * @param status Fill-in parameter which receives the status of the operation.
1208 * @return The value for the given time field, or zero if the field is unset,
1209 * and set() has been called for any other field.
1210 * @stable ICU 2.6.
1211 */
1212 int32_t get(UCalendarDateFields field, UErrorCode& status) const;
1213
1214 #ifndef U_HIDE_DEPRECATED_API
1215 /**
1216 * Determines if the given time field has a value set. This can affect in the
1217 * resolving of time in Calendar. Unset fields have a value of zero, by definition.
1218 *
1219 * @param field The given time field.
1220 * @return True if the given time field has a value set; false otherwise.
1221 * @deprecated ICU 2.6. Use isSet(UCalendarDateFields field) instead.
1222 */
1223 UBool isSet(EDateFields field) const;
1224 #endif /* U_HIDE_DEPRECATED_API */
1225
1226 /**
1227 * Determines if the given time field has a value set. This can affect in the
1228 * resolving of time in Calendar. Unset fields have a value of zero, by definition.
1229 *
1230 * @param field The given time field.
1231 * @return True if the given time field has a value set; false otherwise.
1232 * @stable ICU 2.6.
1233 */
1234 UBool isSet(UCalendarDateFields field) const;
1235
1236 #ifndef U_HIDE_DEPRECATED_API
1237 /**
1238 * Sets the given time field with the given value.
1239 *
1240 * @param field The given time field.
1241 * @param value The value to be set for the given time field.
1242 * @deprecated ICU 2.6. Use set(UCalendarDateFields field, int32_t value) instead.
1243 */
1244 void set(EDateFields field, int32_t value);
1245 #endif /* U_HIDE_DEPRECATED_API */
1246
1247 /**
1248 * Sets the given time field with the given value.
1249 *
1250 * @param field The given time field.
1251 * @param value The value to be set for the given time field.
1252 * @stable ICU 2.6.
1253 */
1254 void set(UCalendarDateFields field, int32_t value);
1255
1256 /**
1257 * Sets the values for the fields YEAR, MONTH, and DATE. Other field values are
1258 * retained; call clear() first if this is not desired.
1259 *
1260 * @param year The value used to set the YEAR time field.
1261 * @param month The value used to set the MONTH time field. Month value is 0-based.
1262 * e.g., 0 for January.
1263 * @param date The value used to set the DATE time field.
1264 * @stable ICU 2.0
1265 */
1266 void set(int32_t year, int32_t month, int32_t date);
1267
1268 /**
1269 * Sets the values for the fields YEAR, MONTH, DATE, HOUR_OF_DAY, and MINUTE. Other
1270 * field values are retained; call clear() first if this is not desired.
1271 *
1272 * @param year The value used to set the YEAR time field.
1273 * @param month The value used to set the MONTH time field. Month value is
1274 * 0-based. E.g., 0 for January.
1275 * @param date The value used to set the DATE time field.
1276 * @param hour The value used to set the HOUR_OF_DAY time field.
1277 * @param minute The value used to set the MINUTE time field.
1278 * @stable ICU 2.0
1279 */
1280 void set(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute);
1281
1282 /**
1283 * Sets the values for the fields YEAR, MONTH, DATE, HOUR_OF_DAY, MINUTE, and SECOND.
1284 * Other field values are retained; call clear() first if this is not desired.
1285 *
1286 * @param year The value used to set the YEAR time field.
1287 * @param month The value used to set the MONTH time field. Month value is
1288 * 0-based. E.g., 0 for January.
1289 * @param date The value used to set the DATE time field.
1290 * @param hour The value used to set the HOUR_OF_DAY time field.
1291 * @param minute The value used to set the MINUTE time field.
1292 * @param second The value used to set the SECOND time field.
1293 * @stable ICU 2.0
1294 */
1295 void set(int32_t year, int32_t month, int32_t date, int32_t hour, int32_t minute, int32_t second);
1296
1297 /**
1298 * Clears the values of all the time fields, making them both unset and assigning
1299 * them a value of zero. The field values will be determined during the next
1300 * resolving of time into time fields.
1301 * @stable ICU 2.0
1302 */
1303 void clear(void);
1304
1305 #ifndef U_HIDE_DEPRECATED_API
1306 /**
1307 * Clears the value in the given time field, both making it unset and assigning it a
1308 * value of zero. This field value will be determined during the next resolving of
1309 * time into time fields.
1310 *
1311 * @param field The time field to be cleared.
1312 * @deprecated ICU 2.6. Use clear(UCalendarDateFields field) instead.
1313 */
1314 void clear(EDateFields field);
1315 #endif /* U_HIDE_DEPRECATED_API */
1316
1317 /**
1318 * Clears the value in the given time field, both making it unset and assigning it a
1319 * value of zero. This field value will be determined during the next resolving of
1320 * time into time fields.
1321 *
1322 * @param field The time field to be cleared.
1323 * @stable ICU 2.6.
1324 */
1325 void clear(UCalendarDateFields field);
1326
1327 /**
1328 * Returns a unique class ID POLYMORPHICALLY. Pure virtual method. This method is to
1329 * implement a simple version of RTTI, since not all C++ compilers support genuine
1330 * RTTI. Polymorphic operator==() and clone() methods call this method.
1331 * <P>
1332 * Concrete subclasses of Calendar must implement getDynamicClassID() and also a
1333 * static method and data member:
1334 *
1335 * static UClassID getStaticClassID() { return (UClassID)&fgClassID; }
1336 * static char fgClassID;
1337 *
1338 * @return The class ID for this object. All objects of a given class have the
1339 * same class ID. Objects of other classes have different class IDs.
1340 * @stable ICU 2.0
1341 */
1342 virtual UClassID getDynamicClassID(void) const = 0;
1343
1344 /**
1345 * Returns the calendar type name string for this Calendar object.
1346 * The returned string is the legacy ICU calendar attribute value,
1347 * for example, "gregorian" or "japanese".
1348 *
1349 * See type="old type name" for the calendar attribute of locale IDs
1350 * at http://www.unicode.org/reports/tr35/#Key_Type_Definitions
1351 *
1352 * Sample code for getting the LDML/BCP 47 calendar key value:
1353 * \code
1354 * const char *calType = cal->getType();
1355 * if (0 == strcmp(calType, "unknown")) {
1356 * // deal with unknown calendar type
1357 * } else {
1358 * string localeID("root@calendar=");
1359 * localeID.append(calType);
1360 * char langTag[100];
1361 * UErrorCode errorCode = U_ZERO_ERROR;
1362 * int32_t length = uloc_toLanguageTag(localeID.c_str(), langTag, (int32_t)sizeof(langTag), TRUE, &errorCode);
1363 * if (U_FAILURE(errorCode)) {
1364 * // deal with errors & overflow
1365 * }
1366 * string lang(langTag, length);
1367 * size_t caPos = lang.find("-ca-");
1368 * lang.erase(0, caPos + 4);
1369 * // lang now contains the LDML calendar type
1370 * }
1371 * \endcode
1372 *
1373 * @return legacy calendar type name string
1374 * @draft ICU 49
1375 */
1376 virtual const char * getType() const = 0;
1377
1378 /**
1379 * Returns whether the given day of the week is a weekday, a
1380 * weekend day, or a day that transitions from one to the other,
1381 * in this calendar system. If a transition occurs at midnight,
1382 * then the days before and after the transition will have the
1383 * type UCAL_WEEKDAY or UCAL_WEEKEND. If a transition occurs at a time
1384 * other than midnight, then the day of the transition will have
1385 * the type UCAL_WEEKEND_ONSET or UCAL_WEEKEND_CEASE. In this case, the
1386 * method getWeekendTransition() will return the point of
1387 * transition.
1388 * @param dayOfWeek The day of the week whose type is desired (UCAL_SUNDAY..UCAL_SATURDAY).
1389 * @param status The error code for the operation.
1390 * @return The UCalendarWeekdayType for the day of the week.
1391 * @stable ICU 4.4
1392 */
1393 virtual UCalendarWeekdayType getDayOfWeekType(UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const;
1394
1395 /**
1396 * Returns the time during the day at which the weekend begins or ends in
1397 * this calendar system. If getDayOfWeekType() rerturns UCAL_WEEKEND_ONSET
1398 * for the specified dayOfWeek, return the time at which the weekend begins.
1399 * If getDayOfWeekType() returns UCAL_WEEKEND_CEASE for the specified dayOfWeek,
1400 * return the time at which the weekend ends. If getDayOfWeekType() returns
1401 * some other UCalendarWeekdayType for the specified dayOfWeek, is it an error condition
1402 * (U_ILLEGAL_ARGUMENT_ERROR).
1403 * @param dayOfWeek The day of the week for which the weekend transition time is
1404 * desired (UCAL_SUNDAY..UCAL_SATURDAY).
1405 * @param status The error code for the operation.
1406 * @return The milliseconds after midnight at which the weekend begins or ends.
1407 * @stable ICU 4.4
1408 */
1409 virtual int32_t getWeekendTransition(UCalendarDaysOfWeek dayOfWeek, UErrorCode &status) const;
1410
1411 /**
1412 * Returns TRUE if the given UDate is in the weekend in
1413 * this calendar system.
1414 * @param date The UDate in question.
1415 * @param status The error code for the operation.
1416 * @return TRUE if the given UDate is in the weekend in
1417 * this calendar system, FALSE otherwise.
1418 * @stable ICU 4.4
1419 */
1420 virtual UBool isWeekend(UDate date, UErrorCode &status) const;
1421
1422 /**
1423 * Returns TRUE if this Calendar's current date-time is in the weekend in
1424 * this calendar system.
1425 * @return TRUE if this Calendar's current date-time is in the weekend in
1426 * this calendar system, FALSE otherwise.
1427 * @stable ICU 4.4
1428 */
1429 virtual UBool isWeekend(void) const;
1430
1431 protected:
1432
1433 /**
1434 * Constructs a Calendar with the default time zone as returned by
1435 * TimeZone::createInstance(), and the default locale.
1436 *
1437 * @param success Indicates the status of Calendar object construction. Returns
1438 * U_ZERO_ERROR if constructed successfully.
1439 * @stable ICU 2.0
1440 */
1441 Calendar(UErrorCode& success);
1442
1443 /**
1444 * Copy constructor
1445 *
1446 * @param source Calendar object to be copied from
1447 * @stable ICU 2.0
1448 */
1449 Calendar(const Calendar& source);
1450
1451 /**
1452 * Default assignment operator
1453 *
1454 * @param right Calendar object to be copied
1455 * @stable ICU 2.0
1456 */
1457 Calendar& operator=(const Calendar& right);
1458
1459 /**
1460 * Constructs a Calendar with the given time zone and locale. Clients are no longer
1461 * responsible for deleting the given time zone object after it's adopted.
1462 *
1463 * @param zone The given time zone.
1464 * @param aLocale The given locale.
1465 * @param success Indicates the status of Calendar object construction. Returns
1466 * U_ZERO_ERROR if constructed successfully.
1467 * @stable ICU 2.0
1468 */
1469 Calendar(TimeZone* zone, const Locale& aLocale, UErrorCode& success);
1470
1471 /**
1472 * Constructs a Calendar with the given time zone and locale.
1473 *
1474 * @param zone The given time zone.
1475 * @param aLocale The given locale.
1476 * @param success Indicates the status of Calendar object construction. Returns
1477 * U_ZERO_ERROR if constructed successfully.
1478 * @stable ICU 2.0
1479 */
1480 Calendar(const TimeZone& zone, const Locale& aLocale, UErrorCode& success);
1481
1482 /**
1483 * Converts Calendar's time field values to GMT as milliseconds.
1484 *
1485 * @param status Output param set to success/failure code on exit. If any value
1486 * previously set in the time field is invalid or restricted by
1487 * leniency, this will be set to an error status.
1488 * @stable ICU 2.0
1489 */
1490 virtual void computeTime(UErrorCode& status);
1491
1492 /**
1493 * Converts GMT as milliseconds to time field values. This allows you to sync up the
1494 * time field values with a new time that is set for the calendar. This method
1495 * does NOT recompute the time first; to recompute the time, then the fields, use
1496 * the method complete().
1497 *
1498 * @param status Output param set to success/failure code on exit. If any value
1499 * previously set in the time field is invalid or restricted by
1500 * leniency, this will be set to an error status.
1501 * @stable ICU 2.0
1502 */
1503 virtual void computeFields(UErrorCode& status);
1504
1505 /**
1506 * Gets this Calendar's current time as a long.
1507 *
1508 * @param status Output param set to success/failure code on exit. If any value
1509 * previously set in the time field is invalid or restricted by
1510 * leniency, this will be set to an error status.
1511 * @return the current time as UTC milliseconds from the epoch.
1512 * @stable ICU 2.0
1513 */
1514 double getTimeInMillis(UErrorCode& status) const;
1515
1516 /**
1517 * Sets this Calendar's current time from the given long value.
1518 * @param millis the new time in UTC milliseconds from the epoch.
1519 * @param status Output param set to success/failure code on exit. If any value
1520 * previously set in the time field is invalid or restricted by
1521 * leniency, this will be set to an error status.
1522 * @stable ICU 2.0
1523 */
1524 void setTimeInMillis( double millis, UErrorCode& status );
1525
1526 /**
1527 * Recomputes the current time from currently set fields, and then fills in any
1528 * unset fields in the time field list.
1529 *
1530 * @param status Output param set to success/failure code on exit. If any value
1531 * previously set in the time field is invalid or restricted by
1532 * leniency, this will be set to an error status.
1533 * @stable ICU 2.0
1534 */
1535 void complete(UErrorCode& status);
1536
1537 #ifndef U_HIDE_DEPRECATED_API
1538 /**
1539 * Gets the value for a given time field. Subclasses can use this function to get
1540 * field values without forcing recomputation of time.
1541 *
1542 * @param field The given time field.
1543 * @return The value for the given time field.
1544 * @deprecated ICU 2.6. Use internalGet(UCalendarDateFields field) instead.
1545 */
internalGet(EDateFields field)1546 inline int32_t internalGet(EDateFields field) const {return fFields[field];}
1547 #endif /* U_HIDE_DEPRECATED_API */
1548
1549 #ifndef U_HIDE_INTERNAL_API
1550 /**
1551 * Gets the value for a given time field. Subclasses can use this function to get
1552 * field values without forcing recomputation of time. If the field's stamp is UNSET,
1553 * the defaultValue is used.
1554 *
1555 * @param field The given time field.
1556 * @param defaultValue a default value used if the field is unset.
1557 * @return The value for the given time field.
1558 * @internal
1559 */
internalGet(UCalendarDateFields field,int32_t defaultValue)1560 inline int32_t internalGet(UCalendarDateFields field, int32_t defaultValue) const {return fStamp[field]>kUnset ? fFields[field] : defaultValue;}
1561
1562 /**
1563 * Gets the value for a given time field. Subclasses can use this function to get
1564 * field values without forcing recomputation of time.
1565 *
1566 * @param field The given time field.
1567 * @return The value for the given time field.
1568 * @internal
1569 */
internalGet(UCalendarDateFields field)1570 inline int32_t internalGet(UCalendarDateFields field) const {return fFields[field];}
1571 #endif /* U_HIDE_INTERNAL_API */
1572
1573 #ifndef U_HIDE_DEPRECATED_API
1574 /**
1575 * Sets the value for a given time field. This is a fast internal method for
1576 * subclasses. It does not affect the areFieldsInSync, isTimeSet, or areAllFieldsSet
1577 * flags.
1578 *
1579 * @param field The given time field.
1580 * @param value The value for the given time field.
1581 * @deprecated ICU 2.6. Use internalSet(UCalendarDateFields field, int32_t value) instead.
1582 */
1583 void internalSet(EDateFields field, int32_t value);
1584 #endif /* U_HIDE_DEPRECATED_API */
1585
1586 /**
1587 * Sets the value for a given time field. This is a fast internal method for
1588 * subclasses. It does not affect the areFieldsInSync, isTimeSet, or areAllFieldsSet
1589 * flags.
1590 *
1591 * @param field The given time field.
1592 * @param value The value for the given time field.
1593 * @stable ICU 2.6.
1594 */
1595 inline void internalSet(UCalendarDateFields field, int32_t value);
1596
1597 /**
1598 * Prepare this calendar for computing the actual minimum or maximum.
1599 * This method modifies this calendar's fields; it is called on a
1600 * temporary calendar.
1601 * @internal
1602 */
1603 virtual void prepareGetActual(UCalendarDateFields field, UBool isMinimum, UErrorCode &status);
1604
1605 /**
1606 * Limit enums. Not in sync with UCalendarLimitType (refers to internal fields).
1607 * @internal
1608 */
1609 enum ELimitType {
1610 UCAL_LIMIT_MINIMUM = 0,
1611 UCAL_LIMIT_GREATEST_MINIMUM,
1612 UCAL_LIMIT_LEAST_MAXIMUM,
1613 UCAL_LIMIT_MAXIMUM,
1614 UCAL_LIMIT_COUNT
1615 };
1616
1617 /**
1618 * Subclass API for defining limits of different types.
1619 * Subclasses must implement this method to return limits for the
1620 * following fields:
1621 *
1622 * <pre>UCAL_ERA
1623 * UCAL_YEAR
1624 * UCAL_MONTH
1625 * UCAL_WEEK_OF_YEAR
1626 * UCAL_WEEK_OF_MONTH
1627 * UCAL_DATE (DAY_OF_MONTH on Java)
1628 * UCAL_DAY_OF_YEAR
1629 * UCAL_DAY_OF_WEEK_IN_MONTH
1630 * UCAL_YEAR_WOY
1631 * UCAL_EXTENDED_YEAR</pre>
1632 *
1633 * @param field one of the above field numbers
1634 * @param limitType one of <code>MINIMUM</code>, <code>GREATEST_MINIMUM</code>,
1635 * <code>LEAST_MAXIMUM</code>, or <code>MAXIMUM</code>
1636 * @internal
1637 */
1638 virtual int32_t handleGetLimit(UCalendarDateFields field, ELimitType limitType) const = 0;
1639
1640 /**
1641 * Return a limit for a field.
1642 * @param field the field, from <code>0..UCAL_MAX_FIELD</code>
1643 * @param limitType the type specifier for the limit
1644 * @see #ELimitType
1645 * @internal
1646 */
1647 virtual int32_t getLimit(UCalendarDateFields field, ELimitType limitType) const;
1648
1649
1650 /**
1651 * Return the Julian day number of day before the first day of the
1652 * given month in the given extended year. Subclasses should override
1653 * this method to implement their calendar system.
1654 * @param eyear the extended year
1655 * @param month the zero-based month, or 0 if useMonth is false
1656 * @param useMonth if false, compute the day before the first day of
1657 * the given year, otherwise, compute the day before the first day of
1658 * the given month
1659 * @return the Julian day number of the day before the first
1660 * day of the given month and year
1661 * @internal
1662 */
1663 virtual int32_t handleComputeMonthStart(int32_t eyear, int32_t month,
1664 UBool useMonth) const = 0;
1665
1666 /**
1667 * Return the number of days in the given month of the given extended
1668 * year of this calendar system. Subclasses should override this
1669 * method if they can provide a more correct or more efficient
1670 * implementation than the default implementation in Calendar.
1671 * @internal
1672 */
1673 virtual int32_t handleGetMonthLength(int32_t extendedYear, int32_t month) const ;
1674
1675 /**
1676 * Return the number of days in the given extended year of this
1677 * calendar system. Subclasses should override this method if they can
1678 * provide a more correct or more efficient implementation than the
1679 * default implementation in Calendar.
1680 * @stable ICU 2.0
1681 */
1682 virtual int32_t handleGetYearLength(int32_t eyear) const;
1683
1684
1685 /**
1686 * Return the extended year defined by the current fields. This will
1687 * use the UCAL_EXTENDED_YEAR field or the UCAL_YEAR and supra-year fields (such
1688 * as UCAL_ERA) specific to the calendar system, depending on which set of
1689 * fields is newer.
1690 * @return the extended year
1691 * @internal
1692 */
1693 virtual int32_t handleGetExtendedYear() = 0;
1694
1695 /**
1696 * Subclasses may override this. This method calls
1697 * handleGetMonthLength() to obtain the calendar-specific month
1698 * length.
1699 * @param bestField which field to use to calculate the date
1700 * @return julian day specified by calendar fields.
1701 * @internal
1702 */
1703 virtual int32_t handleComputeJulianDay(UCalendarDateFields bestField);
1704
1705 /**
1706 * Subclasses must override this to convert from week fields
1707 * (YEAR_WOY and WEEK_OF_YEAR) to an extended year in the case
1708 * where YEAR, EXTENDED_YEAR are not set.
1709 * The Calendar implementation assumes yearWoy is in extended gregorian form
1710 * @internal
1711 * @return the extended year, UCAL_EXTENDED_YEAR
1712 */
1713 virtual int32_t handleGetExtendedYearFromWeekFields(int32_t yearWoy, int32_t woy);
1714
1715 #ifndef U_HIDE_INTERNAL_API
1716 /**
1717 * Compute the Julian day from fields. Will determine whether to use
1718 * the JULIAN_DAY field directly, or other fields.
1719 * @return the julian day
1720 * @internal
1721 */
1722 int32_t computeJulianDay();
1723
1724 /**
1725 * Compute the milliseconds in the day from the fields. This is a
1726 * value from 0 to 23:59:59.999 inclusive, unless fields are out of
1727 * range, in which case it can be an arbitrary value. This value
1728 * reflects local zone wall time.
1729 * @internal
1730 */
1731 int32_t computeMillisInDay();
1732
1733 /**
1734 * This method can assume EXTENDED_YEAR has been set.
1735 * @param millis milliseconds of the date fields
1736 * @param millisInDay milliseconds of the time fields; may be out
1737 * or range.
1738 * @param ec Output param set to failure code on function return
1739 * when this function fails.
1740 * @internal
1741 */
1742 int32_t computeZoneOffset(double millis, int32_t millisInDay, UErrorCode &ec);
1743
1744
1745 /**
1746 * Determine the best stamp in a range.
1747 * @param start first enum to look at
1748 * @param end last enum to look at
1749 * @param bestSoFar stamp prior to function call
1750 * @return the stamp value of the best stamp
1751 * @internal
1752 */
1753 int32_t newestStamp(UCalendarDateFields start, UCalendarDateFields end, int32_t bestSoFar) const;
1754
1755 /**
1756 * Values for field resolution tables
1757 * @see #resolveFields
1758 * @internal
1759 */
1760 enum {
1761 /** Marker for end of resolve set (row or group). */
1762 kResolveSTOP = -1,
1763 /** Value to be bitwised "ORed" against resolve table field values for remapping. Example: (UCAL_DATE | kResolveRemap) in 1st column will cause 'UCAL_DATE' to be returned, but will not examine the value of UCAL_DATE. */
1764 kResolveRemap = 32
1765 };
1766
1767 /**
1768 * Precedence table for Dates
1769 * @see #resolveFields
1770 * @internal
1771 */
1772 static const UFieldResolutionTable kDatePrecedence[];
1773
1774 /**
1775 * Precedence table for Year
1776 * @see #resolveFields
1777 * @internal
1778 */
1779 static const UFieldResolutionTable kYearPrecedence[];
1780
1781 /**
1782 * Precedence table for Day of Week
1783 * @see #resolveFields
1784 * @internal
1785 */
1786 static const UFieldResolutionTable kDOWPrecedence[];
1787
1788 /**
1789 * Given a precedence table, return the newest field combination in
1790 * the table, or UCAL_FIELD_COUNT if none is found.
1791 *
1792 * <p>The precedence table is a 3-dimensional array of integers. It
1793 * may be thought of as an array of groups. Each group is an array of
1794 * lines. Each line is an array of field numbers. Within a line, if
1795 * all fields are set, then the time stamp of the line is taken to be
1796 * the stamp of the most recently set field. If any field of a line is
1797 * unset, then the line fails to match. Within a group, the line with
1798 * the newest time stamp is selected. The first field of the line is
1799 * returned to indicate which line matched.
1800 *
1801 * <p>In some cases, it may be desirable to map a line to field that
1802 * whose stamp is NOT examined. For example, if the best field is
1803 * DAY_OF_WEEK then the DAY_OF_WEEK_IN_MONTH algorithm may be used. In
1804 * order to do this, insert the value <code>kResolveRemap | F</code> at
1805 * the start of the line, where <code>F</code> is the desired return
1806 * field value. This field will NOT be examined; it only determines
1807 * the return value if the other fields in the line are the newest.
1808 *
1809 * <p>If all lines of a group contain at least one unset field, then no
1810 * line will match, and the group as a whole will fail to match. In
1811 * that case, the next group will be processed. If all groups fail to
1812 * match, then UCAL_FIELD_COUNT is returned.
1813 * @internal
1814 */
1815 UCalendarDateFields resolveFields(const UFieldResolutionTable *precedenceTable);
1816 #endif /* U_HIDE_INTERNAL_API */
1817
1818
1819 /**
1820 * @internal
1821 */
1822 virtual const UFieldResolutionTable* getFieldResolutionTable() const;
1823
1824 #ifndef U_HIDE_INTERNAL_API
1825 /**
1826 * Return the field that is newer, either defaultField, or
1827 * alternateField. If neither is newer or neither is set, return defaultField.
1828 * @internal
1829 */
1830 UCalendarDateFields newerField(UCalendarDateFields defaultField, UCalendarDateFields alternateField) const;
1831 #endif /* U_HIDE_INTERNAL_API */
1832
1833
1834 private:
1835 /**
1836 * Helper function for calculating limits by trial and error
1837 * @param field The field being investigated
1838 * @param startValue starting (least max) value of field
1839 * @param endValue ending (greatest max) value of field
1840 * @param status return type
1841 * @internal
1842 */
1843 int32_t getActualHelper(UCalendarDateFields field, int32_t startValue, int32_t endValue, UErrorCode &status) const;
1844
1845
1846 protected:
1847 /**
1848 * The flag which indicates if the current time is set in the calendar.
1849 * @stable ICU 2.0
1850 */
1851 UBool fIsTimeSet;
1852
1853 /**
1854 * True if the fields are in sync with the currently set time of this Calendar.
1855 * If false, then the next attempt to get the value of a field will
1856 * force a recomputation of all fields from the current value of the time
1857 * field.
1858 * <P>
1859 * This should really be named areFieldsInSync, but the old name is retained
1860 * for backward compatibility.
1861 * @stable ICU 2.0
1862 */
1863 UBool fAreFieldsSet;
1864
1865 /**
1866 * True if all of the fields have been set. This is initially false, and set to
1867 * true by computeFields().
1868 * @stable ICU 2.0
1869 */
1870 UBool fAreAllFieldsSet;
1871
1872 /**
1873 * True if all fields have been virtually set, but have not yet been
1874 * computed. This occurs only in setTimeInMillis(). A calendar set
1875 * to this state will compute all fields from the time if it becomes
1876 * necessary, but otherwise will delay such computation.
1877 * @stable ICU 3.0
1878 */
1879 UBool fAreFieldsVirtuallySet;
1880
1881 /**
1882 * Get the current time without recomputing.
1883 *
1884 * @return the current time without recomputing.
1885 * @stable ICU 2.0
1886 */
internalGetTime(void)1887 UDate internalGetTime(void) const { return fTime; }
1888
1889 /**
1890 * Set the current time without affecting flags or fields.
1891 *
1892 * @param time The time to be set
1893 * @return the current time without recomputing.
1894 * @stable ICU 2.0
1895 */
internalSetTime(UDate time)1896 void internalSetTime(UDate time) { fTime = time; }
1897
1898 /**
1899 * The time fields containing values into which the millis is computed.
1900 * @stable ICU 2.0
1901 */
1902 int32_t fFields[UCAL_FIELD_COUNT];
1903
1904 /**
1905 * The flags which tell if a specified time field for the calendar is set.
1906 * @deprecated ICU 2.8 use (fStamp[n]!=kUnset)
1907 */
1908 UBool fIsSet[UCAL_FIELD_COUNT];
1909
1910 /** Special values of stamp[]
1911 * @stable ICU 2.0
1912 */
1913 enum {
1914 kUnset = 0,
1915 kInternallySet,
1916 kMinimumUserStamp
1917 };
1918
1919 /**
1920 * Pseudo-time-stamps which specify when each field was set. There
1921 * are two special values, UNSET and INTERNALLY_SET. Values from
1922 * MINIMUM_USER_SET to Integer.MAX_VALUE are legal user set values.
1923 * @stable ICU 2.0
1924 */
1925 int32_t fStamp[UCAL_FIELD_COUNT];
1926
1927 /**
1928 * Subclasses may override this method to compute several fields
1929 * specific to each calendar system. These are:
1930 *
1931 * <ul><li>ERA
1932 * <li>YEAR
1933 * <li>MONTH
1934 * <li>DAY_OF_MONTH
1935 * <li>DAY_OF_YEAR
1936 * <li>EXTENDED_YEAR</ul>
1937 *
1938 * Subclasses can refer to the DAY_OF_WEEK and DOW_LOCAL fields, which
1939 * will be set when this method is called. Subclasses can also call
1940 * the getGregorianXxx() methods to obtain Gregorian calendar
1941 * equivalents for the given Julian day.
1942 *
1943 * <p>In addition, subclasses should compute any subclass-specific
1944 * fields, that is, fields from BASE_FIELD_COUNT to
1945 * getFieldCount() - 1.
1946 *
1947 * <p>The default implementation in <code>Calendar</code> implements
1948 * a pure proleptic Gregorian calendar.
1949 * @internal
1950 */
1951 virtual void handleComputeFields(int32_t julianDay, UErrorCode &status);
1952
1953 #ifndef U_HIDE_INTERNAL_API
1954 /**
1955 * Return the extended year on the Gregorian calendar as computed by
1956 * <code>computeGregorianFields()</code>.
1957 * @internal
1958 */
getGregorianYear()1959 int32_t getGregorianYear() const {
1960 return fGregorianYear;
1961 }
1962
1963 /**
1964 * Return the month (0-based) on the Gregorian calendar as computed by
1965 * <code>computeGregorianFields()</code>.
1966 * @internal
1967 */
getGregorianMonth()1968 int32_t getGregorianMonth() const {
1969 return fGregorianMonth;
1970 }
1971
1972 /**
1973 * Return the day of year (1-based) on the Gregorian calendar as
1974 * computed by <code>computeGregorianFields()</code>.
1975 * @internal
1976 */
getGregorianDayOfYear()1977 int32_t getGregorianDayOfYear() const {
1978 return fGregorianDayOfYear;
1979 }
1980
1981 /**
1982 * Return the day of month (1-based) on the Gregorian calendar as
1983 * computed by <code>computeGregorianFields()</code>.
1984 * @internal
1985 */
getGregorianDayOfMonth()1986 int32_t getGregorianDayOfMonth() const {
1987 return fGregorianDayOfMonth;
1988 }
1989 #endif /* U_HIDE_INTERNAL_API */
1990
1991 /**
1992 * Called by computeJulianDay. Returns the default month (0-based) for the year,
1993 * taking year and era into account. Defaults to 0 for Gregorian, which doesn't care.
1994 * @param eyear The extended year
1995 * @internal
1996 */
1997 virtual int32_t getDefaultMonthInYear(int32_t eyear) ;
1998
1999
2000 /**
2001 * Called by computeJulianDay. Returns the default day (1-based) for the month,
2002 * taking currently-set year and era into account. Defaults to 1 for Gregorian.
2003 * @param eyear the extended year
2004 * @param month the month in the year
2005 * @internal
2006 */
2007 virtual int32_t getDefaultDayInMonth(int32_t eyear, int32_t month);
2008
2009 //-------------------------------------------------------------------------
2010 // Protected utility methods for use by subclasses. These are very handy
2011 // for implementing add, roll, and computeFields.
2012 //-------------------------------------------------------------------------
2013
2014 /**
2015 * Adjust the specified field so that it is within
2016 * the allowable range for the date to which this calendar is set.
2017 * For example, in a Gregorian calendar pinning the {@link #UCalendarDateFields DAY_OF_MONTH}
2018 * field for a calendar set to April 31 would cause it to be set
2019 * to April 30.
2020 * <p>
2021 * <b>Subclassing:</b>
2022 * <br>
2023 * This utility method is intended for use by subclasses that need to implement
2024 * their own overrides of {@link #roll roll} and {@link #add add}.
2025 * <p>
2026 * <b>Note:</b>
2027 * <code>pinField</code> is implemented in terms of
2028 * {@link #getActualMinimum getActualMinimum}
2029 * and {@link #getActualMaximum getActualMaximum}. If either of those methods uses
2030 * a slow, iterative algorithm for a particular field, it would be
2031 * unwise to attempt to call <code>pinField</code> for that field. If you
2032 * really do need to do so, you should override this method to do
2033 * something more efficient for that field.
2034 * <p>
2035 * @param field The calendar field whose value should be pinned.
2036 * @param status Output param set to failure code on function return
2037 * when this function fails.
2038 *
2039 * @see #getActualMinimum
2040 * @see #getActualMaximum
2041 * @stable ICU 2.0
2042 */
2043 virtual void pinField(UCalendarDateFields field, UErrorCode& status);
2044
2045 /**
2046 * Return the week number of a day, within a period. This may be the week number in
2047 * a year or the week number in a month. Usually this will be a value >= 1, but if
2048 * some initial days of the period are excluded from week 1, because
2049 * {@link #getMinimalDaysInFirstWeek getMinimalDaysInFirstWeek} is > 1, then
2050 * the week number will be zero for those
2051 * initial days. This method requires the day number and day of week for some
2052 * known date in the period in order to determine the day of week
2053 * on the desired day.
2054 * <p>
2055 * <b>Subclassing:</b>
2056 * <br>
2057 * This method is intended for use by subclasses in implementing their
2058 * {@link #computeTime computeTime} and/or {@link #computeFields computeFields} methods.
2059 * It is often useful in {@link #getActualMinimum getActualMinimum} and
2060 * {@link #getActualMaximum getActualMaximum} as well.
2061 * <p>
2062 * This variant is handy for computing the week number of some other
2063 * day of a period (often the first or last day of the period) when its day
2064 * of the week is not known but the day number and day of week for some other
2065 * day in the period (e.g. the current date) <em>is</em> known.
2066 * <p>
2067 * @param desiredDay The {@link #UCalendarDateFields DAY_OF_YEAR} or
2068 * {@link #UCalendarDateFields DAY_OF_MONTH} whose week number is desired.
2069 * Should be 1 for the first day of the period.
2070 *
2071 * @param dayOfPeriod The {@link #UCalendarDateFields DAY_OF_YEAR}
2072 * or {@link #UCalendarDateFields DAY_OF_MONTH} for a day in the period whose
2073 * {@link #UCalendarDateFields DAY_OF_WEEK} is specified by the
2074 * <code>knownDayOfWeek</code> parameter.
2075 * Should be 1 for first day of period.
2076 *
2077 * @param dayOfWeek The {@link #UCalendarDateFields DAY_OF_WEEK} for the day
2078 * corresponding to the <code>knownDayOfPeriod</code> parameter.
2079 * 1-based with 1=Sunday.
2080 *
2081 * @return The week number (one-based), or zero if the day falls before
2082 * the first week because
2083 * {@link #getMinimalDaysInFirstWeek getMinimalDaysInFirstWeek}
2084 * is more than one.
2085 *
2086 * @stable ICU 2.8
2087 */
2088 int32_t weekNumber(int32_t desiredDay, int32_t dayOfPeriod, int32_t dayOfWeek);
2089
2090
2091 #ifndef U_HIDE_INTERNAL_API
2092 /**
2093 * Return the week number of a day, within a period. This may be the week number in
2094 * a year, or the week number in a month. Usually this will be a value >= 1, but if
2095 * some initial days of the period are excluded from week 1, because
2096 * {@link #getMinimalDaysInFirstWeek getMinimalDaysInFirstWeek} is > 1,
2097 * then the week number will be zero for those
2098 * initial days. This method requires the day of week for the given date in order to
2099 * determine the result.
2100 * <p>
2101 * <b>Subclassing:</b>
2102 * <br>
2103 * This method is intended for use by subclasses in implementing their
2104 * {@link #computeTime computeTime} and/or {@link #computeFields computeFields} methods.
2105 * It is often useful in {@link #getActualMinimum getActualMinimum} and
2106 * {@link #getActualMaximum getActualMaximum} as well.
2107 * <p>
2108 * @param dayOfPeriod The {@link #UCalendarDateFields DAY_OF_YEAR} or
2109 * {@link #UCalendarDateFields DAY_OF_MONTH} whose week number is desired.
2110 * Should be 1 for the first day of the period.
2111 *
2112 * @param dayOfWeek The {@link #UCalendarDateFields DAY_OF_WEEK} for the day
2113 * corresponding to the <code>dayOfPeriod</code> parameter.
2114 * 1-based with 1=Sunday.
2115 *
2116 * @return The week number (one-based), or zero if the day falls before
2117 * the first week because
2118 * {@link #getMinimalDaysInFirstWeek getMinimalDaysInFirstWeek}
2119 * is more than one.
2120 * @internal
2121 */
2122 inline int32_t weekNumber(int32_t dayOfPeriod, int32_t dayOfWeek);
2123
2124 /**
2125 * returns the local DOW, valid range 0..6
2126 * @internal
2127 */
2128 int32_t getLocalDOW();
2129 #endif /* U_HIDE_INTERNAL_API */
2130
2131 private:
2132
2133 /**
2134 * The next available value for fStamp[]
2135 */
2136 int32_t fNextStamp;// = MINIMUM_USER_STAMP;
2137
2138 /**
2139 * Recalculates the time stamp array (fStamp).
2140 * Resets fNextStamp to lowest next stamp value.
2141 */
2142 void recalculateStamp();
2143
2144 /**
2145 * The current time set for the calendar.
2146 */
2147 UDate fTime;
2148
2149 /**
2150 * @see #setLenient
2151 */
2152 UBool fLenient;
2153
2154 /**
2155 * Time zone affects the time calculation done by Calendar. Calendar subclasses use
2156 * the time zone data to produce the local time.
2157 */
2158 TimeZone* fZone;
2159
2160 /**
2161 * Option for rpeated wall time
2162 * @see #setRepeatedWallTimeOption
2163 */
2164 UCalendarWallTimeOption fRepeatedWallTime;
2165
2166 /**
2167 * Option for skipped wall time
2168 * @see #setSkippedWallTimeOption
2169 */
2170 UCalendarWallTimeOption fSkippedWallTime;
2171
2172 /**
2173 * Both firstDayOfWeek and minimalDaysInFirstWeek are locale-dependent. They are
2174 * used to figure out the week count for a specific date for a given locale. These
2175 * must be set when a Calendar is constructed. For example, in US locale,
2176 * firstDayOfWeek is SUNDAY; minimalDaysInFirstWeek is 1. They are used to figure
2177 * out the week count for a specific date for a given locale. These must be set when
2178 * a Calendar is constructed.
2179 */
2180 UCalendarDaysOfWeek fFirstDayOfWeek;
2181 uint8_t fMinimalDaysInFirstWeek;
2182 UCalendarDaysOfWeek fWeekendOnset;
2183 int32_t fWeekendOnsetMillis;
2184 UCalendarDaysOfWeek fWeekendCease;
2185 int32_t fWeekendCeaseMillis;
2186
2187 /**
2188 * Sets firstDayOfWeek and minimalDaysInFirstWeek. Called at Calendar construction
2189 * time.
2190 *
2191 * @param desiredLocale The given locale.
2192 * @param type The calendar type identifier, e.g: gregorian, buddhist, etc.
2193 * @param success Indicates the status of setting the week count data from
2194 * the resource for the given locale. Returns U_ZERO_ERROR if
2195 * constructed successfully.
2196 */
2197 void setWeekData(const Locale& desiredLocale, const char *type, UErrorCode& success);
2198
2199 /**
2200 * Recompute the time and update the status fields isTimeSet
2201 * and areFieldsSet. Callers should check isTimeSet and only
2202 * call this method if isTimeSet is false.
2203 *
2204 * @param status Output param set to success/failure code on exit. If any value
2205 * previously set in the time field is invalid or restricted by
2206 * leniency, this will be set to an error status.
2207 */
2208 void updateTime(UErrorCode& status);
2209
2210 /**
2211 * The Gregorian year, as computed by computeGregorianFields() and
2212 * returned by getGregorianYear().
2213 * @see #computeGregorianFields
2214 */
2215 int32_t fGregorianYear;
2216
2217 /**
2218 * The Gregorian month, as computed by computeGregorianFields() and
2219 * returned by getGregorianMonth().
2220 * @see #computeGregorianFields
2221 */
2222 int32_t fGregorianMonth;
2223
2224 /**
2225 * The Gregorian day of the year, as computed by
2226 * computeGregorianFields() and returned by getGregorianDayOfYear().
2227 * @see #computeGregorianFields
2228 */
2229 int32_t fGregorianDayOfYear;
2230
2231 /**
2232 * The Gregorian day of the month, as computed by
2233 * computeGregorianFields() and returned by getGregorianDayOfMonth().
2234 * @see #computeGregorianFields
2235 */
2236 int32_t fGregorianDayOfMonth;
2237
2238 /* calculations */
2239
2240 /**
2241 * Compute the Gregorian calendar year, month, and day of month from
2242 * the given Julian day. These values are not stored in fields, but in
2243 * member variables gregorianXxx. Also compute the DAY_OF_WEEK and
2244 * DOW_LOCAL fields.
2245 */
2246 void computeGregorianAndDOWFields(int32_t julianDay, UErrorCode &ec);
2247
2248 protected:
2249
2250 /**
2251 * Compute the Gregorian calendar year, month, and day of month from the
2252 * Julian day. These values are not stored in fields, but in member
2253 * variables gregorianXxx. They are used for time zone computations and by
2254 * subclasses that are Gregorian derivatives. Subclasses may call this
2255 * method to perform a Gregorian calendar millis->fields computation.
2256 */
2257 void computeGregorianFields(int32_t julianDay, UErrorCode &ec);
2258
2259 private:
2260
2261 /**
2262 * Compute the fields WEEK_OF_YEAR, YEAR_WOY, WEEK_OF_MONTH,
2263 * DAY_OF_WEEK_IN_MONTH, and DOW_LOCAL from EXTENDED_YEAR, YEAR,
2264 * DAY_OF_WEEK, and DAY_OF_YEAR. The latter fields are computed by the
2265 * subclass based on the calendar system.
2266 *
2267 * <p>The YEAR_WOY field is computed simplistically. It is equal to YEAR
2268 * most of the time, but at the year boundary it may be adjusted to YEAR-1
2269 * or YEAR+1 to reflect the overlap of a week into an adjacent year. In
2270 * this case, a simple increment or decrement is performed on YEAR, even
2271 * though this may yield an invalid YEAR value. For instance, if the YEAR
2272 * is part of a calendar system with an N-year cycle field CYCLE, then
2273 * incrementing the YEAR may involve incrementing CYCLE and setting YEAR
2274 * back to 0 or 1. This is not handled by this code, and in fact cannot be
2275 * simply handled without having subclasses define an entire parallel set of
2276 * fields for fields larger than or equal to a year. This additional
2277 * complexity is not warranted, since the intention of the YEAR_WOY field is
2278 * to support ISO 8601 notation, so it will typically be used with a
2279 * proleptic Gregorian calendar, which has no field larger than a year.
2280 */
2281 void computeWeekFields(UErrorCode &ec);
2282
2283
2284 /**
2285 * Ensure that each field is within its valid range by calling {@link
2286 * #validateField(int, int&)} on each field that has been set. This method
2287 * should only be called if this calendar is not lenient.
2288 * @see #isLenient
2289 * @see #validateField(int, int&)
2290 * @internal
2291 */
2292 void validateFields(UErrorCode &status);
2293
2294 /**
2295 * Validate a single field of this calendar. Subclasses should
2296 * override this method to validate any calendar-specific fields.
2297 * Generic fields can be handled by
2298 * <code>Calendar::validateField()</code>.
2299 * @see #validateField(int, int, int, int&)
2300 * @internal
2301 */
2302 virtual void validateField(UCalendarDateFields field, UErrorCode &status);
2303
2304 /**
2305 * Validate a single field of this calendar given its minimum and
2306 * maximum allowed value. If the field is out of range,
2307 * <code>U_ILLEGAL_ARGUMENT_ERROR</code> will be set. Subclasses may
2308 * use this method in their implementation of {@link
2309 * #validateField(int, int&)}.
2310 * @internal
2311 */
2312 void validateField(UCalendarDateFields field, int32_t min, int32_t max, UErrorCode& status);
2313
2314 protected:
2315 #ifndef U_HIDE_INTERNAL_API
2316 /**
2317 * Convert a quasi Julian date to the day of the week. The Julian date used here is
2318 * not a true Julian date, since it is measured from midnight, not noon. Return
2319 * value is one-based.
2320 *
2321 * @param julian The given Julian date number.
2322 * @return Day number from 1..7 (SUN..SAT).
2323 * @internal
2324 */
2325 static uint8_t julianDayToDayOfWeek(double julian);
2326 #endif /* U_HIDE_INTERNAL_API */
2327
2328 private:
2329 char validLocale[ULOC_FULLNAME_CAPACITY];
2330 char actualLocale[ULOC_FULLNAME_CAPACITY];
2331
2332 public:
2333 #if !UCONFIG_NO_SERVICE
2334 /**
2335 * INTERNAL FOR 2.6 -- Registration.
2336 */
2337
2338 #ifndef U_HIDE_INTERNAL_API
2339 /**
2340 * Return a StringEnumeration over the locales available at the time of the call,
2341 * including registered locales.
2342 * @return a StringEnumeration over the locales available at the time of the call
2343 * @internal
2344 */
2345 static StringEnumeration* getAvailableLocales(void);
2346
2347 /**
2348 * Register a new Calendar factory. The factory will be adopted.
2349 * INTERNAL in 2.6
2350 * @param toAdopt the factory instance to be adopted
2351 * @param status the in/out status code, no special meanings are assigned
2352 * @return a registry key that can be used to unregister this factory
2353 * @internal
2354 */
2355 static URegistryKey registerFactory(ICUServiceFactory* toAdopt, UErrorCode& status);
2356
2357 /**
2358 * Unregister a previously-registered CalendarFactory using the key returned from the
2359 * register call. Key becomes invalid after a successful call and should not be used again.
2360 * The CalendarFactory corresponding to the key will be deleted.
2361 * INTERNAL in 2.6
2362 * @param key the registry key returned by a previous call to registerFactory
2363 * @param status the in/out status code, no special meanings are assigned
2364 * @return TRUE if the factory for the key was successfully unregistered
2365 * @internal
2366 */
2367 static UBool unregister(URegistryKey key, UErrorCode& status);
2368 #endif /* U_HIDE_INTERNAL_API */
2369
2370 /**
2371 * Multiple Calendar Implementation
2372 * @internal
2373 */
2374 friend class CalendarFactory;
2375
2376 /**
2377 * Multiple Calendar Implementation
2378 * @internal
2379 */
2380 friend class CalendarService;
2381
2382 /**
2383 * Multiple Calendar Implementation
2384 * @internal
2385 */
2386 friend class DefaultCalendarFactory;
2387 #endif /* !UCONFIG_NO_SERVICE */
2388
2389 /**
2390 * @internal
2391 * @return TRUE if this calendar has a default century (i.e. 03 -> 2003)
2392 */
2393 virtual UBool haveDefaultCentury() const = 0;
2394
2395 /**
2396 * @internal
2397 * @return the start of the default century, as a UDate
2398 */
2399 virtual UDate defaultCenturyStart() const = 0;
2400 /**
2401 * @internal
2402 * @return the beginning year of the default century, as a year
2403 */
2404 virtual int32_t defaultCenturyStartYear() const = 0;
2405
2406 /** Get the locale for this calendar object. You can choose between valid and actual locale.
2407 * @param type type of the locale we're looking for (valid or actual)
2408 * @param status error code for the operation
2409 * @return the locale
2410 * @stable ICU 2.8
2411 */
2412 Locale getLocale(ULocDataLocaleType type, UErrorCode &status) const;
2413
2414 #ifndef U_HIDE_INTERNAL_API
2415 /** Get the locale for this calendar object. You can choose between valid and actual locale.
2416 * @param type type of the locale we're looking for (valid or actual)
2417 * @param status error code for the operation
2418 * @return the locale
2419 * @internal
2420 */
2421 const char* getLocaleID(ULocDataLocaleType type, UErrorCode &status) const;
2422 #endif /* U_HIDE_INTERNAL_API */
2423
2424 private:
2425 /**
2426 * Cast TimeZone used by this object to BasicTimeZone, or NULL if the TimeZone
2427 * is not an instance of BasicTimeZone.
2428 */
2429 BasicTimeZone* getBasicTimeZone() const;
2430 };
2431
2432 // -------------------------------------
2433
2434 inline Calendar*
createInstance(TimeZone * zone,UErrorCode & errorCode)2435 Calendar::createInstance(TimeZone* zone, UErrorCode& errorCode)
2436 {
2437 // since the Locale isn't specified, use the default locale
2438 return createInstance(zone, Locale::getDefault(), errorCode);
2439 }
2440
2441 // -------------------------------------
2442
2443 inline void
roll(UCalendarDateFields field,UBool up,UErrorCode & status)2444 Calendar::roll(UCalendarDateFields field, UBool up, UErrorCode& status)
2445 {
2446 roll(field, (int32_t)(up ? +1 : -1), status);
2447 }
2448
2449 #ifndef U_HIDE_DEPRECATED_API
2450 inline void
roll(EDateFields field,UBool up,UErrorCode & status)2451 Calendar::roll(EDateFields field, UBool up, UErrorCode& status)
2452 {
2453 roll((UCalendarDateFields) field, up, status);
2454 }
2455 #endif
2456
2457
2458 // -------------------------------------
2459
2460 /**
2461 * Fast method for subclasses. The caller must maintain fUserSetDSTOffset and
2462 * fUserSetZoneOffset, as well as the isSet[] array.
2463 */
2464
2465 inline void
internalSet(UCalendarDateFields field,int32_t value)2466 Calendar::internalSet(UCalendarDateFields field, int32_t value)
2467 {
2468 fFields[field] = value;
2469 fStamp[field] = kInternallySet;
2470 fIsSet[field] = TRUE; // Remove later
2471 }
2472
2473
2474 #ifndef U_HIDE_INTERNAL_API
weekNumber(int32_t dayOfPeriod,int32_t dayOfWeek)2475 inline int32_t Calendar::weekNumber(int32_t dayOfPeriod, int32_t dayOfWeek)
2476 {
2477 return weekNumber(dayOfPeriod, dayOfPeriod, dayOfWeek);
2478 }
2479 #endif
2480
2481 U_NAMESPACE_END
2482
2483 #endif /* #if !UCONFIG_NO_FORMATTING */
2484
2485 #endif // _CALENDAR
2486