time/time.h

   1 /* Copyright (C) 1991,92,93,94,95,96,97,98,99 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
  40 /* This defines CLOCKS_PER_SEC, which is the number of processor clock
  41    ticks per second.  */
  42 # include <bits/time.h>
  43
  44 /* This is the obsolete POSIX.1-1988 name for the same constant.  */
  45 # ifdef __USE_POSIX
  46 #  ifndef CLK_TCK
  47 #   define CLK_TCK      CLOCKS_PER_SEC
  48 #  endif
  49 # endif
  50
  51 #endif /* <time.h> included.  */
  52
  53
  54 #if !defined __clock_t_defined && (defined _TIME_H || defined __need_clock_t)
  55 # define __clock_t_defined      1
  56
  57 # include <bits/types.h>
  58
  59 /* Returned by `clock'.  */
  60 typedef __clock_t clock_t;
  61
  62 #endif /* clock_t not defined and <time.h> or need clock_t.  */
  63 #undef  __need_clock_t
  64
  65 #if !defined __time_t_defined && (defined _TIME_H || defined __need_time_t)
  66 # define __time_t_defined       1
  67
  68 # include <bits/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 #if !defined __timespec_defined && \
  78     ((defined _TIME_H && defined __USE_POSIX199309) || defined __need_timespec)
  79 # define __timespec_defined     1
  80
  81 /* POSIX.1b structure for a time value.  This is like a `struct timeval' but
  82    has nanoseconds instead of microseconds.  */
  83 struct timespec
  84   {
  85     long int tv_sec;            /* Seconds.  */
  86     long int tv_nsec;           /* Nanoseconds.  */
  87   };
  88
  89 #endif /* timespec not defined and <time.h> or need timespec.  */
  90 #undef  __need_timespec
  91
  92
  93 #ifdef  _TIME_H
  94 /* Used by other time functions.  */
  95 struct tm
  96 {
  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]*/
 106
 107 # ifdef __USE_BSD
 108   long int tm_gmtoff;           /* Seconds east of UTC.  */
 109   __const char *tm_zone;        /* Timezone abbreviation.  */
 110 # else
 111   long int __tm_gmtoff;         /* Seconds east of UTC.  */
 112   __const char *__tm_zone;      /* Timezone abbreviation.  */
 113 # endif
 114 };
 115
 116
 117 #ifdef __USE_POSIX199309
 118 /* Clock ID used in clock and timer functions.  */
 119 typedef __clockid_t clockid_t;
 120
 121 /* Timer ID returned by `timer_create'.  */
 122 typedef __timer_t timer_t;
 123
 124 /* POSIX.1b structure for timer start values and intervals.  */
 125 struct itimerspec
 126   {
 127     struct timespec it_interval;
 128     struct timespec it_value;
 129   };
 130
 131 /* We can use a simple forward declaration.  */
 132 struct sigevent;
 133
 134 #endif  /* POSIX.1b */
 135
 136
 137 /* Time used by the program so far (user time + system time).
 138    The result / CLOCKS_PER_SECOND is program time in seconds.  */
 139 extern clock_t clock (void) __THROW;
 140
 141 /* Return the current time and put it in *TIMER if TIMER is not NULL.  */
 142 extern time_t time (time_t *__timer) __THROW;
 143
 144 /* Return the difference between TIME1 and TIME0.  */
 145 extern double difftime (time_t __time1, time_t __time0)
 146      __THROW __attribute__ ((__const__));
 147
 148 /* Return the `time_t' representation of TP and normalize TP.  */
 149 extern time_t mktime (struct tm *__tp) __THROW;
 150
 151
 152 /* Format TP into S according to FORMAT.
 153    Write no more than MAXSIZE characters and return the number
 154    of characters written, or 0 if it would exceed MAXSIZE.  */
 155 extern size_t strftime (char *__restrict __s, size_t __maxsize,
 156                         __const char *__restrict __format,
 157                         __const struct tm *__restrict __tp) __THROW;
 158
 159 # ifdef __USE_XOPEN
 160 /* Parse S according to FORMAT and store binary time information in TP.
 161    The return value is a pointer to the first unparsed character in S.  */
 162 extern char *strptime (__const char *__s, __const char *__fmt, struct tm *__tp)
 163      __THROW;
 164 # endif
 165
 166
 167 /* Return the `struct tm' representation of *TIMER
 168    in Universal Coordinated Time (aka Greenwich Mean Time).  */
 169 extern struct tm *gmtime (__const time_t *__timer) __THROW;
 170
 171 /* Return the `struct tm' representation
 172    of *TIMER in the local timezone.  */
 173 extern struct tm *localtime (__const time_t *__timer) __THROW;
 174
 175 # if defined __USE_POSIX || defined __USE_MISC
 176 /* Return the `struct tm' representation of *TIMER in UTC,
 177    using *TP to store the result.  */
 178 extern struct tm *gmtime_r (__const time_t *__restrict __timer,
 179                             struct tm *__restrict __tp) __THROW;
 180
 181 /* Return the `struct tm' representation of *TIMER in local time,
 182    using *TP to store the result.  */
 183 extern struct tm *localtime_r (__const time_t *__restrict __timer,
 184                                struct tm *__restrict __tp) __THROW;
 185 # endif /* POSIX or misc */
 186
 187 /* Return a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 188    that is the representation of TP in this format.  */
 189 extern char *asctime (__const struct tm *__tp) __THROW;
 190
 191 /* Equivalent to `asctime (localtime (timer))'.  */
 192 extern char *ctime (__const time_t *__timer) __THROW;
 193
 194 # if defined __USE_POSIX || defined __USE_MISC
 195 /* Reentrant versions of the above functions.  */
 196
 197 /* Return in BUF a string of the form "Day Mon dd hh:mm:ss yyyy\n"
 198    that is the representation of TP in this format.  */
 199 extern char *asctime_r (__const struct tm *__restrict __tp,
 200                         char *__restrict __buf) __THROW;
 201
 202 /* Equivalent to `asctime_r (localtime_r (timer, *TMP*), buf)'.  */
 203 extern char *ctime_r (__const time_t *__restrict __timer,
 204                       char *__restrict __buf) __THROW;
 205 # endif /* POSIX or misc */
 206
 207
 208 /* Defined in localtime.c.  */
 209 extern char *__tzname[2];       /* Current timezone names.  */
 210 extern int __daylight;          /* If daylight-saving time is ever in use.  */
 211 extern long int __timezone;     /* Seconds west of UTC.  */
 212
 213
 214 # ifdef __USE_POSIX
 215 /* Same as above.  */
 216 extern char *tzname[2];
 217
 218 /* Set time conversion information from the TZ environment variable.
 219    If TZ is not defined, a locale-dependent default is used.  */
 220 extern void tzset (void) __THROW;
 221 # endif
 222
 223 # if defined __USE_SVID || defined __USE_XOPEN
 224 extern int daylight;
 225 extern long int timezone;
 226 # endif
 227
 228 # ifdef __USE_SVID
 229 /* Set the system time to *WHEN.
 230    This call is restricted to the superuser.  */
 231 extern int stime (__const time_t *__when) __THROW;
 232 # endif
 233
 234
 235 /* Nonzero if YEAR is a leap year (every 4 years,
 236    except every 100th isn't, and every 400th is).  */
 237 # define __isleap(year) \
 238   ((year) % 4 == 0 && ((year) % 100 != 0 || (year) % 400 == 0))
 239
 240
 241 # ifdef __USE_MISC
 242 /* Miscellaneous functions many Unices inherited from the public domain
 243    localtime package.  These are included only for compatibility.  */
 244
 245 /* Like `mktime', but for TP represents Universal Time, not local time.  */
 246 extern time_t timegm (struct tm *__tp) __THROW;
 247
 248 /* Another name for `mktime'.  */
 249 extern time_t timelocal (struct tm *__tp) __THROW;
 250
 251 /* Return the number of days in YEAR.  */
 252 extern int dysize (int __year) __THROW;
 253 # endif
 254
 255
 256 # ifdef __USE_POSIX199309
 257 /* Pause execution for a number of nanoseconds.  */
 258 extern int nanosleep (__const struct timespec *__requested_time,
 259                       struct timespec *__remaining) __THROW;
 260
 261
 262 /* Get resolution of clock CLOCK_ID.  */
 263 extern int clock_getres (clockid_t __clock_id, struct timespec *__res) __THROW;
 264
 265 /* Get current value of clock CLOCK_ID and store it in TP.  */
 266 extern int clock_gettime (clockid_t __clock_id, struct timespec *__tp) __THROW;
 267
 268 /* Set clock CLOCK_ID to value TP.  */
 269 extern int clock_settime (clockid_t __clock_id, __const struct timespec *__tp)
 270      __THROW;
 271
 272
 273 /* Create new per-process timer using CLOCK_ID.  */
 274 extern int timer_create (clockid_t __clock_id, struct sigevent *__evp,
 275                          timer_t *__timerid) __THROW;
 276
 277 /* Delete timer TIMERID.  */
 278 extern int timer_delete (timer_t __timerid) __THROW;
 279
 280 /* Set timer TIMERID to VALUE, returning old value in OVLAUE.  */
 281 extern int timer_settime (timer_t __timerid, int __flags,
 282                           __const struct itimerspec *__value,
 283                           struct itimerspec *__ovalue) __THROW;
 284
 285 /* Get current value of timer TIMERID and store it in VLAUE.  */
 286 extern int timer_gettime (timer_t __timerid, struct itimerspec *__value)
 287      __THROW;
 288
 289 /* Get expiration overrun for timer TIMERID.  */
 290 extern int timer_getoverrun (timer_t __timerid) __THROW;
 291 # endif
 292
 293
 294 # ifdef __USE_XOPEN_EXTENDED
 295 /* Set to one of the following values to indicate an error.
 296      1  the DATEMSK environment variable is null or undefined,
 297      2  the template file cannot be opened for reading,
 298      3  failed to get file status information,
 299      4  the template file is not a regular file,
 300      5  an error is encountered while reading the template file,
 301      6  memory allication failed (not enough memory available),
 302      7  there is no line in the template that matches the input,
 303      8  invalid input specification Example: February 31 or a time is
 304         specified that can not be represented in a time_t (representing
 305         the time in seconds since 00:00:00 UTC, January 1, 1970) */
 306 extern int getdate_err;
 307
 308 /* Parse the given string as a date specification and return a value
 309    representing the value.  The templates from the file identified by
 310    the environment variable DATEMSK are used.  In case of an error
 311    `getdate_err' is set.  */
 312 extern struct tm *getdate (__const char *__string) __THROW;
 313 # endif
 314
 315 # ifdef __USE_GNU
 316 /* Since `getdate' is not reentrant because of the use of `getdate_err'
 317    and the static buffer to return the result in, we provide a thread-safe
 318    variant.  The functionality is the same.  The result is returned in
 319    the buffer pointed to by RESBUFP and in case of an error the return
 320    value is != 0 with the same values as given above for `getdate_err'.  */
 321 extern int getdate_r (__const char *__restrict __string,
 322                       struct tm *__restrict __resbufp) __THROW;
 323 # endif
 324
 325
 326 __END_DECLS
 327
 328 #endif /* <time.h> included.  */
 329
 330 #endif /* <time.h> not already included.  */