← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/calendar.h

  • Committer: Brian Aker
  • Date: 2009-12-29 01:38:38 UTC
  • mfrom: (1251.1.1 drizzle)
  • Revision ID: brian@gaz-20091229013838-03kb2z5xbqw03ddt
Merge of Diego fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/calendar.h
 
1
/* - mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2008 Sun Microsystems
 
5
 * 
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; either version 2 of the License, or
 
9
 *  (at your option) any later version.
 
10
 *
 
11
 *  This program is distributed in the hope that it will be useful,
 
12
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
 *  GNU General Public License for more details.
 
15
 *
 
16
 *  You should have received a copy of the GNU General Public License
 
17
 *  along with this program; if not, write to the Free Software
 
18
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
19
 */
 
20
 
 
21
/**
 
22
 * @file 
 
23
 *
 
24
 * Structures and functions for:
 
25
 *
 
26
 * Calculating day number in Gregorian and Julian proleptic calendars.
 
27
 * Converting between day numbers and dates in the calendars.
 
28
 * Converting between different calendars.
 
29
 * Calculating differences between dates.
 
30
 *
 
31
 * Works used in research:
 
32
 *
 
33
 * @cite "Calendrical Calculations", Dershowitz and Reingold
 
34
 * @cite ISO 8601 http://en.wikipedia.org/wiki/ISO_8601
 
35
 * @cite http://www.ddj.com/hpc-high-performance-computing/197006254 
 
36
 * @cite http://en.wikipedia.org/wiki/Julian_day#Calculation
 
37
 */
 
38
 
 
39
#ifndef DRIZZLED_CALENDAR_H
 
40
#define DRIZZLED_CALENDAR_H
 
41
 
 
42
#define JULIAN_DAY_NUMBER_AT_ABSOLUTE_DAY_ONE INT64_C(1721425)
 
43
 
 
44
#define DAYS_IN_NORMAL_YEAR INT32_C(365)
 
45
#define DAYS_IN_LEAP_YEAR INT32_C(366)
 
46
 
 
47
#define GREGORIAN_START_YEAR 1582
 
48
#define GREGORIAN_START_MONTH 10
 
49
#define GREGORIAN_START_DAY 15
 
50
 
 
51
#define UNIX_EPOCH_MAX_YEARS 2038
 
52
#define UNIX_EPOCH_MIN_YEARS 1970
 
53
 
 
54
#define CALENDAR_YY_PART_YEAR 70
 
55
 
 
56
/**
 
57
 * The following constants define the system of calculating the number
 
58
 * of days in various periods of time in the Gregorian calendar.
 
59
 *
 
60
 * Leap years (years containing 366 days) occur:
 
61
 *
 
62
 * - When the year is evenly divisible by 4
 
63
 * - If the year is evenly divisible by 100, it must also
 
64
 *   be evenly divisible by 400.
 
65
 */
 
66
#define GREGORIAN_DAYS_IN_400_YEARS UINT32_C(146097)
 
67
#define GREGORIAN_DAYS_IN_100_YEARS UINT32_C(36524)
 
68
#define GREGORIAN_DAYS_IN_4_YEARS   UINT32_C(1461)
 
69
 
 
70
/**
 
71
 * Simple macro returning whether the supplied year
 
72
 * is a leap year in the supplied calendar.
 
73
 *
 
74
 * @param Year to evaluate
 
75
 * @param Calendar to use
 
76
 */
 
77
#define IS_LEAP_YEAR(y, c) (days_in_year((y),(c)) == 366)
 
78
 
 
79
/**
 
80
 * Simple macro returning whether the supplied year
 
81
 * is a leap year in the Gregorian proleptic calendar.
 
82
 */
 
83
#define IS_GREGORIAN_LEAP_YEAR(y) (days_in_year_gregorian((y)) == 366)
 
84
 
 
85
/**
 
86
 * Simple macro returning whether the supplied year
 
87
 * is a leap year in the Julian proleptic calendar.
 
88
 */
 
89
#define IS_JULIAN_LEAP_YEAR(y) (days_in_year_julian((y)) == 366)
 
90
 
 
91
#ifdef __cplusplus
 
92
extern "C" {
 
93
#endif
 
94
 
 
95
/**
 
96
 * Different calendars supported by the temporal library
 
97
 */
 
98
enum calendar
 
99
{
 
100
  GREGORIAN= 1
 
101
, JULIAN= 2
 
102
, HEBREW= 3
 
103
, ISLAM= 4
 
104
};
 
105
 
 
106
/**
 
107
 * Calculates the Julian Day Number from the year, month 
 
108
 * and day supplied for a Gregorian Proleptic calendar date.
 
109
 *
 
110
 * @note
 
111
 *
 
112
 * Year month and day values are assumed to be valid.  This 
 
113
 * method does no bounds checking or validation.
 
114
 *
 
115
 * @param Year of date
 
116
 * @param Month of date
 
117
 * @param Day of date
 
118
 */
 
119
int64_t julian_day_number_from_gregorian_date(uint32_t year, uint32_t month, uint32_t day);
 
120
 
 
121
/**
 
122
 * Translates an absolute day number to a 
 
123
 * Julian day number.
 
124
 *
 
125
 * @param The absolute day number
 
126
 */
 
127
int64_t absolute_day_number_to_julian_day_number(int64_t absolute_day);
 
128
 
 
129
/**
 
130
 * Translates a Julian day number to an 
 
131
 * absolute day number.  
 
132
 *
 
133
 * @param The Julian day number
 
134
 */
 
135
int64_t julian_day_number_to_absolute_day_number(int64_t julian_day);
 
136
 
 
137
/**
 
138
 * Given a supplied Julian Day Number, populates a year, month, and day
 
139
 * with the date in the Gregorian Proleptic calendar which corresponds to
 
140
 * the given Julian Day Number.
 
141
 *
 
142
 * @param Julian Day Number
 
143
 * @param Pointer to year to populate
 
144
 * @param Pointer to month to populate
 
145
 * @param Pointer to the day to populate
 
146
 */
 
147
void gregorian_date_from_julian_day_number(int64_t julian_day
 
148
                                         , uint32_t *year_out
 
149
                                         , uint32_t *month_out
 
150
                                         , uint32_t *day_out);
 
151
 
 
152
/**
 
153
 * Given a supplied Absolute Day Number, populates a year, month, and day
 
154
 * with the date in the Gregorian Proleptic calendar which corresponds to
 
155
 * the given Absolute Day Number.
 
156
 *
 
157
 * @param Absolute Day Number
 
158
 * @param Pointer to year to populate
 
159
 * @param Pointer to month to populate
 
160
 * @param Pointer to the day to populate
 
161
 */
 
162
void gregorian_date_from_absolute_day_number(int64_t absolute_day
 
163
                                           , uint32_t *year_out
 
164
                                           , uint32_t *month_out
 
165
                                           , uint32_t *day_out);
 
166
 
 
167
/**
 
168
 * Returns the number of days in a particular year.
 
169
 *
 
170
 * @param year to evaluate
 
171
 * @param calendar to use
 
172
 */
 
173
uint32_t days_in_year(uint32_t year, enum calendar calendar);
 
174
 
 
175
/**
 
176
 * Returns the number of days in a particular Gregorian Proleptic calendar year.
 
177
 *
 
178
 * @param year to evaluate
 
179
 */
 
180
uint32_t days_in_year_gregorian(uint32_t year);
 
181
 
 
182
/**
 
183
 * Returns the number of days in a particular Julian Proleptic calendar year.
 
184
 *
 
185
 * @param year to evaluate
 
186
 */
 
187
uint32_t days_in_year_julian(uint32_t year);
 
188
 
 
189
#define NUM_LEAP_YEARS(y, c) ((c) == GREGORIAN \
 
190
    ? number_of_leap_years_gregorian((y)) \
 
191
    : number_of_leap_years_julian((y)))
 
192
 
 
193
/**
 
194
 * Returns the number of leap years that have
 
195
 * occurred in the Julian Proleptic calendar
 
196
 * up to the supplied year.
 
197
 *
 
198
 * @param year to evaluate (1 - 9999)
 
199
 */
 
200
int32_t number_of_leap_years_julian(uint32_t year);
 
201
 
 
202
/**
 
203
 * Returns the number of leap years that have
 
204
 * occurred in the Gregorian Proleptic calendar
 
205
 * up to the supplied year.
 
206
 *
 
207
 * @param year to evaluate (1 - 9999)
 
208
 */
 
209
int32_t number_of_leap_years_gregorian(uint32_t year);
 
210
 
 
211
/**
 
212
 * Returns the number of days in a month, given
 
213
 * a year and a month in the Gregorian calendar.
 
214
 *
 
215
 * @param Year in Gregorian Proleptic calendar
 
216
 * @param Month in date
 
217
 */
 
218
uint32_t days_in_gregorian_year_month(uint32_t year, uint32_t month);
 
219
 
 
220
/**
 
221
 * Returns the number of the day in a week.
 
222
 *
 
223
 * @see temporal_to_number_days()
 
224
 *
 
225
 * Return values:
 
226
 *
 
227
 * Day            Day Number  Sunday first day?
 
228
 * -------------- ----------- -----------------
 
229
 * Sunday         0           true
 
230
 * Monday         1           true
 
231
 * Tuesday        2           true
 
232
 * Wednesday      3           true
 
233
 * Thursday       4           true
 
234
 * Friday         5           true
 
235
 * Saturday       6           true
 
236
 * Sunday         6           false
 
237
 * Monday         0           false
 
238
 * Tuesday        1           false
 
239
 * Wednesday      2           false
 
240
 * Thursday       3           false
 
241
 * Friday         4           false
 
242
 * Saturday       5           false
 
243
 *
 
244
 * @param Number of days since start of Gregorian calendar.
 
245
 * @param Consider Sunday the first day of the week?
 
246
 */
 
247
uint32_t day_of_week(int64_t day_number, bool sunday_is_first_day_of_week);
 
248
 
 
249
/**
 
250
 * Given a year, month, and day, returns whether the date is 
 
251
 * valid for the Gregorian proleptic calendar.
 
252
 *
 
253
 * @param The year
 
254
 * @param The month
 
255
 * @param The day
 
256
 */
 
257
bool is_valid_gregorian_date(uint32_t year, uint32_t month, uint32_t day);
 
258
 
 
259
/**
 
260
 * Returns whether the supplied date components are within the 
 
261
 * range of the UNIX epoch.
 
262
 *
 
263
 * Times in the range of 1970-01-01T00:00:00 to 2038-01-19T03:14:07
 
264
 *
 
265
 * @param Year
 
266
 * @param Month
 
267
 * @param Day
 
268
 * @param Hour
 
269
 * @param Minute
 
270
 * @param Second
 
271
 */
 
272
bool in_unix_epoch_range(uint32_t year
 
273
                       , uint32_t month
 
274
                       , uint32_t day
 
275
                       , uint32_t hour
 
276
                       , uint32_t minute
 
277
                       , uint32_t second);
 
278
 
 
279
/**
 
280
 * Returns the number of the week from a supplied year, month, and
 
281
 * date in the Gregorian proleptic calendar.  We use strftime() and
 
282
 * the %U, %W, and %V format specifiers depending on the value
 
283
 * of the sunday_is_first_day_of_week parameter.
 
284
 *
 
285
 * @param Subject year
 
286
 * @param Subject month
 
287
 * @param Subject day
 
288
 * @param Is sunday the first day of the week?
 
289
 * @param Pointer to a uint32_t to hold the resulting year, which 
 
290
 *        may be incremented or decremented depending on flags
 
291
 */
 
292
uint32_t week_number_from_gregorian_date(uint32_t year
 
293
                                       , uint32_t month
 
294
                                       , uint32_t day
 
295
                                       , bool sunday_is_first_day_of_week);
 
296
 
 
297
/**
 
298
 * Returns the ISO week number of a supplied year, month, and
 
299
 * date in the Gregorian proleptic calendar.  We use strftime() and
 
300
 * the %V format specifier to do the calculation, which yields a
 
301
 * correct ISO 8601:1988 week number.
 
302
 *
 
303
 * The final year_out parameter is a pointer to an integer which will
 
304
 * be set to the year in which the week belongs, according to ISO8601:1988, 
 
305
 * which may be different from the Gregorian calendar year.
 
306
 *
 
307
 * @see http://en.wikipedia.org/wiki/ISO_8601
 
308
 *
 
309
 * @param Subject year
 
310
 * @param Subject month
 
311
 * @param Subject day
 
312
 * @param Pointer to a uint32_t to hold the resulting year, which 
 
313
 *        may be incremented or decremented depending on flags
 
314
 */
 
315
uint32_t iso_week_number_from_gregorian_date(uint32_t year
 
316
                                           , uint32_t month
 
317
                                           , uint32_t day
 
318
                                           , uint32_t *year_out);
 
319
/**
 
320
 * Takes a number in the form [YY]YYMM and converts it into
 
321
 * a number of months.
 
322
 *
 
323
 * @param Period in the form [YY]YYMM
 
324
 */
 
325
uint32_t year_month_to_months(uint32_t year_month);
 
326
 
 
327
/**
 
328
 * Takes a number of months and converts it to
 
329
 * a period in the form YYYYMM.
 
330
 *
 
331
 * @param Number of months
 
332
 */
 
333
uint32_t months_to_year_month(uint32_t months);
 
334
 
 
335
#ifdef __cplusplus
 
336
}
 
337
#endif
 
338
 
 
339
#endif /* DRIZZLED_CALENDAR_H */