1 /* A more-standard <time.h>.
3 Copyright (C) 2007-2010 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software Foundation,
17 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
20 @PRAGMA_SYSTEM_HEADER@
24 /* Don't get in the way of glibc when it includes time.h merely to
25 declare a few standard symbols, rather than to declare all the
26 symbols. Also, Solaris 8 <time.h> eventually includes itself
27 recursively; if that is happening, just include the system <time.h>
28 without adding our own declarations. */
29 #if (defined __need_time_t || defined __need_clock_t \
30 || defined __need_timespec \
31 || defined _GL_TIME_H)
33 # @INCLUDE_NEXT@ @NEXT_TIME_H@
39 # @INCLUDE_NEXT@ @NEXT_TIME_H@
41 /* NetBSD 5.0 mis-defines NULL. */
44 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
46 /* The definition of _GL_ARG_NONNULL is copied here. */
48 /* The definition of _GL_WARN_ON_USE is copied here. */
50 /* Some systems don't define struct timespec (e.g., AIX 4.1, Ultrix 4.3).
51 Or they define it with the wrong member names or define it in <sys/time.h>
52 (e.g., FreeBSD circa 1997). Stock Mingw does not define it, but the
53 pthreads-win32 library defines it in <pthread.h>. */
54 # if ! @TIME_H_DEFINES_STRUCT_TIMESPEC@
55 # if @SYS_TIME_H_DEFINES_STRUCT_TIMESPEC@
56 # include <sys/time.h>
57 # elif @PTHREAD_H_DEFINES_STRUCT_TIMESPEC@
59 /* The pthreads-win32 <pthread.h> also defines a couple of broken macros. */
73 # define timespec rpl_timespec
87 /* Per http://austingroupbugs.net/view.php?id=327, POSIX requires
88 time_t to be an integer type, even though C99 permits floating
89 point. We don't know of any implementation that uses floating
90 point, and it is much easier to write code that doesn't have to
91 worry about that corner case, so we force the issue. */
92 struct __time_t_must_be_integral {
93 unsigned int __floating_time_t_unsupported : (time_t) 1;
96 /* Sleep for at least RQTP seconds unless interrupted, If interrupted,
97 return -1 and store the remaining time into RMTP. See
98 <http://www.opengroup.org/susv3xsh/nanosleep.html>. */
99 # if @GNULIB_NANOSLEEP@
100 # if @REPLACE_NANOSLEEP@
101 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
102 # define nanosleep rpl_nanosleep
104 _GL_FUNCDECL_RPL (nanosleep, int,
105 (struct timespec const *__rqtp, struct timespec *__rmtp)
106 _GL_ARG_NONNULL ((1)));
107 _GL_CXXALIAS_RPL (nanosleep, int,
108 (struct timespec const *__rqtp, struct timespec *__rmtp));
110 # if ! @HAVE_NANOSLEEP@
111 _GL_FUNCDECL_SYS (nanosleep, int,
112 (struct timespec const *__rqtp, struct timespec *__rmtp)
113 _GL_ARG_NONNULL ((1)));
115 _GL_CXXALIAS_SYS (nanosleep, int,
116 (struct timespec const *__rqtp, struct timespec *__rmtp));
118 _GL_CXXALIASWARN (nanosleep);
121 /* Return the 'time_t' representation of TP and normalize TP. */
123 # if @REPLACE_MKTIME@
124 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
125 # define mktime rpl_mktime
127 _GL_FUNCDECL_RPL (mktime, time_t, (struct tm *__tp) _GL_ARG_NONNULL ((1)));
128 _GL_CXXALIAS_RPL (mktime, time_t, (struct tm *__tp));
130 _GL_CXXALIAS_SYS (mktime, time_t, (struct tm *__tp));
132 _GL_CXXALIASWARN (mktime);
135 /* Convert TIMER to RESULT, assuming local time and UTC respectively. See
136 <http://www.opengroup.org/susv3xsh/localtime_r.html> and
137 <http://www.opengroup.org/susv3xsh/gmtime_r.html>. */
139 # if @REPLACE_LOCALTIME_R@
140 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
142 # define localtime_r rpl_localtime_r
144 _GL_FUNCDECL_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
145 struct tm *restrict __result)
146 _GL_ARG_NONNULL ((1, 2)));
147 _GL_CXXALIAS_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
148 struct tm *restrict __result));
150 # if ! @HAVE_LOCALTIME_R@
151 _GL_FUNCDECL_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
152 struct tm *restrict __result)
153 _GL_ARG_NONNULL ((1, 2)));
155 _GL_CXXALIAS_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
156 struct tm *restrict __result));
158 _GL_CXXALIASWARN (localtime_r);
159 # if @REPLACE_LOCALTIME_R@
160 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
162 # define gmtime_r rpl_gmtime_r
164 _GL_FUNCDECL_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
165 struct tm *restrict __result)
166 _GL_ARG_NONNULL ((1, 2)));
167 _GL_CXXALIAS_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
168 struct tm *restrict __result));
170 # if ! @HAVE_LOCALTIME_R@
171 _GL_FUNCDECL_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
172 struct tm *restrict __result)
173 _GL_ARG_NONNULL ((1, 2)));
175 _GL_CXXALIAS_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
176 struct tm *restrict __result));
178 _GL_CXXALIASWARN (gmtime_r);
181 /* Parse BUF as a time stamp, assuming FORMAT specifies its layout, and store
182 the resulting broken-down time into TM. See
183 <http://www.opengroup.org/susv3xsh/strptime.html>. */
184 # if @GNULIB_STRPTIME@
185 # if ! @HAVE_STRPTIME@
186 _GL_FUNCDECL_SYS (strptime, char *, (char const *restrict __buf,
187 char const *restrict __format,
188 struct tm *restrict __tm)
189 _GL_ARG_NONNULL ((1, 2, 3)));
191 _GL_CXXALIAS_SYS (strptime, char *, (char const *restrict __buf,
192 char const *restrict __format,
193 struct tm *restrict __tm));
194 _GL_CXXALIASWARN (strptime);
197 /* Convert TM to a time_t value, assuming UTC. */
199 # if @REPLACE_TIMEGM@
200 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
202 # define timegm rpl_timegm
204 _GL_FUNCDECL_RPL (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
205 _GL_CXXALIAS_RPL (timegm, time_t, (struct tm *__tm));
208 _GL_FUNCDECL_SYS (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
210 _GL_CXXALIAS_SYS (timegm, time_t, (struct tm *__tm));
212 _GL_CXXALIASWARN (timegm);
215 /* Encourage applications to avoid unsafe functions that can overrun
216 buffers when given outlandish struct tm values. Portable
217 applications should use strftime (or even sprintf) instead. */
218 # if defined GNULIB_POSIXCHECK
220 _GL_WARN_ON_USE (asctime, "asctime can overrun buffers in some cases - "
221 "better use strftime (or even sprintf) instead");
223 # if defined GNULIB_POSIXCHECK
225 _GL_WARN_ON_USE (asctime, "asctime_r can overrun buffers in some cases - "
226 "better use strftime (or even sprintf) instead");
228 # if defined GNULIB_POSIXCHECK
230 _GL_WARN_ON_USE (asctime, "ctime can overrun buffers in some cases - "
231 "better use strftime (or even sprintf) instead");
233 # if defined GNULIB_POSIXCHECK
235 _GL_WARN_ON_USE (asctime, "ctime_r can overrun buffers in some cases - "
236 "better use strftime (or even sprintf) instead");