blob: a31a26e169705ea4111abcd2c7b8b63a55bd9ad0 [file] [log] [blame]
The Android Open Source Project1dc9e472009-03-03 19:28:35 -08001#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
Elliott Hughesce4783c2013-07-12 17:31:11 -070018#define GRANDPARENTED "Local time zone must be set--see zic manual page"
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080019
20/*
21** Defaults for preprocessor symbols.
22** You can override these in your C compiler options, e.g. `-DHAVE_ADJTIME=0'.
23*/
24
25#ifndef HAVE_ADJTIME
Elliott Hughesce4783c2013-07-12 17:31:11 -070026#define HAVE_ADJTIME 1
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080027#endif /* !defined HAVE_ADJTIME */
28
29#ifndef HAVE_GETTEXT
Elliott Hughesce4783c2013-07-12 17:31:11 -070030#define HAVE_GETTEXT 0
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080031#endif /* !defined HAVE_GETTEXT */
32
33#ifndef HAVE_INCOMPATIBLE_CTIME_R
Elliott Hughesce4783c2013-07-12 17:31:11 -070034#define HAVE_INCOMPATIBLE_CTIME_R 0
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080035#endif /* !defined INCOMPATIBLE_CTIME_R */
36
37#ifndef HAVE_SETTIMEOFDAY
Elliott Hughesce4783c2013-07-12 17:31:11 -070038#define HAVE_SETTIMEOFDAY 3
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080039#endif /* !defined HAVE_SETTIMEOFDAY */
40
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080041#ifndef HAVE_SYMLINK
Elliott Hughesce4783c2013-07-12 17:31:11 -070042#define HAVE_SYMLINK 1
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080043#endif /* !defined HAVE_SYMLINK */
44
45#ifndef HAVE_SYS_STAT_H
Elliott Hughesce4783c2013-07-12 17:31:11 -070046#define HAVE_SYS_STAT_H 1
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080047#endif /* !defined HAVE_SYS_STAT_H */
48
49#ifndef HAVE_SYS_WAIT_H
Elliott Hughesce4783c2013-07-12 17:31:11 -070050#define HAVE_SYS_WAIT_H 1
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080051#endif /* !defined HAVE_SYS_WAIT_H */
52
53#ifndef HAVE_UNISTD_H
Elliott Hughesce4783c2013-07-12 17:31:11 -070054#define HAVE_UNISTD_H 1
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080055#endif /* !defined HAVE_UNISTD_H */
56
57#ifndef HAVE_UTMPX_H
Elliott Hughesce4783c2013-07-12 17:31:11 -070058#define HAVE_UTMPX_H 0
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080059#endif /* !defined HAVE_UTMPX_H */
60
Elliott Hughesce4783c2013-07-12 17:31:11 -070061#ifndef LOCALE_HOME
62#define LOCALE_HOME "/usr/lib/locale"
63#endif /* !defined LOCALE_HOME */
64
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080065#if HAVE_INCOMPATIBLE_CTIME_R
66#define asctime_r _incompatible_asctime_r
67#define ctime_r _incompatible_ctime_r
68#endif /* HAVE_INCOMPATIBLE_CTIME_R */
69
70/*
71** Nested includes
72*/
73
Elliott Hughesce4783c2013-07-12 17:31:11 -070074#include "sys/types.h" /* for time_t */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080075#include "stdio.h"
76#include "errno.h"
77#include "string.h"
Elliott Hughesce4783c2013-07-12 17:31:11 -070078#include "limits.h" /* for CHAR_BIT et al. */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080079#include "time.h"
80#include "stdlib.h"
81
82#if HAVE_GETTEXT
83#include "libintl.h"
84#endif /* HAVE_GETTEXT */
85
86#if HAVE_SYS_WAIT_H
Elliott Hughesce4783c2013-07-12 17:31:11 -070087#include <sys/wait.h> /* for WIFEXITED and WEXITSTATUS */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080088#endif /* HAVE_SYS_WAIT_H */
89
90#ifndef WIFEXITED
Elliott Hughesce4783c2013-07-12 17:31:11 -070091#define WIFEXITED(status) (((status) & 0xff) == 0)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080092#endif /* !defined WIFEXITED */
93#ifndef WEXITSTATUS
Elliott Hughesce4783c2013-07-12 17:31:11 -070094#define WEXITSTATUS(status) (((status) >> 8) & 0xff)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080095#endif /* !defined WEXITSTATUS */
96
97#if HAVE_UNISTD_H
Elliott Hughesce4783c2013-07-12 17:31:11 -070098#include "unistd.h" /* for F_OK, R_OK, and other POSIX goodness */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080099#endif /* HAVE_UNISTD_H */
100
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800101#ifndef F_OK
Elliott Hughesce4783c2013-07-12 17:31:11 -0700102#define F_OK 0
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800103#endif /* !defined F_OK */
104#ifndef R_OK
Elliott Hughesce4783c2013-07-12 17:31:11 -0700105#define R_OK 4
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800106#endif /* !defined R_OK */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800107
108/* Unlike <ctype.h>'s isdigit, this also works if c < 0 | c > UCHAR_MAX. */
109#define is_digit(c) ((unsigned)(c) - '0' <= 9)
110
111/*
112** Define HAVE_STDINT_H's default value here, rather than at the
113** start, since __GLIBC__'s value depends on previously-included
114** files.
115** (glibc 2.1 and later have stdint.h, even with pre-C99 compilers.)
116*/
117#ifndef HAVE_STDINT_H
118#define HAVE_STDINT_H \
Elliott Hughesce4783c2013-07-12 17:31:11 -0700119 (199901 <= __STDC_VERSION__ || \
120 2 < (__GLIBC__ + (0 < __GLIBC_MINOR__)))
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800121#endif /* !defined HAVE_STDINT_H */
122
123#if HAVE_STDINT_H
124#include "stdint.h"
125#endif /* !HAVE_STDINT_H */
126
Elliott Hughesce4783c2013-07-12 17:31:11 -0700127#ifndef HAVE_INTTYPES_H
128# define HAVE_INTTYPES_H HAVE_STDINT_H
129#endif
130#if HAVE_INTTYPES_H
131# include <inttypes.h>
132#endif
133
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800134#ifndef INT_FAST64_MAX
135/* Pre-C99 GCC compilers define __LONG_LONG_MAX__ instead of LLONG_MAX. */
136#if defined LLONG_MAX || defined __LONG_LONG_MAX__
Elliott Hughesce4783c2013-07-12 17:31:11 -0700137typedef long long int_fast64_t;
138# ifdef LLONG_MAX
139# define INT_FAST64_MIN LLONG_MIN
140# define INT_FAST64_MAX LLONG_MAX
141# else
142# define INT_FAST64_MIN __LONG_LONG_MIN__
143# define INT_FAST64_MAX __LONG_LONG_MAX__
144# endif
145# define SCNdFAST64 "lld"
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800146#else /* ! (defined LLONG_MAX || defined __LONG_LONG_MAX__) */
147#if (LONG_MAX >> 31) < 0xffffffff
148Please use a compiler that supports a 64-bit integer type (or wider);
149you may need to compile with "-DHAVE_STDINT_H".
150#endif /* (LONG_MAX >> 31) < 0xffffffff */
Elliott Hughesce4783c2013-07-12 17:31:11 -0700151typedef long int_fast64_t;
152# define INT_FAST64_MIN LONG_MIN
153# define INT_FAST64_MAX LONG_MAX
154# define SCNdFAST64 "ld"
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800155#endif /* ! (defined LLONG_MAX || defined __LONG_LONG_MAX__) */
156#endif /* !defined INT_FAST64_MAX */
157
Elliott Hughesce4783c2013-07-12 17:31:11 -0700158#ifndef INT_FAST32_MAX
159# if INT_MAX >> 31 == 0
160typedef long int_fast32_t;
161# else
162typedef int int_fast32_t;
163# endif
164#endif
165
166#ifndef INTMAX_MAX
167# if defined LLONG_MAX || defined __LONG_LONG_MAX__
168typedef long long intmax_t;
169# define PRIdMAX "lld"
170# else
171typedef long intmax_t;
172# define PRIdMAX "ld"
173# endif
174#endif
175
176#ifndef UINTMAX_MAX
177# if defined ULLONG_MAX || defined __LONG_LONG_MAX__
178typedef unsigned long long uintmax_t;
179# define PRIuMAX "llu"
180# else
181typedef unsigned long uintmax_t;
182# define PRIuMAX "lu"
183# endif
184#endif
185
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800186#ifndef INT32_MAX
187#define INT32_MAX 0x7fffffff
188#endif /* !defined INT32_MAX */
189#ifndef INT32_MIN
190#define INT32_MIN (-1 - INT32_MAX)
191#endif /* !defined INT32_MIN */
192
Elliott Hughesce4783c2013-07-12 17:31:11 -0700193#if 2 < __GNUC__ + (96 <= __GNUC_MINOR__)
194# define ATTRIBUTE_CONST __attribute__ ((const))
195# define ATTRIBUTE_PURE __attribute__ ((__pure__))
196#else
197# define ATTRIBUTE_CONST /* empty */
198# define ATTRIBUTE_PURE /* empty */
199#endif
200
201#if !defined _Noreturn && __STDC_VERSION__ < 201112
202# if 2 < __GNUC__ + (8 <= __GNUC_MINOR__)
203# define _Noreturn __attribute__ ((__noreturn__))
204# else
205# define _Noreturn
206# endif
207#endif
208
209#if __STDC_VERSION__ < 199901 && !defined restrict
210# define restrict /* empty */
211#endif
212
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800213/*
214** Workarounds for compilers/systems.
215*/
216
217/*
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800218** Some time.h implementations don't declare asctime_r.
219** Others might define it as a macro.
220** Fix the former without affecting the latter.
221*/
222
223#ifndef asctime_r
Elliott Hughesce4783c2013-07-12 17:31:11 -0700224extern char * asctime_r(struct tm const *, char *);
225#endif
226
227/*
228** Compile with -Dtime_tz=T to build the tz package with a private
229** time_t type equivalent to T rather than the system-supplied time_t.
230** This debugging feature can test unusual design decisions
231** (e.g., time_t wider than 'long', or unsigned time_t) even on
232** typical platforms.
233*/
234#ifdef time_tz
235static time_t sys_time(time_t *x) { return time(x); }
236
237# undef ctime
238# define ctime tz_ctime
239# undef ctime_r
240# define ctime_r tz_ctime_r
241# undef difftime
242# define difftime tz_difftime
243# undef gmtime
244# define gmtime tz_gmtime
245# undef gmtime_r
246# define gmtime_r tz_gmtime_r
247# undef localtime
248# define localtime tz_localtime
249# undef localtime_r
250# define localtime_r tz_localtime_r
251# undef mktime
252# define mktime tz_mktime
253# undef time
254# define time tz_time
255# undef time_t
256# define time_t tz_time_t
257
258typedef time_tz time_t;
259
260char *ctime(time_t const *);
261char *ctime_r(time_t const *, char *);
262double difftime(time_t, time_t);
263struct tm *gmtime(time_t const *);
264struct tm *gmtime_r(time_t const *restrict, struct tm *restrict);
265struct tm *localtime(time_t const *);
266struct tm *localtime_r(time_t const *restrict, struct tm *restrict);
267time_t mktime(struct tm *);
268
269static time_t
270time(time_t *p)
271{
272 time_t r = sys_time(0);
273 if (p)
274 *p = r;
275 return r;
276}
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800277#endif
278
279/*
280** Private function declarations.
281*/
282
Elliott Hughesce4783c2013-07-12 17:31:11 -0700283char * icatalloc(char * old, const char * new);
284char * icpyalloc(const char * string);
285const char * scheck(const char * string, const char * format);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800286
287/*
288** Finally, some convenience items.
289*/
290
291#ifndef TRUE
Elliott Hughesce4783c2013-07-12 17:31:11 -0700292#define TRUE 1
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800293#endif /* !defined TRUE */
294
295#ifndef FALSE
Elliott Hughesce4783c2013-07-12 17:31:11 -0700296#define FALSE 0
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800297#endif /* !defined FALSE */
298
299#ifndef TYPE_BIT
Elliott Hughesce4783c2013-07-12 17:31:11 -0700300#define TYPE_BIT(type) (sizeof (type) * CHAR_BIT)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800301#endif /* !defined TYPE_BIT */
302
303#ifndef TYPE_SIGNED
304#define TYPE_SIGNED(type) (((type) -1) < 0)
305#endif /* !defined TYPE_SIGNED */
306
307/*
308** Since the definition of TYPE_INTEGRAL contains floating point numbers,
309** it cannot be used in preprocessor directives.
310*/
311
312#ifndef TYPE_INTEGRAL
313#define TYPE_INTEGRAL(type) (((type) 0.5) != 0.5)
314#endif /* !defined TYPE_INTEGRAL */
315
316#ifndef INT_STRLEN_MAXIMUM
317/*
318** 302 / 1000 is log10(2.0) rounded up.
319** Subtract one for the sign bit if the type is signed;
320** add one for integer division truncation;
321** add one more for a minus sign if the type is signed.
322*/
323#define INT_STRLEN_MAXIMUM(type) \
Elliott Hughesce4783c2013-07-12 17:31:11 -0700324 ((TYPE_BIT(type) - TYPE_SIGNED(type)) * 302 / 1000 + \
325 1 + TYPE_SIGNED(type))
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800326#endif /* !defined INT_STRLEN_MAXIMUM */
327
328/*
329** INITIALIZE(x)
330*/
331
332#ifndef GNUC_or_lint
333#ifdef lint
334#define GNUC_or_lint
335#endif /* defined lint */
336#ifndef lint
337#ifdef __GNUC__
338#define GNUC_or_lint
339#endif /* defined __GNUC__ */
340#endif /* !defined lint */
341#endif /* !defined GNUC_or_lint */
342
343#ifndef INITIALIZE
344#ifdef GNUC_or_lint
Elliott Hughesce4783c2013-07-12 17:31:11 -0700345#define INITIALIZE(x) ((x) = 0)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800346#endif /* defined GNUC_or_lint */
347#ifndef GNUC_or_lint
348#define INITIALIZE(x)
349#endif /* !defined GNUC_or_lint */
350#endif /* !defined INITIALIZE */
351
352/*
353** For the benefit of GNU folk...
354** `_(MSGID)' uses the current locale's message library string for MSGID.
355** The default is to use gettext if available, and use MSGID otherwise.
356*/
357
358#ifndef _
359#if HAVE_GETTEXT
360#define _(msgid) gettext(msgid)
361#else /* !HAVE_GETTEXT */
362#define _(msgid) msgid
363#endif /* !HAVE_GETTEXT */
364#endif /* !defined _ */
365
366#ifndef TZ_DOMAIN
367#define TZ_DOMAIN "tz"
368#endif /* !defined TZ_DOMAIN */
369
370#if HAVE_INCOMPATIBLE_CTIME_R
371#undef asctime_r
372#undef ctime_r
Elliott Hughesce4783c2013-07-12 17:31:11 -0700373char *asctime_r(struct tm const *, char *);
374char *ctime_r(time_t const *, char *);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800375#endif /* HAVE_INCOMPATIBLE_CTIME_R */
376
377#ifndef YEARSPERREPEAT
Elliott Hughesce4783c2013-07-12 17:31:11 -0700378#define YEARSPERREPEAT 400 /* years before a Gregorian repeat */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800379#endif /* !defined YEARSPERREPEAT */
380
381/*
382** The Gregorian year averages 365.2425 days, which is 31556952 seconds.
383*/
384
385#ifndef AVGSECSPERYEAR
Elliott Hughesce4783c2013-07-12 17:31:11 -0700386#define AVGSECSPERYEAR 31556952L
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800387#endif /* !defined AVGSECSPERYEAR */
388
389#ifndef SECSPERREPEAT
Elliott Hughesce4783c2013-07-12 17:31:11 -0700390#define SECSPERREPEAT ((int_fast64_t) YEARSPERREPEAT * (int_fast64_t) AVGSECSPERYEAR)
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800391#endif /* !defined SECSPERREPEAT */
Elliott Hughesce4783c2013-07-12 17:31:11 -0700392
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800393#ifndef SECSPERREPEAT_BITS
Elliott Hughesce4783c2013-07-12 17:31:11 -0700394#define SECSPERREPEAT_BITS 34 /* ceil(log2(SECSPERREPEAT)) */
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800395#endif /* !defined SECSPERREPEAT_BITS */
396
397/*
398** UNIX was a registered trademark of The Open Group in 2003.
399*/
400
401#endif /* !defined PRIVATE_H */