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

/* systime.h - System-dependent definitions for time manipulations.
   Copyright (C) 1992 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 1, 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, 675 Mass Ave, Cambridge, MA 02139, USA.  */

#if defined (HAVE_TIMEVAL) && !defined (NEED_TIME_H)
/* NEED_TIME_H is necessary because some versions of HP/UX shouldn't
   have this included; time.h should do the trick instead.  */

#include <sys/time.h>

#else

/* _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
#include <time.h>
#endif /* _h_BSDTYPES */

#endif

/* AIX needs both <sys/time.h> and <time.h>.  */
#ifdef _AIX
#include <time.h>
#endif

/* SVr4 doesn't actually declare this in its #include files.  */
#ifdef USG5_4
extern long timezone;
#endif

#ifdef VMS
#ifdef VAXC
#include "vmstime.h"
#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 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_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
	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_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_TIME_NEG_P(time)					\
  ((time).tv_sec < 0						\
   || ((time).tv_sec == 0					\
       && (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))

#ifdef USE_UTIME

#define EMACS_SET_UTIMES(path, atime, mtime)			\
  {								\
    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 EAST 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.

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

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

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

   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

/* System V derivatives have a timezone global variable.  */
#if defined(USG) || defined(VMS)
#define EMACS_GET_TZ_OFFSET(offset)					\
  do {									\
    tzset ();								\
    *(offset) = timezone;						\
  } while (0)
#endif

/* If we have timeval, then we have gettimeofday; that's half the battle.  */
#if defined (HAVE_TIMEVAL) && !defined (EMACS_GET_TZ_OFFSET)
#define EMACS_GET_TZ_OFFSET(offset)					\
  do {									\
    struct timeval dummy;						\
    struct timezone zoneinfo;						\
									\
    gettimeofday (&dummy, &zoneinfo);					\
    *(offset) = -zoneinfo.tz_minuteswest;				\
  } 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) || defined (USG) || defined(VMS)

#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) && defined (EMACS_GET_TZ_NAMES)

#define EMACS_CURRENT_TIME_ZONE(offset, savings_flag, standard, savings)\
  do {								       	\
    EMACS_TIME t;							\
    long secs;								\
    struct tm *tmp;							\
									\
    EMACS_GET_TIME (t);							\
    secs = EMACS_SECS (t);						\
    tmp = localtime (&secs);						\
    *(savings_flag) = tmp->tm_isdst;					\
									\
    EMACS_GET_TZ_OFFSET (offset);					\
    EMACS_GET_TZ_NAMES (standard, savings);				\
  } while (0)
#endif /* ! defined (EMACS_GET_TZ_OFFSET) && defined (EMACS_GET_TZ_NAMES) */

#endif /* EMACS_CURRENT_TIME_ZONE */
Commit	Line	Data
10a4cc63	1	/* systime.h - System-dependent definitions for time manipulations.
f469625a JB	2	Copyright (C) 1992 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 1, 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, 675 Mass Ave, Cambridge, MA 02139, USA. */
	19
7b89707c JB	20	#if defined (HAVE_TIMEVAL) && !defined (NEED_TIME_H)
	21	/* NEED_TIME_H is necessary because some versions of HP/UX shouldn't
	22	have this included; time.h should do the trick instead. */
	23
	24	#include <sys/time.h>
	25
	26	#else
	27
f469625a JB	28	/* _h_BSDTYPES is checked because on ISC unix, socket.h includes
	29	both time.h and sys/time.h, and the later file is protected
	30	from repeated inclusion. We just hope that other systems will
	31	use this guard either not at all, or similarly. */
	32	#ifndef _h_BSDTYPES
	33	#include <time.h>
10a4cc63	34	#endif /* _h_BSDTYPES */
b7cceaf1	35
98f77753 JB	36	#endif
98f77753 JB	37
7b89707c JB	38	/* AIX needs both <sys/time.h> and <time.h>. */
	39	#ifdef _AIX
	40	#include <time.h>
b7cceaf1	41	#endif
7b89707c	42
9e70858b JB	43	/* SVr4 doesn't actually declare this in its #include files. */
	44	#ifdef USG5_4
	45	extern long timezone;
	46	#endif
	47
210b2b4f JB	48	#ifdef VMS
	49	#ifdef VAXC
	50	#include "vmstime.h"
	51	#endif
	52	#endif
	53
10a4cc63	54	\f
f469625a JB	55	/* EMACS_TIME is the type to use to represent temporal intervals -
	56	struct timeval on some systems, int on others. It can be passed as
	57	the timeout argument to the select () system call.
	58
	59	EMACS_SECS (TIME) is an rvalue for the seconds component of TIME.
	60	EMACS_SET_SECS (TIME, SECONDS) sets that to SECONDS.
	61
	62	EMACS_HAS_USECS is defined iff EMACS_TIME has a usecs component.
	63	EMACS_USECS (TIME) is an rvalue for the milliseconds component of TIME.
	64	This returns zero if EMACS_TIME doesn't have a milliseconds component.
	65	EMACS_SET_USECS (TIME, MILLISECONDS) sets that to MILLISECONDS.
	66	This does nothing if EMACS_TIME doesn't have a milliseconds component.
	67
	68	EMACS_SET_SECS_USECS (TIME, SECS, USECS) sets both components of TIME.
	69
	70	EMACS_GET_TIME (TIME) stores the current system time in TIME, which
	71	should be an lvalue.
	72	EMACS_SET_UTIMES (PATH, ATIME, MTIME) changes the last-access and
	73	last-modification times of the file named PATH to ATIME and
	74	MTIME, which are EMACS_TIMEs.
	75
	76	EMACS_ADD_TIME (DEST, SRC1, SRC2) adds SRC1 to SRC2 and stores the
	77	result in DEST. SRC should not be negative.
	78
	79	EMACS_SUB_TIME (DEST, SRC1, SRC2) subtracts SRC2 from SRC1 and
	80	stores the result in DEST. SRC should not be negative.
	81	EMACS_TIME_NEG_P (TIME) is true iff TIME is negative.
	82
	83	*/
	84
	85	#ifdef HAVE_TIMEVAL
	86
	87	#define EMACS_TIME struct timeval
	88	#define EMACS_SECS(time) ((time).tv_sec + 0)
	89	#define EMACS_USECS(time) ((time).tv_usec + 0)
	90	#define EMACS_SET_SECS(time, seconds) ((time).tv_sec = (seconds))
	91	#define EMACS_SET_USECS(time, milliseconds) ((time).tv_usec = (milliseconds))
	92
	93	#define EMACS_GET_TIME(time) \
	94	{ \
10a4cc63	95	struct timezone dummy; \
f469625a JB	96	gettimeofday (&(time), &dummy); \
	97	}
	98
	99	#define EMACS_ADD_TIME(dest, src1, src2) \
	100	{ \
	101	(dest).tv_sec = (src1).tv_sec + (src2).tv_sec; \
	102	(dest).tv_usec = (src1).tv_usec + (src2).tv_usec; \
	103	if ((dest).tv_usec > 1000000) \
	104	(dest).tv_usec -= 1000000, (dest).tv_sec++; \
	105	}
	106
	107	#define EMACS_SUB_TIME(dest, src1, src2) \
	108	{ \
	109	(dest).tv_sec = (src1).tv_sec - (src2).tv_sec; \
	110	(dest).tv_usec = (src1).tv_usec - (src2).tv_usec; \
	111	if ((dest).tv_usec < 0) \
	112	(dest).tv_usec += 1000000, (dest).tv_sec--; \
	113	}
	114
	115	#define EMACS_TIME_NEG_P(time) \
	116	((time).tv_sec < 0 \
	117	\|\| ((time).tv_sec == 0 \
	118	&& (time).tv_usec < 0))
	119
10a4cc63	120	#else /* ! defined (HAVE_TIMEVAL) */
f469625a JB	121
	122	#define EMACS_TIME int
	123	#define EMACS_SECS(time) (time)
ef15f270	124	#define EMACS_USECS(time) 0
f469625a	125	#define EMACS_SET_SECS(time, seconds) ((time) = (seconds))
ef15f270	126	#define EMACS_SET_USECS(time, usecs) 0
f469625a JB	127
	128	#define EMACS_GET_TIME(t) ((t) = time ((long *) 0))
	129	#define EMACS_ADD_TIME(dest, src1, src2) ((dest) = (src1) + (src2))
	130	#define EMACS_SUB_TIME(dest, src1, src2) ((dest) = (src1) - (src2))
	131	#define EMACS_TIME_NEG_P(t) ((t) < 0)
	132
10a4cc63	133	#endif /* ! defined (HAVE_TIMEVAL) */
f469625a JB	134
	135	#define EMACS_SET_SECS_USECS(time, secs, usecs) \
	136	(EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs))
	137
	138	#ifdef USE_UTIME
	139
	140	#define EMACS_SET_UTIMES(path, atime, mtime) \
	141	{ \
ef15f270	142	time_t tv[2]; \
f469625a JB	143	tv[0] = EMACS_SECS (atime); \
	144	tv[1] = EMACS_SECS (mtime); \
	145	utime ((path), tv); \
	146	}
	147
10a4cc63	148	#else /* ! defined (USE_UTIME) */
f469625a JB	149
	150	#define EMACS_SET_UTIMES(path, atime, mtime) \
	151	{ \
	152	EMACS_TIME tv[2]; \
	153	tv[0] = atime; \
	154	tv[1] = mtime; \
	155	utimes ((path), tv); \
	156	}
	157
10a4cc63 JB	158	#endif /* ! defined (USE_UTIME) */
	159
	160	\f
	161
	162	/* EMACS_CURRENT_TIME_ZONE (int OFFSET, int SAVINGS_FLAG,
	163	char STANDARD_ABBR, char SAVINGS_ABBR);
	164	expands to a statement which stores information about the current
	165	time zone in its arguments.
	166
b7cceaf1	167	*OFFSET is set to the number of minutes EAST of Greenwich at which
10a4cc63 JB	168	the site's time zone is located. This should describe the offset
	169	to standard time only; if some sort of daylight savings time is in
	170	effect, that should not affect this value. Note that the tm_gmtoff
	171	member of the struct tm returned by localtime is adjusted for
	172	daylight savings, so you don't want to use localtime to set
	173	*OFFSET; gettimeofday does the right thing.
	174
	175	*SAVINGS_FLAG is set to 1 if some sort of daylight savings time is
	176	currently in effect, or 0 if no seasonal adjustment is currently
	177	active.
	178
	179	*STANDARD_ABBR points to an array of at least 10 characters, which
	180	should be set to the standard abbreviation for the time zone name
	181	when daylight savings time is not active. For example, EDT would
	182	be appropriate for the Eastern time zone of the USA.
	183
	184	*SAVINGS_ABBR points to an array of at least 10 characters, which
	185	should be set to the standard abbreviation for the time zone name
	186	when daylight savings time is active. For example, EST would be
	187	appropriate for the Eastern time zone of the USA.
	188
	189	If the operating system cannot provide all this information, then
	190	this macro will not be defined. */
	191
	192
	193	/* The operating system configuration file can define
	194	EMACS_CURRENT_TIME_ZONE. If not, we'll take a shot at it here. */
	195
	196	#ifndef EMACS_CURRENT_TIME_ZONE
	197
98f77753	198	/* System V derivatives have a timezone global variable. */
210b2b4f	199	#if defined(USG) \|\| defined(VMS)
98f77753 JB	200	#define EMACS_GET_TZ_OFFSET(offset) \
	201	do { \
	202	tzset (); \
	203	*(offset) = timezone; \
	204	} while (0)
	205	#endif
	206
10a4cc63	207	/* If we have timeval, then we have gettimeofday; that's half the battle. */
98f77753	208	#if defined (HAVE_TIMEVAL) && !defined (EMACS_GET_TZ_OFFSET)
b7cceaf1	209	#define EMACS_GET_TZ_OFFSET(offset) \
10a4cc63 JB	210	do { \
	211	struct timeval dummy; \
	212	struct timezone zoneinfo; \
	213	\
	214	gettimeofday (&dummy, &zoneinfo); \
b7cceaf1	215	*(offset) = -zoneinfo.tz_minuteswest; \
10a4cc63 JB	216	} while (0)
	217	#endif /* ! defined (HAVE_TIMEVAL) */
	218
10a4cc63 JB	219	/* The following sane systems have a tzname array. The timezone() function
	220	is a stupid idea; timezone names can only be determined geographically,
	221	not by Greenwich offset. */
210b2b4f	222	#if defined (ultrix) \|\| defined (hpux) \|\| defined (_AIX) \|\| defined (USG) \|\| defined(VMS)
10a4cc63 JB	223
	224	#define EMACS_GET_TZ_NAMES(standard, savings) \
	225	do { \
	226	extern char *tzname[2]; \
	227	strcpy ((standard), tzname[0]); \
	228	strcpy ((savings), tzname[1]); \
	229	} while (0)
	230
	231	#else /* ! defined (ultrix) \|\| defined (hpux) \|\| defined (_AIX) */
	232	/* If we are running SunOS, Mt. Xinu BSD, or MACH 2.5, these systems have a
	233	timezone() function. */
	234	#if (defined (hp9000) && ! defined (hpux) && defined (unix)) \|\| defined (MACH) \|\| defined (sun)
	235
	236	#define EMACS_GET_TZ_NAMES(standard, savings) \
	237	do { \
	238	struct timeval dummy; \
	239	struct timezone zoneinfo; \
	240	extern char *timezone (); \
	241	\
	242	gettimeofday (&dummy, &zoneinfo); \
	243	strcpy ((standard), timezone (zoneinfo.tz_minuteswest, 0)); \
	244	strcpy ((savings), timezone (zoneinfo.tz_minuteswest, 1)); \
	245	} while (0)
	246
	247	#endif /* ! (defined (hp9000) && ! defined (hpux) && defined (unix)) \|\| defined (MACH) \|\| defined (sun) */
	248	#endif /* ! defined (ultrix) \|\| defined (hpux) \|\| defined (_AIX) */
	249
	250	/* If we can get all the information we need, let's define the macro! */
b7cceaf1	251	#if defined (EMACS_GET_TZ_OFFSET) && defined (EMACS_GET_TZ_NAMES)
10a4cc63 JB	252
10a4cc63 JB	253	#define EMACS_CURRENT_TIME_ZONE(offset, savings_flag, standard, savings)\
b7cceaf1 JB	254	do { \
	255	EMACS_TIME t; \
	256	long secs; \
	257	struct tm *tmp; \
	258	\
	259	EMACS_GET_TIME (t); \
	260	secs = EMACS_SECS (t); \
	261	tmp = localtime (&secs); \
	262	*(savings_flag) = tmp->tm_isdst; \
	263	\
	264	EMACS_GET_TZ_OFFSET (offset); \
10a4cc63 JB	265	EMACS_GET_TZ_NAMES (standard, savings); \
10a4cc63 JB	266	} while (0)
b7cceaf1	267	#endif /* ! defined (EMACS_GET_TZ_OFFSET) && defined (EMACS_GET_TZ_NAMES) */
10a4cc63 JB	268
10a4cc63 JB	269	#endif /* EMACS_CURRENT_TIME_ZONE */