summaryrefslogtreecommitdiffstats
path: root/gl/time.in.h
diff options
context:
space:
mode:
Diffstat (limited to 'gl/time.in.h')
-rw-r--r--gl/time.in.h257
1 files changed, 225 insertions, 32 deletions
diff --git a/gl/time.in.h b/gl/time.in.h
index 8ced794..a73fe59 100644
--- a/gl/time.in.h
+++ b/gl/time.in.h
@@ -1,19 +1,19 @@
1/* A more-standard <time.h>. 1/* A more-standard <time.h>.
2 2
3 Copyright (C) 2007-2013 Free Software Foundation, Inc. 3 Copyright (C) 2007-2021 Free Software Foundation, Inc.
4 4
5 This program is free software; you can redistribute it and/or modify 5 This file is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by 6 it under the terms of the GNU Lesser General Public License as
7 the Free Software Foundation; either version 3, or (at your option) 7 published by the Free Software Foundation; either version 2.1 of the
8 any later version. 8 License, or (at your option) any later version.
9 9
10 This program is distributed in the hope that it will be useful, 10 This file is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of 11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details. 13 GNU Lesser General Public License for more details.
14 14
15 You should have received a copy of the GNU General Public License 15 You should have received a copy of the GNU Lesser General Public License
16 along with this program; if not, see <http://www.gnu.org/licenses/>. */ 16 along with this program. If not, see <https://www.gnu.org/licenses/>. */
17 17
18#if __GNUC__ >= 3 18#if __GNUC__ >= 3
19@PRAGMA_SYSTEM_HEADER@ 19@PRAGMA_SYSTEM_HEADER@
@@ -22,11 +22,13 @@
22 22
23/* Don't get in the way of glibc when it includes time.h merely to 23/* Don't get in the way of glibc when it includes time.h merely to
24 declare a few standard symbols, rather than to declare all the 24 declare a few standard symbols, rather than to declare all the
25 symbols. Also, Solaris 8 <time.h> eventually includes itself 25 symbols. (However, skip this for MinGW as it treats __need_time_t
26 incompatibly.) Also, Solaris 8 <time.h> eventually includes itself
26 recursively; if that is happening, just include the system <time.h> 27 recursively; if that is happening, just include the system <time.h>
27 without adding our own declarations. */ 28 without adding our own declarations. */
28#if (defined __need_time_t || defined __need_clock_t \ 29#if (((defined __need_time_t || defined __need_clock_t \
29 || defined __need_timespec \ 30 || defined __need_timespec) \
31 && !defined __MINGW32__) \
30 || defined _@GUARD_PREFIX@_TIME_H) 32 || defined _@GUARD_PREFIX@_TIME_H)
31 33
32# @INCLUDE_NEXT@ @NEXT_TIME_H@ 34# @INCLUDE_NEXT@ @NEXT_TIME_H@
@@ -35,6 +37,12 @@
35 37
36# define _@GUARD_PREFIX@_TIME_H 38# define _@GUARD_PREFIX@_TIME_H
37 39
40/* mingw's <time.h> provides the functions asctime_r, ctime_r, gmtime_r,
41 localtime_r only if <unistd.h> or <pthread.h> has been included before. */
42# if defined __MINGW32__
43# include <unistd.h>
44# endif
45
38# @INCLUDE_NEXT@ @NEXT_TIME_H@ 46# @INCLUDE_NEXT@ @NEXT_TIME_H@
39 47
40/* NetBSD 5.0 mis-defines NULL. */ 48/* NetBSD 5.0 mis-defines NULL. */
@@ -46,22 +54,17 @@
46 54
47/* The definition of _GL_WARN_ON_USE is copied here. */ 55/* The definition of _GL_WARN_ON_USE is copied here. */
48 56
49/* Some systems don't define struct timespec (e.g., AIX 4.1, Ultrix 4.3). 57/* Some systems don't define struct timespec (e.g., AIX 4.1).
50 Or they define it with the wrong member names or define it in <sys/time.h> 58 Or they define it with the wrong member names or define it in <sys/time.h>
51 (e.g., FreeBSD circa 1997). Stock Mingw does not define it, but the 59 (e.g., FreeBSD circa 1997). Stock Mingw prior to 3.0 does not define it,
52 pthreads-win32 library defines it in <pthread.h>. */ 60 but the pthreads-win32 library defines it in <pthread.h>. */
53# if ! @TIME_H_DEFINES_STRUCT_TIMESPEC@ 61# if ! @TIME_H_DEFINES_STRUCT_TIMESPEC@
54# if @SYS_TIME_H_DEFINES_STRUCT_TIMESPEC@ 62# if @SYS_TIME_H_DEFINES_STRUCT_TIMESPEC@
55# include <sys/time.h> 63# include <sys/time.h>
56# elif @PTHREAD_H_DEFINES_STRUCT_TIMESPEC@ 64# elif @PTHREAD_H_DEFINES_STRUCT_TIMESPEC@
57# include <pthread.h> 65# include <pthread.h>
58/* The pthreads-win32 <pthread.h> also defines a couple of broken macros. */ 66# elif @UNISTD_H_DEFINES_STRUCT_TIMESPEC@
59# undef asctime_r 67# include <unistd.h>
60# undef ctime_r
61# undef gmtime_r
62# undef localtime_r
63# undef rand_r
64# undef strtok_r
65# else 68# else
66 69
67# ifdef __cplusplus 70# ifdef __cplusplus
@@ -87,8 +90,8 @@ struct timespec
87# endif 90# endif
88 91
89# if !GNULIB_defined_struct_time_t_must_be_integral 92# if !GNULIB_defined_struct_time_t_must_be_integral
90/* Per http://austingroupbugs.net/view.php?id=327, POSIX requires 93/* https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_types.h.html
91 time_t to be an integer type, even though C99 permits floating 94 requires time_t to be an integer type, even though C99 permits floating
92 point. We don't know of any implementation that uses floating 95 point. We don't know of any implementation that uses floating
93 point, and it is much easier to write code that doesn't have to 96 point, and it is much easier to write code that doesn't have to
94 worry about that corner case, so we force the issue. */ 97 worry about that corner case, so we force the issue. */
@@ -98,9 +101,28 @@ struct __time_t_must_be_integral {
98# define GNULIB_defined_struct_time_t_must_be_integral 1 101# define GNULIB_defined_struct_time_t_must_be_integral 1
99# endif 102# endif
100 103
104/* Define TIME_UTC, a positive integer constant used for timespec_get(). */
105# if ! @TIME_H_DEFINES_TIME_UTC@
106# if !GNULIB_defined_TIME_UTC
107# define TIME_UTC 1
108# define GNULIB_defined_TIME_UTC 1
109# endif
110# endif
111
112/* Set *TS to the current time, and return BASE.
113 Upon failure, return 0. */
114# if @GNULIB_TIMESPEC_GET@
115# if ! @HAVE_TIMESPEC_GET@
116_GL_FUNCDECL_SYS (timespec_get, int, (struct timespec *ts, int base)
117 _GL_ARG_NONNULL ((1)));
118# endif
119_GL_CXXALIAS_SYS (timespec_get, int, (struct timespec *ts, int base));
120_GL_CXXALIASWARN (timespec_get);
121# endif
122
101/* Sleep for at least RQTP seconds unless interrupted, If interrupted, 123/* Sleep for at least RQTP seconds unless interrupted, If interrupted,
102 return -1 and store the remaining time into RMTP. See 124 return -1 and store the remaining time into RMTP. See
103 <http://www.opengroup.org/susv3xsh/nanosleep.html>. */ 125 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/nanosleep.html>. */
104# if @GNULIB_NANOSLEEP@ 126# if @GNULIB_NANOSLEEP@
105# if @REPLACE_NANOSLEEP@ 127# if @REPLACE_NANOSLEEP@
106# if !(defined __cplusplus && defined GNULIB_NAMESPACE) 128# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
@@ -123,6 +145,41 @@ _GL_CXXALIAS_SYS (nanosleep, int,
123_GL_CXXALIASWARN (nanosleep); 145_GL_CXXALIASWARN (nanosleep);
124# endif 146# endif
125 147
148/* Initialize time conversion information. */
149# if @GNULIB_TZSET@
150# if @REPLACE_TZSET@
151# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
152# undef tzset
153# define tzset rpl_tzset
154# endif
155_GL_FUNCDECL_RPL (tzset, void, (void));
156_GL_CXXALIAS_RPL (tzset, void, (void));
157# elif defined _WIN32 && !defined __CYGWIN__
158# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
159# undef tzset
160# define tzset _tzset
161# endif
162_GL_CXXALIAS_MDA (tzset, void, (void));
163# else
164_GL_CXXALIAS_SYS (tzset, void, (void));
165# endif
166_GL_CXXALIASWARN (tzset);
167# elif @GNULIB_MDA_TZSET@
168/* On native Windows, map 'tzset' to '_tzset', so that -loldnames is not
169 required. In C++ with GNULIB_NAMESPACE, avoid differences between
170 platforms by defining GNULIB_NAMESPACE::tzset always. */
171# if defined _WIN32 && !defined __CYGWIN__
172# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
173# undef tzset
174# define tzset _tzset
175# endif
176_GL_CXXALIAS_MDA (tzset, void, (void));
177# else
178_GL_CXXALIAS_SYS (tzset, void, (void));
179# endif
180_GL_CXXALIASWARN (tzset);
181# endif
182
126/* Return the 'time_t' representation of TP and normalize TP. */ 183/* Return the 'time_t' representation of TP and normalize TP. */
127# if @GNULIB_MKTIME@ 184# if @GNULIB_MKTIME@
128# if @REPLACE_MKTIME@ 185# if @REPLACE_MKTIME@
@@ -134,12 +191,14 @@ _GL_CXXALIAS_RPL (mktime, time_t, (struct tm *__tp));
134# else 191# else
135_GL_CXXALIAS_SYS (mktime, time_t, (struct tm *__tp)); 192_GL_CXXALIAS_SYS (mktime, time_t, (struct tm *__tp));
136# endif 193# endif
194# if __GLIBC__ >= 2
137_GL_CXXALIASWARN (mktime); 195_GL_CXXALIASWARN (mktime);
196# endif
138# endif 197# endif
139 198
140/* Convert TIMER to RESULT, assuming local time and UTC respectively. See 199/* Convert TIMER to RESULT, assuming local time and UTC respectively. See
141 <http://www.opengroup.org/susv3xsh/localtime_r.html> and 200 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/localtime_r.html> and
142 <http://www.opengroup.org/susv3xsh/gmtime_r.html>. */ 201 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/gmtime_r.html>. */
143# if @GNULIB_TIME_R@ 202# if @GNULIB_TIME_R@
144# if @REPLACE_LOCALTIME_R@ 203# if @REPLACE_LOCALTIME_R@
145# if !(defined __cplusplus && defined GNULIB_NAMESPACE) 204# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
@@ -187,9 +246,44 @@ _GL_CXXALIASWARN (gmtime_r);
187# endif 246# endif
188# endif 247# endif
189 248
190/* Parse BUF as a time stamp, assuming FORMAT specifies its layout, and store 249/* Convert TIMER to RESULT, assuming local time and UTC respectively. See
250 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/localtime.html> and
251 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/gmtime.html>. */
252# if @GNULIB_LOCALTIME@ || @REPLACE_LOCALTIME@
253# if @REPLACE_LOCALTIME@
254# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
255# undef localtime
256# define localtime rpl_localtime
257# endif
258_GL_FUNCDECL_RPL (localtime, struct tm *, (time_t const *__timer)
259 _GL_ARG_NONNULL ((1)));
260_GL_CXXALIAS_RPL (localtime, struct tm *, (time_t const *__timer));
261# else
262_GL_CXXALIAS_SYS (localtime, struct tm *, (time_t const *__timer));
263# endif
264# if __GLIBC__ >= 2
265_GL_CXXALIASWARN (localtime);
266# endif
267# endif
268
269# if 0 || @REPLACE_GMTIME@
270# if @REPLACE_GMTIME@
271# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
272# undef gmtime
273# define gmtime rpl_gmtime
274# endif
275_GL_FUNCDECL_RPL (gmtime, struct tm *, (time_t const *__timer)
276 _GL_ARG_NONNULL ((1)));
277_GL_CXXALIAS_RPL (gmtime, struct tm *, (time_t const *__timer));
278# else
279_GL_CXXALIAS_SYS (gmtime, struct tm *, (time_t const *__timer));
280# endif
281_GL_CXXALIASWARN (gmtime);
282# endif
283
284/* Parse BUF as a timestamp, assuming FORMAT specifies its layout, and store
191 the resulting broken-down time into TM. See 285 the resulting broken-down time into TM. See
192 <http://www.opengroup.org/susv3xsh/strptime.html>. */ 286 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/strptime.html>. */
193# if @GNULIB_STRPTIME@ 287# if @GNULIB_STRPTIME@
194# if ! @HAVE_STRPTIME@ 288# if ! @HAVE_STRPTIME@
195_GL_FUNCDECL_SYS (strptime, char *, (char const *restrict __buf, 289_GL_FUNCDECL_SYS (strptime, char *, (char const *restrict __buf,
@@ -203,6 +297,105 @@ _GL_CXXALIAS_SYS (strptime, char *, (char const *restrict __buf,
203_GL_CXXALIASWARN (strptime); 297_GL_CXXALIASWARN (strptime);
204# endif 298# endif
205 299
300/* Convert *TP to a date and time string. See
301 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/ctime.html>. */
302# if @GNULIB_CTIME@
303# if @REPLACE_CTIME@
304# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
305# define ctime rpl_ctime
306# endif
307_GL_FUNCDECL_RPL (ctime, char *, (time_t const *__tp)
308 _GL_ARG_NONNULL ((1)));
309_GL_CXXALIAS_RPL (ctime, char *, (time_t const *__tp));
310# else
311_GL_CXXALIAS_SYS (ctime, char *, (time_t const *__tp));
312# endif
313# if __GLIBC__ >= 2
314_GL_CXXALIASWARN (ctime);
315# endif
316# endif
317
318/* Convert *TP to a date and time string. See
319 <https://pubs.opengroup.org/onlinepubs/9699919799/functions/strftime.html>. */
320# if @GNULIB_STRFTIME@
321# if @REPLACE_STRFTIME@
322# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
323# define strftime rpl_strftime
324# endif
325_GL_FUNCDECL_RPL (strftime, size_t,
326 (char *restrict __buf, size_t __bufsize,
327 const char *restrict __fmt, const struct tm *restrict __tp)
328 _GL_ARG_NONNULL ((1, 3, 4)));
329_GL_CXXALIAS_RPL (strftime, size_t,
330 (char *restrict __buf, size_t __bufsize,
331 const char *restrict __fmt, const struct tm *restrict __tp));
332# else
333_GL_CXXALIAS_SYS (strftime, size_t,
334 (char *restrict __buf, size_t __bufsize,
335 const char *restrict __fmt, const struct tm *restrict __tp));
336# endif
337# if __GLIBC__ >= 2
338_GL_CXXALIASWARN (strftime);
339# endif
340# endif
341
342# if defined _GNU_SOURCE && @GNULIB_TIME_RZ@ && ! @HAVE_TIMEZONE_T@
343/* Functions that use a first-class time zone data type, instead of
344 relying on an implicit global time zone.
345 Inspired by NetBSD. */
346
347/* Represents a time zone.
348 (timezone_t) NULL stands for UTC. */
349typedef struct tm_zone *timezone_t;
350
351/* tzalloc (name)
352 Returns a time zone object for the given time zone NAME. This object
353 represents the time zone that other functions would use it the TZ
354 environment variable was set to NAME.
355 If NAME is NULL, the result represents the time zone that other functions
356 would use it the TZ environment variable was unset.
357 May return NULL if NAME is invalid (this is platform dependent) or
358 upon memory allocation failure. */
359_GL_FUNCDECL_SYS (tzalloc, timezone_t, (char const *__name));
360_GL_CXXALIAS_SYS (tzalloc, timezone_t, (char const *__name));
361
362/* tzfree (tz)
363 Frees a time zone object.
364 The argument must have been returned by tzalloc(). */
365_GL_FUNCDECL_SYS (tzfree, void, (timezone_t __tz));
366_GL_CXXALIAS_SYS (tzfree, void, (timezone_t __tz));
367
368/* localtime_rz (tz, &t, &result)
369 Converts an absolute time T to a broken-down time RESULT, assuming the
370 time zone TZ.
371 This function is like 'localtime_r', but relies on the argument TZ instead
372 of an implicit global time zone. */
373_GL_FUNCDECL_SYS (localtime_rz, struct tm *,
374 (timezone_t __tz, time_t const *restrict __timer,
375 struct tm *restrict __result) _GL_ARG_NONNULL ((2, 3)));
376_GL_CXXALIAS_SYS (localtime_rz, struct tm *,
377 (timezone_t __tz, time_t const *restrict __timer,
378 struct tm *restrict __result));
379
380/* mktime_z (tz, &tm)
381 Normalizes the broken-down time TM and converts it to an absolute time,
382 assuming the time zone TZ. Returns the absolute time.
383 This function is like 'mktime', but relies on the argument TZ instead
384 of an implicit global time zone. */
385_GL_FUNCDECL_SYS (mktime_z, time_t,
386 (timezone_t __tz, struct tm *restrict __tm)
387 _GL_ARG_NONNULL ((2)));
388_GL_CXXALIAS_SYS (mktime_z, time_t,
389 (timezone_t __tz, struct tm *restrict __tm));
390
391/* Time zone abbreviation strings (returned by 'localtime_rz' or 'mktime_z'
392 in the 'tm_zone' member of 'struct tm') are valid as long as
393 - the 'struct tm' argument is not destroyed or overwritten,
394 and
395 - the 'timezone_t' argument is not freed through tzfree(). */
396
397# endif
398
206/* Convert TM to a time_t value, assuming UTC. */ 399/* Convert TM to a time_t value, assuming UTC. */
207# if @GNULIB_TIMEGM@ 400# if @GNULIB_TIMEGM@
208# if @REPLACE_TIMEGM@ 401# if @REPLACE_TIMEGM@
@@ -231,17 +424,17 @@ _GL_WARN_ON_USE (asctime, "asctime can overrun buffers in some cases - "
231# endif 424# endif
232# if defined GNULIB_POSIXCHECK 425# if defined GNULIB_POSIXCHECK
233# undef asctime_r 426# undef asctime_r
234_GL_WARN_ON_USE (asctime, "asctime_r can overrun buffers in some cases - " 427_GL_WARN_ON_USE (asctime_r, "asctime_r can overrun buffers in some cases - "
235 "better use strftime (or even sprintf) instead"); 428 "better use strftime (or even sprintf) instead");
236# endif 429# endif
237# if defined GNULIB_POSIXCHECK 430# if defined GNULIB_POSIXCHECK
238# undef ctime 431# undef ctime
239_GL_WARN_ON_USE (asctime, "ctime can overrun buffers in some cases - " 432_GL_WARN_ON_USE (ctime, "ctime can overrun buffers in some cases - "
240 "better use strftime (or even sprintf) instead"); 433 "better use strftime (or even sprintf) instead");
241# endif 434# endif
242# if defined GNULIB_POSIXCHECK 435# if defined GNULIB_POSIXCHECK
243# undef ctime_r 436# undef ctime_r
244_GL_WARN_ON_USE (asctime, "ctime_r can overrun buffers in some cases - " 437_GL_WARN_ON_USE (ctime_r, "ctime_r can overrun buffers in some cases - "
245 "better use strftime (or even sprintf) instead"); 438 "better use strftime (or even sprintf) instead");
246# endif 439# endif
247 440