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