[apple/icu.git] / icuSources / tools / tzcode / private.h

#ifndef PRIVATE_H

#define PRIVATE_H

/*
** This file is in the public domain, so clarified as of
** 1996-06-05 by Arthur David Olson.
*/

/*
** 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	privatehid[] = "@(#)private.h	8.6";
#endif /* !defined NOID */
#endif /* !defined lint */

#define GRANDPARENTED	"Local time zone must be set--see zic manual page"

/*
** Defaults for preprocessor symbols.
** You can override these in your C compiler options, e.g. `-DHAVE_ADJTIME=0'.
*/

#ifndef HAVE_ADJTIME
#define HAVE_ADJTIME		1
#endif /* !defined HAVE_ADJTIME */

#ifndef HAVE_GETTEXT
#define HAVE_GETTEXT		0
#endif /* !defined HAVE_GETTEXT */

#ifndef HAVE_INCOMPATIBLE_CTIME_R
#define HAVE_INCOMPATIBLE_CTIME_R	0
#endif /* !defined INCOMPATIBLE_CTIME_R */

#ifndef HAVE_SETTIMEOFDAY
#define HAVE_SETTIMEOFDAY	3
#endif /* !defined HAVE_SETTIMEOFDAY */

#ifndef HAVE_SYMLINK
#define HAVE_SYMLINK		1
#endif /* !defined HAVE_SYMLINK */

#ifndef HAVE_SYS_STAT_H
#define HAVE_SYS_STAT_H		1
#endif /* !defined HAVE_SYS_STAT_H */

#ifndef HAVE_SYS_WAIT_H
#define HAVE_SYS_WAIT_H		1
#endif /* !defined HAVE_SYS_WAIT_H */

#ifndef HAVE_UNISTD_H
#define HAVE_UNISTD_H		1
#endif /* !defined HAVE_UNISTD_H */

#ifndef HAVE_UTMPX_H
#define HAVE_UTMPX_H		0
#endif /* !defined HAVE_UTMPX_H */

#ifndef LOCALE_HOME
#define LOCALE_HOME		"/usr/lib/locale"
#endif /* !defined LOCALE_HOME */

#if HAVE_INCOMPATIBLE_CTIME_R
#define asctime_r _incompatible_asctime_r
#define ctime_r _incompatible_ctime_r
#endif /* HAVE_INCOMPATIBLE_CTIME_R */

/*
** Nested includes
*/

#include "sys/types.h"	/* for time_t */
#include "stdio.h"
#include "errno.h"
#include "string.h"
#include "limits.h"	/* for CHAR_BIT et al. */
#include "time.h"
#include "stdlib.h"

#if HAVE_GETTEXT
#include "libintl.h"
#endif /* HAVE_GETTEXT */

#if HAVE_SYS_WAIT_H
#include <sys/wait.h>	/* for WIFEXITED and WEXITSTATUS */
#endif /* HAVE_SYS_WAIT_H */

#ifndef WIFEXITED
#define WIFEXITED(status)	(((status) & 0xff) == 0)
#endif /* !defined WIFEXITED */
#ifndef WEXITSTATUS
#define WEXITSTATUS(status)	(((status) >> 8) & 0xff)
#endif /* !defined WEXITSTATUS */

#if HAVE_UNISTD_H
#include "unistd.h"	/* for F_OK, R_OK, and other POSIX goodness */
#endif /* HAVE_UNISTD_H */

#ifndef F_OK
#define F_OK	0
#endif /* !defined F_OK */
#ifndef R_OK
#define R_OK	4
#endif /* !defined R_OK */

/* Unlike <ctype.h>'s isdigit, this also works if c < 0 | c > UCHAR_MAX. */
#define is_digit(c) ((unsigned)(c) - '0' <= 9)

/*
** Define HAVE_STDINT_H's default value here, rather than at the
** start, since __GLIBC__'s value depends on previously-included
** files.
** (glibc 2.1 and later have stdint.h, even with pre-C99 compilers.)
*/
#ifndef HAVE_STDINT_H
#define HAVE_STDINT_H \
	(199901 <= __STDC_VERSION__ || \
	2 < (__GLIBC__ + (0 < __GLIBC_MINOR__)))
#endif /* !defined HAVE_STDINT_H */

#if HAVE_STDINT_H
#include "stdint.h"
#endif /* !HAVE_STDINT_H */

#ifndef INT_FAST64_MAX
/* Pre-C99 GCC compilers define __LONG_LONG_MAX__ instead of LLONG_MAX.  */
#if defined LLONG_MAX || defined __LONG_LONG_MAX__
typedef long long	int_fast64_t;
#else /* ! (defined LLONG_MAX || defined __LONG_LONG_MAX__) */
#if (LONG_MAX >> 31) < 0xffffffff
Please use a compiler that supports a 64-bit integer type (or wider);
you may need to compile with "-DHAVE_STDINT_H".
#endif /* (LONG_MAX >> 31) < 0xffffffff */
typedef long		int_fast64_t;
#endif /* ! (defined LLONG_MAX || defined __LONG_LONG_MAX__) */
#endif /* !defined INT_FAST64_MAX */

#ifndef INT32_MAX
#define INT32_MAX 0x7fffffff
#endif /* !defined INT32_MAX */
#ifndef INT32_MIN
#define INT32_MIN (-1 - INT32_MAX)
#endif /* !defined INT32_MIN */

/*
** Workarounds for compilers/systems.
*/

/*
** Some time.h implementations don't declare asctime_r.
** Others might define it as a macro.
** Fix the former without affecting the latter.
*/

#ifndef asctime_r
extern char *	asctime_r(struct tm const *, char *);
#endif

/*
** Private function declarations.
*/

char *		icalloc(int nelem, int elsize);
char *		icatalloc(char * old, const char * new);
char *		icpyalloc(const char * string);
char *		imalloc(int n);
void *		irealloc(void * pointer, int size);
void		icfree(char * pointer);
void		ifree(char * pointer);
const char *	scheck(const char * string, const char * format);

/*
** Finally, some convenience items.
*/

#ifndef TRUE
#define TRUE	1
#endif /* !defined TRUE */

#ifndef FALSE
#define FALSE	0
#endif /* !defined FALSE */

#ifndef TYPE_BIT
#define TYPE_BIT(type)	(sizeof (type) * CHAR_BIT)
#endif /* !defined TYPE_BIT */

#ifndef TYPE_SIGNED
#define TYPE_SIGNED(type) (((type) -1) < 0)
#endif /* !defined TYPE_SIGNED */

/*
** Since the definition of TYPE_INTEGRAL contains floating point numbers,
** it cannot be used in preprocessor directives.
*/

#ifndef TYPE_INTEGRAL
#define TYPE_INTEGRAL(type) (((type) 0.5) != 0.5)
#endif /* !defined TYPE_INTEGRAL */

#ifndef INT_STRLEN_MAXIMUM
/*
** 302 / 1000 is log10(2.0) rounded up.
** Subtract one for the sign bit if the type is signed;
** add one for integer division truncation;
** add one more for a minus sign if the type is signed.
*/
#define INT_STRLEN_MAXIMUM(type) \
	((TYPE_BIT(type) - TYPE_SIGNED(type)) * 302 / 1000 + \
	1 + TYPE_SIGNED(type))
#endif /* !defined INT_STRLEN_MAXIMUM */

/*
** INITIALIZE(x)
*/

#ifndef GNUC_or_lint
#ifdef lint
#define GNUC_or_lint
#endif /* defined lint */
#ifndef lint
#ifdef __GNUC__
#define GNUC_or_lint
#endif /* defined __GNUC__ */
#endif /* !defined lint */
#endif /* !defined GNUC_or_lint */

#ifndef INITIALIZE
#ifdef GNUC_or_lint
#define INITIALIZE(x)	((x) = 0)
#endif /* defined GNUC_or_lint */
#ifndef GNUC_or_lint
#define INITIALIZE(x)
#endif /* !defined GNUC_or_lint */
#endif /* !defined INITIALIZE */

/*
** For the benefit of GNU folk...
** `_(MSGID)' uses the current locale's message library string for MSGID.
** The default is to use gettext if available, and use MSGID otherwise.
*/

#ifndef _
#if HAVE_GETTEXT
#define _(msgid) gettext(msgid)
#else /* !HAVE_GETTEXT */
#define _(msgid) msgid
#endif /* !HAVE_GETTEXT */
#endif /* !defined _ */

#ifndef TZ_DOMAIN
#define TZ_DOMAIN "tz"
#endif /* !defined TZ_DOMAIN */

#if HAVE_INCOMPATIBLE_CTIME_R
#undef asctime_r
#undef ctime_r
char *asctime_r(struct tm const *, char *);
char *ctime_r(time_t const *, char *);
#endif /* HAVE_INCOMPATIBLE_CTIME_R */

#ifndef YEARSPERREPEAT
#define YEARSPERREPEAT		400	/* years before a Gregorian repeat */
#endif /* !defined YEARSPERREPEAT */

/*
** The Gregorian year averages 365.2425 days, which is 31556952 seconds.
*/

#ifndef AVGSECSPERYEAR
#define AVGSECSPERYEAR		31556952L
#endif /* !defined AVGSECSPERYEAR */

#ifndef SECSPERREPEAT
#define SECSPERREPEAT		((int_fast64_t) YEARSPERREPEAT * (int_fast64_t) AVGSECSPERYEAR)
#endif /* !defined SECSPERREPEAT */

#ifndef SECSPERREPEAT_BITS
#define SECSPERREPEAT_BITS	34	/* ceil(log2(SECSPERREPEAT)) */
#endif /* !defined SECSPERREPEAT_BITS */

/*
** UNIX was a registered trademark of The Open Group in 2003.
*/

#endif /* !defined PRIVATE_H */
Commit	Line	Data
73c04bcf A	1	#ifndef PRIVATE_H
	2
	3	#define PRIVATE_H
	4
	5	/*
	6	** This file is in the public domain, so clarified as of
	7	** 1996-06-05 by Arthur David Olson.
	8	*/
	9
	10	/*
	11	** This header is for use ONLY with the time conversion code.
	12	** There is no guarantee that it will remain unchanged,
	13	** or that it will remain at all.
	14	** Do NOT copy it to any system include directory.
	15	** Thank you!
	16	*/
	17
	18	/*
	19	** ID
	20	*/
	21
	22	#ifndef lint
	23	#ifndef NOID
fd0068a8	24	static char privatehid[] = "@(#)private.h 8.6";
73c04bcf A	25	#endif /* !defined NOID */
	26	#endif /* !defined lint */
	27
	28	#define GRANDPARENTED "Local time zone must be set--see zic manual page"
	29
	30	/*
	31	** Defaults for preprocessor symbols.
	32	** You can override these in your C compiler options, e.g. `-DHAVE_ADJTIME=0'.
	33	*/
	34
	35	#ifndef HAVE_ADJTIME
	36	#define HAVE_ADJTIME 1
	37	#endif /* !defined HAVE_ADJTIME */
	38
	39	#ifndef HAVE_GETTEXT
	40	#define HAVE_GETTEXT 0
	41	#endif /* !defined HAVE_GETTEXT */
	42
	43	#ifndef HAVE_INCOMPATIBLE_CTIME_R
	44	#define HAVE_INCOMPATIBLE_CTIME_R 0
	45	#endif /* !defined INCOMPATIBLE_CTIME_R */
	46
	47	#ifndef HAVE_SETTIMEOFDAY
	48	#define HAVE_SETTIMEOFDAY 3
	49	#endif /* !defined HAVE_SETTIMEOFDAY */
	50
73c04bcf A	51	#ifndef HAVE_SYMLINK
	52	#define HAVE_SYMLINK 1
	53	#endif /* !defined HAVE_SYMLINK */
	54
	55	#ifndef HAVE_SYS_STAT_H
	56	#define HAVE_SYS_STAT_H 1
	57	#endif /* !defined HAVE_SYS_STAT_H */
	58
	59	#ifndef HAVE_SYS_WAIT_H
	60	#define HAVE_SYS_WAIT_H 1
	61	#endif /* !defined HAVE_SYS_WAIT_H */
	62
	63	#ifndef HAVE_UNISTD_H
	64	#define HAVE_UNISTD_H 1
	65	#endif /* !defined HAVE_UNISTD_H */
	66
	67	#ifndef HAVE_UTMPX_H
	68	#define HAVE_UTMPX_H 0
	69	#endif /* !defined HAVE_UTMPX_H */
	70
	71	#ifndef LOCALE_HOME
	72	#define LOCALE_HOME "/usr/lib/locale"
	73	#endif /* !defined LOCALE_HOME */
	74
	75	#if HAVE_INCOMPATIBLE_CTIME_R
	76	#define asctime_r _incompatible_asctime_r
	77	#define ctime_r _incompatible_ctime_r
	78	#endif /* HAVE_INCOMPATIBLE_CTIME_R */
	79
	80	/*
	81	** Nested includes
	82	*/
	83
	84	#include "sys/types.h" /* for time_t */
	85	#include "stdio.h"
	86	#include "errno.h"
	87	#include "string.h"
	88	#include "limits.h" /* for CHAR_BIT et al. */
	89	#include "time.h"
	90	#include "stdlib.h"
	91
	92	#if HAVE_GETTEXT
	93	#include "libintl.h"
	94	#endif /* HAVE_GETTEXT */
	95
	96	#if HAVE_SYS_WAIT_H
	97	#include <sys/wait.h> /* for WIFEXITED and WEXITSTATUS */
	98	#endif /* HAVE_SYS_WAIT_H */
	99
	100	#ifndef WIFEXITED
	101	#define WIFEXITED(status) (((status) & 0xff) == 0)
	102	#endif /* !defined WIFEXITED */
	103	#ifndef WEXITSTATUS
	104	#define WEXITSTATUS(status) (((status) >> 8) & 0xff)
	105	#endif /* !defined WEXITSTATUS */
	106
	107	#if HAVE_UNISTD_H
fd0068a8	108	#include "unistd.h" /* for F_OK, R_OK, and other POSIX goodness */
73c04bcf A	109	#endif /* HAVE_UNISTD_H */
73c04bcf A	110
73c04bcf A	111	#ifndef F_OK
	112	#define F_OK 0
	113	#endif /* !defined F_OK */
	114	#ifndef R_OK
	115	#define R_OK 4
	116	#endif /* !defined R_OK */
73c04bcf A	117
	118	/* Unlike <ctype.h>'s isdigit, this also works if c < 0 \| c > UCHAR_MAX. */
	119	#define is_digit(c) ((unsigned)(c) - '0' <= 9)
	120
	121	/*
	122	** Define HAVE_STDINT_H's default value here, rather than at the
	123	** start, since __GLIBC__'s value depends on previously-included
	124	** files.
	125	** (glibc 2.1 and later have stdint.h, even with pre-C99 compilers.)
	126	*/
	127	#ifndef HAVE_STDINT_H
	128	#define HAVE_STDINT_H \
	129	(199901 <= __STDC_VERSION__ \|\| \
	130	2 < (__GLIBC__ + (0 < __GLIBC_MINOR__)))
	131	#endif /* !defined HAVE_STDINT_H */
	132
	133	#if HAVE_STDINT_H
	134	#include "stdint.h"
	135	#endif /* !HAVE_STDINT_H */
	136
	137	#ifndef INT_FAST64_MAX
	138	/* Pre-C99 GCC compilers define __LONG_LONG_MAX__ instead of LLONG_MAX. */
	139	#if defined LLONG_MAX \|\| defined __LONG_LONG_MAX__
	140	typedef long long int_fast64_t;
	141	#else /* ! (defined LLONG_MAX \|\| defined __LONG_LONG_MAX__) */
	142	#if (LONG_MAX >> 31) < 0xffffffff
	143	Please use a compiler that supports a 64-bit integer type (or wider);
	144	you may need to compile with "-DHAVE_STDINT_H".
	145	#endif /* (LONG_MAX >> 31) < 0xffffffff */
	146	typedef long int_fast64_t;
	147	#endif /* ! (defined LLONG_MAX \|\| defined __LONG_LONG_MAX__) */
	148	#endif /* !defined INT_FAST64_MAX */
	149
	150	#ifndef INT32_MAX
	151	#define INT32_MAX 0x7fffffff
	152	#endif /* !defined INT32_MAX */
	153	#ifndef INT32_MIN
	154	#define INT32_MIN (-1 - INT32_MAX)
	155	#endif /* !defined INT32_MIN */
	156
	157	/*
	158	** Workarounds for compilers/systems.
	159	*/
	160
73c04bcf A	161	/*
	162	** Some time.h implementations don't declare asctime_r.
	163	** Others might define it as a macro.
	164	** Fix the former without affecting the latter.
	165	*/
	166
	167	#ifndef asctime_r
fd0068a8	168	extern char * asctime_r(struct tm const , char );
73c04bcf A	169	#endif
	170
	171	/*
	172	** Private function declarations.
	173	*/
	174
fd0068a8 A	175	char * icalloc(int nelem, int elsize);
	176	char * icatalloc(char * old, const char * new);
	177	char * icpyalloc(const char * string);
	178	char * imalloc(int n);
	179	void * irealloc(void * pointer, int size);
	180	void icfree(char * pointer);
	181	void ifree(char * pointer);
	182	const char * scheck(const char * string, const char * format);
73c04bcf A	183
	184	/*
	185	** Finally, some convenience items.
	186	*/
	187
	188	#ifndef TRUE
	189	#define TRUE 1
	190	#endif /* !defined TRUE */
	191
	192	#ifndef FALSE
	193	#define FALSE 0
	194	#endif /* !defined FALSE */
	195
	196	#ifndef TYPE_BIT
	197	#define TYPE_BIT(type) (sizeof (type) * CHAR_BIT)
	198	#endif /* !defined TYPE_BIT */
	199
	200	#ifndef TYPE_SIGNED
	201	#define TYPE_SIGNED(type) (((type) -1) < 0)
	202	#endif /* !defined TYPE_SIGNED */
	203
	204	/*
	205	** Since the definition of TYPE_INTEGRAL contains floating point numbers,
	206	** it cannot be used in preprocessor directives.
	207	*/
	208
	209	#ifndef TYPE_INTEGRAL
	210	#define TYPE_INTEGRAL(type) (((type) 0.5) != 0.5)
	211	#endif /* !defined TYPE_INTEGRAL */
	212
	213	#ifndef INT_STRLEN_MAXIMUM
	214	/*
	215	** 302 / 1000 is log10(2.0) rounded up.
	216	** Subtract one for the sign bit if the type is signed;
	217	** add one for integer division truncation;
	218	** add one more for a minus sign if the type is signed.
	219	*/
	220	#define INT_STRLEN_MAXIMUM(type) \
	221	((TYPE_BIT(type) - TYPE_SIGNED(type)) * 302 / 1000 + \
	222	1 + TYPE_SIGNED(type))
	223	#endif /* !defined INT_STRLEN_MAXIMUM */
	224
	225	/*
	226	** INITIALIZE(x)
	227	*/
	228
	229	#ifndef GNUC_or_lint
	230	#ifdef lint
	231	#define GNUC_or_lint
	232	#endif /* defined lint */
	233	#ifndef lint
	234	#ifdef __GNUC__
	235	#define GNUC_or_lint
	236	#endif /* defined __GNUC__ */
	237	#endif /* !defined lint */
	238	#endif /* !defined GNUC_or_lint */
	239
	240	#ifndef INITIALIZE
	241	#ifdef GNUC_or_lint
	242	#define INITIALIZE(x) ((x) = 0)
	243	#endif /* defined GNUC_or_lint */
	244	#ifndef GNUC_or_lint
	245	#define INITIALIZE(x)
	246	#endif /* !defined GNUC_or_lint */
247	#endif /* !defined INITIALIZE */
248
249	/*
250	** For the benefit of GNU folk...
251	** `_(MSGID)' uses the current locale's message library string for MSGID.
252	** The default is to use gettext if available, and use MSGID otherwise.
253	*/
254
255	#ifndef _
256	#if HAVE_GETTEXT
257	#define _(msgid) gettext(msgid)
258	#else /* !HAVE_GETTEXT */
259	#define _(msgid) msgid
260	#endif /* !HAVE_GETTEXT */
261	#endif /* !defined _ */
262
263	#ifndef TZ_DOMAIN
264	#define TZ_DOMAIN "tz"
265	#endif /* !defined TZ_DOMAIN */
266
267	#if HAVE_INCOMPATIBLE_CTIME_R
268	#undef asctime_r
269	#undef ctime_r
fd0068a8 A	270	char asctime_r(struct tm const , char *);
fd0068a8 A	271	char ctime_r(time_t const , char *);
73c04bcf A	272	#endif /* HAVE_INCOMPATIBLE_CTIME_R */
	273
	274	#ifndef YEARSPERREPEAT
	275	#define YEARSPERREPEAT 400 /* years before a Gregorian repeat */
	276	#endif /* !defined YEARSPERREPEAT */
	277
	278	/*
	279	** The Gregorian year averages 365.2425 days, which is 31556952 seconds.
	280	*/
	281
	282	#ifndef AVGSECSPERYEAR
	283	#define AVGSECSPERYEAR 31556952L
	284	#endif /* !defined AVGSECSPERYEAR */
	285
	286	#ifndef SECSPERREPEAT
	287	#define SECSPERREPEAT ((int_fast64_t) YEARSPERREPEAT * (int_fast64_t) AVGSECSPERYEAR)
	288	#endif /* !defined SECSPERREPEAT */
fd0068a8	289
73c04bcf A	290	#ifndef SECSPERREPEAT_BITS
	291	#define SECSPERREPEAT_BITS 34 /* ceil(log2(SECSPERREPEAT)) */
	292	#endif /* !defined SECSPERREPEAT_BITS */
	293
	294	/*
	295	** UNIX was a registered trademark of The Open Group in 2003.
	296	*/
	297
	298	#endif /* !defined PRIVATE_H */