src/systime.h

   1 /* systime.h - System-dependent definitions for time manipulations.
   2    Copyright (C) 1993, 1994, 2002, 2003, 2004,
   3                  2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef EMACS_SYSTIME_H
  21 #define EMACS_SYSTIME_H
  22
  23 #ifdef TIME_WITH_SYS_TIME
  24 #include <sys/time.h>
  25 #include <time.h>
  26 #else
  27 #ifdef HAVE_SYS_TIME_H
  28 #include <sys/time.h>
  29 #else
  30 #include <time.h>
  31 #endif
  32 #endif
  33
  34 #ifdef HAVE_TZNAME
  35 #ifndef tzname          /* For SGI.  */
  36 extern char *tzname[];  /* RS6000 and others want it this way.  */
  37 #endif
  38 #endif
  39
  40 /* SVr4 doesn't actually declare this in its #include files.  */
  41 #ifdef USG5_4
  42 extern time_t timezone;
  43 #endif
  44
  45 #ifdef VMS
  46 #ifdef VAXC
  47 #include "vmstime.h"
  48 #endif
  49 #endif
  50
  51 /* On some configurations (hpux8.0, X11R4), sys/time.h and X11/Xos.h
  52    disagree about the name of the guard symbol.  */
  53 #ifdef HPUX
  54 #ifdef _STRUCT_TIMEVAL
  55 #ifndef __TIMEVAL__
  56 #define __TIMEVAL__
  57 #endif
  58 #endif
  59 #endif
  60 \f
  61 /* EMACS_TIME is the type to use to represent temporal intervals -
  62    struct timeval on some systems, int on others.  It can be passed as
  63    the timeout argument to the select  system call.
  64
  65    EMACS_SECS (TIME) is an rvalue for the seconds component of TIME.
  66    EMACS_SET_SECS (TIME, SECONDS) sets that to SECONDS.
  67
  68    EMACS_HAS_USECS is defined if EMACS_TIME has a usecs component.
  69    EMACS_USECS (TIME) is an rvalue for the microseconds component of TIME.
  70         This returns zero if EMACS_TIME doesn't have a microseconds component.
  71    EMACS_SET_USECS (TIME, MICROSECONDS) sets that to MICROSECONDS.
  72         This does nothing if EMACS_TIME doesn't have a microseconds component.
  73
  74    EMACS_SET_SECS_USECS (TIME, SECS, USECS) sets both components of TIME.
  75
  76    EMACS_GET_TIME (TIME) stores the current system time in TIME, which
  77         should be an lvalue.
  78
  79    EMACS_ADD_TIME (DEST, SRC1, SRC2) adds SRC1 to SRC2 and stores the
  80         result in DEST.  SRC should not be negative.
  81
  82    EMACS_SUB_TIME (DEST, SRC1, SRC2) subtracts SRC2 from SRC1 and
  83         stores the result in DEST.  SRC should not be negative.
  84    EMACS_TIME_NEG_P (TIME) is true if TIME is negative.
  85
  86 */
  87
  88 #ifdef HAVE_TIMEVAL
  89
  90 #define EMACS_HAS_USECS
  91
  92 #define EMACS_TIME struct timeval
  93 #define EMACS_SECS(time)                    ((time).tv_sec  + 0)
  94 #define EMACS_USECS(time)                   ((time).tv_usec + 0)
  95 #define EMACS_SET_SECS(time, seconds)       ((time).tv_sec  = (seconds))
  96 #define EMACS_SET_USECS(time, microseconds) ((time).tv_usec = (microseconds))
  97
  98 /* On SVR4, the compiler may complain if given this extra BSD arg.  */
  99 #ifdef GETTIMEOFDAY_ONE_ARGUMENT
 100 #define EMACS_GET_TIME(time) gettimeofday (&(time))
 101 #else /* not GETTIMEOFDAY_ONE_ARGUMENT */
 102 /* Presumably the second arg is ignored.  */
 103 #define EMACS_GET_TIME(time) gettimeofday (&(time), NULL)
 104 #endif /* not GETTIMEOFDAY_ONE_ARGUMENT */
 105
 106 #define EMACS_ADD_TIME(dest, src1, src2)                \
 107   do {                                                  \
 108     (dest).tv_sec  = (src1).tv_sec  + (src2).tv_sec;    \
 109     (dest).tv_usec = (src1).tv_usec + (src2).tv_usec;   \
 110     if ((dest).tv_usec > 1000000)                       \
 111       (dest).tv_usec -= 1000000, (dest).tv_sec++;       \
 112   } while (0)
 113
 114 #define EMACS_SUB_TIME(dest, src1, src2)                \
 115   do {                                                  \
 116     (dest).tv_sec  = (src1).tv_sec  - (src2).tv_sec;    \
 117     (dest).tv_usec = (src1).tv_usec - (src2).tv_usec;   \
 118     if ((dest).tv_usec < 0)                             \
 119       (dest).tv_usec += 1000000, (dest).tv_sec--;       \
 120   } while (0)
 121
 122 #define EMACS_TIME_NEG_P(time)                                  \
 123   ((long)(time).tv_sec < 0                                      \
 124    || ((time).tv_sec == 0                                       \
 125        && (long)(time).tv_usec < 0))
 126
 127 #else /* ! defined (HAVE_TIMEVAL) */
 128
 129 #define EMACS_TIME int
 130 #define EMACS_SECS(time)                    (time)
 131 #define EMACS_USECS(time)                   0
 132 #define EMACS_SET_SECS(time, seconds)       ((time) = (seconds))
 133 #define EMACS_SET_USECS(time, usecs)        0
 134
 135 #define EMACS_GET_TIME(t) ((t) = time ((long *) 0))
 136 #define EMACS_ADD_TIME(dest, src1, src2) ((dest) = (src1) + (src2))
 137 #define EMACS_SUB_TIME(dest, src1, src2) ((dest) = (src1) - (src2))
 138 #define EMACS_TIME_NEG_P(t) ((t) < 0)
 139
 140 #endif /* ! defined (HAVE_TIMEVAL) */
 141
 142 #define EMACS_SET_SECS_USECS(time, secs, usecs)                 \
 143   (EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs))
 144
 145 extern int set_file_times __P ((const char *, EMACS_TIME, EMACS_TIME));
 146
 147 /* defined in keyboard.c */
 148 extern void set_waiting_for_input __P ((EMACS_TIME *));
 149
 150 /* When lisp.h is not included Lisp_Object is not defined (this can
 151    happen when this files is used outside the src directory).
 152    Use GCPRO1 to determine if lisp.h was included.  */
 153 #ifdef GCPRO1
 154 /* defined in dired.c */
 155 extern Lisp_Object make_time __P ((time_t));
 156 #endif
 157
 158 /* Compare times T1 and T2.  Value is 0 if T1 and T2 are the same.
 159    Value is < 0 if T1 is less than T2.  Value is > 0 otherwise.  */
 160
 161 #define EMACS_TIME_CMP(T1, T2)                  \
 162   (EMACS_SECS (T1) - EMACS_SECS (T2)            \
 163    + (EMACS_SECS (T1) == EMACS_SECS (T2)        \
 164       ? EMACS_USECS (T1) - EMACS_USECS (T2)     \
 165       : 0))
 166
 167 /* Compare times T1 and T2 for equality, inequality etc.  */
 168
 169 #define EMACS_TIME_EQ(T1, T2) (EMACS_TIME_CMP (T1, T2) == 0)
 170 #define EMACS_TIME_NE(T1, T2) (EMACS_TIME_CMP (T1, T2) != 0)
 171 #define EMACS_TIME_GT(T1, T2) (EMACS_TIME_CMP (T1, T2) > 0)
 172 #define EMACS_TIME_GE(T1, T2) (EMACS_TIME_CMP (T1, T2) >= 0)
 173 #define EMACS_TIME_LT(T1, T2) (EMACS_TIME_CMP (T1, T2) < 0)
 174 #define EMACS_TIME_LE(T1, T2) (EMACS_TIME_CMP (T1, T2) <= 0)
 175
 176 #endif /* EMACS_SYSTIME_H */
 177
 178 /* arch-tag: dcb79915-cf99-4bce-9778-aade71d07651
 179    (do not change this comment) */