[apple/libc.git] / stdtime / FreeBSD / tzfile.h

#ifndef TZFILE_H
#define TZFILE_H


/*
** This file is in the public domain, so clarified as of
** 1996-06-05 by Arthur David Olson.
**
** $FreeBSD: head/contrib/tzcode/stdtime/tzfile.h 192625 2009-05-23 06:31:50Z edwin $
*/

/*
** This header is for use ONLY with the time conversion code.
** There is no guarantee that it will remain unchanged,
** or that it will remain at all.
** Do NOT copy it to any system include directory.
** Thank you!
*/

/*
** ID
*/

#ifndef lint
#ifndef NOID
/*
static char	tzfilehid[] = "@(#)tzfile.h	8.1";
*/
#endif /* !defined NOID */
#endif /* !defined lint */

/*
** Information about time zone files.
*/

#include <TargetConditionals.h>
#include <Availability.h>

/* Time zone object file directory */
#ifndef TZDIR
# if TARGET_OS_SIMULATOR || (TARGET_OS_OSX && __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_13)
#  define TZDIR   "/usr/share/zoneinfo"
# else
#  define TZDIR   "/var/db/timezone/zoneinfo"
# endif
#endif

/* No gurantee is made that the TZDEFAULT symlink will have TZDIR as a prefix.
 * However, clients can assume that the final path component of the prefix will
 * be "zoneinfo"
 */
#ifndef TZDEFAULT
# if TARGET_OS_SIMULATOR || TARGET_OS_OSX
#  define TZDEFAULT       "/etc/localtime"
# else
#  define TZDEFAULT       "/var/db/timezone/localtime"
# endif
#endif

#ifndef TZDEFRULES
#define TZDEFRULES	"posixrules"
#endif /* !defined TZDEFRULES */

/*
** Each file begins with. . .
*/

#define	TZ_MAGIC	"TZif"

struct tzhead {
	char	tzh_magic[4];		/* TZ_MAGIC */
	char	tzh_version[1];		/* '\0' or '2' as of 2005 */
	char	tzh_reserved[15];	/* reserved--must be zero */
	char	tzh_ttisgmtcnt[4];	/* coded number of trans. time flags */
	char	tzh_ttisstdcnt[4];	/* coded number of trans. time flags */
	char	tzh_leapcnt[4];		/* coded number of leap seconds */
	char	tzh_timecnt[4];		/* coded number of transition times */
	char	tzh_typecnt[4];		/* coded number of local time types */
	char	tzh_charcnt[4];		/* coded number of abbr. chars */
};

/*
** . . .followed by. . .
**
**	tzh_timecnt (char [4])s		coded transition times a la time(2)
**	tzh_timecnt (unsigned char)s	types of local time starting at above
**	tzh_typecnt repetitions of
**		one (char [4])		coded UTC offset in seconds
**		one (unsigned char)	used to set tm_isdst
**		one (unsigned char)	that's an abbreviation list index
**	tzh_charcnt (char)s		'\0'-terminated zone abbreviations
**	tzh_leapcnt repetitions of
**		one (char [4])		coded leap second transition times
**		one (char [4])		total correction after above
**	tzh_ttisstdcnt (char)s		indexed by type; if TRUE, transition
**					time is standard time, if FALSE,
**					transition time is wall clock time
**					if absent, transition times are
**					assumed to be wall clock time
**	tzh_ttisgmtcnt (char)s		indexed by type; if TRUE, transition
**					time is UTC, if FALSE,
**					transition time is local time
**					if absent, transition times are
**					assumed to be local time
*/

/*
** If tzh_version is '2' or greater, the above is followed by a second instance
** of tzhead and a second instance of the data in which each coded transition
** time uses 8 rather than 4 chars,
** then a POSIX-TZ-environment-variable-style string for use in handling
** instants after the last transition time stored in the file
** (with nothing between the newlines if there is no POSIX representation for
** such instants).
*/

/*
** In the current implementation, "tzset()" refuses to deal with files that
** exceed any of the limits below.
*/

#ifndef TZ_MAX_TIMES
#define TZ_MAX_TIMES	1200
#endif /* !defined TZ_MAX_TIMES */

#ifndef TZ_MAX_TYPES
#ifndef NOSOLAR
#define TZ_MAX_TYPES	256 /* Limited by what (unsigned char)'s can hold */
#endif /* !defined NOSOLAR */
#ifdef NOSOLAR
/*
** Must be at least 14 for Europe/Riga as of Jan 12 1995,
** as noted by Earl Chew.
*/
#define TZ_MAX_TYPES	20	/* Maximum number of local time types */
#endif /* !defined NOSOLAR */
#endif /* !defined TZ_MAX_TYPES */

#ifndef TZ_MAX_CHARS
#define TZ_MAX_CHARS	50	/* Maximum number of abbreviation characters */
				/* (limited by what unsigned chars can hold) */
#endif /* !defined TZ_MAX_CHARS */

#ifndef TZ_MAX_LEAPS
#define TZ_MAX_LEAPS	50	/* Maximum number of leap second corrections */
#endif /* !defined TZ_MAX_LEAPS */

#define SECSPERMIN	60
#define MINSPERHOUR	60
#define HOURSPERDAY	24
#define DAYSPERWEEK	7
#define DAYSPERNYEAR	365
#define DAYSPERLYEAR	366
#define SECSPERHOUR	(SECSPERMIN * MINSPERHOUR)
#define SECSPERDAY	((long) SECSPERHOUR * HOURSPERDAY)
#define MONSPERYEAR	12

#define TM_SUNDAY	0
#define TM_MONDAY	1
#define TM_TUESDAY	2
#define TM_WEDNESDAY	3
#define TM_THURSDAY	4
#define TM_FRIDAY	5
#define TM_SATURDAY	6

#define TM_JANUARY	0
#define TM_FEBRUARY	1
#define TM_MARCH	2
#define TM_APRIL	3
#define TM_MAY		4
#define TM_JUNE		5
#define TM_JULY		6
#define TM_AUGUST	7
#define TM_SEPTEMBER	8
#define TM_OCTOBER	9
#define TM_NOVEMBER	10
#define TM_DECEMBER	11

#define TM_YEAR_BASE	1900

#define EPOCH_YEAR	1970
#define EPOCH_WDAY	TM_THURSDAY

#define isleap(y) (((y) % 4) == 0 && (((y) % 100) != 0 || ((y) % 400) == 0))

/*
** Since everything in isleap is modulo 400 (or a factor of 400), we know that
**	isleap(y) == isleap(y % 400)
** and so
**	isleap(a + b) == isleap((a + b) % 400)
** or
**	isleap(a + b) == isleap(a % 400 + b % 400)
** This is true even if % means modulo rather than Fortran remainder
** (which is allowed by C89 but not C99).
** We use this to avoid addition overflow problems.
*/

#define isleap_sum(a, b)	isleap((a) % 400 + (b) % 400)

#endif /* !defined TZFILE_H */
Commit	Line	Data
5b2abdfb	1	#ifndef TZFILE_H
5b2abdfb A	2	#define TZFILE_H
5b2abdfb A	3
9385eb3d	4
5b2abdfb A	5	/*
5b2abdfb A	6	** This file is in the public domain, so clarified as of
b061a43b	7	** 1996-06-05 by Arthur David Olson.
9385eb3d	8	**
b061a43b	9	** $FreeBSD: head/contrib/tzcode/stdtime/tzfile.h 192625 2009-05-23 06:31:50Z edwin $
5b2abdfb A	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	/*
	21	** ID
	22	*/
	23
	24	#ifndef lint
	25	#ifndef NOID
	26	/*
b061a43b	27	static char tzfilehid[] = "@(#)tzfile.h 8.1";
5b2abdfb A	28	*/
	29	#endif /* !defined NOID */
	30	#endif /* !defined lint */
	31
	32	/*
	33	** Information about time zone files.
	34	*/
	35
b061a43b A	36	#include <TargetConditionals.h>
b061a43b A	37	#include <Availability.h>
5b2abdfb	38
b061a43b A	39	/* Time zone object file directory */
	40	#ifndef TZDIR
	41	# if TARGET_OS_SIMULATOR \|\| (TARGET_OS_OSX && __MAC_OS_X_VERSION_MIN_REQUIRED < __MAC_10_13)
	42	# define TZDIR "/usr/share/zoneinfo"
	43	# else
	44	# define TZDIR "/var/db/timezone/zoneinfo"
	45	# endif
	46	#endif
	47
	48	/* No gurantee is made that the TZDEFAULT symlink will have TZDIR as a prefix.
	49	* However, clients can assume that the final path component of the prefix will
	50	* be "zoneinfo"
	51	*/
5b2abdfb	52	#ifndef TZDEFAULT
b061a43b A	53	# if TARGET_OS_SIMULATOR \|\| TARGET_OS_OSX
	54	# define TZDEFAULT "/etc/localtime"
	55	# else
	56	# define TZDEFAULT "/var/db/timezone/localtime"
	57	# endif
	58	#endif
5b2abdfb A	59
	60	#ifndef TZDEFRULES
	61	#define TZDEFRULES "posixrules"
	62	#endif /* !defined TZDEFRULES */
	63
	64	/*
	65	** Each file begins with. . .
	66	*/
	67
	68	#define TZ_MAGIC "TZif"
	69
	70	struct tzhead {
b061a43b A	71	char tzh_magic[4]; /* TZ_MAGIC */
	72	char tzh_version[1]; /* '\0' or '2' as of 2005 */
	73	char tzh_reserved[15]; /* reserved--must be zero */
5b2abdfb A	74	char tzh_ttisgmtcnt[4]; /* coded number of trans. time flags */
	75	char tzh_ttisstdcnt[4]; /* coded number of trans. time flags */
	76	char tzh_leapcnt[4]; /* coded number of leap seconds */
	77	char tzh_timecnt[4]; /* coded number of transition times */
	78	char tzh_typecnt[4]; /* coded number of local time types */
	79	char tzh_charcnt[4]; /* coded number of abbr. chars */
	80	};
	81
	82	/*
	83	** . . .followed by. . .
	84	**
	85	** tzh_timecnt (char [4])s coded transition times a la time(2)
	86	** tzh_timecnt (unsigned char)s types of local time starting at above
	87	** tzh_typecnt repetitions of
	88	** one (char [4]) coded UTC offset in seconds
	89	** one (unsigned char) used to set tm_isdst
	90	** one (unsigned char) that's an abbreviation list index
	91	** tzh_charcnt (char)s '\0'-terminated zone abbreviations
	92	** tzh_leapcnt repetitions of
	93	** one (char [4]) coded leap second transition times
	94	** one (char [4]) total correction after above
	95	** tzh_ttisstdcnt (char)s indexed by type; if TRUE, transition
	96	** time is standard time, if FALSE,
	97	** transition time is wall clock time
	98	** if absent, transition times are
	99	** assumed to be wall clock time
	100	** tzh_ttisgmtcnt (char)s indexed by type; if TRUE, transition
	101	** time is UTC, if FALSE,
	102	** transition time is local time
	103	** if absent, transition times are
	104	** assumed to be local time
	105	*/
	106
b061a43b A	107	/*
	108	** If tzh_version is '2' or greater, the above is followed by a second instance
	109	** of tzhead and a second instance of the data in which each coded transition
	110	** time uses 8 rather than 4 chars,
	111	** then a POSIX-TZ-environment-variable-style string for use in handling
	112	** instants after the last transition time stored in the file
	113	** (with nothing between the newlines if there is no POSIX representation for
	114	** such instants).
	115	*/
	116
5b2abdfb A	117	/*
	118	** In the current implementation, "tzset()" refuses to deal with files that
	119	** exceed any of the limits below.
	120	*/
	121
	122	#ifndef TZ_MAX_TIMES
b061a43b	123	#define TZ_MAX_TIMES 1200
5b2abdfb A	124	#endif /* !defined TZ_MAX_TIMES */
	125
	126	#ifndef TZ_MAX_TYPES
	127	#ifndef NOSOLAR
	128	#define TZ_MAX_TYPES 256 /* Limited by what (unsigned char)'s can hold */
	129	#endif /* !defined NOSOLAR */
	130	#ifdef NOSOLAR
	131	/*
	132	** Must be at least 14 for Europe/Riga as of Jan 12 1995,
b061a43b	133	** as noted by Earl Chew.
5b2abdfb A	134	*/
	135	#define TZ_MAX_TYPES 20 /* Maximum number of local time types */
	136	#endif /* !defined NOSOLAR */
	137	#endif /* !defined TZ_MAX_TYPES */
	138
	139	#ifndef TZ_MAX_CHARS
	140	#define TZ_MAX_CHARS 50 /* Maximum number of abbreviation characters */
	141	/* (limited by what unsigned chars can hold) */
	142	#endif /* !defined TZ_MAX_CHARS */
	143
	144	#ifndef TZ_MAX_LEAPS
	145	#define TZ_MAX_LEAPS 50 /* Maximum number of leap second corrections */
	146	#endif /* !defined TZ_MAX_LEAPS */
	147
	148	#define SECSPERMIN 60
	149	#define MINSPERHOUR 60
	150	#define HOURSPERDAY 24
	151	#define DAYSPERWEEK 7
	152	#define DAYSPERNYEAR 365
	153	#define DAYSPERLYEAR 366
	154	#define SECSPERHOUR (SECSPERMIN * MINSPERHOUR)
	155	#define SECSPERDAY ((long) SECSPERHOUR * HOURSPERDAY)
	156	#define MONSPERYEAR 12
	157
	158	#define TM_SUNDAY 0
	159	#define TM_MONDAY 1
	160	#define TM_TUESDAY 2
	161	#define TM_WEDNESDAY 3
	162	#define TM_THURSDAY 4
	163	#define TM_FRIDAY 5
	164	#define TM_SATURDAY 6
	165
	166	#define TM_JANUARY 0
	167	#define TM_FEBRUARY 1
	168	#define TM_MARCH 2
	169	#define TM_APRIL 3
	170	#define TM_MAY 4
	171	#define TM_JUNE 5
	172	#define TM_JULY 6
	173	#define TM_AUGUST 7
	174	#define TM_SEPTEMBER 8
	175	#define TM_OCTOBER 9
	176	#define TM_NOVEMBER 10
	177	#define TM_DECEMBER 11
	178
	179	#define TM_YEAR_BASE 1900
	180
	181	#define EPOCH_YEAR 1970
	182	#define EPOCH_WDAY TM_THURSDAY
	183
5b2abdfb A	184	#define isleap(y) (((y) % 4) == 0 && (((y) % 100) != 0 \|\| ((y) % 400) == 0))
5b2abdfb A	185
ad3c9f2a A	186	/*
	187	** Since everything in isleap is modulo 400 (or a factor of 400), we know that
	188	** isleap(y) == isleap(y % 400)
	189	** and so
	190	** isleap(a + b) == isleap((a + b) % 400)
	191	** or
	192	** isleap(a + b) == isleap(a % 400 + b % 400)
	193	** This is true even if % means modulo rather than Fortran remainder
	194	** (which is allowed by C89 but not C99).
	195	** We use this to avoid addition overflow problems.
	196	*/
	197
	198	#define isleap_sum(a, b) isleap((a) % 400 + (b) % 400)
	199
5b2abdfb	200	#endif /* !defined TZFILE_H */