Wed May 29 00:57:37 1996 David Mosberger-Tang <davidm@azstarnet.com>
[kopensolaris-gnu/glibc.git] / time / time.h
1 /* Copyright (C) 1991, 92, 93, 94, 95, 96 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
16 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
17 Cambridge, MA 02139, USA.  */
18
19 /*
20  *      ANSI 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 #define _TIME_H         1
27 #include <features.h>
28
29 __BEGIN_DECLS
30
31 #endif
32
33 #ifdef  _TIME_H
34 /* Get size_t and NULL from <stddef.h>.  */
35 #define __need_size_t
36 #define __need_NULL
37 #include <stddef.h>
38 #endif /* <time.h> included.  */
39
40
41
42 #ifdef  _TIME_H
43
44 /* This defines CLOCKS_PER_SEC, which is the number of processor clock
45    ticks per second.  */
46 #include <timebits.h>
47
48 /* This is the obsolete POSIX.1-1988 name for the same constant.  */
49 #ifdef  __USE_POSIX
50 #define CLK_TCK         CLOCKS_PER_SEC
51 #endif
52
53 #endif /* <time.h> included.  */
54
55
56 #if     !defined(__clock_t_defined) &&                  \
57         (defined(_TIME_H) || defined(__need_clock_t))
58 #define __clock_t_defined       1
59
60 #include <gnu/types.h>
61
62 /* Returned by `clock'.  */
63 typedef __clock_t clock_t;
64
65 #endif /* clock_t not defined and <time.h> or need clock_t.  */
66 #undef  __need_clock_t
67
68 #if     !defined(__time_t_defined) &&                   \
69         (defined(_TIME_H) || defined(__need_time_t))
70 #define __time_t_defined        1
71
72 #include <gnu/types.h>
73
74 /* Returned by `time'.  */
75 typedef __time_t time_t;
76
77 #endif /* time_t not defined and <time.h> or need time_t.  */
78 #undef  __need_time_t
79
80
81 #ifdef  _TIME_H
82 /* Used by other time functions.  */
83 struct tm
84 {
85   int tm_sec;                   /* Seconds.     [0-61] (2 leap seconds) */
86   int tm_min;                   /* Minutes.     [0-59] */
87   int tm_hour;                  /* Hours.       [0-23] */
88   int tm_mday;                  /* Day.         [1-31] */
89   int tm_mon;                   /* Month.       [0-11] */
90   int tm_year;                  /* Year - 1900.  */
91   int tm_wday;                  /* Day of week. [0-6] */
92   int tm_yday;                  /* Days in year.[0-365] */
93   int tm_isdst;                 /* DST.         [-1/0/1]*/
94   long int tm_gmtoff;           /* Seconds west of UTC.  */
95   __const char *tm_zone;        /* Timezone abbreviation.  */
96 };
97
98 #endif /* <time.h> included.  */
99
100
101 #ifdef  _TIME_H
102 /* Time used by the program so far (user time + system time).
103    The result / CLOCKS_PER_SECOND is program time in seconds.  */
104 extern clock_t clock __P ((void));
105
106 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
107 extern time_t time __P ((time_t *__timer));
108
109 /* Return the difference between TIME1 and TIME0.  */
110 extern double difftime __P ((time_t __time1, time_t __time0))
111      __attribute__ ((__const__));
112
113 /* Return the `time_t' representation of TP and normalize TP.  */
114 extern time_t mktime __P ((struct tm *__tp));
115
116 /* Subroutine of `mktime'.  Return the `time_t' representation of TP and
117    normalize TP, given that a `struct tm *' maps to a `time_t' as performed
118    by FUNC.  Keep track of next guess for time_t offset in *OFFSET.  */
119 extern time_t __mktime_internal __P ((struct tm *__tp,
120                                       struct tm *(*__func) (const time_t *,
121                                                             struct tm *),
122                                       time_t *__offset));
123
124
125 /* Format TP into S according to FORMAT.
126    Write no more than MAXSIZE characters and return the number
127    of characters written, or 0 if it would exceed MAXSIZE.  */
128 extern size_t strftime __P ((char *__s, size_t __maxsize,
129                              __const char *__format, __const struct tm *__tp));
130
131 #ifdef __USE_MISC
132 /* Parse S according to FORMAT and store binary time information in TP.
133    The return value is a pointer to the first unparsed character in S.  */
134 extern char *strptime __P ((__const char *__s, __const char *__fmt,
135                             struct tm *__tp));
136 #endif
137
138
139 /* Return the `struct tm' representation of *TIMER
140    in Universal Coordinated Time (aka Greenwich Mean Time).  */
141 extern struct tm *gmtime __P ((__const time_t *__timer));
142
143 /* Return the `struct tm' representation
144    of *TIMER in the local timezone.  */
145 extern struct tm *localtime __P ((__const time_t *__timer));
146
147 #ifdef  __USE_REENTRANT
148 /* Return the `struct tm' representation of *TIMER in UTC,
149    using *TP to store the result.  */
150 extern struct tm *__gmtime_r __P ((__const time_t *__timer,
151                                    struct tm *__tp));
152 extern struct tm *gmtime_r __P ((__const time_t *__timer,
153                                  struct tm *__tp));
154
155 /* Return the `struct tm' representation of *TIMER in local time,
156    using *TP to store the result.  */
157 extern struct tm *__localtime_r __P ((__const time_t *__timer,
158                                       struct tm *__tp));
159 extern struct tm *localtime_r __P ((__const time_t *__timer,
160                                     struct tm *__tp));
161 #endif
162
163 /* Compute the `struct tm' representation of *T,
164    offset OFFSET seconds east of UTC,
165    and store year, yday, mon, mday, wday, hour, min, sec into *TP.  */
166 extern void __offtime __P ((__const time_t *__timer,
167                             long int __offset,
168                             struct tm *__TP));
169
170 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
171    that is the representation of TP in this format.  */
172 extern char *asctime __P ((__const struct tm *__tp));
173
174 /* Equivalent to `asctime(localtime(timer))'.  */
175 extern char *ctime __P ((__const time_t *__timer));
176
177
178 /* Defined in localtime.c.  */
179 extern char *__tzname[2];       /* Current timezone names.  */
180 extern int __daylight;          /* If it is daylight savings time.  */
181 extern long int __timezone;     /* Seconds west of UTC.  */
182
183 /* Set time conversion information from the TZ environment variable.
184    If TZ is not defined, a locale-dependent default is used.  */
185 extern void __tzset __P ((void));
186
187 #ifdef  __USE_POSIX
188 /* Same as above.  */
189 extern char *tzname[2];
190
191 /* Return the maximum length of a timezone name.
192    This is what `sysconf (_SC_TZNAME_MAX)' does.  */
193 extern long int __tzname_max __P ((void));
194
195 extern void tzset __P ((void));
196 #ifdef  __OPTIMIZE__
197 #define tzset() __tzset()
198 #endif /* Optimizing.  */
199 #endif
200
201 #ifdef  __USE_SVID
202 extern int daylight;
203 extern long int timezone;
204
205 /* Set the system time to *WHEN.
206    This call is restricted to the superuser.  */
207 extern int stime __P ((__const time_t *__when));
208 #endif
209
210
211 /* Nonzero if YEAR is a leap year (every 4 years,
212    except every 100th isn't, and every 400th is).  */
213 #define __isleap(year)  \
214   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
215
216
217 #ifdef __USE_MISC
218 /* Miscellaneous functions many Unices inherited from the public domain
219    localtime package.  These are included only for compatibility.  */
220
221 /* Like `mktime', but for TP represents Universal Time, not local time.  */
222 extern time_t timegm __P ((struct tm *__tp));
223
224 /* Another name for `mktime'.  */
225 extern time_t timelocal __P ((struct tm *__tp));
226
227 /* Return the number of days in YEAR.  */
228 extern int dysize __P ((int __year));
229 #endif
230
231
232 /* POSIX.4 structure for a time value.  This is like a `struct timeval' but
233    has nanoseconds instead of microseconds.  */
234 struct timespec
235   {
236     long int ts_sec;            /* Seconds.  */
237     long int ts_nsec;           /* Nanoseconds.  */
238   };
239
240 #ifdef __USE_POSIX
241 /* Pause execution for a number of nanoseconds.  */
242 extern int nanosleep __P ((__const struct timespec *__requested_time,
243                            struct timespec *__remaining));
244 #endif
245
246
247 __END_DECLS
248
249 #endif /* <time.h> included.  */
250
251 #endif /* <time.h> not already included.  */