lib/time.in.h

   1 /* A more-standard <time.h>.
   2
   3    Copyright (C) 2007-2010 Free Software Foundation, Inc.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 #if __GNUC__ >= 3
  20 @PRAGMA_SYSTEM_HEADER@
  21 #endif
  22
  23 /* Don't get in the way of glibc when it includes time.h merely to
  24    declare a few standard symbols, rather than to declare all the
  25    symbols.  Also, Solaris 8 <time.h> eventually includes itself
  26    recursively; if that is happening, just include the system <time.h>
  27    without adding our own declarations.  */
  28 #if (defined __need_time_t || defined __need_clock_t \
  29      || defined __need_timespec \
  30      || defined _GL_TIME_H)
  31
  32 # @INCLUDE_NEXT@ @NEXT_TIME_H@
  33
  34 #else
  35
  36 # define _GL_TIME_H
  37
  38 # @INCLUDE_NEXT@ @NEXT_TIME_H@
  39
  40 /* NetBSD 5.0 mis-defines NULL.  */
  41 #include <stddef.h>
  42
  43 /* The definitions of _GL_FUNCDECL_RPL etc. are copied here.  */
  44
  45 /* The definition of _GL_ARG_NONNULL is copied here.  */
  46
  47 /* The definition of _GL_WARN_ON_USE is copied here.  */
  48
  49 # ifdef __cplusplus
  50 extern "C" {
  51 # endif
  52
  53 /* Some systems don't define struct timespec (e.g., AIX 4.1, Ultrix 4.3).
  54    Or they define it with the wrong member names or define it in <sys/time.h>
  55    (e.g., FreeBSD circa 1997).  */
  56 # if ! @TIME_H_DEFINES_STRUCT_TIMESPEC@
  57 #  if @SYS_TIME_H_DEFINES_STRUCT_TIMESPEC@
  58 #   include <sys/time.h>
  59 #  else
  60 #   undef timespec
  61 #   define timespec rpl_timespec
  62 struct timespec
  63 {
  64   time_t tv_sec;
  65   long int tv_nsec;
  66 };
  67 #  endif
  68 # endif
  69
  70 # ifdef __cplusplus
  71 }
  72 # endif
  73
  74 /* Sleep for at least RQTP seconds unless interrupted,  If interrupted,
  75    return -1 and store the remaining time into RMTP.  See
  76    <http://www.opengroup.org/susv3xsh/nanosleep.html>.  */
  77 # if @GNULIB_NANOSLEEP@
  78 #  if @REPLACE_NANOSLEEP@
  79 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
  80 #    define nanosleep rpl_nanosleep
  81 #   endif
  82 _GL_FUNCDECL_RPL (nanosleep, int,
  83                   (struct timespec const *__rqtp, struct timespec *__rmtp)
  84                   _GL_ARG_NONNULL ((1)));
  85 _GL_CXXALIAS_RPL (nanosleep, int,
  86                   (struct timespec const *__rqtp, struct timespec *__rmtp));
  87 #  else
  88 _GL_CXXALIAS_SYS (nanosleep, int,
  89                   (struct timespec const *__rqtp, struct timespec *__rmtp));
  90 #  endif
  91 _GL_CXXALIASWARN (nanosleep);
  92 # endif
  93
  94 /* Return the 'time_t' representation of TP and normalize TP.  */
  95 # if @GNULIB_MKTIME@
  96 #  if @REPLACE_MKTIME@
  97 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
  98 #    define mktime rpl_mktime
  99 #   endif
 100 _GL_FUNCDECL_RPL (mktime, time_t, (struct tm *__tp) _GL_ARG_NONNULL ((1)));
 101 _GL_CXXALIAS_RPL (mktime, time_t, (struct tm *__tp));
 102 #  else
 103 _GL_CXXALIAS_SYS (mktime, time_t, (struct tm *__tp));
 104 #  endif
 105 _GL_CXXALIASWARN (mktime);
 106 # endif
 107
 108 /* Convert TIMER to RESULT, assuming local time and UTC respectively.  See
 109    <http://www.opengroup.org/susv3xsh/localtime_r.html> and
 110    <http://www.opengroup.org/susv3xsh/gmtime_r.html>.  */
 111 # if @GNULIB_TIME_R@
 112 #  if @REPLACE_LOCALTIME_R@
 113 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 114 #    undef localtime_r
 115 #    define localtime_r rpl_localtime_r
 116 #   endif
 117 _GL_FUNCDECL_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
 118                                              struct tm *restrict __result)
 119                                             _GL_ARG_NONNULL ((1, 2)));
 120 _GL_CXXALIAS_RPL (localtime_r, struct tm *, (time_t const *restrict __timer,
 121                                              struct tm *restrict __result));
 122 #  else
 123 _GL_CXXALIAS_SYS (localtime_r, struct tm *, (time_t const *restrict __timer,
 124                                              struct tm *restrict __result));
 125 #  endif
 126 _GL_CXXALIASWARN (localtime_r);
 127 #  if @REPLACE_LOCALTIME_R@
 128 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 129 #    undef gmtime_r
 130 #    define gmtime_r rpl_gmtime_r
 131 #   endif
 132 _GL_FUNCDECL_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
 133                                           struct tm *restrict __result)
 134                                          _GL_ARG_NONNULL ((1, 2)));
 135 _GL_CXXALIAS_RPL (gmtime_r, struct tm *, (time_t const *restrict __timer,
 136                                           struct tm *restrict __result));
 137 #  else
 138 _GL_CXXALIAS_SYS (gmtime_r, struct tm *, (time_t const *restrict __timer,
 139                                           struct tm *restrict __result));
 140 #  endif
 141 _GL_CXXALIASWARN (gmtime_r);
 142 # endif
 143
 144 /* Parse BUF as a time stamp, assuming FORMAT specifies its layout, and store
 145    the resulting broken-down time into TM.  See
 146    <http://www.opengroup.org/susv3xsh/strptime.html>.  */
 147 # if @GNULIB_STRPTIME@
 148 #  if @REPLACE_STRPTIME@
 149 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 150 #    undef strptime
 151 #    define strptime rpl_strptime
 152 #   endif
 153 _GL_FUNCDECL_RPL (strptime, char *, (char const *restrict __buf,
 154                                      char const *restrict __format,
 155                                      struct tm *restrict __tm)
 156                                     _GL_ARG_NONNULL ((1, 2, 3)));
 157 _GL_CXXALIAS_RPL (strptime, char *, (char const *restrict __buf,
 158                                      char const *restrict __format,
 159                                      struct tm *restrict __tm));
 160 #  else
 161 _GL_CXXALIAS_SYS (strptime, char *, (char const *restrict __buf,
 162                                      char const *restrict __format,
 163                                      struct tm *restrict __tm));
 164 #  endif
 165 _GL_CXXALIASWARN (strptime);
 166 # endif
 167
 168 /* Convert TM to a time_t value, assuming UTC.  */
 169 # if @GNULIB_TIMEGM@
 170 #  if @REPLACE_TIMEGM@
 171 #   if !(defined __cplusplus && defined GNULIB_NAMESPACE)
 172 #    undef timegm
 173 #    define timegm rpl_timegm
 174 #   endif
 175 _GL_FUNCDECL_RPL (timegm, time_t, (struct tm *__tm) _GL_ARG_NONNULL ((1)));
 176 _GL_CXXALIAS_RPL (timegm, time_t, (struct tm *__tm));
 177 #  else
 178 _GL_CXXALIAS_SYS (timegm, time_t, (struct tm *__tm));
 179 #  endif
 180 _GL_CXXALIASWARN (timegm);
 181 # endif
 182
 183 /* Encourage applications to avoid unsafe functions that can overrun
 184    buffers when given outlandish struct tm values.  Portable
 185    applications should use strftime (or even sprintf) instead.  */
 186 # if GNULIB_PORTCHECK
 187 #  undef asctime
 188 #  define asctime eschew_asctime
 189 #  undef asctime_r
 190 #  define asctime_r eschew_asctime_r
 191 #  undef ctime
 192 #  define ctime eschew_ctime
 193 #  undef ctime_r
 194 #  define ctime_r eschew_ctime_r
 195 # endif
 196
 197 #endif