src/systime.h

/* systime.h - System-dependent definitions for time manipulations.
   Copyright (C) 1993, 1994 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
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,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
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
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */

#ifndef EMACS_SYSTIME_H
#define EMACS_SYSTIME_H

#ifdef TIME_WITH_SYS_TIME
#include <sys/time.h>
#include <time.h>
#else
#ifdef HAVE_SYS_TIME_H
#include <sys/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
   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_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_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.
   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_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)					\
  ((long)(time).tv_sec < 0					\
   || ((time).tv_sec == 0					\
       && (long)(time).tv_usec < 0))

#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_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_SUB_TIME(dest, src1, src2) ((dest) = (src1) - (src2))
#define EMACS_TIME_NEG_P(t) ((t) < 0)

#endif /* ! defined (HAVE_TIMEVAL) */

#define EMACS_SET_SECS_USECS(time, secs, usecs) 		\
  (EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs))

extern int set_file_times __P ((const char *, EMACS_TIME, EMACS_TIME));

/* 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.  */

#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))

/* Compare times T1 and T2 for equality, inequality etc.  */

#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 /* EMACS_SYSTIME_H */

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