Merge latest Org fixes (commit 7524ef2).

[gnu-emacs] / src / systime.h

diff --git a/src/systime.h b/src/systime.h
index 24e9a6f45070fc7119e0fb2ca4dbd501c1964925..fa5e7270cb551373e27389cd224a707c1fe0ad01 100644 (file)
--- a/src/systime.h
+++ b/src/systime.h
@@ -1,5 +1,5 @@
 /* systime.h - System-dependent definitions for time manipulations.
-   Copyright (C) 1993-1994, 2002-2012 Free Software Foundation, Inc.
+   Copyright (C) 1993-1994, 2002-2013 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -21,6 +21,11 @@ along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #include <timespec.h>
 
+INLINE_HEADER_BEGIN
+#ifndef SYSTIME_INLINE
+# define SYSTIME_INLINE INLINE
+#endif
+
 #ifdef emacs
 # ifdef HAVE_X_WINDOWS
 #  include <X11/X.h>
@@ -41,8 +46,9 @@ typedef unsigned long Time;
 
 #include <sys/time.h>  /* for 'struct timeval' */
 \f
-/* The type to use to represent temporal intervals.  Its address can be passed
-   as the timeout argument to the pselect system call.  */
+/* The type to use to represent non-negative temporal intervals.  Its
+   address can be passed as the timeout argument to the pselect system
+   call.  */
 typedef struct timespec EMACS_TIME;
 
 /* Resolution of EMACS_TIME time stamps (in units per second), and log
@@ -53,12 +59,12 @@ enum { LOG10_EMACS_TIME_RESOLUTION = 9 };
 /* EMACS_SECS (TIME) is the seconds component of TIME.
    EMACS_NSECS (TIME) is the nanoseconds component of TIME.
    emacs_secs_addr (PTIME) is the address of *PTIME's seconds component.  */
-static inline time_t EMACS_SECS (EMACS_TIME t) { return t.tv_sec; }
-static inline int EMACS_NSECS (EMACS_TIME t) { return t.tv_nsec; }
-static inline time_t *emacs_secs_addr (EMACS_TIME *t) { return &t->tv_sec; }
+SYSTIME_INLINE time_t EMACS_SECS (EMACS_TIME t) { return t.tv_sec; }
+SYSTIME_INLINE int EMACS_NSECS (EMACS_TIME t) { return t.tv_nsec; }
+SYSTIME_INLINE time_t *emacs_secs_addr (EMACS_TIME *t) { return &t->tv_sec; }
 
 /* Return an Emacs time with seconds S and nanoseconds NS.  */
-static inline EMACS_TIME
+SYSTIME_INLINE EMACS_TIME
 make_emacs_time (time_t s, int ns)
 {
   EMACS_TIME r = { s, ns };
@@ -66,7 +72,7 @@ make_emacs_time (time_t s, int ns)
 }
 
 /* Return an invalid Emacs time.  */
-static inline EMACS_TIME
+SYSTIME_INLINE EMACS_TIME
 invalid_emacs_time (void)
 {
   EMACS_TIME r = { 0, -1 };
@@ -74,7 +80,7 @@ invalid_emacs_time (void)
 }
 
 /* Return current system time.  */
-static inline EMACS_TIME
+SYSTIME_INLINE EMACS_TIME
 current_emacs_time (void)
 {
   EMACS_TIME r;
@@ -84,43 +90,52 @@ current_emacs_time (void)
 
 /* Return the result of adding A to B, or of subtracting B from A.
    On overflow, store an extremal value: ergo, if time_t is unsigned,
-   return 0 if the true answer would be negative.  */
-static inline EMACS_TIME
+   return 0 if the true answer would be negative.
+
+   WARNING: These are NOT general-purpose macros for adding or
+   subtracting arbitrary time values!  They are generally intended to
+   be used with their first argument an absolute time since the epoch
+   and the second argument a non-negative offset.  Do NOT use them for
+   anything else.  */
+SYSTIME_INLINE EMACS_TIME
 add_emacs_time (EMACS_TIME a, EMACS_TIME b)
 {
   return timespec_add (a, b);
 }
-static inline EMACS_TIME
+SYSTIME_INLINE EMACS_TIME
 sub_emacs_time (EMACS_TIME a, EMACS_TIME b)
 {
   return timespec_sub (a, b);
 }
 
-/* Return the sign of the valid time stamp TIME, either -1, 0, or 1.  */
-static inline int
+/* Return the sign of the valid time stamp TIME, either -1, 0, or 1.
+   Note: this can only return a negative value if time_t is a signed
+   data type.  */
+SYSTIME_INLINE int
 EMACS_TIME_SIGN (EMACS_TIME t)
 {
   return timespec_sign (t);
 }
 
 /* Return 1 if TIME is a valid time stamp.  */
-static inline int
+SYSTIME_INLINE int
 EMACS_TIME_VALID_P (EMACS_TIME t)
 {
   return 0 <= t.tv_nsec;
 }
 
 /* Convert the double D to the greatest EMACS_TIME not greater than D.
-   On overflow, return an extremal value.  Return the minimum
-   EMACS_TIME if D is not a number.  */
-static inline EMACS_TIME
+   On overflow, return an extremal value; in particular, if time_t is
+   an unsigned data type and D is negative, return zero.  Return the
+   minimum EMACS_TIME if D is not a number.  */
+SYSTIME_INLINE EMACS_TIME
 EMACS_TIME_FROM_DOUBLE (double d)
 {
   return dtotimespec (d);
 }
 
 /* Convert the Emacs time T to an approximate double value D.  */
-static inline double
+SYSTIME_INLINE double
 EMACS_TIME_TO_DOUBLE (EMACS_TIME t)
 {
   return timespectod (t);
@@ -139,41 +154,43 @@ extern void set_waiting_for_input (EMACS_TIME *);
 #ifdef GCPRO1
 /* defined in editfns.c */
 extern Lisp_Object make_lisp_time (EMACS_TIME);
-extern int decode_time_components (Lisp_Object, Lisp_Object, Lisp_Object,
-                                  Lisp_Object, EMACS_TIME *, double *);
+extern bool decode_time_components (Lisp_Object, Lisp_Object, Lisp_Object,
+                                   Lisp_Object, EMACS_TIME *, double *);
 extern EMACS_TIME lisp_time_argument (Lisp_Object);
 #endif
 
 /* Compare times T1 and T2 for equality, inequality etc.  */
-static inline int
+SYSTIME_INLINE int
 EMACS_TIME_EQ (EMACS_TIME t1, EMACS_TIME t2)
 {
   return timespec_cmp (t1, t2) == 0;
 }
-static inline int
+SYSTIME_INLINE int
 EMACS_TIME_NE (EMACS_TIME t1, EMACS_TIME t2)
 {
   return timespec_cmp (t1, t2) != 0;
 }
-static inline int
+SYSTIME_INLINE int
 EMACS_TIME_GT (EMACS_TIME t1, EMACS_TIME t2)
 {
   return timespec_cmp (t1, t2) > 0;
 }
-static inline int
+SYSTIME_INLINE int
 EMACS_TIME_GE (EMACS_TIME t1, EMACS_TIME t2)
 {
   return timespec_cmp (t1, t2) >= 0;
 }
-static inline int
+SYSTIME_INLINE int
 EMACS_TIME_LT (EMACS_TIME t1, EMACS_TIME t2)
 {
   return timespec_cmp (t1, t2) < 0;
 }
-static inline int
+SYSTIME_INLINE int
 EMACS_TIME_LE (EMACS_TIME t1, EMACS_TIME t2)
 {
   return timespec_cmp (t1, t2) <= 0;
 }
 
+INLINE_HEADER_END
+
 #endif /* EMACS_SYSTIME_H */