src/systime.h

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