Formerly time/time.h.~11~
[kopensolaris-gnu/glibc.git] / time / time.h
1 /* Copyright (C) 1991, 1992 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 #ifdef  __cplusplus
26 extern "C" {
27 #endif
28
29 #if     !defined(__need_time_t) && !defined(__need_clock_t)
30 #define _TIME_H         1
31 #include <features.h>
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 /* Processor clock ticks per second.  */
45 #define CLOCKS_PER_SEC  1       /* ??? */
46
47 #ifdef  __USE_POSIX
48 #define CLK_TCK         60      /* ??? */
49 #endif
50
51 #endif  /* <time.h> included.  */
52
53
54 #if     !defined(__clock_t_defined) &&                  \
55         (defined(_TIME_H) || defined(__need_clock_t))
56 #define __clock_t_defined       1
57
58 /* Returned by `clock'.  */
59 typedef long int clock_t;
60
61 #endif  /* clock_t not defined and <time.h> or need clock_t.  */
62 #undef  __need_clock_t
63
64 #if     !defined(__time_t_defined) &&                   \
65         (defined(_TIME_H) || defined(__need_time_t))
66 #define __time_t_defined        1
67
68 #include <gnu/types.h>
69
70 /* Returned by `time'.  */
71 typedef __time_t time_t;
72
73 #endif  /* time_t not defined and <time.h> or need time_t.  */
74 #undef  __need_time_t
75
76
77 #ifdef  _TIME_H
78 /* Used by other time functions.  */
79 struct tm
80   {
81     int tm_sec;         /* Seconds.     [0-61] (2 leap seconds) */
82     int tm_min;         /* Minutes.     [0-59] */
83     int tm_hour;        /* Hours.       [0-23] */
84     int tm_mday;        /* Day.         [1-31] */
85     int tm_mon;         /* Month.       [0-11] */
86     int tm_year;        /* Year - 1900.  */
87     int tm_wday;        /* Day of week. [0-6] */
88     int tm_yday;        /* Days in year.[0-365] */
89     int tm_isdst;       /* DST.         [-1/0/1]*/
90     long int tm_gmtoff; /* Seconds west of UTC.  */
91     CONST char *tm_zone;/* Timezone abbreviation.  */
92   };
93 #endif  /* <time.h> included.  */
94
95
96 #ifdef  _TIME_H
97 /* Time used by the program so far (user time + system time).
98    The result / CLOCKS_PER_SECOND is program time in seconds.  */
99 extern clock_t EXFUN(clock, (NOARGS));
100
101 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
102 extern time_t EXFUN(time, (time_t *__timer));
103
104 #ifndef __CONSTVALUE
105 #ifdef  __GNUC__
106 /* The `const' keyword tells GCC that a function's return value is
107    based solely on its arguments, and there are no side-effects.  */
108 #define __CONSTVALUE    __const
109 #else
110 #define __CONSTVALUE
111 #endif  /* GCC.  */
112 #endif  /* __CONSTVALUE not defined.  */
113
114 /* Return the difference between TIME1 and TIME0.  */
115 extern __CONSTVALUE double EXFUN(difftime, (time_t __time1, time_t __time0));
116
117 /* Return the `time_t' representation of TP and normalize TP.  */
118 extern time_t EXFUN(mktime, (struct tm *__tp));
119
120
121 /* Format TP into S according to FORMAT.
122    Write no more than MAXSIZE characters and return the number
123    of characters written, or 0 if it would exceed MAXSIZE.  */
124 extern size_t EXFUN(strftime, (char *__s, size_t __maxsize,
125                                CONST char *__format, CONST struct tm *__tp));
126
127
128 /* Return the `struct tm' representation of *TIMER
129    in Universal Coordinated Time (aka Greenwich Mean Time).  */
130 extern struct tm *EXFUN(gmtime, (CONST time_t *__timer));
131
132 /* Return the `struct tm' representation
133    of *TIMER in the local timezone.  */
134 extern struct tm *EXFUN(localtime, (CONST time_t *__timer));
135
136 /* Return the `struct tm' representation of *TIMER,
137    offset OFFSET seconds east of Universal Coordinated Time.  */
138 extern struct tm *EXFUN(__offtime, (CONST time_t *__timer, long int __offset));
139
140 #ifdef  __OPTIMIZE__
141 #define gmtime(timer)   __offtime((timer), 0L)
142 #endif  /* Optimizing.  */
143
144
145 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
146    that is the representation of TP in this format.  */
147 extern char *EXFUN(asctime, (CONST struct tm *__tp));
148
149 /* Equivalent to `asctime(localtime(timer))'.  */
150 extern char *EXFUN(ctime, (CONST time_t *__timer));
151
152
153 /* Defined in localtime.c.  */
154 extern char *__tzname[2];       /* Current timezone names.  */
155 extern int __daylight;          /* If it is daylight savings time.  */
156 extern long int __timezone;     /* Seconds west of UTC.  */
157
158 /* Set time conversion information from the TZ environment variable.
159    If TZ is not defined, a locale-dependent default is used.  */
160 extern void EXFUN(__tzset, (NOARGS));
161
162 #ifdef  __USE_POSIX
163 /* Same as above.  */
164 extern char *tzname[2];
165
166 extern long int EXFUN(__tzname_max, (NOARGS));
167
168 extern void EXFUN(tzset, (NOARGS));
169 #ifdef  __OPTIMIZE__
170 #define tzset() __tzset()
171 #endif  /* Optimizing.  */
172 #endif
173
174 #ifdef  __USE_SVID
175 extern int daylight;
176 extern long int timezone;
177 #endif
178
179
180 /* Nonzero if YEAR is a leap year (every 4 years,
181    except every 100th isn't, and every 400th is).  */
182 #define __isleap(year)  \
183   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
184
185 #endif  /* <time.h> included.  */
186
187 #ifdef  __cplusplus
188 }
189 #endif
190
191 #endif  /* <time.h> not already included.  */