Fix typo.
[kopensolaris-gnu/glibc.git] / time / time.h
1 /* Copyright (C) 1991, 92, 93, 94, 95, 96, 97 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
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.
8
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.
13
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.  */
18
19 /*
20  *      ISO C Standard: 4.12 DATE and TIME      <time.h>
21  */
22
23 #ifndef _TIME_H
24
25 #if (! defined __need_time_t && !defined __need_clock_t && \
26      ! defined __need_timespec)
27 # define _TIME_H        1
28 # include <features.h>
29
30 __BEGIN_DECLS
31
32 #endif
33
34 #ifdef  _TIME_H
35 /* Get size_t and NULL from <stddef.h>.  */
36 # define __need_size_t
37 # define __need_NULL
38 # include <stddef.h>
39 #endif /* <time.h> included.  */
40
41
42
43 #ifdef  _TIME_H
44
45 /* This defines CLOCKS_PER_SEC, which is the number of processor clock
46    ticks per second.  */
47 # include <bits/time.h>
48
49 /* This is the obsolete POSIX.1-1988 name for the same constant.  */
50 # ifdef __USE_POSIX
51 #  ifndef CLK_TCK
52 #   define CLK_TCK      CLOCKS_PER_SEC
53 #  endif
54 # endif
55
56 #endif /* <time.h> included.  */
57
58
59 #if !defined __clock_t_defined && (defined _TIME_H || defined __need_clock_t)
60 # define __clock_t_defined      1
61
62 # include <bits/types.h>
63
64 /* Returned by `clock'.  */
65 typedef __clock_t clock_t;
66
67 #endif /* clock_t not defined and <time.h> or need clock_t.  */
68 #undef  __need_clock_t
69
70 #if !defined __time_t_defined && (defined _TIME_H || defined __need_time_t)
71 # define __time_t_defined       1
72
73 # include <bits/types.h>
74
75 /* Returned by `time'.  */
76 typedef __time_t time_t;
77
78 #endif /* time_t not defined and <time.h> or need time_t.  */
79 #undef  __need_time_t
80
81
82 #if !defined __timespec_defined && \
83     ((defined _TIME_H && defined __USE_POSIX) || defined __need_timespec)
84 # define __timespec_defined     1
85
86 /* POSIX.4 structure for a time value.  This is like a `struct timeval' but
87    has nanoseconds instead of microseconds.  */
88 struct timespec
89   {
90     long int tv_sec;            /* Seconds.  */
91     long int tv_nsec;           /* Nanoseconds.  */
92   };
93
94 #endif /* timespec not defined and <time.h> or need timespec.  */
95 #undef  __need_timespec
96
97
98
99 #ifdef  _TIME_H
100 /* Used by other time functions.  */
101 struct tm
102 {
103   int tm_sec;                   /* Seconds.     [0-60] (1 leap second) */
104   int tm_min;                   /* Minutes.     [0-59] */
105   int tm_hour;                  /* Hours.       [0-23] */
106   int tm_mday;                  /* Day.         [1-31] */
107   int tm_mon;                   /* Month.       [0-11] */
108   int tm_year;                  /* Year - 1900.  */
109   int tm_wday;                  /* Day of week. [0-6] */
110   int tm_yday;                  /* Days in year.[0-365] */
111   int tm_isdst;                 /* DST.         [-1/0/1]*/
112
113 # ifdef __USE_BSD
114   long int tm_gmtoff;           /* Seconds east of UTC.  */
115   __const char *tm_zone;        /* Timezone abbreviation.  */
116 # else
117   long int __tm_gmtoff;         /* Seconds east of UTC.  */
118   __const char *__tm_zone;      /* Timezone abbreviation.  */
119 # endif
120 };
121
122 #endif /* <time.h> included.  */
123
124
125 #ifdef  _TIME_H
126 /* Time used by the program so far (user time + system time).
127    The result / CLOCKS_PER_SECOND is program time in seconds.  */
128 extern clock_t clock __P ((void));
129
130 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
131 extern time_t time __P ((time_t *__timer));
132
133 /* Return the difference between TIME1 and TIME0.  */
134 extern double difftime __P ((time_t __time1, time_t __time0))
135      __attribute__ ((__const__));
136
137 /* Return the `time_t' representation of TP and normalize TP.  */
138 extern time_t mktime __P ((struct tm *__tp));
139
140 /* Subroutine of `mktime'.  Return the `time_t' representation of TP and
141    normalize TP, given that a `struct tm *' maps to a `time_t' as performed
142    by FUNC.  Keep track of next guess for time_t offset in *OFFSET.  */
143 extern time_t __mktime_internal __P ((struct tm *__tp,
144                                       struct tm *(*__func) (const time_t *,
145                                                             struct tm *),
146                                       time_t *__offset));
147
148
149 /* Format TP into S according to FORMAT.
150    Write no more than MAXSIZE characters and return the number
151    of characters written, or 0 if it would exceed MAXSIZE.  */
152 extern size_t strftime __P ((char *__restrict __s, size_t __maxsize,
153                              __const char *__restrict __format,
154                              __const struct tm *__restrict __tp));
155
156 # ifdef __USE_XOPEN
157 /* Parse S according to FORMAT and store binary time information in TP.
158    The return value is a pointer to the first unparsed character in S.  */
159 extern char *strptime __P ((__const char *__s, __const char *__fmt,
160                             struct tm *__tp));
161 # endif
162
163
164 /* Return the `struct tm' representation of *TIMER
165    in Universal Coordinated Time (aka Greenwich Mean Time).  */
166 extern struct tm *gmtime __P ((__const time_t *__timer));
167
168 /* Return the `struct tm' representation
169    of *TIMER in the local timezone.  */
170 extern struct tm *localtime __P ((__const time_t *__timer));
171
172 # if defined __USE_POSIX || defined __USE_MISC
173 /* Return the `struct tm' representation of *TIMER in UTC,
174    using *TP to store the result.  */
175 extern struct tm *__gmtime_r __P ((__const time_t *__timer,
176                                    struct tm *__tp));
177 extern struct tm *gmtime_r __P ((__const time_t *__timer,
178                                  struct tm *__tp));
179
180 /* Return the `struct tm' representation of *TIMER in local time,
181    using *TP to store the result.  */
182 extern struct tm *__localtime_r __P ((__const time_t *__timer,
183                                       struct tm *__tp));
184 extern struct tm *localtime_r __P ((__const time_t *__timer,
185                                     struct tm *__tp));
186 # endif /* POSIX or misc */
187
188 /* Compute the `struct tm' representation of *T,
189    offset OFFSET seconds east of UTC,
190    and store year, yday, mon, mday, wday, hour, min, sec into *TP.  */
191 extern void __offtime __P ((__const time_t *__timer,
192                             long int __offset,
193                             struct tm *__TP));
194
195 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
196    that is the representation of TP in this format.  */
197 extern char *asctime __P ((__const struct tm *__tp));
198
199 /* Equivalent to `asctime (localtime (timer))'.  */
200 extern char *ctime __P ((__const time_t *__timer));
201
202 # if defined __USE_POSIX || defined __USE_MISC
203 /* Reentrant versions of the above functions.  */
204
205 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
206    that is the representation of TP in this format.  */
207 extern char *__asctime_r __P ((__const struct tm *__tp, char *__buf));
208 extern char *asctime_r __P ((__const struct tm *__tp, char *__buf));
209
210 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
211 extern char *ctime_r __P ((__const time_t *__timer, char *__buf));
212 # endif /* POSIX or misc */
213
214
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.  */
219
220 /* Set time conversion information from the TZ environment variable.
221    If TZ is not defined, a locale-dependent default is used.  */
222 extern void __tzset __P ((void));
223
224 # ifdef __USE_POSIX
225 /* Same as above.  */
226 extern char *tzname[2];
227
228 /* Return the maximum length of a timezone name.
229    This is what `sysconf (_SC_TZNAME_MAX)' does.  */
230 extern long int __tzname_max __P ((void));
231
232 extern void tzset __P ((void));
233 # endif
234
235 # if defined __USE_SVID || defined __USE_XOPEN
236 extern int daylight;
237 extern long int timezone;
238 # endif
239
240 # ifdef __USE_SVID
241 /* Set the system time to *WHEN.
242    This call is restricted to the superuser.  */
243 extern int stime __P ((__const time_t *__when));
244 # endif
245
246
247 /* Nonzero if YEAR is a leap year (every 4 years,
248    except every 100th isn't, and every 400th is).  */
249 # define __isleap(year) \
250   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
251
252
253 # ifdef __USE_MISC
254 /* Miscellaneous functions many Unices inherited from the public domain
255    localtime package.  These are included only for compatibility.  */
256
257 /* Like `mktime', but for TP represents Universal Time, not local time.  */
258 extern time_t timegm __P ((struct tm *__tp));
259
260 /* Another name for `mktime'.  */
261 extern time_t timelocal __P ((struct tm *__tp));
262
263 /* Return the number of days in YEAR.  */
264 extern int dysize __P ((int __year));
265 # endif
266
267
268 # ifdef __USE_POSIX199309
269 /* Pause execution for a number of nanoseconds.  */
270 extern int __nanosleep __P ((__const struct timespec *__requested_time,
271                              struct timespec *__remaining));
272 extern int nanosleep __P ((__const struct timespec *__requested_time,
273                            struct timespec *__remaining));
274 # endif
275
276
277 # ifdef __USE_XOPEN_EXTENDED
278 /* Set to one of the following values to indicate an error.
279      1  the DATEMSK environment variable is null or undefined,
280      2  the template file cannot be opened for reading,
281      3  failed to get file status information,
282      4  the template file is not a regular file,
283      5  an error is encountered while reading the template file,
284      6  memory allication failed (not enough memory available),
285      7  there is no line in the template that matches the input,
286      8  invalid input specification Example: February 31 or a time is
287         specified that can not be represented in a time_t (representing
288         the time in seconds since 00:00:00 UTC, January 1, 1970) */
289 extern int getdate_err;
290
291 /* Parse the given string as a date specification and return a value
292    representing the value.  The templates from the file identified by
293    the environment variable DATEMSK are used.  In case of an error
294    `getdate_err' is set.  */
295 extern struct tm *getdate __P ((__const char *__string));
296 # endif
297
298 # ifdef __USE_GNU
299 /* Since `getdate' is not reentrant because of the use of `getdate_err'
300    and the static buffer to return the result in, we provide a thread-safe
301    variant.  The functionality is the same.  The result is returned in
302    the buffer pointed to by RESBUFP and in case of an error the return
303    value is != 0 with the same values as given above for `getdate_err'.  */
304 extern int __getdate_r __P ((__const char *__string, struct tm *__resbufp));
305 extern int getdate_r __P ((__const char *__string, struct tm *__resbufp));
306 # endif
307
308
309 __END_DECLS
310
311 #endif /* <time.h> included.  */
312
313 #endif /* <time.h> not already included.  */