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