← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/calendar.h

  • Committer: Jay Pipes
  • Date: 2009-01-28 02:39:29 UTC
  • mto: This revision was merged to the branch mainline in revision 815.
  • Revision ID: jpipes@serialcoder-20090128023929-gy7mot4ki11taytg
First function cleanup for temporal handling: YEAR()

* Added source files for calendrical calculations:
 drizzled/calendar.h
 drizzled/calendar.cc
* Added source files for new Temporal classes
 drizzled/temporal.h
 drizzled/temporal.cc
 drizzled/temporal_format.h
 drizzled/temporal_format.cc

Modified drizzled/function/time/year.cc to use the new
Temporal classes instead of the DRIZZLE_TIME struct and 
get_date().

Added new error codes for invalid DATETIME values and ensured
bad datetimes throw errors in calls to YEAR().

Added new test case specifically for the YEAR() function

Modified existing func_time and type_date test cases to expect
errors when calling YEAR() with bad datetimes.

Edited Makefile.am in drizzled/ to ensure libpcre is used during
build and that calendar.cc, temporal.cc and temporal_format.cc are
built.

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
/**
 
55
 * The following constants define the system of calculating the number
 
56
 * of days in various periods of time in the Gregorian calendar.
 
57
 *
 
58
 * Leap years (years containing 366 days) occur:
 
59
 *
 
60
 * - When the year is evenly divisible by 4
 
61
 * - If the year is evenly divisible by 100, it must also
 
62
 *   be evenly divisible by 400.
 
63
 */
 
64
#define GREGORIAN_DAYS_IN_400_YEARS UINT32_C(146097)
 
65
#define GREGORIAN_DAYS_IN_100_YEARS UINT32_C(36524)
 
66
#define GREGORIAN_DAYS_IN_4_YEARS   UINT32_C(1461)
 
67
 
 
68
/**
 
69
 * Simple macro returning whether the supplied year
 
70
 * is a leap year in the supplied calendar.
 
71
 *
 
72
 * @param Year to evaluate
 
73
 * @param Calendar to use
 
74
 */
 
75
#define IS_LEAP_YEAR(y, c) (days_in_year((y),(c)) == 366)
 
76
 
 
77
/**
 
78
 * Simple macro returning whether the supplied year
 
79
 * is a leap year in the Gregorian proleptic calendar.
 
80
 */
 
81
#define IS_GREGORIAN_LEAP_YEAR(y) (days_in_year_gregorian((y)) == 366)
 
82
 
 
83
/**
 
84
 * Simple macro returning whether the supplied year
 
85
 * is a leap year in the Julian proleptic calendar.
 
86
 */
 
87
#define IS_JULIAN_LEAP_YEAR(y) (days_in_year_julian((y)) == 366)
 
88
 
 
89
#ifdef __cplusplus
 
90
extern "C" {
 
91
#endif
 
92
 
 
93
/**
 
94
 * Different calendars supported by the temporal library
 
95
 */
 
96
enum calendar
 
97
{
 
98
  GREGORIAN= 1
 
99
, JULIAN= 2
 
100
, HEBREW= 3
 
101
, ISLAM= 4
 
102
};
 
103
 
 
104
/**
 
105
 * Calculates the Julian Day Number from the year, month 
 
106
 * and day supplied for a Gregorian Proleptic calendar date.
 
107
 *
 
108
 * @note
 
109
 *
 
110
 * Year month and day values are assumed to be valid.  This 
 
111
 * method does no bounds checking or validation.
 
112
 *
 
113
 * @param Year of date
 
114
 * @param Month of date
 
115
 * @param Day of date
 
116
 */
 
117
int64_t julian_day_number_from_gregorian_date(uint32_t year, uint32_t month, uint32_t day);
 
118
 
 
119
/**
 
120
 * Translates an absolute day number to a 
 
121
 * Julian day number.
 
122
 *
 
123
 * @param The absolute day number
 
124
 */
 
125
int64_t absolute_day_number_to_julian_day_number(int64_t absolute_day);
 
126
 
 
127
/**
 
128
 * Translates a Julian day number to an 
 
129
 * absolute day number.  
 
130
 *
 
131
 * @param The Julian day number
 
132
 */
 
133
int64_t julian_day_number_to_absolute_day_number(int64_t julian_day);
 
134
 
 
135
/**
 
136
 * Given a supplied Julian Day Number, populates a year, month, and day
 
137
 * with the date in the Gregorian Proleptic calendar which corresponds to
 
138
 * the given Julian Day Number.
 
139
 *
 
140
 * @param Julian Day Number
 
141
 * @param Pointer to year to populate
 
142
 * @param Pointer to month to populate
 
143
 * @param Pointer to the day to populate
 
144
 */
 
145
void gregorian_date_from_julian_day_number(int64_t julian_day
 
146
                                         , uint32_t *year_out
 
147
                                         , uint32_t *month_out
 
148
                                         , uint32_t *day_out);
 
149
 
 
150
/**
 
151
 * Given a supplied Absolute Day Number, populates a year, month, and day
 
152
 * with the date in the Gregorian Proleptic calendar which corresponds to
 
153
 * the given Absolute Day Number.
 
154
 *
 
155
 * @param Absolute Day Number
 
156
 * @param Pointer to year to populate
 
157
 * @param Pointer to month to populate
 
158
 * @param Pointer to the day to populate
 
159
 */
 
160
void gregorian_date_from_absolute_day_number(int64_t absolute_day
 
161
                                           , uint32_t *year_out
 
162
                                           , uint32_t *month_out
 
163
                                           , uint32_t *day_out);
 
164
 
 
165
/**
 
166
 * Returns the number of days in a particular year.
 
167
 *
 
168
 * @param year to evaluate
 
169
 * @param calendar to use
 
170
 */
 
171
uint32_t days_in_year(uint32_t year, enum calendar calendar);
 
172
 
 
173
/**
 
174
 * Returns the number of days in a particular Gregorian Proleptic calendar year.
 
175
 *
 
176
 * @param year to evaluate
 
177
 */
 
178
uint32_t days_in_year_gregorian(uint32_t year);
 
179
 
 
180
/**
 
181
 * Returns the number of days in a particular Julian Proleptic calendar year.
 
182
 *
 
183
 * @param year to evaluate
 
184
 */
 
185
uint32_t days_in_year_julian(uint32_t year);
 
186
 
 
187
#define NUM_LEAP_YEARS(y, c) ((c) == GREGORIAN \
 
188
    ? number_of_leap_years_gregorian((y)) \
 
189
    : number_of_leap_years_julian((y)))
 
190
 
 
191
/**
 
192
 * Returns the number of leap years that have
 
193
 * occurred in the Julian Proleptic calendar
 
194
 * up to the supplied year.
 
195
 *
 
196
 * @param year to evaluate (1 - 9999)
 
197
 */
 
198
int32_t number_of_leap_years_julian(uint32_t year);
 
199
 
 
200
/**
 
201
 * Returns the number of leap years that have
 
202
 * occurred in the Gregorian Proleptic calendar
 
203
 * up to the supplied year.
 
204
 *
 
205
 * @param year to evaluate (1 - 9999)
 
206
 */
 
207
int32_t number_of_leap_years_gregorian(uint32_t year);
 
208
 
 
209
/**
 
210
 * Returns the number of days in a month, given
 
211
 * a year and a month in the Gregorian calendar.
 
212
 *
 
213
 * @param Year in Gregorian Proleptic calendar
 
214
 * @param Month in date
 
215
 */
 
216
uint32_t days_in_gregorian_year_month(uint32_t year, uint32_t month);
 
217
 
 
218
/**
 
219
 * Returns the number of the day in a week.
 
220
 *
 
221
 * @see temporal_to_number_days()
 
222
 *
 
223
 * Return values:
 
224
 *
 
225
 * Day            Day Number  Sunday first day?
 
226
 * -------------- ----------- -----------------
 
227
 * Sunday         0           true
 
228
 * Monday         1           true
 
229
 * Tuesday        2           true
 
230
 * Wednesday      3           true
 
231
 * Thursday       4           true
 
232
 * Friday         5           true
 
233
 * Saturday       6           true
 
234
 * Sunday         6           false
 
235
 * Monday         0           false
 
236
 * Tuesday        1           false
 
237
 * Wednesday      2           false
 
238
 * Thursday       3           false
 
239
 * Friday         4           false
 
240
 * Saturday       5           false
 
241
 *
 
242
 * @param Number of days since start of Gregorian calendar.
 
243
 * @param Consider Sunday the first day of the week?
 
244
 */
 
245
uint32_t day_of_week(int64_t day_number, bool sunday_is_first_day_of_week);
 
246
 
 
247
/**
 
248
 * Given a year, month, and day, returns whether the date is 
 
249
 * valid for the Gregorian proleptic calendar.
 
250
 *
 
251
 * @param The year
 
252
 * @param The month
 
253
 * @param The day
 
254
 */
 
255
bool is_valid_gregorian_date(uint32_t year, uint32_t month, uint32_t day);
 
256
 
 
257
/**
 
258
 * Returns whether the supplied date components are within the 
 
259
 * range of the UNIX epoch.
 
260
 *
 
261
 * Times in the range of 1970-01-01T00:00:00 to 2038-01-19T03:14:07
 
262
 *
 
263
 * @param Year
 
264
 * @param Month
 
265
 * @param Day
 
266
 * @param Hour
 
267
 * @param Minute
 
268
 * @param Second
 
269
 */
 
270
bool in_unix_epoch_range(uint32_t year
 
271
                       , uint32_t month
 
272
                       , uint32_t day
 
273
                       , uint32_t hour
 
274
                       , uint32_t minute
 
275
                       , uint32_t second);
 
276
 
 
277
/* 
 
278
 * I don't like using these defines, but probably good to keep in sync
 
279
 * with MySQL's week mode stuff.. 
 
280
 */
 
281
#define DRIZZLE_WEEK_MODE_MONDAY_FIRST_DAY   1
 
282
#define DRIZZLE_WEEK_MODE_USE_ISO_8601_1988  2
 
283
#define DRIZZLE_WEEK_MODE_WEEK_RANGE_IS_ORDINAL 4
 
284
 
 
285
/**
 
286
 * Returns the number of the week from a supplied year, month, and
 
287
 * date in the Gregorian proleptic calendar.
 
288
 *
 
289
 * The week number returned will depend on the values of the
 
290
 * various boolean flags passed to the function.
 
291
 *
 
292
 * The flags influence returned values in the following ways:
 
293
 *
 
294
 * sunday_is_first_day_of_week
 
295
 *
 
296
 * If TRUE, Sunday is first day of week
 
297
 * If FALSE,    Monday is first day of week
 
298
 *
 
299
 * week_range_is_ordinal
 
300
 *
 
301
 * If FALSE, the week is in range 0-53
 
302
 *
 
303
 * Week 0 is returned for the the last week of the previous year (for
 
304
 * a date at start of january) In this case one can get 53 for the
 
305
 * first week of next year.  This flag ensures that the week is
 
306
 * relevant for the given year. 
 
307
 *
 
308
 * If TRUE, the week is in range 1-53.
 
309
 *
 
310
 * In this case one may get week 53 for a date in January (when
 
311
 * the week is that last week of previous year) and week 1 for a
 
312
 * date in December.
 
313
 *
 
314
 * use_iso_8601_1988
 
315
 *
 
316
 * If TRUE, the weeks are numbered according to ISO 8601:1988
 
317
 *
 
318
 * ISO 8601:1988 means that if the week containing January 1 has
 
319
 * four or more days in the new year, then it is week 1;
 
320
 * Otherwise it is the last week of the previous year, and the
 
321
 * next week is week 1.
 
322
 *
 
323
 * If FALSE, the week that contains the first 'first-day-of-week' is week 1.
 
324
 *
 
325
 * @param Subject year
 
326
 * @param Subject month
 
327
 * @param Subject day
 
328
 * @param Is sunday the first day of the week?
 
329
 * @param Is the week range ordinal?
 
330
 * @param Should we use ISO 8601:1988 rules?
 
331
 * @param Pointer to a uint32_t to hold the resulting year, which 
 
332
 *        may be incremented or decremented depending on flags
 
333
 */
 
334
uint32_t week_number_from_gregorian_date(uint32_t year
 
335
                                       , uint32_t month
 
336
                                       , uint32_t day
 
337
                                       , bool sunday_is_first_day_of_week
 
338
                                       , bool week_range_is_ordinal
 
339
                                       , bool use_iso_8601_1988
 
340
                                       , uint32_t *year_out);
 
341
 
 
342
#ifdef __cplusplus
 
343
}
 
344
#endif
 
345
 
 
346
#endif /* DRIZZLED_CALENDAR_H */