1 /* Copyright (C) 1991-1999, 2000 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public License as
6 published by the Free Software Foundation; either version 2 of the
7 License, or (at your option) any later version.
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details.
14 You should have received a copy of the GNU Library General Public
15 License along with the GNU C Library; see the file COPYING.LIB. If not,
16 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA. */
20 * ISO C Standard: 4.12 DATE and TIME <time.h>
25 #if (! defined __need_time_t && !defined __need_clock_t && \
26 ! defined __need_timespec)
28 # include <features.h>
35 /* Get size_t and NULL from <stddef.h>. */
36 # define __need_size_t
40 /* This defines CLOCKS_PER_SEC, which is the number of processor clock
42 # include <bits/time.h>
44 /* This is the obsolete POSIX.1-1988 name for the same constant. */
47 # define CLK_TCK CLOCKS_PER_SEC
51 #endif /* <time.h> included. */
54 #if !defined __clock_t_defined && (defined _TIME_H || defined __need_clock_t)
55 # define __clock_t_defined 1
57 # include <bits/types.h>
59 /* Returned by `clock'. */
60 typedef __clock_t clock_t;
62 #endif /* clock_t not defined and <time.h> or need clock_t. */
65 #if !defined __time_t_defined && (defined _TIME_H || defined __need_time_t)
66 # define __time_t_defined 1
68 # include <bits/types.h>
70 /* Returned by `time'. */
71 typedef __time_t time_t;
73 #endif /* time_t not defined and <time.h> or need time_t. */
77 #if !defined __timespec_defined && \
78 ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timespec)
79 # define __timespec_defined 1
81 /* POSIX.1b structure for a time value. This is like a `struct timeval' but
82 has nanoseconds instead of microseconds. */
85 long int tv_sec; /* Seconds. */
86 long int tv_nsec; /* Nanoseconds. */
89 #endif /* timespec not defined and <time.h> or need timespec. */
90 #undef __need_timespec
94 /* Used by other time functions. */
97 int tm_sec; /* Seconds. [0-60] (1 leap second) */
98 int tm_min; /* Minutes. [0-59] */
99 int tm_hour; /* Hours. [0-23] */
100 int tm_mday; /* Day. [1-31] */
101 int tm_mon; /* Month. [0-11] */
102 int tm_year; /* Year - 1900. */
103 int tm_wday; /* Day of week. [0-6] */
104 int tm_yday; /* Days in year.[0-365] */
105 int tm_isdst; /* DST. [-1/0/1]*/
108 long int tm_gmtoff; /* Seconds east of UTC. */
109 __const char *tm_zone; /* Timezone abbreviation. */
111 long int __tm_gmtoff; /* Seconds east of UTC. */
112 __const char *__tm_zone; /* Timezone abbreviation. */
117 #ifdef __USE_POSIX199309
118 /* Clock ID used in clock and timer functions. */
119 typedef __clockid_t clockid_t;
121 /* Timer ID returned by `timer_create'. */
122 typedef __timer_t timer_t;
124 /* POSIX.1b structure for timer start values and intervals. */
127 struct timespec it_interval;
128 struct timespec it_value;
131 /* We can use a simple forward declaration. */
134 #endif /* POSIX.1b */
137 # ifndef __pid_t_defined
138 typedef __pid_t pid_t;
139 # define __pid_t_defined
144 /* Time used by the program so far (user time + system time).
145 The result / CLOCKS_PER_SECOND is program time in seconds. */
146 extern clock_t clock (void) __THROW;
148 /* Return the current time and put it in *TIMER if TIMER is not NULL. */
149 extern time_t time (time_t *__timer) __THROW;
151 /* Return the difference between TIME1 and TIME0. */
152 extern double difftime (time_t __time1, time_t __time0)
153 __THROW __attribute__ ((__const__));
155 /* Return the `time_t' representation of TP and normalize TP. */
156 extern time_t mktime (struct tm *__tp) __THROW;
159 /* Format TP into S according to FORMAT.
160 Write no more than MAXSIZE characters and return the number
161 of characters written, or 0 if it would exceed MAXSIZE. */
162 extern size_t strftime (char *__restrict __s, size_t __maxsize,
163 __const char *__restrict __format,
164 __const struct tm *__restrict __tp) __THROW;
167 /* Parse S according to FORMAT and store binary time information in TP.
168 The return value is a pointer to the first unparsed character in S. */
169 extern char *strptime (__const char *__s, __const char *__fmt, struct tm *__tp)
174 /* Return the `struct tm' representation of *TIMER
175 in Universal Coordinated Time (aka Greenwich Mean Time). */
176 extern struct tm *gmtime (__const time_t *__timer) __THROW;
178 /* Return the `struct tm' representation
179 of *TIMER in the local timezone. */
180 extern struct tm *localtime (__const time_t *__timer) __THROW;
182 # if defined __USE_POSIX || defined __USE_MISC
183 /* Return the `struct tm' representation of *TIMER in UTC,
184 using *TP to store the result. */
185 extern struct tm *gmtime_r (__const time_t *__restrict __timer,
186 struct tm *__restrict __tp) __THROW;
188 /* Return the `struct tm' representation of *TIMER in local time,
189 using *TP to store the result. */
190 extern struct tm *localtime_r (__const time_t *__restrict __timer,
191 struct tm *__restrict __tp) __THROW;
192 # endif /* POSIX or misc */
194 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
195 that is the representation of TP in this format. */
196 extern char *asctime (__const struct tm *__tp) __THROW;
198 /* Equivalent to `asctime (localtime (timer))'. */
199 extern char *ctime (__const time_t *__timer) __THROW;
201 # if defined __USE_POSIX || defined __USE_MISC
202 /* Reentrant versions of the above functions. */
204 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
205 that is the representation of TP in this format. */
206 extern char *asctime_r (__const struct tm *__restrict __tp,
207 char *__restrict __buf) __THROW;
209 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'. */
210 extern char *ctime_r (__const time_t *__restrict __timer,
211 char *__restrict __buf) __THROW;
212 # endif /* POSIX or misc */
215 /* Defined in localtime.c. */
216 extern char *__tzname[2]; /* Current timezone names. */
217 extern int __daylight; /* If daylight-saving time is ever in use. */
218 extern long int __timezone; /* Seconds west of UTC. */
223 extern char *tzname[2];
225 /* Set time conversion information from the TZ environment variable.
226 If TZ is not defined, a locale-dependent default is used. */
227 extern void tzset (void) __THROW;
230 # if defined __USE_SVID || defined __USE_XOPEN
232 extern long int timezone;
236 /* Set the system time to *WHEN.
237 This call is restricted to the superuser. */
238 extern int stime (__const time_t *__when) __THROW;
242 /* Nonzero if YEAR is a leap year (every 4 years,
243 except every 100th isn't, and every 400th is). */
244 # define __isleap(year) \
245 ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
249 /* Miscellaneous functions many Unices inherited from the public domain
250 localtime package. These are included only for compatibility. */
252 /* Like `mktime', but for TP represents Universal Time, not local time. */
253 extern time_t timegm (struct tm *__tp) __THROW;
255 /* Another name for `mktime'. */
256 extern time_t timelocal (struct tm *__tp) __THROW;
258 /* Return the number of days in YEAR. */
259 extern int dysize (int __year) __THROW;
263 # ifdef __USE_POSIX199309
264 /* Pause execution for a number of nanoseconds. */
265 extern int nanosleep (__const struct timespec *__requested_time,
266 struct timespec *__remaining) __THROW;
269 /* Get resolution of clock CLOCK_ID. */
270 extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
272 /* Get current value of clock CLOCK_ID and store it in TP. */
273 extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
275 /* Set clock CLOCK_ID to value TP. */
276 extern int clock_settime (clockid_t __clock_id, __const struct timespec *__tp)
279 # ifdef __USE_XOPEN2K
280 /* High-resolution sleep with the specified clock. */
281 extern int clock_nanosleep (clockid_t __clock_id, int __flags,
282 __const struct timespec *__req,
283 struct timespec *__rem) __THROW;
285 /* Return clock ID for CPU-time clock. */
286 extern int clock_getcpuclockid (pid_t __pid, clockid_t *__clock_id) __THROW;
290 /* Create new per-process timer using CLOCK_ID. */
291 extern int timer_create (clockid_t __clock_id, struct sigevent *__evp,
292 timer_t *__timerid) __THROW;
294 /* Delete timer TIMERID. */
295 extern int timer_delete (timer_t __timerid) __THROW;
297 /* Set timer TIMERID to VALUE, returning old value in OVLAUE. */
298 extern int timer_settime (timer_t __timerid, int __flags,
299 __const struct itimerspec *__value,
300 struct itimerspec *__ovalue) __THROW;
302 /* Get current value of timer TIMERID and store it in VLAUE. */
303 extern int timer_gettime (timer_t __timerid, struct itimerspec *__value)
306 /* Get expiration overrun for timer TIMERID. */
307 extern int timer_getoverrun (timer_t __timerid) __THROW;
311 # ifdef __USE_XOPEN_EXTENDED
312 /* Set to one of the following values to indicate an error.
313 1 the DATEMSK environment variable is null or undefined,
314 2 the template file cannot be opened for reading,
315 3 failed to get file status information,
316 4 the template file is not a regular file,
317 5 an error is encountered while reading the template file,
318 6 memory allication failed (not enough memory available),
319 7 there is no line in the template that matches the input,
320 8 invalid input specification Example: February 31 or a time is
321 specified that can not be represented in a time_t (representing
322 the time in seconds since 00:00:00 UTC, January 1, 1970) */
323 extern int getdate_err;
325 /* Parse the given string as a date specification and return a value
326 representing the value. The templates from the file identified by
327 the environment variable DATEMSK are used. In case of an error
328 `getdate_err' is set. */
329 extern struct tm *getdate (__const char *__string) __THROW;
333 /* Since `getdate' is not reentrant because of the use of `getdate_err'
334 and the static buffer to return the result in, we provide a thread-safe
335 variant. The functionality is the same. The result is returned in
336 the buffer pointed to by RESBUFP and in case of an error the return
337 value is != 0 with the same values as given above for `getdate_err'. */
338 extern int getdate_r (__const char *__restrict __string,
339 struct tm *__restrict __resbufp) __THROW;
345 #endif /* <time.h> included. */
347 #endif /* <time.h> not already included. */