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 /* Sleep for at least RQTP seconds unless interrupted, If interrupted,
88 return -1 and store the remaining time into RMTP. See
89 <http://www.opengroup.org/susv3xsh/nanosleep.html>. */
90 # if @GNULIB_NANOSLEEP@
91 # if @REPLACE_NANOSLEEP@
92 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
93 # define nanosleep rpl_nanosleep
95 _GL_FUNCDECL_RPL (nanosleep, int,
96 (struct timespec const *__rqtp, struct timespec *__rmtp)
97 _GL_ARG_NONNULL ((1)));
98 _GL_CXXALIAS_RPL (nanosleep, int,
99 (struct timespec const *__rqtp, struct timespec *__rmtp));
101 # if ! @HAVE_NANOSLEEP@
102 _GL_FUNCDECL_SYS (nanosleep, int,
103 (struct timespec const *__rqtp, struct timespec *__rmtp)
104 _GL_ARG_NONNULL ((1)));
106 _GL_CXXALIAS_SYS (nanosleep, int,
107 (struct timespec const *__rqtp, struct timespec *__rmtp));
109 _GL_CXXALIASWARN (nanosleep);
112 /* Return the 'time_t' representation of TP and normalize TP. */
114 # if @REPLACE_MKTIME@
115 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
116 # define mktime rpl_mktime
118 _GL_FUNCDECL_RPL (mktime, time_t, (struct tm *__tp) _GL_ARG_NONNULL ((1)));
119 _GL_CXXALIAS_RPL (mktime, time_t, (struct tm *__tp));
121 _GL_CXXALIAS_SYS (mktime, time_t, (struct tm *__tp));
123 _GL_CXXALIASWARN (mktime);
126 /* Convert TIMER to RESULT, assuming local time and UTC respectively. See
127 <http://www.opengroup.org/susv3xsh/localtime_r.html> and
128 <http://www.opengroup.org/susv3xsh/gmtime_r.html>. */
130 # if @REPLACE_LOCALTIME_R@
131 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
133 # define localtime_r rpl_localtime_r
135 _GL_FUNCDECL_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
136 struct tm *restrict __result)
137 _GL_ARG_NONNULL ((1, 2)));
138 _GL_CXXALIAS_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
139 struct tm *restrict __result));
141 # if ! @HAVE_LOCALTIME_R@
142 _GL_FUNCDECL_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
143 struct tm *restrict __result)
144 _GL_ARG_NONNULL ((1, 2)));
146 _GL_CXXALIAS_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
147 struct tm *restrict __result));
149 _GL_CXXALIASWARN (localtime_r);
150 # if @REPLACE_LOCALTIME_R@
151 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
153 # define gmtime_r rpl_gmtime_r
155 _GL_FUNCDECL_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
156 struct tm *restrict __result)
157 _GL_ARG_NONNULL ((1, 2)));
158 _GL_CXXALIAS_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
159 struct tm *restrict __result));
161 # if ! @HAVE_LOCALTIME_R@
162 _GL_FUNCDECL_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
163 struct tm *restrict __result)
164 _GL_ARG_NONNULL ((1, 2)));
166 _GL_CXXALIAS_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
167 struct tm *restrict __result));
169 _GL_CXXALIASWARN (gmtime_r);
172 /* Parse BUF as a time stamp, assuming FORMAT specifies its layout, and store
173 the resulting broken-down time into TM. See
174 <http://www.opengroup.org/susv3xsh/strptime.html>. */
175 # if @GNULIB_STRPTIME@
176 # if ! @HAVE_STRPTIME@
177 _GL_FUNCDECL_SYS (strptime, char *, (char const *restrict __buf,
178 char const *restrict __format,
179 struct tm *restrict __tm)
180 _GL_ARG_NONNULL ((1, 2, 3)));
182 _GL_CXXALIAS_SYS (strptime, char *, (char const *restrict __buf,
183 char const *restrict __format,
184 struct tm *restrict __tm));
185 _GL_CXXALIASWARN (strptime);
188 /* Convert TM to a time_t value, assuming UTC. */
190 # if @REPLACE_TIMEGM@
191 # if !(defined __cplusplus && defined GNULIB_NAMESPACE)
193 # define timegm rpl_timegm
195 _GL_FUNCDECL_RPL (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
196 _GL_CXXALIAS_RPL (timegm, time_t, (struct tm *__tm));
199 _GL_FUNCDECL_SYS (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
201 _GL_CXXALIAS_SYS (timegm, time_t, (struct tm *__tm));
203 _GL_CXXALIASWARN (timegm);
206 /* Encourage applications to avoid unsafe functions that can overrun
207 buffers when given outlandish struct tm values. Portable
208 applications should use strftime (or even sprintf) instead. */
209 # if defined GNULIB_POSIXCHECK
211 _GL_WARN_ON_USE (asctime, "asctime can overrun buffers in some cases - "
212 "better use strftime (or even sprintf) instead");
214 # if defined GNULIB_POSIXCHECK
216 _GL_WARN_ON_USE (asctime, "asctime_r can overrun buffers in some cases - "
217 "better use strftime (or even sprintf) instead");
219 # if defined GNULIB_POSIXCHECK
221 _GL_WARN_ON_USE (asctime, "ctime can overrun buffers in some cases - "
222 "better use strftime (or even sprintf) instead");
224 # if defined GNULIB_POSIXCHECK
226 _GL_WARN_ON_USE (asctime, "ctime_r can overrun buffers in some cases - "
227 "better use strftime (or even sprintf) instead");