gl/time_.h

   1 /* A more-standard <time.h>.
   2
   3    Copyright (C) 2007 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 /* Don't get in the way of glibc when it includes time.h merely to
  20    declare a few standard symbols, rather than to declare all the
  21    symbols.  */
  22 #if defined __need_time_t || defined __need_clock_t || defined __need_timespec
  23 # include @ABSOLUTE_TIME_H@
  24
  25 #else
  26 /* Normal invocation convention.  */
  27
  28 # ifdef __DECC
  29 #  include_next <time.h>
  30 # endif
  31
  32 # if ! defined _GL_TIME_H
  33 #  define _GL_TIME_H
  34
  35 #  ifndef __DECC
  36 #   include @ABSOLUTE_TIME_H@
  37 #  endif
  38
  39 #  ifdef __cplusplus
  40 extern "C" {
  41 #  endif
  42
  43 /* Some systems don't define struct timespec (e.g., AIX 4.1, Ultrix 4.3).
  44    Or they define it with the wrong member names or define it in <sys/time.h>
  45    (e.g., FreeBSD circa 1997).  */
  46 #  if ! @TIME_H_DEFINES_STRUCT_TIMESPEC@
  47 #   if @SYS_TIME_H_DEFINES_STRUCT_TIMESPEC@
  48 #    include <sys/time.h>
  49 #   else
  50 #    undef timespec
  51 #    define timespec rpl_timespec
  52 struct timespec
  53 {
  54   time_t tv_sec;
  55   long int tv_nsec;
  56 };
  57 #   endif
  58 #  endif
  59
  60 /* Sleep for at least RQTP seconds unless interrupted,  If interrupted,
  61    return -1 and store the remaining time into RMTP.  See
  62    <http://www.opengroup.org/susv3xsh/nanosleep.html>.  */
  63 #  if @REPLACE_NANOSLEEP@
  64 #   define nanosleep rpl_nanosleep
  65 int nanosleep (struct timespec const *__rqtp, struct timespec *__rmtp);
  66 #  endif
  67
  68 /* Convert TIMER to RESULT, assuming local time and UTC respectively.  See
  69    <http://www.opengroup.org/susv3xsh/localtime_r.html> and
  70    <http://www.opengroup.org/susv3xsh/gmtime_r.html>.  */
  71 #  if @REPLACE_LOCALTIME_R@
  72 #   undef localtime_r
  73 #   define localtime_r rpl_localtime_r
  74 #   undef gmtime_r
  75 #   define gmtime_r rpl_gmtime_r
  76 struct tm *localtime_r (time_t const *restrict __timer,
  77                         struct tm *restrict __result);
  78 struct tm *gmtime_r (time_t const *restrict __timer,
  79                      struct tm *restrict __result);
  80 #  endif
  81
  82 /* Parse BUF as a time stamp, assuming FORMAT specifies its layout, and store
  83    the resulting broken-down time into TM.  See
  84    <http://www.opengroup.org/susv3xsh/strptime.html>.  */
  85 #  if @REPLACE_STRPTIME@
  86 #   undef strptime
  87 #   define strptime rpl_strptime
  88 char *strptime (char const *restrict __buf, char const *restrict __format,
  89                 struct tm *restrict __tm);
  90 #  endif
  91
  92 /* Convert TM to a time_t value, assuming UTC.  */
  93 #  if @REPLACE_TIMEGM@
  94 #   undef timegm
  95 #   define timegm rpl_timegm
  96 time_t timegm (struct tm *__tm);
  97 #  endif
  98
  99 /* Encourage applications to avoid unsafe functions that can overrun
 100    buffers when given outlandish struct tm values.  Portable
 101    applications should use strftime (or even sprintf) instead.  */
 102 #  if GNULIB_PORTCHECK
 103 #   undef asctime
 104 #   define asctime eschew_asctime
 105 #   undef asctime_r
 106 #   define asctime_r eschew_asctime_r
 107 #   undef ctime
 108 #   define ctime eschew_ctime
 109 #   undef ctime_r
 110 #   define ctime_r eschew_ctime_r
 111 #  endif
 112
 113 #  ifdef __cplusplus
 114 }
 115 #  endif
 116
 117 # endif
 118 #endif