time-date.el: Port new time stamp handling to old Emacs and to XEmacs

[gnus] / lisp / time-date.el

diff --git a/lisp/time-date.el b/lisp/time-date.el
index 5dbd08c..a9c30f4 100644 (file)
--- a/lisp/time-date.el
+++ b/lisp/time-date.el
@@ -1,7 +1,6 @@
 ;;; time-date.el --- Date and time handling functions
 
 ;;; time-date.el --- Date and time handling functions
 

-;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
-;;   2007, 2008, 2009, 2010  Free Software Foundation, Inc.
+;; Copyright (C) 1998-2014 Free Software Foundation, Inc.

 
 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
 ;;     Masanobu Umeda <umerin@mse.kyutech.ac.jp>
 
 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
 ;;     Masanobu Umeda <umerin@mse.kyutech.ac.jp>


@@ -24,37 +23,34 @@
 
 ;;; Commentary:
 
 
 ;;; Commentary:
 

-;; Time values come in three formats.  The oldest format is a cons
+;; Time values come in several formats.  The oldest format is a cons

 ;; cell of the form (HIGH . LOW).  This format is obsolete, but still
 ;; cell of the form (HIGH . LOW).  This format is obsolete, but still

-;; supported.  The two other formats are the lists (HIGH LOW) and
-;; (HIGH LOW MICRO).  The first two formats specify HIGH * 2^16 + LOW
-;; seconds; the third format specifies HIGH * 2^16 + LOW + MICRO /
-;; 1000000 seconds.  We should have 0 <= MICRO < 1000000 and 0 <= LOW
-;; < 2^16.  If the time value represents a point in time, then HIGH is
-;; nonnegative.  If the time value is a time difference, then HIGH can
-;; be negative as well.  The macro `with-decoded-time-value' and the
-;; function `encode-time-value' make it easier to deal with these
-;; three formats.  See `time-subtract' for an example of how to use
-;; them.
+;; supported.  The other formats are the lists (HIGH LOW), (HIGH LOW
+;; USEC), and (HIGH LOW USEC PSEC).  These formats specify the time
+;; value equal to HIGH * 2^16 + LOW + USEC * 10^-6 + PSEC * 10^-12
+;; seconds, where missing components are treated as zero.  HIGH can be
+;; negative, either because the value is a time difference, or because
+;; it represents a time stamp before the epoch.  Typically, there are
+;; more time values than the underlying system time type supports,
+;; but the reverse can also be true.

 
 ;;; Code:
 
 
 ;;; Code:
 

-;; Only necessary for `declare' when compiling Gnus with Emacs 21.
-(eval-when-compile (require 'cl))
-

 (defmacro with-decoded-time-value (varlist &rest body)
   "Decode a time value and bind it according to VARLIST, then eval BODY.
 
 The value of the last form in BODY is returned.
 
 Each element of the list VARLIST is a list of the form
 (defmacro with-decoded-time-value (varlist &rest body)
   "Decode a time value and bind it according to VARLIST, then eval BODY.
 
 The value of the last form in BODY is returned.
 
 Each element of the list VARLIST is a list of the form

-\(HIGH-SYMBOL LOW-SYMBOL MICRO-SYMBOL [TYPE-SYMBOL] TIME-VALUE).
-The time value TIME-VALUE is decoded and the result it bound to
+\(HIGH-SYMBOL LOW-SYMBOL MICRO-SYMBOL [PICO-SYMBOL [TYPE-SYMBOL]] TIME-VALUE).
+The time value TIME-VALUE is decoded and the result is bound to

 the symbols HIGH-SYMBOL, LOW-SYMBOL and MICRO-SYMBOL.
 the symbols HIGH-SYMBOL, LOW-SYMBOL and MICRO-SYMBOL.

+The optional PICO-SYMBOL is bound to the picoseconds part.

 
 The optional TYPE-SYMBOL is bound to the type of the time value.
 Type 0 is the cons cell (HIGH . LOW), type 1 is the list (HIGH
 
 The optional TYPE-SYMBOL is bound to the type of the time value.
 Type 0 is the cons cell (HIGH . LOW), type 1 is the list (HIGH

-LOW), and type 2 is the list (HIGH LOW MICRO)."
+LOW), type 2 is the list (HIGH LOW MICRO), and type 3 is the
+list (HIGH LOW MICRO PICO)."

   (declare (indent 1)
           (debug ((&rest (symbolp symbolp symbolp &or [symbolp form] form))
                   body)))
   (declare (indent 1)
           (debug ((&rest (symbolp symbolp symbolp &or [symbolp form] form))
                   body)))


@@ -63,106 +59,144 @@ LOW), and type 2 is the list (HIGH LOW MICRO)."
             (high (pop elt))
             (low (pop elt))
             (micro (pop elt))
             (high (pop elt))
             (low (pop elt))
             (micro (pop elt))

+            (pico (unless (<= (length elt) 2)
+                    (pop elt)))

             (type (unless (eq (length elt) 1)
                     (pop elt)))
             (time-value (car elt))
             (gensym (make-symbol "time")))
             (type (unless (eq (length elt) 1)
                     (pop elt)))
             (time-value (car elt))
             (gensym (make-symbol "time")))

-       `(let* ,(append `((,gensym ,time-value)
+       `(let* ,(append `((,gensym (or ,time-value (current-time)))
+                         (,gensym
+                          (cond
+                           ((integerp ,gensym)
+                            (list (ash ,gensym -16)
+                                  (logand ,gensym 65535)))
+                           ((floatp ,gensym)
+                            (let* ((usec (* 1000000 (mod ,gensym 1)))
+                                   (ps (round (* 1000000 (mod usec 1))))
+                                   (us (floor usec))
+                                   (lo (floor (mod ,gensym 65536)))
+                                   (hi (floor ,gensym 65536)))
+                              (if (eq ps 1000000)
+                                  (progn
+                                    (setq ps 0)
+                                    (setq us (1+ us))
+                                    (if (eq us 1000000)
+                                        (progn
+                                          (setq us 0)
+                                          (setq lo (1+ lo))
+                                          (if (eq lo 65536)
+                                              (progn
+                                                (setq lo 0)
+                                                (setq hi (1+ hi))))))))
+                              (list hi lo us ps)))
+                           (t ,gensym)))

                          (,high (pop ,gensym))
                          ,low ,micro)
                          (,high (pop ,gensym))
                          ,low ,micro)

+                       (when pico `(,pico))

                        (when type `(,type)))
           (if (consp ,gensym)
               (progn
                 (setq ,low (pop ,gensym))
                 (if ,gensym
                        (when type `(,type)))
           (if (consp ,gensym)
               (progn
                 (setq ,low (pop ,gensym))
                 (if ,gensym

-                    ,(append `(setq ,micro (car ,gensym))
-                             (when type `(,type 2)))
+                    (progn
+                      (setq ,micro (car ,gensym))
+                      ,(cond (pico
+                              `(if (cdr ,gensym)
+                                   ,(append `(setq ,pico (cadr ,gensym))
+                                            (when type `(,type 3)))
+                                 ,(append `(setq ,pico 0)
+                                          (when type `(,type 2)))))
+                             (type
+                              `(setq type 2))))

                   ,(append `(setq ,micro 0)
                   ,(append `(setq ,micro 0)

+                           (when pico `(,pico 0))

                            (when type `(,type 1)))))
             ,(append `(setq ,low ,gensym ,micro 0)
                            (when type `(,type 1)))))
             ,(append `(setq ,low ,gensym ,micro 0)

+                     (when pico `(,pico 0))

                      (when type `(,type 0))))
           (with-decoded-time-value ,varlist ,@body)))
     `(progn ,@body)))
 
                      (when type `(,type 0))))
           (with-decoded-time-value ,varlist ,@body)))
     `(progn ,@body)))
 

-(defun encode-time-value (high low micro type)
-  "Encode HIGH, LOW, and MICRO into a time value of type TYPE.
+(defun encode-time-value (high low micro pico &optional type)
+  "Encode HIGH, LOW, MICRO, and PICO into a time value of type TYPE.

 Type 0 is the cons cell (HIGH . LOW), type 1 is the list (HIGH LOW),
 Type 0 is the cons cell (HIGH . LOW), type 1 is the list (HIGH LOW),

-and type 2 is the list (HIGH LOW MICRO)."
+type 2 is (HIGH LOW MICRO), and type 3 is (HIGH LOW MICRO PICO).
+
+For backward compatibility, if only four arguments are given,
+it is assumed that PICO was omitted and should be treated as zero."

   (cond
    ((eq type 0) (cons high low))
    ((eq type 1) (list high low))
   (cond
    ((eq type 0) (cons high low))
    ((eq type 1) (list high low))

-   ((eq type 2) (list high low micro))))
+   ((eq type 2) (list high low micro))
+   ((eq type 3) (list high low micro pico))
+   ((null type) (encode-time-value high low micro 0 pico))))
+
+(when (and (fboundp 'time-add) (subrp (symbol-function 'time-add)))
+  (make-obsolete 'encode-time-value nil "25.1")
+  (make-obsolete 'with-decoded-time-value nil "25.1"))

 
 (autoload 'parse-time-string "parse-time")
 (autoload 'timezone-make-date-arpa-standard "timezone")
 
 ;;;###autoload
 
 (autoload 'parse-time-string "parse-time")
 (autoload 'timezone-make-date-arpa-standard "timezone")
 
 ;;;###autoload

+;; `parse-time-string' isn't sufficiently general or robust.  It fails
+;; to grok some of the formats that timezone does (e.g. dodgy
+;; post-2000 stuff from some Elms) and either fails or returns bogus
+;; values.  timezone-make-date-arpa-standard should help.

 (defun date-to-time (date)
   "Parse a string DATE that represents a date-time and return a time value.
 If DATE lacks timezone information, GMT is assumed."
 (defun date-to-time (date)
   "Parse a string DATE that represents a date-time and return a time value.
 If DATE lacks timezone information, GMT is assumed."

-  (condition-case ()
-      (apply 'encode-time
-            (parse-time-string
-             ;; `parse-time-string' isn't sufficiently general or
-             ;; robust.  It fails to grok some of the formats that
-             ;; timezone does (e.g. dodgy post-2000 stuff from some
-             ;; Elms) and either fails or returns bogus values.  Lars
-             ;; reverted this change, but that loses non-trivially
-             ;; often for me.  -- fx
-             (timezone-make-date-arpa-standard date)))
-    (error (error "Invalid date: %s" date))))
+  (condition-case err
+      (apply 'encode-time (parse-time-string date))
+    (error
+     (let ((overflow-error '(error "Specified time is not representable")))
+       (if (equal err overflow-error)
+          (apply 'signal err)
+        (condition-case err
+            (apply 'encode-time
+                   (parse-time-string
+                    (timezone-make-date-arpa-standard date)))
+          (error
+           (if (equal err overflow-error)
+               (apply 'signal err)
+             (error "Invalid date: %s" date)))))))))

 
 ;; Bit of a mess.  Emacs has float-time since at least 21.1.
 ;; This file is synced to Gnus, and XEmacs packages may have been written
 ;; using time-to-seconds from the Gnus library.
 
 ;; Bit of a mess.  Emacs has float-time since at least 21.1.
 ;; This file is synced to Gnus, and XEmacs packages may have been written
 ;; using time-to-seconds from the Gnus library.

-;;;###autoload(if (and (fboundp 'float-time)
-;;;###autoload         (subrp (symbol-function 'float-time)))
-;;;###autoload    (progn
-;;;###autoload      (defalias 'time-to-seconds 'float-time)
-;;;###autoload      (make-obsolete 'time-to-seconds 'float-time "21.1"))
+;;;###autoload(if (or (featurep 'emacs)
+;;;###autoload        (and (fboundp 'float-time)
+;;;###autoload             (subrp (symbol-function 'float-time))))
+;;;###autoload    (defalias 'time-to-seconds 'float-time)

 ;;;###autoload  (autoload 'time-to-seconds "time-date"))
 
 ;;;###autoload  (autoload 'time-to-seconds "time-date"))
 

-(eval-and-compile
-  (unless (and (fboundp 'float-time)
-              (subrp (symbol-function 'float-time)))
-    (defun time-to-seconds (time)
-      "Convert time value TIME to a floating point number."
-      (with-decoded-time-value ((high low micro time))
-       (+ (* 1.0 high 65536)
-          low
-          (/ micro 1000000.0))))))
-

 (eval-when-compile
 (eval-when-compile

-  (unless (fboundp 'with-no-warnings)
-    (defmacro with-no-warnings (&rest body)
-      `(progn ,@body))))
+  (or (featurep 'emacs)
+      (and (fboundp 'float-time)
+           (subrp (symbol-function 'float-time)))
+      (defun time-to-seconds (&optional time)
+        "Convert optional value TIME to a floating point number.
+TIME defaults to the current time."
+        (with-decoded-time-value ((high low micro pico type
+                                  (or time (current-time))))
+          (+ (* high 65536.0)
+             low
+            (/ (+ (* micro 1e6) pico) 1e12))))))

 
 ;;;###autoload
 (defun seconds-to-time (seconds)
 
 ;;;###autoload
 (defun seconds-to-time (seconds)

-  "Convert SECONDS (a floating point number) to a time value."
-  (list (floor seconds 65536)
-       (floor (mod seconds 65536))
-       (floor (* (- seconds (ffloor seconds)) 1000000))))
-
-;;;###autoload
-(defun time-less-p (t1 t2)
-  "Say whether time value T1 is less than time value T2."
-  (with-decoded-time-value ((high1 low1 micro1 t1)
-                           (high2 low2 micro2 t2))
-    (or (< high1 high2)
-       (and (= high1 high2)
-            (or (< low1 low2)
-                (and (= low1 low2)
-                     (< micro1 micro2)))))))
+  "Convert SECONDS to a time value."
+  (time-add 0 seconds))

 
 ;;;###autoload
 (defun days-to-time (days)
   "Convert DAYS into a time value."
 
 ;;;###autoload
 (defun days-to-time (days)
   "Convert DAYS into a time value."

-  (let* ((seconds (* 1.0 days 60 60 24))
-        (high (condition-case nil (floor (/ seconds 65536))
-                (range-error most-positive-fixnum))))
-    (list high (condition-case nil (floor (- seconds (* 1.0 high 65536)))
-                (range-error 65535)))))
+  (let ((time (condition-case nil (seconds-to-time (* 86400.0 days))
+               (range-error (list most-positive-fixnum 65535)))))
+    (if (integerp days)
+       (setcdr (cdr time) nil))
+    time))

 
 ;;;###autoload
 (defun time-since (time)
 
 ;;;###autoload
 (defun time-since (time)


@@ -171,45 +205,71 @@ TIME should be either a time value or a date-time string."
   (when (stringp time)
     ;; Convert date strings to internal time.
     (setq time (date-to-time time)))
   (when (stringp time)
     ;; Convert date strings to internal time.
     (setq time (date-to-time time)))

-  (time-subtract (current-time) time))
+  (time-subtract nil time))

 
 ;;;###autoload
 (defalias 'subtract-time 'time-subtract)
 
 
 ;;;###autoload
 (defalias 'subtract-time 'time-subtract)
 

-;;;###autoload
-(defun time-subtract (t1 t2)
-  "Subtract two time values, T1 minus T2.
-Return the difference in the format of a time value."
-  (with-decoded-time-value ((high low micro type t1)
-                           (high2 low2 micro2 type2 t2))
-    (setq high (- high high2)
-         low (- low low2)
-         micro (- micro micro2)
-         type (max type type2))
-    (when (< micro 0)
-      (setq low (1- low)
-           micro (+ micro 1000000)))
-    (when (< low 0)
-      (setq high (1- high)
-           low (+ low 65536)))
-    (encode-time-value high low micro type)))
+;; These autoloads do nothing in Emacs 25, where the functions are builtin.
+;;;###autoload(autoload 'time-add "time-date")
+;;;###autoload(autoload 'time-subtract "time-date")
+;;;###autoload(autoload 'time-less-p "time-date")

 
 

-;;;###autoload
-(defun time-add (t1 t2)
-  "Add two time values T1 and T2.  One should represent a time difference."
-  (with-decoded-time-value ((high low micro type t1)
-                           (high2 low2 micro2 type2 t2))
-    (setq high (+ high high2)
-         low (+ low low2)
-         micro (+ micro micro2)
-         type (max type type2))
-    (when (>= micro 1000000)
-      (setq low (1+ low)
-           micro (- micro 1000000)))
-    (when (>= low 65536)
-      (setq high (1+ high)
-           low (- low 65536)))
-    (encode-time-value high low micro type)))
+(eval-when-compile
+  (when (not (and (fboundp 'time-add) (subrp (symbol-function 'time-add))))
+
+    (defun time-add (t1 t2)
+      "Add two time values T1 and T2.  One should represent a time difference."
+      (with-decoded-time-value ((high low micro pico type t1)
+                               (high2 low2 micro2 pico2 type2 t2))
+       (setq high (+ high high2)
+             low (+ low low2)
+             micro (+ micro micro2)
+             pico (+ pico pico2)
+             type (max type type2))
+       (when (>= pico 1000000)
+         (setq micro (1+ micro)
+               pico (- pico 1000000)))
+       (when (>= micro 1000000)
+         (setq low (1+ low)
+               micro (- micro 1000000)))
+       (when (>= low 65536)
+         (setq high (1+ high)
+               low (- low 65536)))
+       (encode-time-value high low micro pico type)))
+
+    (defun time-subtract (t1 t2)
+      "Subtract two time values, T1 minus T2.
+Return the difference in the format of a time value."
+      (with-decoded-time-value ((high low micro pico type t1)
+                               (high2 low2 micro2 pico2 type2 t2))
+       (setq high (- high high2)
+             low (- low low2)
+             micro (- micro micro2)
+             pico (- pico pico2)
+             type (max type type2))
+       (when (< pico 0)
+         (setq micro (1- micro)
+               pico (+ pico 1000000)))
+       (when (< micro 0)
+         (setq low (1- low)
+               micro (+ micro 1000000)))
+       (when (< low 0)
+         (setq high (1- high)
+               low (+ low 65536)))
+       (encode-time-value high low micro pico type)))
+
+    (defun time-less-p (t1 t2)
+      "Return non-nil if time value T1 is earlier than time value T2."
+      (with-decoded-time-value ((high1 low1 micro1 pico1 type1 t1)
+                               (high2 low2 micro2 pico2 type2 t2))
+       (or (< high1 high2)
+           (and (= high1 high2)
+                (or (< low1 low2)
+                    (and (= low1 low2)
+                         (or (< micro1 micro2)
+                             (and (= micro1 micro2)
+                                  (< pico1 pico2)))))))))))

 
 ;;;###autoload
 (defun date-to-day (date)
 
 ;;;###autoload
 (defun date-to-day (date)


@@ -230,11 +290,9 @@ DATE1 and DATE2 should be date-time strings."
           (not (zerop (% year 100))))
       (zerop (% year 400))))
 
           (not (zerop (% year 100))))
       (zerop (% year 400))))
 

-;;;###autoload
-(defun time-to-day-in-year (time)
-  "Return the day number within the year corresponding to TIME."
-  (let* ((tim (decode-time time))
-        (month (nth 4 tim))
+(defun time-date--day-in-year (tim)
+  "Return the day number within the year corresponding to the decoded time TIM."
+  (let* ((month (nth 4 tim))

         (day (nth 3 tim))
         (year (nth 5 tim))
         (day-of-year (+ day (* 31 (1- month)))))
         (day (nth 3 tim))
         (year (nth 5 tim))
         (day-of-year (+ day (* 31 (1- month)))))


@@ -244,32 +302,33 @@ DATE1 and DATE2 should be date-time strings."
        (setq day-of-year (1+ day-of-year))))
     day-of-year))
 
        (setq day-of-year (1+ day-of-year))))
     day-of-year))
 

+;;;###autoload
+(defun time-to-day-in-year (time)
+  "Return the day number within the year corresponding to TIME."
+  (time-date--day-in-year (decode-time time)))
+

 ;;;###autoload
 (defun time-to-days (time)
   "The number of days between the Gregorian date 0001-12-31bce and TIME.
 TIME should be a time value.
 The Gregorian date Sunday, December 31, 1bce is imaginary."
   (let* ((tim (decode-time time))
 ;;;###autoload
 (defun time-to-days (time)
   "The number of days between the Gregorian date 0001-12-31bce and TIME.
 TIME should be a time value.
 The Gregorian date Sunday, December 31, 1bce is imaginary."
   (let* ((tim (decode-time time))

-        (month (nth 4 tim))
-        (day (nth 3 tim))

         (year (nth 5 tim)))
         (year (nth 5 tim)))

-    (+ (time-to-day-in-year time)      ;       Days this year
+    (+ (time-date--day-in-year tim)    ;       Days this year

        (* 365 (1- year))               ;       + Days in prior years
        (/ (1- year) 4)                 ;       + Julian leap years
        (- (/ (1- year) 100))           ;       - century years
        (/ (1- year) 400))))            ;       + Gregorian leap years
 
        (* 365 (1- year))               ;       + Days in prior years
        (/ (1- year) 4)                 ;       + Julian leap years
        (- (/ (1- year) 100))           ;       - century years
        (/ (1- year) 400))))            ;       + Gregorian leap years
 

-(eval-and-compile
-  (if (and (fboundp 'float-time)
-          (subrp (symbol-function 'float-time)))
-      (defun time-to-number-of-days (time)
-       "Return the number of days represented by TIME.
-The number of days will be returned as a floating point number."
-       (/ (float-time time) (* 60 60 24)))
-    (defun time-to-number-of-days (time)
-      "Return the number of days represented by TIME.
-The number of days will be returned as a floating point number."
-      (/ (with-no-warnings (time-to-seconds time)) (* 60 60 24)))))
+(defun time-to-number-of-days (time)
+  "Return the number of days represented by TIME.
+Returns a floating point number."
+  (/ (funcall (eval-when-compile
+                (if (or (featurep 'emacs)
+                        (and (fboundp 'float-time)
+                             (subrp (symbol-function 'float-time))))
+                    'float-time
+                  'time-to-seconds)) time) (* 60 60 24)))

 
 ;;;###autoload
 (defun safe-date-to-time (date)
 
 ;;;###autoload
 (defun safe-date-to-time (date)


@@ -317,13 +376,9 @@ This function does not work for SECONDS greater than `most-positive-fixnum'."
       (setq start (match-end 0)
             spec (match-string 1 string))
       (unless (string-equal spec "%")
       (setq start (match-end 0)
             spec (match-string 1 string))
       (unless (string-equal spec "%")

-       ;; `assoc-string' is not available in XEmacs.  So when compiling
-       ;; Gnus (`time-date.el' is part of Gnus) with XEmacs, we get
-       ;; a warning here.  But `format-seconds' is not used anywhere in
-       ;; Gnus so it's not a real problem. --rsteib
-        (or (setq match (assoc-string spec units t))
+        (or (setq match (assoc (downcase spec) units))

             (error "Bad format specifier: `%s'" spec))
             (error "Bad format specifier: `%s'" spec))

-        (if (assoc-string spec usedunits t)
+        (if (assoc (downcase spec) usedunits)

             (error "Multiple instances of specifier: `%s'" spec))
         (if (string-equal (car match) "z")
             (setq zeroflag t)
             (error "Multiple instances of specifier: `%s'" spec))
         (if (string-equal (car match) "z")
             (setq zeroflag t)


@@ -361,6 +416,23 @@ This function does not work for SECONDS greater than `most-positive-fixnum'."
                  t t string))))))
   (replace-regexp-in-string "%%" "%" string))
 
                  t t string))))))
   (replace-regexp-in-string "%%" "%" string))
 

+(defvar seconds-to-string
+  (list (list 1 "ms" 0.001)
+        (list 100 "s" 1)
+        (list (* 60 100) "m" 60.0)
+        (list (* 3600 30) "h" 3600.0)
+        (list (* 3600 24 400) "d" (* 3600.0 24.0))
+        (list nil "y" (* 365.25 24 3600)))
+  "Formatting used by the function `seconds-to-string'.")
+;;;###autoload
+(defun seconds-to-string (delay)
+  "Convert the time interval in seconds to a short string."
+  (cond ((> 0 delay) (concat "-" (seconds-to-string (- delay))))
+        ((= 0 delay) "0s")
+        (t (let ((sts seconds-to-string) here)
+             (while (and (car (setq here (pop sts)))
+                         (<= (car here) delay)))
+             (concat (format "%.2f" (/ delay (car (cddr here)))) (cadr here))))))

 
 (provide 'time-date)
 
 
 (provide 'time-date)