|
428
|
1 /* systime.h - System-dependent definitions for time manipulations.
|
|
|
2 Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
|
|
771
|
3 Copyright (C) 2001 Ben Wing.
|
|
428
|
4
|
|
|
5 This file is part of XEmacs.
|
|
|
6
|
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
8 under the terms of the GNU General Public License as published by the
|
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
|
10 later version.
|
|
|
11
|
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
15 for more details.
|
|
|
16
|
|
|
17 You should have received a copy of the GNU General Public License
|
|
|
18 along with XEmacs; see the file COPYING. If not, write to
|
|
|
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
20 Boston, MA 02111-1307, USA. */
|
|
|
21
|
|
|
22 /* Synched up with: FSF 19.30. */
|
|
|
23
|
|
440
|
24 #ifndef INCLUDED_systime_h_
|
|
|
25 #define INCLUDED_systime_h_
|
|
428
|
26
|
|
|
27 #ifdef TIME_WITH_SYS_TIME
|
|
442
|
28 # include <sys/time.h>
|
|
|
29 # include <time.h>
|
|
428
|
30 #else
|
|
442
|
31 # ifdef HAVE_SYS_TIME_H
|
|
|
32 # include <sys/time.h>
|
|
|
33 # else
|
|
|
34 # include <time.h>
|
|
|
35 # endif
|
|
428
|
36 #endif
|
|
|
37
|
|
771
|
38 #if defined (CYGWIN) || defined (LINUX)
|
|
|
39 /* #### why don't other systems have problems with this? need this
|
|
|
40 for struct tms */
|
|
|
41 # include <sys/times.h>
|
|
|
42 #endif
|
|
|
43
|
|
428
|
44 /* select() is supposed to be (Unix98) defined in sys/time.h,
|
|
|
45 but FreeBSD and Irix 5 put it in unistd.h instead.
|
|
|
46 If we have it, including it can't hurt. */
|
|
|
47 #ifdef HAVE_UNISTD_H
|
|
|
48 #include <unistd.h>
|
|
|
49 #endif
|
|
|
50
|
|
442
|
51 #ifdef WIN32_NATIVE
|
|
|
52
|
|
|
53 /* This defines struct timeval */
|
|
|
54 #include <winsock.h>
|
|
|
55
|
|
|
56 struct timezone
|
|
|
57 {
|
|
|
58 int tz_minuteswest; /* minutes west of Greenwich */
|
|
|
59 int tz_dsttime; /* type of dst correction */
|
|
|
60 };
|
|
|
61
|
|
|
62 #ifdef HAVE_X_WINDOWS
|
|
428
|
63 /* Provides gettimeofday etc */
|
|
|
64 #include <X11/Xw32defs.h>
|
|
|
65 #include <X11/Xos.h>
|
|
442
|
66 #else
|
|
|
67 /* X11R6 on NT provides the single parameter version of this command */
|
|
|
68 void gettimeofday (struct timeval *, struct timezone *);
|
|
|
69 #endif /* HAVE_X_WINDOWS */
|
|
|
70
|
|
|
71 #endif /* WIN32_NATIVE */
|
|
428
|
72
|
|
592
|
73 /* struct utimbuf */
|
|
|
74
|
|
460
|
75 #ifdef HAVE_UTIME
|
|
428
|
76 # include <utime.h>
|
|
|
77 #endif
|
|
|
78
|
|
592
|
79 #ifdef WIN32_NATIVE
|
|
|
80 # include <sys/utime.h>
|
|
771
|
81 #ifdef emacs
|
|
|
82 int mswindows_utime (Lisp_Object path, struct utimbuf *thymes);
|
|
|
83 #endif
|
|
592
|
84 #endif
|
|
|
85
|
|
442
|
86 #if defined(HAVE_TZNAME) && !defined(WIN32_NATIVE) && !defined(CYGWIN)
|
|
428
|
87 #ifndef tzname /* For SGI. */
|
|
|
88 extern char *tzname[]; /* RS6000 and others want it this way. */
|
|
|
89 #endif
|
|
|
90 #endif
|
|
|
91
|
|
|
92 /* On some configurations (hpux8.0, X11R4), sys/time.h and X11/Xos.h
|
|
|
93 disagree about the name of the guard symbol. */
|
|
|
94 #ifdef HPUX
|
|
|
95 #ifdef _STRUCT_TIMEVAL
|
|
|
96 #ifndef __TIMEVAL__
|
|
|
97 #define __TIMEVAL__
|
|
|
98 #endif
|
|
|
99 #endif
|
|
|
100 #endif
|
|
|
101
|
|
|
102 /* EMACS_TIME is the type to use to represent temporal intervals.
|
|
|
103 At one point this was 'struct timeval' on some systems, int on others.
|
|
|
104 But this is stupid. Other things than select() code like to
|
|
|
105 manipulate time values, and so microsecond precision should be
|
|
|
106 maintained. Separate typedefs and conversion functions are provided
|
|
|
107 for select().
|
|
|
108
|
|
|
109 EMACS_SECS (TIME) is an rvalue for the seconds component of TIME.
|
|
|
110 EMACS_SET_SECS (TIME, SECONDS) sets that to SECONDS.
|
|
|
111
|
|
|
112 EMACS_USECS (TIME) is an rvalue for the microseconds component of TIME.
|
|
|
113 EMACS_SET_USECS (TIME, MICROSECONDS) sets that to MICROSECONDS.
|
|
|
114
|
|
|
115 Note that all times are returned in "normalized" format (i.e. the
|
|
|
116 usecs value is in the range 0 <= value < 1000000) and are assumed
|
|
|
117 to be passed in in this format.
|
|
|
118
|
|
|
119 EMACS_SET_SECS_USECS (TIME, SECS, USECS) sets both components of TIME.
|
|
|
120
|
|
|
121 EMACS_GET_TIME (TIME) stores the current system time in TIME, which
|
|
|
122 should be an lvalue.
|
|
|
123
|
|
|
124 set_file_times (PATH, ATIME, MTIME) changes the last-access and
|
|
|
125 last-modification times of the file named PATH to ATIME and
|
|
|
126 MTIME, which are EMACS_TIMEs.
|
|
|
127
|
|
|
128 EMACS_NORMALIZE_TIME (TIME) coerces TIME into normalized format.
|
|
|
129
|
|
|
130 EMACS_ADD_TIME (DEST, SRC1, SRC2) adds SRC1 to SRC2 and stores the
|
|
|
131 result in DEST. Either or both may be negative.
|
|
|
132
|
|
|
133 EMACS_SUB_TIME (DEST, SRC1, SRC2) subtracts SRC2 from SRC1 and
|
|
|
134 stores the result in DEST. Either or both may be negative.
|
|
|
135
|
|
|
136 EMACS_TIME_NEG_P (TIME) is true iff TIME is negative.
|
|
|
137
|
|
|
138 EMACS_TIME_EQUAL (TIME1, TIME2) is true iff TIME1 is the same as TIME2.
|
|
|
139 EMACS_TIME_GREATER (TIME1, TIME2) is true iff TIME1 is greater than
|
|
|
140 TIME2.
|
|
|
141 EMACS_TIME_EQUAL_OR_GREATER (TIME1, TIME2) is true iff TIME1 is
|
|
|
142 greater than or equal to TIME2.
|
|
|
143
|
|
|
144 */
|
|
|
145
|
|
|
146 #ifdef HAVE_TIMEVAL
|
|
|
147
|
|
|
148 #define EMACS_SELECT_TIME struct timeval
|
|
|
149 #define EMACS_TIME_TO_SELECT_TIME(time, select_time) ((select_time) = (time))
|
|
|
150
|
|
|
151 #else /* not HAVE_TIMEVAL */
|
|
|
152
|
|
|
153 struct timeval
|
|
|
154 {
|
|
|
155 long tv_sec; /* seconds */
|
|
|
156 long tv_usec; /* microseconds */
|
|
|
157 };
|
|
|
158
|
|
|
159 #define EMACS_SELECT_TIME int
|
|
|
160 #define EMACS_TIME_TO_SELECT_TIME(time, select_time) \
|
|
|
161 EMACS_TIME_TO_INT (time, select_time)
|
|
|
162
|
|
|
163 #endif /* not HAVE_TIMEVAL */
|
|
|
164
|
|
|
165 #define EMACS_TIME_TO_INT(time, intvar) \
|
|
|
166 do { \
|
|
|
167 EMACS_TIME tmptime = time; \
|
|
|
168 \
|
|
|
169 if (tmptime.tv_usec > 0) \
|
|
|
170 (intvar) = tmptime.tv_sec + 1; \
|
|
|
171 else \
|
|
|
172 (intvar) = tmptime.tv_sec; \
|
|
|
173 } while (0)
|
|
|
174
|
|
|
175 #define EMACS_TIME struct timeval
|
|
|
176 #define EMACS_SECS(time) ((time).tv_sec + 0)
|
|
|
177 #define EMACS_USECS(time) ((time).tv_usec + 0)
|
|
|
178 #define EMACS_SET_SECS(time, seconds) ((time).tv_sec = (seconds))
|
|
|
179 #define EMACS_SET_USECS(time, microseconds) ((time).tv_usec = (microseconds))
|
|
|
180
|
|
|
181 #if !defined (HAVE_GETTIMEOFDAY)
|
|
442
|
182 int gettimeofday (struct timeval *, void *);
|
|
428
|
183 #endif
|
|
|
184
|
|
|
185 /* On SVR4, the compiler may complain if given this extra BSD arg. */
|
|
|
186 #ifdef GETTIMEOFDAY_ONE_ARGUMENT
|
|
442
|
187 #define EMACS_GETTIMEOFDAY(time) gettimeofday(time)
|
|
|
188 #else
|
|
|
189 #define EMACS_GETTIMEOFDAY(time) gettimeofday(time,0)
|
|
|
190 #endif
|
|
|
191
|
|
428
|
192 /* According to the Xt sources, some NTP daemons on some systems may
|
|
|
193 return non-normalized values. */
|
|
|
194 #define EMACS_GET_TIME(time) \
|
|
|
195 do { \
|
|
442
|
196 EMACS_GETTIMEOFDAY (&(time)); \
|
|
428
|
197 EMACS_NORMALIZE_TIME (time); \
|
|
|
198 } while (0)
|
|
|
199
|
|
|
200 #define EMACS_NORMALIZE_TIME(time) \
|
|
|
201 do { \
|
|
|
202 while ((time).tv_usec >= 1000000) \
|
|
|
203 { \
|
|
|
204 (time).tv_usec -= 1000000; \
|
|
|
205 (time).tv_sec++; \
|
|
|
206 } \
|
|
|
207 while ((time).tv_usec < 0) \
|
|
|
208 { \
|
|
|
209 (time).tv_usec += 1000000; \
|
|
|
210 (time).tv_sec--; \
|
|
|
211 } \
|
|
|
212 } while (0)
|
|
|
213
|
|
|
214 #define EMACS_ADD_TIME(dest, src1, src2) \
|
|
|
215 do { \
|
|
|
216 (dest).tv_sec = (src1).tv_sec + (src2).tv_sec; \
|
|
|
217 (dest).tv_usec = (src1).tv_usec + (src2).tv_usec; \
|
|
|
218 EMACS_NORMALIZE_TIME (dest); \
|
|
|
219 } while (0)
|
|
|
220
|
|
|
221 #define EMACS_SUB_TIME(dest, src1, src2) \
|
|
|
222 do { \
|
|
|
223 (dest).tv_sec = (src1).tv_sec - (src2).tv_sec; \
|
|
|
224 (dest).tv_usec = (src1).tv_usec - (src2).tv_usec; \
|
|
|
225 EMACS_NORMALIZE_TIME (dest); \
|
|
|
226 } while (0)
|
|
|
227
|
|
|
228 #define EMACS_TIME_NEG_P(time) ((long)(time).tv_sec < 0)
|
|
|
229
|
|
|
230 #define EMACS_TIME_EQUAL(time1, time2) \
|
|
|
231 ((time1).tv_sec == (time2).tv_sec && \
|
|
|
232 (time1).tv_usec == (time2).tv_usec)
|
|
|
233
|
|
|
234 #define EMACS_TIME_GREATER(time1, time2) \
|
|
|
235 ((time1).tv_sec > (time2).tv_sec || \
|
|
|
236 ((time1).tv_sec == (time2).tv_sec && \
|
|
|
237 (time1).tv_usec > (time2).tv_usec))
|
|
|
238
|
|
|
239 #define EMACS_TIME_EQUAL_OR_GREATER(time1, time2) \
|
|
|
240 ((time1).tv_sec > (time2).tv_sec || \
|
|
|
241 ((time1).tv_sec == (time2).tv_sec && \
|
|
|
242 (time1).tv_usec >= (time2).tv_usec))
|
|
|
243
|
|
|
244 #define EMACS_SET_SECS_USECS(time, secs, usecs) \
|
|
|
245 (EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs))
|
|
|
246
|
|
592
|
247 #ifdef emacs
|
|
|
248 int set_file_times (Lisp_Object path, EMACS_TIME atime, EMACS_TIME mtime);
|
|
428
|
249 void get_process_times (double *user_time, double *system_time,
|
|
|
250 double *real_time);
|
|
771
|
251 Intbyte *qxe_ctime (const time_t *value);
|
|
|
252
|
|
|
253 #endif
|
|
428
|
254
|
|
611
|
255 #ifdef WIN32_NATIVE
|
|
428
|
256
|
|
611
|
257 /* setitimer emulation for Win32 (see win32.c) */
|
|
428
|
258
|
|
|
259 struct itimerval
|
|
|
260 {
|
|
|
261 struct timeval it_value;
|
|
|
262 struct timeval it_interval;
|
|
|
263 };
|
|
|
264
|
|
|
265 #define ITIMER_REAL 1
|
|
|
266 #define ITIMER_PROF 2
|
|
|
267
|
|
442
|
268 #endif /* WIN32_NATIVE */
|
|
428
|
269
|
|
611
|
270 #if defined (WIN32_NATIVE) || defined (CYGWIN)
|
|
|
271
|
|
|
272 int mswindows_setitimer (int kind, const struct itimerval *itnew,
|
|
|
273 struct itimerval *itold);
|
|
|
274
|
|
|
275 #endif /* defined (WIN32_NATIVE) || defined (CYGWIN) */
|
|
|
276
|
|
|
277 /* #### Move this comment elsewhere when we figure out the place.
|
|
|
278
|
|
|
279 "qxe" is a unique prefix used to identify encapsulations of standard
|
|
|
280 library functions. We used to play pre-processing games but in
|
|
|
281 general this leads to nothing but trouble because someone first
|
|
|
282 encountering the code will have no idea that what appears to be a
|
|
|
283 call to a library function has actually been redefined to be a call
|
|
|
284 somewhere else. This is doubly true when the redefinition occurs
|
|
|
285 in out-of-the way s+m files and only on certainly systems.
|
|
|
286
|
|
617
|
287 The name "qxe" was chosen because it is a unique string that is not
|
|
|
288 going to be found anywhere else in the sources (unlike, for example,
|
|
|
289 the prefixes "xemacs" or "sys") and is easy to type. Alternative
|
|
|
290 names are certainly possible, and suggestions are welcome.
|
|
|
291
|
|
611
|
292 By making the encapsulation explicit we might be making the code
|
|
|
293 that uses is slightly less pretty, but this is more than compensated
|
|
|
294 for by the huge increase in clarity.
|
|
|
295
|
|
|
296 "Standard library function" can refer to any function in any
|
|
|
297 standard library. If we are explicitly changing the semantics
|
|
|
298 (e.g. Mule-encapsulating), we should use an extended version of
|
|
|
299 the prefix, e.g. perhaps "qxe_xlat_" for functions that Mule-
|
|
|
300 encapsulate, or "qxe_retry_" for functions that automatically
|
|
|
301 retry a system call interrupted by EINTR. In general, if there
|
|
|
302 is no prefix extension, it means the function is trying to
|
|
|
303 provide (more or less) the same semantics as the standard library
|
|
|
304 function; but be aware that the reimplementation may be incomplete
|
|
|
305 or differ in important respects. This is especially the case
|
|
|
306 when attempts are made to implement Unix functions on MS Windows.
|
|
617
|
307
|
|
|
308 (The comment on the particular encapsulation should describe what
|
|
|
309 standard function is being emulated, if this is not obvious, and
|
|
|
310 what the differences, if any, from that standard function are.)
|
|
|
311
|
|
|
312 An example of this is the qxe_setitimer() function. This attempts
|
|
|
313 to emulate the POSIX (Unix98?) standard setitimer(), as found on
|
|
|
314 all modern versions of Unix. Normally, we just call the system-
|
|
|
315 provided setitimer() function. When emulated on MS Windows and
|
|
|
316 Cygwin, however, the ITNEW and ITOLD values cannot be different
|
|
|
317 from each other if both are non-zero, due to limitations in the
|
|
|
318 underlying multimedia-timer API. By simply using setitimer() with
|
|
|
319 preprocessor tricks, a programmer would almost have to be a
|
|
|
320 mind-reader to figure this out. With the explicit encapsulation, a
|
|
|
321 programmer need only look at the definition of qxe_setitimer() to
|
|
|
322 see what its semantics are.
|
|
611
|
323 */
|
|
|
324
|
|
|
325 int qxe_setitimer (int kind, const struct itimerval *itnew,
|
|
|
326 struct itimerval *itold);
|
|
|
327
|
|
440
|
328 #endif /* INCLUDED_systime_h_ */
|
