| 1 | /* systime.h - System-dependent definitions for time manipulations. |
| 2 | Copyright (C) 1993, 1994, 2002, 2003, 2004, |
| 3 | 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
| 4 | |
| 5 | This file is part of GNU Emacs. |
| 6 | |
| 7 | GNU Emacs is free software: you can redistribute it and/or modify |
| 8 | it under the terms of the GNU General Public License as published by |
| 9 | the Free Software Foundation, either version 3 of the License, or |
| 10 | (at your option) any later version. |
| 11 | |
| 12 | GNU Emacs is distributed in the hope that it will be useful, |
| 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | GNU General Public License for more details. |
| 16 | |
| 17 | You should have received a copy of the GNU General Public License |
| 18 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 19 | |
| 20 | #ifndef EMACS_SYSTIME_H |
| 21 | #define EMACS_SYSTIME_H |
| 22 | |
| 23 | #ifdef TIME_WITH_SYS_TIME |
| 24 | #include <sys/time.h> |
| 25 | #include <time.h> |
| 26 | #else |
| 27 | #ifdef HAVE_SYS_TIME_H |
| 28 | #include <sys/time.h> |
| 29 | #else |
| 30 | #include <time.h> |
| 31 | #endif |
| 32 | #endif |
| 33 | |
| 34 | #ifdef HAVE_TZNAME |
| 35 | #ifndef tzname /* For SGI. */ |
| 36 | extern char *tzname[]; /* RS6000 and others want it this way. */ |
| 37 | #endif |
| 38 | #endif |
| 39 | |
| 40 | /* SVr4 doesn't actually declare this in its #include files. */ |
| 41 | #ifdef USG5_4 |
| 42 | extern time_t timezone; |
| 43 | #endif |
| 44 | |
| 45 | /* On some configurations (hpux8.0, X11R4), sys/time.h and X11/Xos.h |
| 46 | disagree about the name of the guard symbol. */ |
| 47 | #ifdef HPUX |
| 48 | #ifdef _STRUCT_TIMEVAL |
| 49 | #ifndef __TIMEVAL__ |
| 50 | #define __TIMEVAL__ |
| 51 | #endif |
| 52 | #endif |
| 53 | #endif |
| 54 | \f |
| 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 if EMACS_TIME has a usecs component. |
| 63 | EMACS_USECS (TIME) is an rvalue for the microseconds component of TIME. |
| 64 | This returns zero if EMACS_TIME doesn't have a microseconds component. |
| 65 | EMACS_SET_USECS (TIME, MICROSECONDS) sets that to MICROSECONDS. |
| 66 | This does nothing if EMACS_TIME doesn't have a microseconds 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 | |
| 73 | EMACS_ADD_TIME (DEST, SRC1, SRC2) adds SRC1 to SRC2 and stores the |
| 74 | result in DEST. SRC should not be negative. |
| 75 | |
| 76 | EMACS_SUB_TIME (DEST, SRC1, SRC2) subtracts SRC2 from SRC1 and |
| 77 | stores the result in DEST. SRC should not be negative. |
| 78 | EMACS_TIME_NEG_P (TIME) is true if TIME is negative. |
| 79 | |
| 80 | */ |
| 81 | |
| 82 | #ifdef HAVE_TIMEVAL |
| 83 | |
| 84 | #define EMACS_HAS_USECS |
| 85 | |
| 86 | #define EMACS_TIME struct timeval |
| 87 | #define EMACS_SECS(time) ((time).tv_sec + 0) |
| 88 | #define EMACS_USECS(time) ((time).tv_usec + 0) |
| 89 | #define EMACS_SET_SECS(time, seconds) ((time).tv_sec = (seconds)) |
| 90 | #define EMACS_SET_USECS(time, microseconds) ((time).tv_usec = (microseconds)) |
| 91 | |
| 92 | /* On SVR4, the compiler may complain if given this extra BSD arg. */ |
| 93 | #ifdef GETTIMEOFDAY_ONE_ARGUMENT |
| 94 | #define EMACS_GET_TIME(time) gettimeofday (&(time)) |
| 95 | #else /* not GETTIMEOFDAY_ONE_ARGUMENT */ |
| 96 | /* Presumably the second arg is ignored. */ |
| 97 | #define EMACS_GET_TIME(time) gettimeofday (&(time), NULL) |
| 98 | #endif /* not GETTIMEOFDAY_ONE_ARGUMENT */ |
| 99 | |
| 100 | #define EMACS_ADD_TIME(dest, src1, src2) \ |
| 101 | do { \ |
| 102 | (dest).tv_sec = (src1).tv_sec + (src2).tv_sec; \ |
| 103 | (dest).tv_usec = (src1).tv_usec + (src2).tv_usec; \ |
| 104 | if ((dest).tv_usec > 1000000) \ |
| 105 | (dest).tv_usec -= 1000000, (dest).tv_sec++; \ |
| 106 | } while (0) |
| 107 | |
| 108 | #define EMACS_SUB_TIME(dest, src1, src2) \ |
| 109 | do { \ |
| 110 | (dest).tv_sec = (src1).tv_sec - (src2).tv_sec; \ |
| 111 | (dest).tv_usec = (src1).tv_usec - (src2).tv_usec; \ |
| 112 | if ((dest).tv_usec < 0) \ |
| 113 | (dest).tv_usec += 1000000, (dest).tv_sec--; \ |
| 114 | } while (0) |
| 115 | |
| 116 | #define EMACS_TIME_NEG_P(time) \ |
| 117 | ((long)(time).tv_sec < 0 \ |
| 118 | || ((time).tv_sec == 0 \ |
| 119 | && (long)(time).tv_usec < 0)) |
| 120 | |
| 121 | #else /* ! defined (HAVE_TIMEVAL) */ |
| 122 | |
| 123 | #define EMACS_TIME int |
| 124 | #define EMACS_SECS(time) (time) |
| 125 | #define EMACS_USECS(time) 0 |
| 126 | #define EMACS_SET_SECS(time, seconds) ((time) = (seconds)) |
| 127 | #define EMACS_SET_USECS(time, usecs) 0 |
| 128 | |
| 129 | #define EMACS_GET_TIME(t) ((t) = time ((long *) 0)) |
| 130 | #define EMACS_ADD_TIME(dest, src1, src2) ((dest) = (src1) + (src2)) |
| 131 | #define EMACS_SUB_TIME(dest, src1, src2) ((dest) = (src1) - (src2)) |
| 132 | #define EMACS_TIME_NEG_P(t) ((t) < 0) |
| 133 | |
| 134 | #endif /* ! defined (HAVE_TIMEVAL) */ |
| 135 | |
| 136 | #define EMACS_SET_SECS_USECS(time, secs, usecs) \ |
| 137 | (EMACS_SET_SECS (time, secs), EMACS_SET_USECS (time, usecs)) |
| 138 | |
| 139 | extern int set_file_times __P ((const char *, EMACS_TIME, EMACS_TIME)); |
| 140 | |
| 141 | /* defined in keyboard.c */ |
| 142 | extern void set_waiting_for_input __P ((EMACS_TIME *)); |
| 143 | |
| 144 | /* When lisp.h is not included Lisp_Object is not defined (this can |
| 145 | happen when this files is used outside the src directory). |
| 146 | Use GCPRO1 to determine if lisp.h was included. */ |
| 147 | #ifdef GCPRO1 |
| 148 | /* defined in dired.c */ |
| 149 | extern Lisp_Object make_time __P ((time_t)); |
| 150 | #endif |
| 151 | |
| 152 | /* Compare times T1 and T2. Value is 0 if T1 and T2 are the same. |
| 153 | Value is < 0 if T1 is less than T2. Value is > 0 otherwise. */ |
| 154 | |
| 155 | #define EMACS_TIME_CMP(T1, T2) \ |
| 156 | (EMACS_SECS (T1) - EMACS_SECS (T2) \ |
| 157 | + (EMACS_SECS (T1) == EMACS_SECS (T2) \ |
| 158 | ? EMACS_USECS (T1) - EMACS_USECS (T2) \ |
| 159 | : 0)) |
| 160 | |
| 161 | /* Compare times T1 and T2 for equality, inequality etc. */ |
| 162 | |
| 163 | #define EMACS_TIME_EQ(T1, T2) (EMACS_TIME_CMP (T1, T2) == 0) |
| 164 | #define EMACS_TIME_NE(T1, T2) (EMACS_TIME_CMP (T1, T2) != 0) |
| 165 | #define EMACS_TIME_GT(T1, T2) (EMACS_TIME_CMP (T1, T2) > 0) |
| 166 | #define EMACS_TIME_GE(T1, T2) (EMACS_TIME_CMP (T1, T2) >= 0) |
| 167 | #define EMACS_TIME_LT(T1, T2) (EMACS_TIME_CMP (T1, T2) < 0) |
| 168 | #define EMACS_TIME_LE(T1, T2) (EMACS_TIME_CMP (T1, T2) <= 0) |
| 169 | |
| 170 | #endif /* EMACS_SYSTIME_H */ |
| 171 | |
| 172 | /* arch-tag: dcb79915-cf99-4bce-9778-aade71d07651 |
| 173 | (do not change this comment) */ |