blob: c5f99678b8988c11d5ba23edac87929bd70b13a3 [file] [log] [blame]
Almaz Mingaleev5411aff2022-02-11 12:27:12 +00001/* Layout and location of TZif files. */
2
The Android Open Source Project1dc9e472009-03-03 19:28:35 -08003#ifndef TZFILE_H
4
5#define TZFILE_H
6
7/*
8** This file is in the public domain, so clarified as of
9** 1996-06-05 by Arthur David Olson.
10*/
11
12/*
13** This header is for use ONLY with the time conversion code.
14** There is no guarantee that it will remain unchanged,
15** or that it will remain at all.
16** Do NOT copy it to any system include directory.
17** Thank you!
18*/
19
20/*
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080021** Information about time zone files.
22*/
23
24#ifndef TZDIR
Almaz Mingaleev5411aff2022-02-11 12:27:12 +000025#define TZDIR "/usr/share/zoneinfo" /* Time zone object file directory */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080026#endif /* !defined TZDIR */
27
28#ifndef TZDEFAULT
Almaz Mingaleev5411aff2022-02-11 12:27:12 +000029#define TZDEFAULT "/etc/localtime"
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080030#endif /* !defined TZDEFAULT */
31
32#ifndef TZDEFRULES
Elliott Hughesce4783c2013-07-12 17:31:11 -070033#define TZDEFRULES "posixrules"
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080034#endif /* !defined TZDEFRULES */
35
Almaz Mingaleev5411aff2022-02-11 12:27:12 +000036
37/* See Internet RFC 8536 for more details about the following format. */
38
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080039/*
40** Each file begins with. . .
41*/
42
Elliott Hughesce4783c2013-07-12 17:31:11 -070043#define TZ_MAGIC "TZif"
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080044
45struct tzhead {
Elliott Hughesce4783c2013-07-12 17:31:11 -070046 char tzh_magic[4]; /* TZ_MAGIC */
Almaz Mingaleev5411aff2022-02-11 12:27:12 +000047 char tzh_version[1]; /* '\0' or '2'-'4' as of 2021 */
Elliott Hughes9fb22a32015-10-07 17:13:40 -070048 char tzh_reserved[15]; /* reserved; must be zero */
Almaz Mingaleev5411aff2022-02-11 12:27:12 +000049 char tzh_ttisutcnt[4]; /* coded number of trans. time flags */
Elliott Hughesce4783c2013-07-12 17:31:11 -070050 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 */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080055};
56
57/*
58** . . .followed by. . .
59**
Elliott Hughesce4783c2013-07-12 17:31:11 -070060** 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
Elliott Hughese0d0b152013-09-27 00:04:30 -070063** one (char [4]) coded UT offset in seconds
Elliott Hughesce4783c2013-07-12 17:31:11 -070064** 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
Elliott Hughes9fb22a32015-10-07 17:13:40 -070070** tzh_ttisstdcnt (char)s indexed by type; if 1, transition
71** time is standard time, if 0,
Almaz Mingaleev5411aff2022-02-11 12:27:12 +000072** transition time is local (wall clock)
73** time; if absent, transition times are
Elliott Hughesce4783c2013-07-12 17:31:11 -070074** assumed to be local time
Almaz Mingaleev5411aff2022-02-11 12:27:12 +000075** tzh_ttisutcnt (char)s indexed by type; if 1, transition
76** time is UT, if 0, transition time is
77** local time; if absent, transition
78** times are assumed to be local time.
79** When this is 1, the corresponding
80** std/wall indicator must also be 1.
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080081*/
82
83/*
84** If tzh_version is '2' or greater, the above is followed by a second instance
85** of tzhead and a second instance of the data in which each coded transition
86** time uses 8 rather than 4 chars,
87** then a POSIX-TZ-environment-variable-style string for use in handling
88** instants after the last transition time stored in the file
89** (with nothing between the newlines if there is no POSIX representation for
90** such instants).
Elliott Hughese0d0b152013-09-27 00:04:30 -070091**
92** If tz_version is '3' or greater, the above is extended as follows.
93** First, the POSIX TZ string's hour offset may range from -167
94** through 167 as compared to the POSIX-required 0 through 24.
95** Second, its DST start time may be January 1 at 00:00 and its stop
96** time December 31 at 24:00 plus the difference between DST and
97** standard time, indicating DST all year.
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080098*/
99
100/*
101** In the current implementation, "tzset()" refuses to deal with files that
102** exceed any of the limits below.
103*/
104
105#ifndef TZ_MAX_TIMES
Elliott Hughes9fb22a32015-10-07 17:13:40 -0700106#define TZ_MAX_TIMES 2000
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800107#endif /* !defined TZ_MAX_TIMES */
108
109#ifndef TZ_MAX_TYPES
Calin Juravle627d37c2014-02-28 11:46:03 +0000110/* This must be at least 17 for Europe/Samara and Europe/Vilnius. */
Elliott Hughesce4783c2013-07-12 17:31:11 -0700111#define TZ_MAX_TYPES 256 /* Limited by what (unsigned char)'s can hold */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800112#endif /* !defined TZ_MAX_TYPES */
113
114#ifndef TZ_MAX_CHARS
Elliott Hughesce4783c2013-07-12 17:31:11 -0700115#define TZ_MAX_CHARS 50 /* Maximum number of abbreviation characters */
116 /* (limited by what unsigned chars can hold) */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800117#endif /* !defined TZ_MAX_CHARS */
118
119#ifndef TZ_MAX_LEAPS
Elliott Hughesce4783c2013-07-12 17:31:11 -0700120#define TZ_MAX_LEAPS 50 /* Maximum number of leap second corrections */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800121#endif /* !defined TZ_MAX_LEAPS */
122
Elliott Hughesce4783c2013-07-12 17:31:11 -0700123#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 ((int_fast32_t) SECSPERHOUR * HOURSPERDAY)
131#define MONSPERYEAR 12
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800132
Elliott Hughesce4783c2013-07-12 17:31:11 -0700133#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
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800140
Elliott Hughesce4783c2013-07-12 17:31:11 -0700141#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
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800153
Elliott Hughesce4783c2013-07-12 17:31:11 -0700154#define TM_YEAR_BASE 1900
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800155
Elliott Hughesce4783c2013-07-12 17:31:11 -0700156#define EPOCH_YEAR 1970
157#define EPOCH_WDAY TM_THURSDAY
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800158
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
Elliott Hughesce4783c2013-07-12 17:31:11 -0700163** isleap(y) == isleap(y % 400)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800164** and so
Elliott Hughesce4783c2013-07-12 17:31:11 -0700165** isleap(a + b) == isleap((a + b) % 400)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800166** or
Elliott Hughesce4783c2013-07-12 17:31:11 -0700167** isleap(a + b) == isleap(a % 400 + b % 400)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800168** 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
Elliott Hughesce4783c2013-07-12 17:31:11 -0700173#define isleap_sum(a, b) isleap((a) % 400 + (b) % 400)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800174
175#endif /* !defined TZFILE_H */