]> code.delx.au - gnu-emacs/blobdiff - src/systime.h
(nnmail-extra-headers): Add defvar.
[gnu-emacs] / src / systime.h
index b5a850da1dc2100c2ccab7f3285ffe7c32ca4c4c..12d8d406d8eff53f6c38a92aadfc103633babaa3 100644 (file)
@@ -1,11 +1,12 @@
 /* systime.h - System-dependent definitions for time manipulations.
 /* systime.h - System-dependent definitions for time manipulations.
-   Copyright (C) 1992 Free Software Foundation, Inc.
+   Copyright (C) 1993, 1994, 2002, 2003, 2004,
+                 2005 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
 GNU Emacs is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 
 This file is part of GNU Emacs.
 
 GNU Emacs is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 1, or (at your option)
+the Free Software Foundation; either version 2, or (at your option)
 any later version.
 
 GNU Emacs is distributed in the hope that it will be useful,
 any later version.
 
 GNU Emacs is distributed in the hope that it will be useful,
@@ -15,94 +16,131 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with GNU Emacs; see the file COPYING.  If not, write to
 
 You should have received a copy of the GNU General Public License
 along with GNU Emacs; see the file COPYING.  If not, write to
-the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
+the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.  */
 
 
-#ifdef NEED_TIME_H
+#ifndef EMACS_SYSTIME_H
+#define EMACS_SYSTIME_H
 
 
-/* _h_BSDTYPES is checked because on ISC unix, socket.h includes
-   both time.h and sys/time.h, and the later file is protected
-   from repeated inclusion.  We just hope that other systems will
-   use this guard either not at all, or similarly.  */
-#ifndef _h_BSDTYPES
+#ifdef TIME_WITH_SYS_TIME
+#include <sys/time.h>
 #include <time.h>
 #include <time.h>
-#endif /* _h_BSDTYPES */
-#else /* ! defined (NEED_TIME_H) */
-#ifdef HAVE_TIMEVAL
+#else
+#ifdef HAVE_SYS_TIME_H
 #include <sys/time.h>
 #include <sys/time.h>
-#endif /* ! defined (HAVE_TIMEVAL) */
-#endif /* ! defined (NEED_TIME_H) */
-
+#else
+#include <time.h>
+#endif
+#endif
+
+#ifdef HAVE_TZNAME
+#ifndef tzname         /* For SGI.  */
+extern char *tzname[]; /* RS6000 and others want it this way.  */
+#endif
+#endif
+
+/* SVr4 doesn't actually declare this in its #include files.  */
+#ifdef USG5_4
+extern time_t timezone;
+#endif
+
+#ifdef VMS
+#ifdef VAXC
+#include "vmstime.h"
+#endif
+#endif
+
+/* On some configurations (hpux8.0, X11R4), sys/time.h and X11/Xos.h
+   disagree about the name of the guard symbol.  */
+#ifdef HPUX
+#ifdef _STRUCT_TIMEVAL
+#ifndef __TIMEVAL__
+#define __TIMEVAL__
+#endif
+#endif
+#endif
 \f
 /* EMACS_TIME is the type to use to represent temporal intervals -
    struct timeval on some systems, int on others.  It can be passed as
 \f
 /* EMACS_TIME is the type to use to represent temporal intervals -
    struct timeval on some systems, int on others.  It can be passed as
-   the timeout argument to the select () system call.
+   the timeout argument to the select  system call.
 
    EMACS_SECS (TIME) is an rvalue for the seconds component of TIME.
    EMACS_SET_SECS (TIME, SECONDS) sets that to SECONDS.
 
    EMACS_HAS_USECS is defined iff EMACS_TIME has a usecs component.
 
    EMACS_SECS (TIME) is an rvalue for the seconds component of TIME.
    EMACS_SET_SECS (TIME, SECONDS) sets that to SECONDS.
 
    EMACS_HAS_USECS is defined iff EMACS_TIME has a usecs component.
-   EMACS_USECS (TIME) is an rvalue for the milliseconds component of TIME.
-       This returns zero if EMACS_TIME doesn't have a milliseconds component.
-   EMACS_SET_USECS (TIME, MILLISECONDS) sets that to MILLISECONDS.
-       This does nothing if EMACS_TIME doesn't have a milliseconds component.
+   EMACS_USECS (TIME) is an rvalue for the microseconds component of TIME.
+       This returns zero if EMACS_TIME doesn't have a microseconds component.
+   EMACS_SET_USECS (TIME, MICROSECONDS) sets that to MICROSECONDS.
+       This does nothing if EMACS_TIME doesn't have a microseconds component.
 
    EMACS_SET_SECS_USECS (TIME, SECS, USECS) sets both components of TIME.
 
    EMACS_GET_TIME (TIME) stores the current system time in TIME, which
        should be an lvalue.
 
    EMACS_SET_SECS_USECS (TIME, SECS, USECS) sets both components of TIME.
 
    EMACS_GET_TIME (TIME) stores the current system time in TIME, which
        should be an lvalue.
-   EMACS_SET_UTIMES (PATH, ATIME, MTIME) changes the last-access and
-       last-modification times of the file named PATH to ATIME and
-       MTIME, which are EMACS_TIMEs.
 
    EMACS_ADD_TIME (DEST, SRC1, SRC2) adds SRC1 to SRC2 and stores the
        result in DEST.  SRC should not be negative.
 
    EMACS_SUB_TIME (DEST, SRC1, SRC2) subtracts SRC2 from SRC1 and
 
    EMACS_ADD_TIME (DEST, SRC1, SRC2) adds SRC1 to SRC2 and stores the
        result in DEST.  SRC should not be negative.
 
    EMACS_SUB_TIME (DEST, SRC1, SRC2) subtracts SRC2 from SRC1 and
-       stores the result in DEST.  SRC should not be negative. 
+       stores the result in DEST.  SRC should not be negative.
    EMACS_TIME_NEG_P (TIME) is true iff TIME is negative.
 
 */
 
 #ifdef HAVE_TIMEVAL
 
    EMACS_TIME_NEG_P (TIME) is true iff TIME is negative.
 
 */
 
 #ifdef HAVE_TIMEVAL
 
+#define EMACS_HAS_USECS
+
 #define EMACS_TIME struct timeval
 #define EMACS_SECS(time)                   ((time).tv_sec  + 0)
 #define EMACS_USECS(time)                  ((time).tv_usec + 0)
 #define EMACS_SET_SECS(time, seconds)      ((time).tv_sec  = (seconds))
 #define EMACS_TIME struct timeval
 #define EMACS_SECS(time)                   ((time).tv_sec  + 0)
 #define EMACS_USECS(time)                  ((time).tv_usec + 0)
 #define EMACS_SET_SECS(time, seconds)      ((time).tv_sec  = (seconds))
-#define EMACS_SET_USECS(time, milliseconds) ((time).tv_usec = (milliseconds))
-
-#define EMACS_GET_TIME(time)                                   \
-{                                                              \
-  struct timezone dummy;                                       \
-  gettimeofday (&(time), &dummy);                              \
-}
-
-#define EMACS_ADD_TIME(dest, src1, src2)                       \
-{                                                              \
-  (dest).tv_sec  = (src1).tv_sec  + (src2).tv_sec;             \
-  (dest).tv_usec = (src1).tv_usec + (src2).tv_usec;            \
-  if ((dest).tv_usec > 1000000)                                        \
-    (dest).tv_usec -= 1000000, (dest).tv_sec++;                        \
-}
-
-#define EMACS_SUB_TIME(dest, src1, src2)                       \
-{                                                              \
-  (dest).tv_sec  = (src1).tv_sec  - (src2).tv_sec;             \
-  (dest).tv_usec = (src1).tv_usec - (src2).tv_usec;            \
-  if ((dest).tv_usec < 0)                                      \
-    (dest).tv_usec += 1000000, (dest).tv_sec--;                        \
-}
+#define EMACS_SET_USECS(time, microseconds) ((time).tv_usec = (microseconds))
+
+/* On SVR4, the compiler may complain if given this extra BSD arg.  */
+#ifdef GETTIMEOFDAY_ONE_ARGUMENT
+#define EMACS_GET_TIME(time) gettimeofday (&(time))
+#else /* not GETTIMEOFDAY_ONE_ARGUMENT */
+#ifdef HAVE_STRUCT_TIMEZONE
+#define EMACS_GET_TIME(time)                   \
+  do {                                         \
+    struct timezone dummy;                     \
+    gettimeofday (&(time), &dummy);            \
+  } while (0)
+#else
+/* Presumably the second arg is ignored.  */
+#define EMACS_GET_TIME(time) gettimeofday (&(time), NULL)
+#endif /* HAVE_STRUCT_TIMEZONE */
+#endif /* not GETTIMEOFDAY_ONE_ARGUMENT */
+
+#define EMACS_ADD_TIME(dest, src1, src2)               \
+  do {                                                 \
+    (dest).tv_sec  = (src1).tv_sec  + (src2).tv_sec;   \
+    (dest).tv_usec = (src1).tv_usec + (src2).tv_usec;  \
+    if ((dest).tv_usec > 1000000)                      \
+      (dest).tv_usec -= 1000000, (dest).tv_sec++;      \
+  } while (0)
+
+#define EMACS_SUB_TIME(dest, src1, src2)               \
+  do {                                                 \
+    (dest).tv_sec  = (src1).tv_sec  - (src2).tv_sec;   \
+    (dest).tv_usec = (src1).tv_usec - (src2).tv_usec;  \
+    if ((dest).tv_usec < 0)                            \
+      (dest).tv_usec += 1000000, (dest).tv_sec--;      \
+  } while (0)
 
 #define EMACS_TIME_NEG_P(time)                                 \
 
 #define EMACS_TIME_NEG_P(time)                                 \
-  ((time).tv_sec < 0                                           \
+  ((long)(time).tv_sec < 0                                     \
    || ((time).tv_sec == 0                                      \
    || ((time).tv_sec == 0                                      \
-       && (time).tv_usec < 0))
+       && (long)(time).tv_usec < 0))
 
 #else /* ! defined (HAVE_TIMEVAL) */
 
 #define EMACS_TIME int
 #define EMACS_SECS(time)                   (time)
 
 #else /* ! defined (HAVE_TIMEVAL) */
 
 #define EMACS_TIME int
 #define EMACS_SECS(time)                   (time)
+#define EMACS_USECS(time)                  0
 #define EMACS_SET_SECS(time, seconds)      ((time) = (seconds))
 #define EMACS_SET_SECS(time, seconds)      ((time) = (seconds))
+#define EMACS_SET_USECS(time, usecs)       0
 
 #define EMACS_GET_TIME(t) ((t) = time ((long *) 0))
 #define EMACS_ADD_TIME(dest, src1, src2) ((dest) = (src1) + (src2))
 
 #define EMACS_GET_TIME(t) ((t) = time ((long *) 0))
 #define EMACS_ADD_TIME(dest, src1, src2) ((dest) = (src1) + (src2))
@@ -114,120 +152,27 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #define EMACS_SET_SECS_USECS(time, secs, usecs)                \
   (EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs))
 
 #define EMACS_SET_SECS_USECS(time, secs, usecs)                \
   (EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs))
 
-#ifdef USE_UTIME
-
-#define EMACS_SET_UTIMES(path, atime, mtime)                   \
-  {                                                            \
-    struct time_t tv[2];                                       \
-    tv[0] = EMACS_SECS (atime);                                        \
-    tv[1] = EMACS_SECS (mtime);                                        \
-    utime ((path), tv);                                                \
-  }
-
-#else /* ! defined (USE_UTIME) */
-
-#define EMACS_SET_UTIMES(path, atime, mtime)                   \
-  {                                                            \
-    EMACS_TIME tv[2];                                          \
-    tv[0] = atime;                                             \
-    tv[1] = mtime;                                             \
-    utimes ((path), tv);                                       \
-  }
-
-#endif /* ! defined (USE_UTIME) */
-
-\f
-
-/* EMACS_CURRENT_TIME_ZONE (int *OFFSET, int *SAVINGS_FLAG,
-                            char *STANDARD_ABBR, char *SAVINGS_ABBR);
-   expands to a statement which stores information about the current
-   time zone in its arguments.
-
-   *OFFSET is set to the number of minutes west of Greenwich at which
-   the site's time zone is located.  This should describe the offset
-   to standard time only; if some sort of daylight savings time is in
-   effect, that should not affect this value.  Note that the tm_gmtoff
-   member of the struct tm returned by localtime is adjusted for
-   daylight savings, so you don't want to use localtime to set
-   *OFFSET; gettimeofday does the right thing.
+extern int set_file_times __P ((const char *, EMACS_TIME, EMACS_TIME));
 
 
-   *SAVINGS_FLAG is set to 1 if some sort of daylight savings time is
-   currently in effect, or 0 if no seasonal adjustment is currently
-   active.
+/* Compare times T1 and T2.  Value is 0 if T1 and T2 are the same.
+   Value is < 0 if T1 is less than T2.  Value is > 0 otherwise.  */
 
 
-   *STANDARD_ABBR points to an array of at least 10 characters, which
-   should be set to the standard abbreviation for the time zone name
-   when daylight savings time is not active.  For example, EDT would
-   be appropriate for the Eastern time zone of the USA.
+#define EMACS_TIME_CMP(T1, T2)                 \
+  (EMACS_SECS (T1) - EMACS_SECS (T2)           \
+   + (EMACS_SECS (T1) == EMACS_SECS (T2)       \
+      ? EMACS_USECS (T1) - EMACS_USECS (T2)    \
+      : 0))
 
 
-   *SAVINGS_ABBR points to an array of at least 10 characters, which
-   should be set to the standard abbreviation for the time zone name
-   when daylight savings time is active.  For example, EST would be
-   appropriate for the Eastern time zone of the USA.
+/* Compare times T1 and T2 for equality, inequality etc.  */
 
 
-   If the operating system cannot provide all this information, then
-   this macro will not be defined.  */
-
-
-/* The operating system configuration file can define
-   EMACS_CURRENT_TIME_ZONE.   If not, we'll take a shot at it here.  */
-
-#ifndef EMACS_CURRENT_TIME_ZONE
-
-/* If we have timeval, then we have gettimeofday; that's half the battle.  */
-#ifdef HAVE_TIMEVAL
-#define EMACS_GET_TZ_OFFSET_AND_SAVINGS(offset, savings_flag)          \
-  do {                                                                 \
-    struct timeval dummy;                                              \
-    struct timezone zoneinfo;                                          \
-                                                                       \
-    gettimeofday (&dummy, &zoneinfo);                                  \
-    *(offset) = zoneinfo.tz_minuteswest;                               \
-    *(savings_flag) = zoneinfo.tz_dsttime;                             \
-  } while (0)
-#endif /* ! defined (HAVE_TIMEVAL) */
-
-
-/* The following sane systems have a tzname array.  The timezone() function
-   is a stupid idea; timezone names can only be determined geographically,
-   not by Greenwich offset.  */
-#if defined (ultrix) || defined (hpux) || defined (_AIX)
-
-#define EMACS_GET_TZ_NAMES(standard, savings)                          \
-  do {                                                                 \
-    extern char *tzname[2];                                            \
-    strcpy ((standard), tzname[0]);                                    \
-    strcpy ((savings), tzname[1]);                                     \
-  } while (0)
-
-#else /* ! defined (ultrix) || defined (hpux) || defined (_AIX) */
-/* If we are running SunOS, Mt. Xinu BSD, or MACH 2.5, these systems have a
-   timezone() function.  */
-#if (defined (hp9000) && ! defined (hpux) && defined (unix)) || defined (MACH) || defined (sun)
-
-#define EMACS_GET_TZ_NAMES(standard, savings)                          \
-  do {                                                                 \
-    struct timeval dummy;                                              \
-    struct timezone zoneinfo;                                          \
-    extern char *timezone ();                                          \
-                                                                       \
-    gettimeofday (&dummy, &zoneinfo);                                  \
-    strcpy ((standard), timezone (zoneinfo.tz_minuteswest, 0));                \
-    strcpy ((savings),  timezone (zoneinfo.tz_minuteswest, 1));                \
-  } while (0)
-
-#endif /* ! (defined (hp9000) && ! defined (hpux) && defined (unix)) || defined (MACH) || defined (sun) */
-#endif /* ! defined (ultrix) || defined (hpux) || defined (_AIX) */
-
-/* If we can get all the information we need, let's define the macro!  */
-#if defined (EMACS_GET_TZ_OFFSET_AND_SAVINGS) && defined (EMACS_GET_TZ_NAMES)
-
-#define EMACS_CURRENT_TIME_ZONE(offset, savings_flag, standard, savings)\
-  do {                                                                 \
-    EMACS_GET_TZ_OFFSET_AND_SAVINGS (offset, savings_flag);            \
-    EMACS_GET_TZ_NAMES (standard, savings);                            \
-  } while (0)
+#define EMACS_TIME_EQ(T1, T2) (EMACS_TIME_CMP (T1, T2) == 0)
+#define EMACS_TIME_NE(T1, T2) (EMACS_TIME_CMP (T1, T2) != 0)
+#define EMACS_TIME_GT(T1, T2) (EMACS_TIME_CMP (T1, T2) > 0)
+#define EMACS_TIME_GE(T1, T2) (EMACS_TIME_CMP (T1, T2) >= 0)
+#define EMACS_TIME_LT(T1, T2) (EMACS_TIME_CMP (T1, T2) < 0)
+#define EMACS_TIME_LE(T1, T2) (EMACS_TIME_CMP (T1, T2) <= 0)
 
 
-#endif /* ! defined (EMACS_GET_TZ_OFFSET_AND_SAVINGS) && defined (EMACS_GET_TZ_NAMES) */
+#endif /* EMACS_SYSTIME_H */
 
 
-#endif /* EMACS_CURRENT_TIME_ZONE */
+/* arch-tag: dcb79915-cf99-4bce-9778-aade71d07651
+   (do not change this comment) */