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