Merge remote branch 'crater/DragonFly_RELEASE_3_0' into rel3_0
[dragonfly.git] / include / tzfile.h
1 /*
2  * @(#)tzfile.h         8.1
3  * $DragonFly: src/lib/libc/stdtime/tzfile.h,v 1.3 2008/10/19 20:15:58 swildner Exp $
4  */
5
6 #ifndef TZFILE_H
7
8 #define TZFILE_H
9
10 /*
11 ** This file is in the public domain, so clarified as of
12 ** 1996-06-05 by Arthur David Olson.
13 */
14
15 /*
16 ** This header is for use ONLY with the time conversion code.
17 ** There is no guarantee that it will remain unchanged,
18 ** or that it will remain at all.
19 ** Do NOT copy it to any system include directory.
20 ** Thank you!
21 */
22
23 /*
24 ** Information about time zone files.
25 */
26
27 #ifndef TZDIR
28 #define TZDIR   "/usr/share/zoneinfo" /* Time zone object file directory */
29 #endif /* !defined TZDIR */
30
31 #ifndef TZDEFAULT
32 #define TZDEFAULT       "/etc/localtime"
33 #endif /* !defined TZDEFAULT */
34
35 #ifndef TZDEFRULES
36 #define TZDEFRULES      "posixrules"
37 #endif /* !defined TZDEFRULES */
38
39 /*
40 ** Each file begins with. . .
41 */
42
43 #define TZ_MAGIC        "TZif"
44
45 struct tzhead {
46         char    tzh_magic[4];           /* TZ_MAGIC */
47         char    tzh_version[1];         /* '\0' or '2' as of 2005 */
48         char    tzh_reserved[15];       /* reserved--must be zero */
49         char    tzh_ttisgmtcnt[4];      /* coded number of trans. time flags */
50         char    tzh_ttisstdcnt[4];      /* coded number of trans. time flags */
51         char    tzh_leapcnt[4];         /* coded number of leap seconds */
52         char    tzh_timecnt[4];         /* coded number of transition times */
53         char    tzh_typecnt[4];         /* coded number of local time types */
54         char    tzh_charcnt[4];         /* coded number of abbr. chars */
55 };
56
57 /*
58 ** . . .followed by. . .
59 **
60 **      tzh_timecnt (char [4])s         coded transition times a la time(2)
61 **      tzh_timecnt (unsigned char)s    types of local time starting at above
62 **      tzh_typecnt repetitions of
63 **              one (char [4])          coded UTC offset in seconds
64 **              one (unsigned char)     used to set tm_isdst
65 **              one (unsigned char)     that's an abbreviation list index
66 **      tzh_charcnt (char)s             '\0'-terminated zone abbreviations
67 **      tzh_leapcnt repetitions of
68 **              one (char [4])          coded leap second transition times
69 **              one (char [4])          total correction after above
70 **      tzh_ttisstdcnt (char)s          indexed by type; if TRUE, transition
71 **                                      time is standard time, if FALSE,
72 **                                      transition time is wall clock time
73 **                                      if absent, transition times are
74 **                                      assumed to be wall clock time
75 **      tzh_ttisgmtcnt (char)s          indexed by type; if TRUE, transition
76 **                                      time is UTC, if FALSE,
77 **                                      transition time is local time
78 **                                      if absent, transition times are
79 **                                      assumed to be local time
80 */
81
82 /*
83 ** If tzh_version is '2' or greater, the above is followed by a second instance
84 ** of tzhead and a second instance of the data in which each coded transition
85 ** time uses 8 rather than 4 chars,
86 ** then a POSIX-TZ-environment-variable-style string for use in handling
87 ** instants after the last transition time stored in the file
88 ** (with nothing between the newlines if there is no POSIX representation for
89 ** such instants).
90 */
91
92 /*
93 ** In the current implementation, "tzset()" refuses to deal with files that
94 ** exceed any of the limits below.
95 */
96
97 #ifndef TZ_MAX_TIMES
98 #define TZ_MAX_TIMES    1200
99 #endif /* !defined TZ_MAX_TIMES */
100
101 #ifndef TZ_MAX_TYPES
102 #ifndef NOSOLAR
103 #define TZ_MAX_TYPES    256 /* Limited by what (unsigned char)'s can hold */
104 #endif /* !defined NOSOLAR */
105 #ifdef NOSOLAR
106 /*
107 ** Must be at least 14 for Europe/Riga as of Jan 12 1995,
108 ** as noted by Earl Chew.
109 */
110 #define TZ_MAX_TYPES    20      /* Maximum number of local time types */
111 #endif /* !defined NOSOLAR */
112 #endif /* !defined TZ_MAX_TYPES */
113
114 #ifndef TZ_MAX_CHARS
115 #define TZ_MAX_CHARS    50      /* Maximum number of abbreviation characters */
116                                 /* (limited by what unsigned chars can hold) */
117 #endif /* !defined TZ_MAX_CHARS */
118
119 #ifndef TZ_MAX_LEAPS
120 #define TZ_MAX_LEAPS    50      /* Maximum number of leap second corrections */
121 #endif /* !defined TZ_MAX_LEAPS */
122
123 #define SECSPERMIN      60
124 #define MINSPERHOUR     60
125 #define HOURSPERDAY     24
126 #define DAYSPERWEEK     7
127 #define DAYSPERNYEAR    365
128 #define DAYSPERLYEAR    366
129 #define SECSPERHOUR     (SECSPERMIN * MINSPERHOUR)
130 #define SECSPERDAY      ((long) SECSPERHOUR * HOURSPERDAY)
131 #define MONSPERYEAR     12
132
133 #define TM_SUNDAY       0
134 #define TM_MONDAY       1
135 #define TM_TUESDAY      2
136 #define TM_WEDNESDAY    3
137 #define TM_THURSDAY     4
138 #define TM_FRIDAY       5
139 #define TM_SATURDAY     6
140
141 #define TM_JANUARY      0
142 #define TM_FEBRUARY     1
143 #define TM_MARCH        2
144 #define TM_APRIL        3
145 #define TM_MAY          4
146 #define TM_JUNE         5
147 #define TM_JULY         6
148 #define TM_AUGUST       7
149 #define TM_SEPTEMBER    8
150 #define TM_OCTOBER      9
151 #define TM_NOVEMBER     10
152 #define TM_DECEMBER     11
153
154 #define TM_YEAR_BASE    1900
155
156 #define EPOCH_YEAR      1970
157 #define EPOCH_WDAY      TM_THURSDAY
158
159 #define isleap(y) (((y) % 4) == 0 && (((y) % 100) != 0 || ((y) % 400) == 0))
160
161 /*
162 ** Since everything in isleap is modulo 400 (or a factor of 400), we know that
163 **      isleap(y) == isleap(y % 400)
164 ** and so
165 **      isleap(a + b) == isleap((a + b) % 400)
166 ** or
167 **      isleap(a + b) == isleap(a % 400 + b % 400)
168 ** This is true even if % means modulo rather than Fortran remainder
169 ** (which is allowed by C89 but not C99).
170 ** We use this to avoid addition overflow problems.
171 */
172
173 #define isleap_sum(a, b)        isleap((a) % 400 + (b) % 400)
174
175 #endif /* !defined TZFILE_H */