]>
code.delx.au - gnu-emacs/blob - src/systime.h
1 /* systime.h - System-dependent definitions for time manipulations.
2 Copyright (C) 1993-1994, 2002-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
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 3 of the License, or
9 (at your option) any later version.
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.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19 #ifndef EMACS_SYSTIME_H
20 #define EMACS_SYSTIME_H
22 #ifdef TIME_WITH_SYS_TIME
26 #ifdef HAVE_SYS_TIME_H
36 typedef unsigned long Time
;
40 #ifndef tzname /* For SGI. */
41 extern char *tzname
[]; /* RS6000 and others want it this way. */
45 /* SVr4 doesn't actually declare this in its #include files. */
47 extern time_t timezone
;
50 /* On some configurations (hpux8.0, X11R4), sys/time.h and X11/Xos.h
51 disagree about the name of the guard symbol. */
53 #ifdef _STRUCT_TIMEVAL
60 /* EMACS_TIME is the type to use to represent temporal intervals -
61 struct timeval on some systems, int on others. It can be passed as
62 the timeout argument to the select system call.
64 EMACS_SECS (TIME) is an rvalue for the seconds component of TIME.
65 EMACS_SET_SECS (TIME, SECONDS) sets that to SECONDS.
67 EMACS_HAS_USECS is defined if EMACS_TIME has a usecs component.
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.
73 EMACS_SET_SECS_USECS (TIME, SECS, USECS) sets both components of TIME.
75 EMACS_GET_TIME (TIME) stores the current system time in TIME, which
78 EMACS_ADD_TIME (DEST, SRC1, SRC2) adds SRC1 to SRC2 and stores the
79 result in DEST. SRC should not be negative.
81 EMACS_SUB_TIME (DEST, SRC1, SRC2) subtracts SRC2 from SRC1 and
82 stores the result in DEST. SRC should not be negative.
83 EMACS_TIME_NEG_P (TIME) is true if TIME is negative.
89 #define EMACS_HAS_USECS
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))
95 #define EMACS_SET_USECS(time, microseconds) ((time).tv_usec = (microseconds))
97 /* On SVR4, the compiler may complain if given this extra BSD arg. */
98 #ifdef GETTIMEOFDAY_ONE_ARGUMENT
99 #define EMACS_GET_TIME(time) gettimeofday (&(time))
100 #else /* not GETTIMEOFDAY_ONE_ARGUMENT */
101 /* Presumably the second arg is ignored. */
102 #define EMACS_GET_TIME(time) gettimeofday (&(time), NULL)
103 #endif /* not GETTIMEOFDAY_ONE_ARGUMENT */
105 #define EMACS_ADD_TIME(dest, src1, src2) \
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++; \
113 #define EMACS_SUB_TIME(dest, src1, src2) \
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--; \
121 #define EMACS_TIME_NEG_P(time) \
122 ((long)(time).tv_sec < 0 \
123 || ((time).tv_sec == 0 \
124 && (long)(time).tv_usec < 0))
126 #else /* ! defined (HAVE_TIMEVAL) */
128 #define EMACS_TIME int
129 #define EMACS_SECS(time) (time)
130 #define EMACS_USECS(time) 0
131 #define EMACS_SET_SECS(time, seconds) ((time) = (seconds))
132 #define EMACS_SET_USECS(time, usecs) 0
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)
139 #endif /* ! defined (HAVE_TIMEVAL) */
141 #define EMACS_SET_SECS_USECS(time, secs, usecs) \
142 (EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs))
144 extern int set_file_times (const char *, EMACS_TIME
, EMACS_TIME
);
146 /* defined in keyboard.c */
147 extern void set_waiting_for_input (EMACS_TIME
*);
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. */
153 /* defined in editfns.c*/
154 extern Lisp_Object
make_time (time_t);
155 extern int lisp_time_argument (Lisp_Object
, time_t *, int *);
158 /* Compare times T1 and T2. Value is 0 if T1 and T2 are the same.
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.) */
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) \
169 /* Compare times T1 and T2 for equality, inequality etc. */
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)
178 #endif /* EMACS_SYSTIME_H */