← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/calendar.h

  • Committer: Stewart Smith
  • Date: 2008-10-15 04:21:24 UTC
  • mto: This revision was merged to the branch mainline in revision 516.
  • Revision ID: stewart@flamingspork.com-20081015042124-kdmb74bcbky1k1nz
remove my_pthread_[gs]etspecific

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, Inc.
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 UNIX_EPOCH_MIN_YEARS 1970
48
 
#define UNIX_EPOCH_MAX_YEARS 2038
49
 
 
50
 
#define CALENDAR_YY_PART_YEAR 70
51
 
 
52
 
/**
53
 
 * The following constants define the system of calculating the number
54
 
 * of days in various periods of time in the Gregorian calendar.
55
 
 *
56
 
 * Leap years (years containing 366 days) occur:
57
 
 *
58
 
 * - When the year is evenly divisible by 4
59
 
 * - If the year is evenly divisible by 100, it must also
60
 
 *   be evenly divisible by 400.
61
 
 */
62
 
#define GREGORIAN_DAYS_IN_400_YEARS UINT32_C(146097)
63
 
#define GREGORIAN_DAYS_IN_100_YEARS UINT32_C(36524)
64
 
#define GREGORIAN_DAYS_IN_4_YEARS   UINT32_C(1461)
65
 
 
66
 
namespace drizzled
67
 
{
68
 
 
69
 
/**
70
 
 * Different calendars supported by the temporal library
71
 
 */
72
 
enum calendar
73
 
{
74
 
  GREGORIAN= 1, 
75
 
  JULIAN= 2, 
76
 
  HEBREW= 3, 
77
 
  ISLAM= 4
78
 
};
79
 
 
80
 
 
81
 
/**
82
 
 * Calculates the Julian Day Number from the year, month 
83
 
 * and day supplied for a Gregorian Proleptic calendar date.
84
 
 *
85
 
 * @note
86
 
 *
87
 
 * Year month and day values are assumed to be valid.  This 
88
 
 * method does no bounds checking or validation.
89
 
 *
90
 
 * @param Year of date
91
 
 * @param Month of date
92
 
 * @param Day of date
93
 
 */
94
 
int64_t julian_day_number_from_gregorian_date(uint32_t year, uint32_t month, uint32_t day);
95
 
 
96
 
/**
97
 
 * Translates an absolute day number to a 
98
 
 * Julian day number.
99
 
 *
100
 
 * @param The absolute day number
101
 
 */
102
 
int64_t absolute_day_number_to_julian_day_number(int64_t absolute_day);
103
 
 
104
 
/**
105
 
 * Translates a Julian day number to an 
106
 
 * absolute day number.  
107
 
 *
108
 
 * @param The Julian day number
109
 
 */
110
 
int64_t julian_day_number_to_absolute_day_number(int64_t julian_day);
111
 
 
112
 
/**
113
 
 * Given a supplied Julian Day Number, populates a year, month, and day
114
 
 * with the date in the Gregorian Proleptic calendar which corresponds to
115
 
 * the given Julian Day Number.
116
 
 *
117
 
 * @param Julian Day Number
118
 
 * @param Pointer to year to populate
119
 
 * @param Pointer to month to populate
120
 
 * @param Pointer to the day to populate
121
 
 */
122
 
void gregorian_date_from_julian_day_number(int64_t julian_day
123
 
                                         , uint32_t *year_out
124
 
                                         , uint32_t *month_out
125
 
                                         , uint32_t *day_out);
126
 
 
127
 
/**
128
 
 * Given a supplied Absolute Day Number, populates a year, month, and day
129
 
 * with the date in the Gregorian Proleptic calendar which corresponds to
130
 
 * the given Absolute Day Number.
131
 
 *
132
 
 * @param Absolute Day Number
133
 
 * @param Pointer to year to populate
134
 
 * @param Pointer to month to populate
135
 
 * @param Pointer to the day to populate
136
 
 */
137
 
void gregorian_date_from_absolute_day_number(int64_t absolute_day
138
 
                                           , uint32_t *year_out
139
 
                                           , uint32_t *month_out
140
 
                                           , uint32_t *day_out);
141
 
 
142
 
/**
143
 
 * Returns the number of days in a particular year.
144
 
 *
145
 
 * @param year to evaluate
146
 
 * @param calendar to use
147
 
 */
148
 
uint32_t days_in_year(uint32_t year, enum calendar calendar);
149
 
 
150
 
/**
151
 
 * Returns the number of days in a particular Gregorian Proleptic calendar year.
152
 
 *
153
 
 * @param year to evaluate
154
 
 */
155
 
uint32_t days_in_year_gregorian(uint32_t year);
156
 
 
157
 
/**
158
 
 * Returns the number of days in a particular Julian Proleptic calendar year.
159
 
 *
160
 
 * @param year to evaluate
161
 
 */
162
 
uint32_t days_in_year_julian(uint32_t year);
163
 
 
164
 
/**
165
 
 * Returns the number of leap years that have
166
 
 * occurred in the Julian Proleptic calendar
167
 
 * up to the supplied year.
168
 
 *
169
 
 * @param year to evaluate (1 - 9999)
170
 
 */
171
 
int32_t number_of_leap_years_julian(uint32_t year);
172
 
 
173
 
/**
174
 
 * Returns the number of leap years that have
175
 
 * occurred in the Gregorian Proleptic calendar
176
 
 * up to the supplied year.
177
 
 *
178
 
 * @param year to evaluate (1 - 9999)
179
 
 */
180
 
int32_t number_of_leap_years_gregorian(uint32_t year);
181
 
 
182
 
/**
183
 
 * Returns the number of days in a month, given
184
 
 * a year and a month in the Gregorian calendar.
185
 
 *
186
 
 * @param Year in Gregorian Proleptic calendar
187
 
 * @param Month in date
188
 
 */
189
 
uint32_t days_in_gregorian_year_month(uint32_t year, uint32_t month);
190
 
 
191
 
inline static bool num_leap_years(uint32_t y, enum calendar c) 
192
 
{
193
 
  return (c == GREGORIAN                
194
 
          ? number_of_leap_years_gregorian(y) 
195
 
          : number_of_leap_years_julian(y));
196
 
}
197
 
 
198
 
/**
199
 
 * Returns the number of the day in a week.
200
 
 *
201
 
 * @see temporal_to_number_days()
202
 
 *
203
 
 * Return values:
204
 
 *
205
 
 * Day            Day Number  Sunday first day?
206
 
 * -------------- ----------- -----------------
207
 
 * Sunday         0           true
208
 
 * Monday         1           true
209
 
 * Tuesday        2           true
210
 
 * Wednesday      3           true
211
 
 * Thursday       4           true
212
 
 * Friday         5           true
213
 
 * Saturday       6           true
214
 
 * Sunday         6           false
215
 
 * Monday         0           false
216
 
 * Tuesday        1           false
217
 
 * Wednesday      2           false
218
 
 * Thursday       3           false
219
 
 * Friday         4           false
220
 
 * Saturday       5           false
221
 
 *
222
 
 * @param Number of days since start of Gregorian calendar.
223
 
 * @param Consider Sunday the first day of the week?
224
 
 */
225
 
uint32_t day_of_week(int64_t day_number, bool sunday_is_first_day_of_week);
226
 
 
227
 
/**
228
 
 * Given a year, month, and day, returns whether the date is 
229
 
 * valid for the Gregorian proleptic calendar.
230
 
 *
231
 
 * @param The year
232
 
 * @param The month
233
 
 * @param The day
234
 
 */
235
 
bool is_valid_gregorian_date(uint32_t year, uint32_t month, uint32_t day);
236
 
 
237
 
/**
238
 
 * Returns whether the supplied date components are within the 
239
 
 * range of the UNIX epoch.
240
 
 *
241
 
 * Times in the range of 1970-01-01T00:00:00 to 2038-01-19T03:14:07
242
 
 *
243
 
 * @param Year
244
 
 * @param Month
245
 
 * @param Day
246
 
 * @param Hour
247
 
 * @param Minute
248
 
 * @param Second
249
 
 */
250
 
bool in_unix_epoch_range(uint32_t year
251
 
                       , uint32_t month
252
 
                       , uint32_t day
253
 
                       , uint32_t hour
254
 
                       , uint32_t minute
255
 
                       , uint32_t second);
256
 
 
257
 
/**
258
 
 * Returns the number of the week from a supplied year, month, and
259
 
 * date in the Gregorian proleptic calendar.  We use strftime() and
260
 
 * the %U, %W, and %V format specifiers depending on the value
261
 
 * of the sunday_is_first_day_of_week parameter.
262
 
 *
263
 
 * @param Subject year
264
 
 * @param Subject month
265
 
 * @param Subject day
266
 
 * @param Is sunday the first day of the week?
267
 
 * @param Pointer to a uint32_t to hold the resulting year, which 
268
 
 *        may be incremented or decremented depending on flags
269
 
 */
270
 
uint32_t week_number_from_gregorian_date(uint32_t year
271
 
                                       , uint32_t month
272
 
                                       , uint32_t day
273
 
                                       , bool sunday_is_first_day_of_week);
274
 
 
275
 
/**
276
 
 * Returns the ISO week number of a supplied year, month, and
277
 
 * date in the Gregorian proleptic calendar.  We use strftime() and
278
 
 * the %V format specifier to do the calculation, which yields a
279
 
 * correct ISO 8601:1988 week number.
280
 
 *
281
 
 * The final year_out parameter is a pointer to an integer which will
282
 
 * be set to the year in which the week belongs, according to ISO8601:1988, 
283
 
 * which may be different from the Gregorian calendar year.
284
 
 *
285
 
 * @see http://en.wikipedia.org/wiki/ISO_8601
286
 
 *
287
 
 * @param Subject year
288
 
 * @param Subject month
289
 
 * @param Subject day
290
 
 */
291
 
uint32_t iso_week_number_from_gregorian_date(uint32_t year
292
 
                                           , uint32_t month
293
 
                                           , uint32_t day);
294
 
/**
295
 
 * Takes a number in the form [YY]YYMM and converts it into
296
 
 * a number of months.
297
 
 *
298
 
 * @param Period in the form [YY]YYMM
299
 
 */
300
 
uint32_t year_month_to_months(uint32_t year_month);
301
 
 
302
 
/**
303
 
 * Takes a number of months and converts it to
304
 
 * a period in the form YYYYMM.
305
 
 *
306
 
 * @param Number of months
307
 
 */
308
 
uint32_t months_to_year_month(uint32_t months);
309
 
 
310
 
/**
311
 
 * Simple function returning whether the supplied year
312
 
 * is a leap year in the supplied calendar.
313
 
 *
314
 
 * @param Year to evaluate
315
 
 * @param Calendar to use
316
 
 */
317
 
inline static bool is_leap_year(uint32_t y, enum calendar c)
318
 
{
319
 
  return (days_in_year(y, c) == 366);
320
 
}
321
 
 
322
 
/**
323
 
 * Simple function returning whether the supplied year
324
 
 * is a leap year in the Gregorian proleptic calendar.
325
 
 */
326
 
inline static bool is_gregorian_leap_year(uint32_t y)
327
 
{
328
 
  return (days_in_year_gregorian(y) == 366);
329
 
}
330
 
 
331
 
/**
332
 
 * Simple function returning whether the supplied year
333
 
 * is a leap year in the Julian proleptic calendar.
334
 
 */
335
 
inline static bool is_julian_leap_year(uint32_t y) 
336
 
{
337
 
  return (days_in_year_julian(y) == 366);
338
 
}
339
 
 
340
 
} /* namespace drizzled */
341
 
 
342
 
#endif /* DRIZZLED_CALENDAR_H */