src/systime.h

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