[bpt/emacs.git] / src / systime.h

/* systime.h - System-dependent definitions for time manipulations.
   Copyright (C) 1993-1994, 2002-2011 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 3 of the License, 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.  If not, see <http://www.gnu.org/licenses/>.  */

#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_X_WINDOWS
# include <X11/X.h>
#else
typedef unsigned long Time;
#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

/* 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 if 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 if 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 */
/* Presumably the second arg is ignored.  */
#define EMACS_GET_TIME(time) gettimeofday (&(time), NULL)
#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 (const char *, EMACS_TIME, EMACS_TIME);

/* defined in keyboard.c */
extern void set_waiting_for_input (EMACS_TIME *);

/* When lisp.h is not included Lisp_Object is not defined (this can
   happen when this files is used outside the src directory).
   Use GCPRO1 to determine if lisp.h was included.  */
#ifdef GCPRO1
/* defined in editfns.c*/
extern Lisp_Object make_time (time_t);
extern int lisp_time_argument (Lisp_Object, time_t *, int *);
#endif

/* 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.  (Cast
   to long is for those platforms where time_t is an unsigned
   type, and where otherwise T1 will always be grater than T2.)  */

#define EMACS_TIME_CMP(T1, T2)				\
  ((long)EMACS_SECS (T1) - (long)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 */
Commit	Line	Data
10a4cc63	1	/* systime.h - System-dependent definitions for time manipulations.
73b0cd50	2	Copyright (C) 1993-1994, 2002-2011 Free Software Foundation, Inc.
f469625a JB	3
	4	This file is part of GNU Emacs.
	5
b9b1cc14	6	GNU Emacs is free software: you can redistribute it and/or modify
f469625a	7	it under the terms of the GNU General Public License as published by
b9b1cc14 GM	8	the Free Software Foundation, either version 3 of the License, or
b9b1cc14 GM	9	(at your option) any later version.
f469625a JB	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
b9b1cc14	17	along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
f469625a	18
fb1b041d DL	19	#ifndef EMACS_SYSTIME_H
fb1b041d DL	20	#define EMACS_SYSTIME_H
482fa053	21
d712c26d	22	#ifdef TIME_WITH_SYS_TIME
7b89707c	23	#include <sys/time.h>
f469625a	24	#include <time.h>
d712c26d	25	#else
5cbdb356 JB	26	#ifdef HAVE_SYS_TIME_H
5cbdb356 JB	27	#include <sys/time.h>
d712c26d JB	28	#else
d712c26d JB	29	#include <time.h>
98f77753	30	#endif
b7cceaf1	31	#endif
7b89707c	32
08dc5ae6 PE	33	#ifdef HAVE_X_WINDOWS
	34	# include <X11/X.h>
	35	#else
	36	typedef unsigned long Time;
	37	#endif
	38
2ffe7ef2 RS	39	#ifdef HAVE_TZNAME
	40	#ifndef tzname /* For SGI. */
	41	extern char tzname[]; / RS6000 and others want it this way. */
	42	#endif
	43	#endif
	44
9e70858b JB	45	/* SVr4 doesn't actually declare this in its #include files. */
9e70858b JB	46	#ifdef USG5_4
482fa053	47	extern time_t timezone;
9e70858b JB	48	#endif
9e70858b JB	49
71068d78 KH	50	/* On some configurations (hpux8.0, X11R4), sys/time.h and X11/Xos.h
71068d78 KH	51	disagree about the name of the guard symbol. */
c810639a	52	#ifdef HPUX
71068d78 KH	53	#ifdef _STRUCT_TIMEVAL
	54	#ifndef __TIMEVAL__
	55	#define __TIMEVAL__
	56	#endif
	57	#endif
c810639a	58	#endif
10a4cc63	59	\f
f469625a JB	60	/* EMACS_TIME is the type to use to represent temporal intervals -
f469625a JB	61	struct timeval on some systems, int on others. It can be passed as
88729235	62	the timeout argument to the select system call.
f469625a JB	63
	64	EMACS_SECS (TIME) is an rvalue for the seconds component of TIME.
	65	EMACS_SET_SECS (TIME, SECONDS) sets that to SECONDS.
	66
e0f24100	67	EMACS_HAS_USECS is defined if EMACS_TIME has a usecs component.
7f86bdac JB	68	EMACS_USECS (TIME) is an rvalue for the microseconds component of TIME.
	69	This returns zero if EMACS_TIME doesn't have a microseconds component.
	70	EMACS_SET_USECS (TIME, MICROSECONDS) sets that to MICROSECONDS.
	71	This does nothing if EMACS_TIME doesn't have a microseconds component.
f469625a JB	72
	73	EMACS_SET_SECS_USECS (TIME, SECS, USECS) sets both components of TIME.
	74
	75	EMACS_GET_TIME (TIME) stores the current system time in TIME, which
	76	should be an lvalue.
f469625a JB	77
	78	EMACS_ADD_TIME (DEST, SRC1, SRC2) adds SRC1 to SRC2 and stores the
	79	result in DEST. SRC should not be negative.
	80
	81	EMACS_SUB_TIME (DEST, SRC1, SRC2) subtracts SRC2 from SRC1 and
177c0ea7	82	stores the result in DEST. SRC should not be negative.
e0f24100	83	EMACS_TIME_NEG_P (TIME) is true if TIME is negative.
f469625a JB	84
	85	*/
	86
	87	#ifdef HAVE_TIMEVAL
	88
722687f5 JB	89	#define EMACS_HAS_USECS
722687f5 JB	90
f469625a JB	91	#define EMACS_TIME struct timeval
	92	#define EMACS_SECS(time) ((time).tv_sec + 0)
	93	#define EMACS_USECS(time) ((time).tv_usec + 0)
	94	#define EMACS_SET_SECS(time, seconds) ((time).tv_sec = (seconds))
7f86bdac	95	#define EMACS_SET_USECS(time, microseconds) ((time).tv_usec = (microseconds))
f469625a	96
4fb83f3c	97	/* On SVR4, the compiler may complain if given this extra BSD arg. */
af57e5a7	98	#ifdef GETTIMEOFDAY_ONE_ARGUMENT
f9ee84a3	99	#define EMACS_GET_TIME(time) gettimeofday (&(time))
af57e5a7	100	#else /* not GETTIMEOFDAY_ONE_ARGUMENT */
97dfd1a1 DL	101	/* Presumably the second arg is ignored. */
97dfd1a1 DL	102	#define EMACS_GET_TIME(time) gettimeofday (&(time), NULL)
af57e5a7	103	#endif /* not GETTIMEOFDAY_ONE_ARGUMENT */
f469625a	104
f9ee84a3 GM	105	#define EMACS_ADD_TIME(dest, src1, src2) \
	106	do { \
	107	(dest).tv_sec = (src1).tv_sec + (src2).tv_sec; \
	108	(dest).tv_usec = (src1).tv_usec + (src2).tv_usec; \
	109	if ((dest).tv_usec > 1000000) \
	110	(dest).tv_usec -= 1000000, (dest).tv_sec++; \
	111	} while (0)
	112
	113	#define EMACS_SUB_TIME(dest, src1, src2) \
	114	do { \
	115	(dest).tv_sec = (src1).tv_sec - (src2).tv_sec; \
	116	(dest).tv_usec = (src1).tv_usec - (src2).tv_usec; \
	117	if ((dest).tv_usec < 0) \
	118	(dest).tv_usec += 1000000, (dest).tv_sec--; \
	119	} while (0)
f469625a JB	120
f469625a JB	121	#define EMACS_TIME_NEG_P(time) \
cf4138ad	122	((long)(time).tv_sec < 0 \
f469625a	123	\|\| ((time).tv_sec == 0 \
cf4138ad	124	&& (long)(time).tv_usec < 0))
f469625a	125
10a4cc63	126	#else /* ! defined (HAVE_TIMEVAL) */
f469625a JB	127
	128	#define EMACS_TIME int
	129	#define EMACS_SECS(time) (time)
ef15f270	130	#define EMACS_USECS(time) 0
f469625a	131	#define EMACS_SET_SECS(time, seconds) ((time) = (seconds))
ef15f270	132	#define EMACS_SET_USECS(time, usecs) 0
f469625a JB	133
	134	#define EMACS_GET_TIME(t) ((t) = time ((long *) 0))
	135	#define EMACS_ADD_TIME(dest, src1, src2) ((dest) = (src1) + (src2))
	136	#define EMACS_SUB_TIME(dest, src1, src2) ((dest) = (src1) - (src2))
	137	#define EMACS_TIME_NEG_P(t) ((t) < 0)
	138
10a4cc63	139	#endif /* ! defined (HAVE_TIMEVAL) */
f469625a JB	140
	141	#define EMACS_SET_SECS_USECS(time, secs, usecs) \
	142	(EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs))
	143
383e0970	144	extern int set_file_times (const char *, EMACS_TIME, EMACS_TIME);
c53a6701	145
43f15d4a	146	/* defined in keyboard.c */
383e0970	147	extern void set_waiting_for_input (EMACS_TIME *);
43f15d4a	148
fa8459a3 DN	149	/* When lisp.h is not included Lisp_Object is not defined (this can
	150	happen when this files is used outside the src directory).
	151	Use GCPRO1 to determine if lisp.h was included. */
	152	#ifdef GCPRO1
26469a38	153	/* defined in editfns.c*/
8be6f318	154	extern Lisp_Object make_time (time_t);
26469a38	155	extern int lisp_time_argument (Lisp_Object, time_t , int );
fa8459a3 DN	156	#endif
fa8459a3 DN	157
c53a6701	158	/* Compare times T1 and T2. Value is 0 if T1 and T2 are the same.
12c01aef EZ	159	Value is < 0 if T1 is less than T2. Value is > 0 otherwise. (Cast
	160	to long is for those platforms where time_t is an unsigned
	161	type, and where otherwise T1 will always be grater than T2.) */
	162
	163	#define EMACS_TIME_CMP(T1, T2) \
	164	((long)EMACS_SECS (T1) - (long)EMACS_SECS (T2) \
	165	+ (EMACS_SECS (T1) == EMACS_SECS (T2) \
	166	? EMACS_USECS (T1) - EMACS_USECS (T2) \
c53a6701 GM	167	: 0))
	168
	169	/* Compare times T1 and T2 for equality, inequality etc. */
	170
27a9e9b3 GM	171	#define EMACS_TIME_EQ(T1, T2) (EMACS_TIME_CMP (T1, T2) == 0)
	172	#define EMACS_TIME_NE(T1, T2) (EMACS_TIME_CMP (T1, T2) != 0)
	173	#define EMACS_TIME_GT(T1, T2) (EMACS_TIME_CMP (T1, T2) > 0)
	174	#define EMACS_TIME_GE(T1, T2) (EMACS_TIME_CMP (T1, T2) >= 0)
	175	#define EMACS_TIME_LT(T1, T2) (EMACS_TIME_CMP (T1, T2) < 0)
	176	#define EMACS_TIME_LE(T1, T2) (EMACS_TIME_CMP (T1, T2) <= 0)
c53a6701	177
fb1b041d	178	#endif /* EMACS_SYSTIME_H */